Move util functions from conftest to separated module

Author: dolfinus

.gitignore

@@ -1,7 +1,3 @@
-!.vscode/extensions.json
-!.vscode/launch.json
-!.vscode/settings.json
-!.vscode/tasks.json
 *$py.class
 *.egg
 *.egg-info/
@@ -11,6 +7,10 @@
 .idea/
 .installed.cfg
 .vscode/*
+!.vscode/extensions.json
+!.vscode/launch.json
+!.vscode/settings.json
+!.vscode/tasks.json
 MANIFEST
 __pycache__/
 build/
@@ -20,6 +20,7 @@ docs/_build/
 downloads/
 eggs/
 lib/
+!tests/lib/
 lib64/
 parts/
 pip-wheel-metadata/

.pre-commit-config.yaml

@@ -8,16 +8,14 @@ repos:
   - id: check-merge-conflict
   - id: check-vcs-permalinks
   - id: check-yaml
-  - id: file-contents-sorter
-    files: ^\.gitignore$
   - id: requirements-txt-fixer
     files: ^(requirements.*\.txt)$
   - id: end-of-file-fixer
   - id: fix-byte-order-marker
   - id: fix-encoding-pragma
     args: [--remove]
   - id: name-tests-test
-    files: ^tests/.*\.py$
+    files: ^tests\/test_(unit|integration)\/.*\.py$
     args: [--django]
   - id: trailing-whitespace
   - id: detect-private-key

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "restructuredtext.confPath": "${workspaceFolder}/docs"
+}

docs/schemas/index.rst

@@ -1,3 +1,5 @@
+.. _versioning-schemas:
+
 Versioning schemas
 ------------------
 

setuptools_git_versioning.py

@@ -19,6 +19,7 @@
 DEFAULT_DEV_TEMPLATE = "{tag}.post{ccount}+git.{sha}"
 DEFAULT_DIRTY_TEMPLATE = "{tag}.post{ccount}+git.{sha}.dirty"
 DEFAULT_STARTING_VERSION = "0.0.1"
+DEFAULT_SORT_BY = "creatordate"
 ENV_VARS_REGEXP = re.compile(r"\{env:(?P<name>[^:}]+):?(?P<default>[^}]+\}*)?\}", re.IGNORECASE | re.UNICODE)
 TIMESTAMP_REGEXP = re.compile(r"\{timestamp:?(?P<fmt>[^:}]+)?\}", re.IGNORECASE | re.UNICODE)
 
@@ -32,7 +33,7 @@
     "count_commits_from_version_file": False,
     "tag_formatter": None,
     "branch_formatter": None,
-    "sort_by": None,
+    "sort_by": DEFAULT_SORT_BY,
 }
 
 log = logging.getLogger(__name__)
@@ -61,14 +62,14 @@ def get_branch():  # type: () -> Optional[str]
     return None
 
 
-def get_all_tags(sort_by="creatordate"):  # type: (str) -> List[str]
+def get_all_tags(sort_by=DEFAULT_SORT_BY):  # type: (str) -> List[str]
     tags = _exec("git tag --sort=-{}".format(sort_by))
     if tags:
         return tags
     return []
 
 
-def get_branch_tags(sort_by="creatordate"):  # type: (str) -> List[str]
+def get_branch_tags(sort_by=DEFAULT_SORT_BY):  # type: (str) -> List[str]
     tags = _exec("git tag --sort=-{} --merged".format(sort_by))
     if tags:
         return tags
@@ -380,7 +381,7 @@ def version_from_git(
     count_commits_from_version_file=False,  # type: bool
     tag_formatter=None,  # type: Optional[Callable[[str], str]]
     branch_formatter=None,  # type: Optional[Callable[[str], str]]
-    sort_by=None,  # type: Optional[str]
+    sort_by=DEFAULT_SORT_BY,  # type: str
 ):
     # type: (...) -> str
 
@@ -402,7 +403,7 @@ def version_from_git(
                 return line[8:].strip()
 
     from_file = False
-    tag = get_tag(sort_by) if sort_by else get_tag()
+    tag = get_tag(sort_by=sort_by)
 
     if tag is None:
         # TODO: raise exception if both version_callback and version_file are set

tests/conftest.py

@@ -1,234 +1,13 @@
-from functools import partial
-import logging
 import os
 import pytest
 import shutil
-import subprocess
-import sys
 import textwrap
-import toml
-import uuid
 
-from typing import Any, Callable, Dict, Optional
+from tests.lib.util import rand_str, create_file, execute
 
-log = logging.getLogger(__name__)
 root = os.path.dirname(os.path.dirname(__file__))
 
 
-def rand_str():  # type: () -> str
-    return str(uuid.uuid4())
-
-
-def execute(cwd, cmd, **kwargs):  # type: (str, str, **Any) -> str
-    log.info(cwd)
-    return subprocess.check_output(cmd, cwd=cwd, shell=True, universal_newlines=True, **kwargs)  # nosec
-
-
-def create_file(
-    cwd,  # type: str
-    name=None,  # type: Optional[str]
-    content=None,  # type: Optional[str]
-    add=True,  # type: bool
-    commit=True,  # type: bool
-    **kwargs  # type: Any
-):  # type: (...) -> Optional[str]
-    result = None
-
-    if not name:
-        name = rand_str()
-    if content is None:
-        content = rand_str()
-
-    log.warning(content)
-    with open(os.path.join(cwd, name), "w") as f:
-        f.write(content)
-
-    if add:
-        execute(cwd, "git add {name}".format(name=name))
-        log.info(execute(cwd, "git status"))
-        log.info(execute(cwd, "git diff"))
-
-        if commit:
-            execute(cwd, 'git commit -m "Add {name}"'.format(name=name))
-            result = get_short_commit(cwd)
-
-    return result
-
-
-def create_pyproject_toml(
-    cwd,  # type: str
-    config=None,  # type: Optional[dict]
-    commit=True,  # type: bool
-    **kwargs  # type: Any
-):  # type: (...) -> Optional[str]
-    # well, using pyproject.toml+setup.cfg is more classic
-    # but it is not easy to check code coverage in such a case
-    # so we're using pyproject.toml+setup.py
-    create_file(
-        cwd,
-        "setup.py",
-        textwrap.dedent(
-            """
-            from coverage.control import Coverage
-
-            coverage = Coverage()
-            coverage.start()
-
-            try:
-                import setuptools
-
-                setuptools.setup(
-                    name="mypkg",
-                )
-            finally:
-                coverage.stop()
-                coverage.save()
-            """
-        ),
-        commit=False,
-        **kwargs
-    )
-
-    cfg = {}  # type: Dict[str, Any]
-    cfg["build-system"] = {
-        "requires": [
-            "setuptools>=41",
-            "wheel",
-            "setuptools-git-versioning",
-        ],
-        # with default "setuptools.build_meta" it is not possible to build package
-        # which uses its own source code to get version number,
-        # e.g. `version_callback` or `branch_formatter`
-        # mote details: https://github.com/pypa/setuptools/issues/1642#issuecomment-457673563
-        "build-backend": "setuptools.build_meta:__legacy__",
-    }
-
-    if config is None:
-        config = {"enabled": True}
-
-    if config != NotImplemented:
-        cfg["tool"] = {"setuptools-git-versioning": config}
-
-    return create_file(cwd, "pyproject.toml", toml.dumps(cfg), commit=commit, **kwargs)
-
-
-def create_setup_py(
-    cwd,  # type: str
-    config=None,  # type: Optional[dict]
-    option="setuptools_git_versioning",  # # type: str
-    **kwargs  # type: Any
-):  # type: (...) -> Optional[str]
-
-    if config is None:
-        config = {"enabled": True}
-
-    if config == NotImplemented:
-        cfg = ""
-    else:
-        cfg = "{option}={config},".format(option=option, config=config)
-
-    return create_file(
-        cwd,
-        "setup.py",
-        textwrap.dedent(
-            """
-            from coverage.control import Coverage
-
-            coverage = Coverage()
-            coverage.start()
-
-            try:
-                import setuptools
-
-                setuptools.setup(
-                    name="mypkg",
-                    {cfg}
-                    setup_requires=[
-                        "setuptools>=41",
-                        "wheel",
-                        "setuptools-git-versioning",
-                    ]
-                )
-            finally:
-                coverage.stop()
-                coverage.save()
-            """
-        ).format(cfg=cfg),
-        **kwargs
-    )
-
-
-@pytest.fixture(params=[create_setup_py, create_pyproject_toml])
-def create_config(request):
-    return request.param
-
-
-def typed_config(
-    repo,  # type: str
-    config_creator,  # type: Callable
-    config_type,  # type: str
-    template=None,  # type: Optional[str]
-    template_name=None,  # type: Optional[str]
-    config=None,  # type: Optional[dict]
-):
-    if config_type == "tag":
-        cfg = {}
-    else:
-        cfg = {"version_file": "VERSION.txt", "count_commits_from_version_file": True}
-
-    if template_name is None:
-        if config_type == "tag":
-            template_name = "template"
-        else:
-            template_name = "dev_template"
-
-    if template:
-        cfg[template_name] = template
-
-    if config:
-        cfg.update(config)
-
-    config_creator(repo, cfg)
-
-    if config_type == "tag":
-        execute(repo, "git tag 1.2.3")
-    else:
-        create_file(repo, "VERSION.txt", "1.2.3")
-
-
-@pytest.fixture(params=["tag", "version_file"])
-def template_config(request):
-    return partial(typed_config, config_type=request.param)
-
-
-def get_version_setup_py(cwd, **kwargs):  # type: (str, **Any) -> str
-    return execute(cwd, "{python} setup.py --version".format(python=sys.executable), **kwargs).strip()
-
-
-def get_version(cwd, isolated=False, **kwargs):  # type: (str, bool, **Any) -> str
-    cmd = "{python} -m build -s".format(python=sys.executable)
-    if not isolated:
-        cmd += " --no-isolation"
-    execute(cwd, cmd, **kwargs)
-
-    with open(os.path.join(cwd, "mypkg.egg-info/PKG-INFO")) as f:
-        content = f.read().splitlines()
-
-    for line in content:
-        if line.startswith("Version: "):
-            return line.replace("Version: ", "").strip()
-
-    raise RuntimeError("Cannot get package version")
-
-
-def get_commit(cwd, **kwargs):  # type: (str, **Any) -> str
-    return execute(cwd, "git rev-list -n 1 HEAD", **kwargs).strip()
-
-
-def get_short_commit(cwd, **kwargs):  # type: (str, *Any) -> str
-    return get_commit(cwd, **kwargs)[:8]
-
-
 @pytest.fixture
 def repo_dir(tmpdir):
     repo_dir = str(tmpdir.mkdir(rand_str()))