Implement //example:docker (#3)

.bazelrc

@@ -0,0 +1 @@
+build --noexperimental_convenience_symlinks

.gitignore

@@ -1 +1,3 @@
-/bazel-*
+/bazel-*
+/.vscode/
+.pdm-python

BUILD.bazel

@@ -3,16 +3,16 @@
 # ----------------------------------------------------
 # gazelle:prefix github.com/stackb/pycross_image
 
-load("//tools/example_test:defs.bzl", "example_test_filegroup")
+load("//bazel/tools/example_test:defs.bzl", "example_test_filegroup")
 
 example_test_filegroup(
     name = "example_test_files",
     srcs = [
         "BUILD.bazel",
         "WORKSPACE",
-        "//bazel:example_test_files",
-        "//platform:example_test_files",
-        "//rules:example_test_files",
-        "//tools/example_test:example_test_files",
+        "//bazel/platforms:example_test_files",
+        "//bazel/rules:example_test_files",
+        "//bazel/tools/example_test:example_test_files",
+        "//bazel/workspace:example_test_files",
     ],
 )

Makefile

@@ -0,0 +1,14 @@
+.PHONY: pdm_sync
+pdm_sync:
+	bazel run //bazel/tools/pdm -- sync
+	rm -rf .venv
+
+.PHONY: pdm_lock
+pdm_lock:
+	bazel run //bazel/tools/pdm -- lock --static-urls
+	rm -rf .venv
+
+.PHONY: example_oci_pdm_add
+example_oci_pdm_add:
+	PDM_PROJECT=$(PWD)/example/oci bazel run //bazel/tools/pdm -- add grpclib
+	rm -rf example/oci/.venv

README.md

@@ -1,9 +1,95 @@
-# pycross_image
+# @pycross_image
 
-`pycross_image` provides starlark rules for building container images for python
-applications with bazel.
+![build-status](https://github.com/stackb/pycross_image/actions/workflows/ci.yaml/badge.svg)
 
-You can use the rules directly from this repo, or simply as examples and
-copy/paste them into your own project.
+Bazel starlark rules for building container images from `py_binary` :sparkles:
+using [@rules_pycross](https://github.com/jvolkman/rules_pycross) :magic:.
 
+`@pycross_image` provides:
 
+- `load("@pycross_image//bazel/rules:oci.bzl", "py_image")`: image rule
+  compatible with [@rules_oci](https://github.com/bazel-contrib/rules_oci)
+- `load("@pycross_image//bazel/rules:docker.bzl", "py_image")`: image rule
+  compatible with [@rules_docker](https://github.com/bazelbuild/rules_docker)
+
+## Installation & Usage
+
+See [releases] page for an `http_archive` of the latest `@pycross_image`.
+
+Examples:
+- [@rules_oci example](example/oci/WORKSPACE.in).
+- [@rules_docker example](example/docker/WORKSPACE.in).
+
+A few notes about the workspace setup:
+
+- It's divided into "steps" based on load statement dependencies.  `step1.bzl`
+  only depends on things declared in `repositories.bzl`, `step2.bzl` depends on
+  things declared in `step3.bzl`, etc (this pattern is from
+  [tensorflow](https://github.com/tensorflow/tensorflow/tree/master/tensorflow)).
+- Your workspace may already have many of the dependencies.  Some of the
+  external workspace names may be differ from yours. Use the example as a study
+  guide rather than canonical reference.
+- The examples are only tested with the older `WORKSPACE`.  The rules may not be
+  compatible with bzlmod yet.
+
+## How it Works
+
+```mermaid
+graph TD;
+    pypi[(pypi)]
+    DefaultInfo[[DefaultInfo]]
+    numpy{{numpy}}
+    grpclib{{grpclib}}
+
+    subgraph linux_x86_64["linuxx86_64\n"]
+        image.tar-->image;
+        image-->app_layer;
+        image-->site_packages_layer;
+        image-->interpreter_layer;
+        app_layer-->DefaultInfo;
+        site_packages_layer-->DefaultInfo;
+        interpreter_layer-->DefaultInfo;
+    end
+
+    DefaultInfo--transition :linux_x86_64-->pycross_binary;
+    pycross_binary-->py_binary;
+    py_binary-->numpy;
+    py_binary-->grpclib;
+
+    numpy-.->numpy-cp310-macosx_arm64.whl
+    numpy-.->numpy-cp310-manylinux_x86_64.whl
+    grpclib-.->grpclib.whl
+    numpy-cp310-macosx_arm64.whl-->pypi
+    numpy-cp310-manylinux_x86_64.whl-->pypi
+
+    subgraph zig_toolchain
+        grpclib.whl-->grpclib-tar.gz
+    end
+
+    grpclib-tar.gz-->pypi
+
+    style pypi fill:#3171b2,stroke:#333
+    style numpy fill:#5d97d2,stroke:#3171b2,color:black
+    style grpclib fill:#5d97d2,stroke:#3171b2,color:black
+    style grpclib.whl stroke:#bc082b
+
+    style numpy-cp310-manylinux_x86_64.whl stroke:#bc082b
+    style numpy-cp310-macosx_arm64.whl stroke:#bb22d8
+    style linux_x86_64 stroke:#bc082b,fill:none
+```
+
+In this example the `py_binary` rule has `deps` on two python wheels:
+  - `numpy` has a binary wheel available from pypi for both the darwin and linux
+    platforms.
+  - `grpclib` only has a source distribution available.
+
+The `pycross_binary` rule transitions from the host platform to `:linux_x86_64`.
+  - the transition affects how `@rules_pycross` fetches wheels.  If the binary
+    distribution is available, take it.
+  - if the binary distribution is not available, compile from source using (in
+    this case, with `zig` and `@hermetic_cc_toolchains`).
+
+The image is partitioned into three tar layers by matching against filename
+patterns (see rule implementation for details).
+
+> `@rules_pycross` supports dependency fetching using PDM or poetry.

WORKSPACE

@@ -1,68 +1,51 @@
 workspace(name = "pycross_image")
 
-load("@pycross_image//bazel:repositories.bzl", "repositories")
+# -----------------------------------------
+
+load("@pycross_image//bazel/workspace:repositories.bzl", "repositories")
 
 repositories()
 
 # -----------------------------------------
 
-load(
-    "@pycross_image//bazel:workspace0.bzl",
-    "setup_aspect_bazel_lib",
-    "setup_bazel_gazelle",
-    "setup_bazel_skylib",
-    "setup_rules_docker",
-    "setup_rules_go",
-    "setup_rules_oci",
-    "setup_rules_python",
-    "setup_zig_toolchains",
-)
+load("@pycross_image//bazel/workspace:step1.bzl", "step1")
+
+step1.setup_zig_toolchains()
 
-setup_zig_toolchains()
+step1.setup_rules_go()
 
-setup_rules_go()
+step1.setup_bazel_gazelle()
 
-setup_bazel_gazelle()
+step1.setup_bazel_skylib()
 
-setup_bazel_skylib()
+step1.setup_rules_python()
 
-setup_rules_python()
+step1.setup_aspect_bazel_lib()
 
-setup_aspect_bazel_lib()
+step1.setup_rules_oci()
 
-setup_rules_oci()
+step1.setup_rules_docker()
 
-setup_rules_docker()
+step1.setup_container_structure_test()
 
 # -----------------------------------------
 
-load(
-    "@pycross_image//bazel:workspace1.bzl",
-    "setup_docker_containers",
-    "setup_oci_containers",
-    "setup_rules_pycross",
-)
+load("@pycross_image//bazel/workspace:step2.bzl", "step2")
 
-setup_oci_containers()
+step2.setup_pycross_image_base_oci()
 
-setup_docker_containers()
+step2.setup_pycross_image_base_container()
 
-setup_rules_pycross()
+step2.setup_rules_pycross()
 
 # -----------------------------------------
 
-load(
-    "@pycross_image//bazel:workspace2.bzl",
-    "setup_pdm_deps",
-)
+load("@pycross_image//bazel/workspace:step3.bzl", "step3")
 
-setup_pdm_deps()
+step3.setup_pypi_deps_for_pdm()
 
 # -----------------------------------------
 
-load(
-    "@pycross_image//bazel:workspace3.bzl",
-    "install_pdm_deps",
-)
+load("@pycross_image//bazel/workspace:step4.bzl", "step4")
 
-install_pdm_deps()
+step4.install_pypi_deps_for_pdm()

bazel/platforms/BUILD.bazel

@@ -0,0 +1,33 @@
+load("//bazel/tools/example_test:defs.bzl", "example_test_filegroup")
+
+platform(
+    name = "linux_x86_64",
+    constraint_values = [
+        "@platforms//os:linux",
+        "@platforms//cpu:x86_64",
+    ],
+    visibility = ["//visibility:public"],
+)
+
+platform(
+    name = "darwin_x86_64",
+    constraint_values = [
+        "@platforms//os:macos",
+        "@platforms//cpu:x86_64",
+    ],
+    visibility = ["//visibility:public"],
+)
+
+platform(
+    name = "darwin_arm64",
+    constraint_values = [
+        "@platforms//os:macos",
+        "@platforms//cpu:arm64",
+    ],
+    visibility = ["//visibility:public"],
+)
+
+example_test_filegroup(
+    name = "example_test_files",
+    srcs = ["BUILD.bazel"],
+)

rules/BUILD.bazel → bazel/rules/BUILD.bazel

@@ -1,11 +1,11 @@
-load("//tools/example_test:defs.bzl", "example_test_filegroup")
+load("//bazel/tools/example_test:defs.bzl", "example_test_filegroup")
 
 example_test_filegroup(
     name = "example_test_files",
     srcs = [
         "BUILD.bazel",
         "docker.bzl",
         "oci.bzl",
-        "py_layers.bzl",
+        "support.bzl",
     ],
 )