test-daskhub-chart.yml

# This is a GitHub workflow defining a set of jobs with a set of steps. ref:
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
#
# NOTE: Changes to this name must be followed by updates to the README.me
#       badges.
name: Test daskhub chart

on:
  pull_request:
    paths:
      - "daskhub/**"
      - "chartpress.yaml"
      - "**/test-daskhub-chart.yml"
      - "ci/common"
  push:
    paths:
      - "daskhub/**"
      - "chartpress.yaml"
      - "**/test-daskhub-chart.yml"
      - "ci/common"
    branches-ignore:
      - "upgrade-**"
      - "dependabot/**"
      - "pre-commit-ci-update-config"
  workflow_dispatch:

jobs:
  test-install-chart:
    runs-on: ubuntu-22.04

    strategy:
      # Keep running even if one variation of the job fail
      fail-fast: false
      matrix:
        # We run this job multiple times with different parameterization
        # specified below, these parameters have no meaning on their own and
        # gain meaning on how job steps use them.
        #
        # k3s-version: https://github.com/rancher/k3s/tags
        # k3s-channel: https://update.k3s.io/v1-release/channels
        include:
          - k3s-channel: v1.25
          - k3s-channel: latest

    steps:
      - uses: actions/checkout@v4

      - name: Update chart dependencies
        run: helm dependencies update ./daskhub

      - name: Lint chart's templates
        run: helm lint ./daskhub --strict

      - name: Validate chart's templates can render
        run: helm template ./daskhub 1>/dev/null

      # Starts a k8s cluster with NetworkPolicy enforcement and installs kubectl
      #
      # ref: https://github.com/jupyterhub/action-k3s-helm/
      - uses: jupyterhub/action-k3s-helm@v4
        with:
          k3s-channel: ${{ matrix.k3s-channel }}
          metrics-enabled: false
          traefik-enabled: false
          docker-enabled: false

      # NOTE: We cannot perform helm template --validate as a quick step before
      #       installing the daskhub chart because it contains resources of CRD
      #       kind and the CRDs. This is because we validate against the k8s
      #       api-server and helm template doesn't install the charts crds just
      #       because we want to validate the rendered templates.
      #
      # - name: Validate charts' rendered templates are valid k8s resources
      #   run: |
      #     helm template ./daskhub --validate 1>/dev/null

      - name: Install chart and await readiness
        run: |
          helm install daskhub ./daskhub

          . ci/common
          full_namespace_await

      # GitHub Action reference: https://github.com/jupyterhub/action-k8s-namespace-report
      - name: Kubernetes namespace report
        uses: jupyterhub/action-k8s-namespace-report@v1
        if: always()