dockerfile-analyzer 0.3.22__tar.gz → 0.3.23__tar.gz

{dockerfile_analyzer-0.3.22 → dockerfile_analyzer-0.3.23}/.github/workflows/CI.yml

@@ -19,7 +19,69 @@ permissions:
   contents: read
 
 jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          # Keep in sync with requires-python in pyproject.toml (PyO3 needs a
+          # matching libpython for clippy on --all-targets).
+          python-version: "3.14"
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt, clippy
+      - name: Check formatting
+        run: cargo fmt --all -- --check
+      - name: Clippy
+        run: cargo clippy --all-targets -- -D warnings
+
+  test:
+    name: cargo test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          # Keep in sync with requires-python in pyproject.toml (PyO3 needs a
+          # matching libpython for linking the test binary).
+          python-version: "3.14"
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+      - name: Run tests
+        run: cargo test
+
+  python-test:
+    name: python test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          # Keep in sync with requires-python in pyproject.toml.
+          python-version: "3.14"
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+      - name: Create virtual environment
+        # maturin develop requires an active virtualenv (not system/site-packages).
+        run: python -m venv .venv
+      - name: Install dev dependencies
+        run: |
+          source .venv/bin/activate
+          pip install -r requirements-dev.txt
+      - name: Build and install extension
+        run: |
+          source .venv/bin/activate
+          maturin develop
+      - name: Run Python tests
+        run: |
+          source .venv/bin/activate
+          pytest -v
+
   linux:
+    needs: [lint, test, python-test]
     runs-on: ${{ matrix.platform.runner }}
     strategy:
       matrix:
@@ -55,6 +117,7 @@ jobs:
           path: dist
 
   musllinux:
+    needs: [lint, test, python-test]
     runs-on: ${{ matrix.platform.runner }}
     strategy:
       matrix:
@@ -86,6 +149,7 @@ jobs:
           path: dist
 
   windows:
+    needs: [lint, test, python-test]
     runs-on: ${{ matrix.platform.runner }}
     strategy:
       matrix:
@@ -113,6 +177,7 @@ jobs:
           path: dist
 
   macos:
+    needs: [lint, test, python-test]
     runs-on: ${{ matrix.platform.runner }}
     strategy:
       matrix:
@@ -139,6 +204,7 @@ jobs:
           path: dist
 
   sdist:
+    needs: [lint, test, python-test]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -157,7 +223,7 @@ jobs:
     name: Release
     runs-on: ubuntu-latest
     if: ${{ startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch' }}
-    needs: [linux, musllinux, windows, macos, sdist]
+    needs: [lint, test, python-test, linux, musllinux, windows, macos, sdist]
     permissions:
       # Use to sign the release artifacts
       id-token: write

{dockerfile_analyzer-0.3.22 → dockerfile_analyzer-0.3.23}/Cargo.lock

@@ -14,7 +14,7 @@ dependencies = [
 
 [[package]]
 name = "dockerfile-analyzer"
-version = "0.3.22"
+version = "0.3.23"
 dependencies = [
  "docker-image",
  "parse-dockerfile",
@@ -73,9 +73,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3"
-version = "0.29.2"
+version = "0.29.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4688ddedf473e32662b9b067670129a8afb8c18e351482c70d62ba4a88171e8b"
+checksum = "700d18fa267b73b9b521fd7e13580e2f446916f176cacee1ab63fcc8191f1655"
 dependencies = [
  "libc",
  "once_cell",
@@ -87,18 +87,18 @@ dependencies = [
 
 [[package]]
 name = "pyo3-build-config"
-version = "0.29.2"
+version = "0.29.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f41027e41b4bd03f6e60f9f417fe24a6341a6bb744edd62b6f709f2a52ea30e9"
+checksum = "7b3fc0c4d08f6bb10e71fe39dfb9e2f59c6eb6854e22ec8092f50c69a4499adb"
 dependencies = [
  "target-lexicon",
 ]
 
 [[package]]
 name = "pyo3-ffi"
-version = "0.29.2"
+version = "0.29.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e591a95526fead067432c3b3a33fc74770b87b1e04e73671090d9c2055a2b327"
+checksum = "dfc0b8e19df29aad7086cf977bb0c2a2f143e30567eb113e9cf72b62ca698330"
 dependencies = [
  "libc",
  "pyo3-build-config",
@@ -106,9 +106,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-macros"
-version = "0.29.2"
+version = "0.29.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "73225868fc1cd84eef2c3c230ddb91273bf1de46aeb8a4248da76d32a0924a1c"
+checksum = "6100e8a4b5eba53afaa5ed078364851a0b2499c553a44c31026b929049b49dc6"
 dependencies = [
  "proc-macro2",
  "pyo3-macros-backend",
@@ -118,9 +118,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-macros-backend"
-version = "0.29.2"
+version = "0.29.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "571575aa3749fa6216757dd47d2a3e7ef360f329a40f0666a9fbd14889024952"
+checksum = "6143877a16e82b5a727b7127ff4cd86858a24a28d745d72f43e6f227c7b1bdb3"
 dependencies = [
  "heck",
  "proc-macro2",

{dockerfile_analyzer-0.3.22 → dockerfile_analyzer-0.3.23}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "dockerfile-analyzer"
-version = "0.3.22"
+version = "0.3.23"
 edition = "2024"
 readme = "README.md"
 

{dockerfile_analyzer-0.3.22 → dockerfile_analyzer-0.3.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dockerfile-analyzer
-Version: 0.3.22
+Version: 0.3.23
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy

{dockerfile_analyzer-0.3.22 → dockerfile_analyzer-0.3.23}/README.md

@@ -280,6 +280,9 @@ Analysis(num_stages=4, images=[Image(full="builder", components="ImageComponents
 python3 -m venv env
 source env/bin/activate
 pip install -r requirements-dev.txt
+cargo fmt --all -- --check
+cargo clippy --all-targets -- -D warnings
 cargo test
 maturin develop
+pytest
 ```

{dockerfile_analyzer-0.3.22 → dockerfile_analyzer-0.3.23}/requirements-dev.txt

@@ -1 +1,2 @@
 maturin>=1.14.0
+pytest>=8.0

dockerfile_analyzer-0.3.23/tests/fixtures/multistage.Dockerfile

@@ -0,0 +1,38 @@
+FROM docker.abc.com/base-images/python:3.13-debian@sha256:55f1d15ef4c37870e23c03e89ad238940b55c8ede9f13fac4b7d71c7955f1053 AS base
+
+LABEL org.opencontainers.image.title="My App" \
+      org.opencontainers.image.version="1.0" \
+      org.opencontainers.image.authors="john@example.com"
+
+ENV PYTHONPATH=/src \
+    PYTHONUNBUFFERED=1 \
+    REQUESTS_CA_BUNDLE=/etc/ssl/certs/ca-certificates.crt \
+    PATH="/home/appuser/.local/bin:$PATH"
+WORKDIR /src
+USER root:root
+
+RUN apt-get update && \
+    apt-get install --no-install-recommends -y postgresql-client curl git && \
+    apt-get autoremove -y && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
+
+RUN pip install --no-cache-dir --upgrade pip
+COPY --chown=1000:1000 requirements.txt ./
+RUN pip install --no-cache-dir -r requirements.txt
+
+FROM base AS test
+COPY --chown=1000:1000 test-requirements.txt ./
+USER 1000:1000
+RUN pip install --user --no-cache-dir -r test-requirements.txt
+COPY ./app ./app
+COPY ./test ./test
+
+FROM base
+COPY --chown=1000:1000 ./app ./app
+USER 1000:1000
+ARG GIT_COMMIT
+ENV GIT_COMMIT=$GIT_COMMIT
+EXPOSE 5000
+
+CMD ["uvicorn", "--host", "0.0.0.0", "--port", "5000", "app.main:app"]

dockerfile_analyzer-0.3.23/tests/test_analyze_dockerfile.py

@@ -0,0 +1,129 @@
+"""Python integration tests for the dockerfile_analyzer extension module."""
+
+from pathlib import Path
+
+import pytest
+
+import dockerfile_analyzer as da
+
+FIXTURES = Path(__file__).parent / "fixtures"
+
+
+def _read_fixture(name: str) -> str:
+    return (FIXTURES / name).read_text()
+
+
+def test_analyze_multistage_dockerfile():
+    analysis = da.analyze_dockerfile(_read_fixture("multistage.Dockerfile"))
+
+    assert analysis.num_stages == 3
+    assert analysis.stage_names == ["base", "test"]
+    assert analysis.copy_from_stages == []
+    assert analysis.add_from_stages == []
+    assert analysis.exposed_ports == ["5000"]
+
+    assert analysis.multistage_analysis.is_multistage is True
+    assert analysis.multistage_analysis.stages_used_as_base_images == ["base"]
+    assert analysis.multistage_analysis.stages_copied_from == []
+    assert analysis.multistage_analysis.stages_added_from == []
+    assert analysis.multistage_analysis.unused_stages == ["test"]
+
+    assert analysis.instructions.total_count == 22
+    assert analysis.instructions.by_type == {
+        "ARG": 1,
+        "CMD": 1,
+        "COPY": 5,
+        "ENV": 2,
+        "EXPOSE": 1,
+        "FROM": 3,
+        "LABEL": 1,
+        "RUN": 4,
+        "USER": 3,
+        "WORKDIR": 1,
+    }
+
+    assert analysis.args == {"GIT_COMMIT": None}
+    assert analysis.labels == {
+        "org.opencontainers.image.title": "My App",
+        "org.opencontainers.image.version": "1.0",
+        "org.opencontainers.image.authors": "john@example.com",
+    }
+    assert analysis.env_vars == {
+        "PYTHONPATH": "/src",
+        "PYTHONUNBUFFERED": "1",
+        "REQUESTS_CA_BUNDLE": "/etc/ssl/certs/ca-certificates.crt",
+        "PATH": "/home/appuser/.local/bin:$PATH",
+        "GIT_COMMIT": "$GIT_COMMIT",
+    }
+
+    assert len(analysis.images) == 2
+    base_stage_image, external_image = analysis.images
+
+    assert base_stage_image.full == "base"
+    assert base_stage_image.components is not None
+    assert base_stage_image.components.registry is None
+    assert base_stage_image.components.name == "base"
+    assert base_stage_image.components.tag is None
+    assert base_stage_image.components.digest is None
+
+    assert (
+        external_image.full
+        == "docker.abc.com/base-images/python:3.13-debian@sha256:55f1d15ef4c37870e23c03e89ad238940b55c8ede9f13fac4b7d71c7955f1053"
+    )
+    assert external_image.components is not None
+    assert external_image.components.registry == "docker.abc.com"
+    assert external_image.components.name == "base-images/python"
+    assert external_image.components.tag == "3.13-debian"
+    assert (
+        external_image.components.digest
+        == "sha256:55f1d15ef4c37870e23c03e89ad238940b55c8ede9f13fac4b7d71c7955f1053"
+    )
+
+
+def test_analyze_multistage_to_dict():
+    analysis = da.analyze_dockerfile(_read_fixture("multistage.Dockerfile"))
+    data = analysis.to_dict()
+
+    assert data["num_stages"] == 3
+    assert data["stage_names"] == ["base", "test"]
+    assert data["exposed_ports"] == ["5000"]
+    assert data["multistage_analysis"]["is_multistage"] is True
+    assert data["multistage_analysis"]["unused_stages"] == ["test"]
+    assert data["instructions"]["total_count"] == 22
+    assert data["args"]["GIT_COMMIT"] is None
+    assert data["env_vars"]["PYTHONPATH"] == "/src"
+    assert data["images"][1]["components"]["registry"] == "docker.abc.com"
+
+
+def test_analyze_single_stage_dockerfile():
+    dockerfile = """\
+FROM node:20-alpine
+WORKDIR /app
+COPY package*.json ./
+RUN npm install
+COPY . .
+EXPOSE 3000
+CMD ["npm", "start"]
+"""
+    analysis = da.analyze_dockerfile(dockerfile)
+
+    assert analysis.num_stages == 1
+    assert analysis.stage_names == []
+    assert analysis.multistage_analysis.is_multistage is False
+    assert analysis.exposed_ports == ["3000"]
+    assert analysis.instructions.by_type["FROM"] == 1
+    assert analysis.instructions.by_type["RUN"] == 1
+    assert analysis.images[0].full == "node:20-alpine"
+    assert analysis.images[0].components is not None
+    assert analysis.images[0].components.name == "node"
+    assert analysis.images[0].components.tag == "20-alpine"
+
+
+def test_analyze_invalid_dockerfile_raises():
+    with pytest.raises(ValueError, match="unknown instruction"):
+        da.analyze_dockerfile("invalid dockerfile content")
+
+
+def test_analyze_empty_dockerfile_raises():
+    with pytest.raises(ValueError):
+        da.analyze_dockerfile("")