Updating readme file.

.github/workflows/cd.yml

@@ -0,0 +1,45 @@
+name: cd
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+    deploy:
+        name: Deploy
+        runs-on: ubuntu-latest
+
+        env:
+          DATABASE_URL: ${{ secrets.DATABASE_URL }}
+
+        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: Build
+              run: ./scripts/buildprod.sh
+
+            - name: Auth with GCP
+              uses: google-github-actions/auth@v2
+              with:
+                credentials_json: ${{ secrets.GCP_CREDENTIALS }}
+
+            - name: Set up Cloud SDK
+              uses: google-github-actions/setup-gcloud@v2
+
+            - name: Build and push Docker image
+              run: gcloud builds submit --tag us-central1-docker.pkg.dev/pure-phalanx-505018-q3/notely-ar-repo/notely:latest .
+
+            - name: Run migrations
+              run: ./scripts/migrateup.sh
+
+            - name: Deploy to Cloud Run
+              run: gcloud run deploy notely --image us-central1-docker.pkg.dev/pure-phalanx-505018-q3/notely-ar-repo/notely:latest --region us-central1 --allow-unauthenticated --project pure-phalanx-505018-q3 --max-instances=4

.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+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: Check Go version
+        run: go test -cover ./...
+
+      - 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: Check out code
+        uses: actions/checkout@v6
+
+      - name: Set up Go
+        uses: actions/setup-go@v6
+        with:
+          go-version: "1.26.0"
+
+      - name: Check formating
+        run: test -z $(go fmt ./...)
+
+      - name: Install staticcheck
+        run: go install honnef.co/go/tools/cmd/staticcheck@latest

README.md

@@ -1,3 +1,5 @@
+![badge](https://github.com/kresko/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 +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!
+
+MYNAME

internal/auth/get_api_key_test.go

@@ -0,0 +1,73 @@
+package auth
+
+import (
+	"errors"
+	"net/http"
+	"testing"
+)
+
+func TestGetAPIKey(t *testing.T) {
+	tests := []struct {
+		name       string
+		headers    http.Header
+		wantKey    string
+		wantErr    error
+		wantErrMsg string // used when we only care about error text, not a sentinel
+	}{
+		{
+			name:    "valid api key",
+			headers: http.Header{"Authorization": []string{"ApiKey abc123"}},
+			wantKey: "abc123",
+			wantErr: nil,
+		},
+		{
+			name:    "missing authorization header",
+			headers: http.Header{},
+			wantKey: "",
+			wantErr: ErrNoAuthHeaderIncluded,
+		},
+		{
+			name:       "malformed header - no space",
+			headers:    http.Header{"Authorization": []string{"ApiKeyabc123"}},
+			wantKey:    "",
+			wantErrMsg: "malformed authorization header",
+		},
+		{
+			name:       "malformed header - wrong prefix",
+			headers:    http.Header{"Authorization": []string{"Bearer abc123"}},
+			wantKey:    "",
+			wantErrMsg: "malformed authorization header",
+		},
+		{
+			name:       "malformed header - only prefix, no key",
+			headers:    http.Header{"Authorization": []string{"ApiKey"}},
+			wantKey:    "",
+			wantErrMsg: "malformed authorization header",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			gotKey, gotErr := GetAPIKey(tt.headers)
+
+			if gotKey != tt.wantKey {
+				t.Errorf("got key %q, want %q", gotKey, tt.wantKey)
+			}
+
+			switch {
+			case tt.wantErr != nil:
+				if !errors.Is(gotErr, tt.wantErr) {
+					t.Errorf("got err %v, want %v", gotErr, tt.wantErr)
+				}
+			case tt.wantErrMsg != "":
+				if gotErr == nil || gotErr.Error() != tt.wantErrMsg {
+					t.Errorf("got err %v, want message %q", gotErr, tt.wantErrMsg)
+				}
+			default:
+				if gotErr != nil {
+					t.Errorf("got unexpected err %v", gotErr)
+				}
+			}
+		})
+	}
+}

json.go

@@ -30,5 +30,7 @@ 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)
+	}
 }

main.go

@@ -7,6 +7,8 @@ import (
 	"log"
 	"net/http"
 	"os"
+	"strconv"
+	"time"
 
 	"github.com/go-chi/chi"
 	"github.com/go-chi/cors"
@@ -34,6 +36,10 @@ func main() {
 	if port == "" {
 		log.Fatal("PORT environment variable is not set")
 	}
+	portNum, err := strconv.Atoi(port)
+	if err != nil {
+		log.Fatal("PORT environment variable must be numeric")
+	}
 
 	apiCfg := apiConfig{}
 
@@ -89,10 +95,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.Printf("Serving on port: %d\n", portNum)
 	log.Fatal(srv.ListenAndServe())
 }

static/index.html

@@ -7,7 +7,7 @@
 </head>
 
 <body class="section">
-    <h1>Notely</h1>
+    <h1>Welcome to Notely</h1>
 
     <div id="userCreationContainer" class="section">
         <input id="nameField" type="text" placeholder="Enter your name">