Merge lp:~elopio/snapcraft/test_tmp_cwd into lp:~snappy-dev/snapcraft/core

[Leo Arias]

Use a temporary cwd during the tests.
Added python3-fixtures as a build dependency.

There are some tests that generate directories.
If they are run in the branch directory, then it will be polluted.
By changing to a tmp dir, every test can generate whatever it wants and then it will be cleaned up.

[Michael Terry (mterry)]

Sure, looks good. mvo's copy-plugin branch [1] did something similar, but it was opt-in instead of automatic. This is more fool-proof.

[1] https://code.launchpad.net/~mvo/snapcraft/copy-plugin/+merge/264706

review: Approve

[Snappy Tarmac (snappydevtarmac)]

The attempt to merge lp:~elopio/snapcraft/test_tmp_cwd into lp:snapcraft failed. Below is the output from the failed tests.

EEE
======================================================================
ERROR: snapcraft.tests.test_cmds (unittest.loader.ModuleImportFailure)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python3.4/unittest/case.py", line 57, in testPartExecutor
    yield
  File "/usr/lib/python3.4/unittest/case.py", line 574, in run
    testMethod()
  File "/usr/lib/python3.4/unittest/loader.py", line 32, in testFailure
    raise exception
ImportError: Failed to import test module: snapcraft.tests.test_cmds
Traceback (most recent call last):
  File "/usr/lib/python3.4/unittest/loader.py", line 312, in _find_tests
    module = self._get_module_from_name(name)
  File "/usr/lib/python3.4/unittest/loader.py", line 290, in _get_module_from_name
    __import__(name)
  File "/tmp/tarmac/branch.JBZ6bx/snapcraft/tests/__init__.py", line 17, in <module>
    import fixtures
ImportError: No module named 'fixtures'

======================================================================
ERROR: snapcraft.tests.test_plugin (unittest.loader.ModuleImportFailure)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python3.4/unittest/case.py", line 57, in testPartExecutor
    yield
  File "/usr/lib/python3.4/unittest/case.py", line 574, in run
    testMethod()
  File "/usr/lib/python3.4/unittest/loader.py", line 32, in testFailure
    raise exception
ImportError: Failed to import test module: snapcraft.tests.test_plugin
Traceback (most recent call last):
  File "/usr/lib/python3.4/unittest/loader.py", line 312, in _find_tests
    module = self._get_module_from_name(name)
  File "/usr/lib/python3.4/unittest/loader.py", line 290, in _get_module_from_name
    __import__(name)
  File "/tmp/tarmac/branch.JBZ6bx/snapcraft/tests/__init__.py", line 17, in <module>
    import fixtures
ImportError: No module named 'fixtures'

======================================================================
ERROR: snapcraft.tests.test_yaml (unittest.loader.ModuleImportFailure)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python3.4/unittest/case.py", line 57, in testPartExecutor
    yield
  File "/usr/lib/python3.4/unittest/case.py", line 574, in run
    testMethod()
  File "/usr/lib/python3.4/unittest/loader.py", line 32, in testFailure
    raise exception
ImportError: Failed to import test module: snapcraft.tests.test_yaml
Traceback (most recent call last):
  File "/usr/lib/python3.4/unittest/loader.py", line 312, in _find_tests
    module = self._get_module_from_name(name)
  File "/usr/lib/python3.4/unittest/loader.py", line 290, in _get_module_from_name
    __import__(name)
  File "/tmp/tarmac/branch.JBZ6bx/snapcraft/tests/__init__.py", line 17, in <module>
    import fixtures
ImportError: No module named 'fixtures'

----------------------------------------------------------------------
Ran 3 tests in 0.002s

FAILED (errors=3)

[Michael Terry (mterry)]

Tarmac instance doesn't have python3-fixtures installed... let me see.

[Michael Terry (mterry)]

Manually merged.

=== modified file 'debian/control'
--- debian/control	2015-07-17 13:21:14 +0000
+++ debian/control	2015-07-21 03:25:30 +0000
@@ -10,6 +10,7 @@
                pyflakes,
                python3,
                python3-apt,
+               python3-fixtures,
                python3-setuptools,
                python3-yaml,
 Homepage: https://launchpad.net/snapcraft
 
=== modified file 'snapcraft/tests/__init__.py'
--- snapcraft/tests/__init__.py	2015-07-15 08:57:44 +0000
+++ snapcraft/tests/__init__.py	2015-07-21 03:25:30 +0000
@@ -14,12 +14,15 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-import unittest
+import fixtures
 
 import snapcraft.dirs
-
-
-class TestCase(unittest.TestCase):
+from snapcraft.tests import fixture_setup
+
+
+class TestCase(fixtures.TestWithFixtures):
+
     def setUp(self):
         super().setUp()
         snapcraft.dirs.setup_dirs()
+        self.useFixture(fixture_setup.TempCWD())
 
=== added file 'snapcraft/tests/fixture_setup.py'
--- snapcraft/tests/fixture_setup.py	1970-01-01 00:00:00 +0000
+++ snapcraft/tests/fixture_setup.py	2015-07-21 03:25:30 +0000
@@ -0,0 +1,29 @@
+# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
+#
+# Copyright (C) 2015 Canonical Ltd
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+
+import fixtures
+
+
+class TempCWD(fixtures.TempDir):
+
+    def setUp(self):
+        """Create a temporary directory an cd into it for the test duration."""
+        super().setUp()
+        current_dir = os.getcwd()
+        self.addCleanup(os.chdir, current_dir)
+        os.chdir(self.path)