posit-bakery 0.4.0__tar.gz

posit_bakery-0.4.0/.gitignore

@@ -0,0 +1,4 @@
+.coverage
+coverage.xml
+results.xml
+bake-plan.json

posit_bakery-0.4.0/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Posit Software, PBC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

posit_bakery-0.4.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: posit-bakery
+Version: 0.4.0
+Summary: CLI for building, testing, and managing multidimensional container images with variant, version, and OS support.
+Project-URL: Homepage, https://posit-dev.github.io/images-shared/
+Project-URL: Documentation, https://posit-dev.github.io/images-shared/
+Project-URL: Repository, https://github.com/posit-dev/images-shared
+Project-URL: Issues, https://github.com/posit-dev/images-shared/issues
+Project-URL: Changelog, https://github.com/posit-dev/images-shared/releases
+Author-email: "Ian H. Pittwood" <ian.pittwood@posit.co>, Ben Schwedler <ben@posit.co>
+Maintainer-email: Posit Container Team <docker@posit.co>
+License-Expression: MIT
+License-File: LICENSE.md
+Keywords: bake,build,buildx,cli,container,docker,image,posit
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: System :: Software Distribution
+Requires-Python: >=3.10
+Requires-Dist: gitpython~=3.1.50
+Requires-Dist: jinja2~=3.1.6
+Requires-Dist: packaging<26.0,>=25.0
+Requires-Dist: pydantic[email]<3.0,>=2.0
+Requires-Dist: pygithub<3.0.0,>=2.8.1
+Requires-Dist: python-on-whales<0.80.0,>=0.79.0
+Requires-Dist: requests-cache<2.0.0,>=1.2.1
+Requires-Dist: requests<3.0.0,>=2.32.5
+Requires-Dist: rich~=14.1.0
+Requires-Dist: ruamel-yaml<0.19.0,>=0.18.14
+Requires-Dist: typer~=0.21.1
+Description-Content-Type: text/markdown
+
+<p>
+<a href="https://posit.co/">
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://cdn.posit.co/platform/containers/logos/Posit-Logos-2024_horiz-reverse-quarto-web.svg">
+  <source media="(prefers-color-scheme: light)" srcset="https://cdn.posit.co/platform/containers/logos/Posit-Logos-2024_horiz-full-color-quarto-web.svg">
+  <img alt="Posit Logo" src="https://cdn.posit.co/platform/containers/logos/Posit-Logos-2024_horiz-full-color-quarto-web.svg" height="120">
+</picture>
+</a>
+&nbsp;&nbsp;&nbsp;&nbsp;
+<a href="https://posit-dev.github.io/images-shared/">
+<img alt="bakery" src="docs/images/bakery-logo.svg" height="180">
+</a>
+</p>
+
+# Bakery
+
+The [bakery](./posit_bakery/) command line interface (CLI) binds together various [tools](#3rd-party-tools) to manage a matrixed build of container images.
+
+## Documentation
+
+Full documentation is available at **[posit-dev.github.io/images-shared](https://posit-dev.github.io/images-shared/)**.
+
+## Prerequisites
+
+* [python](https://docs.astral.sh/uv/guides/install-python/)
+* [uv](https://docs.astral.sh/uv/getting-started/installation/)
+* [docker buildx bake](https://github.com/docker/buildx#installing)
+* [just](https://just.systems/man/en/prerequisites.html)
+
+### 3rd Party Tools
+
+| Tool                                                                                                                                                                      | Used By                         | Purpose                                                            |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------|:-------------------------------------------------------------------|
+| [docker buildx bake](https://github.com/docker/buildx#installing)                                                                                                         | `bakery build --strategy bake`  | Build containers in parallel                                       |
+| [docker](https://github.com/docker/buildx#installing), [podman](https://podman-desktop.io/docs/installation), or [nerdctl](https://github.com/containerd/nerdctl#install) | `bakery build --strategy build` | Build containers in series                                         |
+| [dgoss](https://github.com/goss-org/goss#installation)                                                                                                                    | `bakery run dgoss`              | Test container images for expected content & behavior              |
+| [hadolint](https://github.com/hadolint/hadolint#install)                                                                                                                  | to be implemented               | Lint Dockerfile/Containerfile                                      |
+| [openscap](https://static.open-scap.org/)                                                                                                                                 | to be implemented               | Scan container images for secure configuration and vulnerabilities |
+| trivy                                                                                                                                                                      | to be implemented               | Scan container images for vulnerabilities                          |
+| wizcli                                                                                                                                                                     | to be implemented               | Scan container images for vulnerabilities                          |
+
+## Installation
+
+Install `bakery` from [PyPI](https://pypi.org/project/posit-bakery/) using `uv tool`:
+
+```bash
+uv tool install posit-bakery
+```
+
+To install an unreleased development version directly from GitHub:
+
+```bash
+uv tool install 'git+https://github.com/posit-dev/images-shared.git@main#subdirectory=posit-bakery&egg=posit-bakery'
+```
+
+## Examples
+
+See the [Bakery Examples](https://github.com/posit-dev/images-examples/tree/main/bakery) repository for step-by-step tutorials on creating and managing container image projects with Bakery.
+
+## Development
+
+### Development Prerequisites
+
+- [just](https://just.systems/man/en/)
+
+    ```bash
+    # Show all the just recipes
+    just
+    ```
+
+- [uv](https://docs.astral.sh/uv/getting-started/installation/)

posit_bakery-0.4.0/README.md

@@ -0,0 +1,71 @@
+<p>
+<a href="https://posit.co/">
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://cdn.posit.co/platform/containers/logos/Posit-Logos-2024_horiz-reverse-quarto-web.svg">
+  <source media="(prefers-color-scheme: light)" srcset="https://cdn.posit.co/platform/containers/logos/Posit-Logos-2024_horiz-full-color-quarto-web.svg">
+  <img alt="Posit Logo" src="https://cdn.posit.co/platform/containers/logos/Posit-Logos-2024_horiz-full-color-quarto-web.svg" height="120">
+</picture>
+</a>
+&nbsp;&nbsp;&nbsp;&nbsp;
+<a href="https://posit-dev.github.io/images-shared/">
+<img alt="bakery" src="docs/images/bakery-logo.svg" height="180">
+</a>
+</p>
+
+# Bakery
+
+The [bakery](./posit_bakery/) command line interface (CLI) binds together various [tools](#3rd-party-tools) to manage a matrixed build of container images.
+
+## Documentation
+
+Full documentation is available at **[posit-dev.github.io/images-shared](https://posit-dev.github.io/images-shared/)**.
+
+## Prerequisites
+
+* [python](https://docs.astral.sh/uv/guides/install-python/)
+* [uv](https://docs.astral.sh/uv/getting-started/installation/)
+* [docker buildx bake](https://github.com/docker/buildx#installing)
+* [just](https://just.systems/man/en/prerequisites.html)
+
+### 3rd Party Tools
+
+| Tool                                                                                                                                                                      | Used By                         | Purpose                                                            |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------|:-------------------------------------------------------------------|
+| [docker buildx bake](https://github.com/docker/buildx#installing)                                                                                                         | `bakery build --strategy bake`  | Build containers in parallel                                       |
+| [docker](https://github.com/docker/buildx#installing), [podman](https://podman-desktop.io/docs/installation), or [nerdctl](https://github.com/containerd/nerdctl#install) | `bakery build --strategy build` | Build containers in series                                         |
+| [dgoss](https://github.com/goss-org/goss#installation)                                                                                                                    | `bakery run dgoss`              | Test container images for expected content & behavior              |
+| [hadolint](https://github.com/hadolint/hadolint#install)                                                                                                                  | to be implemented               | Lint Dockerfile/Containerfile                                      |
+| [openscap](https://static.open-scap.org/)                                                                                                                                 | to be implemented               | Scan container images for secure configuration and vulnerabilities |
+| trivy                                                                                                                                                                      | to be implemented               | Scan container images for vulnerabilities                          |
+| wizcli                                                                                                                                                                     | to be implemented               | Scan container images for vulnerabilities                          |
+
+## Installation
+
+Install `bakery` from [PyPI](https://pypi.org/project/posit-bakery/) using `uv tool`:
+
+```bash
+uv tool install posit-bakery
+```
+
+To install an unreleased development version directly from GitHub:
+
+```bash
+uv tool install 'git+https://github.com/posit-dev/images-shared.git@main#subdirectory=posit-bakery&egg=posit-bakery'
+```
+
+## Examples
+
+See the [Bakery Examples](https://github.com/posit-dev/images-examples/tree/main/bakery) repository for step-by-step tutorials on creating and managing container image projects with Bakery.
+
+## Development
+
+### Development Prerequisites
+
+- [just](https://just.systems/man/en/)
+
+    ```bash
+    # Show all the just recipes
+    just
+    ```
+
+- [uv](https://docs.astral.sh/uv/getting-started/installation/)

posit_bakery-0.4.0/posit_bakery/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.0"

posit_bakery-0.4.0/posit_bakery/__main__.py

@@ -0,0 +1,4 @@
+if __name__ == "__main__":
+    from .cli.main import app
+
+    app(prog_name="bakery")

posit_bakery-0.4.0/posit_bakery/cli/build.py

@@ -0,0 +1,255 @@
+import logging
+from enum import Enum
+from pathlib import Path
+from typing import Annotated, Optional
+
+import python_on_whales
+import typer
+
+from posit_bakery.cli.common import with_verbosity_flags, with_temporary_storage
+from posit_bakery.config import BakeryConfig
+from posit_bakery.config.config import BakeryConfigFilter, BakerySettings
+from posit_bakery.config.image.posit_product.const import ReleaseStreamEnum
+from posit_bakery.const import DevVersionInclusionEnum, MatrixVersionInclusionEnum
+from posit_bakery.error import BakeryBuildErrorGroup, BakeryToolRuntimeError
+from posit_bakery.image import ImageBuildStrategy
+from posit_bakery.log import stderr_console, stdout_console
+from posit_bakery.util import auto_path
+
+log = logging.getLogger(__name__)
+
+
+class RichHelpPanelEnum(str, Enum):
+    """Enum for categorizing options into rich help panels."""
+
+    BUILD_CONFIGURATION_AND_OUTPUTS = "Build Configuration & Outputs"
+    FILTERS = "Filters"
+
+
+@with_verbosity_flags
+@with_temporary_storage
+def build(
+    context: Annotated[
+        Path,
+        typer.Option(
+            exists=True,
+            file_okay=False,
+            dir_okay=True,
+            readable=True,
+            resolve_path=True,
+            help="The root path to use. Defaults to the current working directory where invoked.",
+        ),
+    ] = auto_path(),
+    strategy: Annotated[
+        Optional[ImageBuildStrategy],
+        typer.Option(
+            case_sensitive=False,
+            help="The strategy to use when building the image. 'bake' requires Docker Buildkit and builds "
+            "images in parallel. 'build' can use generic container builders, such as Podman, and builds "
+            "images sequentially.",
+            rich_help_panel=RichHelpPanelEnum.BUILD_CONFIGURATION_AND_OUTPUTS,
+        ),
+    ] = ImageBuildStrategy.BAKE,
+    fail_fast: Annotated[
+        Optional[bool],
+        typer.Option(
+            "--fail-fast",
+            help="Terminate builds on the first failure.",
+            rich_help_panel=RichHelpPanelEnum.BUILD_CONFIGURATION_AND_OUTPUTS,
+        ),
+    ] = False,
+    retry: Annotated[
+        int,
+        typer.Option(
+            min=0,
+            help="Number of times to retry a failed build.",
+            rich_help_panel=RichHelpPanelEnum.BUILD_CONFIGURATION_AND_OUTPUTS,
+        ),
+    ] = 0,
+    plan: Annotated[
+        Optional[bool],
+        typer.Option(
+            "--plan",
+            help="Print the bake plan and exit.",
+            rich_help_panel=RichHelpPanelEnum.BUILD_CONFIGURATION_AND_OUTPUTS,
+        ),
+    ] = False,
+    load: Annotated[
+        Optional[bool],
+        typer.Option(
+            help="Load the image to Docker after building.",
+            rich_help_panel=RichHelpPanelEnum.BUILD_CONFIGURATION_AND_OUTPUTS,
+        ),
+    ] = True,
+    push: Annotated[
+        Optional[bool],
+        typer.Option(
+            help="Push the image to its registry tags after building.",
+            rich_help_panel=RichHelpPanelEnum.BUILD_CONFIGURATION_AND_OUTPUTS,
+        ),
+    ] = False,
+    clean: Annotated[
+        Optional[bool],
+        typer.Option(
+            help="Clean up intermediary and temporary files after building. Disable for debugging.",
+            rich_help_panel=RichHelpPanelEnum.BUILD_CONFIGURATION_AND_OUTPUTS,
+        ),
+    ] = True,
+    metadata_file: Annotated[
+        Optional[Path],
+        typer.Option(
+            writable=True,
+            resolve_path=True,
+            help="The path to write JSON build metadata to once builds are finished.",
+            rich_help_panel="Build Configuration & Outputs",
+        ),
+    ] = None,
+    pull: Annotated[
+        Optional[bool],
+        typer.Option(
+            help="Always pull the latest version of base images.",
+            rich_help_panel=RichHelpPanelEnum.BUILD_CONFIGURATION_AND_OUTPUTS,
+        ),
+    ] = False,
+    cache: Annotated[
+        Optional[bool],
+        typer.Option(
+            help="Enable layer caching for image builds.",
+            rich_help_panel=RichHelpPanelEnum.BUILD_CONFIGURATION_AND_OUTPUTS,
+        ),
+    ] = True,
+    cache_registry: Annotated[
+        Optional[str],
+        typer.Option(
+            show_default=False,
+            help="External registry to use for layer caching.",
+            rich_help_panel=RichHelpPanelEnum.BUILD_CONFIGURATION_AND_OUTPUTS,
+        ),
+    ] = None,
+    temp_registry: Annotated[
+        Optional[str],
+        typer.Option(
+            help="Temporary registry to use for multiplatform split/merge builds.",
+            rich_help_panel="Build Configuration & Outputs",
+        ),
+    ] = None,
+    image_name: Annotated[
+        Optional[str],
+        typer.Option(
+            show_default=False,
+            help="The image name or a regex pattern to isolate builds to.",
+            rich_help_panel=RichHelpPanelEnum.FILTERS,
+        ),
+    ] = None,
+    image_version: Annotated[
+        Optional[str],
+        typer.Option(
+            show_default=False,
+            help="The image version or version prefix to isolate builds to.",
+            rich_help_panel=RichHelpPanelEnum.FILTERS,
+        ),
+    ] = None,
+    image_variant: Annotated[
+        Optional[str],
+        typer.Option(
+            show_default=False, help="The image type to isolate builds to.", rich_help_panel=RichHelpPanelEnum.FILTERS
+        ),
+    ] = None,
+    image_os: Annotated[
+        Optional[str],
+        typer.Option(
+            show_default=False,
+            help="The image OS name or a regex pattern to isolate builds to.",
+            rich_help_panel=RichHelpPanelEnum.FILTERS,
+        ),
+    ] = None,
+    image_platform: Annotated[
+        Optional[list[str]],
+        typer.Option(
+            show_default=False,
+            help="The image platform(s) to isolate builds to, e.g. 'linux/amd64'. "
+            "Image build targets incompatible with the given platform(s) will be skipped.",
+            rich_help_panel=RichHelpPanelEnum.FILTERS,
+        ),
+    ] = None,
+    dev_versions: Annotated[
+        Optional[DevVersionInclusionEnum],
+        typer.Option(
+            help="Include or exclude development version builds defined in config.",
+            rich_help_panel=RichHelpPanelEnum.FILTERS,
+        ),
+    ] = DevVersionInclusionEnum.EXCLUDE,
+    dev_stream: Annotated[
+        Optional[ReleaseStreamEnum],
+        typer.Option(
+            help="Filter development versions to a specific release stream.",
+            rich_help_panel=RichHelpPanelEnum.FILTERS,
+        ),
+    ] = None,
+    matrix_versions: Annotated[
+        Optional[MatrixVersionInclusionEnum],
+        typer.Option(
+            help="Include or exclude versions defined in image matrix.",
+            rich_help_panel=RichHelpPanelEnum.FILTERS,
+        ),
+    ] = MatrixVersionInclusionEnum.EXCLUDE,
+) -> None:
+    """Builds images in the context path
+
+    If no options are provided, the command will auto-discover all images in the current
+    directory and generate a temporary bake plan to execute for all targets.
+
+    Requires the Docker Engine and CLI to be installed and running for `--strategy bake`.
+
+    Requires Docker, Podman, or nerdctl to be installed and running for `--strategy build`.
+    """
+    settings = BakerySettings(
+        filter=BakeryConfigFilter(
+            image_name=image_name,
+            image_version=image_version,
+            image_variant=image_variant,
+            image_os=image_os,
+            image_platform=image_platform or [],
+        ),
+        dev_versions=dev_versions,
+        dev_stream=dev_stream,
+        matrix_versions=matrix_versions,
+        clean_temporary=clean,
+        cache_registry=cache_registry,
+        temp_registry=temp_registry,
+    )
+    config: BakeryConfig = BakeryConfig.from_context(context, settings)
+
+    if plan:
+        if strategy == ImageBuildStrategy.BUILD:
+            # TODO: This should turn into dry-run behavior eventually.
+            stderr_console.print(
+                "❌ The --plan option is not supported with the 'build' strategy. "
+                "Please use the 'bake' strategy to print the bake plan.",
+                style="error",
+            )
+            raise typer.Exit(code=1)
+        stdout_console.print_json(config.bake_plan_targets(push=push))
+        raise typer.Exit(code=0)
+
+    try:
+        config.build_targets(
+            load=load,
+            push=push,
+            pull=pull,
+            cache=cache,
+            platforms=image_platform,
+            strategy=strategy,
+            fail_fast=fail_fast,
+            retry=retry,
+            metadata_file=metadata_file,
+        )
+    except BakeryBuildErrorGroup as e:
+        stderr_console.print(str(e))
+        stderr_console.print("❌ Build failed", style="error")
+        raise typer.Exit(code=1)
+    except (python_on_whales.DockerException, BakeryToolRuntimeError):
+        stderr_console.print("❌ Build failed", style="error")
+        raise typer.Exit(code=1)
+
+    stderr_console.print("✅ Build completed", style="success")