Reworked scenario name

The scenario name cannot be configured through`molecule.yml`. It is determined by the directory name of the scenario. The config value references a `MOLECULE_SCENARIO_NAME` environment variable, which is correctly interpolated. However, it provided so that the config is symmetrical. It may be removed in the future, if the source of much confusion.
ansible · May 19, 2017 · 0c6a033 · 0c6a033
1 parent 1771dbf
commit 0c6a033
Show file tree

Hide file tree

Showing 32 changed files with 77 additions and 50 deletions.
diff --git a/molecule/config.py b/molecule/config.py
@@ -75,10 +75,12 @@ def __init__(self, molecule_file, args={}, command_args={}):
          the CLI.
         :returns: None
         """
-        # TODO(retr0h): This file should be merged.
         self.molecule_file = molecule_file
         self.args = args
         self.command_args = command_args
+        # NOTE(retr0h): Crude way to determine sceanrio name, before the
+        # scenario instance has been initialized.
+        self._scenario_name = scenario.name(scenario.directory(molecule_file))
         self.config = self._combine()
 
     @property
@@ -213,8 +215,9 @@ def _combine(self):
 
         :return: dict
         """
-        i = interpolation.Interpolator(interpolation.TemplateWithDefaults,
-                                       os.environ)
+        env = self.merge_dicts(os.environ.copy(),
+                               {'MOLECULE_SCENARIO_NAME': self._scenario_name})
+        i = interpolation.Interpolator(interpolation.TemplateWithDefaults, env)
 
         base = self._get_defaults()
         with open(self.molecule_file, 'r') as stream:

diff --git a/...er/docker/{{cookiecutter.molecule_directory}}/{{cookiecutter.scenario_name}}/molecule.yml b/...er/docker/{{cookiecutter.molecule_directory}}/{{cookiecutter.scenario_name}}/molecule.yml
@@ -10,6 +10,6 @@ platforms:
 provisioner:
   name: {{ cookiecutter.provisioner_name }}
 scenario:
-  name: {{ cookiecutter.scenario_name }}
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: {{ cookiecutter.verifier_name }}
diff --git a/...river/ec2/{{cookiecutter.molecule_directory}}/{{cookiecutter.scenario_name}}/molecule.yml b/...river/ec2/{{cookiecutter.molecule_directory}}/{{cookiecutter.scenario_name}}/molecule.yml
@@ -10,6 +10,6 @@ platforms:
 provisioner:
   name: {{ cookiecutter.provisioner_name }}
 scenario:
-  name: {{ cookiecutter.scenario_name }}
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: {{ cookiecutter.verifier_name }}
diff --git a/...river/lxc/{{cookiecutter.molecule_directory}}/{{cookiecutter.scenario_name}}/molecule.yml b/...river/lxc/{{cookiecutter.molecule_directory}}/{{cookiecutter.scenario_name}}/molecule.yml
@@ -10,6 +10,6 @@ platforms:
 provisioner:
   name: {{ cookiecutter.provisioner_name }}
 scenario:
-  name: {{ cookiecutter.scenario_name }}
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: {{ cookiecutter.verifier_name }}
diff --git a/...river/lxd/{{cookiecutter.molecule_directory}}/{{cookiecutter.scenario_name}}/molecule.yml b/...river/lxd/{{cookiecutter.molecule_directory}}/{{cookiecutter.scenario_name}}/molecule.yml
@@ -10,6 +10,6 @@ platforms:
 provisioner:
   name: {{ cookiecutter.provisioner_name }}
 scenario:
-  name: {{ cookiecutter.scenario_name }}
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: {{ cookiecutter.verifier_name }}
diff --git a/...openstack/{{cookiecutter.molecule_directory}}/{{cookiecutter.scenario_name}}/molecule.yml b/...openstack/{{cookiecutter.molecule_directory}}/{{cookiecutter.scenario_name}}/molecule.yml
@@ -10,6 +10,6 @@ platforms:
 provisioner:
   name: {{ cookiecutter.provisioner_name }}
 scenario:
-  name: {{ cookiecutter.scenario_name }}
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: {{ cookiecutter.verifier_name }}
diff --git a/...r/vagrant/{{cookiecutter.molecule_directory}}/{{cookiecutter.scenario_name}}/molecule.yml b/...r/vagrant/{{cookiecutter.molecule_directory}}/{{cookiecutter.scenario_name}}/molecule.yml
@@ -10,6 +10,6 @@ platforms:
 provisioner:
   name: {{ cookiecutter.provisioner_name }}
 scenario:
-  name: {{ cookiecutter.scenario_name }}
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: {{ cookiecutter.verifier_name }}
diff --git a/molecule/scenario.py b/molecule/scenario.py
@@ -53,6 +53,15 @@ class Scenario(object):
 
     A good source of examples are the `scenario`_ functional tests.
 
+    .. important::
+
+        The scenario name cannot be configured through `molecule.yml`.  It is
+        determined by the directory name of the scenario.  The config value
+        references a `MOLECULE_SCENARIO_NAME` environment variable, which is
+        correctly interpolated.  However, it provided so that the config is
+        symmetrical.  It may be removed in the future, if the source of much
+        confusion.
+
     .. _`scenario`: https://github.com/metacloud/molecule/tree/v2/test/scenarios/driver
     """  # noqa
 
@@ -67,11 +76,11 @@ def __init__(self, config):
 
     @property
     def name(self):
-        return self._config.config['scenario']['name']
+        return name(self.directory)
 
     @property
     def directory(self):
-        return os.path.dirname(self._config.molecule_file)
+        return directory(self._config.molecule_file)
 
     @property
     def check_sequence(self):
@@ -84,3 +93,10 @@ def converge_sequence(self):
     @property
     def test_sequence(self):
         return self._config.config['scenario']['test_sequence']
+
+
+def name(path):
+    return os.path.basename(path)
+
+def directory(path):
+    return os.path.dirname(path)
diff --git a/test/scenarios/dependency/molecule/ansible-galaxy/molecule.yml b/test/scenarios/dependency/molecule/ansible-galaxy/molecule.yml
@@ -1,18 +1,18 @@
 ---
 dependency:
-    name: galaxy
+  name: galaxy
 driver:
-    name: docker
+  name: docker
 lint:
-    name: ansible-lint
+  name: ansible-lint
 platforms:
   - name: instance-1
 provisioner:
-    name: ansible
-    playbooks:
-      setup: ../../../../resources/playbooks/docker/create.yml
-      teardown: ../../../../resources/playbooks/docker/destroy.yml
+  name: ansible
+  playbooks:
+    setup: ../../../../resources/playbooks/docker/create.yml
+    teardown: ../../../../resources/playbooks/docker/destroy.yml
 scenario:
-    name: ansible-galaxy
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
-    name: testinfra
+  name: testinfra
diff --git a/test/scenarios/dependency/molecule/gilt/molecule.yml b/test/scenarios/dependency/molecule/gilt/molecule.yml
@@ -1,18 +1,18 @@
 ---
 dependency:
-    name: gilt
+  name: gilt
 driver:
-    name: docker
+  name: docker
 lint:
-    name: ansible-lint
+  name: ansible-lint
 platforms:
   - name: instance-1
 provisioner:
-    name: ansible
-    playbooks:
-      setup: ../../../../resources/playbooks/docker/create.yml
-      teardown: ../../../../resources/playbooks/docker/destroy.yml
+  name: ansible
+  playbooks:
+    setup: ../../../../resources/playbooks/docker/create.yml
+    teardown: ../../../../resources/playbooks/docker/destroy.yml
 scenario:
-    name: gilt
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
-    name: testinfra
+  name: testinfra
diff --git a/test/scenarios/driver/docker/molecule/default/molecule.yml b/test/scenarios/driver/docker/molecule/default/molecule.yml
@@ -15,6 +15,6 @@ provisioner:
   env:
     ANSIBLE_ROLES_PATH: ../../../../../../resources/roles/
 scenario:
-  name: default
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/driver/docker/molecule/multi-node/molecule.yml b/test/scenarios/driver/docker/molecule/multi-node/molecule.yml
@@ -22,6 +22,6 @@ provisioner:
   env:
     ANSIBLE_ROLES_PATH: ../../../../../../resources/roles/
 scenario:
-  name: multi-node
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/driver/ec2/molecule/default/molecule.yml b/test/scenarios/driver/ec2/molecule/default/molecule.yml
@@ -15,6 +15,6 @@ provisioner:
   env:
     ANSIBLE_ROLES_PATH: ../../../../../../resources/roles/
 scenario:
-  name: default
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/driver/ec2/molecule/multi-node/molecule.yml b/test/scenarios/driver/ec2/molecule/multi-node/molecule.yml
@@ -22,6 +22,6 @@ provisioner:
   env:
     ANSIBLE_ROLES_PATH: ../../../../../../resources/roles/
 scenario:
-  name: multi-node
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/driver/lxc/molecule/default/molecule.yml b/test/scenarios/driver/lxc/molecule/default/molecule.yml
@@ -15,6 +15,6 @@ provisioner:
   env:
     ANSIBLE_ROLES_PATH: ../../../../../../resources/roles/
 scenario:
-  name: default
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/driver/lxc/molecule/multi-node/molecule.yml b/test/scenarios/driver/lxc/molecule/multi-node/molecule.yml
@@ -22,6 +22,6 @@ provisioner:
   env:
     ANSIBLE_ROLES_PATH: ../../../../../../resources/roles/
 scenario:
-  name: multi-node
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/driver/lxd/molecule/default/molecule.yml b/test/scenarios/driver/lxd/molecule/default/molecule.yml
@@ -15,6 +15,6 @@ provisioner:
   env:
     ANSIBLE_ROLES_PATH: ../../../../../../resources/roles/
 scenario:
-  name: default
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/driver/lxd/molecule/multi-node/molecule.yml b/test/scenarios/driver/lxd/molecule/multi-node/molecule.yml
@@ -22,6 +22,6 @@ provisioner:
   env:
     ANSIBLE_ROLES_PATH: ../../../../../../resources/roles/
 scenario:
-  name: multi-node
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/driver/openstack/molecule/default/molecule.yml b/test/scenarios/driver/openstack/molecule/default/molecule.yml
@@ -15,6 +15,6 @@ provisioner:
   env:
     ANSIBLE_ROLES_PATH: ../../../../../../resources/roles/
 scenario:
-  name: default
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/driver/openstack/molecule/multi-node/molecule.yml b/test/scenarios/driver/openstack/molecule/multi-node/molecule.yml
@@ -22,6 +22,6 @@ provisioner:
   env:
     ANSIBLE_ROLES_PATH: ../../../../../../resources/roles/
 scenario:
-  name: multi-node
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/driver/static/molecule/docker/molecule.yml b/test/scenarios/driver/static/molecule/docker/molecule.yml
@@ -16,6 +16,6 @@ provisioner:
   env:
     ANSIBLE_ROLES_PATH: ../../../../../../resources/roles/
 scenario:
-  name: docker
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/driver/static/molecule/ec2/molecule.yml b/test/scenarios/driver/static/molecule/ec2/molecule.yml
@@ -18,6 +18,6 @@ provisioner:
   env:
     ANSIBLE_ROLES_PATH: ../../../../../../resources/roles/
 scenario:
-  name: ec2
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/driver/static/molecule/openstack/molecule.yml b/test/scenarios/driver/static/molecule/openstack/molecule.yml
@@ -18,6 +18,6 @@ provisioner:
   env:
     ANSIBLE_ROLES_PATH: ../../../../../../resources/roles/
 scenario:
-  name: openstack
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/driver/static/molecule/vagrant/molecule.yml b/test/scenarios/driver/static/molecule/vagrant/molecule.yml
@@ -18,6 +18,6 @@ provisioner:
   env:
     ANSIBLE_ROLES_PATH: ../../../../../../resources/roles/
 scenario:
-  name: vagrant
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/driver/vagrant/molecule/default/molecule.yml b/test/scenarios/driver/vagrant/molecule/default/molecule.yml
@@ -15,6 +15,6 @@ provisioner:
   env:
     ANSIBLE_ROLES_PATH: ../../../../../../resources/roles/
 scenario:
-  name: default
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/driver/vagrant/molecule/multi-node/molecule.yml b/test/scenarios/driver/vagrant/molecule/multi-node/molecule.yml
@@ -22,6 +22,6 @@ provisioner:
   env:
     ANSIBLE_ROLES_PATH: ../../../../../../resources/roles/
 scenario:
-  name: multi-node
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/host_group_vars/molecule/default/molecule.yml b/test/scenarios/host_group_vars/molecule/default/molecule.yml
@@ -26,6 +26,6 @@ provisioner:
     example_1:
       host_group_vars_example_1_child_group_molecule_yml: True
 scenario:
-  name: default
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/interpolation/molecule/default/molecule.yml b/test/scenarios/interpolation/molecule/default/molecule.yml
@@ -13,6 +13,6 @@ provisioner:
     setup: ../../../../resources/playbooks/docker/create.yml
     teardown: ../../../../resources/playbooks/docker/destroy.yml
 scenario:
-  name: default
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: ${VERIFIER_NAME}
diff --git a/test/scenarios/overrride_driver/molecule/default/molecule.yml b/test/scenarios/overrride_driver/molecule/default/molecule.yml
@@ -15,6 +15,6 @@ provisioner:
       setup: ../../../../resources/playbooks/docker/create.yml
       teardown: ../../../../resources/playbooks/docker/destroy.yml
 scenario:
-  name: default
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/scenarios/verifier/molecule/goss/molecule.yml b/test/scenarios/verifier/molecule/goss/molecule.yml
@@ -13,6 +13,6 @@ provisioner:
     setup: ../../../../resources/playbooks/docker/create.yml
     teardown: ../../../../resources/playbooks/docker/destroy.yml
 scenario:
-  name: goss
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: goss
diff --git a/test/scenarios/verifier/molecule/testinfra/molecule.yml b/test/scenarios/verifier/molecule/testinfra/molecule.yml
@@ -13,6 +13,6 @@ provisioner:
     setup: ../../../../resources/playbooks/docker/create.yml
     teardown: ../../../../resources/playbooks/docker/destroy.yml
 scenario:
-  name: testinfra
+  name: ${MOLECULE_SCENARIO_NAME}
 verifier:
   name: testinfra
diff --git a/test/unit/test_scenario.py b/test/unit/test_scenario.py
@@ -55,3 +55,11 @@ def test_test_sequence_property(scenario_instance):
     ]
 
     assert x == scenario_instance.test_sequence
+
+
+def test_name():
+    assert 'baz' == scenario.name('/foo/bar/baz')
+
+
+def test_directory():
+    assert '/foo/bar' == scenario.directory('/foo/bar/baz')