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
49 changes: 49 additions & 0 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
@@ -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
51 changes: 51 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -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 ./...
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ out
.env
learn-cicd-starter
notely
.DS_Store
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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"
Expand All @@ -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.
35 changes: 35 additions & 0 deletions internal/auth/get_api_key_test.go
Original file line number Diff line number Diff line change
@@ -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)
}
}
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("Failed to write response: %v", err)
}
}
9 changes: 6 additions & 3 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import (
"log"
"net/http"
"os"
"strconv"
"time"

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