Add pre-commit hooks and improve Makefile for #15 (#23)

* add pre-commit hook script

* add Makefile targets and readme instructions

* add badges to README

* update action options

* verify failing unit test fails action

* fix test

* document the makefile in README

Author: camerondurham

.github/workflows/golang-ci-lint.yaml

@@ -0,0 +1,33 @@
+name: Go Lint
+on:
+  push:
+    tags:
+      - v*
+    branches:
+      - master
+      - main
+  pull_request:
+permissions:
+  contents: read
+  # Optional: allow read access to pull request. Use with `only-new-issues` option.
+  # pull-requests: read
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v2
+        with:
+          # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
+          version: v1.29
+
+          # Optional: working directory, useful for monorepos
+          # working-directory: somedir
+
+          # Optional: golangci-lint command line arguments.
+          # args: --issues-exit-code=0
+
+          # Optional: show only new issues if it's a pull request. The default value is `false`.
+          only-new-issues: true

.github/workflows/run-tests.yaml

@@ -1,4 +1,4 @@
-name: Build and Test
+name: Unit Test
 on:
   push:
     branches:
@@ -22,9 +22,6 @@ jobs:
       - name: Check out code into the Go module directory
         uses: actions/checkout@v2
 
-      - name: Vet
-        run: go vet ./...
-
       - name: Test
         run: go test ./...
 

Makefile

@@ -4,11 +4,43 @@
 # Debian/Ubuntu including WSL2: sudo apt-get install build-essential
 # Windows (non-WSL2): choco install make or http://gnuwin32.sourceforge.net/install.html
 
+all:
+	@echo "runner Makefile targets"
+	@echo ""
+	@echo "  gen-mocks: create/recreate mocks for unit testing"
+	@echo ""
+	@echo "  run-api: run the API server"
+	@echo ""
+	@echo "  run-api-bg: run the API server in the background"
+	@echo ""
+	@echo "  kill-api: kill the API server"
+	@echo ""
+	@echo "  test: run all unit tests in the repo"
+	@echo ""
+	@echo "  fmt: run go fmt on the repository"
+	@echo ""
+	@echo "  install-hooks: install git-hooks in the cloned repo .git directory"
+	@echo ""
+
 gen-mocks:
 	mockgen -source ./engine/runtime/types.go -package=mocks -destination ./engine/runtime/mocks/Runtime.go Runtime
 
 run-api:
 	go run api/main.go
 
+run-api-bg:
+	go run api/main.go &
+
+kill-api:
+	./hack/kill_server.sh
+
 test:
-	go test ./...
+	go test ./...
+
+fmt:
+	go fmt ./...
+
+install-hooks:
+	@echo "installing git hooks"
+	cp ./hack/hooks/* .git/hooks/
+	@echo "done"

engine/runtime/runtime.go

@@ -2,10 +2,10 @@ package runtime
 
 import (
 	"bytes"
+	"context"
 	"fmt"
 	"io"
 	"os/exec"
-	"context"
 	"time"
 
 	"github.com/runner-x/runner-x/util/print"
@@ -31,9 +31,9 @@ func (r *RuntimeAgent) RunCmd(runprops *RunProps) (*RunOutput, error) {
 	if numArgs < 1 {
 		return nil, nil
 	} else if numArgs == 1 {
-		cmd = exec.CommandContext(ctx,runprops.RunArgs[0])
+		cmd = exec.CommandContext(ctx, runprops.RunArgs[0])
 	} else {
-		cmd = exec.CommandContext(ctx,runprops.RunArgs[0], runprops.RunArgs[1:]...)
+		cmd = exec.CommandContext(ctx, runprops.RunArgs[0], runprops.RunArgs[1:]...)
 	}
 
 	stdoutPipe, stdoutErr := cmd.StdoutPipe()

hack/hooks/pre-commit

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+# go to repository root, handle case where this is run in root directory
+cd $(git rev-parse --show-toplevel)
+
+# check go is installed
+if ! which go; then
+    echo "go not installed, cannot run precheck"
+    exit
+fi
+
+# format all go files in repository
+go fmt ./...

api/kill_server.sh renamed to hack/kill_server.sh

@@ -1,5 +1,9 @@
 # 401X runner project
 
+[![Unit Tests](https://github.com/camerondurham/runner/workflows/Unit%20Test/badge.svg?branch=main)](https://github.com/camerondurham/runner/actions?query=workflow%3A%22Unit+Test%22)
+
+[![Go Lint](https://github.com/camerondurham/runner/workflows/Go%20Lint/badge.svg?branch=main)](https://github.com/camerondurham/runner/actions?query=workflow%3A%22Go+Lint%22)
+
 ## Intro
 
 The runner project is to create an interface for users to run their code remotely without having
@@ -52,6 +56,48 @@ can install [Docker Desktop](https://www.docker.com/get-started) if you like.
 
 ## Development
 
+This repository is primarily written in Go and the Makefile has a helper
+commands to make development easier and more consistent.
+
+> Note: before you start development, please run `make install-hooks`
+> to install [Git Hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
+> in your repository's `.git/hooks` directory. This will install a pre-commit
+> hook that automatically formats your code with [gofmt](https://go.dev/blog/gofmt).
+
+### Using the Makefile
+
+By now, you are probably familiar with Makefiles. If not, this
+wiki provides a great summary: [cs104/wiki/makefile](https://bytes.usc.edu/cs104/wiki/makefile/) (written by Leif Wesche).
+
+Here's a quick summary of what the targets will do:
+
+```bash
+# print out all the makefile targets
+make
+
+# create or create mocks for unit testing, helpful if you have
+# modified any of the interfaces in a `types.go` file
+make gen-mocks
+
+# run the API server (blocking, you can't use the terminal anymore)
+make run-api
+
+# run the API server in the background (you'll have to shut it down later)
+make run-api-bg
+
+# kill the server if it's running (this works by killing the process using port 8080, the API port)
+make kill-api
+
+# run all tests in the repository
+make test
+
+# run go fmt on the repository to format your code
+make fmt
+
+# install git-hooks to automatically format your code before you commit
+make install-hooks
+```
+
 ### CLI Setup
 
 CLI stands for command line interface.