name: Test & Release

on:
  - push
  - workflow_dispatch

env:
  IMAGE_REGISTRY: ghcr.io
  IMAGE_BASE_REPO: k3d-io
  IMAGE_PLATFORMS: linux/amd64,linux/arm64,linux/arm/v7
  GO_VERSION: "1.22.x"
  DOCKER_VERSION: "23.0"
    
jobs:
  test-suite:
    timeout-minutes: 30
    name: Full Test Suite
    runs-on: ubuntu-22.04
    steps:
      # Setup
      - uses: actions/checkout@v3
      - name: Setup Go environment
        uses: actions/setup-go@v3
        with:
          go-version: "${{ env.GO_VERSION }}"
      - name: Setup Docker
        uses: docker-practice/actions-setup-docker@master
        with:
          docker_version: "${{ env.DOCKER_VERSION }}"
      - name: Setup CI Tools
        run: make ci-setup
      # Code Check
      - name: Run Static Analysis
        run: make ci-lint
      # Tests
      - name: Run Go Tests
        run: make test
      - name: Run E2E Tests
        timeout-minutes: 30
        # Quite often, tests were failing due to "too many open files" errors, so we're fixing this here
        # Also, we want to see trace level logs if tests fail and the pipeline should exit on first error
        run: |
          echo "[$(date '+%F %H:%M:%S')] Setting up environment for E2E tests..."
          sudo prlimit --pid $$ --nofile=1048576:1048576
          sudo sysctl fs.inotify.max_user_instances=1280
          sudo sysctl fs.inotify.max_user_watches=655360
          echo "[$(date '+%F %H:%M:%S')] Running E2E tests..."
          make e2e -e E2E_LOG_LEVEL=trace -e E2E_FAIL_FAST=true
      # Builds
      - name: Test Platform Builds
        run: make build-cross
      - name: Test Helper Image Builds
        run: make build-helper-images

  release-images:
    name: Build & Release Images
    # Only run on tags
    runs-on: ubuntu-22.04
    steps:
      # Setup
      - uses: actions/checkout@v3
      # Container Image Setup
      - name: Setup Docker
        uses: docker-practice/actions-setup-docker@master
        with:
          docker_version: "${{ env.DOCKER_VERSION }}"
      - name: Log in to the Container registry
        uses: docker/login-action@v1
        with:
          registry: ${{ env.IMAGE_REGISTRY }}
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}
      - name: Set up QEMU
        uses: docker/setup-qemu-action@v1
      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v1
      # Gather Docker Metadata
      - name: Docker Metadata k3d-binary
        id: meta-k3d-binary
        env:
          IMAGE_ID: k3d
        uses: docker/metadata-action@v3
        with:
          images: ${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_BASE_REPO }}/${{ env.IMAGE_ID }}
          github-token: ${{ secrets.GITHUB_TOKEN }}
          bake-target: docker-metadata-${{ env.IMAGE_ID }}
          tags: |
            type=semver,pattern={{major}}
            type=semver,pattern={{major}}.{{minor}}
            type=semver,pattern={{version}}
            type=ref,event=branch
            type=ref,event=pr
            type=sha
      - name: Docker Metadata k3d-dind
        id: meta-k3d-dind
        env:
          IMAGE_ID: k3d
          IMAGE_SUFFIX: "-dind"
        uses: docker/metadata-action@v3
        with:
          images: ${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_BASE_REPO }}/${{ env.IMAGE_ID }}
          github-token: ${{ secrets.GITHUB_TOKEN }}
          bake-target: docker-metadata-${{ env.IMAGE_ID }}${{ env.IMAGE_SUFFIX }}
          tags: |
            type=semver,pattern={{major}}
            type=semver,pattern={{major}}.{{minor}}
            type=semver,pattern={{version}}
            type=ref,event=branch
            type=ref,event=pr
            type=sha
          flavor: |
            suffix=${{ env.IMAGE_SUFFIX }}
      - name: Docker Metadata k3d-proxy
        id: meta-k3d-proxy
        env:
          IMAGE_ID: k3d-proxy
        uses: docker/metadata-action@v3
        with:
          images: ${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_BASE_REPO }}/${{ env.IMAGE_ID }}
          github-token: ${{ secrets.GITHUB_TOKEN }}
          bake-target: docker-metadata-${{ env.IMAGE_ID }}
          tags: |
            type=semver,pattern={{major}}
            type=semver,pattern={{major}}.{{minor}}
            type=semver,pattern={{version}}
            type=ref,event=branch
            type=ref,event=pr
            type=sha
      - name: Docker Metadata k3d-tools
        id: meta-k3d-tools
        env:
          IMAGE_ID: k3d-tools
        uses: docker/metadata-action@v3
        with:
          images: ${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_BASE_REPO }}/${{ env.IMAGE_ID }}
          github-token: ${{ secrets.GITHUB_TOKEN }}
          bake-target: docker-metadata-${{ env.IMAGE_ID }}
          tags: |
            type=semver,pattern={{major}}
            type=semver,pattern={{major}}.{{minor}}
            type=semver,pattern={{version}}
            type=ref,event=branch
            type=ref,event=pr
            type=sha
      - name: Merge Metadata Bake Definitions
        run: |
          INPUT=(${{ steps.meta-k3d-binary.outputs.bake-file }} ${{ steps.meta-k3d-dind.outputs.bake-file }} ${{ steps.meta-k3d-proxy.outputs.bake-file }} ${{ steps.meta-k3d-tools.outputs.bake-file }})
          OUT_FILE=./bake-metadata.json
          OUT_FILE_TMP=./bake-metadata-tmp.json

          cat << EOF > $OUT_FILE
          {
            "target": {}
          }
          EOF

          for file in "${INPUT[@]}"; do
            cat $OUT_FILE > $OUT_FILE_TMP
            jq -s '.[0] * .[1]' $OUT_FILE_TMP $file > $OUT_FILE
          done

          rm "$OUT_FILE_TMP"
      # Build and Push container images
      - name: Build Images
        uses: docker/bake-action@v2.3.0
        with:
          files: |
            ./docker-bake.hcl
            ./bake-metadata.json
          targets: release
          push: false
      # Wait for tests to pass and push images (ONLY ON TAG)
      - name: Wait for tests to succeed
        if: startsWith(github.ref, 'refs/tags/')
        uses: lewagon/wait-on-check-action@v1.3.4
        with:
          ref: ${{ github.ref }}
          check-name: "Full Test Suite"
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          wait-interval: 20
      - name: Push Images
        if: startsWith(github.ref, 'refs/tags/')
        uses: docker/bake-action@v2.3.0
        with:
          files: |
            ./docker-bake.hcl
            ./bake-metadata.json
          targets: release
          push: true

  release-github:
    name: Build & Release Binaries
    # Only run on tags
    runs-on: ubuntu-22.04
    steps:
      # Setup
      - uses: actions/checkout@v3
      - name: Setup Go environment
        uses: actions/setup-go@v3
        with:
          go-version: "${{ env.GO_VERSION }}"
      - name: Setup CI Tools
        run: make ci-setup
      # Go Build
      - name: Build k3d Binary
        run: make gen-checksum build-cross
      # Wait for tests to pass and create release (ONLY ON TAG)
      - name: Wait for tests to succeed
        if: startsWith(github.ref, 'refs/tags/')
        uses: lewagon/wait-on-check-action@v1.3.4
        with:
          ref: ${{ github.ref }}
          check-name: "Full Test Suite"
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          wait-interval: 20
      # Create Git Release
      - name: Extract Tag from Ref
        if: startsWith(github.ref, 'refs/tags/')
        id: tag
        run: echo VERSION=${GITHUB_REF/refs\/tags\//} >> $GITHUB_OUTPUT
        shell: bash
      - uses: apexskier/github-semver-parse@v1
        if: startsWith(github.ref, 'refs/tags/')
        id: semver
        with:
          version: ${{ steps.tag.outputs.VERSION }}
      - name: Create Release
        if: startsWith(github.ref, 'refs/tags/')
        uses: ncipollo/release-action@v1
        with:
          allowUpdates: true
          artifactErrorsFailBuild: true
          artifacts: _dist/*
          discussionCategory: releases
          generateReleaseNotes: true
          prerelease: ${{ steps.semver.outputs.prerelease != '' }}
          replacesArtifacts: true
          token: ${{ secrets.GITHUB_TOKEN }}