contentctl 5.0.0a0__py3-none-any.whl → 5.0.0a3__py3-none-any.whl

contentctl/actions/detection_testing/infrastructures/DetectionTestingInfrastructureContainer.py

@@ -17,10 +17,12 @@ class DetectionTestingInfrastructureContainer(DetectionTestingInfrastructure):
             # If we are configured to use the persistent container, then check and see if it's already
             # running. If so, just use it without additional configuration.
             try:
-                self.container = self.get_docker_client().containers.get(self.get_name())
+                self.container = self.get_docker_client().containers.get(
+                    self.get_name()
+                )
                 return
             except Exception:
-                #We did not find the container running, we will set it up
+                # We did not find the container running, we will set it up
                 pass
 
         self.container = self.make_container()
@@ -47,9 +49,10 @@ class DetectionTestingInfrastructureContainer(DetectionTestingInfrastructure):
             raise (Exception(f"Failed to get docker client: {str(e)}"))
 
     def check_for_teardown(self):
-
         try:
-            container: docker.models.containers.Container = self.get_docker_client().containers.get(self.get_name())
+            container: docker.models.containers.Container = (
+                self.get_docker_client().containers.get(self.get_name())
+            )
         except Exception as e:
             if self.sync_obj.terminate is not True:
                 self.pbar.write(
@@ -57,7 +60,7 @@ class DetectionTestingInfrastructureContainer(DetectionTestingInfrastructure):
                 )
                 self.sync_obj.terminate = True
         else:
-            if container.status != 'running':
+            if container.status != "running":
                 self.sync_obj.terminate = True
                 self.container = None
 
@@ -90,28 +93,33 @@ class DetectionTestingInfrastructureContainer(DetectionTestingInfrastructure):
         environment["SPLUNK_PASSWORD"] = self.infrastructure.splunk_app_password
         # Files have already been staged by the time that we call this. Files must only be staged
         # once, not staged by every container
-        environment["SPLUNK_APPS_URL"] = self.global_config.getContainerEnvironmentString(stage_file=False)
+        environment["SPLUNK_APPS_URL"] = (
+            self.global_config.getContainerEnvironmentString(stage_file=False)
+        )
         if (
             self.global_config.splunk_api_username is not None
             and self.global_config.splunk_api_password is not None
         ):
             environment["SPLUNKBASE_USERNAME"] = self.global_config.splunk_api_username
             environment["SPLUNKBASE_PASSWORD"] = self.global_config.splunk_api_password
-        
-
 
         def emit_docker_run_equivalent():
-            environment_string = " ".join([f'-e "{k}={environment.get(k)}"' for k in environment.keys()])
-            print(f"\n\ndocker run -d "\
-                  f"-p {self.infrastructure.web_ui_port}:8000 "
-                  f"-p {self.infrastructure.hec_port}:8088 "
-                  f"-p {self.infrastructure.api_port}:8089 "
-                  f"{environment_string} "            
-                  f" --name {self.get_name()} "
-                  f"--platform linux/amd64 "
-                  f"{self.global_config.container_settings.full_image_path}\n\n")
-        #emit_docker_run_equivalent()
-        
+            environment_string = " ".join(
+                [f'-e "{k}={environment.get(k)}"' for k in environment.keys()]
+            )
+            print(
+                f"\n\ndocker run -d "
+                f"-p {self.infrastructure.web_ui_port}:8000 "
+                f"-p {self.infrastructure.hec_port}:8088 "
+                f"-p {self.infrastructure.api_port}:8089 "
+                f"{environment_string} "
+                f" --name {self.get_name()} "
+                f"--platform linux/amd64 "
+                f"{self.global_config.container_settings.full_image_path}\n\n"
+            )
+
+        # emit_docker_run_equivalent()
+
         container = self.get_docker_client().containers.create(
             self.global_config.container_settings.full_image_path,
             ports=ports_dict,
@@ -119,20 +127,21 @@ class DetectionTestingInfrastructureContainer(DetectionTestingInfrastructure):
             name=self.get_name(),
             mounts=mounts,
             detach=True,
-            platform="linux/amd64"
+            platform="linux/amd64",
         )
-        
+
         if self.global_config.enterpriseSecurityInApps():
-            #ES sets up https, so make sure it is included in the link
+            # ES sets up https, so make sure it is included in the link
             address = f"https://{self.infrastructure.instance_address}:{self.infrastructure.web_ui_port}"
         else:
             address = f"http://{self.infrastructure.instance_address}:{self.infrastructure.web_ui_port}"
-        print(f"\nStarted container with the following information:\n"
-              f"\tname    : [{self.get_name()}]\n"
-              f"\taddress : [{address}]\n"
-              f"\tusername: [{self.infrastructure.splunk_app_username}]\n"
-              f"\tpassword: [{self.infrastructure.splunk_app_password}]\n"
-              )
+        print(
+            f"\nStarted container with the following information:\n"
+            f"\tname    : [{self.get_name()}]\n"
+            f"\taddress : [{address}]\n"
+            f"\tusername: [{self.infrastructure.splunk_app_username}]\n"
+            f"\tpassword: [{self.infrastructure.splunk_app_password}]\n"
+        )
 
         return container
 
@@ -141,15 +150,19 @@ class DetectionTestingInfrastructureContainer(DetectionTestingInfrastructure):
             container: docker.models.containers.Container = (
                 self.get_docker_client().containers.get(self.get_name())
             )
-        except Exception as e:
+        except Exception:
             # Container does not exist, no need to try and remove it
             return
         try:
             # If the user wants to persist the container (or use a previously configured container), then DO NOT remove it.
-            # Emit the following message, which they will see on initial setup and teardown at the end of the test. 
+            # Emit the following message, which they will see on initial setup and teardown at the end of the test.
             if self.global_config.container_settings.leave_running:
-                print(f"\nContainer [{self.get_name()}] has NOT been terminated because 'contentctl_test.yml ---> infrastructure_config ---> persist_and_reuse_container = True'")
-                print(f"To remove it, please manually run the following at the command line: `docker container rm -fv {self.get_name()}`\n")
+                print(
+                    f"\nContainer [{self.get_name()}] has NOT been terminated because 'contentctl_test.yml ---> infrastructure_config ---> persist_and_reuse_container = True'"
+                )
+                print(
+                    f"To remove it, please manually run the following at the command line: `docker container rm -fv {self.get_name()}`\n"
+                )
                 return
             # container was found, so now we try to remove it
             # v also removes volumes linked to the container

contentctl/actions/detection_testing/progress_bar.py

@@ -8,6 +8,7 @@ class TestReportingType(StrEnum):
     """
     5-char identifiers for the type of testing being reported on
     """
+
     # Reporting around general testing setup (e.g. infra, role configuration)
     SETUP = "SETUP"
 
@@ -25,6 +26,7 @@ class TestingStates(StrEnum):
     """
     Defined testing states
     """
+
     BEGINNING_GROUP = "Beginning Test Group"
     BEGINNING_TEST = "Beginning Test"
     DOWNLOADING = "Downloading Data"
@@ -47,6 +49,7 @@ class FinalTestingStates(StrEnum):
     """
     The possible final states for a test (for pbar reporting)
     """
+
     FAIL = "\x1b[0;30;41m" + "FAIL ".ljust(LONGEST_STATE) + "\x1b[0m"
     ERROR = "\x1b[0;30;41m" + "ERROR".ljust(LONGEST_STATE) + "\x1b[0m"
     PASS = "\x1b[0;30;42m" + "PASS ".ljust(LONGEST_STATE) + "\x1b[0m"

contentctl/actions/detection_testing/views/DetectionTestingView.py

@@ -64,7 +64,7 @@ class DetectionTestingView(BaseModel, abc.ABC):
         try:
             runtime = self.getRuntime()
             time_per_detection = runtime / num_tested
-            remaining_time = (num_untested+.5) * time_per_detection
+            remaining_time = (num_untested + 0.5) * time_per_detection
             remaining_time -= datetime.timedelta(
                 microseconds=remaining_time.microseconds
             )
@@ -74,7 +74,14 @@ class DetectionTestingView(BaseModel, abc.ABC):
 
     def getSummaryObject(
         self,
-        test_result_fields: list[str] = ["success", "message", "exception", "status", "duration", "wait_duration"],
+        test_result_fields: list[str] = [
+            "success",
+            "message",
+            "exception",
+            "status",
+            "duration",
+            "wait_duration",
+        ],
         test_job_fields: list[str] = ["resultCount", "runDuration"],
     ) -> dict[str, dict[str, Any] | list[dict[str, Any]] | str]:
         """
@@ -110,11 +117,11 @@ class DetectionTestingView(BaseModel, abc.ABC):
                 total_skipped += 1
 
             # Aggregate production status metrics
-            if detection.status == DetectionStatus.production:                                
+            if detection.status == DetectionStatus.production:
                 total_production += 1
-            elif detection.status == DetectionStatus.experimental:                            
+            elif detection.status == DetectionStatus.experimental:
                 total_experimental += 1
-            elif detection.status == DetectionStatus.deprecated:                              
+            elif detection.status == DetectionStatus.deprecated:
                 total_deprecated += 1
 
             # Check if the detection is manual_test
@@ -128,19 +135,11 @@ class DetectionTestingView(BaseModel, abc.ABC):
                 tested_detections.append(summary)
 
         # Sort tested detections s.t. all failures appear first, then by name
-        tested_detections.sort(
-            key=lambda x: (
-                x["success"],
-                x["name"]
-            )
-        )
+        tested_detections.sort(key=lambda x: (x["success"], x["name"]))
 
         # Sort skipped detections s.t. detections w/ tests appear before those w/o, then by name
         skipped_detections.sort(
-            key=lambda x: (
-                0 if len(x["tests"]) > 0 else 1,
-                x["name"]
-            )
+            key=lambda x: (0 if len(x["tests"]) > 0 else 1, x["name"])
         )
 
         # TODO (#267): Align test reporting more closely w/ status enums (as it relates to
@@ -170,9 +169,7 @@ class DetectionTestingView(BaseModel, abc.ABC):
         percent_complete = Utils.getPercent(
             len(tested_detections), len(untested_detections), 1
         )
-        success_rate = Utils.getPercent(
-            total_pass, total_tested_detections, 1
-        )
+        success_rate = Utils.getPercent(total_pass, total_tested_detections, 1)
 
         # TODO (#230): expand testing metrics reported (and make nested)
         # Construct and return the larger results dict

contentctl/actions/detection_testing/views/DetectionTestingViewCLI.py

@@ -3,7 +3,6 @@ from contentctl.actions.detection_testing.views.DetectionTestingView import (
 )
 
 import time
-import datetime
 import tqdm
 
 
@@ -39,15 +38,12 @@ class DetectionTestingViewCLI(DetectionTestingView, arbitrary_types_allowed=True
             miniters=0,
             mininterval=0,
         )
-        fmt = self.format_pbar(
-            len(self.sync_obj.outputQueue), len(self.sync_obj.inputQueue)
-        )
+        self.format_pbar(len(self.sync_obj.outputQueue), len(self.sync_obj.inputQueue))
 
         self.showStatus()
 
     # TODO (#267): Align test reporting more closely w/ status enums (as it relates to "untested")
     def showStatus(self, interval: int = 1):
-
         while True:
             summary = self.getSummaryObject()
 

contentctl/actions/detection_testing/views/DetectionTestingViewFile.py

@@ -13,7 +13,7 @@ class DetectionTestingViewFile(DetectionTestingView):
     output_filename: str = OUTPUT_FILENAME
 
     def getOutputFilePath(self) -> pathlib.Path:
-        folder_path = pathlib.Path('.') / self.output_folder
+        folder_path = pathlib.Path(".") / self.output_folder
         output_file = folder_path / self.output_filename
 
         return output_file
@@ -22,7 +22,7 @@ class DetectionTestingViewFile(DetectionTestingView):
         pass
 
     def stop(self):
-        folder_path = pathlib.Path('.') / self.output_folder
+        folder_path = pathlib.Path(".") / self.output_folder
         output_file = self.getOutputFilePath()
 
         folder_path.mkdir(parents=True, exist_ok=True)

contentctl/actions/detection_testing/views/DetectionTestingViewWeb.py

@@ -102,9 +102,7 @@ class SimpleWebServer(ServerAdapter):
 class DetectionTestingViewWeb(DetectionTestingView):
     bottleApp: Bottle = Bottle()
     server: SimpleWebServer = SimpleWebServer(host="0.0.0.0", port=DEFAULT_WEB_UI_PORT)
-    model_config = ConfigDict(
-        arbitrary_types_allowed=True
-    )
+    model_config = ConfigDict(arbitrary_types_allowed=True)
 
     def setup(self):
         self.bottleApp.route("/", callback=self.showStatus)
@@ -123,7 +121,6 @@ class DetectionTestingViewWeb(DetectionTestingView):
             print(f"Could not open webbrowser for status page: {str(e)}")
 
     def stop(self):
-
         if self.server.server is None:
             print("Web Server is not running anyway - nothing to shut down")
             return

contentctl/actions/doc_gen.py

@@ -10,17 +10,21 @@ from contentctl.output.doc_md_output import DocMdOutput
 class DocGenInputDto:
     director_input_dto: DirectorInputDto
 
-class DocGen:
 
+class DocGen:
     def execute(self, input_dto: DocGenInputDto) -> None:
-        director_output_dto = DirectorOutputDto([],[],[],[],[],[],[],[],[],[])
+        director_output_dto = DirectorOutputDto([], [], [], [], [], [], [], [], [], [])
         director = Director(director_output_dto)
         director.execute(input_dto.director_input_dto)
 
         doc_md_output = DocMdOutput()
         doc_md_output.writeObjects(
-            [director_output_dto.stories, director_output_dto.detections, director_output_dto.playbooks], 
-            os.path.join(input_dto.director_input_dto.input_path, "docs")
+            [
+                director_output_dto.stories,
+                director_output_dto.detections,
+                director_output_dto.playbooks,
+            ],
+            os.path.join(input_dto.director_input_dto.input_path, "docs"),
         )
 
-        print('Generating Docs of security content successful.')
+        print("Generating Docs of security content successful.")

contentctl/actions/initialize.py

@@ -1,4 +1,3 @@
-
 import shutil
 import os
 import pathlib
@@ -7,57 +6,70 @@ from contentctl.output.yml_writer import YmlWriter
 
 
 class Initialize:
-
     def execute(self, config: test) -> None:
         # construct a test object from the init object
         # This way we can easily populate a yml with ALL the important
-        # fields for validating, building, and testing your app. 
-        
-        YmlWriter.writeYmlFile(str(config.path/'contentctl.yml'), config.model_dump()) 
-
-        
-        #Create the following empty directories:
-        for emptyDir in ['lookups', 'baselines', 'data_sources', 'docs', 'reporting', 'investigations', 
-                            'detections/application', 'detections/cloud', 'detections/endpoint', 
-                            'detections/network', 'detections/web', 'macros', 'stories']:
-            #Throw an error if this directory already exists
-            (config.path/emptyDir).mkdir(exist_ok=False, parents=True)
+        # fields for validating, building, and testing your app.
+
+        YmlWriter.writeYmlFile(str(config.path / "contentctl.yml"), config.model_dump())
+
+        # Create the following empty directories:
+        for emptyDir in [
+            "lookups",
+            "baselines",
+            "data_sources",
+            "docs",
+            "reporting",
+            "investigations",
+            "detections/application",
+            "detections/cloud",
+            "detections/endpoint",
+            "detections/network",
+            "detections/web",
+            "macros",
+            "stories",
+        ]:
+            # Throw an error if this directory already exists
+            (config.path / emptyDir).mkdir(exist_ok=False, parents=True)
 
         # If this is not a bare config, then populate
         # a small amount of content into the directories
         if not config.bare:
-            #copy the contents of all template directories
+            # copy the contents of all template directories
             for templateDir, targetDir in [
-                ('../templates/detections/', 'detections'),
-                ('../templates/data_sources/', 'data_sources'),
-                ('../templates/macros/', 'macros'),
-                ('../templates/stories/', 'stories'),
+                ("../templates/detections/", "detections"),
+                ("../templates/data_sources/", "data_sources"),
+                ("../templates/macros/", "macros"),
+                ("../templates/stories/", "stories"),
             ]:
-                source_directory = pathlib.Path(os.path.dirname(__file__))/templateDir
-                target_directory = config.path/targetDir
-                
-                # Do not throw an exception if the directory exists. In fact, it was 
+                source_directory = pathlib.Path(os.path.dirname(__file__)) / templateDir
+                target_directory = config.path / targetDir
+
+                # Do not throw an exception if the directory exists. In fact, it was
                 # created above when the structure of the app was created.
                 shutil.copytree(source_directory, target_directory, dirs_exist_ok=True)
-        
+
         # The contents of app_template must ALWAYS be copied because it contains
         # several special files.
         # For now, we also copy the deployments because the ability to create custom
         # deployment files is limited with built-in functionality.
         for templateDir, targetDir in [
-            ('../templates/app_template/', 'app_template'),
-            ('../templates/deployments/', 'deployments')
+            ("../templates/app_template/", "app_template"),
+            ("../templates/deployments/", "deployments"),
         ]:
-            source_directory = pathlib.Path(os.path.dirname(__file__))/templateDir
-            target_directory = config.path/targetDir
-            #Throw an exception if the target exists
+            source_directory = pathlib.Path(os.path.dirname(__file__)) / templateDir
+            target_directory = config.path / targetDir
+            # Throw an exception if the target exists
             shutil.copytree(source_directory, target_directory, dirs_exist_ok=False)
 
         # Create a README.md file.  Note that this is the README.md for the repository, not the
         # one which will actually be packaged into the app. That is located in the app_template folder.
-        shutil.copyfile(pathlib.Path(os.path.dirname(__file__))/'../templates/README.md','README.md')
-
-
-        print(f"The app '{config.app.title}' has been initialized. "
-              "Please run 'contentctl new --type {detection,story}' to create new content")
+        shutil.copyfile(
+            pathlib.Path(os.path.dirname(__file__)) / "../templates/README.md",
+            "README.md",
+        )
 
+        print(
+            f"The app '{config.app.title}' has been initialized. "
+            "Please run 'contentctl new --type {detection,story}' to create new content"
+        )