Skip to content
Open

add #1936

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
25 changes: 25 additions & 0 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
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: run script
run: scripts/buildprod.sh


52 changes: 52 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -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@v4

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

- 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.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 ./...


11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# learn-cicd-starter (Notely)



![code coverage badge](https://github.com/hakancoruhh/learn-cicd-starter/actions/workflows/ci.yml/badge.svg)





This repo contains the starter code for the "Notely" application for the "Learn CICD" course on [Boot.dev](https://boot.dev).

## Local Development
Expand All @@ -21,3 +29,6 @@ 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!


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

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

"github.com/bootdotdev/learn-cicd-starter/internal/auth"
)

func TestGetAPIKey(t *testing.T) {
tests := []struct {
name string
headers map[string]string
expectedKey string
expectedError error
}{
{
name: "valid API key",
headers: map[string]string{"Authorization": "ApiKey valid-api-key-123"},
expectedKey: "valid-api-key-123",
expectedError: nil,
},
{
name: "valid API key with special characters",
headers: map[string]string{"Authorization": "ApiKey abc123-def456_ghi789"},
expectedKey: "abc123-def456_ghi789",
expectedError: nil,
},
{
name: "missing authorization header",
headers: map[string]string{},
expectedKey: "",
expectedError: auth.ErrNoAuthHeaderIncluded,
},
{
name: "empty authorization header",
headers: map[string]string{"Authorization": ""},
expectedKey: "",
expectedError: auth.ErrNoAuthHeaderIncluded,
},
{
name: "malformed authorization header - no space",
headers: map[string]string{"Authorization": "ApiKey"},
expectedKey: "",
expectedError: errors.New("malformed authorization header"),
},
{
name: "malformed authorization header - wrong prefix",
headers: map[string]string{"Authorization": "Bearer token123"},
expectedKey: "",
expectedError: errors.New("malformed authorization header"),
},
{
name: "malformed authorization header - lowercase apikey",
headers: map[string]string{"Authorization": "apikey token123"},
expectedKey: "",
expectedError: errors.New("malformed authorization header"),
},
{
name: "malformed authorization header - only space",
headers: map[string]string{"Authorization": " "},
expectedKey: "",
expectedError: errors.New("malformed authorization header"),
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Create HTTP headers from the test case
headers := make(http.Header)
for key, value := range tt.headers {
headers.Set(key, value)
}

// Call the function
key, err := auth.GetAPIKey(headers)

// Check the returned key
if key != tt.expectedKey {
t.Errorf("GetAPIKey() key = %v, want %v", key, tt.expectedKey)
}

// Check the returned error
if tt.expectedError == nil {
if err != nil {
t.Errorf("GetAPIKey() error = %v, want nil", err)
}
} else {
if err == nil {
t.Errorf("GetAPIKey() error = nil, want %v", tt.expectedError)
} else if err.Error() != tt.expectedError.Error() {
t.Errorf("GetAPIKey() error = %v, want %v", err, tt.expectedError)
}
}
})
}
}

func TestGetAPIKey_EdgeCases(t *testing.T) {
t.Run("case insensitive header name", func(t *testing.T) {
headers := make(http.Header)
headers.Set("authorization", "ApiKey test-key") // lowercase header name

key, err := auth.GetAPIKey(headers)

if err != nil {
t.Errorf("GetAPIKey() error = %v, want nil", err)
}
if key != "test-key" {
t.Errorf("GetAPIKey() key = %v, want %v", key, "test-key")
}
})

t.Run("multiple authorization headers", func(t *testing.T) {
headers := make(http.Header)
headers.Add("Authorization", "Bearer token1")
headers.Add("Authorization", "ApiKey test-key")

key, err := auth.GetAPIKey(headers)

// Should get the first one (Bearer), which should be malformed
if err == nil {
t.Errorf("GetAPIKey() error = nil, want malformed authorization header error")
}
if key != "" {
t.Errorf("GetAPIKey() key = %v, want empty string", key)
}
})
}
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: 30 * time.Second,
}

log.Printf("Serving on port: %s\n", port)
Expand Down