patch-via-github 1.0.0__py3-none-any.whl

patch_via_github/tests/__init__.py

@@ -0,0 +1 @@
+"""Test suite for patch_via_github."""

patch_via_github/tests/conftest.py

@@ -0,0 +1,185 @@
+import os
+import subprocess
+import xml.etree.ElementTree as EleTree
+from pathlib import Path
+
+import pytest
+import requests
+
+import patch_via_github.scripts.main as app
+
+TESTS_DIR = Path(__file__).parent
+
+GIT_ENV = {
+    'GIT_AUTHOR_NAME': 't', 'GIT_AUTHOR_EMAIL': 't@example.com',
+    'GIT_COMMITTER_NAME': 't', 'GIT_COMMITTER_EMAIL': 't@example.com',
+    'GIT_CONFIG_GLOBAL': os.devnull, 'GIT_CONFIG_NOSYSTEM': '1',
+}
+
+
+@pytest.fixture(autouse=True)
+def isolated(monkeypatch, tmp_path):
+    """No network, no host config, and no logger state leaking between tests"""
+
+    def no_network(*args, **kwargs):
+        pytest.fail(f'test attempted network access: {args[1:3]}')
+
+    monkeypatch.setattr(requests.Session, 'request', no_network)
+    # Git may only reach local repos, so a wrong fetch URL can't hit GitHub
+    monkeypatch.setenv('GIT_ALLOW_PROTOCOL', 'file')
+    monkeypatch.setenv('HOME', str(tmp_path / 'home'))
+    monkeypatch.delenv('LD_LIBRARY_PATH', raising=False)
+    handlers, level = app.logger.handlers[:], app.logger.level
+    yield
+    app.logger.handlers[:] = handlers
+    app.logger.setLevel(level)
+
+
+def make_pr_api_response(
+    number, repo_name, org="couchbase", base_ref="master",
+    head_sha="abc123", state="open", labels=None, title=None
+):
+    """Build a mock GitHub PR API response dict."""
+    return {
+        "number": number,
+        "state": state,
+        "title": title or f"PR #{number}",
+        "html_url": f"https://github.com/{org}/{repo_name}/pull/{number}",
+        "labels": [{"name": lbl} for lbl in (labels or [])],
+        "base": {
+            "ref": base_ref,
+            "repo": {
+                "name": repo_name,
+                "full_name": f"{org}/{repo_name}",
+                "clone_url": f"https://github.com/{org}/{repo_name}.git",
+                "ssh_url": f"git@github.com:{org}/{repo_name}.git",
+            },
+        },
+        "head": {
+            "sha": head_sha,
+            "ref": f"feature-{number}",
+            "repo": {
+                "clone_url": f"https://github.com/{org}/{repo_name}.git",
+            },
+        },
+    }
+
+
+def commit(sha, parents):
+    return {"sha": sha, "parents": [{"sha": p} for p in parents]}
+
+
+@pytest.fixture
+def config_file(tmp_path):
+    ini = tmp_path / "patch_via_github.ini"
+    ini.write_text(
+        "[main]\n"
+        "token = ghp_test_token_000000000000000000000\n"
+        "default_org = couchbase\n"
+    )
+    return str(ini)
+
+
+@pytest.fixture
+def config_file_no_org(tmp_path):
+    ini = tmp_path / "patch_via_github_no_org.ini"
+    ini.write_text(
+        "[main]\n"
+        "token = ghp_test_token_000000000000000000000\n"
+    )
+    return str(ini)
+
+
+@pytest.fixture
+def gp_with_manifest(config_file):
+    gp = app.GitHubPatches.from_config_file(config_file)
+    gp.manifest = EleTree.parse(str(TESTS_DIR / "manifest.xml")).getroot()
+    return gp
+
+
+class GitRepos:
+    """
+    An origin repo exposing PR heads as refs/pull/N/head, a clone of it
+    standing in for a repo sync project, and the GitHub API data for the
+    PRs made on it
+    """
+
+    def __init__(self, root):
+        self.root = root
+        self.origin = root / "origin"
+        self.work = root / "work"
+        self.git(root, 'init', '-q', '-b', 'master', str(self.origin))
+        self.commit_file("f", "base\n", "base")
+        self.git(root, 'clone', '-q', str(self.origin), str(self.work))
+        self.api = {}
+        self.endpoints = []
+
+    def git(self, cwd, *args):
+        return subprocess.run(
+            ['git', *args], cwd=cwd, check=True, capture_output=True,
+            text=True, env={**os.environ, **GIT_ENV}
+        ).stdout.strip()
+
+    def clone(self, path):
+        self.git(self.root, 'clone', '-q', str(self.origin), str(path))
+        return path
+
+    def commit_file(self, name, content, msg, repo=None):
+        repo = repo or self.origin
+        (repo / name).write_text(content)
+        self.git(repo, 'add', name)
+        self.git(repo, 'commit', '-q', '-m', msg)
+        return self.git(repo, 'rev-parse', 'HEAD')
+
+    def make_pr(self, number, branch, commits, start='master',
+                project='work', **fields):
+        """commits: [(file, content, message)]; None content = empty commit"""
+        self.git(self.origin, 'checkout', '-q', '-B', branch, start)
+        for name, content, msg in commits:
+            if content is None:
+                self.git(self.origin, 'commit', '-q', '--allow-empty',
+                         '-m', msg)
+            else:
+                self.commit_file(name, content, msg)
+        head = self.git(self.origin, 'rev-parse', 'HEAD')
+        self.git(self.origin, 'update-ref', f'refs/pull/{number}/head', head)
+        self.git(self.origin, 'checkout', '-q', 'master')
+
+        log = self.git(self.origin, 'log', '--format=%H %P',
+                       f'{start}..{head}').splitlines()
+        data = make_pr_api_response(number, project, head_sha=head, **fields)
+        data['base']['repo']['clone_url'] = str(self.origin)
+        data['base']['repo']['ssh_url'] = str(self.root / "ssh-unreachable")
+        api_commits = [commit(line.split()[0], line.split()[1:])
+                       for line in log]
+
+        # The listing omits the commit count, as GitHub's does
+        pulls = f'/repos/couchbase/{project}/pulls'
+        self.api[f'{pulls}/{number}'] = {**data, 'commits': len(log)}
+        self.api[f'{pulls}/{number}/commits?per_page=100'] = api_commits
+        listing = self.api.setdefault(f'{pulls}?state=open&per_page=100', [])
+        listing[:] = [pr for pr in listing if pr['number'] != number]
+        if data['state'] == 'open':
+            listing.append(data)
+
+        pr = app.GitHubPR({**data, 'commits': len(log)})
+        return pr, api_commits
+
+    def api_get(self, endpoint):
+        """Stand-in for GitHub; names are case-insensitive, as there"""
+        self.endpoints.append(endpoint)
+        return self.api[endpoint.lower()]
+
+    def work_log(self, repo=None):
+        return self.git(repo or self.work, 'log',
+                        '--format=%s').splitlines()
+
+    def work_file(self, name):
+        return (self.work / name).read_text()
+
+
+@pytest.fixture
+def repos(tmp_path, monkeypatch):
+    for key, value in GIT_ENV.items():
+        monkeypatch.setenv(key, value)
+    return GitRepos(tmp_path)

patch_via_github/tests/manifest.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<manifest>
+  <!-- Test-only manifest for patch_via_github unit tests. Never built. -->
+  <remote name="couchbase" fetch="https://github.com/couchbase/" />
+
+  <default remote="couchbase" revision="master" />
+
+  <project name="tlm" revision="master" groups="kv"/>
+  <project name="ns_server" groups="bsl"/>
+  <project name="geocouch" revision="3e8040787139e3c67766ce50398860c185737b8a"/>
+  <project name="eventing" path="goproj/src/github.com/couchbase/eventing"/>
+  <project name="build" groups="build"/>
+  <project name="server-ui" revision="main"/>
+  <project name="couchbase-cli" path="couchbase-cli-tools" revision="master"/>
+  <project name="cbgt"/>
+  <project name="stellar-gateway" revision="a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"/>
+
+</manifest>