Skip to content

Update validate output #370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pyth0n1c merged 6 commits into from
Apr 29, 2025
Merged

Update validate output #370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
666de14
Update director.py
nasbench Feb 11, 2025
c7733c1
first emoji pass
MHaggis Feb 11, 2025
e589632
errors
MHaggis Feb 11, 2025
e9b7dfe
💸
MHaggis Feb 11, 2025
3388c69
ruff
MHaggis Feb 11, 2025
3f5b031
Merge branch 'main' into update-validate-output.
pyth0n1c Apr 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 19 additions & 12 deletions contentctl/actions/validate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from contentctl.enrichments.cve_enrichment import CveEnrichment
from contentctl.helper.splunk_app import SplunkApp
from contentctl.helper.utils import Utils
from contentctl.input.director import Director, DirectorOutputDto
from contentctl.input.director import Director, DirectorOutputDto, ValidationFailedError
from contentctl.objects.atomic import AtomicEnrichment
from contentctl.objects.config import validate
from contentctl.objects.data_source import DataSource
Expand All @@ -13,19 +13,26 @@

class Validate:
def execute(self, input_dto: validate) -> DirectorOutputDto:
director_output_dto = DirectorOutputDto(
AtomicEnrichment.getAtomicEnrichment(input_dto),
AttackEnrichment.getAttackEnrichment(input_dto),
CveEnrichment.getCveEnrichment(input_dto),
)
try:
director_output_dto = DirectorOutputDto(
AtomicEnrichment.getAtomicEnrichment(input_dto),
AttackEnrichment.getAttackEnrichment(input_dto),
CveEnrichment.getCveEnrichment(input_dto),
)

director = Director(director_output_dto)
director.execute(input_dto)
self.ensure_no_orphaned_files_in_lookups(
input_dto.path, director_output_dto
)
if input_dto.data_source_TA_validation:
self.validate_latest_TA_information(director_output_dto.data_sources)

director = Director(director_output_dto)
director.execute(input_dto)
self.ensure_no_orphaned_files_in_lookups(input_dto.path, director_output_dto)
if input_dto.data_source_TA_validation:
self.validate_latest_TA_information(director_output_dto.data_sources)
return director_output_dto

return director_output_dto
except ValidationFailedError:
# Just re-raise without additional output since we already formatted everything
raise SystemExit(1)

def ensure_no_orphaned_files_in_lookups(
self, repo_path: pathlib.Path, director_output_dto: DirectorOutputDto
Expand Down
128 changes: 117 additions & 11 deletions contentctl/input/director.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,39 @@ def addContentToDictMappings(self, content: SecurityContentObject):
self.uuid_to_content_map[content.id] = content


class Colors:
HEADER = "\033[95m"
BLUE = "\033[94m"
CYAN = "\033[96m"
GREEN = "\033[92m"
YELLOW = "\033[93m"
RED = "\033[91m"
BOLD = "\033[1m"
UNDERLINE = "\033[4m"
END = "\033[0m"
MAGENTA = "\033[35m"
BRIGHT_MAGENTA = "\033[95m"

# Add fallback symbols for Windows
CHECK_MARK = "✓" if sys.platform != "win32" else "*"
WARNING = "⚠️" if sys.platform != "win32" else "!"
ERROR = "❌" if sys.platform != "win32" else "X"
ARROW = "🎯" if sys.platform != "win32" else ">"
TOOLS = "🛠️" if sys.platform != "win32" else "#"
DOCS = "📚" if sys.platform != "win32" else "?"
BULB = "💡" if sys.platform != "win32" else "i"
SEARCH = "🔍" if sys.platform != "win32" else "@"
ZAP = "⚡" if sys.platform != "win32" else "!"


class ValidationFailedError(Exception):
"""Custom exception for validation failures that already have formatted output."""

def __init__(self, message: str):
self.message = message
super().__init__(message)


class Director:
input_dto: validate
output_dto: DirectorOutputDto
Expand Down Expand Up @@ -268,18 +301,91 @@ def createSecurityContent(
end="",
flush=True,
)
print("Done!")

if len(validation_errors) > 0:
errors_string = "\n\n".join(
[
f"File: {e_tuple[0]}\nError: {str(e_tuple[1])}"
for e_tuple in validation_errors
]
print("\n") # Clean separation
print(f"{Colors.BOLD}{Colors.BRIGHT_MAGENTA}╔{'═' * 60}╗{Colors.END}")
print(
f"{Colors.BOLD}{Colors.BRIGHT_MAGENTA}║{Colors.BLUE}{f'{Colors.SEARCH} Content Validation Summary':^60}{Colors.BRIGHT_MAGENTA}║{Colors.END}"
)
print(f"{Colors.BOLD}{Colors.BRIGHT_MAGENTA}╚{'═' * 60}╝{Colors.END}\n")

print(
f"{Colors.BOLD}{Colors.GREEN}✨ Validation Completed{Colors.END} – Issues detected in {Colors.RED}{Colors.BOLD}{len(validation_errors)}{Colors.END} files.\n"
)

for index, entry in enumerate(validation_errors, 1):
file_path, error = entry
width = max(70, len(str(file_path)) + 15)

# File header with numbered emoji
number_emoji = f"{index}️⃣"
print(f"{Colors.YELLOW}┏{'━' * width}┓{Colors.END}")
print(
f"{Colors.YELLOW}┃{Colors.BOLD} {number_emoji} File: {Colors.CYAN}{file_path}{Colors.END}{' ' * (width - len(str(file_path)) - 12)}{Colors.YELLOW}┃{Colors.END}"
)
print(f"{Colors.YELLOW}┗{'━' * width}┛{Colors.END}")

print(
f" {Colors.RED}{Colors.BOLD}{Colors.ZAP} Validation Issues:{Colors.END}"
)

if isinstance(error, ValidationError):
for err in error.errors():
error_msg = err.get("msg", "")
if "https://errors.pydantic.dev" in error_msg:
continue

# Clean error categorization
if "Field required" in error_msg:
print(
f" {Colors.YELLOW}{Colors.WARNING} Field Required: {err.get('loc', [''])[0]}{Colors.END}"
)
elif "Input should be" in error_msg:
print(
f" {Colors.MAGENTA}{Colors.ARROW} Invalid Value for {err.get('loc', [''])[0]}{Colors.END}"
)
if err.get("ctx", {}).get("expected", None) is not None:
print(
f" Valid options: {err.get('ctx', {}).get('expected', None)}"
)
elif "Extra inputs" in error_msg:
print(
f" {Colors.BLUE}❌ Unexpected Field: {err.get('loc', [''])[0]}{Colors.END}"
)
elif "Failed to find" in error_msg:
print(
f" {Colors.RED}🔍 Missing Reference: {error_msg}{Colors.END}"
)
else:
print(f" {Colors.RED}❌ {error_msg}{Colors.END}")
else:
print(f" {Colors.RED}❌ {str(error)}{Colors.END}")
print("")

# Clean footer with next steps
max_width = max(60, max(len(str(e[0])) + 15 for e in validation_errors))
print(f"{Colors.BOLD}{Colors.CYAN}╔{'═' * max_width}╗{Colors.END}")
print(
f"{Colors.BOLD}{Colors.CYAN}║{Colors.BLUE}{'🎯 Next Steps':^{max_width}}{Colors.CYAN}║{Colors.END}"
)
print(f"{Colors.BOLD}{Colors.CYAN}╚{'═' * max_width}╝{Colors.END}\n")

print(
f"{Colors.GREEN}{Colors.TOOLS} Fix the validation issues in the listed files{Colors.END}"
)
print(
f"{Colors.YELLOW}{Colors.DOCS} Check the documentation: {Colors.UNDERLINE}https://github.com/splunk/contentctl{Colors.END}"
)
# print(f"The following {len(validation_errors)} error(s) were found during validation:\n\n{errors_string}\n\nVALIDATION FAILED")
# We quit after validation a single type/group of content because it can cause significant cascading errors in subsequent
# types of content (since they may import or otherwise use it)
raise Exception(
f"The following {len(validation_errors)} error(s) were found during validation:\n\n{errors_string}\n\nVALIDATION FAILED"
print(
f"{Colors.BLUE}{Colors.BULB} Use --verbose for detailed error information{Colors.END}\n"
)

raise ValidationFailedError(
f"Validation failed with {len(validation_errors)} error(s)"
)

# Success case
print(
f"\r{f'{contentCartegoryName} Progress'.rjust(23)}: [{progress_percent:3.0f}%]... {Colors.GREEN}{Colors.CHECK_MARK} Done!{Colors.END}"
)
Loading