batect.yml

containers:
  build-env:
    build_directory: .batect/build-env
    volumes:
      - local: .
        container: /code
        options: cached
      - type: cache
        name: go-cache
        container: /go
      - type: cache
        name: golangci-cache
        container: /home/container-user/.cache/golangci-lint
    working_directory: /code
    environment:
      GOCACHE: /go/cache
    run_as_current_user:
      enabled: true
      home_directory: /home/container-user

  terraform:
    build_directory: .batect/terraform
    build_args:
      CLOUD_SDK_VERSION: <{cloudSdkVersion}
    volumes:
      - local: .
        container: /code
        options: cached
      - local: .gcloud
        container: /root/.config/gcloud
        options: cached
    working_directory: /code
    environment:
      GOOGLE_PROJECT: <{gcpProject}
      GOOGLE_REGION: <{gcpRegion}

  push-env:
    build_directory: .batect/push-env
    build_args:
      CLOUD_SDK_VERSION: <{cloudSdkVersion}
    volumes:
      - local: .
        container: /code
        options: cached
      - local: .gcloud
        container: /root/.config/gcloud
        options: cached
      - local: /var/run/docker.sock
        container: /var/run/docker.sock
    working_directory: /code
    environment:
      GOOGLE_PROJECT: <{gcpProject}
      GOOGLE_REGION: <{gcpRegion}

  app:
    build_directory: .batect/app
    volumes:
      - local: .creds/application_service_account_personal.json
        container: /creds/gcp.json
        options: ro
    environment:
      PORT: 8080
      GOOGLE_PROJECT: <{gcpProject}
      GOOGLE_APPLICATION_CREDENTIALS: /creds/gcp.json
      HONEYCOMB_API_KEY: <{honeycombAPIKey}

  cloud-storage:
    build_directory: .batect/fake-gcs-server

  observatory:
    build_directory: .batect/observatory

tasks:
  setup:
    description: Download all dependencies used by the application.
    group: Setup tasks
    run:
      container: build-env
      command: sh -c 'go mod download && go install github.com/onsi/ginkgo/v2/ginkgo'

  build:
    description: Build the application.
    group: Build tasks
    run:
      container: build-env
      command: go build -o .batect/app/updates ./server/cmd
      environment:
        CGO_ENABLED: 0
        GOOS: linux

  unitTest:
    description: Run the unit tests.
    group: Test tasks
    run:
      container: build-env
      command: ginkgo --skip-file='_integration_test.go$' -race -coverprofile=coverage.txt -covermode=atomic server/...

  continuousUnitTest:
    description: Run the unit tests, and re-run them when any code changes are detected.
    group: Test tasks
    run:
      container: build-env
      command: ginkgo watch --skip-file='_integration_test.go$' server/...

  integrationTest:
    description: Run the integration tests.
    group: Test tasks
    dependencies:
      - cloud-storage
    run:
      container: build-env
      command: ginkgo --focus-file='_integration_test.go$' server/...
      environment:
        STORAGE_EMULATOR_HOST: cloud-storage

  shell:
    description: Start a shell in the development environment.
    group: Utility tasks
    run:
      container: build-env
      command: bash

  run:
    description: Run the application.
    group: Test tasks
    prerequisites:
      - build
    run:
      container: app
      ports:
        - local: 8080
          container: 8080

  lint:
    description: Check for linting errors in Golang files.
    group: Linting tasks
    run:
      container: build-env
      command: golangci-lint run --timeout=5m server/...

  lintFix:
    description: Fix linting errors in Golang files.
    group: Linting tasks
    run:
      container: build-env
      command: golangci-lint run --fix server/...

  update:
    description: Update to latest minor or patch update of all dependencies.
    group: Dependency management tasks
    run:
      container: build-env
      command: sh -c 'go get -u && go mod tidy'

  setupTerraform:
    description: Initialise Terraform.
    group: Infrastructure management tasks
    run:
      container: terraform
      command: sh -c './scripts/generate_vars.sh && terraform init -input=false -reconfigure -backend-config="bucket=$GOOGLE_PROJECT-terraform-state" -backend-config="credentials=../.creds/gcp_service_account_${CLOUDSDK_ACTIVE_CONFIG_NAME}.json"'
      working_directory: /code/infra
      environment:
        CLOUDSDK_ACTIVE_CONFIG_NAME: <{gcpProject}
        ROOT_DOMAIN: <{rootDomain}
        SUBDOMAIN: <{subdomain}

  applyTerraform:
    description: Run Terraform to provision infrastructure.
    group: Infrastructure management tasks
    run:
      container: terraform
      command: sh -c "terraform apply -input=false -auto-approve && echo && ./scripts/wait_for_cloud_run.sh"
      working_directory: /code/infra
      environment:
        CLOUDSDK_ACTIVE_CONFIG_NAME: <{gcpProject}
        ROOT_DOMAIN: <{rootDomain}
        SUBDOMAIN: <{subdomain}

  planTerraform:
    description: Plan changes required to bring infrastructure to desired state.
    group: Infrastructure management tasks
    run:
      container: terraform
      command: terraform plan -input=false
      working_directory: /code/infra
      environment:
        CLOUDSDK_ACTIVE_CONFIG_NAME: <{gcpProject}

  destroyTerraform:
    description: Run Terraform to provision infrastructure.
    group: Infrastructure management tasks
    run:
      container: terraform
      command: terraform destroy -input=false -auto-approve
      working_directory: /code/infra
      environment:
        CLOUDSDK_ACTIVE_CONFIG_NAME: <{gcpProject}

  checkTerraformState:
    description: Check that the infrastructure matches the desired state.
    group: Infrastructure management tasks
    run:
      container: terraform
      command: terraform plan -detailed-exitcode -input=false -lock=false
      working_directory: /code/infra
      environment:
        CLOUDSDK_ACTIVE_CONFIG_NAME: <{gcpProject}

  terraformShell:
    description: Start a shell in the Terraform environment.
    group: Infrastructure management tasks
    run:
      container: terraform
      command: bash

  setupGCPServiceAccount:
    description: Store credentials used to access GCP when deploying the application.
    group: Setup tasks
    run:
      container: terraform
      command: scripts/setup_service_account.sh
      environment:
        GCP_SERVICE_ACCOUNT_EMAIL: $GCP_SERVICE_ACCOUNT_EMAIL
        GCP_SERVICE_ACCOUNT_KEY: $GCP_SERVICE_ACCOUNT_KEY
        CLOUDSDK_ACTIVE_CONFIG_NAME: <{gcpProject}

  lintTerraform:
    description: Check for linting errors in Terraform files.
    group: Linting tasks
    run:
      container: terraform
      command: terraform fmt -diff -check -recursive infra

  lintFixTerraform:
    description: Fix linting errors in Terraform files.
    group: Linting tasks
    run:
      container: terraform
      command: terraform fmt -recursive infra

  pushImage:
    description: Push the application image to GCP.
    group: Deployment tasks
    run:
      container: push-env
      command: ./infra/scripts/push_image.sh
      environment:
        CLOUDSDK_ACTIVE_CONFIG_NAME: <{gcpProject}

  setupCloudflareKey:
    description: Store credentials used to access Cloudflare when deploying the application.
    group: Infrastructure management tasks
    run:
      container: terraform
      command: sh -c "echo $CLOUDFLARE_KEY > .creds/cloudflare_key"
      environment:
        CLOUDFLARE_KEY: $CLOUDFLARE_KEY

  checkSecurity:
    description: Check HTTP security of deployed service.
    group: Test tasks
    run:
      container: observatory
      command: sh -c "observatory $DOMAIN --format report --zero --rescan --attempts 40 && observatory $DOMAIN --format report --min-grade A+ --min-score 100 --attempts 20"
      environment:
        DOMAIN: <{subdomain}.<{rootDomain}

  checkLicenseHeader:
    description: Check that all files have the required license header.
    group: Linting tasks
    run:
      container: build-env
      command: ./scripts/check_licenses.sh

  smokeTest:
    description: Run a smoke test against a deployed version of the service.
    group: Test tasks
    run:
      container: build-env
      command: go run ./scripts/smoketest
      environment:
        DOMAIN: <{subdomain}.<{rootDomain}

config_variables:
  gcpProject:
    description: GCP project to use.

  gcpRegion:
    default: us-central1

  cloudSdkVersion:
    default: 447.0.0

  rootDomain:
    description: Root domain name registered with Cloudflare.
    default: batect.dev

  subdomain:
    description: Subdomain (under rootDomain) to host the application at.

  honeycombAPIKey:
    description: API key used to upload traces to Honeycomb.