Fix bug where -container-settings.num-containers

was not being respected. Fix undefined python
behavior where during filtering of detections,
we were deleting items from the list while iterating
over it.

Author: pyth0n1c

contentctl/actions/test.py

@@ -43,29 +43,32 @@ class TestInputDto:
     config: test_common
 
 
-class TestOutputDto:
-    results: list
-
-
 class Test:
 
-    def filter_detections(self, input_dto: TestInputDto):
+    def filter_detections(self, input_dto: TestInputDto)->TestInputDto:
+        
         if not input_dto.config.enable_integration_testing:
             #Skip all integraiton tests if integration testing is not enabled:
             for detection in input_dto.detections:
                 for test in detection.tests:
                     if isinstance(test, IntegrationTest):
                         test.skip("TEST SKIPPED: Skipping all integration tests")
 
+        list_after_filtering:List[Detection] = []
         #extra filtering which may be removed/modified in the future
         for detection in input_dto.detections:
             if (detection.status != DetectionStatus.production.value):
                 #print(f"{detection.name} - Not testing because [STATUS: {detection.status}]")
-                input_dto.detections.remove(detection)
+                pass
             elif detection.type == AnalyticsType.Correlation:
                 #print(f"{detection.name} - Not testing because [  TYPE: {detection.type}]")
-                input_dto.detections.remove(detection)
-
+                pass
+            else:
+                list_after_filtering.append(detection)
+        
+        return TestInputDto(list_after_filtering, input_dto.config)
+        
+        
     def execute(self, input_dto: TestInputDto) -> bool:
 
 

contentctl/contentctl.py

@@ -114,14 +114,14 @@ def test_common_func(config:test_common):
 
     # Remove detections that we do not want to test because they are
     # not production, the correct type, or manual_test only
-    t.filter_detections(test_input_dto)
+    filted_test_input_dto = t.filter_detections(test_input_dto)
 
     if config.plan_only:
         #Emit the test plan and quit. Do not actually run the test
-        config.dumpCICDPlanAndQuit(gitServer.getHash(),test_input_dto.detections)
+        config.dumpCICDPlanAndQuit(gitServer.getHash(),filted_test_input_dto.detections)
         return 
 
-    success = t.execute(test_input_dto)
+    success = t.execute(filted_test_input_dto)
 
     if success:
         #Everything passed!
@@ -212,6 +212,10 @@ def main():
         elif type(config) == deploy_rest:
             deploy_rest_func(config)
         elif type(config) == test or type(config) == test_servers:
+            if type(config) == test:
+                #construct the container Infrastructure objects
+                config.getContainerInfrastructureObjects()
+                #otherwise, they have already been passed as servers
             test_common_func(config)
         else:
             raise Exception(f"Unknown command line type '{type(config).__name__}'")

contentctl/objects/config.py

@@ -689,17 +689,13 @@ class test(test_common):
     splunk_api_password: Optional[str] = Field(default=None, exclude = True, description="Splunk API password used for running appinspect or installaing apps from Splunkbase")
 
 
-    @model_validator(mode='after')
-    def get_test_instances(self)->Self:
-        
-        if len(self.test_instances) > 0:
-            return self
+    def getContainerInfrastructureObjects(self)->Self:
         try:
             self.test_instances = self.container_settings.getContainers()
             return self
 
         except Exception as e:
-            raise ValueError(f"Error constructing test_instances: {str(e)}")
+            raise ValueError(f"Error constructing container test_instances: {str(e)}")
 
 
 
@@ -748,20 +744,24 @@ def getAppFilePath(self):
         return self.path / "apps.yml"
 
 
-
+TEST_ARGS_ENV = "CONTENTCTL_TEST_INFRASTRUCTURES"
 class test_servers(test_common):
     model_config = ConfigDict(use_enum_values=True,validate_default=True, arbitrary_types_allowed=True)
     test_instances:List[Infrastructure] = Field([],description="Test against one or more preconfigured servers.", validate_default=True)
-    server_info:Optional[str] = Field(None, validate_default=True)
-
+    server_info:Optional[str] = Field(None, validate_default=True, description='String of pre-configured servers to use for testing.  The list MUST be in the format:\n'
+                                      'address,username,web_ui_port,hec_port,api_port;address_2,username_2,web_ui_port_2,hec_port_2,api_port_2'
+                                      '\nFor example, the following string will use 2 preconfigured test instances:\n'
+                                      '127.0.0.1,firstUser,firstUserPassword,8000,8088,8089;1.2.3.4,secondUser,secondUserPassword,8000,8088,8089\n'
+                                      'Note that these test_instances may be hosted on the same system, such as localhost/127.0.0.1 or a docker server, or different hosts.\n'
+                                      f'This value may also be passed by setting the environment variable [{TEST_ARGS_ENV}] with the value above.')
 
     @model_validator(mode='before')
     @classmethod
     def parse_config(cls, data:Any, info: ValidationInfo)->Any:
         #Ignore whatever is in the file or defaults, these must be supplied on command line
         #if len(v) != 0:
         #    return v
-        TEST_ARGS_ENV = "CONTENTCTL_TEST_INFRASTRUCTURES"
+        
 
         if isinstance(data.get("server_info"),str) :
             server_info = data.get("server_info")