contentctl 5.5.6__py3-none-any.whl → 5.5.8__py3-none-any.whl

contentctl/helper/utils.py

@@ -60,7 +60,7 @@ class Utils:
 
         if not path.exists() or not path.is_dir():
             raise Exception(
-                f"Unable to get security_content files, required directory '{str(path)}' does not exist or is not a directory"
+                f"Unable to get security_content files, required directory '{path!s}' does not exist or is not a directory"
             )
 
         allowedFiles: list[pathlib.Path] = []
@@ -275,7 +275,7 @@ class Utils:
                 # This is a file and we know it exists
                 return None
         except Exception as e:
-            print(f"Could not copy local file {file_path} the file because {str(e)}")
+            print(f"Could not copy local file {file_path} the file because {e!s}")
 
         # Try to make a head request to verify existence of the file
         try:
@@ -285,7 +285,7 @@ class Utils:
             if req.status_code > 400:
                 raise (Exception(f"Return code={req.status_code}"))
         except Exception as e:
-            raise (Exception(f"HTTP Resolution Failed: {str(e)}"))
+            raise (Exception(f"HTTP Resolution Failed: {e!s}"))
 
     @staticmethod
     def copy_local_file(
@@ -326,7 +326,7 @@ class Utils:
         except Exception as e:
             raise (
                 Exception(
-                    f"Error: Could not copy local file [{sourcePath}] to [{destPath}]: [{str(e)}]"
+                    f"Error: Could not copy local file [{sourcePath}] to [{destPath}]: [{e!s}]"
                 )
             )
         if verbose_print:
@@ -417,26 +417,26 @@ class Utils:
         except requests.exceptions.ConnectionError as e:
             raise (
                 Exception(
-                    f"Error: Could not download file [{file_path}] to [{destinationPath}] (Unable to connect to server. Are you sure the server exists and you have connectivity to it?): [{str(e)}]"
+                    f"Error: Could not download file [{file_path}] to [{destinationPath}] (Unable to connect to server. Are you sure the server exists and you have connectivity to it?): [{e!s}]"
                 )
             )
 
         except requests.exceptions.HTTPError as e:
             raise (
                 Exception(
-                    f"Error: Could not download file [{file_path}] to [{destinationPath}] (The file was probably not found on the server): [{str(e)}]"
+                    f"Error: Could not download file [{file_path}] to [{destinationPath}] (The file was probably not found on the server): [{e!s}]"
                 )
             )
         except requests.exceptions.Timeout as e:
             raise (
                 Exception(
-                    f"Error: Could not download file [{file_path}] to [{destinationPath}] (Timeout getting file): [{str(e)}]"
+                    f"Error: Could not download file [{file_path}] to [{destinationPath}] (Timeout getting file): [{e!s}]"
                 )
             )
         except Exception as e:
             raise (
                 Exception(
-                    f"Error: Could not download file [{file_path}] to [{destinationPath}] (Unknown Reason): [{str(e)}]"
+                    f"Error: Could not download file [{file_path}] to [{destinationPath}] (Unknown Reason): [{e!s}]"
                 )
             )
         finally:

contentctl/input/director.py

@@ -200,6 +200,7 @@ class Director:
             author=self.input_dto.app.author_name,
             description="A lookup file that contains the data source objects for detections.",
             lookup_type=Lookup_Type.csv,
+            case_sensitive_match=False,
             contents=RuntimeCsvWriter.generateDatasourceCSVContent(
                 self.output_dto.data_sources
             ),
@@ -315,7 +316,7 @@ class Director:
             print(f"{Colors.BOLD}{Colors.BRIGHT_MAGENTA}╚{'═' * 60}╝{Colors.END}\n")
 
             print(
-                f"{Colors.BOLD}{Colors.GREEN}{Colors.SPARKLE} Validation Completed{Colors.END} – Issues detected in {Colors.RED}{Colors.BOLD}{len(validation_errors)}{Colors.END} files.\n"
+                f"{Colors.BOLD}{Colors.GREEN}{Colors.SPARKLE} 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):
@@ -371,7 +372,7 @@ class Director:
                                 f"      {Colors.RED}{Colors.ERROR} {error_msg}{Colors.END}"
                             )
                 else:
-                    print(f"      {Colors.RED}{Colors.ERROR} {str(error)}{Colors.END}")
+                    print(f"      {Colors.RED}{Colors.ERROR} {error!s}{Colors.END}")
                 print("")
 
             # Clean footer with next steps

contentctl/input/new_content_questions.py

@@ -1,4 +1,5 @@
 from typing import Any
+
 from contentctl.objects.enums import DataSource
 
 

contentctl/input/yml_reader.py

@@ -16,7 +16,7 @@ class YmlReader:
             file_handler = open(file_path, "r", encoding="utf-8")
         except OSError as exc:
             print(
-                f"\nThere was an unrecoverable error when opening the file '{file_path}' - we will exit immediately:\n{str(exc)}"
+                f"\nThere was an unrecoverable error when opening the file '{file_path}' - we will exit immediately:\n{exc!s}"
             )
             sys.exit(1)
 
@@ -57,7 +57,7 @@ class YmlReader:
                 )
         except yaml.YAMLError as exc:
             print(
-                f"\nThere was an unrecoverable YML Parsing error when reading or parsing the file '{file_path}' - we will exit immediately:\n{str(exc)}"
+                f"\nThere was an unrecoverable YML Parsing error when reading or parsing the file '{file_path}' - we will exit immediately:\n{exc!s}"
             )
             sys.exit(1)
 

contentctl/objects/abstract_security_content_objects/detection_abstract.py

@@ -463,7 +463,7 @@ class Detection_Abstract(SecurityContentObject):
             )
         """
         action.risk.param._risk
-        of the conf file only contains a list of dicts. We do not eant to 
+        of the conf file only contains a list of dicts. We do not eant to
         include the message here, so we do not return it.
         """
         rba_dict = self.rba.model_dump()

contentctl/objects/alert_action.py

@@ -1,12 +1,14 @@
 from __future__ import annotations
-from pydantic import BaseModel, model_serializer, ConfigDict
+
 from typing import Optional
 
+from pydantic import BaseModel, ConfigDict, model_serializer
+
 from contentctl.objects.deployment_email import DeploymentEmail
 from contentctl.objects.deployment_notable import DeploymentNotable
+from contentctl.objects.deployment_phantom import DeploymentPhantom
 from contentctl.objects.deployment_rba import DeploymentRBA
 from contentctl.objects.deployment_slack import DeploymentSlack
-from contentctl.objects.deployment_phantom import DeploymentPhantom
 
 
 class AlertAction(BaseModel):

contentctl/objects/atomic.py

@@ -1,16 +1,19 @@
 from __future__ import annotations
+
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
     from contentctl.objects.config import validate
 
-from contentctl.input.yml_reader import YmlReader
-from pydantic import BaseModel, model_validator, ConfigDict, FilePath, UUID4
 import dataclasses
-from typing import List, Optional, Dict, Union, Self
 import pathlib
-from enum import StrEnum, auto
 import uuid
+from enum import StrEnum, auto
+from typing import Dict, List, Optional, Self, Union
+
+from pydantic import UUID4, BaseModel, ConfigDict, FilePath, model_validator
+
+from contentctl.input.yml_reader import YmlReader
 
 
 class SupportedPlatform(StrEnum):
@@ -125,7 +128,7 @@ class AtomicTest(BaseModel):
             try:
                 atomic_files.append(cls.constructAtomicFile(obj_path))
             except Exception as e:
-                error_messages.append(f"File [{obj_path}]\n{str(e)}")
+                error_messages.append(f"File [{obj_path}]\n{e!s}")
 
         if len(error_messages) > 0:
             exceptions_string = "\n\n".join(error_messages)

contentctl/objects/base_test.py

@@ -1,6 +1,6 @@
+from abc import ABC, abstractmethod
 from enum import StrEnum
 from typing import Union
-from abc import ABC, abstractmethod
 
 from pydantic import BaseModel, ConfigDict
 

contentctl/objects/base_test_result.py

@@ -1,7 +1,7 @@
-from typing import Union, Any
 from enum import StrEnum
+from typing import Any, Union
 
-from pydantic import ConfigDict, BaseModel
+from pydantic import BaseModel, ConfigDict
 from splunklib.data import Record  # type: ignore
 
 from contentctl.helper.utils import Utils

contentctl/objects/baseline_tags.py

@@ -1,18 +1,19 @@
 from __future__ import annotations
+
+from typing import Any, List, Union
+
 from pydantic import (
     BaseModel,
+    ConfigDict,
     Field,
-    field_validator,
     ValidationInfo,
+    field_validator,
     model_serializer,
-    ConfigDict,
 )
-from typing import List, Any, Union
 
-from contentctl.objects.story import Story
 from contentctl.objects.detection import Detection
-from contentctl.objects.enums import SecurityContentProductName
-from contentctl.objects.enums import SecurityDomain
+from contentctl.objects.enums import SecurityContentProductName, SecurityDomain
+from contentctl.objects.story import Story
 
 
 class BaselineTags(BaseModel):

contentctl/objects/config.py

@@ -200,7 +200,7 @@ class CustomApp(App_Base):
             raise (
                 ValueError(
                     "The specified version does not follow the semantic versioning spec "
-                    f"(https://semver.org/). {str(e)}"
+                    f"(https://semver.org/). {e!s}"
                 )
             )
         return v
@@ -1094,7 +1094,7 @@ class test_common(build):
                 f"Successfully wrote a test plan for [{len(self.mode.files)} detections] using [{len(self.apps)} apps] to [{output_file}]"
             )
         except Exception as e:
-            raise Exception(f"Error writing test plan file [{output_file}]: {str(e)}")
+            raise Exception(f"Error writing test plan file [{output_file}]: {e!s}")
 
     def getLocalAppDir(self) -> pathlib.Path:
         # docker really wants absolute paths
@@ -1189,7 +1189,7 @@ class test(test_common):
             return self
 
         except Exception as e:
-            raise ValueError(f"Error constructing container test_instances: {str(e)}")
+            raise ValueError(f"Error constructing container test_instances: {e!s}")
 
     @model_validator(mode="after")
     def ensureAppsAreGood(self) -> Self:
@@ -1213,7 +1213,7 @@ class test(test_common):
                 stage_file=False, include_custom_app=False
             )
         except Exception as e:
-            raise Exception(f"Error validating test apps: {str(e)}")
+            raise Exception(f"Error validating test apps: {e!s}")
         return self
 
     def getContainerEnvironmentString(
@@ -1363,7 +1363,7 @@ class release_notes(Config_Base):
             p.mkdir(exist_ok=True, parents=True)
         except Exception as e:
             raise Exception(
-                f"Error making the directory '{p}' to hold release_notes: {str(e)}"
+                f"Error making the directory '{p}' to hold release_notes: {e!s}"
             )
         return p / filename