Taskfile.yml

version: "3"

includes:
  enhanced:
    taskfile: ./Taskfile.ex.yml
    flatten: true

vars:
  DOCKER_ORG: ghcr.io/freefair
  DOCKER_SERVER: semaphore-ex
  DOCKER_RUNNER: semaphore-ex-runner
  DOCKER_CMD: docker
  CORE_REVISION:
    sh: git rev-parse HEAD
  ENHANCED_REVISION:
    sh: git rev-parse HEAD
  SOURCE_DATE_EPOCH:
    sh: git show -s --format=%ct HEAD

tasks:
  all:
    desc: Install, test and build Semaphore for local architecture
    cmds:
      - task: deps
      - task: test
      - task: build
        vars:
          GOOS: ""
          GOARCH: ""

  deps:
    desc: Install all build dependencies
    cmds:
      - task: deps:tools
      - task: deps:be
      - task: deps:fe

  deps:tools:
    desc: Installs required tools to build and publish
    vars:
      SWAGGER_VERSION: v0.30.5
      GORELEASER_VERSION: v2.11.2
      GOLINTER_VERSION: v2.13.2
    cmds:
      - go install github.com/go-swagger/go-swagger/cmd/swagger@latest
      - go install github.com/goreleaser/goreleaser/v2@{{ .GORELEASER_VERSION }}
      - go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@{{ .GOLINTER_VERSION }}
    dir: /tmp

  deps:be:
    desc: Vendor application dependencies
    cmds:
      - go work vendor

  deps:fe:
    desc: Installs nodejs requirements
    dir: web
    cmds:
      - npm ci

  build:
    desc: Build a full set of release binaries and packages
    cmds:
      - task: build:fe
      - task: build:be

  build:debug:
    desc: Build DEBUG server binary
    cmds:
      - >-
        env CGO_ENABLED=0 GOOS={{ .GOOS }} GOARCH={{ .GOARCH }}
        go build -trimpath -buildvcs=false -o bin/semaphore{{ if eq OS "windows" }}.exe{{ end }}
        -tags "netgo"
        -gcflags="all=-N -l"
        -ldflags "-X {{ .IMPORT }}/util.Ver={{ .VERSION }} -X {{ .IMPORT }}/util.Commit={{ .SHA }} -X {{ .IMPORT }}/util.Date={{ .DATE }} -X {{ .IMPORT }}/util.BuildEdition={{ .EDITION }} -X {{ .IMPORT }}/util.CoreRevision={{ .CORE_REVISION }} -X {{ .IMPORT }}/util.EnhancedRevision={{ .ENHANCED_REVISION }} -X {{ .IMPORT }}/util.EditionImplementation={{ .IMPLEMENTATION_VERSION }}" ./cli
    vars:
      EDITION: enhanced
      IMPLEMENTATION_VERSION:
        sh: echo "{{ .ENHANCED_REVISION }}" | cut -c1-12 | sed 's/^/enhanced-/'
      TAG:
        sh: git name-rev --name-only --tags --no-undefined HEAD 2>/dev/null || git rev-parse --abbrev-ref HEAD
      SHA:
        sh: git log --pretty=format:'%h' -n 1
      VERSION: "{{ if eq .GITHUB_REF_TYPE \"tag\" }}{{ .GITHUB_REF_NAME }}{{ else }}{{ .TAG }}{{ end }}"
      DATE: "{{ .SOURCE_DATE_EPOCH }}"
      IMPORT: "github.com/semaphoreui/semaphore"

  build:fe:
    desc: Build VueJS project
    dir: web
    sources:
      - src/*.*
      - src/**/*.*
      - public/index.html
      - public/favicon.ico
      - ../api-docs.yml
      - package.json
      - package-lock.json
      - babel.config.js
      - vue.config.js
    generates:
      - ../api/public/css/*.css
      - ../api/public/js/*.js
      - ../api/public/index.html
      - ../api/public/favicon.ico
    cmds:
      - >-
        {{ if eq OS "windows" }}set VUE_APP_SOURCE_MAP_MODE=none && {{ else }}env VUE_APP_SOURCE_MAP_MODE=none{{ end }}
        npm run build

  build:be:
    desc: Build server binary
    cmds:
      - >-
        {{ if eq OS "windows" }}set CGO_ENABLED=0 && GOOS={{ .GOOS }} && GOARCH={{ .GOARCH }} && {{ else }}env CGO_ENABLED=0 GOOS={{ .GOOS }} GOARCH={{ .GOARCH }}{{ end }}
        go build -trimpath -buildvcs=false -o bin/semaphore{{ if eq OS "windows" }}.exe{{ end }}
        -tags "netgo"
        -ldflags "-s -w -X {{ .IMPORT }}/util.Ver={{ .VERSION }} -X {{ .IMPORT }}/util.Commit={{ .SHA }} -X {{ .IMPORT }}/util.Date={{ .DATE }} -X {{ .IMPORT }}/util.BuildEdition={{ .EDITION }} -X {{ .IMPORT }}/util.CoreRevision={{ .CORE_REVISION }} -X {{ .IMPORT }}/util.EnhancedRevision={{ .ENHANCED_REVISION }} -X {{ .IMPORT }}/util.EditionImplementation={{ .IMPLEMENTATION_VERSION }}" ./cli
    vars:
      EDITION: enhanced
      IMPLEMENTATION_VERSION:
        sh: echo "{{ .ENHANCED_REVISION }}" | cut -c1-12 | sed 's/^/enhanced-/'
      TAG:
        sh: if [ -n "${SEMAPHORE_SOURCE_TAG:-}" ]; then printf '%s\n' "${SEMAPHORE_SOURCE_TAG}"; else git name-rev --name-only --tags --no-undefined HEAD 2>/dev/null || git rev-parse --abbrev-ref HEAD; fi
      SHA:
        sh: if [ -n "${SEMAPHORE_SOURCE_SHA:-}" ]; then printf '%s\n' "${SEMAPHORE_SOURCE_SHA}"; else git log --pretty=format:'%h' -n 1; fi
      VERSION: "{{ if eq .GITHUB_REF_TYPE \"tag\" }}{{ .GITHUB_REF_NAME }}{{ else }}{{ .TAG }}{{ end }}"
      DATE: "{{ .SOURCE_DATE_EPOCH }}"
      IMPORT: "github.com/semaphoreui/semaphore"

  docs:gen:
    desc: Regenerate the generated documentation reference pages from the source
    cmds:
      - go run ./tools/docsref -out docs/docs/reference/configuration.md
      - go run ./tools/clidocs -out docs/docs/reference/cli/commands.md

  docs:check:
    desc: Fail if the generated documentation pages are out of date
    cmds:
      - task: docs:gen
      - |
        # --porcelain rather than `diff --quiet` so that a brand new generated
        # page, which is untracked rather than modified, also fails the check.
        changed=$(git -C docs status --porcelain -- docs/reference)
        if [ -n "$changed" ]; then
          echo "The generated documentation reference is out of date."
          echo "Run 'task docs:gen' and commit docs/docs/reference."
          echo "$changed"
          exit 1
        fi

  lint:
    cmds:
      - task: lint:fe
      - task: lint:be

  lint:fe:
    dir: web
    cmds:
      - npm run lint

  lint:be:
    cmds:
      - golangci-lint run
      - swagger validate ./api-docs.yml

  test:
    cmds:
      - task: test:fe
      - task: test:be

  test:fe:
    dir: web
    cmds:
      - npm run test:unit

  test:be:
    desc: Run go code tests
    cmds:
      - go test -v -coverprofile=coverage.out ./...

  dredd:goodman:
    desc: Installs goodman which is required by dredd
    cmds:
      - go install github.com/snikch/goodman/cmd/goodman@latest

  dredd:deps:
    desc: Installs dredd dep for integration testing
    dir: web
    cmds:
      - npm install dredd@13.1.2

  dredd:hooks:
    desc: Compile required dredd hooks built
    dir: ./.dredd/hooks
    cmds:
      - go build -o ../compiled_hooks{{ if eq OS "windows" }}.exe{{ end }}

  dredd:test:
    desc: Run end to end test for API with dredd
    cmds:
      - go run ./tools/openapibundle
      - ./web/node_modules/.bin/dredd --config .dredd/dredd.testing.yml

  dredd:test:local:
    desc: Run end to end test for API with dredd
    cmds:
      - go run ./tools/openapibundle
      - ./web/node_modules/.bin/dredd --config .dredd/dredd.local.yml

  release:prod:
    desc: Create and publish a release
    vars:
      EDITION: enhanced
      IMPLEMENTATION_VERSION:
        sh: echo "{{ .ENHANCED_REVISION }}" | cut -c1-12 | sed 's/^/enhanced-/'
    cmds:
      - >-
        env BUILD_EDITION="{{ .EDITION }}"
        CORE_REVISION="{{ .CORE_REVISION }}"
        ENHANCED_REVISION="{{ .ENHANCED_REVISION }}"
        EDITION_IMPLEMENTATION="{{ .IMPLEMENTATION_VERSION }}"
        SOURCE_DATE_EPOCH="{{ .SOURCE_DATE_EPOCH }}"
        goreleaser release {{ .GORELEASER_ARGS }}

  release:test:
    desc: Create a local test release
    vars:
      EDITION: enhanced
      IMPLEMENTATION_VERSION:
        sh: echo "{{ .ENHANCED_REVISION }}" | cut -c1-12 | sed 's/^/enhanced-/'
    cmds:
      - >-
        env BUILD_EDITION="{{ .EDITION }}"
        CORE_REVISION="{{ .CORE_REVISION }}"
        ENHANCED_REVISION="{{ .ENHANCED_REVISION }}"
        EDITION_IMPLEMENTATION="{{ .IMPLEMENTATION_VERSION }}"
        SOURCE_DATE_EPOCH="{{ .SOURCE_DATE_EPOCH }}"
        goreleaser --auto-snapshot --clean --skip=sign

  docker:test:
    desc: Test containers by building, running, testing and deleting them
    deps:
      - task: docker:deps
    cmds:
      - task: docker:build
        vars:
          tag: test

      - task: docker:goss
      - task: docker:lint

      - "{{ .DOCKER_CMD }} rmi {{ .DOCKER_ORG }}/{{ .DOCKER_SERVER }}:test"
      - "{{ .DOCKER_CMD }} rmi {{ .DOCKER_ORG }}/{{ .DOCKER_RUNNER }}:test"

  docker:lint:
    desc: Lint all dockerfiles based on Hadolint
    deps:
      - task: docker:deps
    cmds:
      - task: docker:lint:server
      - task: docker:lint:runner

  docker:lint:server:
    desc: Lint server dockerfile based on Hadolint
    dir: deployment/docker/server
    cmds:
      - hadolint Dockerfile --ignore DL3018

  docker:lint:runner:
    desc: Lint runner dockerfile based on Hadolint
    dir: deployment/docker/runner
    cmds:
      - hadolint Dockerfile --ignore DL3018

  docker:goss:
    desc: Check if container contains defined files
    deps:
      - task: docker:deps
    cmds:
      - task: docker:goss:server
      - task: docker:goss:runner

  docker:goss:server:
    desc: Check if server contains defined files
    dir: deployment/docker/server
    env:
      GOSS_FILES_STRATEGY: cp
    cmds:
      - dgoss run -it "{{ .DOCKER_ORG }}/{{ .DOCKER_SERVER }}:test"

  docker:goss:runner:
    desc: Check if runner contains defined files
    dir: deployment/docker/runner
    env:
      GOSS_FILES_STRATEGY: cp
    cmds:
      - dgoss run -it "{{ .DOCKER_ORG }}/{{ .DOCKER_RUNNER }}:test"

  docker:build:
    desc: Build all defined images for Semaphore
    vars:
      tag: "{{ if .tag }}{{ .tag }}{{ else }}latest{{ end }}"
    cmds:
      - task: docker:build:server
        vars:
          tag: "{{ .tag }}"
      - task: docker:build:runner
        vars:
          tag: "{{ .tag }}"

  docker:build:debug:
    desc: Build an DEBUG image for Semaphore server
    vars:
      tag: "debug"
    cmds:
      - "{{ .DOCKER_CMD }} build -f deployment/docker/debug/Dockerfile -t {{ .DOCKER_ORG }}/{{ .DOCKER_SERVER }}:{{ .tag }} ."

  docker:build:server:
    desc: Build an image for Semaphore server
    vars:
      tag: "{{ if .tag }}{{ .tag }}{{ else }}latest{{ end }}"
    cmds:
      - "{{ .DOCKER_CMD }} build -f deployment/docker/server/Dockerfile -t {{ .DOCKER_ORG }}/{{ .DOCKER_SERVER }}:{{ .tag }} ."

  docker:build:runner:
    desc: Build an image for Semaphore runner
    vars:
      tag: "{{ if .tag }}{{ .tag }}{{ else }}latest{{ end }}"
    cmds:
      - "{{ .DOCKER_CMD }} build -f deployment/docker/runner/Dockerfile -t {{ .DOCKER_ORG }}/{{ .DOCKER_RUNNER }}:{{ .tag }} ."

  docker:push:
    desc: Push the images to registry
    cmds:
      - docker push {{ .DOCKER_ORG }}/{{ .DOCKER_SERVER }}:{{ .tag }}
      - docker push {{ .DOCKER_ORG }}/{{ .DOCKER_RUNNER }}:{{ .tag }}

  docker:deps:
    desc: Install docker testing dependencies
    vars:
      INSTALL_PATH: '{{ .INSTALL_PATH | default "/usr/local/bin" }}'
      REQUIRE_SUDO: '{{ .REQUIRE_SUDO | default "true" }}'
    cmds:
      - task: docker:deps:hadolint
        vars:
          INSTALL_PATH: "{{ .INSTALL_PATH }}"
          REQUIRE_SUDO: "{{ .REQUIRE_SUDO }}"
      - task: docker:deps:goss
        vars:
          INSTALL_PATH: "{{ .INSTALL_PATH }}"
          REQUIRE_SUDO: "{{ .REQUIRE_SUDO }}"
      - task: docker:deps:dgoss
        vars:
          INSTALL_PATH: "{{ .INSTALL_PATH }}"
          REQUIRE_SUDO: "{{ .REQUIRE_SUDO }}"

  docker:deps:hadolint:
    platforms:
      - linux/amd64
      - linux/arm64
      - darwin/amd64
      - darwin/arm64
    vars:
      HADOLINT_VERSION: v2.10.0
    status:
      - test -f "{{ .INSTALL_PATH }}/hadolint"
    cmds:
      - '{{ if eq .REQUIRE_SUDO "true" }}sudo {{ end }}curl -sSL https://github.com/hadolint/hadolint/releases/download/{{ .HADOLINT_VERSION }}/hadolint-{{ if eq OS "linux" }}Linux{{ end }}{{ if eq OS "darwin" }}Darwin{{ end }}-{{ if eq ARCH "amd64" }}x86_64{{ else }}{{ ARCH }}{{ end }} -o {{ .INSTALL_PATH }}/hadolint'
      - '{{ if eq .REQUIRE_SUDO "true" }}sudo {{ end }}chmod +x {{ .INSTALL_PATH }}/hadolint'

  docker:deps:goss:
    platforms:
      - linux
      - darwin
    vars:
      GOSS_VERSION: v0.3.5
    status:
      - test -f "{{ .INSTALL_PATH }}/goss"
    cmds:
      - '{{ if eq .REQUIRE_SUDO "true" }}sudo {{ end }}curl -sSL https://github.com/aelsabbahy/goss/releases/download/{{ .GOSS_VERSION }}/goss-{{ OS }}-{{ ARCH }} -o {{ .INSTALL_PATH }}/goss'
      - '{{ if eq .REQUIRE_SUDO "true" }}sudo {{ end }}chmod +x {{ .INSTALL_PATH }}/goss'

  docker:deps:dgoss:
    platforms:
      - linux
      - darwin
    vars:
      GOSS_VERSION: v0.3.5
    status:
      - test -f "{{ .INSTALL_PATH }}/dgoss"
    cmds:
      - '{{ if eq .REQUIRE_SUDO "true" }}sudo {{ end }}curl -sSL https://raw.githubusercontent.com/aelsabbahy/goss/{{ .GOSS_VERSION }}/extras/dgoss/dgoss -o {{ .INSTALL_PATH }}/dgoss'
      - '{{ if eq .REQUIRE_SUDO "true" }}sudo {{ end }}chmod +x {{ .INSTALL_PATH }}/dgoss'