Implement tooling best practices #40
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Copyright 2023 Canonical Ltd. | |
| # See LICENSE file for licensing details. | |
| name: Tests | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| on: | |
| pull_request: | |
| schedule: | |
| - cron: "53 0 * * *" # Daily at 00:53 UTC | |
| # Triggered on push to branch "main" by .github/workflows/release.yaml | |
| workflow_call: | |
| jobs: | |
| lint: | |
| name: Lint | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install tox & poetry | |
| run: | | |
| pipx install tox | |
| pipx install poetry | |
| - name: Run linters | |
| run: tox run -e lint | |
| lib-check: | |
| name: Check libraries | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Check libs | |
| uses: canonical/charming-actions/[email protected] | |
| with: | |
| credentials: ${{ secrets.CHARMHUB_TOKEN }} # FIXME: current token will expire in 2023-07-04 | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| unit-test: | |
| name: Unit test charm | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Install tox & poetry | |
| run: | | |
| pipx install tox | |
| pipx install poetry | |
| - name: Run tests | |
| run: tox run -e unit | |
| - name: Upload Coverage to Codecov | |
| uses: codecov/codecov-action@v3 | |
| build: | |
| name: Build charms | |
| uses: canonical/data-platform-workflows/.github/workflows/build_charms_with_cache.yaml@v8 | |
| permissions: | |
| actions: write # Needed to manage GitHub Actions cache | |
| integration-test: | |
| # TODO: use reusable workflow | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| tox-environments: | |
| - integration-charm | |
| name: ${{ matrix.tox-environments }} | |
| needs: | |
| - lint | |
| - unit-test | |
| - lib-check | |
| - build | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 120 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Setup operator environment | |
| # TODO: Replace with custom image on self-hosted runner | |
| uses: charmed-kubernetes/actions-operator@main | |
| with: | |
| provider: lxd | |
| juju-channel: 3.1/stable | |
| bootstrap-options: "--agent-version 3.1.6" | |
| - name: Download packed charm(s) | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: ${{ needs.build.outputs.artifact-name }} | |
| - name: Free disk space | |
| run: | | |
| echo "Free disk space before cleanup" | |
| df -T | |
| # free space in the runner | |
| sudo rm -rf /usr/share/dotnet | |
| sudo rm -rf /opt/ghc | |
| sudo rm -rf /usr/local/share/boost | |
| sudo rm -rf "$AGENT_TOOLSDIRECTORY" | |
| echo "Free disk space after cleanup" | |
| df -T | |
| - name: Select tests | |
| id: select-tests | |
| run: | | |
| if [ "${{ github.event_name }}" == "schedule" ] | |
| then | |
| echo Running unstable and stable tests | |
| echo "mark_expression=" >> $GITHUB_OUTPUT | |
| else | |
| echo Skipping unstable tests | |
| echo "mark_expression=not unstable" >> $GITHUB_OUTPUT | |
| fi | |
| - name: Run integration tests | |
| run: tox run -e ${{ matrix.tox-environments }} -- -m '${{ steps.select-tests.outputs.mark_expression }}' |