Merge pull request #8 from frigg/fix-tests

Fix tests and bugs that the tests uncovered

Author: relekang

docker/manager.py

@@ -1,6 +1,7 @@
 import datetime
 import logging
 import os
+import re
 import subprocess
 from time import sleep
 
@@ -25,21 +26,31 @@ def _execute(cmd):
     result.out = stdout.decode('utf-8').strip() if stdout else ''
     result.err = stderr.decode('utf-8').strip() if stderr else ''
     result.return_code = process.returncode
-    result.succeeded = result.return_code == 0
     logger.debug('Finished running of: {0}'.format(result.__dict__))
     return result
 
 
 class ProcessResult(object):
+    return_code = None
+    out = ''
+    err = ''
+
     def __init__(self, command):
         self.command = command
 
+    @property
+    def succeeded(self):
+        if self.return_code is None:
+            return None
+        return self.return_code == 0
+
 
 class Docker(object):
-    def __init__(self, image='ubuntu', timeout=3600):
+    def __init__(self, image='ubuntu', timeout=3600, combine_outputs=False):
         self.container_name = 'dyn-{0}'.format(int(datetime.datetime.now().strftime('%s')) * 1000)
         self.timeout = timeout
         self.image = image
+        self.combine_outputs = combine_outputs
 
     def __enter__(self):
         return self.start()
@@ -49,10 +60,23 @@ def __exit__(self, exc_type, exc_val, exc_tb):
 
     def run(self, cmd, working_directory=''):
         working_directory = self._get_working_directory(working_directory)
-        return _execute('docker exec -i {container} bash -c "{command}"'.format(
-            container=self.container_name,
-            command='cd {0} && {1}'.format(working_directory, cmd)
-        ))
+        command_string = 'cd {working_directory} && {command}'
+        if self.combine_outputs:
+            command_string += ' 2>&1'
+        result = _execute(
+            'docker exec -i {container} bash -c \'{command} ;  echo "--return-$?--"\''.format(
+                container=self.container_name,
+                command=command_string.format(working_directory=working_directory, command=cmd)
+            )
+        )
+
+        return_code_match = re.search(r'(?:\\n)?--return-(\d+)--$', result.out)
+        if return_code_match:
+            result.return_code = int(return_code_match.group(1))
+            result.out = result.out.replace(return_code_match.group(0), '')
+            if result.out.endswith('\n'):
+                result.out = result.out[:len(result.out) - 1]
+        return result
 
     def read_file(self, path):
         path = self._get_working_directory(path)
@@ -147,6 +171,6 @@ def wrapper(*args, **kwargs):
 
     @staticmethod
     def _get_working_directory(working_directory):
-        if not working_directory.startswith('/'):
-            working_directory = '~/{}'.format(working_directory)
-        return working_directory
+        if working_directory.startswith('/') or working_directory.startswith('~/'):
+            return working_directory
+        return '~/{}'.format(working_directory)

tests/test_manager.py

@@ -9,56 +9,16 @@
     import mock
 
 
-class DockerBasicInteractionTests(unittest.TestCase):
-
-    def test_create_files(self):
-        with Docker() as docker:
-            docker.run('touch file1')
-            docker.run('touch file2')
-            self.assertEqual(docker.list_files(''), ['file1', 'file2'])
-
-    def test_create_directories(self):
-        with Docker() as docker:
-            docker.run('mkdir dir1')
-            docker.run('mkdir dir1/test')
-            docker.run('mkdir dir2')
-            docker.run('mkdir dir3')
-            self.assertEqual(
-                docker.list_directories('', include_trailing_slash=False),
-                ['dir1', 'dir2', 'dir3']
-            )
-
-    def test_create_and_list_files_in_sub_directory(self):
-        with Docker() as docker:
-            docker.run('mkdir builds')
-            docker.run('touch builds/readme.txt')
-
-            self.assertEqual(docker.list_files('builds'), ['readme.txt'])
-
-    def test_create_file_with_content(self):
-        with Docker() as docker:
-            file_name = 'readme.txt'
-            file_content = 'this is a test file'
-
-            self.assertFalse(docker.file_exist(file_name))
-            docker.create_file(file_name, file_content)
-            self.assertTrue(docker.file_exist(file_name))
-
-    def test_read_file_with_content(self):
-        with Docker() as docker:
-            file_name = 'readme.txt'
-            file_content = 'this is a test file {0}'.format(randint(5000, 5500))
-            docker.create_file(file_name, file_content)
-
-            self.assertEqual(docker.read_file(file_name), file_content)
-
-    def test_read_file_that_dont_exist(self):
-        with Docker() as docker:
-            self.assertIsNone(docker.read_file('no-file.txt'))
+class DockerManagerTests(unittest.TestCase):
+    """
+    This test class should contain tests for the docker manager
+    that does not invoke docker.
+    """
 
     def test__get_working_directory(self):
         self.assertEqual(Docker._get_working_directory('directory'), '~/directory')
         self.assertEqual(Docker._get_working_directory('/absolute/path'), '/absolute/path')
+        self.assertEqual(Docker._get_working_directory('~/home/path'), '~/home/path')
 
     @mock.patch('docker.manager.Docker.stop')
     @mock.patch('docker.manager.Docker.start')
@@ -79,3 +39,66 @@ def wrapped(docker):
         wrapped()
         mock_start.assert_called_once_with()
         mock_stop.assert_called_once_with()
+
+
+class DockerInteractionTests(unittest.TestCase):
+    def setUp(self):
+        self.docker = Docker()
+        self.docker.start()
+
+    def tearDown(self):
+        self.docker.stop()
+
+    def test_create_files(self):
+        self.docker.run('touch file1')
+        self.docker.run('touch file2')
+        self.assertEqual(self.docker.list_files(''), ['file1', 'file2'])
+
+    def test_create_directories(self):
+        self.docker.run('mkdir dir1')
+        self.docker.run('mkdir dir1/test')
+        self.docker.run('mkdir dir2')
+        self.docker.run('mkdir dir3')
+        self.assertEqual(
+            self.docker.list_directories('', include_trailing_slash=False),
+            ['dir1', 'dir2', 'dir3']
+        )
+
+    def test_create_and_list_files_in_sub_directory(self):
+        self.docker.run('mkdir builds')
+        self.docker.run('touch builds/readme.txt')
+
+        self.assertEqual(self.docker.list_files('builds'), ['readme.txt'])
+
+    def test_create_file_with_content(self):
+        file_name = 'readme.txt'
+        file_content = 'this is a test file'
+
+        self.assertFalse(self.docker.file_exist(file_name))
+        self.docker.create_file(file_name, file_content)
+        self.assertTrue(self.docker.file_exist(file_name))
+
+    def test_read_file_with_content(self):
+        file_name = 'readme.txt'
+        file_content = 'this is a test file {0}'.format(randint(5000, 5500))
+        self.docker.run('echo \"{0}\" > ~/{1}; cat readme.txt'.format(file_content, file_name))
+
+        self.assertEqual(self.docker.read_file(file_name), file_content)
+
+    def test_read_file_that_dont_exist(self):
+        self.assertIsNone(self.docker.read_file('no-file.txt'))
+
+    def test_directory_exist(self):
+        self.assertTrue(self.docker.directory_exist('~/'))
+        self.assertFalse(self.docker.directory_exist('does-not-exist'))
+
+    def test_file_exist(self):
+        self.docker.run('touch file')
+        self.assertTrue(self.docker.file_exist('file'))
+        self.assertFalse(self.docker.file_exist('does-not-exist'))
+
+    def test_combine_output(self):
+        self.docker.combine_outputs = True
+        result = self.docker.run('ls does-not-exist')
+        self.assertEqual(result.err, '')
+        self.assertEqual(result.out, 'ls: cannot access does-not-exist: No such file or directory')