Skip to content

Commit

Permalink
Workflow pipeline with unit tests
Browse files Browse the repository at this point in the history
This adds a unit test workflow and restructures the github workflows
so that we run golangci-lint and unit tests first. Only when they have
succeded will the pipeline continue with e2e tests.
The goal is to conserve resources and avoid running pointless jobs.
The commit also removes unnecessary permissions and avoids running the
jobs if the PR is a draft.

Signed-off-by: Lennart Jern <lennart.jern@est.tech>
  • Loading branch information
lentzi90 committed Jun 5, 2024
1 parent 0b5856f commit fba1d95
Show file tree
Hide file tree
Showing 5 changed files with 133 additions and 14 deletions.
22 changes: 10 additions & 12 deletions .github/workflows/e2e-fixture-test.yml
Original file line number Diff line number Diff line change
@@ -1,24 +1,14 @@
name: E2E Fixture Test

on:
pull_request:
branches:
- 'release-0.5'
paths-ignore:
- '**/*.md'
- 'docs/**'
- '.gitignore'
- 'hack/*.sh'
- 'LICENSE'
- 'SECURITY_CONTACTS'
- 'DCO'
- 'OWNERS'
workflow_call:

permissions:
contents: read

jobs:
test:
name: E2E fixture test
runs-on: ubuntu-latest

steps:
Expand All @@ -34,3 +24,11 @@ jobs:
E2E_CONF_FILE: ${GITHUB_WORKSPACE}/test/e2e/config/fixture.yaml
USE_EXISTING_CLUSTER: "false"
run: make test-e2e

- name: Upload artifacts
uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3
with:
name: artifacts-fixture.tar.gz
path: test/e2e/_artifacts
if-no-files-found: error
overwrite: false
53 changes: 53 additions & 0 deletions .github/workflows/e2e-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: E2E Test

on:
workflow_call:
inputs:
bmc-protocol:
required: true
type: string
runner:
type: string
default: "ubuntu-latest-4-cores"
ginkgo-focus:
type: string
default: ""
ref:
type: string
default: ${{ github.ref }}

permissions: {}

jobs:
test:
name: E2E test
runs-on: ${{ inputs.runner }}

steps:
- uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
with:
ref: ${{ inputs.ref }}

- name: Install libvirt
run: |
sudo apt-get update
sudo apt-get install -y libvirt-daemon-system qemu-kvm virt-manager
- name: Run BMO e2e Tests
env:
BMC_PROTOCOL: ${{ inputs.bmc-protocol }}
GINKGO_FOCUS: "${{ inputs.ginkgo-focus }}"
# We need a new shell to pick up the new group. That is why we do the sudo -s -u $USER ...
# Remove the pre-installed go version. We install the exact version we need.
run: |
sudo usermod -a -G libvirt $USER
sudo rm /usr/bin/go
sudo -s -u $USER --preserve-env bash ${{ github.workspace }}/hack/ci-e2e.sh
- name: Upload artifacts
uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3
with:
name: artifacts-${{ inputs.bmc-protocol }}.tar.gz
path: test/e2e/_artifacts
if-no-files-found: error
overwrite: false
3 changes: 1 addition & 2 deletions .github/workflows/golangci-lint.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
name: golangci-lint

on:
pull_request:
types: [opened, edited, synchronize, reopened]
workflow_call:

# Remove all permissions from GITHUB_TOKEN except metadata.
permissions: {}
Expand Down
44 changes: 44 additions & 0 deletions .github/workflows/pipeline.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: E2E Test pipeline

on:
pull_request:
types: [opened, edited, synchronize, reopened, ready_for_review]
branches:
- 'main'
- 'release-*'
paths-ignore:
- '**/*.md'
- 'docs/**'
- '.gitignore'
- 'LICENSE'
- 'SECURITY_CONTACTS'
- 'DCO'
- 'OWNERS'

permissions: {}

jobs:
golangci-lint:
if: github.event.pull_request.draft == false
uses: ./.github/workflows/golangci-lint.yml

unit:
if: github.event.pull_request.draft == false
uses: ./.github/workflows/unit.yml

e2e-fixture-test:
needs: [golangci-lint, unit]
uses: ./.github/workflows/e2e-fixture-test.yml

e2e-test:
needs: [golangci-lint, unit]
strategy:
# Avoid wasting CI resources
fail-fast: true
matrix:
bmc-protocol:
- redfish-virtualmedia
- ipmi
uses: ./.github/workflows/e2e-test.yml
with:
bmc-protocol: ${{ matrix.bmc-protocol }}
25 changes: 25 additions & 0 deletions .github/workflows/unit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: unit

on:
workflow_call:

# Remove all permissions from GITHUB_TOKEN except metadata.
permissions: {}

jobs:
golangci:
name: unit
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
- name: Calculate go version
id: vars
run: echo "go_version=$(make go-version)" >> $GITHUB_OUTPUT
- name: Set up Go
uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7 # v5.0.1
with:
go-version: ${{ steps.vars.outputs.go_version }}
- name: Run unit tests
run: make -e unit-cover
env:
TEST_FLAGS: "-v"

0 comments on commit fba1d95

Please sign in to comment.