pytest-html-plus 0.4.2__tar.gz → 0.4.3__tar.gz

{pytest_html_plus-0.4.2 → pytest_html_plus-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pytest-html-plus
-Version: 0.4.2
+Version: 0.4.3
 Summary: Get started with rich pytest reports in under 3 seconds. Just install the plugin — no setup required. The simplest, fastest reporter for pytest.
 License: MIT
 Keywords: pytest,pytest-html-plus,pytest-plugin,html-test-report,beautiful-test-report,shareable-test-results,test-report,test-results,unit-test-report,functional-test-report,test-summary,reporting,python-testing,automated-testing,test-runner,report-generator,continuous-integration,ci-cd,github-actions,jenkins,pytest-html,pytest-report

{pytest_html_plus-0.4.2 → pytest_html_plus-0.4.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pytest-html-plus"
-version = "0.4.2"
+version = "0.4.3"
 description = "Get started with rich pytest reports in under 3 seconds. Just install the plugin — no setup required. The simplest, fastest reporter for pytest."
 readme = "README.md"
 authors = ["reporterplus"]

pytest_html_plus-0.4.3/pytest_html_plus/compute_git_branch.py

@@ -0,0 +1,99 @@
+import os
+import threading
+import subprocess
+from typing import Tuple, Optional
+
+_CACHE_LOCK = threading.Lock()
+_CACHED_REPO_INFO: Optional[Tuple[str, str]] = None
+
+# Env vars we treat as authoritative when present (CI) — cheap checks
+_CI_BRANCH_VARS = [
+    "GITHUB_HEAD_REF", "GITHUB_REF_NAME",
+    "CI_COMMIT_REF_NAME", "BITBUCKET_BRANCH",
+    "BUILD_SOURCEBRANCHNAME", "CIRCLE_BRANCH",
+    "BRANCH_NAME", "TRAVIS_BRANCH", "GIT_BRANCH"
+]
+_CI_COMMIT_VARS = [
+    "GITHUB_SHA", "CI_COMMIT_SHA", "BITBUCKET_COMMIT",
+    "BUILD_SOURCEVERSION", "CIRCLE_SHA1", "TRAVIS_COMMIT"
+]
+
+def _run_git(cmd: list, timeout: float = 1.0) -> Optional[str]:
+    try:
+        out = subprocess.check_output(cmd, stderr=subprocess.DEVNULL, timeout=timeout)
+        return out.decode().strip()
+    except Exception:
+        return None
+
+def get_repo_info() -> Tuple[str, str]:
+    """
+    Return (branch, commit_sha).
+    - Branch is a readable branch name or "NA".
+    - Commit is full SHA or "NA".
+    Behavior:
+      1) If REPORTER_BRANCH / REPORTER_COMMIT provided -> use them (manual override).
+      2) Else read common CI env vars (cheap).
+      3) Else call git once to get commit, and try to get branch (symbolic-ref / points-at).
+    Result is cached per-process.
+    """
+    global _CACHED_REPO_INFO
+
+    # 0) Manual overrides (explicit, highest priority) - zero cost
+    manual_branch = os.getenv("REPORTER_BRANCH")
+    manual_commit = os.getenv("REPORTER_COMMIT")
+    if manual_branch or manual_commit:
+        branch = manual_branch or "NA"
+        commit = manual_commit or _run_git(["git", "rev-parse", "HEAD"]) or "NA"
+        with _CACHE_LOCK:
+            _CACHED_REPO_INFO = (branch, commit)
+        return _CACHED_REPO_INFO
+
+    # 1) CI envs (cheap, no subprocess)
+    for var in _CI_COMMIT_VARS:
+        val = os.getenv(var)
+        if val:
+            commit = val
+            # try branch envs (if any)
+            branch = next((os.getenv(bv) for bv in _CI_BRANCH_VARS if os.getenv(bv)), "NA")
+            with _CACHE_LOCK:
+                _CACHED_REPO_INFO = (branch, commit)
+            return _CACHED_REPO_INFO
+
+    for var in _CI_BRANCH_VARS:
+        val = os.getenv(var)
+        if val:
+            # branch available but commit not set in CI envs -> get commit cheaply
+            commit = _run_git(["git", "rev-parse", "HEAD"]) or "NA"
+            with _CACHE_LOCK:
+                _CACHED_REPO_INFO = (val, commit)
+            return _CACHED_REPO_INFO
+
+    # 2) Return cached if already computed
+    with _CACHE_LOCK:
+        if _CACHED_REPO_INFO is not None:
+            return _CACHED_REPO_INFO
+
+    # 3) Final: use git (one or two quick calls), cached afterwards
+    commit = _run_git(["git", "rev-parse", "HEAD"]) or "NA"
+    branch = _run_git(["git", "symbolic-ref", "--short", "-q", "HEAD"])
+
+    # If symbolic-ref didn't return and commit is present, try local branches pointing to HEAD
+    if not branch and commit != "NA":
+        branches = _run_git(["git", "branch", "--points-at", "HEAD", "--format=%(refname:short)"])
+        if branches:
+            branch = branches.splitlines()[0].strip()
+
+    if not branch:
+        branch = "NA"
+
+    with _CACHE_LOCK:
+        _CACHED_REPO_INFO = (branch, commit)
+    return _CACHED_REPO_INFO
+
+def display_repo_ref(short_len: int = 7) -> str:
+    """Return a friendly display like 'feature/foo (5bb4c87)' or '5bb4c87'."""
+    branch, commit = get_repo_info()
+    commit_short = commit[:short_len] if commit and commit != "NA" else "NA"
+    if branch and branch != "NA":
+        return f"{branch} ({commit_short})"
+    return commit_short

{pytest_html_plus-0.4.2 → pytest_html_plus-0.4.3}/pytest_html_plus/compute_report_metadata.py

@@ -1,18 +1,19 @@
 import json
 from datetime import datetime
 
-from pytest_html_plus.utils import is_main_worker, get_env_marker, get_git_branch, get_git_commit, get_report_title, \
+from pytest_html_plus.utils import is_main_worker, get_env_marker, get_git_information, get_report_title, \
     get_python_version
 
 
 def write_plus_metadata_if_main_worker(config, report_path, output_path="plus_metadata.json"):
     if not is_main_worker():
         return
+    branch, commit = get_git_information()
     metadata = {
         "report_title": get_report_title(output_path=report_path),
         "environment": get_env_marker(config),
-        "branch": get_git_branch(),
-        "commit": get_git_commit(),
+        "branch": branch,
+        "commit": commit,
         "python_version": get_python_version(),
         "generated_at": datetime.now().isoformat()
     }

{pytest_html_plus-0.4.2 → pytest_html_plus-0.4.3}/pytest_html_plus/utils.py

@@ -3,31 +3,11 @@ import subprocess
 import shutil
 import os
 
+from pytest_html_plus.compute_git_branch import get_repo_info
 
-def get_git_commit():
-    try:
-        return subprocess.check_output(["git", "rev-parse", "HEAD"]).decode().strip()
-    except Exception:
-        return "NA"
-
-def get_git_branch():
-    branch_env_vars = [
-        "GITHUB_HEAD_REF", "GITHUB_REF_NAME",
-        "CI_COMMIT_REF_NAME", "BITBUCKET_BRANCH",
-        "BUILD_SOURCEBRANCHNAME", "CIRCLE_BRANCH",
-        "BRANCH_NAME", "TRAVIS_BRANCH"
-    ]
-    for var in branch_env_vars:
-        val = os.getenv(var)
-        if val:
-            return val
 
-    try:
-        return subprocess.check_output(
-            ["git", "rev-parse", "--abbrev-ref", "HEAD"]
-        ).decode().strip()
-    except Exception:
-        return "NA"
+def get_git_information():
+    return get_repo_info()
 
 def get_env_marker(config):
     for arg in ("--env", "--environment"):