diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000000..171c8605fc --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,55 @@ +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.24.1' + + - name: tests + run: go test ./... -cover + + - name: Install Gosec + run: go install github.com/securego/gosec/v2/cmd/gosec@latest + + - name: check Vulnerabilities + run: gosec ./... + + + + style: + name: Style Check + 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.24.1' + + + - name: formating check + run: test -z $(go fmt ./...) + + - name: Install staticCheck + run: go install honnef.co/go/tools/cmd/staticcheck@latest + + - name: check linting + run: staticcheck ./... \ No newline at end of file diff --git a/README.md b/README.md index c2bec0368b..f2156e8c46 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ This repo contains the starter code for the "Notely" application for the "Learn CICD" course on [Boot.dev](https://boot.dev). + +![Build Status](https://github.com/dronzzz/learn-cicd-starter/actions/workflows/ci.yml/badge.svg) ## Local Development Make sure you're on Go version 1.22+. @@ -21,3 +23,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! + +*dronzzz 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..1b3516579b --- /dev/null +++ b/internal/auth/auth_test.go @@ -0,0 +1,53 @@ +package auth + +import ( + "errors" + "net/http" + "testing" +) + +func TestGetApiKey(t *testing.T) { + tests := []struct { + name string + headers http.Header + expectedErr error + expectedKey string + }{ + { + name: "valid header", + headers: http.Header{"Authorization": []string{"ApiKey my-api-key"}}, + expectedKey: "my-api-key", + expectedErr: nil, + }, + { + name: "malformed header", + headers: http.Header{"Authorization": []string{"apiKey my-api-key"}}, + expectedKey: "", + expectedErr: errors.New("malformed authorization header"), + }, + { + name: "missign header", + headers: http.Header{"Authorization": []string{""}}, + expectedErr: errors.New("no authorization header included"), + expectedKey: "", + }, + } + + for _, tc := range tests { + t.Run(tc.name, func(t *testing.T) { + gotKey, gotErr := GetAPIKey(tc.headers) + if gotKey != tc.expectedKey { + t.Errorf("expected key %q, got %q", tc.expectedKey, gotKey) + } + if tc.expectedErr == nil { + if gotErr != nil { + t.Errorf("expected no error, got %v", gotErr) + } + } else { + if gotErr == nil || gotErr.Error() != tc.expectedErr.Error() { + t.Errorf("expected error %q, got %v", tc.expectedErr.Error(), gotErr) + } + } + }) + } +} diff --git a/json.go b/json.go index 1e6e7985e1..ef53d67d7c 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) + if _, err := w.Write(dat); err != nil { + log.Printf("Error writing response: %s", err) + return + } } diff --git a/main.go b/main.go index 19d7366c5f..72873fee93 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,8 +90,9 @@ func main() { router.Mount("/v1", v1Router) srv := &http.Server{ - Addr: ":" + port, - Handler: router, + Addr: ":" + port, + Handler: router, + ReadHeaderTimeout: 10 * time.Second, } log.Printf("Serving on port: %s\n", port)