How-To: CI/CD Pipeline Setup

Integrate NSE into GitHub Actions or GitLab CI to automatically test firewall rulesets on every commit.

---

GitHub Actions Workflow

Create .github/workflows/ci.yml:

name: CI/CD Pipeline

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.11'
      - run: make setup
      - run: make lint

  unit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.11'
      - run: make setup
      - run: make test

  integration:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.11'
      - run: |
          sudo apt-get update
          sudo apt-get install -y nftables iproute2 conntrack
      - run: make setup
      - run: |
          sudo .venv/bin/python -m pytest tests/ -v -m "integration"
          sudo .venv/bin/python -m nse.cli.runner --file tests/test_suite.yaml

---

Local CI Verification (make ci-local)

Run the complete 5-job CI pipeline locally before pushing:

make ci-local