From b229fe3a341e1a5b3545553a79dc831a5cee67a6 Mon Sep 17 00:00:00 2001 From: Samuel Allan Date: Wed, 28 Aug 2024 12:00:08 +0930 Subject: [PATCH] Update workflows to latest templates (#16) This also ensures that charmcraft is pinned to v2, which is required for this charm; it doesn't support charmcraft v3. --- .github/workflows/check.yaml | 87 +++++++++++++++++++++++++++++----- .github/workflows/promote.yaml | 28 +++++++---- .github/workflows/release.yaml | 21 +++++--- .github/workflows/sonar.yaml | 17 ------- 4 files changed, 108 insertions(+), 45 deletions(-) delete mode 100644 .github/workflows/sonar.yaml diff --git a/.github/workflows/check.yaml b/.github/workflows/check.yaml index 5ca1ee0..5b065d9 100644 --- a/.github/workflows/check.yaml +++ b/.github/workflows/check.yaml @@ -1,11 +1,11 @@ -name: Check workflow running linter, unit and functional tests +name: Tests on: workflow_call: workflow_dispatch: pull_request: types: [opened, synchronize, reopened] - branches: [master, main] + branches: [main] paths-ignore: - "**.md" - "**.rst" @@ -25,18 +25,79 @@ jobs: python-version: ${{ matrix.python-version }} func: - uses: canonical/bootstack-actions/.github/workflows/func.yaml@v3 needs: lint-unit + name: functional tests + runs-on: ${{ matrix.runs-on }} + timeout-minutes: 120 strategy: fail-fast: false matrix: - command: ["TEST_JUJU3=1 make functional"] # TEST_JUJU3 needed due https://github.com/openstack-charmers/zaza/blob/b22c2eed4c322f1dfc14ffb2d31e0dd18c911a40/setup.py#L47 to support Juju3+ - juju-channel: ["3.4/stable"] - with: - command: ${{ matrix.command }} - juju-channel: ${{ matrix.juju-channel }} - nested-containers: false - provider: "lxd" - python-version: "3.10" - timeout-minutes: 120 - runs-on: "['self-hosted', 'linux', 'x64', 'large', 'jammy']" + runs-on: [[self-hosted, linux, x64, large, jammy]] + test-command: ['make functional'] + steps: + + - uses: actions/checkout@v4 + with: + submodules: true + + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: "3.10" + + - name: Setup Juju environment + uses: charmed-kubernetes/actions-operator@main + with: + provider: "lxd" + juju-channel: "3.4/stable" + charmcraft-channel: "2.x/stable" + + # This is used by zaza in the functional tests for non-amd64 architectures (if applicable) + - name: Set zaza juju model constraints for architecture + run: | + if [ "$(uname -m)" = "aarch64" ]; then + echo "TEST_MODEL_CONSTRAINTS=arch=arm64" >> "$GITHUB_ENV" + fi + + - name: Run tests + run: ${{ matrix.test-command }} + env: + TEST_JUJU3: "1" # https://github.com/openstack-charmers/zaza/pull/653 + TEST_JUJU_CHANNEL: ${{ matrix.juju-channel }} + + # Save output for debugging + + - name: Generate debugging information + if: always() + run: | + set -x + # install dependencies + sudo snap install --classic juju-crashdump + sudo apt install -y jq uuid + + # Print juju controller information for debugging + # to check controller and client are compatible versions; + # we can have a mismatch if using an external controller. + juju version + juju controllers + + models="$(juju models --format json | jq -r '.models[]."short-name"')" + dir="$(mktemp -d)" + # Use a different dir to avoid charmed-kubernetes/actions-operator from also trying to upload crashdumps. + # We don't want to rely on that action, because it doesn't use a descriptive enough name for the artefact, + # and we may stop using that action soon. + echo "CRASHDUMPS_DIR=$dir" | tee -a "$GITHUB_ENV" + echo "CRASHDUMPS_ARTEFACT_SUFFIX=$(uuid)-$(uname -m)" | tee -a "$GITHUB_ENV" + + for model in $models; do + # show status here for quick debugging + juju status -m "$model" + juju-crashdump --as-root -m "$model" -u "$model-$(uname -m)" -o "$dir" + done + + - name: Upload juju crashdumps + uses: actions/upload-artifact@v4 + if: always() + with: + name: "juju-crashdumps-${{ env.CRASHDUMPS_ARTEFACT_SUFFIX }}" + path: "${{ env.CRASHDUMPS_DIR }}/juju-crashdump-*.tar.xz" diff --git a/.github/workflows/promote.yaml b/.github/workflows/promote.yaml index aa53c2e..18408ee 100644 --- a/.github/workflows/promote.yaml +++ b/.github/workflows/promote.yaml @@ -1,14 +1,15 @@ -name: Promote charm to other tracks and channels +name: Promote charm to default track, standard risk levels. on: workflow_dispatch: inputs: - destination-channel: - description: 'Destination Channel, e.g. latest/candidate' - required: true - origin-channel: - description: 'Origin Channel, e.g. latest/edge' + channel-promotion: + description: 'Channel Promotion, e.g. latest/edge -> latest/candidate' required: true + type: choice + options: + - 'latest/edge -> latest/candidate' + - 'latest/candidate -> latest/stable' jobs: promote-charm: @@ -16,10 +17,19 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 + - name: Set channels + id: set-channels + run: | + channel_promotion="${{ github.event.inputs.channel-promotion }}" + origin=$(echo "$channel_promotion" | sed 's/\s*->.*//') + destination=$(echo "$channel_promotion" | sed 's/.*->\s*//') + echo "destination-channel=$destination" >> $GITHUB_OUTPUT + echo "origin-channel=$origin" >> $GITHUB_OUTPUT - name: Release charm to channel - uses: canonical/charming-actions/release-charm@2.4.0 + uses: canonical/charming-actions/release-charm@2.6.2 with: credentials: ${{ secrets.CHARMHUB_TOKEN }} github-token: ${{ secrets.GITHUB_TOKEN }} - destination-channel: ${{ github.event.inputs.destination-channel }} - origin-channel: ${{ github.event.inputs.origin-channel }} + destination-channel: ${{ steps.set-channels.outputs.destination-channel }} + origin-channel: ${{ steps.set-channels.outputs.origin-channel }} + charmcraft-channel: "2.x/stable" diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 3b01e7e..2724c65 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -13,17 +13,26 @@ jobs: release: needs: check - runs-on: ubuntu-latest + runs-on: ${{ matrix.runs-on }} + strategy: + fail-fast: false + matrix: + runs-on: [[ubuntu-latest]] steps: - name: Checkout uses: actions/checkout@v4 + with: + submodules: true + - name: Initialize lxd # This should dropped once it's implemented on charming-actions itself. https://github.com/canonical/charming-actions/issues/140 - uses: canonical/setup-lxd@v0.1.1 - - name: Upload charm to charmhub - uses: canonical/charming-actions/upload-charm@2.4.0 + # revision is latest main at time of writing; using because it contains a fix to https://github.com/canonical/setup-lxd/issues/19 + uses: canonical/setup-lxd@2aa6f7caf7d1484298a64192f7f63a6684e648a4 + + - name: Pack and upload to charmhub + uses: canonical/charming-actions/upload-charm@2.6.2 with: + charmcraft-channel: "2.x/stable" credentials: "${{ secrets.CHARMHUB_TOKEN }}" github-token: "${{ secrets.GITHUB_TOKEN }}" - channel: "latest/edge" - # Note(rgildein): Right now we are not using destructive-mode, since our charmcraft.yaml is designed with a single build-on and the ability to run-on multiple bases. Running with destructive-mode would require aligning the base defined in this job with the one defined in charmcraft.yaml (build-on). + # Ensure the charm is built in an isolated environment and on the correct base in an lxd container. destructive-mode: false diff --git a/.github/workflows/sonar.yaml b/.github/workflows/sonar.yaml deleted file mode 100644 index 34c8d6f..0000000 --- a/.github/workflows/sonar.yaml +++ /dev/null @@ -1,17 +0,0 @@ -# This is a template `sonar.yaml` file for ops charms -# This file is managed by bootstack-charms-spec and should not be modified -# within individual charm repos. https://launchpad.net/bootstack-charms-spec - -name: SonarCloud -on: - workflow_run: - workflows: - - PR workflow running lint checkers, unit and functional tests - types: [completed] - -jobs: - sonar: - uses: canonical/bootstack-actions/.github/workflows/sonar.yaml@main - secrets: inherit - with: - workflow-name: PR workflow running lint checkers, unit and functional tests