conftest.py

from __future__ import annotations

from pathlib import Path
from typing import Any, Protocol

import pytest
import rtoml
import yaml


class MkTemp(Protocol):
    """
    Protocol for the mktemp fixture.
    """

    def mktemp(self, name: str) -> Path: ...


@pytest.fixture
def fake_get_repo_names_response() -> dict[str, Any]:
    """
    Response snippet for the get_repo_names GraphQL
    query.
    """
    return {
        "data": {
            "user": {
                "repositories": {
                    "nodes": [
                        {"name": "dingle"},
                        {"name": "dongle"},
                        {"name": "dangle"},
                        {"name": "a_cool_project"},
                        {"name": "another"},
                        {"name": "yetanother"},
                        {"name": "hello"},
                    ]
                }
            }
        }
    }


@pytest.fixture
def fake_get_repos_response() -> dict[str, Any]:
    """
    Response snippet for the get_repos GraphQL
    query.
    """
    return {
        "data": {
            "user": {
                "repositories": {
                    "nodes": [
                        {
                            "name": "advent_of_code_2020",
                            "description": "Retroactively doing AOC2020 in Go.",
                            "createdAt": "2022-01-05T16:54:03Z",
                            "pushedAt": "2022-01-09T06:55:32Z",
                            "diskUsage": 45,
                        },
                        {
                            "name": "advent_of_code_2021",
                            "description": "My code for AOC 2021",
                            "createdAt": "2021-11-30T12:01:22Z",
                            "pushedAt": "2021-12-19T15:10:07Z",
                            "diskUsage": 151,
                        },
                        {
                            "name": "aircraft_crashes",
                            "description": "Analysis of aircraft crash data.",
                            "createdAt": "2021-01-02T19:34:15Z",
                            "pushedAt": "2021-01-20T10:35:57Z",
                            "diskUsage": 2062,
                        },
                        {
                            "name": "cookie_pypackage",
                            "description": ("My own version of the Cookiecutter pypackage template"),
                            "createdAt": "2020-07-04T10:05:36Z",
                            "pushedAt": "2021-12-03T08:45:49Z",
                            "diskUsage": 734,
                        },
                        {
                            "name": "cv",
                            "description": "Repo for my CV, built with JSON Resume.",
                            "createdAt": "2021-10-30T15:11:49Z",
                            "pushedAt": "2022-01-10T19:50:24Z",
                            "diskUsage": 145,
                        },
                        {
                            "name": "eu_energy_analysis",
                            "description": "Analysis of the EU Open Power System Data.",
                            "createdAt": "2020-12-13T10:50:35Z",
                            "pushedAt": "2020-12-24T11:12:34Z",
                            "diskUsage": 1834,
                        },
                        {
                            "name": "FollowTheProcess",
                            "description": 'My "About Me" Repo',
                            "createdAt": "2020-07-14T16:06:52Z",
                            "pushedAt": "2022-01-10T20:05:47Z",
                            "diskUsage": 14640,
                        },
                        {
                            "name": "followtheprocess.github.io",
                            "description": "Repo for my GitHub pages site.",
                            "createdAt": "2021-02-19T20:16:05Z",
                            "pushedAt": "2021-11-18T19:04:06Z",
                            "diskUsage": 10753,
                        },
                    ]
                }
            }
        }
    }


@pytest.fixture
def fake_get_forks_response() -> dict[str, Any]:
    """
    Response snippet for the get_forks GraphQL
    query.
    """
    return {
        "data": {
            "user": {
                "repositories": {
                    "nodes": [
                        {
                            "name": "nox",
                            "diskUsage": 5125,
                            "createdAt": "2021-07-01T11:43:36Z",
                            "pushedAt": "2022-01-08T11:00:44Z",
                            "parent": {"nameWithOwner": "theacodes/nox"},
                        },
                        {
                            "name": "python-launcher",
                            "diskUsage": 824,
                            "createdAt": "2021-10-25T18:33:11Z",
                            "pushedAt": "2021-11-09T07:47:23Z",
                            "parent": {"nameWithOwner": "brettcannon/python-launcher"},
                        },
                    ]
                }
            }
        }
    }


@pytest.fixture
def fake_repo_exists_false_response() -> dict[str, Any]:
    """
    Response snippet for the check_repo_exists GraphQL
    query when the requested repo does not exist.
    """
    return {
        "data": {"repository": None},
        "errors": [
            {
                "type": "NOT_FOUND",
                "path": ["repository"],
                "locations": [{"line": 7, "column": 3}],
                "message": ("Could not resolve to a Repository with the name" " 'FollowTheProcess/dave'."),
            }
        ],
    }


@pytest.fixture
def fake_repo_exists_true_response() -> dict[str, Any]:
    """
    Response snippet for the check_repo_exists GraphQL
    query when the requested repo exists.
    """
    return {"data": {"repository": {"name": "pytoil"}}}


@pytest.fixture
def fake_repo_info_response() -> dict[str, Any]:
    """
    Response snippet for the get_repo_info GraphQL
    query.
    """
    return {
        "data": {
            "repository": {
                "name": "pytoil",
                "description": "CLI to automate the development workflow :robot:",
                "createdAt": "2021-02-04T15:05:23Z",
                "pushedAt": "2021-12-27T13:31:53Z",
                "diskUsage": 3153,
                "licenseInfo": {"name": "Apache License 2.0"},
                "primaryLanguage": {"name": "Python"},
            }
        }
    }


@pytest.fixture
def fake_repo_info_response_no_license() -> dict[str, Any]:
    """
    Response snippet for the get_repo_info GraphQL
    query.
    """
    return {
        "data": {
            "repository": {
                "name": "pytoil",
                "description": "CLI to automate the development workflow :robot:",
                "createdAt": "2021-02-04T15:05:23Z",
                "pushedAt": "2021-12-27T13:31:53Z",
                "diskUsage": 3153,
                "licenseInfo": None,
                "primaryLanguage": {"name": "Python"},
            }
        }
    }


@pytest.fixture
def fake_projects_dir(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a fake projects directory complete
    with subdirectories mocking development projects.
    """
    project_names: list[str] = [
        "project1",
        "myproject",
        "dingleproject",
        "anotherone",
        ".ishouldnt_show_up",
    ]

    projects_dir: Path = tmp_path_factory.mktemp("projects")

    for project_name in project_names:
        project_path = projects_dir.joinpath(project_name)
        project_path.mkdir()

    return projects_dir


@pytest.fixture
def temp_environment_yml(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a valid temporary environment.yml file.
    """
    env_file: Path = tmp_path_factory.mktemp("temp").joinpath("environment.yml")

    fake_env_info: dict[str, str | list[str]] = {
        "name": "testy",
        "channels": ["defaults", "conda-forge"],
        "dependencies": [
            "python=3",
            "invoke",
            "black",
            "flake8",
            "isort",
            "mypy",
            "rich",
            "numpy",
            "requests",
            "pandas",
        ],
    }

    env_file.write_text(yaml.dump(fake_env_info))

    return env_file


@pytest.fixture
def bad_temp_environment_yml(tmp_path_factory: MkTemp) -> Path:
    """
    Returns an invalid temporary environment.yml file.
    """
    env_file: Path = tmp_path_factory.mktemp("temp").joinpath("environment.yml")

    # name must be a string
    fake_env_info = {
        "name": 300,
        "channels": ["defaults", "conda-forge"],
        "dependencies": [
            "python>3.7",
            "invoke",
            "black",
            "flake8",
            "isort",
            "mypy",
            "rich",
            "requests",
            "numpy",
            "pandas",
        ],
    }

    env_file.write_text(yaml.dump(fake_env_info))

    return env_file


@pytest.fixture
def fake_home_folder_miniconda(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a faked $HOME folder. Should be used as the return
    value from pathlib.Path.home().
    Designed to test the auto detection of conda environment
    storage directory.
    """
    fake_home: Path = tmp_path_factory.mktemp("home")

    miniconda = fake_home.joinpath("miniconda3/envs")
    miniconda.mkdir(parents=True)

    return fake_home


@pytest.fixture
def fake_home_folder_anaconda(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a faked $HOME folder. Should be used as the return
    value from pathlib.Path.home().
    Designed to test the auto detection of conda environment
    storage directory.
    """
    fake_home: Path = tmp_path_factory.mktemp("home")

    anaconda = fake_home.joinpath("anaconda3/envs")
    anaconda.mkdir(parents=True)

    return fake_home


@pytest.fixture
def fake_home_folder_miniforge(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a faked $HOME folder. Should be used as the return
    value from pathlib.Path.home().
    Designed to test the auto detection of conda environment
    storage directory.
    """
    fake_home: Path = tmp_path_factory.mktemp("home")

    anaconda = fake_home.joinpath("miniforge3/envs")
    anaconda.mkdir(parents=True)

    return fake_home


@pytest.fixture
def fake_home_folder_mambaforge(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a faked $HOME folder. Should be used as the return
    value from pathlib.Path.home().
    Designed to test the auto detection of conda environment
    storage directory.
    """
    fake_home: Path = tmp_path_factory.mktemp("home")

    anaconda = fake_home.joinpath("mambaforge/envs")
    anaconda.mkdir(parents=True)

    return fake_home


@pytest.fixture
def fake_home_folder_no_conda(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a faked $HOME but without any conda dirs.
    To test whether get_envs_dir raises correctly.
    """
    fake_home: Path = tmp_path_factory.mktemp("home")

    return fake_home


@pytest.fixture
def repo_folder_with_random_existing_files(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a temporary directory containing a few random files
    to test methods which check for a files existence within
    a certain directory.
    """
    folder: Path = tmp_path_factory.mktemp("myrepo")

    files: list[str] = ["here.txt", "i_exist.yml", "hello.py", "me_too.json"]

    for file in files:
        # Create each file under the myrepo folder
        folder.joinpath(file).touch()

    return folder


@pytest.fixture
def project_with_no_build_system(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a temporary directory containing a
    pyproject.toml but this file does not specify
    a build-system, which is bad.
    """
    # Create the folder and pyproject.toml file
    folder: Path = tmp_path_factory.mktemp("myrepo")
    pyproject_toml = folder.joinpath("pyproject.toml")
    pyproject_toml.touch()

    return folder


@pytest.fixture
def project_with_no_build_backend(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a temporary directory containing a
    pyproject.toml.
    This time we do write a 'build-system' but no
    'build-backend'.
    """
    # Create the folder and pyproject.toml file
    folder: Path = tmp_path_factory.mktemp("myrepo")
    pyproject_toml = folder.joinpath("pyproject.toml")
    pyproject_toml.touch()

    # Create some fake build-system
    build_system = {
        "build-system": {
            "requires": ["poetry-core>=1.0.0"],
        },
    }

    pyproject_toml.write_text(rtoml.dumps(build_system))

    return folder


@pytest.fixture
def project_with_setuptools_pep621_backend(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a temporary directory containing a PEP 621
    pyproject.toml configured to use setuptools as the
    build backend.
    """
    # Create the folder and pyproject.toml file
    folder: Path = tmp_path_factory.mktemp("myrepo")
    pyproject_toml = folder.joinpath("pyproject.toml")
    pyproject_toml.touch()

    build_system = {
        "build-system": {
            "requires": [
                "setuptools>=61",
                "wheel>=0.37.1",
            ],
            "build-backend": "setuptools.build_meta",
        }
    }

    pyproject_toml.write_text(rtoml.dumps(build_system))

    return folder


@pytest.fixture
def fake_poetry_project(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a temporary directory containing a
    valid poetry pyproject.toml file.
    """
    # Create the folder and pyproject.toml file
    folder: Path = tmp_path_factory.mktemp("myrepo")
    pyproject_toml = folder.joinpath("pyproject.toml")
    pyproject_toml.touch()

    # Create some fake poetry content
    build_system = {
        "build-system": {
            "requires": ["poetry-core>=1.0.0"],
            "build-backend": "poetry.core.masonry.api",
        },
    }

    pyproject_toml.write_text(rtoml.dumps(build_system))

    return folder


@pytest.fixture
def fake_flit_project(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a temporary directory containing a
    valid flit pyproject.toml file.
    """
    # Create the folder and pyproject.toml file
    folder: Path = tmp_path_factory.mktemp("myrepo")
    pyproject_toml = folder.joinpath("pyproject.toml")
    pyproject_toml.touch()

    # Create some fake flit content
    build_system = {
        "build-system": {
            "requires": ["flit_core >=2,<4"],
            "build-backend": "flit_core.buildapi",
        },
    }

    pyproject_toml.write_text(rtoml.dumps(build_system))

    return folder


@pytest.fixture
def fake_hatch_project(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a temporary directory containing a
    valid hatch pyproject.toml file.
    """
    # Create the folder and pyproject.toml file
    folder: Path = tmp_path_factory.mktemp("myrepo")
    pyproject_toml = folder.joinpath("pyproject.toml")
    pyproject_toml.touch()

    # Create some fake hatch content
    build_system = {
        "build-system": {
            "requires": ["hatchling"],
            "build-backend": "hatchling.build",
        },
    }

    pyproject_toml.write_text(rtoml.dumps(build_system))

    return folder


@pytest.fixture
def fake_pep621_project(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a temporary directory containing a
    valid pep621 pyproject.toml file.
    """
    # Create the folder and pyproject.toml file
    folder: Path = tmp_path_factory.mktemp("myrepo")
    pyproject_toml = folder.joinpath("pyproject.toml")
    pyproject_toml.touch()

    # Create some fake pep621 content
    content = {
        "build-system": {
            "requires": ["hatchling"],
            "build-backend": "hatchling.build",
        },
        "project": {
            "name": "myrepo",
            "version": "0.1.0",
            "description": "A test project",
            "readme": "README.md",
        },
    }

    pyproject_toml.write_text(rtoml.dumps(content))

    return folder


@pytest.fixture
def requirements_dev_project(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a temp directory containing a requirements-dev.txt
    file.
    """
    folder: Path = tmp_path_factory.mktemp("myrepo")
    req_dev_txt = folder.joinpath("requirements-dev.txt")
    req_dev_txt.touch()

    return folder


@pytest.fixture
def requirements_project(tmp_path_factory: MkTemp) -> Path:
    """
    Returns a temp directory containing a requirements.txt
    file.
    """
    folder: Path = tmp_path_factory.mktemp("myrepo")
    req_txt = folder.joinpath("requirements.txt")
    req_txt.touch()

    return folder