Merge pull request Containers-Testing-Framework#35 from vrutkovs/issue-32

Move common environment.py into file

Author: vrutkovs

ctf_cli/application.py

@@ -24,7 +24,7 @@
 from ctf_cli.config import CTFCliConfig
 from ctf_cli.behave import BehaveWorkingDirectory, BehaveRunner
 from ctf_cli.exceptions import CTFCliError
-from ctf_cli.common_environment import common_environment_py_content, sample_ctl_ctf_config, common_steps_py_content
+from ctf_cli.common_environment import sample_ctl_ctf_config, common_steps_py_content
 
 
 class Application(object):
@@ -66,16 +66,6 @@ def init(self):
             os.mkdir(tests_dir)
             check_call("git add %s" % tests_dir, shell=True)
 
-        env_py_path = os.path.join(tests_dir, "environment.py")
-        if os.path.exists(env_py_path):
-            logger.info("File tests/environment.py already exists")
-        else:
-            logger.info("Creating environment.py")
-            # Create environment.py
-            with open(env_py_path, "w") as f:
-                f.write(common_environment_py_content)
-            check_call("git add %s" % env_py_path, shell=True)
-
         features_dir = os.path.join(tests_dir, "features")
         if os.path.exists(features_dir):
             logger.info("Directory tests/features already exists")

ctf_cli/behave.py

@@ -26,7 +26,8 @@
 from ctf_cli.logger import logger
 from ctf_cli.exceptions import CTFCliError
 from ctf_cli.config import CTFCliConfig
-from ctf_cli.common_environment import common_environment_py_content, common_environment_py_header
+from ctf_cli.common_environment import common_environment_py_header
+from ctf_cli import __path__
 
 class BehaveTestsConfig(object):
     """
@@ -277,10 +278,11 @@ def _write_environment_py(self):
             import_statement = ''
 
         # create the environment.py
-        with open(os.path.join(self._working_dir, 'environment.py'), 'w') as f:
+        with open(os.path.join(self._working_dir, 'environment.py'), 'w') as f, \
+             open(os.path.join(__path__[0], 'common_environment_content.py'), 'r') as src:
             logger.debug("Writing '%s'", os.path.join(self._working_dir, 'environment.py'))
             f.write(common_environment_py_header.format(project_env_py_import=import_statement))
-            f.write(common_environment_py_content)
+            f.write(src.read())
 
     def _add_remote_steps(self):
         """

ctf_cli/common_environment.py

@@ -23,171 +23,6 @@
 {project_env_py_import}
 """
 
-common_environment_py_content = """
-# Some useful functions for your environment.py
-from types import ModuleType
-import tempfile
-import shutil
-import ansible.runner
-import logging
-import re
-import os
-import glob
-import stat
-import inspect
-import copy
-
-def _invoke_other_environment_hooks(*args):
-    # we need a copy of current frame becase it will change
-    frame_globals = copy.copy(inspect.currentframe().f_globals)
-    # get which function invoked us
-    current_function = inspect.stack()[1][3]
-    # iterate for all modules wich ends with _environemnt
-    # and execute current method from them
-    for g in frame_globals:
-        if isinstance(frame_globals[g], ModuleType):
-            if frame_globals[g].__name__.endswith("_environment"):
-                for func_name, func in inspect.getmembers(frame_globals[g], inspect.isfunction):
-                    if func_name == current_function:
-                        func(*args)
-
-
-def before_all(context):
-    _invoke_other_environment_hooks(context)
-    try:
-        ansible_cfg = context.config.userdata['ANSIBLE']
-        inventory = ansible.inventory.Inventory(ansible_cfg)
-    except KeyError:
-        raise Exception("-D ANSIBLE missing")
-    remote_dir = '/var/tmp/dkrfile'
-
-    def open_file(path):
-        context.temp_dir = tempfile.mkdtemp()
-        ret = ansible.runner.Runner(
-            module_name='fetch',
-            inventory=inventory,
-            module_args='src={0} dest={1}'.format(
-                path, context.temp_dir)).run()
-        for host, value in ret['contacted'].iteritems():
-            try:
-                ret_file = open(value['dest'])
-                return ret_file
-            except KeyError:
-                print ("ansible output: {0}".format(ret))
-                raise Exception(value['msg'])
-    context.open_file = open_file
-
-    def run(command):
-        if '{{' in command:
-            command = command.replace("{{", "{{ '{{").replace("}}", "}}' }}")
-        logging.info("Running '%s'" % command)
-        context.result = ansible.runner.Runner(
-            module_name="shell",
-            inventory=inventory,
-            module_args="{0} chdir={1}".format(command, remote_dir)
-        ).run()
-        passed = True
-        # dark means not responding
-        if context.result['dark']:
-            passed = False
-            print(context.result)
-        if not context.result['contacted']:
-            passed = False
-            print ("no contacted hosts")
-        for host, values in context.result['contacted'].iteritems():
-            if values['rc'] != 0:
-                print("On {0} returned {1}".format(host, values['rc']))
-                print("stderr: {0}".format(values['stderr']))
-                print("cmd: {0}".format(values['cmd']))
-                assert False
-            logging.info('stdout:\\n%s' % values['stdout'])
-            if values['stderr']:
-                logging.info('stderr\\n:%s' % values['stderr'])
-            return values['stdout']
-    context.run = run
-
-    def copy_dockerfile():
-
-        try:
-            # copy dockerfile
-            dockerfile = context.config.userdata['DOCKERFILE']
-            dockerfile_dir = os.path.dirname(dockerfile)
-            # create remote directory
-            ansible.runner.Runner(
-                module_name='file',
-                inventory=inventory,
-                module_args='dest={0} state=directory'.format(remote_dir)
-                ).run()
-            # copy dockerfile
-            ansible.runner.Runner(
-                module_name='copy',
-                inventory=inventory,
-                module_args='src={0} dest={1}'.format(dockerfile, remote_dir)
-                ).run()
-            # copy files from dockerfile
-            f_in = open(dockerfile)
-            for path in re.findall('(?:ADD|COPY) ([^ ]+) ', f_in.read()):
-                for glob_path in glob.glob(os.path.join(dockerfile_dir,path)):
-                    # TODO Is there a nicer way to keep permissions?
-                    ansible.runner.Runner(
-                        module_name='copy',
-                        inventory=inventory,
-                        module_args='src={0} dest={1} directory_mode mode={2}'.format(glob_path, remote_dir,
-                            oct(stat.S_IMODE(os.stat(glob_path).st_mode)))
-                    ).run()
-        except Exception as e:
-            logging.warning("copy_dockerfile:%s" % e)
-
-    copy_dockerfile()
-
-    # build image if not exist
-    try:
-        context.image = context.config.userdata['IMAGE']
-        run('docker pull {0}'.format(context.image))
-    except AssertionError:
-        pass
-    except KeyError:
-        context.image = 'ctf'
-        try:
-            run('docker build -t {0} .'.format(context.image))
-        except AssertionError:
-            pass
-
-    cid_file_name = re.sub(r'\W+', '', context.image)
-    context.cid_file = "/tmp/%s.cid" % cid_file_name
-
-def after_scenario(context, scenario):
-    _invoke_other_environment_hooks(context ,scenario)
-    try:
-        if context.config.userdata['KEEP_CONTAINER_AFTER_TEST']:
-            return
-    except KeyError, e:
-        pass
-
-    try:
-        cid = context.run('cat %s' % context.cid_file)
-    except AssertionError, e:
-        logging.info("before_scenario: {0}".format(e))
-        return
-    if cid:
-        context.run("docker logs %s" % cid)
-        try:
-            context.run("docker stop %s" % cid)
-            context.run("docker kill %s" % cid)
-            context.run("docker rm -v %s" % cid)
-        except AssertionError:
-            pass
-        if hasattr(context, 'cid'):
-            del context.cid
-        context.run('rm {0}'.format(context.cid_file))
-
-
-def after_all(context):
-    _invoke_other_environment_hooks(context)
-    if hasattr(context, 'temp_dir'):
-        shutil.rmtree(context.temp_dir) #FIXME catch exception
-
-"""
 
 sample_ctl_ctf_config = """
 [ctf]

ctf_cli/common_environment_content.py

@@ -0,0 +1,162 @@
+# Some useful functions for your environment.py
+from types import ModuleType
+import tempfile
+import shutil
+import ansible.runner
+import logging
+import re
+import os
+import glob
+import stat
+import inspect
+import copy
+
+
+def _invoke_other_environment_hooks(*args):
+    # we need a copy of current frame becase it will change
+    frame_globals = copy.copy(inspect.currentframe().f_globals)
+    # get which function invoked us
+    current_function = inspect.stack()[1][3]
+    # iterate for all modules wich ends with _environemnt
+    # and execute current method from them
+    for g in frame_globals:
+        if isinstance(frame_globals[g], ModuleType):
+            if frame_globals[g].__name__.endswith("_environment"):
+                for func_name, func in inspect.getmembers(frame_globals[g], inspect.isfunction):
+                    if func_name == current_function:
+                        func(*args)
+
+
+def before_all(context):
+    _invoke_other_environment_hooks(context)
+    try:
+        ansible_cfg = context.config.userdata['ANSIBLE']
+        inventory = ansible.inventory.Inventory(ansible_cfg)
+    except KeyError:
+        raise Exception("-D ANSIBLE missing")
+    remote_dir = '/var/tmp/dkrfile'
+
+    def open_file(path):
+        context.temp_dir = tempfile.mkdtemp()
+        ret = ansible.runner.Runner(
+            module_name='fetch',
+            inventory=inventory,
+            module_args='src={0} dest={1}'.format(
+                path, context.temp_dir)).run()
+        for host, value in ret['contacted'].iteritems():
+            try:
+                ret_file = open(value['dest'])
+                return ret_file
+            except KeyError:
+                print("ansible output: {0}".format(ret))
+                raise Exception(value['msg'])
+    context.open_file = open_file
+
+    def run(command):
+        if '{{' in command:
+            command = command.replace("{{", "{{ '{{").replace("}}", "}}' }}")
+        logging.info("Running '%s'" % command)
+        context.result = ansible.runner.Runner(
+            module_name="shell",
+            inventory=inventory,
+            module_args="{0} chdir={1}".format(command, remote_dir)
+        ).run()
+        # dark means not responding
+        if context.result['dark']:
+            print(context.result)
+        if not context.result['contacted']:
+            print("no contacted hosts")
+        for host, values in context.result['contacted'].iteritems():
+            if values['rc'] != 0:
+                print("On {0} returned {1}".format(host, values['rc']))
+                print("stderr: {0}".format(values['stderr']))
+                print("cmd: {0}".format(values['cmd']))
+                assert False
+            logging.info('stdout:\\n%s' % values['stdout'])
+            if values['stderr']:
+                logging.info('stderr\\n:%s' % values['stderr'])
+            return values['stdout']
+    context.run = run
+
+    def copy_dockerfile():
+
+        try:
+            # copy dockerfile
+            dockerfile = context.config.userdata['DOCKERFILE']
+            dockerfile_dir = os.path.dirname(dockerfile)
+            # create remote directory
+            ansible.runner.Runner(
+                module_name='file',
+                inventory=inventory,
+                module_args='dest={0} state=directory'.format(remote_dir)
+                ).run()
+            # copy dockerfile
+            ansible.runner.Runner(
+                module_name='copy',
+                inventory=inventory,
+                module_args='src={0} dest={1}'.format(dockerfile, remote_dir)
+                ).run()
+            # copy files from dockerfile
+            f_in = open(dockerfile)
+            for path in re.findall('(?:ADD|COPY) ([^ ]+) ', f_in.read()):
+                for glob_path in glob.glob(os.path.join(dockerfile_dir, path)):
+                    # TODO Is there a nicer way to keep permissions?
+                    ansible.runner.Runner(
+                        module_name='copy',
+                        inventory=inventory,
+                        module_args='src={0} dest={1} directory_mode mode={2}'.format(
+                            glob_path, remote_dir,
+                            oct(stat.S_IMODE(os.stat(glob_path).st_mode)))
+                    ).run()
+        except Exception as e:
+            logging.warning("copy_dockerfile:%s" % e)
+
+    copy_dockerfile()
+
+    # build image if not exist
+    try:
+        context.image = context.config.userdata['IMAGE']
+        run('docker pull {0}'.format(context.image))
+    except AssertionError:
+        pass
+    except KeyError:
+        context.image = 'ctf'
+        try:
+            run('docker build -t {0} .'.format(context.image))
+        except AssertionError:
+            pass
+
+    cid_file_name = re.sub(r'\W+', '', context.image)
+    context.cid_file = "/tmp/%s.cid" % cid_file_name
+
+
+def after_scenario(context, scenario):
+    _invoke_other_environment_hooks(context, scenario)
+    try:
+        if context.config.userdata['KEEP_CONTAINER_AFTER_TEST']:
+            return
+    except KeyError as e:
+        pass
+
+    try:
+        cid = context.run('cat %s' % context.cid_file)
+    except AssertionError as e:
+        logging.info("before_scenario: {0}".format(e))
+        return
+    if cid:
+        context.run("docker logs %s" % cid)
+        try:
+            context.run("docker stop %s" % cid)
+            context.run("docker kill %s" % cid)
+            context.run("docker rm -v %s" % cid)
+        except AssertionError:
+            pass
+        if hasattr(context, 'cid'):
+            del context.cid
+        context.run('rm {0}'.format(context.cid_file))
+
+
+def after_all(context):
+    _invoke_other_environment_hooks(context)
+    if hasattr(context, 'temp_dir'):
+        shutil.rmtree(context.temp_dir)  # FIXME catch exception