CI workflow (OWASP/Python-Honeypot)

The CI workflow from OWASP/Python-Honeypot, explained and optimized by Latchkey.

CI health: D - needs work

Point runs-on at Latchkey and get caching, run de-duplication, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: OWASP/Python-Honeypot.github/workflows/ci.ymlLicense Apache-2.0View source

What it does

This is the CI workflow from the OWASP/Python-Honeypot repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

workflow (.yml)

# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: CI

on:
  push:
    branches:
      - master
      - development
      - '**'

  pull_request:
    branches:
      - master
      - development
      - '**'

    paths-ignore:
      - 'lib/**'

    types: [
      assigned,
      unassigned,
      labeled,
      unlabeled,
      opened,
      edited,
      closed,
      reopened,
      synchronize,
      ready_for_review,
      locked,
      unlocked,
      review_requested,
      review_request_removed
    ]

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.9.4, 3.8.9]

    steps:
      - uses: actions/checkout@v2
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install dependencies
        run: |
          python3 -m pip install --upgrade pip
          sudo pip3 install setuptools
          sudo pip3 install -r requirements.txt
          sudo pip3 install -r requirements-dev.txt

      - name: Install OS dependencies
        run: sudo yes | sudo apt-get update && sudo apt-get install libpcap-dev libnet-dev tshark --fix-missing

      - name: Lint with flake8
        run: flake8 --count --show-source --statistics .

      - name: Run API server via docker daemon
        run: sudo mkdir -p data/db && sudo chmod -R 1777 data/db && docker-compose up -d --build && sleep 60

      - name: Check API server logs
        run: docker logs python-honeypot_ohp_1

      - name: Test with pytest
        run: docker exec python-honeypot_ohp_1 python3 -m pytest -rpP --reruns 5 --reruns-delay 3

      - name: Check API server logs
        run: docker-compose logs ohp

      - name: Run modules test
        run: sudo python3 ohp.py -m all --test --store-pcap --verbose

      - name: Kill API Server
        run: docker-compose down

The same workflow, on Latchkey

Estimated ~20% faster on cache hits, plus fewer wasted runs and a safer supply chain. Added and changed lines are highlighted.

# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
name: CI
 
on:
  push:
    branches:
      - master
      - development
      - '**'
 
  pull_request:
    branches:
      - master
      - development
      - '**'
 
    paths-ignore:
      - 'lib/**'
 
    types: [
      assigned,
      unassigned,
      labeled,
      unlabeled,
      opened,
      edited,
      closed,
      reopened,
      synchronize,
      ready_for_review,
      locked,
      unlocked,
      review_requested,
      review_request_removed
    ]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
 
    runs-on: latchkey-small
    strategy:
      matrix:
        python-version: [3.9.4, 3.8.9]
 
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
 
      - name: Install dependencies
        run: |
          python3 -m pip install --upgrade pip
          sudo pip3 install setuptools
          sudo pip3 install -r requirements.txt
          sudo pip3 install -r requirements-dev.txt
 
      - name: Install OS dependencies
        run: sudo yes | sudo apt-get update && sudo apt-get install libpcap-dev libnet-dev tshark --fix-missing
 
      - name: Lint with flake8
        run: flake8 --count --show-source --statistics .
 
      - name: Run API server via docker daemon
        run: sudo mkdir -p data/db && sudo chmod -R 1777 data/db && docker-compose up -d --build && sleep 60
 
      - name: Check API server logs
        run: docker logs python-honeypot_ohp_1
 
      - name: Test with pytest
        run: docker exec python-honeypot_ohp_1 python3 -m pytest -rpP --reruns 5 --reruns-delay 3
 
      - name: Check API server logs
        run: docker-compose logs ohp
 
      - name: Run modules test
        run: sudo python3 ohp.py -m all --test --store-pcap --verbose
 
      - name: Kill API Server
        run: docker-compose down

What changed

Run on Latchkey managed runners with one line (runs-on), which apply the fixes below automatically and self-heal transient failures. This example uses latchkey-small; pick the runner size that fits the job.
Cancel superseded runs when a branch or PR gets a newer push.
Cache dependency installs on the setup step so they are served from cache.
Add a job timeout so a hung step cannot burn hours of runner time.

What Latchkey heals here

This workflow has steps that commonly fail on transient issues (network, registries, flaky browsers). On Latchkey managed runners they are detected, retried, and self-healed instead of failing your build:

Dependency installs

This workflow runs 1 job (2 with the matrix expanded) per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow

actions/checkout actions/setup-python