Manage builds with different combinations of extensions

Files were added to be built whether an extension is on or off.
New build tags were added for each extension, while minimal and extended disappeared.

added custom binary naming depending on extensions used and changed references from binary to binary-extended

added automated blackbox tests for sync, search, scrub, metrics

added contributor guidelines

Signed-off-by: Alex Stan <[email protected]>

.github/workflows/codeql-analysis.yml

@@ -37,7 +37,7 @@ jobs:
         # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
     env:
       CGO_ENABLED: 0
-      GOFLAGS: "-tags=extended,containers_image_openpgp"
+      GOFLAGS: "-tags=sync,search,scrub,metrics,ui_base,containers_image_openpgp"
 
     steps:
     - name: Checkout repository

.github/workflows/ecosystem-tools.yaml

@@ -44,3 +44,15 @@ jobs:
       - name: Run push-pull tests
         run: |
             make push-pull
+      - name: Run metrics tests
+        run: |
+            make bats-metrics
+      - name: Run cve tests
+        run: |
+            make bats-cve
+      - name: Run sync test
+        run: |
+            make bats-sync
+      - name: Run scrub tests
+        run: |
+            make bats-scrub

.github/workflows/golangci-lint.yaml

@@ -31,7 +31,7 @@ jobs:
 
           # Optional: golangci-lint command line arguments.
           # args: --issues-exit-code=0
-          args: --config ./golangcilint.yaml --enable-all --build-tags extended,containers_image_openpgp ./cmd/... ./pkg/...
+          args: --config ./golangcilint.yaml --enable-all --build-tags sync,scrub,search,metrics,ui_base,containers_image_openpgp ./cmd/... ./pkg/...
 
           # Optional: show only new issues if it's a pull request. The default value is `false`.
           # only-new-issues: true

.gitignore

@@ -20,4 +20,5 @@ test/data/
 coverage.html
 tags
 vendor/
-.vscode/
+.vscode/
+examples/config-sync-localhost.json

CONTRIBUTING.md

@@ -44,6 +44,15 @@ For a minimal dist-spec only zot,
 make binary-minimal
 ```
 
+For a zot that includes only the extensions that you specify,
+the available extensions that can be used at the moment are: sync, scrub, metrics, search, ui_base .
+
+NOTES: When multiple extensions are used, they should be enlisted in the above presented order.
+
+```
+make binary EXTENSIONS=a,b,c
+```
+
 For a node exporter used by minimal dist-spec only zot,
 
 ```

Makefile

@@ -16,6 +16,10 @@ TESTDATA := $(TOP_LEVEL)/test/data
 OS ?= linux
 ARCH ?= amd64
 BENCH_OUTPUT ?= stdout
+EXTENSIONS ?= sync,search,scrub,metrics,ui_base
+comma:= ,
+hyphen:= -
+extended-name:=
 
 .PHONY: all
 all: modcheck swagger binary binary-minimal binary-debug cli bench exporter-minimal verify-config test covhtml check
@@ -24,42 +28,48 @@ all: modcheck swagger binary binary-minimal binary-debug cli bench exporter-mini
 modcheck:
 	go mod tidy
 
+.PHONY: create-name
+create-name:
+ifdef EXTENSIONS
+	$(eval extended-name=-$(subst $(comma),$(hyphen),$(EXTENSIONS)))
+endif
+
+.PHONY: binary
+binary: modcheck swagger create-name
+	env CGO_ENABLED=0 GOOS=$(OS) GOARCH=$(ARCH) go build -o bin/zot-$(OS)-$(ARCH) -buildmode=pie -tags $(EXTENSIONS),containers_image_openpgp -v -trimpath -ldflags "-X zotregistry.io/zot/pkg/api/config.Commit=${COMMIT} -X zotregistry.io/zot/pkg/api/config.BinaryType=$(extended-name) -X zotregistry.io/zot/pkg/api/config.GoVersion=${GO_VERSION} -s -w" ./cmd/zot
+
 .PHONY: binary-debug
-binary-debug: modcheck swagger
-	env CGO_ENABLED=0 GOOS=$(OS) GOARCH=$(ARCH) go build -o bin/zot-$(OS)-$(ARCH)-debug -buildmode=pie -tags extended,containers_image_openpgp -v -gcflags all='-N -l' -ldflags "-X zotregistry.io/zot/pkg/api/config.Commit=${COMMIT} -X zotregistry.io/zot/pkg/api/config.BinaryType=extended -X zotregistry.io/zot/pkg/api/config.GoVersion=${GO_VERSION}" ./cmd/zot
+binary-debug: modcheck swagger create-name
+	env CGO_ENABLED=0 GOOS=$(OS) GOARCH=$(ARCH) go build -o bin/zot-$(OS)-$(ARCH)-debug -buildmode=pie -tags $(EXTENSIONS),containers_image_openpgp -v -gcflags all='-N -l' -ldflags "-X zotregistry.io/zot/pkg/api/config.Commit=${COMMIT} -X zotregistry.io/zot/pkg/api/config.BinaryType=$(extended-name) -X zotregistry.io/zot/pkg/api/config.GoVersion=${GO_VERSION}" ./cmd/zot
 
 .PHONY: binary-minimal
 binary-minimal: modcheck swagger
-	env CGO_ENABLED=0 GOOS=$(OS) GOARCH=$(ARCH) go build -o bin/zot-$(OS)-$(ARCH)-minimal -buildmode=pie -tags minimal,containers_image_openpgp -v -trimpath -ldflags "-X zotregistry.io/zot/pkg/api/config.Commit=${COMMIT} -X zotregistry.io/zot/pkg/api/config.BinaryType=minimal -X zotregistry.io/zot/pkg/api/config.GoVersion=${GO_VERSION} -s -w" ./cmd/zot
-
-.PHONY: binary
-binary: modcheck swagger
-	env CGO_ENABLED=0 GOOS=$(OS) GOARCH=$(ARCH) go build -o bin/zot-$(OS)-$(ARCH) -buildmode=pie -tags extended,containers_image_openpgp -v -trimpath -ldflags "-X zotregistry.io/zot/pkg/api/config.Commit=${COMMIT} -X zotregistry.io/zot/pkg/api/config.BinaryType=extended -X zotregistry.io/zot/pkg/api/config.GoVersion=${GO_VERSION} -s -w" ./cmd/zot
+	env CGO_ENABLED=0 GOOS=$(OS) GOARCH=$(ARCH) go build -o bin/zot-$(OS)-$(ARCH)-minimal -buildmode=pie -tags containers_image_openpgp -v -trimpath -ldflags "-X zotregistry.io/zot/pkg/api/config.Commit=${COMMIT} -X zotregistry.io/zot/pkg/api/config.BinaryType=minimal -X zotregistry.io/zot/pkg/api/config.GoVersion=${GO_VERSION} -s -w" ./cmd/zot
 
 .PHONY: cli
-cli: modcheck
-	env CGO_ENABLED=0 GOOS=$(OS) GOARCH=$(ARCH) go build -o bin/zli-$(OS)-$(ARCH) -buildmode=pie -tags extended,containers_image_openpgp -v -trimpath -ldflags "-X zotregistry.io/zot/pkg/api/config.Commit=${COMMIT} -X zotregistry.io/zot/pkg/api/config.BinaryType=extended -X zotregistry.io/zot/pkg/api/config.GoVersion=${GO_VERSION} -s -w" ./cmd/zli
+cli: modcheck create-name
+	env CGO_ENABLED=0 GOOS=$(OS) GOARCH=$(ARCH) go build -o bin/zli-$(OS)-$(ARCH) -buildmode=pie -tags $(EXTENSIONS),ui_base,containers_image_openpgp -v -trimpath -ldflags "-X zotregistry.io/zot/pkg/api/config.Commit=${COMMIT} -X zotregistry.io/zot/pkg/api/config.BinaryType=$(extended-name) -X zotregistry.io/zot/pkg/api/config.GoVersion=${GO_VERSION} -s -w" ./cmd/zli
 
 .PHONY: bench
-bench: modcheck
-	env CGO_ENABLED=0 GOOS=$(OS) GOARCH=$(ARCH) go build -o bin/zb-$(OS)-$(ARCH) -buildmode=pie -tags extended,containers_image_openpgp -v -trimpath -ldflags "-X zotregistry.io/zot/pkg/api/config.Commit=${COMMIT} -X zotregistry.io/zot/pkg/api/config.BinaryType=extended -X zotregistry.io/zot/pkg/api/config.GoVersion=${GO_VERSION} -s -w" ./cmd/zb
+bench: modcheck create-name
+	env CGO_ENABLED=0 GOOS=$(OS) GOARCH=$(ARCH) go build -o bin/zb-$(OS)-$(ARCH) -buildmode=pie -tags $(EXTENSIONS),containers_image_openpgp -v -trimpath -ldflags "-X zotregistry.io/zot/pkg/api/config.Commit=${COMMIT} -X zotregistry.io/zot/pkg/api/config.BinaryType=$(extended-name) -X zotregistry.io/zot/pkg/api/config.GoVersion=${GO_VERSION} -s -w" ./cmd/zb
 
 .PHONY: exporter-minimal
 exporter-minimal: modcheck
-	env CGO_ENABLED=0 GOOS=$(OS) GOARCH=$(ARCH) go build -o bin/zxp-$(OS)-$(ARCH) -buildmode=pie -tags minimal,containers_image_openpgp -v -trimpath ./cmd/zxp
+	env CGO_ENABLED=0 GOOS=$(OS) GOARCH=$(ARCH) go build -o bin/zxp-$(OS)-$(ARCH) -buildmode=pie -tags containers_image_openpgp -v -trimpath ./cmd/zxp
 
 .PHONY: test
 test: check-skopeo $(TESTDATA) $(NOTATION)
-	go test -failfast -tags extended,containers_image_openpgp -v -trimpath -race -timeout 15m -cover -coverpkg ./... -coverprofile=coverage-extended.txt -covermode=atomic ./...
-	go test -failfast -tags minimal,containers_image_openpgp -v -trimpath -race -cover -coverpkg ./... -coverprofile=coverage-minimal.txt -covermode=atomic ./...
+	go test -failfast -tags $(EXTENSIONS),containers_image_openpgp -v -trimpath -race -timeout 15m -cover -coverpkg ./... -coverprofile=coverage-extended.txt -covermode=atomic ./...
+	go test -failfast -tags containers_image_openpgp -v -trimpath -race -cover -coverpkg ./... -coverprofile=coverage-minimal.txt -covermode=atomic ./...
 	# development-mode unit tests possibly using failure injection
-	go test -failfast -tags dev,extended,containers_image_openpgp -v -trimpath -race -timeout 15m -cover -coverpkg ./... -coverprofile=coverage-dev-extended.txt -covermode=atomic ./pkg/test/... ./pkg/api/... ./pkg/storage/... ./pkg/extensions/sync/... -run ^TestInject
-	go test -failfast -tags dev,minimal,containers_image_openpgp -v -trimpath -race -cover -coverpkg ./... -coverprofile=coverage-dev-minimal.txt -covermode=atomic ./pkg/test/... ./pkg/storage/... ./pkg/extensions/sync/... -run ^TestInject
-	go test -failfast -tags stress,extended,containers_image_openpgp -v -trimpath -race -timeout 15m ./pkg/cli/stress_test.go
+	go test -failfast -tags dev,$(EXTENSIONS),containers_image_openpgp -v -trimpath -race -timeout 15m -cover -coverpkg ./... -coverprofile=coverage-dev-extended.txt -covermode=atomic ./pkg/test/... ./pkg/api/... ./pkg/storage/... ./pkg/extensions/sync/... -run ^TestInject
+	go test -failfast -tags dev,containers_image_openpgp -v -trimpath -race -cover -coverpkg ./... -coverprofile=coverage-dev-minimal.txt -covermode=atomic ./pkg/test/... ./pkg/storage/... ./pkg/extensions/sync/... -run ^TestInject
+	go test -failfast -tags stress,$(EXTENSIONS),containers_image_openpgp -v -trimpath -race -timeout 15m ./pkg/cli/stress_test.go
 
 .PHONY: privileged-test
 privileged-test: check-skopeo $(TESTDATA) $(NOTATION)
-	go test -failfast -tags needprivileges,extended,containers_image_openpgp -v -trimpath -race -timeout 15m -cover -coverpkg ./... -coverprofile=coverage-dev-needprivileges.txt -covermode=atomic ./pkg/storage/... ./pkg/cli/... -run ^TestElevatedPrivileges
+	go test -failfast -tags needprivileges,$(EXTENSIONS),containers_image_openpgp -v -trimpath -race -timeout 15m -cover -coverpkg ./... -coverprofile=coverage-dev-needprivileges.txt -covermode=atomic ./pkg/storage/... ./pkg/cli/... -run ^TestElevatedPrivileges
 
 $(TESTDATA): check-skopeo
 	$(shell mkdir -p ${TESTDATA}; cd ${TESTDATA}; ../scripts/gen_certs.sh; cd ${TOP_LEVEL}; skopeo --insecure-policy copy -q docker://public.ecr.aws/t0x7q1g8/centos:7 oci:${TESTDATA}/zot-test:0.0.1;skopeo --insecure-policy copy -q docker://public.ecr.aws/t0x7q1g8/centos:8 oci:${TESTDATA}/zot-cve-test:0.0.1)
@@ -95,11 +105,11 @@ $(GOLINTER):
 
 .PHONY: check
 check: ./golangcilint.yaml $(GOLINTER)
-	$(GOLINTER) --config ./golangcilint.yaml run --enable-all --out-format=colored-line-number --build-tags minimal,containers_image_openpgp ./...
-	$(GOLINTER) --config ./golangcilint.yaml run --enable-all --out-format=colored-line-number --build-tags extended,containers_image_openpgp ./...
-	$(GOLINTER) --config ./golangcilint.yaml run --enable-all --out-format=colored-line-number --build-tags dev,minimal,containers_image_openpgp ./...
-	$(GOLINTER) --config ./golangcilint.yaml run --enable-all --out-format=colored-line-number --build-tags dev,extended,containers_image_openpgp ./...
-	$(GOLINTER) --config ./golangcilint.yaml run --enable-all --out-format=colored-line-number --build-tags stress,extended,containers_image_openpgp ./...
+	$(GOLINTER) --config ./golangcilint.yaml run --enable-all --out-format=colored-line-number --build-tags containers_image_openpgp ./...
+	$(GOLINTER) --config ./golangcilint.yaml run --enable-all --out-format=colored-line-number --build-tags $(EXTENSIONS),containers_image_openpgp ./...
+	$(GOLINTER) --config ./golangcilint.yaml run --enable-all --out-format=colored-line-number --build-tags dev,containers_image_openpgp ./...
+	$(GOLINTER) --config ./golangcilint.yaml run --enable-all --out-format=colored-line-number --build-tags dev,$(EXTENSIONS),containers_image_openpgp ./...
+	$(GOLINTER) --config ./golangcilint.yaml run --enable-all --out-format=colored-line-number --build-tags stress,$(EXTENSIONS),containers_image_openpgp ./...
 
 swagger/docs.go: 
 	swag -v || go install github.com/swaggo/swag/cmd/[email protected]
@@ -117,7 +127,7 @@ update-licenses:
 .PHONY: check-licenses
 check-licenses:
 	go install github.com/google/go-licenses@latest
-	@for tag in "extended,containers_image_openpgp" "minimal,containers_image_openpgp"; do \
+	@for tag in "$(EXTENSIONS),containers_image_openpgp" "$(EXTENSIONS),containers_image_openpgp"; do \
 		echo Evaluating tag: $$tag;\
 		for mod in $$(go list -m -f '{{if not (or .Indirect .Main)}}{{.Path}}{{end}}' all); do \
 			while [ x$$mod != x ]; do \
@@ -204,8 +214,48 @@ $(BATS):
 
 .PHONY: push-pull
 push-pull: binary check-skopeo $(BATS)
-	$(BATS) --trace --print-output-on-failure test/blackbox
+	$(BATS) --trace --print-output-on-failure test/blackbox/pushpull.bats
 
 .PHONY: push-pull-verbose
 push-pull-verbose: binary check-skopeo $(BATS)
-	$(BATS) --trace --verbose-run --print-output-on-failure --show-output-of-passing-tests test/blackbox
+	$(BATS) --trace --verbose-run --print-output-on-failure --show-output-of-passing-tests test/blackbox/pushpull.bats
+
+.PHONY: bats-sync
+bats-sync: EXTENSIONS=sync
+bats-sync: binary binary-minimal check-skopeo $(BATS)
+	$(BATS) --trace --print-output-on-failure test/blackbox/sync.bats
+
+.PHONY: bats-sync-verbose
+bats-sync-verbose: EXTENSIONS=sync
+bats-sync-verbose: binary binary-minimal check-skopeo $(BATS)
+	$(BATS) --trace -t -x -p --verbose-run --print-output-on-failure --show-output-of-passing-tests test/blackbox/sync.bats
+
+.PHONY: bats-cve
+bats-cve: EXTENSIONS=ui_base
+bats-cve: binary cli check-skopeo $(BATS)
+	$(BATS) --trace --print-output-on-failure test/blackbox/cve.bats
+
+.PHONY: bats-cve-verbose
+bats-cve-verbose: EXTENSIONS=ui_base
+bats-cve-verbose: binary cli check-skopeo $(BATS)
+	$(BATS) --trace -t -x -p --verbose-run --print-output-on-failure --show-output-of-passing-tests test/blackbox/cve.bats
+
+.PHONY: bats-scrub
+bats-scrub: EXTENSIONS=scrub
+bats-scrub: binary check-skopeo $(BATS)
+	$(BATS) --trace --print-output-on-failure test/blackbox/scrub.bats
+
+.PHONY: bats-scrub-verbose
+bats-scrub-verbose: EXTENSIONS=scrub
+bats-scrub-verbose: binary check-skopeo $(BATS)
+	$(BATS) --trace -p --verbose-run --print-output-on-failure --show-output-of-passing-tests test/blackbox/scrub.bats
+
+.PHONY: bats-metrics
+bats-metrics: EXTENSIONS=metrics
+bats-metrics: binary check-skopeo $(BATS)
+	$(BATS) --trace --print-output-on-failure test/blackbox/metrics.bats
+
+.PHONY: bats-metrics-verbose
+bats-metrics-verbose: EXTENSIONS=metrics
+bats-metrics-verbose: binary check-skopeo $(BATS)
+	$(BATS) --trace -p --verbose-run --print-output-on-failure --show-output-of-passing-tests test/blackbox/metrics.bats

README.md

@@ -10,9 +10,13 @@ https://zotregistry.io
 
 **Check the [package repository](https://github.com/orgs/project-zot/packages?repo_name=zot) for your os/arch**
 
+The following document refers on the **core dist-spec**, see also the [zot-specific extensions spec](pkg/extensions/README.md)
+
+
 ## [**Why zot?**](COMPARISON.md)
 
 ## What's new?
+* Selectively add extensions on top of minimal build
 * Supports container image signatures - [cosign](https://github.com/sigstore/cosign) and [notation](https://github.com/notaryproject/notation)
 * Multi-arch support
 * Clustering support
@@ -96,6 +100,12 @@ make binary-stacker
 make
 ```
 
+* Build zot with specified extensions
+```
+make binary EXTENSIONS=extension1,extension2,extension3
+# e.g. make binary EXTENSIONS=sync,search,metrics,scrub
+```
+
 Build artifacts are in bin/
 
 # Serving

cmd/zxp/main.go

@@ -1,5 +1,5 @@
-//go:build minimal
-// +build minimal
+//go:build !metrics
+// +build !metrics
 
 package main
 

examples/config-sync-localhost.json

@@ -0,0 +1,37 @@
+{
+    "distspecversion":"1.0.1-dev",
+    "storage": {
+        "rootDirectory": "/tmp/zot_to_sync",
+        "dedupe": false,
+        "gc": false
+    },
+    "http": {
+        "address": "127.0.0.1",
+        "port": "8081"
+    },
+    "log": {
+        "level": "debug"
+    },
+    "extensions": {
+        "sync": {
+            "registries": [
+                {
+                    "urls": [
+                        "http://localhost:8080"
+                    ],
+                    "onDemand": true,
+                    "tlsVerify": false,
+                    "PollInterval": "30s",
+                    "content": [
+                        {
+                            "prefix": "**"
+                        }
+                    ]
+                }
+            ]
+        },
+        "scrub": {
+            "interval": "24h"
+        }
+    }
+}

pkg/api/controller.go

@@ -353,21 +353,23 @@ func (c *Controller) Shutdown() {
 func (c *Controller) StartBackgroundTasks(reloadCtx context.Context) {
 	// Enable extensions if extension config is provided for DefaultStore
 	if c.Config != nil && c.Config.Extensions != nil {
-		ext.EnableExtensions(c.Config, c.Log, c.Config.Storage.RootDirectory)
+		ext.EnableMetricsExtension(c.Config, c.Log, c.Config.Storage.RootDirectory)
+		ext.EnableSearchExtension(c.Config, c.Log, c.Config.Storage.RootDirectory)
 	}
 
 	if c.Config.Storage.SubPaths != nil {
 		for _, storageConfig := range c.Config.Storage.SubPaths {
 			// Enable extensions if extension config is provided for subImageStore
 			if c.Config != nil && c.Config.Extensions != nil {
-				ext.EnableExtensions(c.Config, c.Log, storageConfig.RootDirectory)
+				ext.EnableMetricsExtension(c.Config, c.Log, storageConfig.RootDirectory)
+				ext.EnableSearchExtension(c.Config, c.Log, storageConfig.RootDirectory)
 			}
 		}
 	}
 
 	// Enable extensions if extension config is provided for storeController
 	if c.Config.Extensions != nil {
-		if c.Config.Extensions.Sync != nil && *c.Config.Extensions.Sync.Enable {
+		if c.Config.Extensions.Sync != nil {
 			ext.EnableSyncExtension(reloadCtx, c.Config, c.wgShutDown, c.StoreController, c.Log)
 		}
 	}

pkg/api/controller_test.go

@@ -1,5 +1,5 @@
-//go:build extended
-// +build extended
+//go:build sync && scrub && metrics && search && ui_base
+// +build sync,scrub,metrics,search,ui_base
 
 package api_test
 

pkg/api/routes.go

@@ -121,7 +121,8 @@ func (rh *RouteHandler) SetupRoutes() {
 			prefixedRouter.HandleFunc("/metrics", rh.GetMetrics).Methods("GET")
 		} else {
 			// extended build
-			ext.SetupRoutes(rh.c.Config, rh.c.Router, rh.c.StoreController, rh.c.Log)
+			ext.SetupMetricsRoutes(rh.c.Config, rh.c.Router, rh.c.StoreController, rh.c.Log)
+			ext.SetupSearchRoutes(rh.c.Config, rh.c.Router, rh.c.StoreController, rh.c.Log)
 		}
 	}
 }

pkg/api/routes_test.go

@@ -1,5 +1,5 @@
-//go:build extended
-// +build extended
+//go:build sync && scrub && metrics && search && ui_base
+// +build sync,scrub,metrics,search,ui_base
 
 package api_test
 

pkg/cli/cli.go

@@ -1,5 +1,5 @@
-//go:build extended
-// +build extended
+//go:build ui_base || search
+// +build ui_base search
 
 package cli
 

pkg/cli/client.go

@@ -1,5 +1,5 @@
-//go:build extended
-// +build extended
+//go:build search || ui_base
+// +build search ui_base
 
 package cli
 

pkg/cli/client_elevated_test.go

@@ -1,5 +1,5 @@
-//go:build extended && needprivileges
-// +build extended,needprivileges
+//go:build ui_base && needprivileges
+// +build ui_base,needprivileges
 
 package cli //nolint:testpackage
 

pkg/cli/client_test.go

@@ -1,5 +1,5 @@
-//go:build extended
-// +build extended
+//go:build ui_base
+// +build ui_base
 
 package cli //nolint:testpackage
 

pkg/cli/config_cmd.go

@@ -1,5 +1,5 @@
-//go:build extended
-// +build extended
+//go:build search || ui_base
+// +build search ui_base
 
 package cli
 

pkg/cli/config_cmd_test.go

@@ -1,5 +1,5 @@
-//go:build extended
-// +build extended
+//go:build ui_base
+// +build ui_base
 
 package cli //nolint:testpackage
 

pkg/cli/cve_cmd.go

@@ -1,5 +1,5 @@
-//go:build extended
-// +build extended
+//go:build search || ui_base
+// +build search ui_base
 
 package cli