Merge pull request #138 from NLeSC/101-test-fixes

thanks!

Author: eriktks

requirements.txt

@@ -1,8 +1,5 @@
 cookiecutter==1.7.2
-sh
 
 # Testing
 pytest<5.0.0,>=3.3.0
 pytest-cookies
-pycodestyle
-ruamel.yaml

tests/test_lint.py

@@ -1,109 +1,10 @@
 import pytest
-import os
-import sys
 
-from ruamel import yaml
 
-try:
-    import sh
-except ImportError:
-    pass
-
-
-def load_yaml(filename):
-    """Return object in yaml file."""
-    with open(filename) as myfile:
-        content = myfile.read()
-        if "win" in sys.platform:
-            content = content.replace("\\", "/")
-        return yaml.safe_load(content)
-
-
-def test_project(cookies):
+def test_project_folder(cookies):
     project = cookies.bake()
 
     assert project.exit_code == 0
     assert project.exception is None
     assert project.project.basename == 'my_python_project'
     assert project.project.isdir()
-
-
-@pytest.mark.skipif(sys.platform.startswith('win'),
-                    reason='Skipping test with sh-module on Windows')
-def test_install(cookies):
-    project = cookies.bake()
-
-    assert project.exit_code == 0
-    assert project.exception is None
-
-    cwd = os.getcwd()
-    os.chdir(str(project.project))
-
-    try:
-        sh.python(['setup.py', 'install'])
-    except sh.ErrorReturnCode as e:
-        pytest.fail(e)
-    finally:
-        os.chdir(cwd)
-
-
-@pytest.mark.skipif(sys.platform.startswith('win'),
-                    reason='Skipping test with sh-module on Windows')
-def test_running_tests(cookies):
-    project = cookies.bake()
-
-    assert project.exit_code == 0
-    assert project.exception is None
-
-    cwd = os.getcwd()
-    os.chdir(str(project.project))
-
-    try:
-        sh.python(['setup.py', 'test'])
-    except sh.ErrorReturnCode as e:
-        pytest.fail(e)
-    finally:
-        os.chdir(cwd)
-
-
-@pytest.mark.skipif(sys.platform.startswith('win'),
-                    reason='Skipping test with sh-module on Windows')
-def test_building_documentation_no_apidocs(cookies):
-    project = cookies.bake()
-
-    assert project.exit_code == 0
-    assert project.exception is None
-
-    cwd = os.getcwd()
-    os.chdir(str(project.project))
-
-    try:
-        sh.python(['setup.py', 'build_sphinx'])
-    except sh.ErrorReturnCode as e:
-        pytest.fail(e)
-    finally:
-        os.chdir(cwd)
-
-
-@pytest.mark.skipif(sys.platform.startswith('win'),
-                    reason='Skipping test with sh-module on Windows')
-def test_building_documentation_apidocs(cookies):
-    project = cookies.bake(extra_context={'apidoc': 'yes'})
-
-    assert project.exit_code == 0
-    assert project.exception is None
-
-    cwd = os.getcwd()
-    os.chdir(str(project.project))
-
-    try:
-        sh.python(['setup.py', 'build_sphinx'])
-    except sh.ErrorReturnCode as e:
-        pytest.fail(e)
-    finally:
-        os.chdir(cwd)
-
-    apidocs = project.project.join('docs', '_build', 'html', 'apidocs')
-
-    assert apidocs.join('my_python_project.html').isfile()
-    assert apidocs.join('my_python_project.my_python_project.html').isfile()

tests/test_project.py

@@ -1,104 +1,39 @@
 import pytest
-import os
-import sys
 
-try:
-    import sh
-except ImportError:
-    pass
 
-
-@pytest.mark.skipif(sys.platform.startswith('win'),
-                    reason='Skipping test with sh-module on Windows')
 def test_double_quotes_in_name_and_description(cookies):
-    ctx = {'project_short_description': '"double quotes"',
-           'full_name': '"name"name'}
+    ctx = {
+        "project_short_description": '"double quotes"',
+        "full_name": '"name"name'
+    }
     project = cookies.bake(extra_context=ctx)
 
     assert project.exit_code == 0
 
-    with open(os.path.join(str(project.project), 'setup.py')) as f:
-        setup = f.read()
-    print(setup)
-
-    cwd = os.getcwd()
-    os.chdir(str(project.project))
-
-    try:
-        sh.python(['setup.py', 'install'])
-    except sh.ErrorReturnCode as e:
-        pytest.fail(e)
-    finally:
-        os.chdir(cwd)
-
 
-@pytest.mark.skipif(sys.platform.startswith('win'),
-                    reason='Skipping test with sh-module on Windows')
 def test_single_quotes_in_name_and_description(cookies):
-    ctx = {'project_short_description': "'single quotes'",
-           'full_name': "Mr. O'Keeffe"}
+    ctx = {
+        "project_short_description": "'single quotes'",
+        "full_name": "Mr. O'Keeffe"
+    }
     project = cookies.bake(extra_context=ctx)
 
     assert project.exit_code == 0
 
-    with open(os.path.join(str(project.project), 'setup.py')) as f:
-        setup = f.read()
-    print(setup)
-
-    cwd = os.getcwd()
-    os.chdir(str(project.project))
-
-    try:
-        sh.python(['setup.py', 'install'])
-    except sh.ErrorReturnCode as e:
-        pytest.fail(e)
-    finally:
-        os.chdir(cwd)
-
 
-@pytest.mark.skipif(sys.platform.startswith('win'),
-                    reason='Skipping test with sh-module on Windows')
 def test_dash_in_project_slug(cookies):
-    ctx = {'project_slug': "my-package"}
+    ctx = {
+        "project_slug": "my-package"
+    }
     project = cookies.bake(extra_context=ctx)
 
     assert project.exit_code == 0
 
-    with open(os.path.join(str(project.project), 'setup.py')) as f:
-        setup = f.read()
-    print(setup)
 
-    cwd = os.getcwd()
-    os.chdir(str(project.project))
-
-    try:
-        sh.python(['setup.py', 'install'])
-        sh.python(['setup.py', 'build_sphinx'])
-    except sh.ErrorReturnCode as e:
-        pytest.fail(e)
-    finally:
-        os.chdir(cwd)
-
-
-@pytest.mark.skipif(sys.platform.startswith('win'),
-                    reason='Skipping test with sh-module on Windows')
 def test_space_in_project_slug(cookies):
-    ctx = {'project_slug': "my package"}
+    ctx = {
+        "project_slug": "my package"
+    }
     project = cookies.bake(extra_context=ctx)
 
     assert project.exit_code == 0
-
-    with open(os.path.join(str(project.project), 'setup.py')) as f:
-        setup = f.read()
-    print(setup)
-
-    cwd = os.getcwd()
-    os.chdir(str(project.project))
-
-    try:
-        sh.python(['setup.py', 'install'])
-        sh.python(['setup.py', 'build_sphinx'])
-    except sh.ErrorReturnCode as e:
-        pytest.fail(e)
-    finally:
-        os.chdir(cwd)

tests/test_values.py

@@ -40,5 +40,5 @@ jobs:
       - name: Test
         shell: bash -l {0}
         run: |
-          python setup.py test
+          pytest tests
           pytest --cov --cov-report term --cov-report xml --junitxml=xunit-result.xml

{{cookiecutter.project_slug}}/.github/workflows/build.yml

@@ -17,11 +17,11 @@
 import os
 import sys
 
-import {{ cookiecutter.project_slug.lower().replace(" ", "_").replace("-", "_")}}
-
 here = os.path.dirname(__file__)
 sys.path.insert(0, os.path.abspath(os.path.join(here, "..")))
 
+import {{ cookiecutter.project_slug.lower().replace(" ", "_").replace("-", "_")}}
+
 
 # -- General configuration ------------------------------------------------
 

{{cookiecutter.project_slug}}/docs/conf.py

@@ -1,9 +1 @@
-import os
-import sys
-
-# To update the package version number, edit CITATION.cff
-citationfile = os.path.join(sys.exec_prefix, "citation/{{ cookiecutter.project_slug.lower().replace(" ", "_").replace("-", "_")}}", "CITATION.cff")
-with open(citationfile, "r") as cff:
-    for line in cff:
-        if "version:" in line:
-            __version__ = line.replace("version:", "").strip().strip('"')
+__version__ = "{{ cookiecutter.version }}"