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
22 changes: 22 additions & 0 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
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.25.1"

- name: Build production binary
run: ./scripts/buildprod.sh
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.25.1"

- name: Run unit 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.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 ./...
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
![CI status](https://github.com/mnem0nic7/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).
Expand All @@ -21,3 +23,8 @@ 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!

GitHub Copilot's version of Boot.dev's Notely app.


Grant's version of Boot.dev's Notely app.
60 changes: 60 additions & 0 deletions internal/auth/auth_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
package auth

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

func TestGetAPIKey(t *testing.T) {
t.Run("returns API key when header formatted correctly", func(t *testing.T) {
headers := http.Header{}
headers.Set("Authorization", "ApiKey secret123")

key, err := GetAPIKey(headers)
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if key != "secret123" {
t.Fatalf("expected key 'secret123', got %q", key)
}
})

t.Run("returns error when header missing", func(t *testing.T) {
headers := http.Header{}

_, err := GetAPIKey(headers)
if err == nil {
t.Fatal("expected error, got nil")
}
if !errors.Is(err, ErrNoAuthHeaderIncluded) {
t.Fatalf("expected ErrNoAuthHeaderIncluded, got %v", err)
}
})

t.Run("returns error when header malformed", func(t *testing.T) {
headers := http.Header{}
headers.Set("Authorization", "Bearer token")

_, err := GetAPIKey(headers)
if err == nil {
t.Fatal("expected error, got nil")
}
if err.Error() != "malformed authorization header" {
t.Fatalf("expected malformed header error, got %v", err)
}
})

t.Run("returns error when API key missing", func(t *testing.T) {
headers := http.Header{}
headers.Set("Authorization", "ApiKey")

_, err := GetAPIKey(headers)
if err == nil {
t.Fatal("expected error, got nil")
}
if err.Error() != "malformed authorization header" {
t.Fatalf("expected malformed header error, got %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: %s", err)
}
}
6 changes: 4 additions & 2 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"log"
"net/http"
"os"
"time"

"github.com/go-chi/chi"
"github.com/go-chi/cors"
Expand Down Expand Up @@ -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)
Expand Down