test_project.py

import os
import subprocess
import sys
from sys import platform
from typing import Sequence

from pyprojroot.here import here
from copier import run_copy
import pytest

IS_WINDOWS = platform.startswith('win')


@pytest.fixture(scope='session')
def copier_project_defaults():
    return {
            "package_name": "my_python_package",
            "package_short_description": "Short description of package",
            "keywords": "keyword1,keyword2",
            "version": "0.1.0",
            "github_organization": "<my-github-organization>",
            "full_name": "Jane Smith",
            "email": "yourname@esciencecenter.nl",
            "code_of_conduct_email": "yourname@esciencecenter.nl",
            "copyright_holder": "Netherlands eScience Center"
        }

def test_project_folder(copie, copier_project_defaults):
    project_defaults = copier_project_defaults
    project = copie.copy(extra_answers=project_defaults)

    assert project.exit_code == 0
    assert project.exception is None
    assert project.project_dir.is_dir()


def run(args: Sequence[str], dirpath: os.PathLike) -> subprocess.CompletedProcess:
    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(scope='session')
def project_env_bin_dir(tmp_path_factory):
    tmp_path = tmp_path_factory.mktemp('venv')
    env_output = run(['python', '-m', 'venv', 'env'], tmp_path)
    assert env_output.returncode == 0
    bin_dir = str(tmp_path / 'env' / 'bin')
    if IS_WINDOWS:
        bin_dir = str(tmp_path / 'env' / 'Scripts')
    return str(bin_dir) + os.sep


@pytest.fixture(scope='session')
def baked_with_development_dependencies(tmp_path_factory, project_env_bin_dir, copier_project_defaults):
    project_defaults = copier_project_defaults
    project = run_copy(
                    src_path=str(here()),
                    dst_path=str(tmp_path_factory.mktemp('projects')),
                    defaults=True,
                    vcs_ref="HEAD",
                    data=project_defaults
                    )
    project_dir = project.dst_path

    bin_dir = project_env_bin_dir
    latest_pip_output = run([f'{bin_dir}python', '-m', 'pip', 'install', '--upgrade', 'pip', 'setuptools'], project_dir)
    assert latest_pip_output.returncode == 0
    pip_output = run([f'{bin_dir}python', '-m', 'pip', 'install', '--editable', '.[dev]'], project_dir)
    assert pip_output.returncode == 0
    return project_dir


def test_pytest(baked_with_development_dependencies, project_env_bin_dir):
    project_dir = baked_with_development_dependencies
    bin_dir = project_env_bin_dir
    result = run([f'{bin_dir}python', '-m', 'pytest'], project_dir)
    assert result.returncode == 0
    assert '== 3 passed in' in result.stdout


def test_coverage(baked_with_development_dependencies, project_env_bin_dir):
    project_dir = baked_with_development_dependencies
    bin_dir = project_env_bin_dir
    result = run([f'{bin_dir}coverage', 'run', '-m', 'pytest'], project_dir)
    assert result.returncode == 0
    assert '== 3 passed in' in result.stdout
    assert (project_dir / '.coverage').exists()


def test_tox(baked_with_development_dependencies, project_env_bin_dir):
    project_dir = baked_with_development_dependencies
    bin_dir = project_env_bin_dir
    result = run([f'{bin_dir}tox'], project_dir)
    assert result.returncode == 0
    assert '== 3 passed in' in result.stdout
    # assert (project_dir / '.tox' / 'dist' / 'my_python_package-0.1.0.zip').exists()
    assert (project_dir / '.tox' / '.pkg'  / 'dist'/ 'my_python_package-0.1.0.tar.gz').exists()


def test_subpackage(baked_with_development_dependencies, project_env_bin_dir):
    """Test if subpackages end up in (wheel) distributions"""
    project_dir = baked_with_development_dependencies
    bin_dir = project_env_bin_dir
    subpackage = (project_dir / 'src' / 'my_python_package' / 'mysub')
    subpackage.mkdir()
    (subpackage / '__init__.py').write_text('FOO = "bar"\n', encoding="utf-8")

    subsubpackage = (project_dir / 'src' / 'my_python_package' / 'mysub' / 'mysub2')
    subsubpackage.mkdir()
    (subsubpackage / '__init__.py').write_text('FOO = "bar"\n', encoding="utf-8")

    # Note: we pass --wheel explicitly, because wheel has a useful side-effect
    # of leaving a build directory after building that we can check for its
    # contents in the asserts below. However, be aware that this behavior is
    # not guaranteed to stay and is in fact a known bug / PEP-violation!
    # See https://github.com/pypa/wheel/issues/447. Also, by passing --wheel
    # explicitly (although by default build already builds a wheel as well),
    # we omit the sdist being built, saving some seconds.
    result = run([f'{bin_dir}python', '-m', 'build', '--wheel'], project_dir)
    assert result.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_env_bin_dir):
    project_dir = baked_with_development_dependencies
    bin_dir = project_env_bin_dir

    result = run([f'{bin_dir}sphinx-build', '-b', 'html', 'docs', 'docs/_build/html'], project_dir)
    assert result.returncode == 0
    assert 'build succeeded' in result.stdout
    assert (project_dir / 'docs' / '_build' / 'html' / 'index.html').exists()


@pytest.mark.skipif(sys.version_info < (3, 9), reason=
"requires python 3.9 or higher, see https://github.com/NLeSC/python-template/pull/347#issuecomment-1710684574")
def test_coverage_api_docs(baked_with_development_dependencies, project_env_bin_dir):
    project_dir = baked_with_development_dependencies
    bin_dir = project_env_bin_dir

    result = run([f'{bin_dir}sphinx-build', '-b', 'coverage', 'docs', 'docs/_build/coverage'], project_dir)
    assert result.returncode == 0
    assert 'build succeeded' in result.stdout
    coverage_file = project_dir / 'docs' / '_build' / 'coverage' / 'python.txt'
    coverage_file_lines = coverage_file.read_text('utf8').splitlines()
    # Coverage file lines should look globally like:
    # ['Undocumented Python objects',
    #  '===========================',
    #  '',
    #  'Statistics',
    #  '----------',
    #  '',
    #  '+--------------------------------+----------+--------------+',
    #  '| Module                         | Coverage | Undocumented |',
    #  '+================================+==========+==============+',
    #  '| my_python_package.my_module    | 100.00%  | 0            |',
    #  '+--------------------------------+----------+--------------+',
    #  '| my_python_package.mysub.mysub2 | 100.00%  | 0            |',
    #  '+--------------------------------+----------+--------------+',
    #  '| my_python_package              | 100.00%  | 0            |',
    #  '+--------------------------------+----------+--------------+',
    #  '| my_python_package.mysub        | 100.00%  | 0            |',
    #  '+--------------------------------+----------+--------------+',
    #  '| TOTAL                          | 100.00%  | 0            |',
    #  '+--------------------------------+----------+--------------+',
    #  ''
    #  ]
    # The package coverage lines change order between runs, so we test for each data row individually:
    assert '| my_python_package              | 100.00%  | 0            |' in coverage_file_lines
    assert '| my_python_package.my_module    | 100.00%  | 0            |' in coverage_file_lines
    assert '| TOTAL                          | 100.00%  | 0            |' in coverage_file_lines


def test_doctest_api_docs(baked_with_development_dependencies, project_env_bin_dir):
    project_dir = baked_with_development_dependencies
    bin_dir = project_env_bin_dir

    result = run([f'{bin_dir}sphinx-build', '-b', 'doctest', 'docs', 'docs/_build/doctest'], project_dir)
    assert result.returncode == 0
    assert 'build succeeded' in result.stdout
    assert (project_dir / 'docs' / '_build' / 'doctest' / 'output.txt').exists()


def test_ruff_check(baked_with_development_dependencies, project_env_bin_dir):
    project_dir = baked_with_development_dependencies
    bin_dir = project_env_bin_dir

    result = run([f'{bin_dir}ruff', 'check'], project_dir)
    assert result.returncode == 0
    assert '' in result.stdout


def test_bumpversion(baked_with_development_dependencies, project_env_bin_dir):
    project_dir = baked_with_development_dependencies
    bin_dir = project_env_bin_dir

    original_version = '0.1.0'
    assert original_version in (project_dir / 'pyproject.toml').read_text('utf-8')
    # assert original_version in (project_dir / 'CITATION.cff').read_text('utf-8')
    assert original_version in (project_dir / 'src' / 'my_python_package' / '__init__.py').read_text('utf-8')
    assert original_version in (project_dir / 'docs' / 'conf.py').read_text('utf-8')

    result = run([f'{bin_dir}bump-my-version', 'bump', 'major'], project_dir)
    assert result.returncode == 0
    assert '' in result.stdout
    expected_version = '1.0.0'
    assert expected_version in (project_dir / 'pyproject.toml').read_text('utf-8')
    # assert expected_version in (project_dir / 'CITATION.cff').read_text('utf-8')
    assert expected_version in (project_dir / 'src' / 'my_python_package' / '__init__.py').read_text('utf-8')
    assert expected_version in (project_dir / 'docs' / 'conf.py').read_text('utf-8')