updated-readme

.github/workflows/cd.yml

@@ -0,0 +1,31 @@
+name: cd
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - 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"
+        with:
+          version: ">= 363.0.0"
+
+      - name: Build Go binary
+        run: ./scripts/buildprod.sh
+
+      - name: "Build and Push Docker Image"
+        run: |
+          gcloud builds submit --tag us-central1-docker.pkg.dev/notely-470817/arvindkhoisnam/notely:latest .

.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+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.23.0"
+
+      - name: Install gosec
+        run: go install github.com/securego/gosec/v2/cmd/gosec@latest
+
+      - name: Run unit tests
+        run: go test ./... -cover
+
+      - name: Run gosec
+        run: gosec ./...
+
+      - name: Print User's name
+        run: echo Hello Arvind 👋
+
+  style:
+    name: Style
+    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.23.0"
+
+      - name: Install staticcheck
+        run: go install honnef.co/go/tools/cmd/staticcheck@latest
+
+      - name: Check formatting
+        run: test -z $(go fmt ./...)
+
+      - name: Check linting
+        run: staticcheck ./...

README.md

@@ -18,6 +18,8 @@ Run the server:
 go build -o notely && ./notely
 ```
 
-*This starts the server in non-database mode.* It will serve a simple webpage at `http://localhost:8080`.
+_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!
+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!
+
+Arvind's version of Boot.dev's Notely app.

internal/auth/auth_test.go

@@ -0,0 +1,23 @@
+package auth
+
+import (
+	"net/http"
+	"testing"
+)
+
+func TestGetAPIKey(t *testing.T) {
+
+	apiKey := "ApiKey this_is_a_temporary_api_key"
+	expect := "this_is_a_temporary_api_key"
+	header := make(http.Header)
+	header.Set("Authorization", apiKey)
+
+	res, err := GetAPIKey(header)
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+
+	if res != expect {
+		t.Errorf("expected %q, got %q", expect, res)
+	}
+}

json.go

@@ -30,5 +30,8 @@ func respondWithJSON(w http.ResponseWriter, code int, payload interface{}) {
 		return
 	}
 	w.WriteHeader(code)
-	w.Write(dat)
+	_, err = w.Write(dat)
+	if err != nil {
+		log.Println(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)