Add Style job for formatting checks

.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-go@v5
+        with:
+          go-version: '1.21'
+
+      - name: Run tests
+        run: go test ./... --cover
+
+      - name: Install gosec
+        run: go install github.com/securego/gosec/v2/cmd/gosec@latest
+
+      - name: Run gosec security scan
+        run: gosec ./...

README.md

@@ -1,23 +1,17 @@
-# learn-cicd-starter (Notely)
+[![CI Status](https://github.com/sadiaaschrafi/learn-cicd-starter/actions/workflows/ci.yml/badge.svg)](https://github.com/sadiaaschrafi/learn-cicd-starter/actions)
 
-This repo contains the starter code for the "Notely" application for the "Learn CICD" course on [Boot.dev](https://boot.dev).
+# learn-cicd-starter
 
-## Local Development
+This is a starter project for learning CI/CD concepts.
 
-Make sure you're on Go version 1.22+.
+## Features
+- Automated testing with Go
+- CI/CD pipeline with GitHub Actions
+- Code formatting checks
 
-Create a `.env` file in the root of the project with the following contents:
+## Getting Started
+1. Clone the repository
+2. Run `go mod tidy`
+3. Run `go test ./...` to run tests
 
-```bash
-PORT="8080"
-```
-
-Run the server:
-
-```bash
-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!
+sadiaaschrafi's version of Boot.dev's Notely app.

internal/auth/auth_test.go

@@ -0,0 +1,38 @@
+package auth
+
+import (
+	"net/http"
+	"testing"
+)
+
+func TestGetAPIKey(t *testing.T) {
+	t.Run("returns API key when header is valid", func(t *testing.T) {
+		headers := http.Header{}
+		headers.Set("Authorization", "ApiKey test123")
+
+		key, err := GetAPIKey(headers)
+
+		if err != nil {
+			t.Errorf("Expected no error, got %v", err)
+		}
+		if key != "test123" {
+			t.Errorf("Expected 'test123', got %s", key)
+		}
+	})
+
+	t.Run("returns error when no authorization header", func(t *testing.T) {
+		headers := http.Header{}
+
+		key, err := GetAPIKey(headers)
+
+		if err == nil {
+			t.Error("Expected error, got nil")
+		}
+		if err != ErrNoAuthHeaderIncluded {
+			t.Errorf("Expected ErrNoAuthHeaderIncluded, got %v", err)
+		}
+		if key != "" {
+			t.Errorf("Expected empty key, got %s", key)
+		}
+	})
+}

json.go

@@ -6,29 +6,28 @@ import (
 	"net/http"
 )
 
-func respondWithError(w http.ResponseWriter, code int, msg string, logErr error) {
-	if logErr != nil {
-		log.Println(logErr)
-	}
-	if code > 499 {
-		log.Printf("Responding with 5XX error: %s", msg)
-	}
-	type errorResponse struct {
-		Error string `json:"error"`
-	}
-	respondWithJSON(w, code, errorResponse{
-		Error: msg,
-	})
+type errorResponse struct {
+	Error string `json:"error"`
+}
+
+func respondWithError(w http.ResponseWriter, code int, msg string) {
+    respondWithJSON(w, code, errorResponse{
+        Error: msg,
+    })
 }
 
 func respondWithJSON(w http.ResponseWriter, code int, payload interface{}) {
 	w.Header().Set("Content-Type", "application/json")
+
 	dat, err := json.Marshal(payload)
 	if err != nil {
 		log.Printf("Error marshalling JSON: %s", err)
-		w.WriteHeader(500)
+		w.WriteHeader(http.StatusInternalServerError)
 		return
 	}
+
 	w.WriteHeader(code)
-	w.Write(dat)
+	if _, err := w.Write(dat); err != nil {
+		log.Println("error writing response:", err)
+	}
 }

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: 5 * time.Second,
 	}
 
 	log.Printf("Serving on port: %s\n", port)