test: setup initial github workflow for raft

Signed-off-by: Benjamin Wang <[email protected]>

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '20 14 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'go' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

.github/workflows/govuln.yaml

@@ -0,0 +1,12 @@
+name: Go Vulnerability Checker
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: "1.19.3"
+      - run: date
+      - run: go install golang.org/x/vuln/cmd/govulncheck@latest && govulncheck ./...

.github/workflows/static-analysis.yaml

@@ -0,0 +1,19 @@
+name: Static Analysis
+on: [push, pull_request]
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: "1.19.3"
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.49.0
+      - name: protoc
+        uses: arduino/setup-protoc@v1
+        with:
+          version: '3.14.0'
+      - run: make verify

.github/workflows/test.yaml

@@ -0,0 +1,13 @@
+name: Static Analysis
+on: [push, pull_request]
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: "1.19.3"
+      # TODO(ahrtr): add test matrix for different platform and ARCH
+      - run: make test
+

.golangci.yaml

@@ -0,0 +1,41 @@
+run:
+  timeout: 30m
+  skip-files:
+    - "^zz_generated.*"
+
+issues:
+  max-same-issues: 0
+  # Excluding configuration per-path, per-linter, per-text and per-source
+  exclude-rules:
+    # exclude ineffassing linter for generated files for conversion
+    - path: conversion\.go
+      linters:
+        - ineffassign
+
+linters:
+  disable-all: true
+  enable: # please keep this alphabetized
+  # Don't use soon to deprecated[1] linters that lead to false
+  # https://github.com/golangci/golangci-lint/issues/1841
+  # - deadcode
+  # - structcheck
+  # - varcheck
+    - goimports
+    - ineffassign
+    - revive
+    - staticcheck
+    - stylecheck
+    - unused
+    - unconvert # Remove unnecessary type conversions
+
+linters-settings: # please keep this alphabetized
+  goimports:
+    local-prefixes: go.etcd.io # Put imports beginning with prefix after 3rd-party packages.
+  staticcheck:
+    checks:
+      - "all"
+      - "-SA1019" # TODO(fix) Using a deprecated function, variable, constant or field
+      - "-SA2002"  # TODO(fix) Called testing.T.FailNow or SkipNow in a goroutine, which isn’t allowed
+  stylecheck:
+    checks:
+      - "ST1019"  # Importing the same package multiple times.

Makefile

@@ -0,0 +1,25 @@
+
+.PHONY: verify
+verify: verify-gofmt verify-dep verify-lint verify-mod-tidy
+
+.PHONY: verify-gofmt
+verify-gofmt:
+	PASSES="gofmt" ./scripts/test.sh
+
+.PHONY: verify-dep
+verify-dep:
+	PASSES="dep" ./scripts/test.sh
+
+.PHONY: verify-lint
+verify-lint:
+	golangci-lint run
+
+.PHONY: verify-mod-tidy
+verify-mod-tidy:
+	PASSES="mod_tidy" ./scripts/test.sh
+
+
+.PHONY: test
+test:
+	go test ./...
+

scripts/fix.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+set -eo pipefail
+
+source ./scripts/test_lib.sh
+
+function mod_tidy_fix {
+  rm ./go.sum
+  go mod tidy || return 2
+}
+
+function go_fmt_fix {
+  go fmt -n . || return 2
+}
+
+log_callout -e "\\nFixing raft code for you...\\n"
+
+mod_tidy_fix || exit 2
+go_fmt_fix || exit 2
+
+log_success -e "\\nSUCCESS: raft code is fixed :)"
+

scripts/test.sh

@@ -0,0 +1,116 @@
+#!/usr/bin/env bash
+
+set -eo pipefail
+
+source ./scripts/test_lib.sh
+
+######### Code formatting checkers #############################################
+
+# generic_checker [cmd...]
+# executes given command in the current module, and clearly fails if it
+# failed or returned output.
+function generic_checker {
+  local cmd=("$@")
+  if ! output=$("${cmd[@]}"); then
+    echo "${output}"
+    log_error -e "FAIL: '${cmd[*]}' checking failed (!=0 return code)"
+    return 255
+  fi
+  if [ -n "${output}" ]; then
+    echo "${output}"
+    log_error -e "FAIL: '${cmd[*]}' checking failed (printed output)"
+    return 255
+  fi
+}
+
+function go_fmt_for_package {
+  # We utilize 'go fmt' to find all files suitable for formatting,
+  # but reuse full power gofmt to perform just RO check.
+  go fmt -n . | sed 's| -w | -d |g' | sh
+}
+
+function gofmt_pass {
+  generic_checker go_fmt_for_package
+}
+
+######## VARIOUS CHECKERS ######################################################
+
+function dump_deps_of_module() {
+  local module
+  if ! module=$(go list -m); then
+    return 255
+  fi
+  go list -f "{{if not .Indirect}}{{if .Version}}{{.Path}},{{.Version}},${module}{{end}}{{end}}" -m all
+}
+
+# Checks whether dependencies are consistent across modules
+function dep_pass {
+  local all_dependencies
+  all_dependencies=$(dump_deps_of_module | sort) || return 2
+
+  local duplicates
+  duplicates=$(echo "${all_dependencies}" | cut -d ',' -f 1,2 | sort | uniq | cut -d ',' -f 1 | sort | uniq -d) || return 2
+
+  for dup in ${duplicates}; do
+    log_error "FAIL: inconsistent versions for depencency: ${dup}"
+    echo "${all_dependencies}" | grep "${dup}" | sed "s|\\([^,]*\\),\\([^,]*\\),\\([^,]*\\)|  - \\1@\\2 from: \\3|g"
+  done
+  if [[ -n "${duplicates}" ]]; then
+    log_error "FAIL: inconsistent dependencies"
+    return 2
+  else
+    log_success "SUCCESS: dependencies are consistent across modules"
+  fi
+}
+
+function mod_tidy_for_module {
+  # Watch for upstream solution: https://github.com/golang/go/issues/27005
+  local tmpModDir
+  tmpModDir=$(mktemp -d -t 'tmpModDir.XXXXXX')
+  cp "./go.mod" "${tmpModDir}" || return 2
+
+  # Guarantees keeping go.sum minimal
+  # If this is causing too much problems, we should
+  # stop controlling go.sum at all.
+  rm go.sum
+  go mod tidy || return 2
+
+  set +e
+  local tmpFileGoModInSync
+  diff -C 5 "${tmpModDir}/go.mod" "./go.mod"
+  tmpFileGoModInSync="$?"
+
+  # Bring back initial state
+  mv "${tmpModDir}/go.mod" "./go.mod"
+
+  if [ "${tmpFileGoModInSync}" -ne 0 ]; then
+    log_error "${PWD}/go.mod is not in sync with 'go mod tidy'"
+    return 255
+  fi
+}
+
+function mod_tidy_pass {
+  mod_tidy_for_module
+}
+
+########### MAIN ###############################################################
+
+function run_pass {
+  local pass="${1}"
+  shift 1
+  log_callout -e "\\n'${pass}' started at $(date)"
+  if "${pass}_pass" "$@" ; then
+    log_success "'${pass}' completed at $(date)"
+  else
+    log_error "FAIL: '${pass}' failed at $(date)"
+    exit 255
+  fi
+}
+
+log_callout "Starting at: $(date)"
+for pass in $PASSES; do
+  run_pass "${pass}" "${@}"
+done
+
+log_success "SUCCESS"
+

scripts/test_lib.sh

@@ -0,0 +1,50 @@
+#!/usr/bin/env bash
+
+####   Convenient IO methods #####
+
+COLOR_RED='\033[0;31m'
+COLOR_ORANGE='\033[0;33m'
+COLOR_GREEN='\033[0;32m'
+COLOR_LIGHTCYAN='\033[0;36m'
+COLOR_BLUE='\033[0;94m'
+COLOR_MAGENTA='\033[95m'
+COLOR_BOLD='\033[1m'
+COLOR_NONE='\033[0m' # No Color
+
+
+function log_error {
+  >&2 echo -n -e "${COLOR_BOLD}${COLOR_RED}"
+  >&2 echo "$@"
+  >&2 echo -n -e "${COLOR_NONE}"
+}
+
+function log_warning {
+  >&2 echo -n -e "${COLOR_ORANGE}"
+  >&2 echo "$@"
+  >&2 echo -n -e "${COLOR_NONE}"
+}
+
+function log_callout {
+  >&2 echo -n -e "${COLOR_LIGHTCYAN}"
+  >&2 echo "$@"
+  >&2 echo -n -e "${COLOR_NONE}"
+}
+
+function log_cmd {
+  >&2 echo -n -e "${COLOR_BLUE}"
+  >&2 echo "$@"
+  >&2 echo -n -e "${COLOR_NONE}"
+}
+
+function log_success {
+  >&2 echo -n -e "${COLOR_GREEN}"
+  >&2 echo "$@"
+  >&2 echo -n -e "${COLOR_NONE}"
+}
+
+function log_info {
+  >&2 echo -n -e "${COLOR_NONE}"
+  >&2 echo "$@"
+  >&2 echo -n -e "${COLOR_NONE}"
+}
+