feat: scaffolding ca certs

.github/workflows/check-generated.yaml

@@ -0,0 +1,18 @@
+name: Func Check Generated
+
+on: [pull_request]
+
+jobs:
+  check:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: "1.20.x"
+      - name: Check that 'schema/func_yaml-schema.json schema' is up-to-date
+        run: make schema-check
+      - name: Check that 'templates/certs/ca-certificates.crt' is up-to-date
+        run: make certs-check
+      - name: Check that 'generate/zz_filesystem_generated.go' is up-to-date
+        run: make templates-check

.github/workflows/check.yaml

@@ -4,17 +4,11 @@ on: [pull_request]
 
 jobs:
   check:
-    name: Check Source
-    strategy:
-      matrix:
-        go: [1.20.x]
-        os: ["ubuntu-latest"]
-    runs-on: ${{ matrix.os }}
+    runs-on: "ubuntu-latest"
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: ${{ matrix.go }}
+          go-version: "1.20.x"
       - name: Check
         run: make check
-

.gitignore

@@ -4,6 +4,7 @@
 /cmd/func.yaml
 /templates/typescript/cloudevents/build
 /templates/typescript/http/build
+/templates/go/cloudevents/go.sum
 /coverage.out
 /coverage.txt
 /.coverage
@@ -29,3 +30,6 @@ __pycache__
 BUILD.bazel
 OWNERS
 OWNERS_ALIASES
+
+# Make stamps
+.*_stamp

Makefile

@@ -30,14 +30,13 @@ LDFLAGS := "-X main.date=$(DATE) -X main.vers=$(VERS) -X main.kver=$(KVER) -X ma
 CODE := $(shell find . -name '*.go') generate/zz_filesystem_generated.go go.mod schema/func_yaml-schema.json
 TEMPLATES := $(shell find templates -name '*' -type f)
 
-.PHONY: test docs
-
-# Default Targets
-all: build docs
+# Default Target
+all: check test build docs
 
 # Help Text
 # Headings: lines with `##$` comment prefix
 # Targets:  printed if their line includes a `##` comment
+.PHONY: help
 help:
 	@echo 'Usage: make <OPTIONS> ... <TARGETS>'
 	@echo ''
@@ -49,24 +48,66 @@ help:
 ##@ Development
 ###############
 
+.PHONY: build
 build: $(BIN) ## (default) Build binary for current OS
 
 $(BIN): $(CODE)
+	# Building
 	env CGO_ENABLED=0 go build -ldflags $(LDFLAGS) ./cmd/$(BIN)
 
-test: $(CODE) ## Run core unit tests
+.PHONY: test
+test: .test_stamp ## Run core unit tests
+# stamp allows caching.  Run `make clean` to force retest.
+.test_stamp: $(CODE)
+	# Testing
 	go test -race -cover -coverprofile=coverage.txt ./...
+	touch .test_stamp
 
-check: bin/golangci-lint ## Check code quality (lint)
+.PHONY: check
+check: .check_stamp ## Check code quality (lint)
+# stamp allows caching.  Run `make clean` to force receheck.
+.check_stamp: $(CODE) bin/golangci-lint
+	# Checking code quality with linter
 	./bin/golangci-lint run --timeout 300s
 	cd test && ../bin/golangci-lint run --timeout 300s
+	touch .check_stamp
 
 bin/golangci-lint:
 	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b ./bin v1.53.2
 
-.PHONY: clean_templates
+.PHONY: clean
+clean: ## Remove generated artifacts such as binaries and schemas
+	# Cleaning up binaries, generated files and stamp sentinel files 
+	rm -f $(BIN) $(BIN_WINDOWS) $(BIN_LINUX) $(BIN_DARWIN_AMD64) $(BIN_DARWIN_ARM64)
+	rm -f generate/zz_filesystem_generated.go
+	rm -f templates/certs/ca-certificates.crt
+	rm -f schema/func_yaml-schema.json
+	rm -f coverage.txt
+	rm -f .docs_stamp
+	rm -f .check_stamp
+	rm -f .test_stamp
+
+.PHONY: docs
+docs: .docs_stamp
+.docs_stamp: $(CODE) 
+	# Generating command reference docs
+	go run docs/generator/main.go
+	touch .docs_stamp
 
-clean_templates:
+#############
+##@ Templates
+#############
+
+.PHONY: templates
+templates: templates-clean generate/zz_filesystem_generated.go ## Build the embedded templates
+
+# remove the generated filesystem file if it has been edited (such as when it
+# has the merge blocks added during a rebase, etc) such that the make target
+# will rebuild the file. 
+.PHONY: templates-clean
+templates-clean:
+	# Removing any modifications to zz_filesystem_generated
+	- git diff --name-only generate/zz_filesystem_generated.go | uniq | xargs rm -f
 	# Removing temporary template files
 	@rm -f templates/go/cloudevents/go.sum
 	@rm -f templates/go/http/go.sum
@@ -86,137 +127,179 @@ clean_templates:
 	@rm -rf templates/springboot/http/target
 	@rm -f templates/**/.DS_Store
 
-.PHONY: generate/zz_filesystem_generated.go
 
-generate/zz_filesystem_generated.go: clean_templates
+# the filesysetm file itself is defined as being fresh if all the files in
+# templates are fresh as well as the certificates file.
+generate/zz_filesystem_generated.go: $(TEMPLATES) templates/certs/ca-certificates.crt
+	# Generating embedded templates filesystem
 	go generate pkg/functions/templates_embedded.go
 
-.PHONY: clean
-
-clean: clean_templates ## Remove generated artifacts such as binaries and schemas
-	rm -f $(BIN) $(BIN_WINDOWS) $(BIN_LINUX) $(BIN_DARWIN_AMD64) $(BIN_DARWIN_ARM64)
-	rm -f schema/func_yaml-schema.json
-	rm -f coverage.txt
-
-docs:
-	# Generating command reference doc
-	go run docs/generator/main.go
-
-#############
-##@ Templates
-#############
+.PHONY: templates-check
+templates-check: certs ## Check that the generated embedded filesystems are up-to-date
+	@if [[ -n $$(git diff -- schema/func_yaml-schema.json) ]]; \
+		then echo "\nFunction root certs (templates/certs/ca-certificates.crt) are obsolete, please run 'make certs' and commit the result.\n" >&2; \
+	exit 1; fi
 
 # TODO: add linters for other templates
+# NOTE the potential naming confusion with `templates-check` which checks if
+# the generated file is up-to-date, whereas this checks source code via the
+# linter.
 check-templates: check-rust
 
 check-rust: ## Lint Rust templates
 	cd templates/rust/cloudevents && cargo clippy && cargo clean
 	cd templates/rust/http && cargo clippy && cargo clean
 
+.PHONY: test-templates
 test-templates: test-go test-node test-python test-quarkus test-springboot test-rust test-typescript ## Run all template tests
 
+.PHONY: test-go
 test-go: ## Test Go templates
 	cd templates/go/cloudevents && go mod tidy && go test
 	cd templates/go/http && go mod tidy && go test
 
+.PHONY: test-node
 test-node: ## Test Node templates
 	cd templates/node/cloudevents && npm ci && npm test && rm -rf node_modules
 	cd templates/node/http && npm ci && npm test && rm -rf node_modules
 
+.PHONY: test-python
 test-python: ## Test Python templates
 	cd templates/python/cloudevents && pip3 install -r requirements.txt && python3 test_func.py && rm -rf __pycache__
 	cd templates/python/http && python3 test_func.py && rm -rf __pycache__
 
+.PHONY: test-quarkus
 test-quarkus: ## Test Quarkus templates
 	cd templates/quarkus/cloudevents && mvn test && mvn clean
 	cd templates/quarkus/http && mvn test && mvn clean
 
+.PHONY: test-springboot
 test-springboot: ## Test Spring Boot templates
 	cd templates/springboot/cloudevents && mvn test && mvn clean
 	cd templates/springboot/http && mvn test && mvn clean
 
+.PHONY: test-rust
 test-rust: ## Test Rust templates
 	cd templates/rust/cloudevents && cargo test && cargo clean
 	cd templates/rust/http && cargo test && cargo clean
 
+.PHONY: test-typescript
 test-typescript: ## Test Typescript templates
 	cd templates/typescript/cloudevents && npm ci && npm test && rm -rf node_modules build
 	cd templates/typescript/http && npm ci && npm test && rm -rf node_modules build
 
+###############
+##@ Scaffolding
+###############
+
+.PHONY: certs 
+certs: templates/certs/ca-certificates.crt ## Ensure the certs exist
+
+templates/certs/ca-certificates.crt:
+	# Updating root certificates
+	curl --output templates/certs/ca-certificates.crt https://curl.se/ca/cacert.pem
+
+.PHONY: certs-check
+certs-check: certs ## Check that root certificates are up-to-date
+	@if [[ -n $$(git diff -- schema/func_yaml-schema.json) ]]; \
+		then echo "\nFunction root certs (templates/certs/ca-certificates.crt) are obsolete, please run 'make certs' and commit the result.\n" >&2; \
+	exit 1; fi
 
 ###################
 ##@ Extended Testing (cluster required)
 ###################
 
+.PHONY: test-integration
 test-integration: ## Run integration tests using an available cluster.
 	go test -tags integration -timeout 30m --coverprofile=coverage.txt ./... -v
 
 .PHONY: func-instrumented
-
 func-instrumented: ## Func binary that is instrumented for e2e tests
 	env CGO_ENABLED=1 go build -ldflags $(LDFLAGS) -cover -o func ./cmd/func
 
+.PHONY: test-e2e
 test-e2e: func-instrumented ## Run end-to-end tests using an available cluster.
 	./test/e2e_extended_tests.sh
 
+.PHONY: test-e2e-runtime
 test-e2e-runtime: func-instrumented ## Run end-to-end lifecycle tests using an available cluster for a single runtime.
 	./test/e2e_lifecycle_tests.sh $(runtime)
 
+.PHONY: test-e2e-on-cluster
 test-e2e-on-cluster: func-instrumented ## Run end-to-end on-cluster build tests using an available cluster.
 	./test/e2e_oncluster_tests.sh
 
 ######################
 ##@ Release Artifacts
 ######################
 
+.PHONY: cross-platform
 cross-platform: darwin-arm64 darwin-amd64 linux-amd64 linux-arm64 linux-ppc64le linux-s390x windows ## Build all distributable (cross-platform) binaries
 
+.PHONY: darwin-arm64
 darwin-arm64: $(BIN_DARWIN_ARM64) ## Build for mac M1
 
 $(BIN_DARWIN_ARM64): generate/zz_filesystem_generated.go
 	env CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 go build -o $(BIN_DARWIN_ARM64) -ldflags $(LDFLAGS) ./cmd/$(BIN)
 
+.PHONY: darwin-amd64
 darwin-amd64: $(BIN_DARWIN_AMD64) ## Build for Darwin (macOS)
 
 $(BIN_DARWIN_AMD64): generate/zz_filesystem_generated.go
 	env CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -o $(BIN_DARWIN_AMD64) -ldflags $(LDFLAGS) ./cmd/$(BIN)
 
+.PHONY: linux-amd64
 linux-amd64: $(BIN_LINUX_AMD64) ## Build for Linux amd64
 
 $(BIN_LINUX_AMD64): generate/zz_filesystem_generated.go
 	env CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o $(BIN_LINUX_AMD64) -ldflags $(LDFLAGS) ./cmd/$(BIN)
 
+.PHONY: linux-arm64
 linux-arm64: $(BIN_LINUX_ARM64) ## Build for Linux arm64
 
 $(BIN_LINUX_ARM64): generate/zz_filesystem_generated.go
 	env CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -o $(BIN_LINUX_ARM64) -ldflags $(LDFLAGS) ./cmd/$(BIN)
 
+.PHONY: linux-ppc64le
 linux-ppc64le: $(BIN_LINUX_PPC64LE) ## Build for Linux ppc64le
 
 $(BIN_LINUX_PPC64LE): generate/zz_filesystem_generated.go
 	env CGO_ENABLED=0 GOOS=linux GOARCH=ppc64le go build -o $(BIN_LINUX_PPC64LE) -ldflags $(LDFLAGS) ./cmd/$(BIN)
 
+.PHONY: linux-s390x
 linux-s390x: $(BIN_LINUX_S390X) ## Build for Linux s390x
 
 $(BIN_LINUX_S390X): generate/zz_filesystem_generated.go
 	env CGO_ENABLED=0 GOOS=linux GOARCH=s390x go build -o $(BIN_LINUX_S390X) -ldflags $(LDFLAGS) ./cmd/$(BIN)
 
+.PHONY: windows
 windows: $(BIN_WINDOWS) ## Build for Windows
 
 $(BIN_WINDOWS): generate/zz_filesystem_generated.go
 	env CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -o $(BIN_WINDOWS) -ldflags $(LDFLAGS) ./cmd/$(BIN)
 
 ######################
-##@ Schemas
+##@ Schema
 ######################
-schema-generate: schema/func_yaml-schema.json ## Generate func.yaml schema
-schema/func_yaml-schema.json: pkg/functions/function.go pkg/functions/function_*.go
-	go run schema/generator/main.go
 
-schema-check: ## Check that func.yaml schema is up-to-date
-	mv schema/func_yaml-schema.json schema/func_yaml-schema-previous.json
-	make schema-generate
-	diff schema/func_yaml-schema.json schema/func_yaml-schema-previous.json ||\
-	(echo "\n\nFunction config schema 'schema/func_yaml-schema.json' is obsolete, please run 'make schema-generate'.\n\n"; rm -rf schema/func_yaml-schema-previous.json; exit 1)
-	rm -rf schema/func_yaml-schema-previous.json
+.PHONY: schema
+schema: schema-clean schema/func_yaml-schema.json ## Generate func.yaml schema
 
+# the schema file itself is considered fresh if all go files relating to
+# the function struct (with the function_ prefix) are older.  Merge conflicts
+# with the schema file are automatically resolved using schema-clean.
+schema/func_yaml-schema.json: pkg/functions/function.go pkg/functions/function_*.go
+	@go run schema/generator/main.go
+
+# remove the schema file if it has been modified (has merge blocks or was
+# regenerated without being committed during a schema-check) such that
+# the rebuild task will be triggered to automatically resolve the conflict.
+.PHONY: schema-clean
+schema-clean:
+	-@git diff --name-only schema/func_yaml-schema.json | uniq | xargs rm -f
+
+.PHONY: schema-check
+schema-check: schema ## Check that func.yaml schema is up-to-date
+	@if [[ -n $$(git diff -- schema/func_yaml-schema.json) ]]; \
+		then echo "\nFunction schema (schema/func_yaml-schema.json) is obsolete, please run 'make schema' and commit the result.\n" >&2; \
+	exit 1; fi

generate/templates/main.go

@@ -11,6 +11,8 @@ import (
 	"path/filepath"
 )
 
+// MODIFIED
+
 const templatesPath = "../../templates"
 
 // This program generates zz_filesystem_generated.go file containing byte array variable named TemplatesZip.