Taskfile.yml

---
version: '3'

# This Taskfile represents the primary control surface for developers interacting with
# this component.
#
# Primary "configure/build/deploy/test" tasks must be provided directly in this top level
# taskfile
#
# Infrequently used or pure sub-tasks should be in subservient taskfiles and included
# here.
#
# All tasks that are expected to be run directly by developers must have a meaningful
# 'desc' with all optional variables defined, in this file or in included files.
#
# All tasks that are internal sub-tasks only should have a meaningful 'summary'.
#
includes:
  codeqa:
    taskfile: ./taskfiles/Taskfile_codeqa.yml
  mocks:
    taskfile: ./taskfiles/Taskfile_mocks.yml
  azurite:
    taskfile: ./taskfiles/Taskfile_azurite.yml
    dir: ./taskfiles

tasks:

  default:
    desc: Default task lists all available tasks to run.
    cmds:
      - which task
      - |
        task --list

  environment:
    desc: Show environment and location of tools executables.
    cmds:
      - env | sort
      - which go

  precommit:
    desc: |
      format the source and run all the quality checks
      (Does not run unit tests)
    cmds:
      - task: codeqa:format
      - task: codeqa:lint
      - task: codeqa:modules

  build:
    desc: ensure go build works for all packages
    cmds:
      - go build -v ./...

  format:
    desc: format the code
    cmds:
      - task: codeqa:format

  lint:
    desc: run the linter
    cmds:
      - task: codeqa:lint

  go:modules:
    desc: ensure that go.mod is up to date
    cmds:
      - task: codeqa:modules

  test:unit:
    desc: run the tests
    cmds:
      - task: codeqa:unit-tests

  test:setup:
    desc: do all necessary cleanup and preparation for a test run
    cmds:
      - task: azurite:preflight