Merge branch 'main' into run-id-always

* main:
  Switched from cmd to command (#615)
  Hotfix for check on frequency provider
  Tests run_until must be guard-claused with cleanup routine (#616)
  Fix check if stderr is empty (#613)
  Bump uvicorn[standard] from 0.24.0.post1 to 0.25.0 (#612)
  Fxing the network provider stderror

Author: ArneTR

docker/requirements.txt

@@ -1,7 +1,7 @@
 gunicorn==21.2.0
 psycopg[binary]==3.1.16
 fastapi==0.105.0
-uvicorn[standard]==0.24.0.post1
+uvicorn[standard]==0.25.0
 pandas==2.1.4
 PyYAML==6.0.1
 anybadge==1.14.0

lib/schema_checker.py

@@ -102,7 +102,7 @@ def check_usage_scenario(self, usage_scenario):
                     Optional("setup-commands"): [str],
                     Optional("volumes"): self.single_or_list(str),
                     Optional("folder-destination"):str,
-                    Optional("cmd"): str,
+                    Optional("command"): str,
                     Optional("log-stdout"): bool,
                     Optional("log-stderr"): bool,
                     Optional("read-notes-stdout"): bool,
@@ -130,6 +130,7 @@ def check_usage_scenario(self, usage_scenario):
             Optional("compose-file"): Use(self.validate_compose_include)
         }, ignore_extra_keys=True)
 
+
         # This check is necessary to do in a seperate pass. If tried to bake into the schema object above,
         # it will not know how to handle the value passed when it could be either a dict or list
         if 'networks' in usage_scenario:
@@ -139,6 +140,8 @@ def check_usage_scenario(self, usage_scenario):
             service = usage_scenario['services'][service_name]
             if 'image' not in service and 'build' not in service:
                 raise SchemaError("The 'image' key under services is required when 'build' key is not present.")
+            if 'cmd' in service:
+                raise SchemaError("The 'cmd' key under services is not supported anymore. Please migrate to 'command'")
 
         usage_scenario_schema.validate(usage_scenario)
 

metric_providers/cpu/frequency/sysfs/core/provider.py

@@ -21,4 +21,5 @@ def check_system(self):
                     file.read()
             except PermissionError as exc:
                 raise MetricProviderConfigurationError(f"{self._metric_name} provider could not be started.\nCannot read the path for the CPU frequency in sysfs.\n\nAre you running in a VM / cloud / shared hosting?\nIf so please disable the {self._metric_name} provider in the config.yml") from exc
-        raise MetricProviderConfigurationError(f"{self._metric_name} provider could not be started.\nCould not find the path for the CPU frequency in sysfs.\n\nAre you running in a VM / cloud / shared hosting? \nIf so please disable the {self._metric_name} provider in the config.yml")
+        else:
+            raise MetricProviderConfigurationError(f"{self._metric_name} provider could not be started.\nCould not find the path for the CPU frequency in sysfs.\n\nAre you running in a VM / cloud / shared hosting? \nIf so please disable the {self._metric_name} provider in the config.yml")

runner.py

@@ -830,9 +830,6 @@ def setup_services(self):
 
             docker_run_string.append(self.clean_image_name(service['image']))
 
-            if 'cmd' in service:  # must come last
-                docker_run_string.append(service['cmd'])
-
             # Before starting the container, check if the dependent containers are "ready".
             # If not, wait for some time. If the container is not ready after a certain time, throw an error.
             # Currently we consider "ready" only as "running".
@@ -861,6 +858,9 @@ def setup_services(self):
                     if state != "running":
                         raise RuntimeError(f"Dependent container '{dependent_container}' of '{container_name}' is not running after waiting for {time_waited} sec! Consider checking your service configuration, the entrypoint of the container or the logs of the container.")
 
+            if 'command' in service:  # must come last
+                docker_run_string.append(service['command'])
+
             print(f"Running docker run with: {' '.join(docker_run_string)}")
 
             # docker_run_string must stay as list, cause this forces items to be quoted and escaped and prevents
@@ -962,7 +962,7 @@ def start_metric_providers(self, allow_container=True, allow_other=True):
 
             stderr_read = metric_provider.get_stderr()
             print(f"Stderr check on {metric_provider.__class__.__name__}")
-            if stderr_read is not None:
+            if stderr_read is not None and str(stderr_read):
                 raise RuntimeError(f"Stderr on {metric_provider.__class__.__name__} was NOT empty: {stderr_read}")
 
 
@@ -1096,7 +1096,7 @@ def stop_metric_providers(self):
                 continue
 
             stderr_read = metric_provider.get_stderr()
-            if stderr_read is not None:
+            if stderr_read is not None and str(stderr_read):
                 errors.append(f"Stderr on {metric_provider.__class__.__name__} was NOT empty: {stderr_read}")
 
             metric_provider.stop_profiling()

tests/data/test_cases/subdir_volume_loading/subdir/usage_scenario_subdir.yml

@@ -13,7 +13,7 @@ services:
     volumes:
       - ./subdir2/testfile2:/tmp/testfile2-correctly-mounted
       - ./subdir2/subdir3/testfile3:/tmp/testfile3-correctly-mounted
-    cmd: sh
+    command: sh
 
 flow:
   - name: Cat Subdir2

tests/data/usage_scenarios/cmd_stress.yml

@@ -9,7 +9,7 @@ services:
     type: container
     image: gcb_stress
     build: .
-    cmd: sh
+    command: sh
 
 flow:
   - name: Stress

tests/test_usage_scenario.py

@@ -329,22 +329,34 @@ def test_depends_on_huge():
 
 def test_depends_on_error_not_running():
     runner = Tests.setup_runner(usage_scenario='depends_on_error_not_running.yml', dry_run=True)
-    with pytest.raises(RuntimeError) as e:
-        Tests.run_until(runner, 'setup_services')
+    try:
+        with pytest.raises(RuntimeError) as e:
+            Tests.run_until(runner, 'setup_services')
+    finally:
+        runner.cleanup()
+
     assert "Dependent container 'test-container-2' of 'test-container-1' is not running" in str(e.value) , \
         Tests.assertion_info('test-container-2 is not running', str(e.value))
 
 def test_depends_on_error_cyclic_dependency():
     runner = Tests.setup_runner(usage_scenario='depends_on_error_cycle.yml', dry_run=True)
-    with pytest.raises(RuntimeError) as e:
-        Tests.run_until(runner, 'setup_services')
+    try:
+        with pytest.raises(RuntimeError) as e:
+            Tests.run_until(runner, 'setup_services')
+    finally:
+        runner.cleanup()
+
     assert "Cycle found in depends_on definition with service 'test-container-1'" in str(e.value) , \
         Tests.assertion_info('cycle in depends_on with test-container-1', str(e.value))
 
 def test_depends_on_error_unsupported_long_form():
     runner = Tests.setup_runner(usage_scenario='depends_on_error_unsupported_long_form.yml', dry_run=True)
-    with pytest.raises(RuntimeError) as e:
-        Tests.run_until(runner, 'setup_services')
+    try:
+        with pytest.raises(RuntimeError) as e:
+            Tests.run_until(runner, 'setup_services')
+    finally:
+        runner.cleanup()
+
     assert "long form" in str(e.value) , \
         Tests.assertion_info('long form is not supported', str(e.value))
 
@@ -411,7 +423,7 @@ def test_container_is_in_network():
         Tests.cleanup(runner)
     assert 'test-container' in inspect, Tests.assertion_info('test-container', inspect)
 
-# cmd: [str] (optional)
+# command: [str] (optional)
 #    Command to be executed when container is started.
 #    When container does not have a daemon running typically a shell
 #    is started here to have the container running like bash or sh
@@ -454,9 +466,12 @@ def test_uri_local_dir():
 
 def test_uri_local_dir_missing():
     runner = Tests.setup_runner(usage_scenario='basic_stress.yml', uri='/tmp/missing')
-    with pytest.raises(FileNotFoundError) as e:
-        runner.run()
-    expected_exception = 'No such file or directory: \'/tmp/missing\''
+    try:
+        with pytest.raises(FileNotFoundError) as e:
+            runner.run()
+        expected_exception = 'No such file or directory: \'/tmp/missing\''
+    finally:
+        runner.cleanup()
     assert expected_exception in str(e.value),\
         Tests.assertion_info(f"Exception: {expected_exception}", str(e.value))