vm based providers: Introduce Provision manager (kubevirt#982)

* vm based providers: Introduce Provision manager

Provision manager determines which providers to rebuild and
which to retag according previous released `KUBEVIRTCI_TAG`.

Motivation:
1. Freeze versions unless changed, less prone for regressions,
improves reproducibility and consistency.
3. Faster provisioning.
4. Decouple collision domains, if one provider is problematic,
we can still build other ones, without blocking them.

Flow:
It checks which files changed versus the latest `KUBEVIRTCI_TAG`.
For each changed file, it find the matching rule and accumulate a
list of targets to rebuild.

Signed-off-by: Or Shoval <[email protected]>

* gocli: Update vendor folder

Signed-off-by: Or Shoval <[email protected]>

* publish: Integrate provision manager

Signed-off-by: Or Shoval <[email protected]>

* pman: Extract filesystem functions to its own lib

Signed-off-by: Or Shoval <[email protected]>

* publish: Update kubevirtbot email

Signed-off-by: Or Shoval <[email protected]>

---------

Signed-off-by: Or Shoval <[email protected]>

Author: oshoval

.gitignore

@@ -14,3 +14,5 @@ cluster-provision/gocli/bazel-*
 # image builder
 *.qcow2
 cluster-provision/images/vm-image-builder/*_build
+
+cluster-provision/gocli/cover.out

cluster-provision/gocli/Makefile

@@ -13,6 +13,10 @@ GO ?= go
 
 all: container-run
 
+.PHONY: test
+test:
+	$(GO) test -v ./cmd/... -coverprofile cover.out
+
 .PHONY: gocli
 cli:
 	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 $(GO) build -ldflags "-X 'kubevirt.io/kubevirtci/cluster-provision/gocli/images.SUFFIX=:$(KUBEVIRTCI_TAG)'" -o $(BIN_DIR)/cli ./cmd/cli

cluster-provision/gocli/build/Dockerfile

@@ -1,4 +1,8 @@
-FROM scratch
+FROM alpine:3.18.0
+
+RUN apk add git
+WORKDIR /workdir
+RUN git config --global --add safe.directory /workdir
 
 COPY cli /cli
 

cluster-provision/gocli/cmd/PROVISION_MANAGER.md

@@ -0,0 +1,43 @@
+# Provision Manager
+
+## Purpose:
+Detect which files are changed versus the latest `KUBEVIRTCI_TAG`,
+and build only the providers which should be updated.
+The other providers will be reused by retagging their latest version.
+
+## Motivation:
+1. Freeze a state unless a change happens.
+2. Faster provision job.
+3. Reduce collision domain, a problem on one provider won't block updating the others.
+
+## Related Files:
+1. `hack/pman/rules.yaml` - the rules that determine which folder/file affects which provider.
+2. `hack/pman/force` - changing this file allows to enforce rebuild of all vm based providers.
+
+## Flow:
+1. Read rules.yaml and build a database of the rules.
+2. For each changed file (comparing to latest `KUBEVIRTCI_TAG`), check which rule match:  
+a. Check the full filename (relative to kubevirtci folder).  
+b. Check the `dirname` of the file  
+c. Check each of the `dirname`/* of the file and its parent directories (until `.`, not included).  
+If a match is found, the assicated rule is accumulated.
+Match must be found, unless the file is deleted,
+because we have rules which are regex, so once some files, are deleted also their rule will be gone.  
+The motivation is to have less to maintain when adding / removing new providers.
+
+See `Config` struct at `cluster-provision/gocli/cmd/provision_manager.go` for more details about rule types.
+
+## Parameters:
+`--debug` - Run in debug mode.
+Output has the following sections:
+1. Run Parameters such as the tag comparing to, and the targets detected.
+2. The expanded rules (based on rules file).
+3. The files that were detected, their git status, and what is their effect based on the rules.
+4. The cumulative targets (which is the output in case of non DEBUG mode as well).
+Example: `docker run --rm -v $(pwd):/workdir:Z quay.io/kubevirtci/gocli provision-manager --debug`
+
+## Notes:
+1. If you need to enforce provision of all providers, run and commit this file:
+`curl -sL https://storage.googleapis.com/kubevirt-prow/release/kubevirt/kubevirtci/latest?ignoreCache=1 > hack/pman/force`
+This is helpful in case you want a specific PR to rebuild all providers, without changing the publish job.
+2. In order to bypass provision manager and rebuild all targets, run `BYPASS_PMAN=true ./publish.sh`.

cluster-provision/gocli/cmd/cmd_suite_test.go

@@ -0,0 +1,13 @@
+package cmd_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestCmd(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Provision Manager Suite")
+}

cluster-provision/gocli/cmd/filesystem/filesystem.go

@@ -0,0 +1,90 @@
+package filesystem
+
+import (
+	"os"
+	"path/filepath"
+
+	"github.com/spf13/afero"
+)
+
+var fileSystem FileSystem = RealFileSystem{}
+
+type FileSystem interface {
+	Open(name string) (afero.File, error)
+	Glob(pattern string) ([]string, error)
+	Stat(name string) (os.FileInfo, error)
+}
+
+// RealFileSystem
+type RealFileSystem struct{}
+
+func (fs RealFileSystem) Open(name string) (afero.File, error) {
+	return os.Open(name)
+}
+
+func (fs RealFileSystem) Glob(pattern string) ([]string, error) {
+	return filepath.Glob(pattern)
+}
+
+func (fs RealFileSystem) Stat(name string) (os.FileInfo, error) {
+	return os.Stat(name)
+}
+
+// MockFileSystem
+type MockFileSystem struct {
+	fs afero.Fs
+}
+
+func (fs MockFileSystem) Open(name string) (afero.File, error) {
+	return fs.fs.Open(name)
+}
+
+func (fs MockFileSystem) Glob(pattern string) ([]string, error) {
+	return afero.Glob(fs.fs, pattern)
+}
+
+func (fs MockFileSystem) Stat(name string) (os.FileInfo, error) {
+	return fs.fs.Stat(name)
+}
+
+// General
+
+func SetMockFileSystem() {
+	fileSystem = MockFileSystem{fs: afero.NewMemMapFs()}
+}
+
+func SetRealFileSystem() {
+	fileSystem = RealFileSystem{}
+}
+
+func GetFileSystem() FileSystem {
+	return fileSystem
+}
+
+func GetFs() afero.Fs {
+	if mockFs, ok := fileSystem.(MockFileSystem); ok {
+		return mockFs.fs
+	} else {
+		return afero.NewOsFs()
+	}
+}
+
+func GlobDirectories(path string) ([]string, error) {
+	files, err := fileSystem.Glob(path)
+	if err != nil {
+		return nil, err
+	}
+
+	var directories []string
+	for _, candid := range files {
+		f, err := fileSystem.Stat(candid)
+		if err != nil {
+			return nil, err
+		}
+		if f.IsDir() {
+			directories = append(directories, candid)
+		}
+	}
+
+	return directories, nil
+}