Change test runner from nose to py.test (#714)

* Change test runner from nose to py.test

Nose has been deprecated by its authors. py.test is very active, widely
used, and has many useful features for running and writing tests.

Changing the tests themselves away from unittest-style is a different
step that must be taken later. This commit only changes the tooling.

* dag: port tests to pytest

* blueprints: raw: always return absolute template paths

Additionaly, adapt tests to not depend on any fixtures in the test
directory, or on the current working directory of the test runner.

* test: disable deprecation warnings by default due to noise

Author: danielkza

.gitignore

@@ -56,17 +56,13 @@ dist/
 .eggs/
 *.egg
 
-# nosetest --with-coverage dumps these in CWD
+# Coverage artifacts
 .coverage
-
-
-
-vm_setup.sh
+htmlcov
 
 # Ignore development conf/env files
 dev.yaml
 dev.env
-
 tests/fixtures/blueprints/*-result
-
 FakeKey.pem
+vm_setup.sh

Makefile

@@ -8,10 +8,10 @@ lint:
 	flake8 --require-code --min-version=2.7 --ignore FI50,FI51,FI53,FI14,E402,N802,W605 stacker/tests # ignore setUp naming
 
 test-unit: clean
-	python setup.py nosetests
+	python setup.py test
 
 test-unit3: clean
-	python3 setup.py nosetests
+	python3 setup.py test
 
 clean:
 	rm -rf .egg stacker.egg-info

docs/blueprints.rst

@@ -427,7 +427,7 @@ structure and execute a test case for it. As an example:
       variables:
         var1: val1
 
-When run from nosetests, this will create a template fixture file called
+When run from tests, this will create a template fixture file called
 test_stack.json containing the output from the `stacker_blueprints.s3.Buckets`
 template.
 

setup.cfg

@@ -1,8 +1,11 @@
 [metadata]
 description-file = README.rst
 
-[nosetests]
-tests=stacker/tests
-detailed-errors=1
-with-coverage=1
-cover-package=stacker
+[aliases]
+test = pytest
+
+[tool:pytest]
+testpaths = stacker/tests
+cov = stacker
+filterwarnings =
+  ignore::DeprecationWarning

setup.py

@@ -1,7 +1,6 @@
 import os
 from setuptools import setup, find_packages
 
-
 VERSION = "1.6.0"
 
 src_dir = os.path.dirname(__file__)
@@ -20,16 +19,17 @@
     "python-dateutil>=2.0,<3.0",
 ]
 
+setup_requires = ['pytest-runner']
+
 tests_require = [
-    "mock~=2.0.0",
+    "pytest~=4.3",
+    "pytest-cov~=2.6",
+    "mock~=2.0",
     "moto~=1.3.7",
     "testfixtures~=4.10.0",
-    "coverage~=4.3.4",
     "flake8-future-import",
 ]
 
-setup_requires = ["nose"]
-
 scripts = [
     "scripts/compare_env",
     "scripts/docker-stacker",
@@ -60,7 +60,6 @@ def read(filename):
         tests_require=tests_require,
         setup_requires=setup_requires,
         extras_require=dict(testing=tests_require),
-        test_suite="nose.collector",
         classifiers=[
             "Development Status :: 5 - Production/Stable",
             "Environment :: Console",

stacker/blueprints/raw.py

@@ -30,10 +30,11 @@ def get_template_path(filename):
 
     """
     if os.path.isfile(filename):
-        return filename
+        return os.path.abspath(filename)
     for i in sys.path:
         if os.path.isfile(os.path.join(i, filename)):
-            return os.path.join(i, filename)
+            return os.path.abspath(os.path.join(i, filename))
+
     return None
 
 

stacker/tests/__init__.py

@@ -1,34 +0,0 @@
-from __future__ import absolute_import, division, print_function
-
-import logging
-import os
-
-
-logger = logging.getLogger(__name__)
-_saved_env = {}
-
-
-def setUpModule():
-    # Handle change in  https://github.com/spulec/moto/issues/1924
-    # Ensure AWS SDK find some (bogus) credentials in the environment and
-    # doesn't try to use other providers
-    overrides = {
-        'AWS_ACCESS_KEY_ID': 'testing',
-        'AWS_SECRET_ACCESS_KEY': 'testing',
-        'AWS_DEFAULT_REGION': 'us-east-1'
-    }
-    for key, value in overrides.items():
-        logger.info('Overriding env var: {}={}'.format(key, value))
-        _saved_env[key] = os.environ.get(key, None)
-        os.environ[key] = value
-
-
-def tearDownModule():
-    for key, value in _saved_env.items():
-        logger.info('Restoring saved env var: {}={}'.format(key, value))
-        if value is None:
-            del os.environ[key]
-        else:
-            os.environ[key] = value
-
-    _saved_env.clear()

stacker/tests/blueprints/test_raw.py

@@ -3,8 +3,6 @@
 from __future__ import division
 from __future__ import absolute_import
 import json
-import os
-import sys
 import unittest
 
 from mock import MagicMock
@@ -15,66 +13,72 @@
 from stacker.variables import Variable
 from ..factories import mock_context
 
+
 RAW_JSON_TEMPLATE_PATH = 'stacker/tests/fixtures/cfn_template.json'
 RAW_YAML_TEMPLATE_PATH = 'stacker/tests/fixtures/cfn_template.yaml'
 RAW_J2_TEMPLATE_PATH = 'stacker/tests/fixtures/cfn_template.json.j2'
 
 
-class TestRawBluePrintHelpers(unittest.TestCase):
-    """Test class for functions in module."""
-
-    def test_get_template_path_local_file(self):  # noqa pylint: disable=invalid-name
-        """Verify get_template_path finding a file relative to CWD."""
-        self.assertEqual(get_template_path(RAW_YAML_TEMPLATE_PATH),
-                         RAW_YAML_TEMPLATE_PATH)
-
-    def test_get_template_path_invalid_file(self):  # noqa pylint: disable=invalid-name
-        """Verify get_template_path with an invalid filename."""
-        self.assertEqual(get_template_path('afilenamethatdoesnotexist.txt'),
-                         None)
-
-    def test_get_template_path_file_in_syspath(self):  # noqa pylint: disable=invalid-name
-        """Verify get_template_path with a file in sys.path.
-
-        This ensures templates are able to be retreived from remote packages.
-
-        """
-        stacker_tests_dir = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))  # noqa
-        old_sys_path = list(sys.path)
-        sys.path.append(stacker_tests_dir)
-        try:
-            self.assertEqual(get_template_path('fixtures/cfn_template.yaml'),
-                             os.path.join(stacker_tests_dir,
-                                          'fixtures/cfn_template.yaml'))
-        finally:
-            sys.path = old_sys_path
-
-    def test_get_template_params(self):
-        """Verify get_template_params function operation."""
-        template_dict = {
-            "AWSTemplateFormatVersion": "2010-09-09",
-            "Description": "TestTemplate",
-            "Parameters": {
-                "Param1": {
-                    "Type": "String"
-                },
-                "Param2": {
-                    "Default": "default",
-                    "Type": "CommaDelimitedList"
-                }
-            },
-            "Resources": {}
-        }
-        template_params = {
+def test_get_template_path_local_file(tmpdir):
+    """Verify get_template_path finding a file relative to CWD."""
+
+    template_path = tmpdir.join('cfn_template.json')
+    template_path.ensure()
+
+    with tmpdir.as_cwd():
+        result = get_template_path('cfn_template.json')
+        assert template_path.samefile(result)
+
+
+def test_get_template_path_invalid_file(tmpdir):
+    """Verify get_template_path with an invalid filename."""
+
+    with tmpdir.as_cwd():
+        assert get_template_path('cfn_template.json') is None
+
+
+def test_get_template_path_file_in_syspath(tmpdir, monkeypatch):
+    """Verify get_template_path with a file in sys.path.
+
+    This ensures templates are able to be retrieved from remote packages.
+
+    """
+
+    template_path = tmpdir.join('cfn_template.json')
+    template_path.ensure()
+
+    monkeypatch.syspath_prepend(tmpdir)
+    result = get_template_path(template_path.basename)
+    assert template_path.samefile(result)
+
+
+def test_get_template_params():
+    """Verify get_template_params function operation."""
+    template_dict = {
+        "AWSTemplateFormatVersion": "2010-09-09",
+        "Description": "TestTemplate",
+        "Parameters": {
             "Param1": {
                 "Type": "String"
             },
             "Param2": {
                 "Default": "default",
                 "Type": "CommaDelimitedList"
             }
+        },
+        "Resources": {}
+    }
+    template_params = {
+        "Param1": {
+            "Type": "String"
+        },
+        "Param2": {
+            "Default": "default",
+            "Type": "CommaDelimitedList"
         }
-        self.assertEqual(get_template_params(template_dict), template_params)
+    }
+
+    assert get_template_params(template_dict) == template_params
 
 
 class TestBlueprintRendering(unittest.TestCase):

stacker/tests/conftest.py

@@ -0,0 +1,37 @@
+from __future__ import absolute_import, division, print_function
+
+import logging
+import os
+
+import pytest
+
+
+logger = logging.getLogger(__name__)
+
+
+@pytest.fixture(scope='session', autouse=True)
+def aws_credentials():
+    # Handle change in https://github.com/spulec/moto/issues/1924
+    # Ensure AWS SDK finds some (bogus) credentials in the environment and
+    # doesn't try to use other providers.
+    overrides = {
+        'AWS_ACCESS_KEY_ID': 'testing',
+        'AWS_SECRET_ACCESS_KEY': 'testing',
+        'AWS_DEFAULT_REGION': 'us-east-1'
+    }
+    saved_env = {}
+    for key, value in overrides.items():
+        logger.info('Overriding env var: {}={}'.format(key, value))
+        saved_env[key] = os.environ.get(key, None)
+        os.environ[key] = value
+
+    yield
+
+    for key, value in saved_env.items():
+        logger.info('Restoring saved env var: {}={}'.format(key, value))
+        if value is None:
+            del os.environ[key]
+        else:
+            os.environ[key] = value
+
+    saved_env.clear()