Merge pull request #2070 from stratosphereips/develop

Slips v1.1.23

Author: AlyaGomaa

.gitattributes

@@ -0,0 +1,2 @@
+modules/ml_linear_model/artifacts/* filter=lfs diff=lfs merge=lfs -text
+modules/ml_online_model/artifacts/* filter=lfs diff=lfs merge=lfs -text

.github/dependabot.yml

@@ -5,9 +5,13 @@ updates:
     target-branch: "develop"
     schedule:
       interval: "daily"
+    cooldown:
+      default-days: 7
 
   - package-ecosystem: "github-actions"
     directory: "/"
     target-branch: "develop"
     schedule:
       interval: "daily"
+    cooldown:
+      default-days: 7

.github/workflows/dependabot-develop-tests.yml

@@ -0,0 +1,83 @@
+# Runs unit and integration tests for Dependabot PRs to develop.
+# Unlike the regular unit-tests/integration-tests workflows (which use the
+# prebuilt stratosphereips/slips_dependencies image from Docker Hub), this
+# builds a fresh Docker image from docker/Dockerfile and runs the tests inside
+# it, so dependency bumps are validated against a newly built image.
+
+name: dependabot-develop-tests
+
+on:
+  pull_request:
+    branches:
+      - 'develop'
+
+permissions:
+  contents: read
+
+jobs:
+  build-docker-image:
+    name: Build Docker image
+    # Only run for Dependabot-authored pull requests.
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    runs-on: ubuntu-22.04
+    timeout-minutes: 120
+    outputs:
+      docker_image_artifact_name: ${{ steps.image.outputs.artifact_name }}
+      docker_image_tag: ${{ steps.image.outputs.image_tag }}
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          ref: ${{ github.ref }}
+          fetch-depth: 0
+          lfs: true
+
+      - name: Prepare Docker image metadata
+        id: image
+        run: |
+          image_tag="slips-dependabot-develop-tests:${GITHUB_RUN_ID}-${GITHUB_RUN_ATTEMPT}"
+          artifact_name="slips-dependabot-develop-tests-image-${GITHUB_RUN_ID}-${GITHUB_RUN_ATTEMPT}"
+          echo "image_tag=$image_tag" >> "$GITHUB_OUTPUT"
+          echo "artifact_name=$artifact_name" >> "$GITHUB_OUTPUT"
+
+      - name: Build Docker image
+        uses: ./.github/workflows/reusable/build-docker-image
+        with:
+          artifact_name: ${{ steps.image.outputs.artifact_name }}
+          image_tag: ${{ steps.image.outputs.image_tag }}
+
+  unit-tests:
+    if: ${{ always() && needs.build-docker-image.result == 'success' }}
+    needs:
+      - build-docker-image
+    uses: ./.github/workflows/test-suite.yml
+    with:
+      test_suite_name: unit-tests
+      test_dir: tests/unit
+      test_path_prefix: tests/unit/
+      pytest_workers: "5"
+      timeout_minutes: 120
+      output_path: output/unit_tests
+      artifact_name_prefix: test_slips-output-
+      container_prefix: slips-unit
+      docker_image_artifact_name: ${{ needs.build-docker-image.outputs.docker_image_artifact_name }}
+      docker_image_tag: ${{ needs.build-docker-image.outputs.docker_image_tag }}
+      setup_venv: true
+
+  integration-tests:
+    if: ${{ always() && needs.build-docker-image.result == 'success' }}
+    needs:
+      - build-docker-image
+    uses: ./.github/workflows/test-suite.yml
+    with:
+      test_suite_name: integration-tests
+      test_dir: tests/integration
+      output_prefix: integration/
+      test_path_prefix: tests/
+      pytest_workers: "3"
+      timeout_minutes: 1800
+      output_path: output/integration_tests
+      artifact_name_suffix: -integration-output
+      container_prefix: slips-integration
+      docker_image_artifact_name: ${{ needs.build-docker-image.outputs.docker_image_artifact_name }}
+      docker_image_tag: ${{ needs.build-docker-image.outputs.docker_image_tag }}
+      setup_venv: true

.github/workflows/dockerfile-pr-tests.yml

@@ -37,6 +37,7 @@ jobs:
         with:
           ref: ${{ github.ref }}
           fetch-depth: 0
+          lfs: true
 
       - name: Prepare Docker image metadata
         id: image

.github/workflows/integration-tests.yml

@@ -8,6 +8,9 @@ on:
 
 jobs:
   integration-tests:
+    # Dependabot PRs to develop are handled by dependabot-develop-tests.yml,
+    # which runs the tests on a freshly built Docker image instead.
+    if: ${{ github.actor != 'dependabot[bot]' }}
     uses: ./.github/workflows/test-suite.yml
     with:
       test_suite_name: integration-tests

.github/workflows/publish-slips-images.yml

@@ -71,9 +71,13 @@ jobs:
           fetch-depth: 0
           # submodules are needed for local and global p2p
           submodules: true
+          # without this, LFS-tracked files (e.g. ml_online_model/ml_linear_model
+          # artifacts) are checked out as pointer text files instead of the
+          # real binaries, breaking those models in the published images
+          lfs: true
 
       - name: Login to DockerHub
-        uses: docker/login-action@v4
+        uses: docker/login-action@v4.5.2
         with:
           username: stratosphereips
           password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}

.github/workflows/reusable/build-docker-image/action.yml

@@ -28,6 +28,7 @@ runs:
         ref: ${{ github.ref }}
         fetch-depth: 0
         submodules: recursive
+        lfs: true
 
     - name: Validate Docker build context
       shell: bash

.github/workflows/reusable/list-tests-dir/action.yml

@@ -10,7 +10,7 @@ inputs:
     default: ""
 outputs:
   test_files:
-    description: "JSON array of integration test files (relative to tests/)"
+    description: "JSON array of test file metadata objects"
     value: ${{ steps.set-matrix.outputs.files }}
 
 runs:
@@ -19,7 +19,18 @@ runs:
     - id: set-matrix
       shell: bash
       run: |
-        # Find files in test_dir/ and optionally prefix entries for consumers.
         PREFIX="${{ inputs.output_prefix }}"
-        FILES=$(find "${{ inputs.test_dir }}" -name "test_*.py" -printf "%P\n" | sed "s|^|${PREFIX}|" | jq -R -s -c 'split("\n")[:-1]')
+        FILES=$(find "${{ inputs.test_dir }}" -name "test_*.py" -printf "%P\n" | jq -R -s -c --arg prefix "$PREFIX" '
+          split("\n")[:-1]
+          | map({
+              test_file: ($prefix + .),
+              display_name: (
+                split("/")
+                | if length >= 2
+                  then .[-2] + "/" + .[-1]
+                  else .[-1]
+                  end
+              )
+            })
+        ')
         echo "files=$FILES" >> "$GITHUB_OUTPUT"

.github/workflows/reusable/run-test-file/action.yml

@@ -37,6 +37,10 @@ inputs:
     description: "Matrix job index for unique Docker container names"
     required: false
     default: "0"
+  setup_venv:
+    description: "Create a fresh python3.10 venv, install install/requirements.txt into it, and run the tests with it (docker execution mode only)"
+    required: false
+    default: "false"
 
 runs:
   using: "composite"
@@ -66,6 +70,7 @@ runs:
         OUTPUT_PATH: ${{ inputs.output_path }}
         CONTAINER_PREFIX: ${{ inputs.container_prefix }}
         JOB_INDEX: ${{ inputs.job_index }}
+        SETUP_VENV: ${{ inputs.setup_venv }}
       run: |
         mkdir -p "$OUTPUT_PATH"
         container_name="${CONTAINER_PREFIX}-${GITHUB_RUN_ID}-${GITHUB_RUN_ATTEMPT}-${JOB_INDEX}"
@@ -78,6 +83,7 @@ runs:
           -e TEST_FILE="$TEST_FILE" \
           -e TEST_PATH_PREFIX="$TEST_PATH_PREFIX" \
           -e PYTEST_WORKERS="$PYTEST_WORKERS" \
+          -e SETUP_VENV="$SETUP_VENV" \
           "$IMAGE_TAG" \
           bash -lc '
             set -e
@@ -92,6 +98,16 @@ runs:
               fi
               sleep 0.5
             done
+            if [ "$SETUP_VENV" = "true" ]; then
+              # Validate this PR against a fresh venv built only from the PRs
+              # install/requirements.txt, rather than the image-baked packages.
+              apt-get update
+              apt-get install -y --no-install-recommends python3.10-venv
+              python3.10 -m venv /tmp/slips-venv
+              . /tmp/slips-venv/bin/activate
+              python3 -m pip install --upgrade pip
+              python3 -m pip install -r install/requirements.txt
+            fi
             python3 -m pytest "${TEST_PATH_PREFIX}${TEST_FILE}" -p no:warnings -vv -s -n "$PYTEST_WORKERS"
           '
 

.github/workflows/test-suite.yml

@@ -17,6 +17,13 @@
 #image_tag_prefix: slips-my-tests
 #container_prefix: slips-my-tess
 
+
+# this file runs either
+#  build-docker-image -> dockerfile-image-tests
+# or
+# dependency-image-tests -> prebuilt-docker-image-tests
+
+
 name: test-suite
 
 on:
@@ -86,6 +93,11 @@ on:
         required: false
         default: ""
         type: string
+      setup_venv:
+        description: "Inside the test container, create a fresh python3.10 venv, install install/requirements.txt into it, and run the tests with it"
+        required: false
+        default: false
+        type: boolean
 
 jobs:
   list-tests:
@@ -115,6 +127,7 @@ jobs:
         with:
           ref: ${{ github.ref }}
           fetch-depth: 0
+          lfs: true
 
       - name: Prepare Docker image metadata
         id: image
@@ -132,7 +145,7 @@ jobs:
 
   dependency-image-tests:
     # runs slips tests inside a pre-built slips dependency docker image at stratosphereips/slips_dependencies
-    name: ${{ inputs.test_suite_name }}
+    name: "${{ matrix.display_name && format('{0} / {1}', inputs.test_suite_name, matrix.display_name) || format('{0} (dependency image)', inputs.test_suite_name) }}"
     if: ${{ !inputs.build_dockerfile && inputs.docker_image_artifact_name == '' && inputs.docker_image_tag == '' }}
     needs: list-tests
     runs-on: ubuntu-22.04
@@ -150,13 +163,20 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        test_file: ${{ fromJson(needs.list-tests.outputs.test_files) }}
+        include: ${{ fromJson(needs.list-tests.outputs.test_files) }}
 
     steps:
+      - name: Install git-lfs
+        run: |
+          apt-get update
+          apt-get install -y --no-install-recommends git-lfs
+          git lfs install
+
       - uses: actions/checkout@v7
         with:
           ref: ${{ github.ref }}
           fetch-depth: 0
+          lfs: true
 
       - name: Run ${{ inputs.test_suite_name }} for ${{ matrix.test_file }}
         uses: ./.github/workflows/reusable/run-test-file
@@ -169,9 +189,10 @@ jobs:
           artifact_name: ${{ inputs.artifact_name_prefix && format('{0}{1}', inputs.artifact_name_prefix, strategy.job-index) || '' }}
           artifact_name_suffix: ${{ inputs.artifact_name_suffix }}
 
+
   dockerfile-image-tests:
-    # runs slips tests inside a newly created docker image from docker/Dockerfile
-    name: ${{ inputs.test_suite_name }}
+    # runs slips tests inside a newly built img from the "build-docker-image" step.
+    name: "${{ matrix.display_name && format('{0} / {1}', inputs.test_suite_name, matrix.display_name) || format('{0} (build dockerfile)', inputs.test_suite_name) }}"
     if: ${{ inputs.build_dockerfile }}
     needs:
       - list-tests
@@ -186,16 +207,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        test_file: ${{ fromJson(needs.list-tests.outputs.test_files) }}
+        include: ${{ fromJson(needs.list-tests.outputs.test_files) }}
 
     steps:
       - uses: actions/checkout@v7
         with:
           ref: ${{ github.ref }}
           fetch-depth: 0
+          lfs: true
 
       - name: Download Docker Image
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v8
         with:
           name: ${{ needs.build-docker-image.outputs.artifact_name }}
 
@@ -218,7 +240,7 @@ jobs:
 
   prebuilt-docker-image-tests:
     # runs slips tests inside a Docker image built by the caller and passed as an artifact
-    name: ${{ inputs.test_suite_name }}
+    name: "${{ matrix.display_name && format('{0} / {1}', inputs.test_suite_name, matrix.display_name) || format('{0} (prebuilt image)', inputs.test_suite_name) }}"
     if: ${{ !inputs.build_dockerfile && inputs.docker_image_artifact_name != '' && inputs.docker_image_tag != '' }}
     needs: list-tests
     runs-on: ubuntu-22.04
@@ -231,16 +253,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        test_file: ${{ fromJson(needs.list-tests.outputs.test_files) }}
+        include: ${{ fromJson(needs.list-tests.outputs.test_files) }}
 
     steps:
       - uses: actions/checkout@v7
         with:
           ref: ${{ github.ref }}
           fetch-depth: 0
+          lfs: true
 
       - name: Download Docker Image
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v8
         with:
           name: ${{ inputs.docker_image_artifact_name }}
 
@@ -260,3 +283,4 @@ jobs:
           image_tag: ${{ inputs.docker_image_tag }}
           container_prefix: ${{ inputs.container_prefix }}
           job_index: ${{ strategy.job-index }}
+          setup_venv: ${{ inputs.setup_venv }}