pyaescrypt tests workflow (marcobellaccini/pyAesCrypt)

The pyaescrypt tests workflow from marcobellaccini/pyAesCrypt, explained and optimized by Latchkey.

What it does

This is the pyaescrypt tests workflow from the marcobellaccini/pyAesCrypt 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

name: pyaescrypt tests
run-name: pyaescrypt tests

on:
  push:
  pull_request:

jobs:

  build_linux:
    runs-on: ubuntu-latest

    strategy:
      matrix:
        python-version: ["3.7","3.8","3.9","3.10","3.11"]

    steps:
    - uses: actions/checkout@v3
    
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v4
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install cryptography
        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
        
    - name: Install AESCrypt
      run: |
        wget https://www.aescrypt.com/download/v3/linux/aescrypt-3.14.tgz
        tar -xzf aescrypt-3.14.tgz
        pushd aescrypt-3.14/src && make && sudo make install && popd
        
    - name: Run tests
      run: |
        python -m unittest discover
    

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.

name: pyaescrypt tests
run-name: pyaescrypt tests
 
on:
  push:
  pull_request:
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
 
  build_linux:
    timeout-minutes: 30
    runs-on: latchkey-small
 
    strategy:
      matrix:
        python-version: ["3.7","3.8","3.9","3.10","3.11"]
 
    steps:
    - uses: actions/checkout@v3
    
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v4
      with:
        cache: 'pip'
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install cryptography
        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
        
    - name: Install AESCrypt
      run: |
        wget https://www.aescrypt.com/download/v3/linux/aescrypt-3.14.tgz
        tar -xzf aescrypt-3.14.tgz
        pushd aescrypt-3.14/src && make && sudo make install && popd
        
    - name: Run tests
      run: |
        python -m unittest discover
    
 

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
• Network fetches

This workflow runs 1 job (5 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