diff --git a/.gcloudignore b/.gcloudignore index 2c51591c28a..e4d7088be06 100644 --- a/.gcloudignore +++ b/.gcloudignore @@ -1 +1,2 @@ !notely +google-cloud-sdk diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml new file mode 100644 index 00000000000..b73f5f055a9 --- /dev/null +++ b/.github/workflows/cd.yml @@ -0,0 +1,48 @@ +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: Deploy + run: ./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: 'Use gcloud CLI' + run: 'gcloud info' + + - name: 'Build Docker Image' + run: gcloud builds submit --tag us-central1-docker.pkg.dev/notely-503820/notely-ar-repo/notely:latest + + - name: Migrate + run: ./scripts/migrateup.sh + + - name: Deploy to Cloud Run + run: gcloud run deploy notely --image us-central1-docker.pkg.dev/notely-503820/notely-ar-repo/notely:latest --region us-central1 --allow-unauthenticated --project notely-503820 --max-instances=4 diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000000..fb0cfd5aa72 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,52 @@ +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: Unit Tests + run: go test -cover ./... + + - name: Install gosec + run: go install github.com/securego/gosec/v2/cmd/gosec@latest + + - name: Security Test + 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.25.1" + + - 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 ./... diff --git a/.gitignore b/.gitignore index 2092f54e78a..3292fe4a6f2 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,5 @@ out .env learn-cicd-starter notely +google-cloud-sdk +notely-503820-0b56b0c8c032.json diff --git a/README.md b/README.md index c2bec0368b7..01494052f8b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + # 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! + +MYNAME'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..9e02a0e01e5 --- /dev/null +++ b/internal/auth/get_api_key_test.go @@ -0,0 +1,88 @@ +package auth + +import ( + "errors" + "net/http" + "testing" +) + +func TestGetAPIKey(t *testing.T) { + tests := []struct { + name string + headers http.Header + wantKey string + wantErr error + wantErrText string + }{ + { + name: "Missing Authorization header", + headers: http.Header{}, + wantKey: "", + wantErr: ErrNoAuthHeaderIncluded, + }, + { + name: "Empty Authorization header value", + headers: http.Header{ + "Authorization": []string{""}, + }, + wantKey: "", + wantErr: ErrNoAuthHeaderIncluded, + }, + { + name: "Malformed header - missing ApiKey prefix", + headers: http.Header{ + "Authorization": []string{"Bearer 12345"}, + }, + wantKey: "", + wantErrText: "malformed authorization header", + }, + { + name: "Malformed header - missing key component", + headers: http.Header{ + "Authorization": []string{"ApiKey"}, + }, + wantKey: "", + wantErrText: "malformed authorization header", + }, + { + name: "Malformed header - invalid prefix casing", + headers: http.Header{ + "Authorization": []string{"apikey 12345"}, + }, + wantKey: "", + wantErrText: "malformed authorization header", + }, + { + name: "Valid Authorization header", + headers: http.Header{ + "Authorization": []string{"ApiKey my-secret-api-key-123"}, + }, + wantKey: "my-secret-api-key-123", + wantErr: nil, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + gotKey, err := GetAPIKey(tt.headers) + + // Check error expectations + if tt.wantErr != nil { + if !errors.Is(err, tt.wantErr) { + t.Errorf("GetAPIKey() error = %v, wantErr %v", err, tt.wantErr) + } + } else if tt.wantErrText != "" { + if err == nil || err.Error() != tt.wantErrText { + t.Errorf("GetAPIKey() error = %v, wantErrText %q", err, tt.wantErrText) + } + } else if err != nil { + t.Errorf("GetAPIKey() unexpected error = %v", err) + } + + // Check key expectation + if gotKey != tt.wantKey { + t.Errorf("GetAPIKey() gotKey = %q, want %q", gotKey, tt.wantKey) + } + }) + } +} diff --git a/json.go b/json.go index 1e6e7985e18..c4cb71a3295 100644 --- a/json.go +++ b/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.Printf("Failed to write response: %v", err) + } } diff --git a/main.go b/main.go index 19d7366c5f7..ff22804fe0b 100644 --- a/main.go +++ b/main.go @@ -7,6 +7,8 @@ import ( "log" "net/http" "os" + "strings" + "time" "github.com/go-chi/chi" "github.com/go-chi/cors" @@ -89,10 +91,13 @@ 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) + cleanPort := strings.ReplaceAll(strings.ReplaceAll(port, "\n", ""), "\r", "") + + log.Printf("Serving on port: %s\n", cleanPort) log.Fatal(srv.ListenAndServe()) } diff --git a/static/index.html b/static/index.html index 72be101028c..5d4ad73c095 100644 --- a/static/index.html +++ b/static/index.html @@ -7,7 +7,7 @@
-