adds PopperTest class and popper versoin test (#803)

Adds a PopperTest class that other unit tests can derive from in order
to make use of generic testing functionality. Currently this contains a
`mk_repo()` function that takes care of initializing a git repo with a
`README` file in it.

In addition, a test for the `popper version` command has been added
that makes use of Click's unit testing features that allow to test CLI
functionality. This will eventually replace the pipeline in the `ci/` folder.

cli/test/test_cmdversion.py

@@ -0,0 +1,17 @@
+from click.testing import CliRunner
+import popper.commands.cmd_version as version
+import unittest
+from test_common import PopperTest
+from popper import __version__ as version_value
+
+
+class TestCommandVersion(PopperTest):
+
+    def test_version(self):
+
+        with self.assertLogs('popper') as test:
+            runner = CliRunner()
+            result = runner.invoke(version.cli)
+            self.assertEqual(result.exit_code, 0)
+
+        self.assertTrue(version_value in test.output[0])

cli/test/test_common.py

@@ -0,0 +1,41 @@
+import os
+import sys
+import shutil
+import contextlib
+import subprocess
+import tempfile
+import git
+import unittest
+
+FIXDIR = f'{os.path.dirname(os.path.realpath(__file__))}/fixtures'
+
+
+class PopperTest(unittest.TestCase):
+
+    def mk_repo(self):
+        """creates a test repo in a random temp file. Equivalent to:
+        REPODIR=/tmp/<random>
+        mkdir $REPODIR
+        cd $REPODIR
+        git init
+        touch README.md
+        git add .
+        git commit -m 'first commit'
+        """
+        tempdir = tempfile.mkdtemp()
+        repo = git.Repo.init(tempdir)
+        readme = os.path.join(tempdir, 'README.md')
+        open(readme, 'w').close()
+        repo.index.add([readme])
+        repo.index.commit('first commit')
+        return repo
+
+
+class PopperCommonTest(PopperTest):
+
+    def test_mkrepo(self):
+
+        repo = self.mk_repo()
+        self.assertTrue(os.path.isdir(repo.working_tree_dir))
+        self.assertTrue(os.path.isfile(
+            os.path.join(repo.working_tree_dir, 'README.md')))

cli/test/test_config.py

@@ -3,11 +3,11 @@
 
 from popper.config import PopperConfig
 from popper.cli import log
+from test_common import PopperTest
 
 
 FIXDIR = f'{os.path.dirname(os.path.realpath(__file__))}/fixtures'
 
-
 class TestPopperConfig(unittest.TestCase):
     default_args = {
         'skip_clone': False,

cli/test/test_runner_host.py

@@ -6,7 +6,6 @@
 
 import docker
 
-import utils as testutils
 import popper.utils as pu
 
 from testfixtures import LogCapture
@@ -15,15 +14,20 @@
 from popper.parser import YMLWorkflow
 from popper.runner import WorkflowRunner
 from popper.runner_host import HostRunner, DockerRunner
+
+
+from test_common import PopperTest
+
 from popper.cli import log as log
 
 
-class TestHostHostRunner(unittest.TestCase):
+class TestHostHostRunner(PopperTest):
     def setUp(self):
         log.setLevel('CRITICAL')
 
     def test_run(self):
-        repo = testutils.mk_repo()
+
+        repo = self.mk_repo()
         conf = PopperConfig(workspace_dir=repo.working_dir)
 
         with WorkflowRunner(conf) as r:
@@ -97,7 +101,7 @@ def test_stop_running_tasks(self):
         self.assertRaises(ProcessLookupError, os.kill, pid, 0)
 
 
-class TestHostDockerRunner(unittest.TestCase):
+class TestHostDockerRunner(PopperTest):
     def setUp(self):
         log.setLevel('CRITICAL')
 
@@ -212,7 +216,8 @@ def test_get_build_info(self):
 
     @unittest.skipIf(os.environ['ENGINE'] != 'docker', 'ENGINE != docker')
     def test_docker_basic_run(self):
-        repo = testutils.mk_repo()
+
+        repo = self.mk_repo()
         conf = PopperConfig(workspace_dir=repo.working_dir)
 
         with WorkflowRunner(conf) as r:

cli/test/test_runner_slurm.py

@@ -1,14 +1,14 @@
 import os
 import unittest
 import tempfile
-import utils as testutils
 
 from popper.config import PopperConfig
 from popper.runner import WorkflowRunner
 from popper.parser import YMLWorkflow
 from popper.runner_slurm import SlurmRunner, DockerRunner
 from popper.cli import log as log
 
+from test_common import PopperTest
 from testfixtures import Replacer, replace, compare
 from testfixtures.popen import MockPopen
 from testfixtures.mock import call
@@ -18,7 +18,7 @@ def mock_kill(pid, sig):
     return 0
 
 
-class TestSlurmSlurmRunner(unittest.TestCase):
+class TestSlurmSlurmRunner(PopperTest):
     def setUp(self):
         log.setLevel('CRITICAL')
         self.Popen = MockPopen()
@@ -152,7 +152,7 @@ def test_submit_job_failure(self, mock_kill):
             self.assertEqual(call_sbatch in self.Popen.all_calls, True)
 
     def test_dry_run(self):
-        repo = testutils.mk_repo()
+        repo = self.mk_repo()
         config = PopperConfig(
             engine_name='docker',
             resman_name='slurm',