Merge pull request #266 from NLeSC/213-test-make-html

Add test for generating api docs

Author: sverhoeven

.github/workflows/tests.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ['ubuntu-latest', 'macos-latest']
+        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
         python-version: ['3.6', '3.7', '3.8', '3.9']
     steps:
     - uses: actions/checkout@v2

tests/test_project.py

@@ -1,10 +1,15 @@
 import os
 import subprocess
+from pathlib import Path
+from shutil import which
 from sys import platform
 from typing import Sequence
 
 import pytest
 
+IS_WINDOWS = platform.startswith("win")
+IS_WINDOWS_CI = IS_WINDOWS and os.environ.get('CI', False)
+
 
 def test_project_folder(cookies):
     project = cookies.bake()
@@ -16,37 +21,46 @@ def test_project_folder(cookies):
 
 
 def run(args: Sequence[str], dirpath: os.PathLike) -> subprocess.CompletedProcess:
-    return subprocess.run(args=args,
-                          stdout=subprocess.PIPE,
-                          stderr=subprocess.PIPE,
-                          cwd=dirpath,
-                          encoding="utf-8")
+    completed_process = subprocess.run(args=args,
+                                       stdout=subprocess.PIPE,
+                                       stderr=subprocess.PIPE,
+                                       cwd=dirpath,
+                                       encoding="utf-8")
+    print(completed_process.stdout)
+    print(completed_process.stderr)
+    return completed_process
 
 
 @pytest.fixture
 def baked_with_development_dependencies(cookies):
     result = cookies.bake()
-    env_output = run(['python3', '-m', 'venv', 'env'], result.project)
-    assert env_output.returncode == 0
-    env_bin = 'env/Scripts/' if platform.startswith("win") else 'env/bin/'
-    latest_pip_output = run([f'{env_bin}pip3', 'install', '--upgrade', 'pip', 'setuptools'], result.project)
+    if IS_WINDOWS_CI:
+        # Creating virtualenv does not work on Windows CI,
+        # falling back to using current pip3 dir
+        pip = Path(which('pip3'))
+        bin_dir = str(pip.parent) + '\\'
+    else:
+        env_output = run(['python3', '-m', 'venv', 'env'], result.project)
+        assert env_output.returncode == 0
+        bin_dir = 'env/Scripts/' if IS_WINDOWS else 'env/bin/'
+    latest_pip_output = run([f'{bin_dir}pip3', 'install', '--upgrade', 'pip', 'setuptools'], result.project)
     assert latest_pip_output.returncode == 0
-    pip_output = run([f'{env_bin}pip3', 'install', '--editable', '.[dev]'], result.project)
+    pip_output = run([f'{bin_dir}pip3', 'install', '--editable', '.[dev]'], result.project)
     assert pip_output.returncode == 0
-    return result.project, env_bin
+    return result.project, bin_dir
 
 
 def test_pytest(baked_with_development_dependencies):
-    project_dir, env_bin = baked_with_development_dependencies
-    pytest_output = run([f'{env_bin}pytest'], project_dir)
+    project_dir, bin_dir = baked_with_development_dependencies
+    pytest_output = run([f'{bin_dir}pytest'], project_dir)
     assert pytest_output.returncode == 0
     assert '== 4 passed in' in pytest_output.stdout
     assert (project_dir / 'coverage.xml').exists()
     assert (project_dir / 'htmlcov/index.html').exists()
 
 
 def test_subpackage(baked_with_development_dependencies):
-    project_dir, env_bin = baked_with_development_dependencies
+    project_dir, bin_dir = baked_with_development_dependencies
     subpackage = (project_dir / 'my_python_package' / 'mysub')
     subpackage.mkdir()
     (subpackage / '__init__.py').write_text('FOO = "bar"', encoding="utf-8")
@@ -55,7 +69,19 @@ def test_subpackage(baked_with_development_dependencies):
     subsubpackage.mkdir()
     (subsubpackage / '__init__.py').write_text('FOO = "bar"', encoding="utf-8")
 
-    build_output = run([f'{env_bin}python3', 'setup.py', 'build'], project_dir)
+    if IS_WINDOWS_CI:
+        # On Windows CI python and pip executable are in different paths
+        bin_dir = ''
+    build_output = run([f'{bin_dir}python', 'setup.py', 'build'], project_dir)
     assert build_output.returncode == 0
     assert (project_dir / 'build' / 'lib' / 'my_python_package' / 'mysub' / '__init__.py').exists()
     assert (project_dir / 'build' / 'lib' / 'my_python_package' / 'mysub' / 'mysub2' / '__init__.py').exists()
+
+
+def test_generate_api_docs(baked_with_development_dependencies):
+    project_dir, bin_dir = baked_with_development_dependencies
+
+    build_output = run([f'{bin_dir}sphinx-build', '-b', 'html', 'docs', 'docs/_build/html'], project_dir)
+    assert build_output.returncode == 0
+    assert 'build succeeded' in build_output.stdout
+    assert (project_dir / 'docs' / '_build' / 'html' / 'index.html').exists()