Implemented 'smart-tests get docs' command

See: https://htmlpreview.github.io/?https://gist.github.com/kohsuke/fc76db6b1276c77d388e063b36572fe7/raw/651263a15993fbeb665ece68dc5c032e4a98a1fe/out.html

Author: kohsuke

.gitignore

@@ -145,3 +145,6 @@ bazel-*
 
 .DS_Store
 .idea/*
+
+# Docs bundled from docsite repo at build time; populated by `uv build` or `smart-tests get docs` in dev
+smart_tests/docs/

pyproject.toml

@@ -61,6 +61,6 @@ build-backend = "setuptools.build_meta"
 packages = ["smart_tests"]
 
 [tool.setuptools.package-data]
-smart_tests = ["jar/exe_deploy.jar"]
+smart_tests = ["jar/exe_deploy.jar", "docs/**/*"]
 
 [tool.setuptools_scm]

setup.py

@@ -1,3 +1,27 @@
+import shutil
+import subprocess
+import tempfile
+from pathlib import Path
+
 from setuptools import setup
+from setuptools.command.build_py import build_py
+
+
+class BuildPyWithDocs(build_py):
+    def run(self):
+        docs_dst = Path(__file__).parent / 'smart_tests' / 'docs'
+        if docs_dst.exists():
+            shutil.rmtree(docs_dst)
+
+        with tempfile.TemporaryDirectory() as tmpdir:
+            subprocess.run(
+                ['git', 'clone', '--depth=1',
+                 'git@github.com:cloudbees/docsite-cloudbees-smart-tests.git', tmpdir],
+                check=True,
+            )
+            shutil.copytree(Path(tmpdir) / 'docs', docs_dst)
+
+        super().run()
+
 
-setup()
+setup(cmdclass={'build_py': BuildPyWithDocs})

smart_tests/__main__.py

@@ -9,6 +9,7 @@
 from smart_tests.commands.compare import compare
 from smart_tests.commands.detect_flakes import detect_flakes
 from smart_tests.commands.gate import gate
+from smart_tests.commands.get import get
 from smart_tests.commands.inspect import inspect
 from smart_tests.commands.record import record
 from smart_tests.commands.stats import stats
@@ -25,6 +26,7 @@
 cli.add_command(compare)
 cli.add_command(detect_flakes)
 cli.add_command(gate)
+cli.add_command(get)
 
 
 def _load_test_runners():

smart_tests/commands/get/__init__.py

@@ -0,0 +1,11 @@
+from ... import args4p
+from ...app import Application
+from .docs import docs
+
+
+@args4p.group(help="Retrieve resources")
+def get(app: Application):
+    return app
+
+
+get.add_command(docs)

smart_tests/commands/get/docs.py

@@ -0,0 +1,72 @@
+import importlib.resources
+import shutil
+import subprocess
+import sys
+import tempfile
+from pathlib import Path
+
+import click
+
+from ... import args4p
+from ...app import Application
+
+DOCSITE_REPO = 'git@github.com:cloudbees/docsite-cloudbees-smart-tests.git'
+OUTPUT_DIR = 'smart-tests-docs'
+
+
+def _find_bundled_docs() -> Path | None:
+    """Return the path to the bundled docs/ directory, or None if not present."""
+    pkg = importlib.resources.files('smart_tests') / 'docs'
+    # files() returns a Traversable; check it's a real, non-empty directory
+    try:
+        p = Path(str(pkg))
+        if p.is_dir() and any(p.iterdir()):
+            return p
+    except (TypeError, OSError):
+        pass
+    return None
+
+
+def _fetch_docs_via_git() -> Path:
+    """
+    Clone the docsite repo into smart_tests/docs/ (relative to this package's
+    location) and return the path to the docs/ subdirectory.
+
+    If smart_tests/docs/ already exists, run `git pull` instead of cloning.
+    """
+    package_dir = Path(__file__).parent.parent.parent  # smart_tests/
+    docs_dst = package_dir / 'docs'
+
+    if docs_dst.is_dir():
+        click.echo(f"Updating docs from {DOCSITE_REPO} ...")
+        subprocess.run(['git', '-C', str(docs_dst), 'pull'], check=True)
+    else:
+        click.echo(f"Cloning docs from {DOCSITE_REPO} ...")
+        with tempfile.TemporaryDirectory() as tmpdir:
+            subprocess.run(
+                ['git', 'clone', '--depth=1', DOCSITE_REPO, tmpdir],
+                check=True,
+            )
+            shutil.copytree(Path(tmpdir) / 'docs', docs_dst)
+
+    return docs_dst
+
+
+@args4p.command(help="Copy product documentation into ./smart-tests-docs")
+def docs(app: Application):
+    output = Path(OUTPUT_DIR)
+    if output.exists():
+        click.secho(
+            f"'{OUTPUT_DIR}' already exists. Please delete it first, then re-run this command.",
+            fg='red', err=True,
+        )
+        sys.exit(1)
+
+    docs_src = _find_bundled_docs()
+    if docs_src is None:
+        # Dev mode: not running from an installed package
+        docs_src = _fetch_docs_via_git()
+
+    click.echo(f"Copying docs to ./{OUTPUT_DIR} ...")
+    shutil.copytree(docs_src, output)
+    click.echo(f"Done. Documentation is in ./{OUTPUT_DIR}")