Taskfile.yml

# Database Gateway provides access to servers with ACL for safe and restricted database interactions.
# Copyright (C) 2024  Kirill Zhuravlev
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

version: "3"

vars:
  PROJECT_NAME: database-gateway
  DEPS_COMPOSE_FILE: ./.cicd/local/docker-compose.yaml
  DOCKER_IMAGE_NAME: database-gateway
  GO_ENTRYPOINT: ./cmd/gateway
  FRONTEND_DIR: ./frontend
  FRONTEND_DIST: ./frontend/dist
  FRONTEND_EMBED_DIST: ./internal/facade/ui/dist
  HELM_CHART_DIR: ./charts/database-gateway
  HELM_DIST_DIR: ./dist/helm
  TOOLSET: "go run github.com/kazhuravlev/toolset/cmd/toolset@v0.40.0"
  GIT_TAG:
    sh: "gt t l -f tag"

tasks:
  run:
    cmds:
      - task: "frontend:build"
      - go run {{ .GO_ENTRYPOINT }} run

  deps:run:
    desc: Run all deps
    cmds:
      - docker compose -p {{ .PROJECT_NAME }} -f {{ .DEPS_COMPOSE_FILE }} up -d

  deps:logs:
    desc: Show all deps logs
    cmds:
      - docker compose -p {{ .PROJECT_NAME }} -f {{ .DEPS_COMPOSE_FILE }} logs -f

  deps:stop:
    desc: Stop all deps
    cmds:
      - docker compose -p {{ .PROJECT_NAME }} -f {{ .DEPS_COMPOSE_FILE }} stop

  deps:drop:
    desc: Stop all deps, remove volumes and other resources
    cmds:
      - docker compose -p {{ .PROJECT_NAME }} -f {{ .DEPS_COMPOSE_FILE }} down -v -t 0
      - docker volume list | grep {{ .PROJECT_NAME }} | awk '{print $2}' | xargs docker volume rm $1

  tools:install:
    cmds:
      - echo '>>> Run install tools'
      - "{{ .TOOLSET }} sync"

  lint:
    desc: Run static analysis
    cmds:
      - echo '>>> Run lint'
      - "{{ .TOOLSET }} run golangci-lint run --fix"

  fmt:
    desc: Safe formatting codebase
    cmds:
      - echo ">>> Run Code Formatter"
      - go fmt $(go list ./...)
      - "{{ .TOOLSET }} run gofumpt -l -w ."
      - "{{ .TOOLSET }} run goimports -d -w $(find . -type f -name '*.go' -not -path './.cicd/*')"

  migrations:new:
    desc: Create new migration
    cmds:
      - go run {{ .GO_ENTRYPOINT }} migrate-new

  migrations:up:
    desc: Up all migrations
    cmds:
      - go run {{ .GO_ENTRYPOINT }} migrate-up

  ci:lint:
    desc: Run linter in CI tool
    cmds:
      - task: tools:install
      - echo ">>> Run lint"
      - "{{ .TOOLSET }} run golangci-lint run"

  helm:lint:
    desc: Lint Helm chart
    cmds:
      - echo ">>> Helm lint"
      - helm lint {{ .HELM_CHART_DIR }}

  helm:build:
    desc: Package Helm chart
    cmds:
      - echo ">>> Helm build"
      - mkdir -p {{ .HELM_DIST_DIR }}
      - helm package {{ .HELM_CHART_DIR }} --destination {{ .HELM_DIST_DIR }}

  generate:
    desc: Generate code
    cmds:
      - task: "generate:go"
      - task: "generate:jet"
      - task: "generate:license"
      - task: "fmt"

  generate:jet:
    desc: Generate jet models
    cmds:
      - echo ">>> Jet generate"
      - go run {{ .GO_ENTRYPOINT }} jet-generate
      - rm -rf ./internal/storage/jetgen/{table,model}
      - mv ./internal/storage/jetgen/local__dbgw/public/* ./internal/storage/jetgen/
      - rm -rf ./internal/storage/jetgen/local__dbgw

  generate:license:
    cmds:
      - "{{ .TOOLSET }} run addlicense -f LICENSE_gplv3_header.txt ."

  frontend:deps:
    desc: Install frontend dependencies
    dir: '{{ .FRONTEND_DIR }}'
    cmds:
      - npm install

  frontend:dev:
    desc: Run frontend in dev mode with autoreload
    dir: '{{ .FRONTEND_DIR }}'
    env:
      VITE_BASE_PATH: /
    cmds:
      - npm run dev

  frontend:build:
    desc: Build frontend for /ui and sync dist to Go embed directory
    env:
      VITE_BASE_PATH: /ui/
    cmds:
      - task: "frontend:deps"
      - echo ">>> Build frontend"
      - cd {{ .FRONTEND_DIR }} && npm run build
      - echo ">>> Sync frontend dist into embed directory"
      - rm -rf {{ .FRONTEND_EMBED_DIST }}
      - mkdir -p {{ .FRONTEND_EMBED_DIST }}
      - cp -R {{ .FRONTEND_DIST }}/. {{ .FRONTEND_EMBED_DIST }}/

  generate:go:
    desc: Generate go
    cmds:
      - echo ">>> Go generate ./..."
      - go generate ./...

  check:
    desc: Run all project checks
    cmds:
      - task: "tools:install"
      - task: "deps:run"
      - task: "migrations:up"
      - task: "frontend:build"
      - task: "generate"
      - task: "fmt"
      - task: "lint"
      - task: "helm:lint"
      - task: "helm:build"
      - task: "test"

  test:
    cmds:
      - go test ./...

  docker:build:
    cmds:
      - echo ">>> Docker build"
      - |
        docker buildx build \
          --build-arg VERSION=local \
          -t {{ .DOCKER_IMAGE_NAME }}:{{.GIT_TAG}} \
          -f Dockerfile .