E2E test workflow (moleculerjs/moleculer)
The E2E test workflow from moleculerjs/moleculer, explained and optimized by Latchkey.
D
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.
What it does
This is the E2E test workflow from the moleculerjs/moleculer repository, a real project running GitHub Actions. It is shown here with attribution under its MIT license.
Below, Latchkey shows a faster, safer version produced by its optimization engine.
The workflow
workflow (.yml)
name: E2E test
on:
push:
branches:
- '**'
paths-ignore:
- 'benchmark/**'
- 'dev/**'
- 'examples/**'
- '*.md'
pull_request:
branches:
- master
paths-ignore:
- 'benchmark/**'
- 'dev/**'
- 'examples/**'
- '*.md'
jobs:
test:
runs-on: ubuntu-22.04
#concurrency:
# group: ${{ github.workflow }}-${{ github.ref }}
# cancel-in-progress: true
strategy:
matrix:
node-version: [22.x]
transporter: [NATS, Redis, MQTT, AMQP, AMQP10, Kafka, TCP]
serializer: [JSON, JSONExt, MsgPack, Notepack, CBOR]
discoverer: [Local, Etcd3, Redis]
fail-fast: false
steps:
- uses: actions/checkout@v4
- name: Use Node.js ${{ matrix.node-version }} with ${{ matrix.transporter }} transporter and ${{ matrix.serializer }} and ${{ matrix.discoverer }} discoverer
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
- name: Cache node modules
uses: actions/cache@v4
env:
cache-name: cache-node-modules
with:
# npm cache files are stored in `~/.npm` on Linux/macOS
path: ~/.npm
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-build-${{ env.cache-name }}-
${{ runner.os }}-build-
${{ runner.os }}-
- name: Install dependencies
run: npm ci
- name: Start NATS
run: docker compose up -d nats && sleep 10
if: ${{ matrix.transporter == 'NATS' }}
working-directory: ./test
- name: Start Redis
run: docker compose up -d redis && sleep 10
if: ${{ matrix.transporter == 'Redis' || matrix.discoverer == 'Redis' }}
working-directory: ./test
- name: Start MQTT
run: docker compose up -d mqtt && sleep 10
if: ${{ matrix.transporter == 'MQTT' }}
working-directory: ./test
- name: Start RabbitMQ
run: docker compose up -d rabbitmq && sleep 10
if: ${{ matrix.transporter == 'AMQP' }}
working-directory: ./test
- name: Start ActiveMQ
run: docker compose up -d activemq && sleep 30
if: ${{ matrix.transporter == 'AMQP10' }}
working-directory: ./test
- name: Start Kafka
run: docker compose up -d kafka && sleep 60
if: ${{ matrix.transporter == 'Kafka' }}
working-directory: ./test
- name: Start Etcd3
run: docker compose up -d etcd3 && sleep 10
if: ${{ matrix.discoverer == 'Etcd3' }}
working-directory: ./test
- name: Check containers
run: docker compose ps
working-directory: ./test
- name: Check logs
run: docker compose logs
working-directory: ./test
- name: Execute E2E tests
run: npm run test:e2e
timeout-minutes: 5
env:
TRANSPORTER: ${{ matrix.transporter }}
SERIALIZER: ${{ matrix.serializer }}
DISCOVERER: ${{ matrix.discoverer }}
# LOGLEVEL: "${{ matrix.transporter == 'Kafka' && 'debug' || 'warn' }}"
- name: Stop containers
run: docker compose down -v
working-directory: ./test
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: E2E test on: push: branches: - '**' paths-ignore: - 'benchmark/**' - 'dev/**' - 'examples/**' - '*.md' pull_request: branches: - master paths-ignore: - 'benchmark/**' - 'dev/**' - 'examples/**' - '*.md' concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: test: timeout-minutes: 30 runs-on: latchkey-small #concurrency: # group: ${{ github.workflow }}-${{ github.ref }} # cancel-in-progress: true strategy: matrix: node-version: [22.x] transporter: [NATS, Redis, MQTT, AMQP, AMQP10, Kafka, TCP] serializer: [JSON, JSONExt, MsgPack, Notepack, CBOR] discoverer: [Local, Etcd3, Redis] fail-fast: false steps: - uses: actions/checkout@v4 - name: Use Node.js ${{ matrix.node-version }} with ${{ matrix.transporter }} transporter and ${{ matrix.serializer }} and ${{ matrix.discoverer }} discoverer uses: actions/setup-node@v4 with: cache: 'npm' node-version: ${{ matrix.node-version }} - name: Cache node modules uses: actions/cache@v4 env: cache-name: cache-node-modules with: # npm cache files are stored in `~/.npm` on Linux/macOS path: ~/.npm key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }} restore-keys: | ${{ runner.os }}-build-${{ env.cache-name }}- ${{ runner.os }}-build- ${{ runner.os }}- - name: Install dependencies run: npm ci - name: Start NATS run: docker compose up -d nats && sleep 10 if: ${{ matrix.transporter == 'NATS' }} working-directory: ./test - name: Start Redis run: docker compose up -d redis && sleep 10 if: ${{ matrix.transporter == 'Redis' || matrix.discoverer == 'Redis' }} working-directory: ./test - name: Start MQTT run: docker compose up -d mqtt && sleep 10 if: ${{ matrix.transporter == 'MQTT' }} working-directory: ./test - name: Start RabbitMQ run: docker compose up -d rabbitmq && sleep 10 if: ${{ matrix.transporter == 'AMQP' }} working-directory: ./test - name: Start ActiveMQ run: docker compose up -d activemq && sleep 30 if: ${{ matrix.transporter == 'AMQP10' }} working-directory: ./test - name: Start Kafka run: docker compose up -d kafka && sleep 60 if: ${{ matrix.transporter == 'Kafka' }} working-directory: ./test - name: Start Etcd3 run: docker compose up -d etcd3 && sleep 10 if: ${{ matrix.discoverer == 'Etcd3' }} working-directory: ./test - name: Check containers run: docker compose ps working-directory: ./test - name: Check logs run: docker compose logs working-directory: ./test - name: Execute E2E tests run: npm run test:e2e timeout-minutes: 5 env: TRANSPORTER: ${{ matrix.transporter }} SERIALIZER: ${{ matrix.serializer }} DISCOVERER: ${{ matrix.discoverer }} # LOGLEVEL: "${{ matrix.transporter == 'Kafka' && 'debug' || 'warn' }}" - name: Stop containers run: docker compose down -v working-directory: ./test
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 useslatchkey-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
- End-to-end and browser tests
This workflow runs 1 job (105 with the matrix expanded) per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.