diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml new file mode 100644 index 0000000000..6a32dd7b8a --- /dev/null +++ b/.github/workflows/cd.yml @@ -0,0 +1,55 @@ +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@v4 + + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: "1.23.0" + + - name: Install Goose + run: go install github.com/pressly/goose/v3/cmd/goose@latest + + - name: Build app + 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@v2 + + - name: Use gcloud CLI + run: gcloud info + + - name: Run DB migrations + run: ./scripts/migrateup.sh + + - name: Build and push Docker image to Artifact Registry + run: | + gcloud builds submit --tag us-central1-docker.pkg.dev/notely-459117/notely-ar-repo/notely:latest --service-account=projects/notely-459117/serviceAccounts/cloud-run-deployer@notely-459117.iam.gserviceaccount.com --gcs-log-dir=gs://notely-459117_cloudbuild/logs + + - name: Deploy to Cloud Run + run: | + gcloud run deploy notely \ + --image us-central1-docker.pkg.dev/notely-459117/notely-ar-repo/notely:latest \ + --region us-central1 \ + --allow-unauthenticated \ + --project notely-459117 \ + --max-instances=4 diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000000..a7216fb050 --- /dev/null +++ b/.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@v4 + + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: "1.23.0" + + - name: Tests locally auth + 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 ./... + + 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: style format automatically + run: test -z $(go fmt ./...) + + - name: Install staticcheck + run: go install honnef.co/go/tools/cmd/staticcheck@latest diff --git a/README.md b/README.md index c2bec0368b..43216f9fb4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[![ci](https://github.com/donutz03/learn-cicd-starter/actions/workflows/ci.yml/badge.svg?branch=addtests)](https://github.com/donutz03/learn-cicd-starter/actions/workflows/ci.yml) + # 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). @@ -18,6 +20,7 @@ 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! +donutz03 diff --git a/internal/auth/auth_test.go b/internal/auth/auth_test.go new file mode 100644 index 0000000000..9bce548070 --- /dev/null +++ b/internal/auth/auth_test.go @@ -0,0 +1,68 @@ +package auth + +import ( + "errors" + "net/http" + "testing" +) + +func TestGetAPIKey(t *testing.T) { + tests := []struct { + name string + headers http.Header + expectedKey string + expectedError error + }{ + { + name: "No Authorization header", + headers: http.Header{}, + expectedKey: "", + expectedError: ErrNoAuthHeaderIncluded, + }, + { + name: "Malformed Authorization header - no space", + headers: http.Header{ + "Authorization": []string{"ApiKey"}, + }, + expectedKey: "", + expectedError: errors.New("malformed authorization header"), + }, + { + name: "Malformed Authorization header - wrong prefix", + headers: http.Header{ + "Authorization": []string{"Bearer token123"}, + }, + expectedKey: "", + expectedError: errors.New("malformed authorization header"), + }, + { + name: "Valid Authorization header", + headers: http.Header{ + "Authorization": []string{"ApiKey test123"}, + }, + expectedKey: "test123", + expectedError: nil, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + key, err := GetAPIKey(tt.headers) + if err != nil && tt.expectedError == nil { + t.Errorf("GetAPIKey() unexpected error = %v", err) + return + } + if err == nil && tt.expectedError != nil { + t.Errorf("GetAPIKey() expected error = %v, got nil", tt.expectedError) + return + } + if err != nil && tt.expectedError != nil && err.Error() != tt.expectedError.Error() { + t.Errorf("GetAPIKey() error = %v, expected error = %v", err, tt.expectedError) + return + } + if key != tt.expectedKey { + t.Errorf("GetAPIKey() key = %v, expected key = %v", key, tt.expectedKey) + } + }) + } +} diff --git a/json.go b/json.go index 1e6e7985e1..8d4f9d6c93 100644 --- a/json.go +++ b/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("failed to write response: %v", err) + } } diff --git a/main.go b/main.go index 19d7366c5f..09b9d8d68d 100644 --- a/main.go +++ b/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, + ReadHeaderTimeout: 5 * time.Second, + Addr: ":" + port, + Handler: router, } log.Printf("Serving on port: %s\n", port) diff --git a/static/index.html b/static/index.html index 72be101028..d9997c6fef 100644 --- a/static/index.html +++ b/static/index.html @@ -1,193 +1,203 @@ + + + Welcome to Notely + - - - Notely - - - +

Notely

- - + +
-