presubmit.sh

#!/bin/bash
#
# Presubmit checks for Trillian.
#
# Checks for lint errors, spelling, licensing, correct builds / tests and so on.
# Flags may be specified to allow suppressing of checks or automatic fixes, try
# `scripts/presubmit.sh --help` for details.
#
# Globals:
#   GO_TEST_TIMEOUT: timeout for 'go test'. Optional (defaults to 5m).
set -eu

check_pkg() {
  local cmd="$1"
  local pkg="$2"
  check_cmd "$cmd" "try running 'go get -u $pkg'"
}

check_cmd() {
  local cmd="$1"
  local msg="$2"
  if ! type -p "${cmd}" > /dev/null; then
    echo "${cmd} not found, ${msg}"
    return 1
  fi
}

usage() {
  echo "$0 [--coverage] [--fix] [--no-mod-tidy] [--no-build] [--no-linters] [--no-generate] [--empty-diff]"
}

main() {
  local coverage=0
  local fix=0
  local run_mod_tidy=1
  local run_build=1
  local run_lint=1
  local run_generate=1
  local empty_diff=0
  while [[ $# -gt 0 ]]; do
    case "$1" in
      --coverage)
        coverage=1
        ;;
      --fix)
        fix=1
        ;;
      --no-mod-tidy)
        run_mod_tidy=0
        ;;
      --help)
        usage
        exit 0
        ;;
      --no-build)
        run_build=0
        ;;
      --no-linters)
        run_lint=0
        ;;
      --no-generate)
        run_generate=0
        ;;
      --empty-diff)
        empty_diff=1
        ;;
      *)
        usage
        exit 1
        ;;
    esac
    shift 1
  done

  cd "$(dirname "$0")"  # at scripts/
  cd ..  # at top level

  go_srcs="$(find . -name '*.go' | \
    grep -v mock_ | \
    grep -v .pb.go | \
    grep -v _string.go | \
    grep -v .shims.go | \
    tr '\n' ' ')"

  # Prevent the creation of proto files with .txt extensions.
  bad_protos="$(find . -name '*.pb.txt' -o -name '*.proto.txt' -print)"
  if [[ "${bad_protos}" != "" ]]; then
    echo "Text-based protos must use the .textproto extension:"
    echo $bad_protos
    exit 1
  fi

  if [[ "$fix" -eq 1 ]]; then
    check_pkg goimports golang.org/x/tools/cmd/goimports || exit 1

    echo 'running gofmt'
    gofmt -s -w ${go_srcs}
    echo 'running goimports'
    goimports -w ${go_srcs}
    if [[ "$run_mod_tidy" -eq 1 ]]; then
      echo 'running go mod tidy'
      go mod tidy
    fi
  fi

  if [[ "${run_build}" -eq 1 ]]; then
    echo 'running go build'
    go build ./...

    export TEST_FLAGS="-timeout=${GO_TEST_TIMEOUT:-5m}"

    if [[ ${coverage} -eq 1 ]]; then
      TEST_FLAGS+=" -covermode=atomic -coverprofile=coverage.txt"
    fi

    echo "running go test ${TEST_FLAGS} ./..."
    go test ${TEST_FLAGS} ./...
  fi

  if [[ "${run_lint}" -eq 1 ]]; then
    check_cmd golangci-lint \
      'have you installed github.com/golangci/golangci-lint?' || exit 1

    echo 'running golangci-lint'
    golangci-lint run --deadline=8m
    echo 'checking license headers'
    ./scripts/check_license.sh ${go_srcs}
  fi

  if [[ "${run_generate}" -eq 1 ]]; then
    check_cmd protoc 'have you installed protoc?'
    check_pkg mockgen github.com/golang/mock/mockgen || exit 1
    check_pkg stringer golang.org/x/tools/cmd/stringer || exit 1

    echo 'running go generate'
    go generate -run="protoc" ./...
    go generate -run="mockgen" ./...
    go generate -run="stringer" ./...
  fi

  if [[ "${empty_diff}" -eq 1 ]]; then
    echo 'checking git diff is empty'
    git diff --exit-code
  fi
}

main "$@"