release: ipmininet v1.3.1 — revive upstream

.dockerignore

@@ -0,0 +1,9 @@
+.git
+.venv
+.tmp
+.pytest_cache
+.ruff_cache
+.mypy_cache
+**/__pycache__
+*.pyc
+*.log

.git-blame-ignore-revs

@@ -0,0 +1,6 @@
+# Revisions to skip in `git blame` — purely mechanical reformatting with no
+# semantic change, so blame should attribute the code to its real author.
+#
+# style: apply ruff and mdformat auto-fixes (ruff lint autofix + ruff
+# formatter + mdformat on the markdown files).
+46083b313a0aca6d9f1f8ad9e4805044d52c1fef

.github/dependabot.yml

@@ -0,0 +1,31 @@
+version: 2
+updates:
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 5
+    groups:
+      python-dependencies:
+        patterns:
+          - "*"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 5
+    groups:
+      actions-dependencies:
+        patterns:
+          - "*"
+
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 3
+    groups:
+      docker-dependencies:
+        patterns:
+          - "*"

.github/workflows/container-test.yaml

@@ -0,0 +1,45 @@
+# Containerized CI.
+#
+# Builds a two-stage image: the builder runs the full install (-a: FRRouting,
+# libyang, mininet, radvd, sshd, named) plus the uv venv and mimidump, and the
+# slim runtime stage keeps only the test-facing packages and the compiled
+# artifacts. Runs the full test suite inside it with root privileges. Every
+# worker runs in its own isolated namespace (scripts/run-tests-parallel.sh),
+# mirroring the bare-metal job but in a reproducible environment.
+#
+# Runs on pull requests and on demand; master pushes keep this job too.
+name: Container test
+on:
+  pull_request:
+  push:
+    branches: [master]
+  workflow_dispatch:
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  container-test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 90
+    steps:
+      - uses: actions/checkout@v7
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v4
+      - name: Build and cache test container
+        uses: docker/build-push-action@v7
+        with:
+          file: Containerfile
+          target: final
+          push: false
+          load: true
+          tags: ipmininet-dev
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+      - name: Run full test suite
+        run: |
+          docker run --rm --privileged \
+            -v $PWD:/workspace:Z \
+            -e UV_PROJECT_ENVIRONMENT=/opt/venv \
+            -e DEBIAN_FRONTEND=noninteractive \
+            ipmininet-dev \
+            scripts/ci-test.sh

.github/workflows/docs.yaml

@@ -0,0 +1,34 @@
+# Documentation build.
+#
+# Builds the Sphinx documentation with the `docs` uv dependency group and
+# uploads the resulting HTML as an artifact. The build runs with -W so Sphinx
+# warnings fail the job. Runs on every PR and on master; the artifact is
+# available from the workflow run page.
+name: Build documentation
+on:
+  pull_request:
+  push:
+    branches: [master]
+  workflow_dispatch:
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - name: Install docs dependencies
+        run: uv sync --group docs
+      - name: Build documentation
+        run: uv run --group docs sphinx-build -b html -W docs docs/_build/html
+      - name: Upload documentation
+        uses: actions/upload-artifact@v7
+        with:
+          name: ipmininet-docs
+          path: docs/_build/html

.github/workflows/heavy-test.yaml

@@ -0,0 +1,79 @@
+# Full test suite with coverage, run on master and on demand.
+#
+# Performs the full `ipmininet.install -a` and runs every test with the
+# coverage gate. It complements `test.yaml`, which runs the same suite on pull
+# requests: master only changes through merged PRs, so this job is the single
+# bare-metal full-suite run per master push and enforces the coverage floor.
+# Lint/format checks are run in the `rootless` job of test.yaml.
+name: Heavy test
+on:
+  workflow_dispatch:
+  push:
+    branches: [master]
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  heavy-test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 200
+    steps:
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - name: Cache venv
+        uses: actions/cache@v6
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+      - run: uv sync --all-extras
+      - name: Record OS version for the deps cache key
+        run: echo "OS=$(. /etc/os-release && echo $VERSION_ID)" >> "$GITHUB_ENV"
+      - name: Cache compiled deps
+        id: cache-deps
+        uses: actions/cache@v6
+        with:
+          path: /home/runner/ci-deps
+          key: ci-deps-${{ runner.os }}-${{ env.OS }}-${{ hashFiles('uv.lock', 'pyproject.toml', 'ipmininet/install/install.py', 'ipmininet/install/utils.py', 'ipmininet/install/__main__.py') }}
+      - name: Restore compiled deps
+        if: steps.cache-deps.outputs.cache-hit == 'true'
+        run: scripts/ci-restore-deps.sh
+      - name: Install dependencies (FRRouting, libyang, mininet)
+        timeout-minutes: 10
+        run: |
+          sudo env "PATH=$PATH" uv run python -m ipmininet.install -a
+      - name: Save compiled deps
+        if: steps.cache-deps.outputs.cache-hit != 'true'
+        run: scripts/ci-save-deps.sh
+      - name: Install mimidump
+        run: scripts/ci-install-mimidump.sh
+      - name: Run full test suite (coverage)
+        timeout-minutes: 170
+        run: |
+          sudo env "PATH=$PATH" COVERAGE=1 scripts/run-tests-parallel.sh
+      - name: Combine and enforce the coverage gate
+        run: |
+          sudo env "PATH=$PATH" bash -c '
+            uv run coverage combine || true
+            uv run coverage xml -o coverage.xml
+            uv run coverage html -d htmlcov
+            uv run coverage report -m
+          '
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v7
+        with:
+          name: coverage-full
+          path: |
+            coverage.xml
+            htmlcov/
+      - name: Upload coverage to Codecov
+        if: env.CODECOV_TOKEN != ''
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        uses: codecov/codecov-action@v7
+        with:
+          files: coverage.xml
+          flags: full
+          slug: ${{ github.repository }}

.github/workflows/test.yaml

@@ -0,0 +1,114 @@
+# Bare-metal CI, run on pull requests and on demand.
+#
+# Two jobs:
+#  - rootless: installs the venv with uv and runs the test suite as the
+#    default (non-root) runner user. Tests that require root are skipped via
+#    the `require_root` marker, so this job validates the rootless tests.
+#  - test: performs the full `ipmininet.install -a` (FRRouting, libyang,
+#    mininet, ...) and runs the complete test suite with root privileges.
+#
+# Lint/format checks run in the `rootless` job below, before the light tests.
+#
+# Runs on pull requests and via manual dispatch (so the full suite can be
+# exercised on any branch before merge): master changes arrive through merged
+# PRs whose checks already ran here, so re-running this suite on every master
+# push would duplicate the coverage-gated `heavy-test.yaml` job. Master pushes
+# keep that job plus `container-test.yaml` and `docs.yaml`.
+name: Test IPMininet
+on:
+  pull_request:
+  workflow_dispatch:
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  rootless:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - name: Mininet dependency must be mimi-net fork
+        run: grep -q 'mimi-net/mininet' pyproject.toml || (echo "mininet dependency must point to mimi-net/mininet.git fork" && exit 1)
+      - run: uv sync --all-extras
+      - name: Lint and format checks
+        run: |
+          uv run ruff check .
+          uv run ruff format --check .
+          uv run mdformat --check README.md LICENSE.md ipmininet/examples/README.md
+      - name: Check for duplicated code
+        run: scripts/check-duplicates.sh
+      - name: Run rootless tests (coverage)
+        run: |
+          uv run python -m pytest \
+            -v \
+            --cov=ipmininet \
+            --cov-fail-under=0 \
+            --cov-report=html:htmlcov \
+            --cov-report=xml:coverage.xml \
+            ipmininet/tests/test_pure.py \
+            ipmininet/tests/test_misc.py \
+            ipmininet/tests/test_link.py \
+            ipmininet/tests/test_network_capture.py \
+            ipmininet/tests/test_bgp_model.py \
+            ipmininet/tests/test_dhcp.py
+      - name: Upload coverage report (rootless)
+        uses: actions/upload-artifact@v7
+        with:
+          name: coverage-rootless
+          path: |
+            coverage.xml
+            htmlcov/
+      - name: Upload coverage to Codecov
+        if: env.CODECOV_TOKEN != ''
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        uses: codecov/codecov-action@v7
+        with:
+          files: coverage.xml
+          flags: rootless
+          slug: ${{ github.repository }}
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 200
+    steps:
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - name: Cache venv
+        uses: actions/cache@v6
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+      - name: Mininet dependency must be mimi-net fork
+        run: grep -q 'mimi-net/mininet' pyproject.toml || (echo "mininet dependency must point to mimi-net/mininet.git fork" && exit 1)
+      - run: uv sync --all-extras
+      - name: Record OS version for the deps cache key
+        run: echo "OS=$(. /etc/os-release && echo $VERSION_ID)" >> "$GITHUB_ENV"
+      - name: Cache compiled deps
+        id: cache-deps
+        uses: actions/cache@v6
+        with:
+          path: /home/runner/ci-deps
+          key: ci-deps-${{ runner.os }}-${{ env.OS }}-${{ hashFiles('uv.lock', 'pyproject.toml', 'ipmininet/install/install.py', 'ipmininet/install/utils.py', 'ipmininet/install/__main__.py') }}
+      - name: Restore compiled deps
+        if: steps.cache-deps.outputs.cache-hit == 'true'
+        run: scripts/ci-restore-deps.sh
+      - name: Install dependencies (FRRouting, libyang, mininet)
+        timeout-minutes: 10
+        run: |
+          sudo env "PATH=$PATH" uv run python -m ipmininet.install -a
+      - name: Save compiled deps
+        if: steps.cache-deps.outputs.cache-hit != 'true'
+        run: scripts/ci-save-deps.sh
+      - name: Install mimidump
+        run: scripts/ci-install-mimidump.sh
+      - name: Run test suite
+        timeout-minutes: 170
+        run: |
+          sudo env "PATH=$PATH" scripts/run-tests-parallel.sh

.gitignore

@@ -13,3 +13,10 @@ tags
 *.ropeproject
 _build/
 docs/api/*.rst
+.idea/
+.venv/
+/.tmp/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/

.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+default_install_hook_types: [pre-commit, pre-push]
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.5
+    hooks:
+      - id: ruff
+        name: ruff (auto-fix)
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+        name: ruff format (auto-format)
+      - id: ruff
+        name: ruff (strict check)
+        stages: [pre-push]
+      - id: ruff-format
+        name: ruff format (strict check)
+        args: [--check]
+        stages: [pre-push]
+  - repo: https://github.com/hukkin/mdformat
+    rev: 1.0.0
+    hooks:
+      - id: mdformat
+        name: mdformat (auto-format)
+      - id: mdformat
+        name: mdformat (strict check)
+        args: [--check]
+        stages: [pre-push]
+  - repo: local
+    hooks:
+      - id: duplicate-code
+        name: pylint duplicate-code (zero tolerance)
+        entry: scripts/check-duplicates.sh
+        language: system
+        pass_filenames: false
+        stages: [pre-push]

.python-version

@@ -0,0 +1 @@
+3.12