Taskfile.yaml

# https://taskfile.dev

version: "3"

silent: true

includes:
  vm-route-forge:
    taskfile: ./images/vm-route-forge
    dir: ./images/vm-route-forge
  virtualization-controller:
    aliases: [controller]
    taskfile: ./images/virtualization-artifact
    dir: ./images/virtualization-artifact
  gohooks:
    taskfile: ./images/hooks
    dir: ./images/hooks
  pvc-artifact:
    taskfile: ./images/pvc-artifact
    dir: ./images/pvc-artifact
  e2e:
    taskfile: ./test/e2e
    dir: ./test/e2e
  perf:
    taskfile: ./test/performance
    dir: ./test/performance
  d8v-cli:
    taskfile: ./src/cli
    dir: ./src/cli

vars:
  deckhouse_lib_helm_ver: 1.72.0
  TRIVY_VERSION: 0.55.0
  target: ""
  VALIDATION_FILES: "tools/validation/{main,messages,diff,no_cyrillic,doc_changes}.go"

  DLV_IMAGE:
    sh: if [ -z $DLV_IMAGE ]; then echo "ttl.sh/$(uuidgen | awk '{print tolower($0)}'):10m" ; else echo $DLV_IMAGE ; fi

tasks:
  go:sync:
    desc: "Sync module go.mod/go.sum files via go work sync. Use instead of go mod tidy."
    cmds:
      - go work sync

  check-werf:
    cmds:
      - which werf >/dev/null || (echo "werf not found."; exit 1)
    silent: true

  check-yq:
    cmds:
      - which yq >/dev/null || (echo "yq not found."; exit 1)
    silent: true

  check-jq:
    cmds:
      - which jq >/dev/null || (echo "jq not found."; exit 1)
    silent: true

  report:render:slowest:
    desc: "Render slowest-specs chart for one Describe (DESCRIBE=..., JSON=...)"
    silent: true
    vars:
      JSON: '{{.JSON | default ""}}'
      DESCRIBE: '{{.DESCRIBE | default ""}}'
      OUT_DIR: '{{.OUT_DIR | default "tmp"}}'
    cmds:
      - test -n "{{.JSON}}" || (echo "JSON=... is required"; exit 1)
      - test -n "{{.DESCRIBE}}" || (echo "DESCRIBE=... is required"; exit 1)
      - >-
        python3 .github/scripts/python/e2e_report/charts.py slowest
        --json "{{.JSON}}"
        --describe "{{.DESCRIBE}}" --out-dir "{{.OUT_DIR}}/charts"

  report:render:top-slowest:
    desc: "Render slowest-specs charts for top-N slowest Describes"
    silent: true
    vars:
      REPORTS_DIR: '{{.REPORTS_DIR | default "tmp/test-ci/report/out"}}'
      OUT_DIR: '{{.OUT_DIR | default "tmp"}}'
      TOP_N: "{{.TOP_N | default 5}}"
    cmds:
      - mkdir -p "{{.OUT_DIR}}" "{{.REPORTS_DIR}}"
      - >-
        python3 .github/scripts/python/e2e_report/charts.py top
        --reports-dir "{{.REPORTS_DIR}}"
        --out-dir "{{.OUT_DIR}}/charts"
        --top-n "{{.TOP_N}}"

  check-helm:
    cmds:
      - which helm >/dev/null || (echo "helm not found."; exit 1)
    silent: true

  golangci-lint:check:
    desc: "Check golangci-lint version"
    cmds:
      - |
        GOLANGCI_LINT_MIN_VERSION="2.0"
        CURRENT_VERSION=$(golangci-lint --version 2>/dev/null | grep -oP 'version \K[0-9]+\.[0-9]+' || echo "0.0")
        if [ "$(printf '%s\n' "$GOLANGCI_LINT_MIN_VERSION" "$CURRENT_VERSION" | sort -V | head -n1)" != "$GOLANGCI_LINT_MIN_VERSION" ]; then
          echo "golangci-lint version $CURRENT_VERSION is below minimum $GOLANGCI_LINT_MIN_VERSION"
          echo "Installing golangci-lint..."
          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin
        fi
    silent: true

  helm-update-subcharts:
    deps:
      - check-helm
    cmds:
      - |
        echo -e "Step 1: Add deckhouse Helm repo\n"
        helm repo add deckhouse https://deckhouse.github.io/lib-helm
        echo -e "\nStep 2: Update deckhouse Helm repo\n"
        helm repo update deckhouse
        echo -e "\nStep 3: Update dependencies\n"
        helm dep update

  helm-bump-helm-lib:
    deps:
      - check-yq
    cmds:
      - |
        lib_helm_ver=$(yq '.dependencies[] | select(.name == "deckhouse_lib_helm").version' Chart.yaml)
        echo lib_helm version before update: $lib_helm_ver && echo
      - yq -i '.dependencies[] |= select(.name == "deckhouse_lib_helm").version = "{{ .deckhouse_lib_helm_ver }}"' Chart.yaml
      - task: helm-update-subcharts
      - |
        lib_helm_ver=$(yq '.dependencies[] | select(.name == "deckhouse_lib_helm").version' Chart.yaml)
        echo && echo lib_helm version after update: $lib_helm_ver

  helm-render:
    deps:
      - check-helm
    cmds:
      - helm template virtualization . -f tools/kubeconform/fixtures/module-values.yaml --debug --devel > helm-template-render.yaml

  build:
    deps:
      - check-werf
    cmds:
      - werf build {{ .target }}

  dev:format:yaml:
    desc: "Format non-templated YAML files, e.g. CRDs"
    cmds:
      - |
        docker run --rm \
          -v ./:/tmp/virt ghcr.io/deckhouse/virtualization/prettier:3.2.5 \
          sh -c "cd /tmp/virt ; prettier -w \"**/*.yaml\" \"**/*.yml\""

  dev:addlicense:
    desc: |-
      Add Flant CE license to files sh,go,py. Default directory is root of project, custom directory path can be passed like: "task dev:addlicense -- <somedir>"
    cmds:
      - |
        {{if .CLI_ARGS}}
          go run tools/addlicense/{main,variables,msg,utils}.go -directory {{ .CLI_ARGS }}
        {{else}}
          go run tools/addlicense/{main,variables,msg,utils}.go -directory ./
        {{end}}

  golangci-lint:sync:
    desc: "Sync root .golangci.yaml to all subprojects"
    cmds:
      - |
        ROOT_CONFIG="images/virtualization-artifact/.golangci.yaml"
        TARGETS=(
          "images/hooks"
          "images/dvcr-artifact"
          "images/virtualization-dra"
          "src/cli"
          "test/e2e"
          "test/performance/tools/shatal"
          "tools/addlicense"
          "tools/moduleversions"
        )
        for target in "${TARGETS[@]}"; do
          cp "$ROOT_CONFIG" "$target/.golangci.yaml"
          echo "Synced $ROOT_CONFIG -> $target/.golangci.yaml"
        done

  lint:
    cmds:
      - task: lint:doc-ru
      - task: lint:prettier:yaml
      - task: lint:shellcheck
      - task: lint:actionlint
      - task: virtualization-controller:dvcr:lint
      - task: virtualization-controller:lint

  lint:shellcheck:
    desc: "Run shellcheck for CI shell scripts."
    cmds:
      - |
        set -e
        # The .gitlab/ci/scripts tree is split into bash/ and python/ folders,
        # so lint:shellcheck points directly at the bash folder (no find scan).
        EXPLICIT=".github/scripts/bash/e2e/*.sh
        .gitlab/ci/scripts/bash/*.sh
        .gitlab/ci/scripts/bash/lib/*.sh
        api/scripts/update-codegen.sh
        images/virtualization-artifact/hack/args.sh
        images/virtualization-artifact/hack/dlv.sh
        images/virtualization-artifact/hack/pyroscope.sh"
        EXPANDED="$(for f in $EXPLICIT; do [ -f "$f" ] && echo "$f"; done | sort -u)"
        if [ -z "$EXPANDED" ]; then
          echo "No shell scripts found to lint."; exit 0
        fi
        echo "==> shellcheck will scan $(printf '%s\n' "$EXPANDED" | wc -l | tr -d ' ') files:"
        printf '  %s\n' $EXPANDED
        echo "==> running shellcheck (koalaman/shellcheck-alpine:v0.11.0)"
        docker run --rm \
          -v "$PWD:/mnt" \
          -w /mnt \
          koalaman/shellcheck-alpine:v0.11.0 \
          shellcheck \
          $EXPANDED
        echo "==> shellcheck: no issues found"

  lint:actionlint:
    desc: "Run actionlint for E2E GitHub workflows."
    cmds:
      - |
        docker run --rm \
          -v "$PWD:/repo" \
          -w /repo \
          rhysd/actionlint:1.7.7 \
          -color \
          -shellcheck= \
          .github/workflows/e2e*.yml

  lint:doc-ru:
    desc: "Check the correspondence between description fields in the original crd and the Russian language version"
    cmds:
      - |
        docker run \
          --rm -it -v "$PWD:/src" docker.io/fl64/d8-doc-ru-linter:v0.0.1-dev0 \
          sh -c \
            'for crd in /src/crds/*.yaml; do [[ "$(basename "$crd")" =~ ^doc-ru ]] || (echo ${crd}; /d8-doc-ru-linter -s "$crd" -d "/src/crds/doc-ru-$(basename "$crd")" -n /dev/null); done'

  lint:prettier:yaml:
    desc: "Check if yaml files are prettier-formatted."
    cmds:
      - |
        docker run --rm \
          -v ./:/tmp/virt ghcr.io/deckhouse/virtualization/prettier:3.2.5 \
          sh -c "cd /tmp/virt ; prettier -c \"**/*.yaml\" \"**/*.yml\""

  validation:no-cyrillic:
    desc: "No cyrillic"
    cmds:
      - go run {{ .VALIDATION_FILES }} --type no-cyrillic

  validation:doc-changes:
    desc: "Doc-changes"
    cmds:
      - go run {{ .VALIDATION_FILES }} --type doc-changes

  validation:go-work:
    desc: "Check go.work sync freshness and replace consistency across modules"
    deps:
      - check-jq
    cmds:
      - task: go:sync
      - git diff --exit-code -- go.work.sum ':(glob)**/go.mod' ':(glob)**/go.sum'
      - ./hack/validate-go-work.sh

  validation:helm-templates:
    desc: "Check Helm templates"
    cmds:
      - |
        cd tools/kubeconform
        ./kubeconform.sh

  dlv:kubevirt:build:
    internal: true
    desc: "Clone-and-build a kubevirt fork component with dlv (COMPONENT var)"
    cmds:
      - |
        BRANCH="${BRANCH:-$(yq '.core.kubevirt' build/components/versions.yml)}"
        if ! LSOUT=$(git ls-remote "ssh://git@fox.flant.com/deckhouse/virtualization/fork/kubevirt.git" "refs/heads/${BRANCH}" "refs/tags/${BRANCH}"); then
          echo "git ls-remote to fox failed — ssh agent locked? Try: ssh-add ~/.ssh/id_rsa" >&2; exit 1
        fi
        COMMIT=$(echo "$LSOUT" | head -1 | cut -f1)
        if [ -z "$COMMIT" ]; then echo "No branch or tag '${BRANCH}' on the fox kubevirt fork" >&2; exit 1; fi
        docker build --ssh default --build-arg BRANCH="$BRANCH" --build-arg COMMIT="$COMMIT" -f ./images/{{ .COMPONENT }}/debug/dlv.Dockerfile -t "{{ .DLV_IMAGE }}" --platform linux/amd64 .

  dlv:virt-controller:build:
    desc: "Build image virt-controller with dlv (clones the kubevirt fork from fox via the host ssh agent)"
    cmds:
      - task: dlv:kubevirt:build
        vars: { COMPONENT: virt-controller }

  dlv:virt-controller:build-push:
    desc: "Build and Push image virt-controller with dlv"
    cmds:
      - task: dlv:virt-controller:build
      - docker push "{{ .DLV_IMAGE }}"
      - task: dlv:virt-controller:print

  dlv:virt-controller:print:
    desc: "Print commands for debug"
    env:
      IMAGE: "{{ .DLV_IMAGE }}"
    cmd: |
      cat <<EOF
      kubectl patch mc virtualization --type merge --patch '{"spec":{"maintenance":"NoResourceReconciliation"}}'
      kubectl -n d8-virtualization scale deploy virt-operator --replicas=0
      kubectl -n d8-virtualization patch deploy virt-controller --type='strategic' -p '{
        "spec": {
          "template": {
            "spec": {
              "containers": [
                {
                  "name": "virt-controller",
                  "image": "${IMAGE}",
                  "ports": [ { "containerPort": 2345, "name": "dlv" } ],
                  "readinessProbe": null,
                  "livenessProbe": null,
                  "command": null
                }
              ]
            }
          }
        }
      }'
      kubectl -n d8-virtualization port-forward deploy/virt-controller 2345:2345
      EOF

  dlv:virt-handler:build:
    desc: "Build image virt-handler with dlv (clones the kubevirt fork from fox via the host ssh agent)"
    cmds:
      - task: dlv:kubevirt:build
        vars: { COMPONENT: virt-handler }

  dlv:virt-handler:build-push:
    desc: "Build and Push image virt-handler with dlv"
    cmds:
      - task: dlv:virt-handler:build
      - docker push "{{ .DLV_IMAGE }}"
      - task: dlv:virt-handler:print

  dlv:virt-handler:print:
    desc: "Print commands for debug"
    env:
      IMAGE: "{{ .DLV_IMAGE }}"
    cmd: |
      cat <<EOF
      kubectl patch mc virtualization --type merge --patch '{"spec":{"maintenance":"NoResourceReconciliation"}}'
      kubectl -n d8-virtualization scale deploy virt-operator --replicas=0
      kubectl -n d8-virtualization patch ds virt-handler --type='strategic' -p '{
        "spec": {
          "template": {
            "spec": {
              "containers": [
                {
                  "name": "virt-handler",
                  "image": "${IMAGE}",
                  "ports": [ { "containerPort": 2345, "name": "dlv" } ],
                  "readinessProbe": null,
                  "livenessProbe": null,
                  "command": null
                }
              ]
            }
          }
        }
      }'
      kubectl -n d8-virtualization port-forward pod/<virt-handler-pod> 2345:2345
      EOF

  dlv:virt-api:build:
    desc: "Build image virt-api with dlv (clones the kubevirt fork from fox via the host ssh agent)"
    cmds:
      - task: dlv:kubevirt:build
        vars: { COMPONENT: virt-api }

  dlv:virt-api:build-push:
    desc: "Build and Push image virt-api with dlv"
    cmds:
      - task: dlv:virt-api:build
      - docker push "{{ .DLV_IMAGE }}"
      - task: dlv:virt-api:print

  dlv:virt-api:print:
    desc: "Print commands for debug"
    env:
      IMAGE: "{{ .DLV_IMAGE }}"
    cmd: |
      cat <<EOF
      kubectl patch mc virtualization --type merge --patch '{"spec":{"maintenance":"NoResourceReconciliation"}}'
      kubectl -n d8-virtualization scale deploy virt-operator --replicas=0
      kubectl -n d8-virtualization patch deploy virt-api --type='strategic' -p '{
        "spec": {
          "template": {
            "spec": {
              "containers": [
                {
                  "name": "virt-api",
                  "image": "${IMAGE}",
                  "ports": [ { "containerPort": 2345, "name": "dlv" } ],
                  "readinessProbe": null,
                  "livenessProbe": null,
                  "command": null
                },
                {
                  "name": "proxy",
                  "readinessProbe": null,
                  "livenessProbe": null
                },
                {
                  "name": "kube-rbac-proxy",
                  "readinessProbe": null,
                  "livenessProbe": null
                }
              ]
            }
          }
        }
      }'
      kubectl -n d8-virtualization port-forward deploy/virt-api 2345:2345
      EOF

  dlv:virtualization-dra-usb:build:
    desc: "Build image virtualization-dra-usb with dlv (binary is cross-built on the host in workspace mode)"
    cmds:
      - GOOS=linux GOARCH=amd64 go install github.com/go-delve/delve/cmd/dlv@latest
      - mkdir -p images/virtualization-dra-usb/debug/out
      - |
        DLV_SRC="$(go env GOPATH)/bin/linux_amd64/dlv"
        [ -f "$DLV_SRC" ] || DLV_SRC="$(go env GOPATH)/bin/dlv"
        cp "$DLV_SRC" images/virtualization-dra-usb/debug/out/dlv
      - GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -gcflags "all=-N -l" -o images/virtualization-dra-usb/debug/out/virtualization-dra-usb ./images/virtualization-dra/cmd/usb/dra
      - docker build -f ./images/virtualization-dra-usb/debug/dlv.Dockerfile -t "{{ .DLV_IMAGE }}" --platform linux/amd64 .

  dlv:virtualization-dra-usb:build-push:
    desc: "Build and Push image virtualization-dra-usb with dlv"
    cmds:
      - task: dlv:virtualization-dra-usb:build
      - docker push "{{ .DLV_IMAGE }}"
      - task: dlv:virtualization-dra-usb:print

  dlv:virtualization-dra-usb:print:
    desc: "Print commands for debug"
    env:
      IMAGE: "{{ .DLV_IMAGE }}"
    cmd: |
      cat <<EOF
      kubectl patch mc virtualization --type merge --patch '{"spec":{"maintenance":"NoResourceReconciliation"}}'
      kubectl -n d8-virtualization patch ds virtualization-dra --type='strategic' -p '{
        "spec": {
          "template": {
            "spec": {
              "containers": [ {
                "name": "virtualization-dra",
                "image": "${IMAGE}",
                "ports": [ { "containerPort": 2345, "name": "dlv" } ]
              }]
            }
          }
        }
      }'
      kubectl -n d8-virtualization port-forward pod/<virtualization-dra-pod> 2345:2345
      EOF