diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000000..6b23baa72c --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,50 @@ +name: ci + +on: + pull_request: + branches: [main] + +jobs: + tests: + name: Tests + runs-on: ubuntu-latest + + steps: + - name: Check out code + uses: actions/checkout@v4 + + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: "1.23.0" + + - name: Go Version + run: go test -cover ./internal/auth + + - name: Install gosec + run: go install github.com/securego/gosec/v2/cmd/gosec@latest + - name: gosec + run: gosec ./... + + + style: + name: Style + runs-on: ubuntu-latest + + steps: + - name: Check out code + uses: actions/checkout@v4 + + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: "1.23.0" + + - name: Check formatting + run: test -z $(go fmt ./...) + + - name: Install staticcheck + run: go install honnef.co/go/tools/cmd/staticcheck@latest + + + diff --git a/README.md b/README.md index c2bec0368b..54b91547c6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ + + +![Test Status](https://github.com/WhileWorkingdoLearn/learn-cicd-starter/actions/workflows/ci.yml/badge.svg) # learn-cicd-starter (Notely) This repo contains the starter code for the "Notely" application for the "Learn CICD" course on [Boot.dev](https://boot.dev). @@ -21,3 +24,5 @@ go build -o notely && ./notely *This starts the server in non-database mode.* It will serve a simple webpage at `http://localhost:8080`. You do *not* need to set up a database or any interactivity on the webpage yet. Instructions for that will come later in the course! + +WhileCodingDoLearn's version of Boot.dev's Notely app. diff --git a/internal/auth/auth_test.go b/internal/auth/auth_test.go new file mode 100644 index 0000000000..38141d9d03 --- /dev/null +++ b/internal/auth/auth_test.go @@ -0,0 +1,37 @@ +package auth + +import ( + "net/http" + "testing" +) + +func TestEmpty(t *testing.T) {} + +func TestGetAuth(t *testing.T) { + + tests := map[string]struct { + input string + want string + err string + }{ + "simple": {input: "ApiKey blablabla", want: "blablabla", err: ""}, + "no seperator": {input: "ApiKeyblablabla", want: "", err: "malformed authorization header"}, + "api key": {input: "ApiKey", want: "", err: "malformed authorization header"}, + } + + for name, tc := range tests { + t.Run(name, func(t *testing.T) { + header := http.Header{} + header.Add("Authorization", tc.input) + got, err := GetAPIKey(header) + if err != nil { + if err.Error() != tc.err { + t.Fatalf("%s: expected: %v, got: %v, err: %v", name, tc.want, got, err) + } + } + if got != tc.want { + t.Fatalf("%s: expected: %v, got: %v, err: %v", name, tc.want, got, err) + } + }) + } +} diff --git a/json.go b/json.go index 1e6e7985e1..806a35ba1d 100644 --- a/json.go +++ b/json.go @@ -30,5 +30,8 @@ func respondWithJSON(w http.ResponseWriter, code int, payload interface{}) { return } w.WriteHeader(code) - w.Write(dat) + _, errWrite := w.Write(dat) + if errWrite != nil { + log.Printf("Error with writing: %s", err) + } } diff --git a/main.go b/main.go index 19d7366c5f..041cba5756 100644 --- a/main.go +++ b/main.go @@ -7,6 +7,7 @@ import ( "log" "net/http" "os" + "time" "github.com/go-chi/chi" "github.com/go-chi/cors" @@ -89,10 +90,16 @@ func main() { router.Mount("/v1", v1Router) srv := &http.Server{ - Addr: ":" + port, - Handler: router, + Addr: ":" + port, + Handler: router, + ReadHeaderTimeout: 3 * time.Second, } log.Printf("Serving on port: %s\n", port) log.Fatal(srv.ListenAndServe()) } + +func unused() { + // this function does nothing + // and is called nowhere +}