Allow overwrite of str in usage scenario (#1248)

* Making tests faster by running only to needed mark

* when merging YML the str keys should be taken preferred from usage_scenario.yml

* Added tests for using strs from usage_scenario.yml on merge-include [skip ci]

Author: ArneTR

lib/scenario_runner.py

@@ -316,6 +316,7 @@ def include(self, node):
                     nodes = self.construct_sequence(node)
                 else:
                     raise ValueError("We don't support Mapping Nodes to date")
+
                 try:
                     usage_scenario_dir = os.path.split(usage_scenario_file)[0]
                     filename = runner_join_paths(usage_scenario_dir, nodes[0], force_path_as_root=True)
@@ -356,6 +357,7 @@ def recursive_lookup(k, d):
 
             # We can use load here as the Loader extends SafeLoader
             yml_obj = yaml.load(usage_scenario, Loader)
+
             # Now that we have parsed the yml file we need to check for the special case in which we have a
             # compose-file key. In this case we merge the data we find under this key but overwrite it with
             # the data from the including file.
@@ -369,7 +371,7 @@ def merge_dicts(dict1, dict2):
                         else:
                             dict1[k] = v
                     return dict1
-                return dict1
+                return dict2
 
             new_dict = {}
             if 'compose-file' in yml_obj.keys():
@@ -383,6 +385,7 @@ def merge_dicts(dict1, dict2):
 
             yml_obj.update(new_dict)
 
+
             # If a service is defined as None we remove it. This is so we can have a compose file that starts
             # all the various services but we can disable them in the usage_scenario. This is quite useful when
             # creating benchmarking scripts and you want to have all options in the compose but not in each benchmark.

tests/data/usage_scenarios/include_example.yml

@@ -0,0 +1,4 @@
+---
+name: Name as is
+author: Author as is
+description: Description as is

tests/data/usage_scenarios/overwrite_string_from_include.yml

@@ -0,0 +1,13 @@
+---
+name: Name overwritten
+author: Author overwritten
+
+compose-file: !include include_example.yml
+
+flow:
+  - name: dummy
+    container: test-container-1
+    commands:
+      - type: console
+        command: pwd
+

tests/data/usage_scenarios/overwrite_string_from_include_even_if_top.yml

@@ -0,0 +1,13 @@
+---
+compose-file: !include include_example.yml
+
+name: Name overwritten
+author: Author overwritten
+
+flow:
+  - name: dummy
+    container: test-container-1
+    commands:
+      - type: console
+        command: pwd
+

tests/test_usage_scenario.py

@@ -155,7 +155,7 @@ def test_compose_include_not_same_dir():
 
     with redirect_stdout(out), redirect_stderr(err), pytest.raises(ValueError) as e:
         with Tests.RunUntilManager(runner) as context:
-            context.run_until('setup_services')
+            context.run_until('import_metric_providers')
     assert str(e.value).startswith('Included compose file "../compose.yml" may only be in the same directory as the usage_scenario file as otherwise relative context_paths and volume_paths cannot be mapped anymore') , \
         Tests.assertion_info('Root directory escape', str(e.value))
 
@@ -167,7 +167,7 @@ def test_context_include():
 
     with redirect_stdout(out), redirect_stderr(err):
         with Tests.RunUntilManager(runner) as context:
-            context.run_until('setup_services')
+            context.run_until('import_metric_providers')
     # will not throw an exception
 
 def test_context_include_escape():
@@ -183,12 +183,33 @@ def test_context_include_escape():
     assert str(e.value).startswith('../../../../../../ must not be in folder above root repo folder') , \
         Tests.assertion_info('Root directory escape', str(e.value))
 
+def test_include_overwrites_string_values():
+    runner = ScenarioRunner(uri=GMT_DIR, uri_type='folder', filename='tests/data/usage_scenarios/overwrite_string_from_include.yml', skip_system_checks=True, dev_no_metrics=True, dev_no_phase_stats=True, dev_no_sleeps=True, dev_cache_build=False)
+
+    with Tests.RunUntilManager(runner) as context:
+        context.run_until('import_metric_providers')
+
+    assert runner._usage_scenario['name'] == 'Name overwritten'
+    assert runner._usage_scenario['author'] == 'Author overwritten'
+    assert runner._usage_scenario['description'] == 'Description as is'
+
+def test_include_overwrites_string_values_even_if_top_include():
+    runner = ScenarioRunner(uri=GMT_DIR, uri_type='folder', filename='tests/data/usage_scenarios/overwrite_string_from_include_even_if_top.yml', skip_system_checks=True, dev_no_metrics=True, dev_no_phase_stats=True, dev_no_sleeps=True, dev_cache_build=False)
+
+    with Tests.RunUntilManager(runner) as context:
+        context.run_until('import_metric_providers')
+
+    assert runner._usage_scenario['name'] == 'Name overwritten'
+    assert runner._usage_scenario['author'] == 'Author overwritten'
+    assert runner._usage_scenario['description'] == 'Description as is'
+
+
 def test_unsupported_compose():
     runner = ScenarioRunner(uri=GMT_DIR, uri_type='folder', filename='tests/data/usage_scenarios/unsupported_compose.yml', skip_system_checks=True, dev_no_metrics=True, dev_no_phase_stats=True, dev_no_sleeps=True, dev_cache_build=False)
 
     with pytest.raises(SchemaError) as e:
         with Tests.RunUntilManager(runner) as context:
-            context.run_until('setup_services')
+            context.run_until('import_metric_providers')
     assert str(e.value) == 'Your compose file does contain a key that GMT does not support - Please check if the container will still run as intended. If you want to ignore this error you can add the attribute `ignore-unsupported-compose: true` to your usage_scenario.yml\nError: ["Wrong key \'blkio_config\' in {\'image\': \'alpine\', \'blkio_config\': {\'weight\': 300}}"]'
 
 def test_skip_unsupported_compose():
@@ -468,7 +489,7 @@ def test_depends_on_healthcheck_error_max_waiting_time():
 def test_network_created():
     runner = ScenarioRunner(uri=GMT_DIR, uri_type='folder', filename='tests/data/usage_scenarios/network_stress.yml', skip_system_checks=True, dev_no_metrics=True, dev_no_phase_stats=True, dev_no_sleeps=True, dev_cache_build=True)
     with Tests.RunUntilManager(runner) as context:
-        context.run_until('setup_services')
+        context.run_until('setup_networks')
         ps = subprocess.run(
             ['docker', 'network', 'ls'],
             check=True,