Addtests

.github/workflows/cd.yml

@@ -0,0 +1,43 @@
+name: cd
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  Deploy:
+    runs-on: ubuntu-latest
+    env:
+      DATABASE_URL: ${{ secrets.DATABASE_URL }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version-file: "go.mod"
+
+      - name: Install goose
+        run: go install github.com/pressly/goose/v3/cmd/goose@latest
+
+      - name: Build application
+        run: bash scripts/buildprod.sh
+
+      - id: "auth"
+        uses: "google-github-actions/auth@v2"
+        with:
+          credentials_json: "${{ secrets.GCP_CREDENTIALS }}"
+
+      - name: "Set up Cloud SDK"
+        uses: "google-github-actions/setup-gcloud@v3"
+
+      - name: Build and Push Docker Image
+        run:  gcloud builds submit --tag us-central1-docker.pkg.dev/notely-502219/notely-ar-repo/notaly:latest .
+
+      - name:  run migrations
+        run: bash scripts/migrateup.sh
+
+      - name: Deploy to Cloud Run
+        run: gcloud run deploy notely --image us-central1-docker.pkg.dev/notely-502219/notely-ar-repo/notaly:latest --region us-central1  --allow-unauthenticated --project  notely-502219 --max-instances=4

.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@v6
+
+      - name: Set up Go
+        uses: actions/setup-go@v6
+        with:
+          go-version: "1.26.0"
+
+      - name: install goose
+        run: go install github.com/pressly/goose/v3/cmd/goose@latest
+
+      - name: Force Failure
+        run: go test -cover ./...
+
+      - name: Style
+        run: test -z $(go fmt ./...)
+
+      - name: Install gosec
+        run: go install github.com/securego/gosec/v2/cmd/gosec@latest
+
+      - name: Run gosec
+        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: "stable"
+
+      - name: Check formatting
+        run: test -z "$(go fmt ./...)"
+
+      - name: Install staticcheck
+        run: go install honnef.co/go/tools/cmd/staticcheck@latest
+
+      - name: Run staticcheck
+        run: staticcheck ./...

.github/workflows/style.yml

@@ -0,0 +1,22 @@
+name: Style
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v6
+
+      - name: Set up Go
+        uses: actions/setup-go@v6
+        with:
+          go-version: "1.26.0"
+
+      - name: Style
+        run: test -z $(go fmt ./...)

README.md

@@ -1,3 +1,4 @@
+![alt text goes here](https://github.com/Gemelovg/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,4 @@ 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!
+MYNAME's version of Boot.dev's Notely app.

internal/auth/get_api_key_test.go

@@ -0,0 +1,114 @@
+package auth
+
+import (
+	"net/http"
+	"testing"
+)
+
+func TestGetAPIKey(t *testing.T) {
+	t.Run("returns error when no authorization header", func(t *testing.T) {
+		headers := http.Header{}
+
+		key, err := GetAPIKey(headers)
+
+		if err != ErrNoAuthHeaderIncluded {
+			t.Errorf("expected ErrNoAuthHeaderIncluded, got %v", err)
+		}
+		if key != "" {
+			t.Errorf("expected empty key, got %q", key)
+		}
+	})
+
+	t.Run("returns error for empty authorization header", func(t *testing.T) {
+		headers := http.Header{
+			"Authorization": []string{""},
+		}
+
+		key, err := GetAPIKey(headers)
+
+		if err == nil {
+			t.Fatal("expected error for empty header, got nil")
+		}
+		if key != "" {
+			t.Errorf("expected empty key, got %q", key)
+		}
+	})
+
+	t.Run("returns error for header without 'ApiKey' scheme", func(t *testing.T) {
+		headers := http.Header{
+			"Authorization": []string{"Bearer token123"},
+		}
+
+		key, err := GetAPIKey(headers)
+
+		if err == nil {
+			t.Fatal("expected error for Bearer scheme, got nil")
+		}
+		if key != "" {
+			t.Errorf("expected empty key, got %q", key)
+		}
+	})
+
+	t.Run("returns error for malformed header with only one part", func(t *testing.T) {
+		headers := http.Header{
+			"Authorization": []string{"ApiKey"},
+		}
+
+		key, err := GetAPIKey(headers)
+
+		if err == nil {
+			t.Fatal("expected error for missing key portion, got nil")
+		}
+		if key != "" {
+			t.Errorf("expected empty key, got %q", key)
+		}
+	})
+
+	t.Run("successfully extracts API key from valid header", func(t *testing.T) {
+		expectedKey := "my-secret-api-key-12345"
+		headers := http.Header{
+			"Authorization": []string{"ApiKey " + expectedKey},
+		}
+
+		key, err := GetAPIKey(headers)
+
+		if err != nil {
+			t.Fatalf("unexpected error: %v", err)
+		}
+		if key != expectedKey {
+			t.Errorf("expected %q, got %q", expectedKey, key)
+		}
+	})
+
+	t.Run("extra whitespace causes issues with Split - known limitation", func(t *testing.T) {
+		headers := http.Header{
+			"Authorization": []string{"ApiKey  api-key"}, // Two spaces
+		}
+
+		key, err := GetAPIKey(headers)
+
+		// Current Split behavior: ["ApiKey", "", "api-key"], so splitAuth[1] = ""
+		if err == nil && key == "" {
+			// Documented quirk - production code needs fixing for robust parsing
+			return
+		}
+		if err != nil {
+			t.Errorf("got error %v, expected none or empty key", err)
+		}
+	})
+
+	t.Run("header case-sensitivity check - lowercase apischeme fails", func(t *testing.T) {
+		headers := http.Header{
+			"Authorization": []string{"apikey secret123"},
+		}
+
+		key, err := GetAPIKey(headers)
+
+		if err == nil {
+			t.Fatal("expected error for lowercase 'apikey', got nil")
+		}
+		if key != "" {
+			t.Errorf("expected empty key, got %q", key)
+		}
+	})
+}

json.go

@@ -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("warning: failed to write response: %v", err)
+	}
 }

main.go

@@ -7,6 +7,8 @@ import (
 	"log"
 	"net/http"
 	"os"
+	"strings"
+	"time"
 
 	"github.com/go-chi/chi"
 	"github.com/go-chi/cors"
@@ -24,6 +26,18 @@ type apiConfig struct {
 //go:embed static/*
 var staticFiles embed.FS
 
+func sanitizeLogString(input string) string {
+	s := strings.ReplaceAll(input, "\r", "\\r")
+	s = strings.ReplaceAll(s, "\n", "\\n")
+	result := ""
+	for _, ch := range s {
+		if ch >= 32 || ch == '\t' {
+			result += string(ch)
+		}
+	}
+	return result
+}
+
 func main() {
 	err := godotenv.Load(".env")
 	if err != nil {
@@ -89,10 +103,14 @@ func main() {
 
 	router.Mount("/v1", v1Router)
 	srv := &http.Server{
-		Addr:    ":" + port,
-		Handler: router,
+		Addr:              ":" + port,
+		Handler:           router,
+		ReadHeaderTimeout: 5 * time.Second,  // Prevents Slowloris attacks
+		ReadTimeout:       10 * time.Second, // Prevents slow readers
+		WriteTimeout:      30 * time.Second, // Limits write duration
+		IdleTimeout:       60 * time.Second, // Closes idle connections
 	}
 
-	log.Printf("Serving on port: %s\n", port)
+	log.Printf("Serving on port: %s\n", sanitizeLogString(port))
 	log.Fatal(srv.ListenAndServe())
 }

sql/queries/notes.sql

@@ -10,3 +10,5 @@ SELECT * FROM notes WHERE id = ?;
 -- name: GetNotesForUser :many
 SELECT * FROM notes WHERE user_id = ?;
 --
+--
+__