refactor(tests): Deprecate local fixtures for libvcs pytest plugin (#398)

Author: tony

CHANGES

@@ -19,6 +19,10 @@ $ pipx install --suffix=@next 'vcspull' --pip-args '\--pre' --force
 
 - _Add your latest changes from PRs here_
 
+### Internal
+
+- Move test fixtures over to libvcs's pytest plugin (#398)
+
 ## vcspull v1.13.0 (2022-09-25)
 
 ### What's new

tests/conftest.py

@@ -1,30 +1,39 @@
-import getpass
 import pathlib
 import shutil
-import textwrap
 import typing as t
 
 import pytest
 
-from libvcs._internal.run import run
-from libvcs._internal.shortcuts import create_project
-from libvcs.sync.git import GitSync
 
+@pytest.fixture(autouse=True)
+def add_doctest_fixtures(
+    request: pytest.FixtureRequest,
+    doctest_namespace: t.Dict[str, t.Any],
+) -> None:
+    from _pytest.doctest import DoctestItem
 
-@pytest.fixture(autouse=True, scope="session")
-def home_path(tmp_path_factory: pytest.TempPathFactory):
-    return tmp_path_factory.mktemp("home")
+    if isinstance(request._pyfuncitem, DoctestItem):
+        request.getfixturevalue("add_doctest_fixtures")
+        request.getfixturevalue("set_home")
 
 
-@pytest.fixture(autouse=True, scope="session")
-def user_path(home_path: pathlib.Path):
-    p = home_path / getpass.getuser()
-    p.mkdir()
-    return p
+@pytest.fixture(autouse=True)
+def setup(
+    request: pytest.FixtureRequest,
+    gitconfig: pathlib.Path,
+    set_home: pathlib.Path,
+    xdg_config_path: pathlib.Path,
+) -> None:
+    pass
+
+
+@pytest.fixture(autouse=True)
+def cwd_default(monkeypatch: pytest.MonkeyPatch, tmp_path: pathlib.Path) -> None:
+    monkeypatch.chdir(tmp_path)
 
 
 @pytest.fixture(autouse=True, scope="session")
-@pytest.mark.usefixtures("set_user_path")
+@pytest.mark.usefixtures("set_home")
 def xdg_config_path(user_path: pathlib.Path):
     p = user_path / ".config"
     p.mkdir()
@@ -43,11 +52,6 @@ def clean():
     return conf_path
 
 
-@pytest.fixture(autouse=True)
-def set_user_path(monkeypatch: pytest.MonkeyPatch, user_path: pathlib.Path):
-    monkeypatch.setenv("HOME", str(user_path))
-
-
 @pytest.fixture(autouse=True)
 def set_xdg_config_path(monkeypatch: pytest.MonkeyPatch, xdg_config_path: pathlib.Path):
     monkeypatch.setenv("XDG_CONFIG_HOME", str(xdg_config_path))
@@ -64,90 +68,3 @@ def clean():
 
     request.addfinalizer(clean)
     return dir
-
-
-@pytest.fixture
-def git_repo_kwargs(repos_path: pathlib.Path, git_dummy_repo_dir):
-    """Return kwargs for :func:`create_project`."""
-    return {
-        "url": "git+file://" + git_dummy_repo_dir,
-        "dir": str(repos_path / "repo_name"),
-        "name": "repo_name",
-    }
-
-
-@pytest.fixture
-def git_repo(git_repo_kwargs) -> GitSync:
-    """Create an git repository for tests. Return repo."""
-    repo = create_project(vcs="git", **git_repo_kwargs)
-    repo.obtain(quiet=True)
-    return repo
-
-
-class DummyRepoProtocol(t.Protocol):
-    """Callback for repo fixture factory."""
-
-    def __call__(self, repo_name: str, testfile_filename: str = ...) -> str:
-        """Callback signature for subprocess communication."""
-        ...
-
-
-@pytest.fixture
-def create_git_dummy_repo(
-    repos_path: pathlib.Path,
-) -> t.Generator[DummyRepoProtocol, None, None]:
-    def fn(repo_name: str, testfile_filename: str = "testfile.test"):
-        repo_path = str(repos_path / repo_name)
-
-        run(["git", "init", repo_name], cwd=str(repos_path))
-
-        run(["touch", testfile_filename], cwd=repo_path)
-        run(["git", "add", testfile_filename], cwd=repo_path)
-        run(["git", "commit", "-m", "test file for %s" % repo_name], cwd=repo_path)
-
-        return repo_path
-
-    yield fn
-
-
-@pytest.fixture
-def git_dummy_repo_dir(
-    repos_path: pathlib.Path, create_git_dummy_repo: DummyRepoProtocol
-):
-    """Create a git repo with 1 commit, used as a remote."""
-    return create_git_dummy_repo("dummyrepo")
-
-
-@pytest.fixture(autouse=True, scope="session")
-def hgrc(user_path: pathlib.Path):
-    hgrc = user_path / ".hgrc"
-    hgrc.write_text(
-        textwrap.dedent(
-            f"""
-        [ui]
-        username = vcspull tests <vcspull@git-pull.com>
-        merge = internal:merge
-
-        [trusted]
-        users = {getpass.getuser()}
-    """
-        ),
-        encoding="utf-8",
-    )
-    return hgrc
-
-
-@pytest.fixture(autouse=True, scope="module")
-def gitconfig(user_path: pathlib.Path):
-    gitconfig = user_path / ".gitconfig"
-    gitconfig.write_text(
-        textwrap.dedent(
-            f"""
-  [user]
-    email = libvcs@git-pull.com
-    name = {getpass.getuser()}
-    """
-        ),
-        encoding="utf-8",
-    )
-    return gitconfig

tests/test_sync.py

@@ -7,8 +7,8 @@
 import kaptan
 
 from libvcs._internal.shortcuts import create_project
+from libvcs.pytest_plugin import CreateProjectCallbackFixtureProtocol
 from libvcs.sync.git import GitRemote, GitSync
-from tests.conftest import DummyRepoProtocol
 from vcspull.cli.sync import update_repo
 from vcspull.config import extract_repos, filter_repos, load_configs
 from vcspull.types import ConfigDict
@@ -18,15 +18,15 @@
 
 def test_makes_recursive(
     tmp_path: pathlib.Path,
-    git_dummy_repo_dir: pathlib.Path,
+    git_remote_repo: pathlib.Path,
 ):
     """Ensure that directories in pull are made recursively."""
     conf = kaptan.Kaptan(handler="yaml")
     conf.import_config(
         textwrap.dedent(
             f"""
         {tmp_path}/study/myrepo:
-            my_url: git+file://{git_dummy_repo_dir}
+            my_url: git+file://{git_remote_repo}
     """
         )
     )
@@ -88,14 +88,14 @@ def write_config_remote(
 )
 def test_config_variations(
     tmp_path: pathlib.Path,
-    create_git_dummy_repo: DummyRepoProtocol,
+    create_git_remote_repo: CreateProjectCallbackFixtureProtocol,
     config_tpl: str,
     capsys: pytest.CaptureFixture[str],
     remote_list: t.List[str],
 ) -> None:
     """Test config output with variation of config formats"""
     dummy_repo_name = "dummy_repo"
-    dummy_repo = create_git_dummy_repo(dummy_repo_name)
+    dummy_repo = create_git_remote_repo(remote_repo_name=dummy_repo_name)
 
     config_file = write_config_remote(
         config_path=tmp_path / "myrepos.yaml",
@@ -157,17 +157,17 @@ def test_config_variations(
 )
 def test_updating_remote(
     tmp_path: pathlib.Path,
-    create_git_dummy_repo: DummyRepoProtocol,
+    create_git_remote_repo: CreateProjectCallbackFixtureProtocol,
     config_tpl: str,
     has_extra_remotes: bool,
 ) -> None:
     """Ensure additions/changes to yaml config are reflected"""
 
     dummy_repo_name = "dummy_repo"
-    dummy_repo = create_git_dummy_repo(dummy_repo_name)
+    dummy_repo = create_git_remote_repo(remote_repo_name=dummy_repo_name)
 
     mirror_name = "mirror_repo"
-    mirror_repo = create_git_dummy_repo(mirror_name)
+    mirror_repo = create_git_remote_repo(remote_repo_name=mirror_name)
 
     repo_parent = tmp_path / "study" / "myrepo"
     repo_parent.mkdir(parents=True)