DynoID Helpers for Testing and Local Development (#225)

* Add LocalIssuer middleware to make testing and local development easier.
* Create functions useful for local development and testing.
* Add IssuerOpt for providing a private key.
* Handle nil when logging.
* Don't run CodeQL on push/pr since it's not currently working.
* DynoID docs
* Changed `AuthorizeSpaces` to use the same issuer as the current app.
* Added `AuthorizeSpacesWIthIssuer` to allow for the previous behavior specifying the issuer host.
* Move context functions from middleware package to dynoid package.
* Add examples
* Add CI check for docs.

---------

Co-authored-by: Troels Thomsen <[email protected]>

Author: kennyp

.github/workflows/ci.yaml

@@ -5,9 +5,11 @@ on: [ push ]
 jobs:
   ci:
     runs-on: [ ubuntu-latest ]
+    env:
+      GOMARKDOC_OPTS: -c
     strategy:
       matrix:
-        target: [ test, lint ]
+        target: [ test, lint, docs ]
     steps:
     - uses: actions/checkout@v4
     - uses: actions/setup-go@v4

.github/workflows/codeql-analysis.yml

@@ -1,8 +1,6 @@
 name: "Code scanning - action"
 
 on:
-  push:
-  pull_request:
   schedule:
     - cron: '0 12 * * 6'
 

.golangci.yml

@@ -31,6 +31,7 @@ issues:
         - scopelint # Otherwise you need tc := tc. This isn't actually a problem unless tests are being run in parallel.
         - lll # Don't do line length checks in test code.
         - dupl # Sometimes we duplicate a bunch in tests for the sake of clarity.
+        - gosec # Don't run gosec, it's insecure because it's a test
     - path: nacl/secretbox
       linters:
         - gosec # Don't run gosec on nacl/secretbox* because we know it uses crypto/md5. TODO: Evaluate if this makes sense.
@@ -43,9 +44,6 @@ issues:
     - path: grpc/
       linters:
         - lll # GRPC code has notoriously long function signatures.
-    - path: testing/mustcert/example_test.go
-      linters:
-        - gosec # Don't run gosec, it's insecure because it's a test
 
 linters-settings:
   misspell:

Makefile

@@ -22,6 +22,7 @@ PROTOC_DOWNLOAD_URL = https://github.com/protocolbuffers/protobuf/releases/downl
 # Additive or overridable variables
 override GOTEST_OPT += -timeout 30s
 LINT_RUN_OPTS ?= --fix
+override GOMARKDOC_OPTS += --header="" --repository.url="https://github.com/heroku/x" --repository.path="/" --repository.default-branch="master"
 
 .DEFAULT_GOAL := precommit
 
@@ -78,3 +79,10 @@ proto: $(TOOLS_BIN)/protoc $(TOOLS_BIN)/protoc-gen-go | $(TOOLS_BIN) ## Regenera
 		--go_out=paths=source_relative:. \
 		--loggingtags_out=. \
 		./cmd/protoc-gen-loggingtags/internal/test/*.proto
+
+$(GOPATH)/bin/gomarkdoc:
+	go install github.com/princjef/gomarkdoc/cmd/gomarkdoc@latest
+
+.PHONY: docs
+docs: $(GOPATH)/bin/gomarkdoc ## Generate docs using gomarkdoc
+	$< $(GOMARKDOC_OPTS) -o ./dynoid/README.md -e ./dynoid/...