add version directory with logic being moved to mimic controller-tools

Signed-off-by: Troy Connor <[email protected]>

Author: troy0820

Makefile

@@ -174,7 +174,7 @@ release-binary: $(RELEASE_DIR)
 		-v "$$(pwd):/workspace$(DOCKER_VOL_OPTS)" \
 		-w /workspace/tools/setup-envtest \
 		golang:$(GO_VERSION) \
-		go build -a -trimpath -ldflags "-X 'main.BranchVersion=$(RELEASE_TAG)' -extldflags '-static'" \
+		go build -a -trimpath -ldflags "-X 'sigs.k8s.io/controller-runtime/tools/setup-envtest/version.version=$(RELEASE_TAG)' -extldflags '-static'" \
 		-o ./out/$(RELEASE_BINARY) ./
 
 ## --------------------------------------

tools/setup-envtest/main.go

@@ -51,9 +51,6 @@ var (
 		"directory to store binary assets (default: $OS_SPECIFIC_DATA_DIR/envtest-binaries)")
 
 	index = flag.String("index", remote.DefaultIndexURL, "index to discover envtest binaries")
-
-	// BranchVersion is the current setup-envtest branch that is used for the binary version of setup-envtest.
-	BranchVersion = ""
 )
 
 // TODO(directxman12): handle interrupts?
@@ -277,9 +274,7 @@ Environment Variables:
 			PrintFormat: printFormat,
 		}.Do(env)
 	case "version":
-		workflows.Version{
-			BinaryVersion: BranchVersion,
-		}.Do(env)
+		workflows.Version{}.Do(env)
 	default:
 		flag.Usage()
 		envp.Exit(2, "unknown action %q", action)

tools/setup-envtest/version/version.go

@@ -0,0 +1,21 @@
+package version
+
+import "runtime/debug"
+
+// Version to be set using ldflags:
+// -ldflags "-X sigs.k8s.io/controller-tools/pkg/version.version=v1.0.0"
+// falls back to module information is unse
+var version = ""
+
+// Version returns the version of the main module
+func Version() string {
+	if version != "" {
+		return version
+	}
+	info, ok := debug.ReadBuildInfo()
+	if !ok || info == nil || info.Main.Version == "" {
+		// binary has not been built with module support or doesn't contain a version.
+		return "(unknown)"
+	}
+	return info.Main.Version
+}

tools/setup-envtest/version/version_suite_test.go

@@ -0,0 +1,27 @@
+/*
+Copyright 2024 The Kubernetes Authors.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package version
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestVersioning(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Test Version Suite")
+}

tools/setup-envtest/version/version_test.go

@@ -0,0 +1,54 @@
+/*
+Copyright 2024 The Kubernetes Authors.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+
+See the License for the specific language governing permissions and
+
+limitations under the License.
+*/
+
+package version
+
+import (
+	"runtime/debug"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("TestVersion", func() {
+
+	info, ok := debug.ReadBuildInfo()
+	Expect(ok).To(BeTrue())
+	tests := map[string]struct {
+		version  string
+		expected string
+	}{
+		"empty returns build info": {
+			version:  "",
+			expected: info.Main.Version,
+		},
+		"set to a value returns it": {
+			version:  "1.2.3",
+			expected: "1.2.3",
+		},
+	}
+	for name, tc := range tests {
+		It("Version set to "+name, func() {
+			versionBackup := version
+			defer func() {
+				version = versionBackup
+			}()
+			version = tc.version
+			result := Version()
+			Expect(result).To(Equal(tc.expected))
+		})
+	}
+})

tools/setup-envtest/workflows/workflows.go

@@ -7,11 +7,11 @@ import (
 	"context"
 	"fmt"
 	"io"
-	"runtime/debug"
 
 	"github.com/go-logr/logr"
 
 	envp "sigs.k8s.io/controller-runtime/tools/setup-envtest/env"
+	"sigs.k8s.io/controller-runtime/tools/setup-envtest/version"
 )
 
 // Use is a workflow that prints out information about stored
@@ -90,20 +90,9 @@ func (f Sideload) Do(env *envp.Env) {
 
 // Version is the workflow that shows the current binary version
 // of setup-envtest.
-type Version struct {
-	BinaryVersion string
-}
+type Version struct{}
 
 // Do executes the workflow.
 func (v Version) Do(env *envp.Env) {
-	version := "(unknown)"
-	if v.BinaryVersion == "" {
-		info, ok := debug.ReadBuildInfo()
-		if ok && info != nil && info.Main.Version != "" {
-			// binary has been built with module support.
-			version = info.Main.Version
-		}
-		v.BinaryVersion = version
-	}
-	fmt.Fprintf(env.Out, "setup-envtest version: %s\n", v.BinaryVersion)
+	fmt.Fprintf(env.Out, "setup-envtest version: %s\n", version.Version())
 }

tools/setup-envtest/workflows/workflows_test.go

@@ -446,15 +446,6 @@ var _ = Describe("Workflows", func() {
 	})
 
 	Describe("version", func() {
-		It("should print out the version based on the Binary Version", func() {
-			v := wf.Version{
-				BinaryVersion: "v0.18.2",
-			}
-			v.Do(env)
-			Expect(out.String()).ToNot(BeEmpty())
-			Expect(out.String()).To(Equal("setup-envtest version: v0.18.2\n"))
-		})
-
 		It("should print out the version if the RELEASE_TAG is empty", func() {
 			v := wf.Version{}
 			v.Do(env)