Env vars numbers tests (#546)

* Added tests and changed test logic to also check for valid results and include all env vars

* expanded usage scenario unallowed vars unit tests to check each case

* run usage scenario env var unit tests with dry-run to save time

---------

Co-authored-by: dan-mm <[email protected]>

Author: ArneTR

tests/data/usage_scenarios/env_vars_stress.yml

@@ -11,6 +11,7 @@ services:
     build: .
     environment:
       TESTALLOWED: 'alpha-num123_'
+      TEST1_ALLOWED: 'alpha-key-num123_'
 flow:
   - name: Stress
     container: test-container

tests/data/usage_scenarios/env_vars_stress_unallowed.yml

@@ -10,6 +10,7 @@ services:
     build: .
     environment:
       TESTALLOWED: 'alpha-num123_'
+      TEST1_ALLOWED: 'alpha-key-num123_'
       TESTBACKTICK: '`'
       TESTDOLLAR: '$'
       TESTPARENTHESIS: '()'

tests/data/usage_scenarios/env_vars_stress_unallowed_backtick.yml

@@ -0,0 +1,22 @@
+---
+name: Test Stress
+author: Dan Mateas
+description: test
+
+services:
+  test-container:
+    type: container
+    image: gcb_stress
+    build: .
+    environment:
+      TESTALLOWED: 'alpha-num123_'
+      TEST1_ALLOWED: 'alpha-key-num123_'
+      TESTBACKTICK: '`'
+
+flow:
+  - name: Stress
+    container: test-container
+    commands:
+      - type: console
+        command: stress-ng -c 1 -t 1 -q
+        note: Starting Stress

tests/data/usage_scenarios/env_vars_stress_unallowed_dollar.yml

@@ -0,0 +1,22 @@
+---
+name: Test Stress
+author: Dan Mateas
+description: test
+
+services:
+  test-container:
+    type: container
+    image: gcb_stress
+    build: .
+    environment:
+      TESTALLOWED: 'alpha-num123_'
+      TEST1_ALLOWED: 'alpha-key-num123_'
+      TESTDOLLAR: '$'
+
+flow:
+  - name: Stress
+    container: test-container
+    commands:
+      - type: console
+        command: stress-ng -c 1 -t 1 -q
+        note: Starting Stress

tests/data/usage_scenarios/env_vars_stress_unallowed_paren.yml

@@ -0,0 +1,22 @@
+---
+name: Test Stress
+author: Dan Mateas
+description: test
+
+services:
+  test-container:
+    type: container
+    image: gcb_stress
+    build: .
+    environment:
+      TESTALLOWED: 'alpha-num123_'
+      TEST1_ALLOWED: 'alpha-key-num123_'
+      TESTPARENTHESIS: '()'
+
+flow:
+  - name: Stress
+    container: test-container
+    commands:
+      - type: console
+        command: stress-ng -c 1 -t 1 -q
+        note: Starting Stress

tests/test_functions.py

@@ -35,7 +35,8 @@ def replace_include_in_usage_scenario(usage_scenario_path, docker_compose_filena
 
 def setup_runner(usage_scenario, docker_compose=None, uri='default', uri_type='folder', branch=None,
         debug_mode=False, allow_unsafe=False, no_file_cleanup=False,
-        skip_unsafe=False, verbose_provider_boot=False, dir_name=None, dev_repeat_run=True, skip_system_checks=True):
+        skip_unsafe=False, verbose_provider_boot=False, dir_name=None, dev_repeat_run=True, skip_system_checks=True,
+        dry_run=False):
     usage_scenario_path = os.path.join(CURRENT_DIR, 'data/usage_scenarios/', usage_scenario)
     if docker_compose is not None:
         docker_compose_path = os.path.join(CURRENT_DIR, 'data/docker-compose-files/', docker_compose)
@@ -53,7 +54,7 @@ def setup_runner(usage_scenario, docker_compose=None, uri='default', uri_type='f
     return Runner(name=RUN_NAME, uri=uri, uri_type=uri_type, filename=usage_scenario, branch=branch,
         debug_mode=debug_mode, allow_unsafe=allow_unsafe, no_file_cleanup=no_file_cleanup,
         skip_unsafe=skip_unsafe, verbose_provider_boot=verbose_provider_boot, dev_repeat_run=dev_repeat_run,
-        skip_system_checks=skip_system_checks)
+        skip_system_checks=skip_system_checks, dry_run=dry_run)
 
 # This function runs the runner up to and *including* the specified step
 # remember to catch in try:finally and do cleanup when calling this!

tests/test_usage_scenario.py

@@ -59,7 +59,7 @@ def get_env_vars(runner):
 
         ps = subprocess.run(
             ['docker', 'exec', 'test-container', '/bin/sh',
-            '-c', 'echo $TESTALLOWED'],
+            '-c', 'env'],
             check=True,
             stderr=subprocess.PIPE,
             stdout=subprocess.PIPE,
@@ -70,23 +70,54 @@ def get_env_vars(runner):
         Tests.cleanup(runner)
     return env_var_output
 
-def test_env_variable_no_skip_or_allow():
-    runner = Tests.setup_runner(usage_scenario='env_vars_stress_unallowed.yml')
+def test_env_variable_with_incorrect_envs_no_flags_backtick():
+    runner = Tests.setup_runner(usage_scenario='env_vars_stress_unallowed_backtick.yml', dry_run=True)
     with pytest.raises(RuntimeError) as e:
         get_env_vars(runner)
     expected_exception = 'Docker container setup environment var value had wrong format.'
     assert expected_exception in str(e.value), \
         Tests.assertion_info(f"Exception: {expected_exception}", str(e.value))
 
+def test_env_variable_with_incorrect_envs_no_flags_dollar():
+    runner = Tests.setup_runner(usage_scenario='env_vars_stress_unallowed_dollar.yml', dry_run=True)
+    with pytest.raises(RuntimeError) as e:
+        get_env_vars(runner)
+    expected_exception = 'Docker container setup environment var value had wrong format.'
+    assert expected_exception in str(e.value), \
+        Tests.assertion_info(f"Exception: {expected_exception}", str(e.value))
+
+def test_env_variable_with_incorrect_envs_no_flags_paren():
+    runner = Tests.setup_runner(usage_scenario='env_vars_stress_unallowed_paren.yml', dry_run=True)
+    with pytest.raises(RuntimeError) as e:
+        get_env_vars(runner)
+    expected_exception = 'Docker container setup environment var value had wrong format.'
+    assert expected_exception in str(e.value), \
+        Tests.assertion_info(f"Exception: {expected_exception}", str(e.value))
+
+def test_env_variable_unsafe_false():
+    runner = Tests.setup_runner(usage_scenario='env_vars_stress.yml', skip_unsafe=False, dry_run=True)
+    env_var_output = get_env_vars(runner)
+    print("Env var output is ", env_var_output)
+    assert 'TESTALLOWED=alpha-num123_' in env_var_output, Tests.assertion_info('TESTALLOWED=alpha-num123_', env_var_output)
+    assert 'TEST1_ALLOWED=alpha-key-num123_' in env_var_output, Tests.assertion_info('TEST1_ALLOWED=alpha-key-num123_', env_var_output)
+
 def test_env_variable_skip_unsafe_true():
-    runner = Tests.setup_runner(usage_scenario='env_vars_stress.yml', skip_unsafe=True)
+    runner = Tests.setup_runner(usage_scenario='env_vars_stress_unallowed.yml', skip_unsafe=True, dry_run=True)
     env_var_output = get_env_vars(runner)
-    assert env_var_output == 'alpha-num123_\n', Tests.assertion_info('alpha-num123_', env_var_output)
+    assert 'TESTALLOWED=alpha-num123_' in env_var_output, Tests.assertion_info('TESTALLOWED=alpha-num123_', env_var_output)
+    assert 'TEST1_ALLOWED=alpha-key-num123_' in env_var_output, Tests.assertion_info('TEST1_ALLOWED=alpha-key-num123_', env_var_output)
+    assert 'TESTBACKTICK' not in env_var_output, Tests.assertion_info('TESTBACKTICK', env_var_output)
+    assert 'TESTDOLLAR' not in env_var_output, Tests.assertion_info('TESTDOLLAR', env_var_output)
+    assert 'TESTPARENTHESIS' not in env_var_output, Tests.assertion_info('TESTPARENTHESIS', env_var_output)
 
 def test_env_variable_allow_unsafe_true():
-    runner = Tests.setup_runner(usage_scenario='env_vars_stress.yml', allow_unsafe=True)
+    runner = Tests.setup_runner(usage_scenario='env_vars_stress_unallowed.yml', allow_unsafe=True, dry_run=True)
     env_var_output = get_env_vars(runner)
-    assert env_var_output == 'alpha-num123_\n', Tests.assertion_info('alpha-num123_', env_var_output)
+    assert 'TESTALLOWED=alpha-num123_' in env_var_output, Tests.assertion_info('TESTALLOWED=alpha-num123_', env_var_output)
+    assert 'TEST1_ALLOWED=alpha-key-num123_' in env_var_output, Tests.assertion_info('TEST1_ALLOWED=alpha-key-num123_', env_var_output)
+    assert 'TESTBACKTICK' in env_var_output, Tests.assertion_info('TESTBACKTICK', env_var_output)
+    assert 'TESTDOLLAR' in env_var_output, Tests.assertion_info('TESTDOLLAR', env_var_output)
+    assert 'TESTPARENTHESIS' in env_var_output, Tests.assertion_info('TESTPARENTHESIS', env_var_output)
 
 # ports: [int:int] (optional)
 # Docker container portmapping on host OS to be used with --allow-unsafe flag.