[MISC] Reusable workflow

.github/renovate.json5

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["github>canonical/data-platform//renovate_presets/charm.json5"],
+  "reviewers": ["dragomirp", "marceloneppel", "taurus-forever"],
+  "packageRules": [
+    // Later rules override earlier rules
+    {
+      "matchPackageNames": ["pydantic"],
+      "allowedVersions": "<2.0.0"
+    }, {
+      "matchPackageNames": ["python"],
+      "allowedVersions": "<3.11"
+    }
+  ]
+}

.github/workflows/ci.yaml

@@ -13,7 +13,7 @@ on:
       - '.jujuignore'
       - 'LICENSE'
       - '**.md'
-      - 'renovate.json'
+      - .github/renovate.json5
   schedule:
     - cron: '53 0 * * *' # Daily at 00:53 UTC
   # Triggered on push to branch "main" by .github/workflows/release.yaml
@@ -22,90 +22,45 @@ on:
 jobs:
   lint:
     name: Lint
-    runs-on: ubuntu-latest
-    timeout-minutes: 5
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Install tox
-        # TODO: Consider replacing with custom image on self-hosted runner OR pinning version
-        run: python3 -m pip install tox
-      - name: Run linters
-        run: tox run -e lint
+    uses: canonical/data-platform-workflows/.github/workflows/lint.yaml@v8.0.0
 
   unit-test:
-    name: Unit tests
+    name: Unit test charm
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Install tox
-        # TODO: Consider replacing with custom image on self-hosted runner OR pinning version
-        run: python3 -m pip install tox
+      - name: Install tox & poetry
+        run: |
+          pipx install tox
+          pipx install poetry
       - name: Run tests
         run: tox run -e unit
 
   build:
-    name: Build charms
-    uses: canonical/data-platform-workflows/.github/workflows/build_charms_with_cache.yaml@v2
+    name: Build charm
+    uses: canonical/data-platform-workflows/.github/workflows/build_charms_with_cache.yaml@v8.0.0
+    permissions:
+      actions: write  # Needed to manage GitHub Actions cache
 
   integration-test:
     strategy:
       fail-fast: false
-      max-parallel: 6
       matrix:
-        tox-environments:
-          - backend-integration
-          - client-relation-integration
-          - scaling-integration
-          - tls-integration
-          - standalone-integration
-          - legacy-client-relation-integration
-          - upgrade-integration
-        agent-versions: 
-          - "2.9.45"  # renovate: latest juju 2
-          - "3.1.6"  # renovate: latest juju 3
-    name: ${{ matrix.tox-environments }} | ${{ matrix.agent-versions }}
+        juju:
+          - agent: 2.9.46
+            libjuju: ^2
+          - agent: 3.1.6
+    name: Integration test charm | ${{ matrix.juju.agent }}
     needs:
       - lint
       - unit-test
       - build
-    runs-on: ubuntu-latest
-    timeout-minutes: 120
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Set channel
-        run: |
-          juju_channel=$(echo "${{ matrix.agent-versions }}" | cut -c 1-3)
-          echo "channel=${juju_channel}/stable" >> "$GITHUB_ENV"
-          juju_major=$(echo "${{ matrix.agent-versions }}" | cut -c 1)
-          echo "libjuju=juju${juju_major}" >> "$GITHUB_ENV"
-      - name: Setup operator environment
-        # TODO: Replace with custom image on self-hosted runner
-        uses: charmed-kubernetes/actions-operator@main
-        with:
-          provider: microk8s
-          channel: "1.28-strict/stable"
-          bootstrap-options: "--agent-version ${{ matrix.agent-versions }}"
-          juju-channel: "${{ env.channel }}"
-      - name: Download packed charm(s)
-        uses: actions/download-artifact@v3
-        with:
-          name: ${{ needs.build.outputs.artifact-name }}
-      - 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 }}-${{ env.libjuju }} -- -m '${{ steps.select-tests.outputs.mark_expression }}'
-        env:
-          CI_PACKED_CHARMS: ${{ needs.build.outputs.charms }}
+    uses: canonical/data-platform-workflows/.github/workflows/integration_test_charm.yaml@v8.0.0
+    with:
+      artifact-name: ${{ needs.build.outputs.artifact-name }}
+      cloud: microk8s
+      microk8s-snap-channel: 1.29-strict/stable
+      juju-agent-version: ${{ matrix.juju.agent }}
+      libjuju-version-constraint: ${{ matrix.juju.libjuju }}

.github/workflows/lib-check.yaml

@@ -26,6 +26,17 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
+      - name: Set up environment
+        run: |
+          pipx install tox
+          pipx install poetry
+          pipx inject poetry poetry-plugin-export
+          # TODO: Remove after https://github.com/python-poetry/poetry/pull/5980 is closed
+          poetry config warnings.export false
+      - name: Generate requirements
+        run: |
+          tox run -e pack-wrapper
+          mv requirements-last-build.txt requirements.txt
       - name: Check libs
         uses: canonical/charming-actions/check-libraries@2.4.0
         with:

.github/workflows/release.yaml

@@ -9,8 +9,7 @@ on:
     paths-ignore:
       - 'tests/**'
       - 'docs/**'
-      - renovate.json
-      - poetry.lock
+      - .github/renovate.json5
       - pyproject.toml
       - '.github/workflows/ci.yaml'
       - '.github/workflows/lib-check.yaml'
@@ -20,6 +19,8 @@ jobs:
     name: Tests
     uses: ./.github/workflows/ci.yaml
     secrets: inherit
+    permissions:
+      actions: write  # Needed to manage GitHub Actions cache
 
   release-libraries:
     name: Release libraries
@@ -40,14 +41,14 @@ jobs:
 
   build:
     name: Build charm
-    uses: canonical/data-platform-workflows/.github/workflows/build_charm_without_cache.yaml@v2
+    uses: canonical/data-platform-workflows/.github/workflows/build_charm_without_cache.yaml@v8.0.0
 
   release:
     name: Release charm
     needs:
       - ci-tests
       - build
-    uses: canonical/data-platform-workflows/.github/workflows/release_charm.yaml@v2
+    uses: canonical/data-platform-workflows/.github/workflows/release_charm.yaml@v8.0.0
     with:
       channel: 1/edge
       artifact-name: ${{ needs.build.outputs.artifact-name }}

.github/workflows/sync_issue_to_jira.yaml

@@ -9,7 +9,7 @@ on:
 jobs:
   sync:
     name: Sync GitHub issue to Jira
-    uses: canonical/data-platform-workflows/.github/workflows/sync_issue_to_jira.yaml@v2
+    uses: canonical/data-platform-workflows/.github/workflows/sync_issue_to_jira.yaml@v8.0.0
     with:
       jira-base-url: https://warthogs.atlassian.net
       jira-project-key: DPE

.gitignore

@@ -5,4 +5,6 @@ build/
 .coverage
 __pycache__/
 *.py[cod]
-*.log
+*.log
+/requirements.txt
+/requirements-last-build.txt

charmcraft.yaml

@@ -12,12 +12,20 @@ bases:
 
 parts:
   charm:
+    override-pull: |
+      craftctl default
+      if [[ ! -f requirements.txt ]]
+      then
+          echo 'ERROR: Use "tox run -e build" instead of calling "charmcraft pack" directly' >&2
+          exit 1
+      fi
+    charm-strict-dependencies: true
     build-packages:
       - libffi-dev
       - libssl-dev
       - rustc
       - cargo
       - pkg-config
     charm-binary-python-packages:
-      - psycopg2-binary==2.9.9  # renovate
-      - psycopg[binary]==3.1.12  # renovate
+      - psycopg2-binary
+      - psycopg-binary