version.go

/*
Copyright 2020 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 (
	"fmt"
	"runtime"

	azuresdkversion "github.com/Azure/azure-sdk-for-go/version"
)

var (
	gitMajor     string // major version, always numeric
	gitMinor     string // minor version, numeric possibly followed by "+"
	gitVersion   string // semantic version, derived by build scripts
	gitCommit    string // sha1 from git, output of $(git rev-parse HEAD)
	gitTreeState string // state of git tree, either "clean" or "dirty"
	buildDate    string // build date in ISO8601 format, output of $(date -u +'%Y-%m-%dT%H:%M:%SZ')
)

// Info contains all version-related information.
type Info struct {
	Major           string `json:"major,omitempty"`
	Minor           string `json:"minor,omitempty"`
	GitVersion      string `json:"gitVersion,omitempty"`
	GitCommit       string `json:"gitCommit,omitempty"`
	GitTreeState    string `json:"gitTreeState,omitempty"`
	BuildDate       string `json:"buildDate,omitempty"`
	GoVersion       string `json:"goVersion,omitempty"`
	Compiler        string `json:"compiler,omitempty"`
	Platform        string `json:"platform,omitempty"`
	AzureSdkVersion string `json:"azureSdkVersion,omitempty"`
}

// Get returns version info initialized from defaults and the runtime environment.
func Get() Info {
	return Info{
		Major:           gitMajor,
		Minor:           gitMinor,
		GitVersion:      gitVersion,
		GitCommit:       gitCommit,
		GitTreeState:    gitTreeState,
		BuildDate:       buildDate,
		GoVersion:       runtime.Version(),
		Compiler:        runtime.Compiler,
		Platform:        fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH),
		AzureSdkVersion: fmt.Sprintf("v%s", azuresdkversion.Number),
	}
}

// String returns version info in a human-friendly format.
func (info Info) String() string {
	return info.GitVersion
}