diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml new file mode 100644 index 0000000000..60b7ad33da --- /dev/null +++ b/.github/workflows/cd.yml @@ -0,0 +1,49 @@ +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 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@v3' + + - name: 'Use gcloud CLI' + run: 'gcloud info' + + - name: 'Build and push Docker image' + run: gcloud builds submit --tag us-central1-docker.pkg.dev/notely-505216/notely-ar-repo/notely:latest . + + - name: 'Migrate database' + run: ./scripts/migrateup.sh + + - name: Deploy to Cloud Run + run: gcloud run deploy notely --image us-central1-docker.pkg.dev/notely-505216/notely-ar-repo/notely:latest --region us-central1 --allow-unauthenticated --project notely-505216 --max-instances=4 + + - name: 'Git diff' + run: git diff HEAD \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000000..05d62a4781 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,51 @@ +name: ci + +on: + workflow_dispatch: + 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: Run all tests + 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: Run go fmt + run: test -z $(go fmt ./...) + + - name: Install staticcheck + run: go install honnef.co/go/tools/cmd/staticcheck@latest + + - name: Run staticcheck + run: staticcheck ./... \ No newline at end of file diff --git a/.gitignore b/.gitignore index 2092f54e78..c5cd3b1472 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ out .env learn-cicd-starter notely +.DS_Store diff --git a/README.md b/README.md index c2bec0368b..1a0bc07f7d 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ +![CI test results](https://github.com/MarkDavidSanders/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). + ## Local Development Make sure you're on Go version 1.22+. -Create a `.env` file in the root of the project with the following contents: +Create a `.env` file in the durn root of the project with the following contents: ```bash PORT="8080" @@ -21,3 +24,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! + +MarkDavidSanders's version of Boot.dev's Notely app. \ No newline at end of file diff --git a/internal/auth/get_api_key_test.go b/internal/auth/get_api_key_test.go new file mode 100644 index 0000000000..1af1170136 --- /dev/null +++ b/internal/auth/get_api_key_test.go @@ -0,0 +1,35 @@ +package auth + +import ( + "net/http/httptest" + "testing" +) + +var testReq = httptest.NewRequest("GET", "/api", nil) + +func TestGetAPIKeyGoodAuth(t *testing.T) { + testReq.Header.Set("Authorization", "ApiKey 42069") + want := "42069" + got, err := GetAPIKey(testReq.Header) + if err != nil { + t.Errorf("GetAPIKey() returned an error: %v", err) + } + if got != want { + t.Errorf("GetAPIKey() = %v, want %v", got, want) + } +} + +func TestGetAPIKeyBadAuth(t *testing.T) { + testReq.Header.Set("Authorization", "Bearer 42069") + got, err := GetAPIKey(testReq.Header) + if err == nil { + t.Errorf("GetAPIKey() did not return an error; got %v", got) + } +} + +func TestGetAPIKeyNoAuth(t *testing.T) { + got, err := GetAPIKey(testReq.Header) + if err == nil { + t.Errorf("GetAPIKey() did not flag missing header as expected; got %v", got) + } +} diff --git a/json.go b/json.go index 1e6e7985e1..bdd2719f7d 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..65a9537337 100644 --- a/main.go +++ b/main.go @@ -7,6 +7,8 @@ import ( "log" "net/http" "os" + "strconv" + "time" "github.com/go-chi/chi" "github.com/go-chi/cors" @@ -89,10 +91,11 @@ func main() { router.Mount("/v1", v1Router) srv := &http.Server{ - Addr: ":" + port, - Handler: router, + Addr: ":" + port, + Handler: router, + ReadHeaderTimeout: 2 * time.Second, } - log.Printf("Serving on port: %s\n", port) + log.Printf("Serving on port: %s", strconv.Quote(port)) log.Fatal(srv.ListenAndServe()) } diff --git a/static/index.html b/static/index.html index 72be101028..5d4ad73c09 100644 --- a/static/index.html +++ b/static/index.html @@ -7,7 +7,7 @@ -

Notely

+

Welcome to Notely