diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000000..36bff04a744 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,22 @@ +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.23" + + - name: Run go tests + run: go test -cover ./... diff --git a/README.md b/README.md index c2bec0368b7..1ca1f3cb746 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +![CI](https://github.com/sadodk/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). @@ -18,6 +20,7 @@ Run the server: go build -o notely && ./notely ``` -*This starts the server in non-database mode.* It will serve a simple webpage at `http://localhost:8080`. +_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! +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! +Saads's version of Boot.dev's Notely app diff --git a/internal/auth/auth_test.go b/internal/auth/auth_test.go new file mode 100644 index 00000000000..0621dce1521 --- /dev/null +++ b/internal/auth/auth_test.go @@ -0,0 +1,60 @@ +package auth + +import ( + "net/http" + "testing" +) + +func TestGetAPIKey(t *testing.T) { + tests := []struct { + name string + headers http.Header + wantKey string + wantErr error + wantErrMsg string + }{ + { + name: "valid API key", + headers: http.Header{"Authorization": []string{"ApiKey my-secret-key"}}, + wantKey: "my-secret-key", + wantErr: nil, + }, + { + name: "no authorization header", + headers: http.Header{}, + wantKey: "", + wantErr: ErrNoAuthHeaderIncluded, + }, + { + name: "malformed header - wrong prefix", + headers: http.Header{"Authorization": []string{"Bearer my-token"}}, + wantKey: "", + wantErrMsg: "malformed authorization header", + }, + { + name: "malformed header - no space", + headers: http.Header{"Authorization": []string{"ApiKey"}}, + wantKey: "", + wantErrMsg: "malformed authorization header", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + gotKey, gotErr := GetAPIKey(tt.headers) + if gotKey != tt.wantKey { + t.Errorf("GetAPIKey() key = %q, want %q", gotKey, tt.wantKey) + } + if tt.wantErr != nil { + if gotErr != tt.wantErr { + t.Errorf("GetAPIKey() error = %v, want %v", gotErr, tt.wantErr) + } + } else if tt.wantErrMsg != "" { + if gotErr == nil || gotErr.Error() != tt.wantErrMsg { + t.Errorf("GetAPIKey() error = %v, want error with message %q", gotErr, tt.wantErrMsg) + } + } else if gotErr != nil { + t.Errorf("GetAPIKey() unexpected error = %v", gotErr) + } + }) + } +}