Taskfile.yml

version: '3'

vars:
  COMMAND_NAME: exasol
  BINARY_SUFFIX:
    sh: test "$(go env GOOS)" = "windows" && echo ".exe" || true
  BINARY_NAME: "{{.COMMAND_NAME}}{{.BINARY_SUFFIX}}"
  MAIN_PATH_REL: "./cmd/exasol"
  BUILD_DIR_NAME: "bin"
  ROOT_PATH: >-
    {{- if eq OS "windows" }}
      {{- .ROOT_DIR | replace "\\" "\\\\" }}
    {{- else }}
      {{- .ROOT_DIR }}
    {{- end }}
  SEP: '{{if eq OS "windows"}}\\{{else}}/{{end}}'
  BUILD_DIR: '{{.ROOT_PATH}}{{.SEP}}{{.BUILD_DIR_NAME}}'
  TESTS_DIR: '{{.ROOT_PATH}}{{.SEP}}tests'

includes:
  github: ./tasks/github.Taskfile.yml

tasks:
  default:
    silent: true
    cmds:
      - "task --list"

  generate:
    desc: 'Run generation for all packages. TARGET_GOOS/TARGET_GOARCH: also stage a non-host platform''s embedded resources. SKIP_EMBED=true: never fetch real embedded resource data, just write empty placeholders (for lint/test builds that never look at the bytes).'
    vars:
      TARGET_GOOS: '{{default "" .TARGET_GOOS}}'
      TARGET_GOARCH: '{{default "" .TARGET_GOARCH}}'
      SKIP_EMBED: '{{default "" .SKIP_EMBED}}'
    env:
      GOFLAGS: '-tags=containers_image_openpgp'
    cmds:
      # unset GOOS/GOARCH: an inherited value would cross-compile the
      # directives' own tool invocations instead of just running them
      # ("exec format error"). TARGET_GOOS/TARGET_GOARCH/SKIP_EMBED carry
      # the resourceembedder's own settings instead, without that side effect.
      - >-
        unset GOOS GOARCH;
        TARGET_GOOS="{{.TARGET_GOOS}}" TARGET_GOARCH="{{.TARGET_GOARCH}}" SKIP_EMBED="{{.SKIP_EMBED}}"
        go generate ./...

  tofu-lock-update:
    desc: Regenerate multi-platform .terraform.lock.hcl files (no temp files in assets)
    deps:
      - generate
    cmds:
      - >-
        go run ./tools/lockfileupdate/main.go
        -platform=linux_amd64
        -platform=linux_arm64
        -platform=windows_amd64
        -platform=darwin_amd64
        -platform=darwin_arm64

  # Using relative paths to build because on Windows the .ROOT_DIR
  # variable messes with path separators and results in incompatible
  # with Windows path.
  build:
    desc: 'Build the binary. COVERAGE=true enables coverage instrumentation.'
    # {{env "GOOS/GOARCH"}}: passes the ambient cross-compile target (if any)
    # through to generate's TARGET_GOOS/TARGET_GOARCH, so its embedded
    # resources are staged for that target rather than just the host.
    deps:
      - task: generate
        vars:
          TARGET_GOOS: '{{env "GOOS"}}'
          TARGET_GOARCH: '{{env "GOARCH"}}'
    vars:
      DEBUG_BUILD: '{{default "false" .DEBUG_BUILD}}'
      COVERAGE: '{{default "false" .COVERAGE}}'
    env:
      CGO_ENABLED: "0"
    cmds:
      - |
        version=$(git describe --tags --abbrev=0) # First character is "v".
        go build \
          -tags=containers_image_openpgp \
          -o {{.BUILD_DIR_NAME}}/{{.BINARY_NAME}} \
          {{if eq .COVERAGE "true"}}-cover -covermode=atomic {{end}}\
          {{if eq .DEBUG_BUILD "true"}}-gcflags="all=-N -l"{{else}}-trimpath \
          -gcflags=all=-l{{end}} \
          -ldflags "{{if ne .DEBUG_BUILD "true"}}-s -w {{end}}-X main.CurrentLauncherVersion=${version:1}" {{.MAIN_PATH_REL}}

  build-windows:
    desc: Cross-compile the Windows binary (defaults to GOARCH=amd64)
    vars:
      DEBUG_BUILD: '{{default "false" .DEBUG_BUILD}}'
      TARGET_GOARCH: '{{default "amd64" .GOARCH}}'
      OUTPUT_NAME: '{{.COMMAND_NAME}}.exe'
    deps:
      - task: generate
        vars:
          TARGET_GOOS: windows
          TARGET_GOARCH: '{{default "amd64" .GOARCH}}'
    env:
      GOOS: windows
      GOARCH: '{{.TARGET_GOARCH}}'
      CGO_ENABLED: "0"
    cmds:
      - |
        version=$(git describe --tags --abbrev=0) # First character is "v".
        go build -tags=containers_image_openpgp -o {{.BUILD_DIR_NAME}}/{{.OUTPUT_NAME}} \
          {{if eq .DEBUG_BUILD "true"}}-gcflags="all=-N -l"{{else}}-trimpath \
          -gcflags=all=-l{{end}} \
          -ldflags "{{if ne .DEBUG_BUILD "true"}}-s -w {{end}}-X main.CurrentLauncherVersion=${version:1}" {{.MAIN_PATH_REL}}


  deps-update-golang:
    desc: Update all Go dependencies
    cmds:
      - go get -u ./...

  deps-update-python:
    desc: Update all Python dependencies
    dir: '{{.USER_WORKING_DIR}}/{{.TESTS_DIR}}'
    cmds:
      - poetry update

  deps-update:
    desc: Update all Go dependencies
    deps:
      - deps-update-golang
      - deps-update-python

  deps-install-poetry:
    cmds:
      - python3 -m pip install poetry
    status:
      - which poetry

  tests-setup:
    desc: Install required test tools
    dir: '{{.TESTS_DIR}}'
    cmds:
      - poetry sync
    status:
      - poetry run ruff --version
      - poetry run mypy --version
    deps:
      - deps-install-poetry

  tests-unit:
    desc: 'Run unit tests. TEST is a regex for `go test -run` (substring match, e.g. TEST=Ready). COVERAGE=true collects a coverage profile.'
    deps:
      - task: generate
        vars:
          SKIP_EMBED: "true"
    vars:
      TEST: '{{default "" .TEST}}'
      COVERAGE: '{{default "false" .COVERAGE}}'
    cmds:
      - go test -v  -tags=containers_image_openpgp -race{{if eq .COVERAGE "true"}} -coverprofile=coverage-unit.out -covermode=atomic{{end}}{{if .TEST}} -run "{{.TEST}}"{{end}} ./...
      - '{{if eq .COVERAGE "true"}}go tool cover -func=coverage-unit.out{{end}}'

  tests-unit-find:
    desc: Find Go unit test names by wildcard on Linux (`task tests-unit-find TEST=*Ready*`)
    platforms:
      - linux
    vars:
      TEST: '{{default "*" .TEST}}'
    cmds:
      - |
        go test -tags=containers_image_openpgp -json ./... | jq -r 'select(.Action=="run") | .Test'

  tests-integration:
    desc: 'Run integration tests. COVERAGE=true collects Go coverage from the exasol binary.'
    deps: [tests-setup]
    dir: '{{.TESTS_DIR}}'
    vars:
      COVERAGE: '{{default "false" .COVERAGE}}'
      GOCOVERDIR_PATH: '{{.ROOT_PATH}}{{.SEP}}covdata-integration'
    env:
      GOCOVERDIR: '{{if eq .COVERAGE "true"}}{{.GOCOVERDIR_PATH}}{{end}}'
    cmds:
      - '{{if eq .COVERAGE "true"}}rm -rf {{.GOCOVERDIR_PATH}} && mkdir -p {{.GOCOVERDIR_PATH}}{{end}}'
      - poetry run pytest -vv --exasol-path={{.BUILD_DIR}}{{.SEP}}{{.BINARY_NAME}} {{.TESTS_DIR}}{{.SEP}}tests{{.SEP}}integration
      - '{{if eq .COVERAGE "true"}}go tool covdata textfmt -i={{.GOCOVERDIR_PATH}} -o={{.ROOT_PATH}}{{.SEP}}coverage-integration.out{{end}}'

  tests-deployment:
    desc: Run all cloud tests (deployment, e2e, chaos). Filter with `-k` via TEST, e.g. `task tests-deployment INFRA=aws TEST=test_stop_and_start`
    deps: [tests-setup]
    dir: '{{.TESTS_DIR}}'
    vars:
      INFRA: '{{default "aws" .INFRA}}'
      TEST: '{{default "" .TEST}}'
      STACKIT_PROJECT_ID: '{{default "" .STACKIT_PROJECT_ID}}'
      GOCOVERDIR_PATH: '{{.ROOT_PATH}}{{.SEP}}covdata-deployment'
    env:
      # The exasol binary is always built with COVERAGE=true in CI; without
      # GOCOVERDIR it prints a warning on every invocation that pollutes
      # stdout and breaks tests asserting exact output.
      GOCOVERDIR: '{{.GOCOVERDIR_PATH}}'
    cmds:
      - rm -rf {{.GOCOVERDIR_PATH}} && mkdir -p {{.GOCOVERDIR_PATH}}
      - |
        poetry run pytest -vv --exasol-path={{.BUILD_DIR}}{{.SEP}}{{.BINARY_NAME}} --infra={{.INFRA}} {{if .STACKIT_PROJECT_ID}}--stackit-project-id={{.STACKIT_PROJECT_ID}}{{end}} {{if .TEST}}-k "{{.TEST}}"{{end}} {{.TESTS_DIR}}{{.SEP}}tests{{.SEP}}deployment {{.TESTS_DIR}}{{.SEP}}tests{{.SEP}}e2e {{.TESTS_DIR}}{{.SEP}}tests{{.SEP}}chaos

  tests-deployment-infrastructure:
    desc: Run infrastructure-focused deployment tests
    deps: [tests-setup]
    dir: '{{.TESTS_DIR}}'
    vars:
      INFRA: '{{default "aws" .INFRA}}'
      STACKIT_PROJECT_ID: '{{default "" .STACKIT_PROJECT_ID}}'
      GOCOVERDIR_PATH: '{{.ROOT_PATH}}{{.SEP}}covdata-deployment'
    env:
      # See tests-deployment: avoids the GOCOVERDIR-not-set warning leaking into test output.
      GOCOVERDIR: '{{.GOCOVERDIR_PATH}}'
    cmds:
      - rm -rf {{.GOCOVERDIR_PATH}} && mkdir -p {{.GOCOVERDIR_PATH}}
      - |
        poetry run pytest -vv --exasol-path={{.BUILD_DIR}}{{.SEP}}{{.BINARY_NAME}} --infra={{.INFRA}} {{if .STACKIT_PROJECT_ID}}--stackit-project-id={{.STACKIT_PROJECT_ID}}{{end}} -m "infrastructure_e2e" {{.TESTS_DIR}}{{.SEP}}tests{{.SEP}}deployment {{.TESTS_DIR}}{{.SEP}}tests{{.SEP}}e2e {{.TESTS_DIR}}{{.SEP}}tests{{.SEP}}chaos

  tests-deployment-installation:
    desc: Run installation-focused end-to-end tests
    deps: [tests-setup]
    dir: '{{.TESTS_DIR}}'
    vars:
      INFRA: '{{default "aws" .INFRA}}'
      STACKIT_PROJECT_ID: '{{default "" .STACKIT_PROJECT_ID}}'
      GOCOVERDIR_PATH: '{{.ROOT_PATH}}{{.SEP}}covdata-deployment'
    env:
      # See tests-deployment: avoids the GOCOVERDIR-not-set warning leaking into test output.
      GOCOVERDIR: '{{.GOCOVERDIR_PATH}}'
    cmds:
      - rm -rf {{.GOCOVERDIR_PATH}} && mkdir -p {{.GOCOVERDIR_PATH}}
      - |
        poetry run pytest -vv --exasol-path={{.BUILD_DIR}}{{.SEP}}{{.BINARY_NAME}} --infra={{.INFRA}} {{if .STACKIT_PROJECT_ID}}--stackit-project-id={{.STACKIT_PROJECT_ID}}{{end}} -m "installation_e2e" {{.TESTS_DIR}}{{.SEP}}tests{{.SEP}}deployment {{.TESTS_DIR}}{{.SEP}}tests{{.SEP}}e2e {{.TESTS_DIR}}{{.SEP}}tests{{.SEP}}chaos

  tests-deployment-local:
    desc: Run local deployment tests on supported Linux, Windows, and macOS hosts
    deps: [tests-setup]
    dir: '{{.TESTS_DIR}}'
    vars:
      GOCOVERDIR_PATH: '{{.ROOT_PATH}}{{.SEP}}covdata-deployment'
    env:
      # See tests-deployment: avoids the GOCOVERDIR-not-set warning leaking into test output.
      GOCOVERDIR: '{{.GOCOVERDIR_PATH}}'
    cmds:
      - rm -rf {{.GOCOVERDIR_PATH}} && mkdir -p {{.GOCOVERDIR_PATH}}
      - poetry run pytest -vv --exasol-path={{.BUILD_DIR}}{{.SEP}}{{.BINARY_NAME}} --infra=local -m "local_e2e" {{.TESTS_DIR}}{{.SEP}}tests{{.SEP}}deployment {{.TESTS_DIR}}{{.SEP}}tests{{.SEP}}e2e {{.TESTS_DIR}}{{.SEP}}tests{{.SEP}}chaos

  lint-ruff:
    desc: Run ruff check
    cmds:
      - task: lint-ruff-check
      - task: lint-ruff-format

  lint-ruff-fix:
    desc: Run ruff check, format and apply automatic fixes
    cmds:
      - task: lint-ruff-check-fix
      - task: lint-ruff-format-fix

  lint-ruff-check:
    desc: Run ruff check
    deps:
      - tests-setup
    dir: '{{.TESTS_DIR}}'
    cmds:
      - poetry run ruff check

  lint-ruff-check-fix:
    desc: Run ruff check and apply automatic fixes
    deps:
      - tests-setup
    dir: '{{.TESTS_DIR}}'
    cmds:
      - poetry run ruff check --fix

  lint-ruff-format:
    desc: Run ruff format
    deps:
      - tests-setup
    dir: '{{.TESTS_DIR}}'
    cmds:
      - poetry run ruff format --check

  lint-ruff-format-fix:
    desc: Run ruff format and apply automatic fixes
    deps:
      - tests-setup
    dir: '{{.TESTS_DIR}}'
    cmds:
      - poetry run ruff format

  lint-mypy:
    desc: Run mypy check
    deps: [tests-setup]
    dir: '{{.TESTS_DIR}}'
    cmds:
      - poetry run mypy {{.TESTS_DIR}}

  lint-golang:
    desc: Run golangci-lint linters and verify go.mod/go.sum are tidy
    deps:
      - task: generate
        vars:
          SKIP_EMBED: "true"
    cmds:
      - go tool golangci-lint run ./...
      - go mod tidy
      - git diff --exit-code go.mod go.sum

  lint-golang-fix:
    desc: Run golangci-lint linters and apply automatic fixes
    deps:
      - task: generate
        vars:
          SKIP_EMBED: "true"
    cmds:
      - go tool golangci-lint run ./... --fix

  lint-terraform:
    desc: Run tflint for Terraform files within assets/infrastructure
    cmds:
      - go tool tflint --init
      - go tool tflint --recursive --format=default --chdir=./assets/infrastructure

  lint-licenses:
    desc: Run addlicense on check mode for all source files
    cmds:
      - go tool addlicense -l mit -c "Exasol AG" -check -s=only $(git ls-files '*.go' '*.py')

  lint-licenses-fix:
    desc: Run addlicense to add the correct license header for all source files
    cmds:
      - go tool addlicense -l mit -c "Exasol AG" -s=only $(git ls-files '*.go' '*.py')

  lint:
    desc: Run linters
    cmds:
      - task: lint-golang
      - task: lint-ruff
      - task: lint-mypy
      - task: lint-terraform
      - task: lint-licenses

  clean:
    desc: Clean build artifacts
    cmds:
      - rm -rf {{.BUILD_DIR}}
      - rm -f coverage-unit.out
      - rm -f coverage-integration.out
      - rm -rf covdata-integration
      - rm -rf coverage-integration-linux
      - rm -rf coverage-integration-windows

  fmt-golang:
    desc: Format Go code
    cmds:
      - task: lint-golang-fix

  fmt-ruff:
    desc: Format Python code with Ruff
    deps: [tests-setup]
    dir: '{{.TESTS_DIR}}'
    cmds:
      - poetry run ruff format
      - poetry run ruff check --fix

  fmt-terraform:
    desc: Format Terraform code with OpenTofu
    cmds:
      - go run -tags=containers_image_openpgp ./tools/tofu/main.go fmt -recursive assets/infrastructure

  fmt:
    desc: Format code
    deps:
      - fmt-golang
      - fmt-ruff
      - fmt-terraform

  all:
    desc: Run all tasks (lint, build, test)
    cmds:
      - task: lint
      - task: build
      - task: tests-unit
      - task: tests-integration