Add Dockerfile for boe create for cshared libs, configure test.short to skip long runing tests and other tech debt (#445)

This PR contains several build and test-related fixes and tech debt
addressing. I did them incrementally in this PR as many were tightly
related, but I'm happy to split up into different PRs if that's
preferred.


* The `Dockerfile` generated for the Go plugins was for the `goplugin`
build, but the Makefile main build is now cshared. This PR provides a
Dockerfile for each case, switches the default one to `cshared`, and
adds the needed Makefile targets.
* Related to #442: The
Dockerfile for `cshared` in this PR may need to be updated if that PR is
merged first. cc @codefromthecrypt
* Adds the `config.schema.json` to the extension images along with the
manifest and adds missing tests for verifying the contents of
extensions.
* For Go extensions, adds the `cshared` bool to the OCI annotations.
CShared extensions and plugin extensions are downloaded to different
locations, and knowing the "flavor" is needed by `boe download` before
it can inspect the package contents. cc @wbpcode
* Adds `make help` support for all the generated Makefiles to help users
easily understand what is available.
* Adds support for the `-test.short` flag when running Go tests. By
default, PR e2e tests will run with the "short" flag to skip
long-running tests, but e2e tests for `main` and release branches will
run all tests. Added a helper `internaltesting.MaybeSkipLongRunningTest`
to easily mark tests as long running and to have them skipped easily.
* Prints the boe logs upon e2e test failures.
* Logs command execution errors to the boe log file (previously, only
normal info/debug messages were logged).
* Unify Go verison for Dockerfiles and generated files to reduce the
number of places it needs to be updated.

---------

Signed-off-by: Ignasi Barrera <ignasi@tetrate.io>

Author: nacx

.github/workflows/cli.yaml

@@ -97,7 +97,8 @@ jobs:
       run:
         working-directory: ./cli
     env:
-      GO_TEST_ARGS: -v
+      # For PRs, skip the long running tests. For pushes to main or release branches, run all tests.
+      GO_TEST_ARGS: ${{ github.event_name == 'pull_request' && '-v -test.short' || '-v' }}
       TEST_BOE_REGISTRY: ghcr.io/tetratelabs/built-on-envoy
       TEST_BOE_REGISTRY_USERNAME: ${{ github.actor }}
       TEST_BOE_REGISTRY_PASSWORD: ${{ secrets.GITHUB_TOKEN }}

cli/Dockerfile

@@ -30,7 +30,7 @@ ENV GOMODCACHE=/var/boe/go/pkg/mod \
 
 ARG TARGETOS
 ARG TARGETARCH
-ARG GO_VERSION=1.26.3
+ARG GO_VERSION
 
 # Install Go
 RUN curl -fsSL https://go.dev/dl/go${GO_VERSION}.${TARGETOS}-${TARGETARCH}.tar.gz \

cli/Makefile

@@ -23,8 +23,9 @@ GO_TEST_ARGS ?=
 
 # Use a specific go tool invocation that uses the tools module for linters and other tools so that
 # the main go.mod is not polluted with tool dependencies.
-ROOT     := $(shell git rev-parse --show-toplevel)
-GO_TOOL  := go tool -modfile=$(ROOT)/tools/go.mod
+ROOT       := $(shell git rev-parse --show-toplevel)
+GO_VERSION := $(shell sed -ne 's/^go //gp' $(ROOT)/go.mod)
+GO_TOOL    := go tool -modfile=$(ROOT)/tools/go.mod
 
 # Base OCI image annotations (shared by all image types)
 BASE_OCI_ANNOTATIONS := \
@@ -138,6 +139,7 @@ build_image:  ## Build the Docker image
 	docker buildx build \
 		--output type=docker,oci-mediatypes=true \
 		--provenance=false \
+		--build-arg GO_VERSION="$(GO_VERSION)" \
 		$(BASE_OCI_ANNOTATIONS) \
 		-t $(OCI_REGISTRY)/$(NAME):$(TAG) \
 		-f ./Dockerfile .
@@ -151,6 +153,7 @@ push_image: create_builder  ## Push the Docker image to the registry
 		--builder $(BUILDER_NAME) \
 		--output type=registry,oci-mediatypes=true$(registry_output) \
 		--provenance=false \
+		--build-arg GO_VERSION="$(GO_VERSION)" \
 		$(MULTI_OCI_ANNOTATIONS) \
 		-t $(OCI_REGISTRY)/$(NAME):$(TAG) \
 		-f ./Dockerfile .

cli/README.md

@@ -74,5 +74,5 @@ cli/
 
 | Variable | Description | Example |
 |----------|-------------|---------|
-| `GO_TEST_ARGS` | Extra args for `go test` | `make test GO_TEST_ARGS="-run TestRun -v"` |
+| `GO_TEST_ARGS` | Extra args for `go test` | `make test GO_TEST_ARGS="-test.short -run TestRun -v"` |
 | `TAG` | Docker image tag | `make build_image TAG=v1.0.0` |

cli/cmd/create.go

@@ -17,6 +17,7 @@ import (
 	"slices"
 	"text/template"
 
+	"github.com/tetratelabs/built-on-envoy/cli/internal"
 	"github.com/tetratelabs/built-on-envoy/cli/internal/extensions"
 	"github.com/tetratelabs/built-on-envoy/cli/internal/xdg"
 )
@@ -83,6 +84,7 @@ func createGoExtension(logger *slog.Logger, dirs *xdg.Directories, path, name, c
 		"Name":               name,
 		"LibComposerVersion": composerVersion,
 		"DataHome":           dirs.DataHome,
+		"GoVersion":          internal.GoVersion,
 	}
 
 	// Map of output filename to template filename
@@ -93,6 +95,7 @@ func createGoExtension(logger *slog.Logger, dirs *xdg.Directories, path, name, c
 		"Makefile":           "templates/create/go/Makefile.tmpl",
 		"go.mod":             "templates/create/go/go.mod.tmpl",
 		"Dockerfile":         "templates/create/go/Dockerfile.tmpl",
+		"Dockerfile.plugin":  "templates/create/go/Dockerfile.plugin.tmpl",
 		"Dockerfile.code":    "templates/create/go/Dockerfile.code.tmpl",
 		".dockerignore":      "templates/create/go/dockerignore.tmpl",
 		"embedded/host.go":   "templates/create/go/host.go.tmpl",
@@ -160,7 +163,8 @@ func createExtProcExtension(logger *slog.Logger, path, name string) error {
 	repoPath := filepath.Join(path, name)
 
 	data := map[string]string{
-		"Name": name,
+		"Name":      name,
+		"GoVersion": internal.GoVersion,
 	}
 
 	files := map[string]string{

cli/cmd/create_test.go

@@ -20,6 +20,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
+	"github.com/tetratelabs/built-on-envoy/cli/internal"
 	internaltesting "github.com/tetratelabs/built-on-envoy/cli/internal/testing"
 	"github.com/tetratelabs/built-on-envoy/cli/internal/xdg"
 )
@@ -96,8 +97,10 @@ func TestCreateGo_Run(t *testing.T) {
 			"Makefile",
 			"go.mod",
 			"Dockerfile",
+			"Dockerfile.plugin",
 			"Dockerfile.code",
 			".dockerignore",
+			"main/main.go",
 			"embedded/host.go",
 			"standalone/main.go",
 		}
@@ -118,6 +121,18 @@ func TestCreateGo_Run(t *testing.T) {
 		require.NoError(t, err)
 		assert.Contains(t, string(plugin), "x-"+name)
 		assert.Contains(t, string(plugin), "WellKnownHttpFilterConfigFactories")
+
+		// verify go.mod content
+		// #nosec G304
+		gomod, err := os.ReadFile(filepath.Join(repoPath, "go.mod"))
+		require.NoError(t, err)
+		assert.Contains(t, string(gomod), `go `+internal.GoVersion)
+
+		// verify Dockerfile content
+		// #nosec G304
+		dockerfile, err := os.ReadFile(filepath.Join(repoPath, "Dockerfile"))
+		require.NoError(t, err)
+		assert.Contains(t, string(dockerfile), "FROM golang:"+internal.GoVersion)
 	}
 }
 

cli/cmd/root.go

@@ -50,6 +50,8 @@ type CLI struct {
 	StateHome   string `name:"state-home" env:"BOE_STATE_HOME" help:"Persistent state and logs directory. Defaults to ~/.local/state/boe" type:"path" default:"~/.local/state/boe"`
 	RuntimeDir  string `name:"runtime-dir" env:"BOE_RUNTIME_DIR" help:"Ephemeral runtime files directory. Defaults to /tmp/boe-$UID" type:"path"`
 	BoeLogLevel string `name:"boe-log-level" env:"BOE_LOG_LEVEL" help:"Log level for the CLI. Defaults to debug" enum:"debug,info,warn,error" default:"debug"`
+
+	Logger *slog.Logger `kong:"-"` // Internal field for the logger
 }
 
 // BeforeApply is called by Kong before applying defaults to set XDG directory defaults.
@@ -72,11 +74,12 @@ func (c *CLI) BeforeApply(ctx *kong.Context) error {
 	}
 	ctx.Bind(dirs)
 
-	logger, err := initLogger(dirs, c.BoeLogLevel)
+	var err error
+	c.Logger, err = initLogger(dirs, c.BoeLogLevel)
 	if err != nil {
 		return fmt.Errorf("failed to initialize logger: %w", err)
 	}
-	ctx.Bind(logger)
+	ctx.Bind(c.Logger)
 
 	return nil
 }

cli/cmd/templates/create/ext_proc/Dockerfile.tmpl

@@ -8,7 +8,7 @@
 # Dockerfile (e.g., Dockerfile.custom) instead of editing this file.
 
 # Build the manager binary
-FROM golang:1.26.3 AS builder
+FROM golang:{{ .GoVersion }} AS builder
 
 WORKDIR /workspace
 COPY . .
@@ -24,4 +24,8 @@ FROM scratch AS final
 # include in the image.
 COPY --from=builder /workspace/manifest.yaml /
 COPY --from=builder /workspace/out/ext_proc-server /
+# Use a wildcard to copy config.schema.json if it exists, since COPY will fail if the file does not exist and we want to
+# allow for optional presence of this file.
+COPY --from=builder /workspace/config.schema.json* /
+
 ENTRYPOINT [ "/ext_proc-server" ]

cli/cmd/templates/create/ext_proc/Makefile.tmpl

@@ -2,6 +2,8 @@
 # If you need to customize the build process, consider using environment variables
 # or wrapper scripts instead of editing this file.
 
+default: build
+
 # This IMAGE_NONCE will be appended to the final image tag if set.
 # It is intended to be used in CI environments to ensure that each image
 # built gets a unique tag.
@@ -57,7 +59,7 @@ SOURCE_ARTIFACT := --annotation "io.tetratelabs.built-on-envoy.extension.artifac
 comma := ,
 MULTI_OCI_ANNOTATIONS := \
 	$(subst --annotation ",--annotation "index$(comma)manifest:,$(BASE_OCI_ANNOTATIONS)) \
-	--annotation "index,manifest:io.tetratelabs.built-on-envoy.extension.artifact=binary"
+	$(subst --annotation ",--annotation "index$(comma)manifest:,$(BINARY_ARTIFACT))
 
 BUILDER_NAME := boe-builder
 .PHONY: create_builder
@@ -67,29 +69,33 @@ create_builder:
 			--driver docker-container --driver-opt network=host \
 			--buildkitd-flags '--allow-insecure-entitlement network.host' --use
 
-.PHONY: test
-test:
-	go test ./...
+##@ Build
 
 .PHONY: build
-build:
+build:  ## Compile the extproc server binary
 	CGO_ENABLED=0 go build -a -ldflags="-s -w" -o ./out/ext_proc-server .
 
-.PHONY: clean
-clean:
-	rm -f ./out/ext_proc-server
+.PHONY: test
+test:  ## Run the tests
+	go test ./...
 
 .PHONY: install
-install: build
+install: build  ## Install the built extproc extension to the local BOE data directory
 	@echo "Installing $(NAME)..."
 	mkdir -p $(BOE_DATA_HOME)/extensions/extproc/$(NAME)/$(VERSION); \
 	cp ./out/ext_proc-server $(BOE_DATA_HOME)/extensions/extproc/$(NAME)/$(VERSION)/ext_proc-server;
 	@echo "Installed to $(BOE_DATA_HOME)/extensions/extproc/$(NAME)"
 
+.PHONY: clean
+clean:  ## Clean up the build artifacts
+	rm -f ./out/ext_proc-server
+
+##@ Packaging
+
 # For single local platform build, we will add the OS and ARCH to the image tag to avoid confusion.
 # And we will not push it to the registry by default.
 .PHONY: build_image
-build_image:
+build_image:  ## Build the OCI image for the extproc server
 	docker buildx build \
 		--output type=docker,oci-mediatypes=true \
 		--provenance=false \
@@ -102,7 +108,7 @@ build_image:
 # both amd64 and arm64 architectures, and push it to the registry.
 PLATFORMS ?= linux/arm64,linux/amd64
 .PHONY: push_image
-push_image: create_builder  ## Build and push docker image for the plugin for cross-platform support
+push_image: create_builder  ## Build and push OCI image for the extproc server
 	@echo "Building and pushing image..."
 	docker buildx build --platform=$(PLATFORMS) \
 		--builder $(BUILDER_NAME) \
@@ -115,7 +121,7 @@ push_image: create_builder  ## Build and push docker image for the plugin for cr
 # Package source code into an image and push it to the registry.
 CODE_IMAGE := $(HUB)/extension-src-$(NAME):$(VERSION)$(IMAGE_NONCE)
 .PHONY: push_code
-push_code: create_builder  ## Build and push source code image
+push_code: create_builder  ## Build and push the OCI image with the extension source code
 	@echo "Building and pushing source code image..."
 	docker buildx build \
 		--builder $(BUILDER_NAME) \
@@ -125,3 +131,12 @@ push_code: create_builder  ## Build and push source code image
 		$(SOURCE_ARTIFACT) \
 		--tag $(CODE_IMAGE) \
 		-f ./Dockerfile.code .
+
+
+##@ Help
+
+.PHONY: help
+help:  ## Show this help info
+	@echo "Built On Envoy. Discover, run, and build custom filters with zero friction.\n"
+	@echo "Usage:\n  make \033[36m<Target>\033[0m \n\nTargets:"
+	@awk 'BEGIN {FS = ":.*##"; printf ""} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

cli/cmd/templates/create/ext_proc/go.mod.tmpl

@@ -1,6 +1,6 @@
 module {{ .Name }}
 
-go 1.26.3
+go {{ .GoVersion }}
 
 require (
 	github.com/envoyproxy/go-control-plane/envoy v1.37.0