diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml new file mode 100644 index 00000000000..f9b2b077654 --- /dev/null +++ b/.github/workflows/cd.yml @@ -0,0 +1,24 @@ +name: cd + +on: + push: + branches: [main] + + +jobs: + deploy: + name: Deploy + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: "1.25.0" + + - name: Build app + run: ./scripts/buildprod.sh \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000000..c3b76695e61 --- /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: Checkout code + uses: actions/checkout@v5 + + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: "1.26.0" + + - name: Check version of Go + run: go test -cover ./... + - name: Install gosec + run: go install github.com/securego/gosec/v2/cmd/gosec@latest + - name: Check security issues + run: gosec ./... + style: + name: Style + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: "1.26.0" + + - name: Install staticcheck + run: go install honnef.co/go/tools/cmd/staticcheck@latest + - name: Check code style + run: test -z $(go fmt ./...) + + - name: Check formatting + run: staticcheck ./... + + + + \ No newline at end of file diff --git a/README.md b/README.md index c2bec0368b7..fba58aad383 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +![test badge](https://github.com/Dolamu-TheDataGuy/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 +22,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! + +Dolamu's version of Boot.dev's Notely app diff --git a/internal/auth/get_api_key_test.go b/internal/auth/get_api_key_test.go new file mode 100644 index 00000000000..b73944f8589 --- /dev/null +++ b/internal/auth/get_api_key_test.go @@ -0,0 +1,29 @@ +package auth + +import ( + "net/http" + "testing" +) + +func TestGetAPIKey(t *testing.T) { + headers := http.Header{} + headers.Set("Authorization", "ApiKey test-api-key") + got, err := GetAPIKey(headers) + if got != "test-api-key" { + t.Error("Expected API key, got empty string") + } + if err != nil { + t.Errorf("Expected no error, got %v", err) + } + if got == "my-api-key" { + t.Error("Expected API key, got a wrong string") + } +} + +func TestGetAPIKeyNoHeader(t *testing.T) { + headers := http.Header{} + _, err := GetAPIKey(headers) + if err != ErrNoAuthHeaderIncluded { + t.Errorf("Expected ErrNoAuthHeaderIncluded, got %v", err) + } +} diff --git a/json.go b/json.go index 1e6e7985e18..b32c31cbdd5 100644 --- a/json.go +++ b/json.go @@ -11,7 +11,7 @@ func respondWithError(w http.ResponseWriter, code int, msg string, logErr error) log.Println(logErr) } if code > 499 { - log.Printf("Responding with 5XX error: %s", msg) + log.Println("Responding with 5XX error:" + msg) } type errorResponse struct { Error string `json:"error"` @@ -30,5 +30,9 @@ func respondWithJSON(w http.ResponseWriter, code int, payload interface{}) { return } w.WriteHeader(code) - w.Write(dat) + _, err = w.Write(dat) + if err != nil { + log.Printf("Critical error writing response: %s", err) + + } } diff --git a/main.go b/main.go index 19d7366c5f7..076e53f7b6e 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" @@ -27,7 +28,7 @@ var staticFiles embed.FS func main() { err := godotenv.Load(".env") if err != nil { - log.Printf("warning: assuming default configuration. .env unreadable: %v", err) + log.Println("warning: assuming default configuration. .env unreadable:" + err.Error()) } port := os.Getenv("PORT") @@ -89,10 +90,11 @@ func main() { router.Mount("/v1", v1Router) srv := &http.Server{ - Addr: ":" + port, - Handler: router, + Addr: ":" + port, + Handler: router, + ReadHeaderTimeout: 5 * time.Second, } - log.Printf("Serving on port: %s\n", port) + // log.Println("Serving on port:" + port) log.Fatal(srv.ListenAndServe()) }