Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: cd

on:
push:
branches: [main]

jobs:
deploy:
name: Deploy
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.26.0"

- name: Build Go binary
run: ./scripts/buildprod.sh

- name: Authenticate to Google Cloud
uses: google-github-actions/auth@v2
with:
credentials_json: ${{ secrets.GCP_CREDENTIALS }}

- name: Set up gcloud
uses: google-github-actions/setup-gcloud@v2
with:
project_id: first-skein-494213-p9

- name: Build and push image
run: |
gcloud builds submit \
--tag us-central1-docker.pkg.dev/first-skein-494213-p9/notely-ar-repo/notely:latest .

- name: Deploy to Cloud Run
run: gcloud run deploy notely --image us-central1-docker.pkg.dev/first-skein-494213-p9/notely-ar-repo/notely:latest --region us-central1 --allow-unauthenticated --project first-skein-494213-p9 --max-instances=4
50 changes: 50 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
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.26.0"

- name: Run 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@v4

- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: "1.26.0"

- 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 ./...
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![CI](https://github.com/augusthottie/learn-cicd-starter/actions/workflows/ci.yml/badge.svg)](https://github.com/augusthottie/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).
Expand All @@ -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!

augusthottie's version of Boot.dev's Notely app.
1 change: 0 additions & 1 deletion handler_notes.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ func (cfg *apiConfig) handlerNotesGet(w http.ResponseWriter, r *http.Request, us
respondWithError(w, http.StatusInternalServerError, "Couldn't get posts for user", err)
return
}

postsResp, err := databasePostsToPosts(posts)
if err != nil {
respondWithError(w, http.StatusInternalServerError, "Couldn't convert posts", err)
Expand Down
41 changes: 41 additions & 0 deletions internal/auth/get_api_key_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
package auth

import (
"errors"
"net/http"
"testing"
)

func TestGetAPIKey(t *testing.T) {
t.Run("extracts key from ApiKey scheme", func(t *testing.T) {
h := http.Header{}
h.Set("Authorization", "ApiKey my-secret-key")
key, err := GetAPIKey(h)
if err != nil {
t.Fatalf("GetAPIKey: %v", err)
}
if key != "my-secret-key" {
t.Errorf("key = %q, want %q", key, "my-secret-key")
}
})

t.Run("missing Authorization header", func(t *testing.T) {
h := http.Header{}
_, err := GetAPIKey(h)
if !errors.Is(err, ErrNoAuthHeaderIncluded) {
t.Errorf("err = %v, want ErrNoAuthHeaderIncluded", err)
}
})

t.Run("malformed Authorization header", func(t *testing.T) {
h := http.Header{}
h.Set("Authorization", "Bearer not-an-api-key")
_, err := GetAPIKey(h)
if err == nil {
t.Fatal("expected error")
}
if err.Error() != "malformed authorization header" {
t.Errorf("err = %v", err)
}
})
}
4 changes: 3 additions & 1 deletion json.go
Original file line number Diff line number Diff line change
Expand Up @@ -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: %v", err)
}
}
18 changes: 13 additions & 5 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@ package main
import (
"database/sql"
"embed"
"fmt"
"io"
"log"
"net/http"
"os"
"strconv"
"time"

"github.com/go-chi/chi"
"github.com/go-chi/cors"
Expand All @@ -30,10 +33,14 @@ func main() {
log.Printf("warning: assuming default configuration. .env unreadable: %v", err)
}

port := os.Getenv("PORT")
if port == "" {
portStr := os.Getenv("PORT")
if portStr == "" {
log.Fatal("PORT environment variable is not set")
}
portNum, err := strconv.Atoi(portStr)
if err != nil || portNum < 1 || portNum > 65535 {
log.Fatal("PORT must be a valid TCP port number between 1 and 65535")
}

apiCfg := apiConfig{}

Expand Down Expand Up @@ -89,10 +96,11 @@ func main() {

router.Mount("/v1", v1Router)
srv := &http.Server{
Addr: ":" + port,
Handler: router,
Addr: fmt.Sprintf(":%d", portNum),
Handler: router,
ReadHeaderTimeout: 10 * time.Second,
}

log.Printf("Serving on port: %s\n", port)
log.Printf("Serving on port: %d\n", portNum)
log.Fatal(srv.ListenAndServe())
}
2 changes: 1 addition & 1 deletion static/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down