mini-runbot 0.2.0__tar.gz

mini_runbot-0.2.0/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: mini-runbot
+Version: 0.2.0
+Summary: A small, local build orchestrator proof of concept for Odoo 16
+Author: rafnixg
+Project-URL: Documentation, https://rafnixg.github.io/odoo-platform-ephemeral-environment/
+Project-URL: Repository, https://github.com/rafnixg/odoo-platform-ephemeral-environment
+Project-URL: Issues, https://github.com/rafnixg/odoo-platform-ephemeral-environment/issues
+Project-URL: DeepWiki, https://deepwiki.com/rafnixg/odoo-platform-ephemeral-environment
+Keywords: odoo,docker,runbot,testing,ephemeral-environments
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi<1,>=0.115
+Requires-Dist: jinja2<4,>=3.1
+Requires-Dist: pydantic<3,>=2.9
+Requires-Dist: pyyaml<7,>=6
+Requires-Dist: rich<15,>=13
+Requires-Dist: sqlalchemy<3,>=2.0
+Requires-Dist: typer<1,>=0.12
+Requires-Dist: uvicorn<1,>=0.30
+Provides-Extra: dev
+Requires-Dist: build<2,>=1; extra == "dev"
+Requires-Dist: httpx<1,>=0.27; extra == "dev"
+Requires-Dist: pytest<9,>=8; extra == "dev"
+Requires-Dist: pytest-asyncio<1,>=0.24; extra == "dev"
+Requires-Dist: pytest-cov<7,>=5; extra == "dev"
+Requires-Dist: ruff<1,>=0.8; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs-material<10,>=9; extra == "docs"
+
+# Mini-Runbot for Odoo 16 (PoC)
+
+[![CI](https://github.com/rafnixg/odoo-platform-ephemeral-environment/actions/workflows/ci.yml/badge.svg)](https://github.com/rafnixg/odoo-platform-ephemeral-environment/actions/workflows/ci.yml)
+[![Documentation](https://github.com/rafnixg/odoo-platform-ephemeral-environment/actions/workflows/docs.yml/badge.svg)](https://github.com/rafnixg/odoo-platform-ephemeral-environment/actions/workflows/docs.yml)
+[![CodeQL](https://github.com/rafnixg/odoo-platform-ephemeral-environment/actions/workflows/codeql.yml/badge.svg)](https://github.com/rafnixg/odoo-platform-ephemeral-environment/actions/workflows/codeql.yml)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/rafnixg/odoo-platform-ephemeral-environment)
+
+Mini-Runbot turns configured Git revisions and Odoo module lists into isolated, tested, temporary
+Odoo 16 environments. It is a local, single-host proof of concept for trusted repositories, not a
+security boundary for hostile code.
+
+## Documentation
+
+- [Documentación en español](https://rafnixg.github.io/odoo-platform-ephemeral-environment/)
+- [English documentation](https://rafnixg.github.io/odoo-platform-ephemeral-environment/en/)
+- [Documentation sources](gh-docs/es/index.md)
+- [Explore the codebase in DeepWiki](https://deepwiki.com/rafnixg/odoo-platform-ephemeral-environment)
+
+The bilingual portal is the canonical project documentation. It covers installation on Windows and
+Linux, configuration, dashboard and CLI usage, the HTTP API, operations, security limits, testing,
+the roadmap, and architecture decisions. Its technical guides connect behavior to the current
+implementation:
+
+- [Domain model and lifecycle](gh-docs/en/domain-model.md)
+- [Eight-stage build pipeline](gh-docs/en/build-pipeline.md)
+- [Concurrency, cleanup, and recovery](gh-docs/en/concurrency-recovery.md)
+- [Ports and adapters](gh-docs/en/adapters.md)
+- [Troubleshooting and operator runbook](gh-docs/en/troubleshooting.md)
+- [CI/CD and automated security](gh-docs/en/ci-cd.md)
+- [Glossary](gh-docs/en/glossary.md)
+
+DeepWiki provides a generated, code-oriented view that complements the maintained portal; when the
+two differ, the repository documentation and implementation are authoritative.
+
+## Quick start
+
+Python 3.12, Git, and Docker Compose v2 are required. On Windows, use Docker Desktop with Linux
+containers; on Linux, use Docker Engine with the Compose v2 plugin.
+
+### PyPI application
+
+Mini-Runbot is packaged as a CLI application. After the first PyPI release, install it in an
+isolated environment with `pipx`:
+
+```console
+pipx install mini-runbot
+mini-runbot init
+```
+
+Until that release, clone the repository and run `pipx install .`, or use the development setup
+below. `init` asks for runtime and allowed-repository settings and refuses to overwrite an existing
+`config.local.yaml`. Use `mini-runbot init --defaults` for the bundled example values.
+
+### Development installation
+
+#### Windows · PowerShell
+
+```powershell
+py -3.12 -m venv .venv
+.venv\Scripts\Activate.ps1
+python -m pip install -e ".[dev]"
+mini-runbot init
+$env:MINI_RUNBOT_CONFIG = (Resolve-Path config.local.yaml)
+mini-runbot doctor
+mini-runbot serve --reload
+```
+
+#### Linux · Bash
+
+```bash
+python3.12 -m venv .venv
+source .venv/bin/activate
+python -m pip install -e ".[dev]"
+mini-runbot init
+export MINI_RUNBOT_CONFIG="$(realpath config.local.yaml)"
+mini-runbot doctor
+mini-runbot serve --reload
+```
+
+Open `http://127.0.0.1:8000`, or create a build from the CLI:
+
+```console
+mini-runbot build create --repo custom --ref 16.0 --modules module_a,module_b --run
+```
+
+Repository inputs are configured aliases, never arbitrary URLs or filesystem paths supplied by a
+client.
+
+## Local checks
+
+The same commands work in an activated PowerShell or Bash environment:
+
+```console
+python -m pip install -e ".[dev,docs]"
+python -m pytest -m "not docker"
+python -m ruff check .
+node --check src/mini_runbot/web/app.js
+python -m build
+python scripts/check_distribution.py dist
+python scripts/check_docs.py
+python -m mkdocs build --strict --config-file gh-docs/mkdocs.es.yml --site-dir ../site
+python -m mkdocs build --strict --config-file gh-docs/mkdocs.en.yml --site-dir ../site/en
+git diff --check
+```
+
+Docker-marked end-to-end tests remain an explicit local check because they require a working daemon,
+image registry access, and real Odoo startup.

mini_runbot-0.2.0/README.md

@@ -0,0 +1,107 @@
+# Mini-Runbot for Odoo 16 (PoC)
+
+[![CI](https://github.com/rafnixg/odoo-platform-ephemeral-environment/actions/workflows/ci.yml/badge.svg)](https://github.com/rafnixg/odoo-platform-ephemeral-environment/actions/workflows/ci.yml)
+[![Documentation](https://github.com/rafnixg/odoo-platform-ephemeral-environment/actions/workflows/docs.yml/badge.svg)](https://github.com/rafnixg/odoo-platform-ephemeral-environment/actions/workflows/docs.yml)
+[![CodeQL](https://github.com/rafnixg/odoo-platform-ephemeral-environment/actions/workflows/codeql.yml/badge.svg)](https://github.com/rafnixg/odoo-platform-ephemeral-environment/actions/workflows/codeql.yml)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/rafnixg/odoo-platform-ephemeral-environment)
+
+Mini-Runbot turns configured Git revisions and Odoo module lists into isolated, tested, temporary
+Odoo 16 environments. It is a local, single-host proof of concept for trusted repositories, not a
+security boundary for hostile code.
+
+## Documentation
+
+- [Documentación en español](https://rafnixg.github.io/odoo-platform-ephemeral-environment/)
+- [English documentation](https://rafnixg.github.io/odoo-platform-ephemeral-environment/en/)
+- [Documentation sources](gh-docs/es/index.md)
+- [Explore the codebase in DeepWiki](https://deepwiki.com/rafnixg/odoo-platform-ephemeral-environment)
+
+The bilingual portal is the canonical project documentation. It covers installation on Windows and
+Linux, configuration, dashboard and CLI usage, the HTTP API, operations, security limits, testing,
+the roadmap, and architecture decisions. Its technical guides connect behavior to the current
+implementation:
+
+- [Domain model and lifecycle](gh-docs/en/domain-model.md)
+- [Eight-stage build pipeline](gh-docs/en/build-pipeline.md)
+- [Concurrency, cleanup, and recovery](gh-docs/en/concurrency-recovery.md)
+- [Ports and adapters](gh-docs/en/adapters.md)
+- [Troubleshooting and operator runbook](gh-docs/en/troubleshooting.md)
+- [CI/CD and automated security](gh-docs/en/ci-cd.md)
+- [Glossary](gh-docs/en/glossary.md)
+
+DeepWiki provides a generated, code-oriented view that complements the maintained portal; when the
+two differ, the repository documentation and implementation are authoritative.
+
+## Quick start
+
+Python 3.12, Git, and Docker Compose v2 are required. On Windows, use Docker Desktop with Linux
+containers; on Linux, use Docker Engine with the Compose v2 plugin.
+
+### PyPI application
+
+Mini-Runbot is packaged as a CLI application. After the first PyPI release, install it in an
+isolated environment with `pipx`:
+
+```console
+pipx install mini-runbot
+mini-runbot init
+```
+
+Until that release, clone the repository and run `pipx install .`, or use the development setup
+below. `init` asks for runtime and allowed-repository settings and refuses to overwrite an existing
+`config.local.yaml`. Use `mini-runbot init --defaults` for the bundled example values.
+
+### Development installation
+
+#### Windows · PowerShell
+
+```powershell
+py -3.12 -m venv .venv
+.venv\Scripts\Activate.ps1
+python -m pip install -e ".[dev]"
+mini-runbot init
+$env:MINI_RUNBOT_CONFIG = (Resolve-Path config.local.yaml)
+mini-runbot doctor
+mini-runbot serve --reload
+```
+
+#### Linux · Bash
+
+```bash
+python3.12 -m venv .venv
+source .venv/bin/activate
+python -m pip install -e ".[dev]"
+mini-runbot init
+export MINI_RUNBOT_CONFIG="$(realpath config.local.yaml)"
+mini-runbot doctor
+mini-runbot serve --reload
+```
+
+Open `http://127.0.0.1:8000`, or create a build from the CLI:
+
+```console
+mini-runbot build create --repo custom --ref 16.0 --modules module_a,module_b --run
+```
+
+Repository inputs are configured aliases, never arbitrary URLs or filesystem paths supplied by a
+client.
+
+## Local checks
+
+The same commands work in an activated PowerShell or Bash environment:
+
+```console
+python -m pip install -e ".[dev,docs]"
+python -m pytest -m "not docker"
+python -m ruff check .
+node --check src/mini_runbot/web/app.js
+python -m build
+python scripts/check_distribution.py dist
+python scripts/check_docs.py
+python -m mkdocs build --strict --config-file gh-docs/mkdocs.es.yml --site-dir ../site
+python -m mkdocs build --strict --config-file gh-docs/mkdocs.en.yml --site-dir ../site/en
+git diff --check
+```
+
+Docker-marked end-to-end tests remain an explicit local check because they require a working daemon,
+image registry access, and real Odoo startup.

mini_runbot-0.2.0/pyproject.toml

@@ -0,0 +1,83 @@
+[build-system]
+requires = ["setuptools>=75"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mini-runbot"
+version = "0.2.0"
+description = "A small, local build orchestrator proof of concept for Odoo 16"
+readme = "README.md"
+requires-python = ">=3.12"
+authors = [{ name = "rafnixg" }]
+keywords = ["odoo", "docker", "runbot", "testing", "ephemeral-environments"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Framework :: FastAPI",
+  "Intended Audience :: Developers",
+  "Operating System :: Microsoft :: Windows",
+  "Operating System :: POSIX :: Linux",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Software Development :: Testing",
+]
+dependencies = [
+  "fastapi>=0.115,<1",
+  "jinja2>=3.1,<4",
+  "pydantic>=2.9,<3",
+  "pyyaml>=6,<7",
+  "rich>=13,<15",
+  "sqlalchemy>=2.0,<3",
+  "typer>=0.12,<1",
+  "uvicorn>=0.30,<1",
+]
+
+[project.optional-dependencies]
+dev = [
+  "build>=1,<2",
+  "httpx>=0.27,<1",
+  "pytest>=8,<9",
+  "pytest-asyncio>=0.24,<1",
+  "pytest-cov>=5,<7",
+  "ruff>=0.8,<1",
+]
+docs = [
+  "mkdocs-material>=9,<10",
+]
+
+[project.scripts]
+mini-runbot = "mini_runbot.cli.main:app"
+
+[project.urls]
+Documentation = "https://rafnixg.github.io/odoo-platform-ephemeral-environment/"
+Repository = "https://github.com/rafnixg/odoo-platform-ephemeral-environment"
+Issues = "https://github.com/rafnixg/odoo-platform-ephemeral-environment/issues"
+DeepWiki = "https://deepwiki.com/rafnixg/odoo-platform-ephemeral-environment"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+mini_runbot = [
+  "resources/*.yaml",
+  "templates/*.j2",
+  "web/*.html",
+  "web/*.css",
+  "web/*.js",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q"
+asyncio_default_fixture_loop_scope = "function"
+markers = ["docker: requires an available Docker daemon"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]
+
+[tool.ruff.lint.per-file-ignores]
+"**/__manifest__.py" = ["B018"]

mini_runbot-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mini_runbot-0.2.0/src/mini_runbot/__init__.py

@@ -0,0 +1,3 @@
+"""Mini-Runbot proof of concept."""
+
+__version__ = "0.2.0"

mini_runbot-0.2.0/src/mini_runbot/adapters/git/cli.py

@@ -0,0 +1,165 @@
+from __future__ import annotations
+
+import subprocess
+from dataclasses import replace
+from pathlib import Path
+from urllib.parse import urlsplit
+
+from mini_runbot.config import Settings
+from mini_runbot.domain.errors import GitOperationError, UnsafePathError
+from mini_runbot.domain.models import RepositoryRevision
+
+REMOTE_GIT_SCHEMES = {"https", "ssh"}
+
+
+def is_remote_git_url(value: str) -> bool:
+    """Return whether a configured source is an allowed remote Git URL."""
+    parsed = urlsplit(value)
+    if parsed.scheme.lower() in REMOTE_GIT_SCHEMES:
+        return True
+    return value.startswith("git@") and ":" in value.partition("@")[2]
+
+
+def validate_remote_git_url(value: str) -> None:
+    parsed = urlsplit(value)
+    if parsed.scheme:
+        if parsed.scheme.lower() not in REMOTE_GIT_SCHEMES:
+            raise GitOperationError(
+                "Remote repository URL must use HTTPS or SSH"
+            )
+        if not parsed.hostname:
+            raise GitOperationError("Remote repository URL must include a host")
+        if parsed.scheme.lower() == "https" and (parsed.username or parsed.password):
+            raise GitOperationError(
+                "HTTPS repository URLs must not contain embedded credentials"
+            )
+        if parsed.password:
+            raise GitOperationError(
+                "SSH repository URLs must not contain an embedded password"
+            )
+        return
+    if value.startswith("git@") and ":" in value.partition("@")[2]:
+        return
+    raise GitOperationError("Remote repository URL must use HTTPS or SSH")
+
+
+class GitCliService:
+    def __init__(self, settings: Settings) -> None:
+        self.settings = settings
+
+    def checkout(
+        self,
+        revision: RepositoryRevision,
+        workspace_path: Path,
+        log_path: Path,
+    ) -> RepositoryRevision:
+        config = self.settings.repository(revision.name, revision.requested_ref)
+        sources_root = (workspace_path / "sources").resolve()
+        target = (sources_root / config.target).resolve()
+        if target.parent != sources_root:
+            raise UnsafePathError(f"Checkout target escaped sources directory: {target}")
+        if target.exists():
+            raise GitOperationError(f"Checkout target already exists: {target}")
+        target.parent.mkdir(parents=True, exist_ok=True)
+
+        log_path.parent.mkdir(parents=True, exist_ok=True)
+        if is_remote_git_url(config.url) or "://" in config.url:
+            source = config.url
+            sha, output = self._checkout_remote(source, revision.requested_ref, target)
+        else:
+            source_path = Path(config.url).expanduser().resolve()
+            if not source_path.is_dir():
+                raise GitOperationError(
+                    f"Configured repository does not exist: {source_path}"
+                )
+            source_check = self._run(
+                ["git", "-C", str(source_path), "rev-parse", "--is-inside-work-tree"]
+            )
+            if source_check.strip() != "true":
+                raise GitOperationError(
+                    f"Configured source is not a Git repository: {source_path}"
+                )
+            sha = self._run(
+                [
+                    "git",
+                    "-C",
+                    str(source_path),
+                    "rev-parse",
+                    "--verify",
+                    f"{revision.requested_ref}^{{commit}}",
+                ]
+            ).strip()
+            output = self._run(
+                ["git", "clone", "--no-checkout", "--", str(source_path), str(target)]
+            )
+            output += self._run(
+                ["git", "-C", str(target), "checkout", "--detach", sha]
+            )
+            source = str(source_path)
+        with log_path.open("a", encoding="utf-8") as log:
+            log.write(f"== {revision.name} @ {revision.requested_ref} ==\n")
+            log.write(output)
+            if output and not output.endswith("\n"):
+                log.write("\n")
+        addons_path = (target / config.addons_subpath).resolve()
+        if target not in {addons_path, *addons_path.parents} or not addons_path.is_dir():
+            raise GitOperationError(
+                f"Configured addons_subpath does not exist inside checkout: {config.addons_subpath}"
+            )
+        return replace(
+            revision,
+            source=source,
+            commit_sha=sha,
+            checkout_path=str(addons_path),
+            addons_priority=config.addons_priority,
+        )
+
+    def _checkout_remote(
+        self, source: str, requested_ref: str, target: Path
+    ) -> tuple[str, str]:
+        validate_remote_git_url(source)
+        target.mkdir()
+        output = self._run(["git", "init", str(target)])
+        output += self._run(
+            ["git", "-C", str(target), "remote", "add", "origin", source]
+        )
+        output += self._run(
+            [
+                "git",
+                "-C",
+                str(target),
+                "fetch",
+                "--depth=1",
+                "--no-tags",
+                "origin",
+                requested_ref,
+            ]
+        )
+        sha = self._run(
+            [
+                "git",
+                "-C",
+                str(target),
+                "rev-parse",
+                "--verify",
+                "FETCH_HEAD^{commit}",
+            ]
+        ).strip()
+        output += self._run(
+            ["git", "-C", str(target), "checkout", "--detach", sha]
+        )
+        return sha, output
+
+    @staticmethod
+    def _run(arguments: list[str]) -> str:
+        try:
+            result = subprocess.run(
+                arguments, capture_output=True, text=True, timeout=120, check=False
+            )
+        except (OSError, subprocess.TimeoutExpired) as exc:
+            raise GitOperationError(f"Git command could not run: {exc}") from exc
+        output = f"{result.stdout}{result.stderr}"
+        if result.returncode != 0:
+            safe_command = " ".join(arguments[:3])
+            raise GitOperationError(f"Git command failed ({safe_command}): {output[-500:]}")
+        return output