Add channel to worker logs

.github/workflows/tests.yml

@@ -33,7 +33,7 @@ jobs:
         run: git config --global --add safe.directory "$(pwd)"
 
       - name: Run unit tests
-        run: go test -race -covermode=atomic -coverprofile=coverage.txt -coverpkg=$(go list ./... | grep -v rpmmd/test$ | tr "\n" ",") ./...
+        run: make unit-tests
 
       - uses: codecov/codecov-action@v4
         if: env.CODECOV_TOKEN

.gitignore

@@ -17,3 +17,8 @@ __pycache__
 container_composer_golangci_built.info
 processed-templates
 
+coverage.txt
+coverage.html
+
+coverage_splunk_logger.txt
+coverage_splunk_logger.html

Makefile

@@ -90,6 +90,7 @@ help:
 	@echo "                        (do this before pushing!)"
 	@echo "    lint:               Runs linters as close as github workflow as possible"
 	@echo "    process-templates:  Execute the OpenShift CLI to check the templates"
+	@echo "    coverage-report:    Run unit tests and generate HTML coverage reports"
 
 $(BUILDDIR)/:
 	mkdir -p "$@"
@@ -234,8 +235,17 @@ worker-key-pair: ca
 	rm /etc/osbuild-composer/worker-csr.pem
 
 .PHONY: unit-tests
+.ONESHELL:
 unit-tests:
-	go test -race ./...
+	go test -race -covermode=atomic -coverprofile=coverage.txt -coverpkg=$$(go list ./... | tr "\n" ",") ./...
+	# go modules with go.mod in subdirs are not tested automatically
+	cd pkg/splunk_logger
+	go test -race -covermode=atomic -coverprofile=../../coverage_splunk_logger.txt -coverpkg=$$(go list ./... | tr "\n" ",") ./...
+
+.PHONY: coverage-report
+coverage-report: unit-tests
+	go tool cover -o coverage.html -html coverage.txt
+	go tool cover -o coverage_splunk_logger.html -html coverage_splunk_logger.txt
 
 #
 # Building packages

cmd/osbuild-composer/main.go

@@ -85,7 +85,7 @@ func main() {
 	}
 
 	if config.DeploymentChannel != "" {
-		logrus.AddHook(&common.EnvironmentHook{Channel: config.DeploymentChannel})
+		logrus.AddHook(&slogger.EnvironmentHook{Channel: config.DeploymentChannel})
 	}
 
 	if config.SplunkHost != "" {

cmd/osbuild-worker/config.go

@@ -103,6 +103,8 @@ type workerConfig struct {
 	// default value: &{ Type: host }
 	OSBuildExecutor      *executorConfig       `toml:"osbuild_executor"`
 	RepositoryMTLSConfig *repositoryMTLSConfig `toml:"repository_mtls"`
+	// something like "production" or "staging" to be added to logging
+	DeploymentChannel string `toml:"deployment_channel"`
 }
 
 func parseConfig(file string) (*workerConfig, error) {
@@ -112,6 +114,7 @@ func parseConfig(file string) (*workerConfig, error) {
 		OSBuildExecutor: &executorConfig{
 			Type: "host",
 		},
+		DeploymentChannel: "local",
 	}
 
 	_, err := toml.DecodeFile(file, &config)

cmd/osbuild-worker/config_test.go

@@ -136,6 +136,7 @@ cloudwatch_group = "osbuild-worker"
 					Credentials: "/etc/osbuild-worker/pulp-creds",
 					ServerURL:   "https://example.com/pulp",
 				},
+				DeploymentChannel: "local",
 			},
 		},
 		{
@@ -146,6 +147,18 @@ cloudwatch_group = "osbuild-worker"
 				OSBuildExecutor: &executorConfig{
 					Type: "host",
 				},
+				DeploymentChannel: "local",
+			},
+		},
+		{
+			name:   "set_channel",
+			config: `deployment_channel = "staging"`,
+			want: &workerConfig{
+				BasePath: "/api/worker/v1",
+				OSBuildExecutor: &executorConfig{
+					Type: "host",
+				},
+				DeploymentChannel: "staging",
 			},
 		},
 	}

cmd/osbuild-worker/main.go

@@ -7,6 +7,7 @@ import (
 	"errors"
 	"flag"
 	"fmt"
+	slogger "github.com/osbuild/osbuild-composer/pkg/splunk_logger"
 	"net/url"
 	"os"
 	"path"
@@ -193,6 +194,10 @@ func main() {
 		logrus.Fatalf("Could not print config: %v", err)
 	}
 
+	if config.DeploymentChannel != "" {
+		logrus.AddHook(&slogger.EnvironmentHook{Channel: config.DeploymentChannel})
+	}
+
 	cacheDirectory, ok := os.LookupEnv("CACHE_DIRECTORY")
 	if !ok {
 		logrus.Fatal("CACHE_DIRECTORY is not set. Is the service file missing CacheDirectory=?")

go.mod

@@ -47,7 +47,7 @@ require (
 	github.com/openshift-online/ocm-sdk-go v0.1.432
 	github.com/oracle/oci-go-sdk/v54 v54.0.0
 	github.com/osbuild/images v0.79.0
-	github.com/osbuild/osbuild-composer/pkg/splunk_logger v0.0.0-20231117174845-e969a9dc3cd1
+	github.com/osbuild/osbuild-composer/pkg/splunk_logger v0.0.0-20240814102216-0239db53236d
 	github.com/osbuild/pulp-client v0.1.0
 	github.com/prometheus/client_golang v1.19.1
 	github.com/segmentio/ksuid v1.0.4

go.sum

@@ -510,8 +510,8 @@ github.com/oracle/oci-go-sdk/v54 v54.0.0 h1:CDLjeSejv2aDpElAJrhKpi6zvT/zhZCZuXch
 github.com/oracle/oci-go-sdk/v54 v54.0.0/go.mod h1:+t+yvcFGVp+3ZnztnyxqXfQDsMlq8U25faBLa+mqCMc=
 github.com/osbuild/images v0.79.0 h1:6kBRo0WzmyQTZ4ojX1oU9nIxBazZOO4I3FLsZaz8268=
 github.com/osbuild/images v0.79.0/go.mod h1:Rzud9PFt0L9qFFlisL9I6OsZ2h0M6viMBdPhPtpwfwg=
-github.com/osbuild/osbuild-composer/pkg/splunk_logger v0.0.0-20231117174845-e969a9dc3cd1 h1:UFEJIcPa46W8gtWgOYzriRKYyy1t6SWL0BI7fPTuVvc=
-github.com/osbuild/osbuild-composer/pkg/splunk_logger v0.0.0-20231117174845-e969a9dc3cd1/go.mod h1:z+WA+dX6qMwc7fqY5jCzESDIlg4WR2sBQezxsoXv9Ik=
+github.com/osbuild/osbuild-composer/pkg/splunk_logger v0.0.0-20240814102216-0239db53236d h1:r9BFPDv0uuA9k1947Jybcxs36c/pTywWS1gjeizvtcQ=
+github.com/osbuild/osbuild-composer/pkg/splunk_logger v0.0.0-20240814102216-0239db53236d/go.mod h1:zR1iu/hOuf+OQNJlk70tju9IqzzM4ycq0ectkFBm94U=
 github.com/osbuild/pulp-client v0.1.0 h1:L0C4ezBJGTamN3BKdv+rKLuq/WxXJbsFwz/Hj7aEmJ8=
 github.com/osbuild/pulp-client v0.1.0/go.mod h1:rd/MLdfwwO2cQI1s056h8z32zAi3Bo90XhlAAryIvWc=
 github.com/ostreedev/ostree-go v0.0.0-20210805093236-719684c64e4f h1:/UDgs8FGMqwnHagNDPGOlts35QkhAZ8by3DR7nMih7M=

templates/packer/ansible/roles/common/files/worker-initialization-scripts/client_credentials.sh

@@ -20,6 +20,7 @@ jq -r ".client_secret" /tmp/client-credentials.json > /etc/osbuild-worker/client
 rm -f /tmp/client-credentials.json
 
 sudo tee -a /etc/osbuild-worker/osbuild-worker.toml > /dev/null << EOF
+deployment_channel = "${CHANNEL:-local}"
 [authentication]
 oauth_url = "${TOKEN_URL:-https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token}"
 client_id = "${CLIENT_ID}"

tmt/plans/edge-test.fmf

@@ -11,6 +11,8 @@ provision:
     cpu:
       processors: ">= 2"
     memory: ">= 6 GB"
+    disk:
+      - size: ">= 15 GB"
 
 /edge-x86-commit:
   summary: Test edge commit

vendor/modules.txt

@@ -989,8 +989,8 @@ github.com/osbuild/images/pkg/rhsm
 github.com/osbuild/images/pkg/rhsm/facts
 github.com/osbuild/images/pkg/rpmmd
 github.com/osbuild/images/pkg/runner
-# github.com/osbuild/osbuild-composer/pkg/splunk_logger v0.0.0-20231117174845-e969a9dc3cd1
-## explicit; go 1.19
+# github.com/osbuild/osbuild-composer/pkg/splunk_logger v0.0.0-20240814102216-0239db53236d
+## explicit; go 1.21
 github.com/osbuild/osbuild-composer/pkg/splunk_logger
 # github.com/osbuild/pulp-client v0.1.0
 ## explicit; go 1.19