OCPBUGS-60903: v2/version: output ocp release version

A commit hash cannot be easily related to an ocp release version.

Author: r4f4

v2/internal/pkg/version/version.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"os"
 	"runtime"
+	"strings"
 
 	clog "github.com/openshift/oc-mirror/v2/internal/pkg/log"
 	"github.com/spf13/cobra"
@@ -28,8 +29,37 @@ var (
 	buildDate string
 	// state of git tree, either "clean" or "dirty"
 	gitTreeState string
+
+	// releaseVersionPadded may be replaced in the binary with Release
+	// Metadata: Version that overrides defaultVersion as a null-terminated
+	// string within the allowed character length. This allows a distributor to
+	// override the version without having to rebuild the source.
+	releaseVersionPadded = "\x00_RELEASE_VERSION_LOCATION_\x00XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\x00"
+	releaseVersionPrefix = "\x00_RELEASE_VERSION_LOCATION_\x00"
+	releaseVersionLength = len(releaseVersionPadded)
 )
 
+func Version() (string, error) {
+	if strings.HasPrefix(releaseVersionPadded, releaseVersionPrefix) {
+		return fmt.Sprintf("unreleased-%s", commitFromGit), nil
+	}
+	nullTerminator := strings.IndexByte(releaseVersionPadded, '\x00')
+	if nullTerminator == -1 {
+		// the binary has been altered, but we didn't find a null terminator within the release name constant which is an error
+		return commitFromGit, fmt.Errorf("release name location was replaced but without a null terminator before %d bytes", releaseVersionLength)
+	} else if nullTerminator > releaseVersionLength {
+		// the binary has been altered, but the null terminator is *longer* than the constant encoded in the library
+		return commitFromGit, fmt.Errorf("release name location contains no null-terminator and constant is corrupted")
+	}
+	releaseName := releaseVersionPadded[:nullTerminator]
+	if len(releaseName) == 0 {
+		// the binary has been altered, but the replaced release name is empty which is incorrect
+		// the oc binary will not be pinned to Release Metadata: Version
+		return commitFromGit, fmt.Errorf("release name was incorrectly replaced during extract")
+	}
+	return releaseName, nil
+}
+
 type Info struct {
 	Major        string `json:"major"`
 	Minor        string `json:"minor"`
@@ -48,8 +78,8 @@ type VersionOptions struct {
 	V2     bool
 }
 
-// Version is a struct for version information
-type Version struct {
+// VersionInfo is a struct for version information
+type VersionInfo struct {
 	ClientVersion *Info `json:"clientVersion,omitempty" yaml:"clientVersion,omitempty"`
 }
 
@@ -98,15 +128,15 @@ func (o *VersionOptions) Validate() error {
 }
 
 func (o *VersionOptions) Run() error {
-	var versionInfo Version
+	var versionInfo VersionInfo
 
 	clientVersion := Get()
 	versionInfo.ClientVersion = &clientVersion
 
 	switch o.Output {
 	case "":
 		if o.Short {
-			fmt.Fprintf(os.Stdout, "Client Version: %s\n", clientVersion.GitVersion)
+			fmt.Fprintf(os.Stdout, "Client Version: %s\n", clientVersion.Major)
 		} else {
 			fmt.Fprintf(os.Stderr, "WARNING: This version information is deprecated and will be replaced with the output from --short. Use --output=yaml|json to get the full version.\n")
 			fmt.Fprintf(os.Stdout, "Client Version: %#v\n", clientVersion)
@@ -131,9 +161,13 @@ func (o *VersionOptions) Run() error {
 }
 
 func Get() Info {
+	version, err := Version()
+	if err != nil {
+		panic(fmt.Errorf("could not assembler binary version: %w", err))
+	}
 	return Info{
-		Major:        majorFromGit,
-		Minor:        minorFromGit,
+		Major:        version,
+		Minor:        version,
 		GitCommit:    commitFromGit,
 		GitVersion:   versionFromGit,
 		GitTreeState: gitTreeState,