Update go version and fix small errors (#8)

* Update to go 1.15

* Upadate mux version

* Add linter and fix lint errors

* Fix spelling in README

Author: phillebaba

.github/workflows/go-test.yml

@@ -0,0 +1,27 @@
+name: go
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v1
+        with:
+          version: v1.30
+          args: -E misspell
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup go
+        uses: actions/setup-go@v1
+        with:
+          go-version: 1.15
+      - run: make test

.github/workflows/go.yaml

@@ -1,4 +1,4 @@
-FROM golang:1.14.4 as builder
+FROM golang:1.15 as builder
 RUN mkdir /build
 ADD . /build/
 WORKDIR /build

.github/workflows/publish-helm-charts.yml renamed to .github/workflows/publish-helm-charts.yaml

@@ -5,6 +5,9 @@ assets:
 	draw.io -b 10 -x -f png -p 0 -o assets/architecture.png assets/diagram.drawio
 .PHONY: assets
 
+lint:
+	golangci-lint run -E misspell
+
 fmt:
 	go fmt ./...
 

Dockerfile

@@ -12,7 +12,7 @@ of automation cumbersome if multiple tokens are needed with limited scopes.
   <img src="./assets/architecture.png">
 </p>
 
-Azure Devops Proxy (azdo-proxy) is an attempt to solve this issue by enabling a single PAT
+Azure DevOps Proxy (azdo-proxy) is an attempt to solve this issue by enabling a single PAT
 to be shared by many applications, while at the same time limiting access for each application.
 Requests are sent to azdo-proxy together with a token, which gives access to a specific repository.
 The request is checked and if allowed forwarded to Azure DevOps with the PAT appended to the request.
@@ -57,10 +57,9 @@ There should now be a azdo-proxy Pod and Service in the cluster, ready to proxy
 
 ### GIT
 Cloning a repository through the proxy is not too different from doing so directly from Azure DevOps.
-The only limitation is that it is not possible to clone through ssh, as azdo-proxy only proxies http traffic.
-To clone the repository `repo-1` [get the clone url from the respository page](https://docs.microsoft.com/en-us/azure/devops/repos/git/clone?view=azure-devops&tabs=visual-studio#get-the-clone-url-to-your-repo).
-Then replace the host part of the url with `azdo-proxy` and att the token as a basci auth parameter.
-The result should be similar to below.
+The only limitation is that it is not possible to clone through ssh, as azdo-proxy only proxies HTTP traffic.
+To clone the repository `repo-1` [get the clone URL from the repository page](https://docs.microsoft.com/en-us/azure/devops/repos/git/clone?view=azure-devops&tabs=visual-studio#get-the-clone-url-to-your-repo).
+Then replace the host part of the URL with `azdo-proxy` and add the token as a basic auth parameter. The result should be similar to below.
 ```shell
 git clone http://<token-1>@azdo-proxy/org/proj/_git/repo-1
 ```

Makefile

@@ -6,7 +6,7 @@ require (
 	github.com/go-logr/logr v0.2.0
 	github.com/go-logr/zapr v0.2.0
 	github.com/go-playground/validator/v10 v10.3.0
-	github.com/gorilla/mux v1.7.4
+	github.com/gorilla/mux v1.8.0
 	github.com/spf13/pflag v1.0.5
 	go.uber.org/zap v1.15.0
 )

README.md

@@ -19,6 +19,8 @@ github.com/go-playground/validator/v10 v10.3.0/go.mod h1:uOYAAleCW8F/7oMFd6aG0GO
 github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI=
 github.com/gorilla/mux v1.7.4 h1:VuZ8uybHlWmqV03+zRzdwKL4tUnIp1MAQtp1mIFE1bc=
 github.com/gorilla/mux v1.7.4/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
+github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
+github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
 github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
 github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=

go.mod

@@ -62,8 +62,8 @@ func main() {
 	// Configure revers proxy and http server
 	proxy := httputil.NewSingleHostReverseProxy(remote)
 	router := mux.NewRouter()
-	router.HandleFunc("/readyz", readinessHandler).Methods("GET")
-	router.HandleFunc("/healthz", livenessHandler).Methods("GET")
+	router.HandleFunc("/readyz", readinessHandler(log.WithName("readiness"))).Methods("GET")
+	router.HandleFunc("/healthz", livenessHandler(log.WithName("liveness"))).Methods("GET")
 	router.PathPrefix("/").HandlerFunc(proxyHandler(proxy, log.WithName("reverse-proxy"), auth, config.Domain, config.Pat))
 
 	srv := &http.Server{
@@ -100,16 +100,24 @@ func main() {
 	setupLog.Info("Server exited properly")
 }
 
-func readinessHandler(w http.ResponseWriter, r *http.Request) {
-	w.WriteHeader(http.StatusOK)
-	w.Header().Set("Content-Type", "application/json")
-	w.Write([]byte("{\"status\": \"ok\"}"))
+func readinessHandler(log logr.Logger) func(http.ResponseWriter, *http.Request) {
+	return func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(http.StatusOK)
+		w.Header().Set("Content-Type", "application/json")
+		if _, err := w.Write([]byte("{\"status\": \"ok\"}")); err != nil {
+			log.Error(err, "Could not write response data")
+		}
+	}
 }
 
-func livenessHandler(w http.ResponseWriter, r *http.Request) {
-	w.WriteHeader(http.StatusOK)
-	w.Header().Set("Content-Type", "application/json")
-	w.Write([]byte("{\"status\": \"ok\"}"))
+func livenessHandler(log logr.Logger) func(http.ResponseWriter, *http.Request) {
+	return func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(http.StatusOK)
+		w.Header().Set("Content-Type", "application/json")
+		if _, err := w.Write([]byte("{\"status\": \"ok\"}")); err != nil {
+			log.Error(err, "Could not write response data")
+		}
+	}
 }
 
 func proxyHandler(p *httputil.ReverseProxy, log logr.Logger, a *auth.Authorization, domain string, pat string) func(http.ResponseWriter, *http.Request) {