Remove generated files from directory

Author: kurtnordstrom

broker/Dockerfile

@@ -21,6 +21,12 @@ COPY ncip/ ./ncip
 COPY zoom/ ./zoom
 COPY testutil/ ./testutil
 
+# Directory generated sources are not stored in the repository.
+RUN --mount=type=cache,sharing=shared,target=/go/pkg/mod \
+    cd /app/directory && \
+    GOWORK=off go mod download && \
+    GOWORK=off go generate .
+
 # copy broker manifests before sources to leverage docker cache for mod downloads
 COPY broker/go.mod broker/go.sum ./broker/
 
@@ -31,9 +37,6 @@ WORKDIR /app/broker
 RUN --mount=type=cache,sharing=shared,target=/go/pkg/mod \
   go mod download
 
-# sources are generated before docker build
-# make sure make generate is run
-
 # copy broker sources (changes here won't invalidate deps cache)
 # see .dockerignore for what is getting copied
 COPY broker/ ./

broker/Dockerfile.dockerignore

@@ -26,3 +26,9 @@ broker/**/*_test.go
 
 # Include pull slip templates
 !broker/pullslip/service/pull_slip_template.html
+
+# Directory sources are generated inside the build.
+directory/api/directory.gen.go
+directory/db/db.go
+directory/db/models.go
+directory/db/query.sql.go

directory/.gitignore

@@ -1,3 +1,7 @@
 directory
 coverage.out
 .vscode
+/api/directory.gen.go
+/db/db.go
+/db/models.go
+/db/query.sql.go

directory/Dockerfile

@@ -10,16 +10,17 @@ COPY directory/go.mod directory/go.sum ./directory/
 # Set destination for COPY
 WORKDIR /app/directory
 
-# sources are generated before docker build
-# make sure make generate is run
-
 # see .dockerignore for what is getting copied
 COPY directory/ ./
 
 # download go deps, caches GOMODPATH
 RUN --mount=type=cache,sharing=shared,target=/go/pkg/mod \
   GOWORK=off go mod download
 
+# Generate API and database code from the tracked specifications.
+RUN --mount=type=cache,sharing=shared,target=/go/pkg/mod \
+  GOWORK=off go generate .
+
 # Build, caches GOCACHE
 RUN --mount=type=cache,sharing=shared,target=/root/.cache/go-build \
   CGO_ENABLED=0 \

directory/Dockerfile.dockerignore

@@ -0,0 +1,5 @@
+# Generated sources are created inside the build.
+directory/api/directory.gen.go
+directory/db/db.go
+directory/db/models.go
+directory/db/query.sql.go

directory/Makefile

@@ -10,7 +10,7 @@ OAPI_CODEGEN ?= $(GO) tool oapi-codegen
 
 .PHONY: all docker generate generate-sqlc generate-api check checkinclgen run fmt fmt-check lint vulncheck clean deps-update tools-update
 
-all: generate $(BINARY)
+all: $(BINARY)
 
 docker:
 	cd .. && $(DOCKER) build -f ./directory/Dockerfile .
@@ -23,18 +23,18 @@ generate-sqlc:
 generate-api:
 	$(OAPI_CODEGEN) --config=oapi-codegen.yaml api.yaml
 
-$(BINARY): $(GOFILES)
+$(BINARY): generate $(GOFILES)
 	$(GO) build -v -o $(BINARY) ./$(MAIN_PACKAGE)
 
-checkinclgen:
+checkinclgen: generate
 	$(GO) test -v -cover -coverpkg=./... -coverprofile=$(COVERAGE) ./...
 
-check:
+check: generate
 	$(GO) test -v -coverpkg=./... -coverprofile=$(COVERAGE).tmp ./...
 	grep -v "\.gen\.go" $(COVERAGE).tmp | grep -v "/db/" | grep -v "/test/" > $(COVERAGE)
 	$(GO) tool cover -func $(COVERAGE)
 
-run: $(BINARY)
+run: generate
 	$(GO) run -buildvcs=true ./$(MAIN_PACKAGE)
 
 fmt:
@@ -59,4 +59,6 @@ tools-update:
 	$(GO) mod tidy
 
 clean:
-	rm -f $(BINARY) $(COVERAGE) $(COVERAGE).tmp
+	rm -f $(BINARY) $(COVERAGE) $(COVERAGE).tmp \
+		api/directory.gen.go \
+		db/db.go db/models.go db/query.sql.go

directory/README.md

@@ -7,23 +7,25 @@ PGPASSWORD=<somepass> psql -p 54322 -U postgres -h <local host/ip> -c 'create da
 PGPASSWORD=<somepass> psql -p 54322 -U postgres -h <local host/ip> -d directory -a -f schema.sql
 ```
 
-Installing sqlc and oapi-codegen (probably good to contrive a way to add these as deps although the [tools.go](https://www.jvt.me/posts/2024/09/30/go-tools-module/) approach is a bit unwieldy it does seem like they have a proposal open with the core team to smooth this out a bit): 
-```
-go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest
-go install github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen@latest
-```
+The SQLC and OpenAPI generator versions are pinned as Go tools in `go.mod`.
+Generate the database and API sources with:
 
-Generating structs/interfaces for db and api:
 ```
-sqlc generate
-oapi-codegen --config=oapi-codegen.yaml api.yaml
+make generate
 ```
 
-Compiling:
+Generated Go sources are build artifacts and are not stored in the repository.
+The standard build, test, lint, and run targets generate them automatically:
+
 ```
-go build
+make all
+make check
+make lint
+make run
 ```
 
+Run `make generate` before invoking `go build` or `go test` directly.
+
 # Some examples of repos using sqlc / some sort of api gen
 
 ## Contrived
@@ -37,4 +39,4 @@ go build
 - https://github.com/helpwave/services/tree/main/services/tasks-svc
 
 # Environment variables
-- SYMBOL_AUTHORITY: The authority that is paired with the incoming institution/tenant to form a full symbol
+- SYMBOL_AUTHORITY: The authority that is paired with the incoming institution/tenant to form a full symbol