Taskfile.dist.yml

version: "3"

env:
  GOTOOLCHAIN: auto
  GOPROXY: https://proxy.golang.org,direct
  APP_VERSION:
    sh: echo -n "${APP_VERSION:-$(git rev-parse --short HEAD)-dev}"
  UID:
    sh: '{{if ne OS "windows"}}id -u{{end}}'
  GID:
    sh: '{{if ne OS "windows"}}id -g{{end}}'

dotenv: [".env"]

includes:
  docker: ./scripts/tasks/docker.yml
  batocera: ./scripts/tasks/batocera.yml
  bazzite: ./scripts/tasks/bazzite.yml
  chimeraos: ./scripts/tasks/chimeraos.yml
  libreelec: ./scripts/tasks/libreelec.yml
  linux: ./scripts/tasks/linux.yml
  mac: ./scripts/tasks/mac.yml
  mister: ./scripts/tasks/mister.yml
  mistex: ./scripts/tasks/mistex.yml
  recalbox: ./scripts/tasks/recalbox.yml
  replayos: ./scripts/tasks/replayos.yml
  retropie: ./scripts/tasks/retropie.yml
  steamos: ./scripts/tasks/steamos.yml
  windows: ./scripts/tasks/windows.yml
  cross-lint: ./scripts/tasks/cross-lint.yml
  zigcc: ./scripts/tasks/zigcc.yml

tasks:
  build:
    vars:
      APP_BIN: '{{default "zaparoo" .APP_BIN}}'
      BUILD_OS: "{{default OS .BUILD_OS}}"
      BUILD_ARCH: "{{default ARCH .BUILD_ARCH}}"
      PLATFORM: '{{default (OS | replace "darwin" "mac") .PLATFORM}}'
      BUILD_DIR: "_build/{{.PLATFORM}}_{{.BUILD_ARCH}}"
      EXTRA_LDFLAGS: "{{.EXTRA_LDFLAGS}}"
      EXTRA_TAGS: "{{.EXTRA_TAGS}}"
    env:
      GO111MODULE: on
      CGO_ENABLED: 1
      GOARCH: "{{.BUILD_ARCH}}"
      GOOS: "{{.BUILD_OS}}"
      CGO_LDFLAGS: "{{if not .NO_LIBNFC}}-lnfc -lusb{{end}}"
      PLATFORM: "{{.PLATFORM}}"
      CC: "{{.CC}}"
      CXX: "{{.CXX}}"
    cmds:
      - >-
        go build -trimpath
        -ldflags "-X 'github.com/ZaparooProject/zaparoo-core/v2/pkg/config.AppVersion=${APP_VERSION}'
        -linkmode external -extldflags
        '{{if not .NO_LIBNFC}}${CGO_LDFLAGS}{{end}}
        {{if not .NO_STATIC}}-static{{end}}'
        -s -w {{.EXTRA_LDFLAGS}}"
        -tags "netgo,osusergo,sqlite_omit_load_extension{{if .EXTRA_TAGS}},{{.EXTRA_TAGS}}{{end}}"
        -o "{{.BUILD_DIR}}/{{.APP_BIN}}"
        "./cmd/${PLATFORM}"

  clean:
    desc: Clean build artifacts (optionally specific platform/arch)
    vars:
      PLATFORM: '{{default "" .PLATFORM}}'
      ARCH: '{{default "" .ARCH}}'
      TARGET_DIR: "{{if and .PLATFORM .ARCH}}_build/{{.PLATFORM}}_{{.ARCH}}{{else if .PLATFORM}}_build/{{.PLATFORM}}_*{{else}}_build{{end}}"
    cmds:
      - '{{if eq OS "windows"}}powershell rm -Recurse -Force{{else}}rm -rf{{end}} {{.TARGET_DIR}}'

  hooks:install:
    desc: Install local pre-push validation hook
    cmds:
      - mkdir -p .git/hooks
      - |
        cat > .git/hooks/pre-push <<'HOOK'
        #!/usr/bin/env bash
        set -euo pipefail

        if [[ -n "$(git status --short)" ]]; then
          cat >&2 <<'MSG'
        pre-push: working tree has uncommitted changes before validation.
        Commit or stash them, then push again.
        MSG
          git status --short >&2
          exit 1
        fi

        printf 'pre-push: running task lint-fix\n'
        task lint-fix

        printf 'pre-push: running task test\n'
        task test

        printf 'pre-push: running task cross-lint:all\n'
        task cross-lint:all

        if [[ -n "$(git status --short)" ]]; then
          cat >&2 <<'MSG'
        pre-push: validation changed working tree.
        Review changes, commit them, then push again.
        MSG
          git status --short >&2
          exit 1
        fi

        printf 'pre-push: validation passed\n'
        HOOK
      - chmod +x .git/hooks/pre-push
      - echo "Installed .git/hooks/pre-push"

  test:
    desc: Run all tests
    vars:
      TEST_ARGS: '{{default "./..." .CLI_ARGS}}'
    cmds:
      - go test -race {{.TEST_ARGS}}

  fuzz:
    desc: Run fuzz tests (default 30s per test, use FUZZ_TIME to override)
    vars:
      FUZZ_TIME: '{{default "30s" .FUZZ_TIME}}'
    cmds:
      - |
        exit_code=0
        targets=(
          "FuzzParseToText ./pkg/readers/shared/ndef"
          "FuzzValidateNDEFMessage ./pkg/readers/shared/ndef"
          "FuzzExtractTLVPayload ./pkg/readers/shared/ndef"
          "FuzzParseTextPayload ./pkg/readers/shared/ndef"
          "FuzzParseURIPayload ./pkg/readers/shared/ndef"
          "FuzzParseFilenameToCanonicalTags ./pkg/database/tags"
          "FuzzExtractTags ./pkg/database/tags"
          "FuzzParseTitleFromFilename ./pkg/database/tags"
          "FuzzExtractSpecialPatterns ./pkg/database/tags"
          "FuzzParseLine ./pkg/readers/rs232barcode"
          "FuzzDecodeURIIfNeeded ./pkg/helpers"
          "FuzzIsValidExtension ./pkg/helpers"
          "FuzzFilenameFromPath ./pkg/helpers"
          "FuzzContainsControlChar ./pkg/helpers"
          "FuzzIsValidScheme ./pkg/helpers"
          "FuzzIsValidPort ./pkg/helpers"
          "FuzzGetPathExt ./pkg/helpers"
          "FuzzGetPathBase ./pkg/helpers"
          "FuzzGetPathDir ./pkg/helpers"
          "FuzzSplitCommand ./pkg/helpers"
          "FuzzParseVirtualPathStr ./pkg/helpers/virtualpath"
          "FuzzFindPath ./pkg/database/mediascanner"
          "FuzzProcessRequestObject ./pkg/api"
          "FuzzEstablishSession ./pkg/api/middleware"
          "FuzzStartSession ./pkg/api"
          "FuzzHandleRun ./pkg/api/methods"
          "FuzzRPCIDUnmarshalJSON ./pkg/api/models"
          "FuzzMQTTMessageHandler ./pkg/readers/mqtt"
          "FuzzParseMQTTPath ./pkg/readers/mqtt"
          "FuzzParseMQTTProtocol ./pkg/readers/mqtt"
          "FuzzAdvargsParse ./pkg/zapscript/advargs"
          "FuzzFetchWellKnown ./pkg/zapscript"
          "FuzzCheckMappingUID ./pkg/service"
          "FuzzCheckMappingText ./pkg/service"
          "FuzzCheckMappingData ./pkg/service"
        )
        for target in "${targets[@]}"; do
          func="${target%% *}"
          pkg="${target#* }"
          echo "=== ${func} (${pkg}) ==="
          if go test -run "^$" -fuzz="${func}" -fuzztime={{.FUZZ_TIME}} "./${pkg}"; then
            echo "PASS: ${func}"
          else
            echo "FAIL: ${func} in ${pkg}"
            exit_code=1
          fi
        done
        exit $exit_code

  lint:
    desc: Run golangci-lint
    cmds:
      - golangci-lint run ./...

  lint-fix:
    desc: Run golangci-lint with auto-fixes
    cmds:
      - golangci-lint run --fix ./...

  vulncheck:
    desc: Run govulncheck for security vulnerabilities
    cmds:
      - govulncheck ./...

  nilcheck:
    desc: Run nilaway for nil-pointer analysis
    cmds:
      - nilaway ./...

  deadlock:
    desc: Run tests with go-deadlock to detect lock ordering violations
    cmds:
      - go test -tags=deadlock -race -count=1 ./...

  mutesting:
    desc: Run mutation testing on a package
    cmds:
      - go-mutesting {{.CLI_ARGS}}

  # Benchmark workflow:
  #   1. task bench-baseline  (generates testdata/benchmarks/baseline.txt, commit this)
  #   2. make changes
  #   3. task bench-compare   (compares current vs committed baseline via benchstat)
  # Quick runs: task bench (count=3) or task bench-db (database only)
  bench:
    desc: Run all benchmarks
    cmds:
      - go test -run='^$' -bench=. -benchmem -count=3 -timeout=30m ./...

  bench-db:
    desc: Run database benchmarks only
    cmds:
      - go test -run='^$' -bench=. -benchmem -count=3 -timeout=20m ./pkg/database/...

  bench-baseline:
    desc: Generate benchmark baseline (commit the output)
    cmds:
      - bash -o pipefail -c 'go test -run="^$$" -bench=. -benchmem -count=6 -timeout=45m ./... | grep -E "^(Benchmark|goos:|goarch:|pkg:|cpu:)" | tee testdata/benchmarks/baseline.txt'

  bench-compare:
    desc: Compare current benchmarks against baseline (requires benchstat, install with go install golang.org/x/perf/cmd/benchstat@latest)
    cmds:
      - bash -o pipefail -c 'go test -run="^$$" -bench=. -benchmem -count=6 -timeout=45m ./... | grep -E "^(Benchmark|goos:|goarch:|pkg:|cpu:)" > /tmp/zaparoo-bench-current.txt'
      - benchstat testdata/benchmarks/baseline.txt /tmp/zaparoo-bench-current.txt

  get-logs:
    desc: Download and decode logs from Zaparoo API
    vars:
      ENDPOINT: '{{default "localhost:7497" .CLI_ARGS}}'
      UUID:
        sh: uuidgen
    cmds:
      - >-
        curl -X POST http://{{.ENDPOINT}}/api/v0.1
        -H "Content-Type: application/json"
        -d '{
          "jsonrpc": "2.0",
          "method": "settings.logs.download",
          "params": {},
          "id": "{{.UUID}}"
        }' | jq -r '.result.content' | base64 -d