common/version.go

package common

import (
	"fmt"
	"runtime"
	"runtime/debug"

	"github.com/prometheus/client_golang/prometheus"
	"github.com/urfave/cli"
)

var (
	NAME     = "gitlab-runner"
	VERSION  = ""
	REVISION = ""
	BRANCH   = "HEAD"
	BUILT    = ""
)

var AppVersion = AppVersionInfo{
	Name:         NAME,
	Version:      VERSION,
	Revision:     REVISION,
	Branch:       BRANCH,
	GOVersion:    runtime.Version(),
	BuiltAt:      BUILT,
	OS:           runtime.GOOS,
	Architecture: runtime.GOARCH,
}

type AppVersionInfo struct {
	Name         string `json:"name"`
	Version      string `json:"version"`
	Revision     string `json:"revision"`
	Branch       string `json:"branch"`
	GOVersion    string `json:"go_version"`
	BuiltAt      string `json:"built_at"`
	OS           string `json:"os"`
	Architecture string `json:"architecture"`
}

func (v *AppVersionInfo) Printer(c *cli.Context) {
	fmt.Print(v.Extended())
}

func (v *AppVersionInfo) Line() string {
	return fmt.Sprintf("%s %s (%s)", v.Name, v.Version, v.Revision)
}

func (v *AppVersionInfo) ShortLine() string {
	return fmt.Sprintf("%s (%s)", v.Version, v.Revision)
}

func (v *AppVersionInfo) UserAgent() string {
	return fmt.Sprintf("%s %s (%s; %s; %s/%s)", v.Name, v.Version, v.Branch, v.GOVersion, v.OS, v.Architecture)
}

func (v *AppVersionInfo) Variables() JobVariables {
	return JobVariables{
		{Key: "CI_RUNNER_VERSION", Value: v.Version, Public: true, Internal: true, File: false},
		{Key: "CI_RUNNER_REVISION", Value: v.Revision, Public: true, Internal: true, File: false},
		{
			Key:      "CI_RUNNER_EXECUTABLE_ARCH",
			Value:    fmt.Sprintf("%s/%s", v.OS, v.Architecture),
			Public:   true,
			Internal: true,
			File:     false,
		},
	}
}

func (v *AppVersionInfo) Extended() string {
	version := fmt.Sprintf("Version:      %s\n", v.Version)
	version += fmt.Sprintf("Git revision: %s\n", v.Revision)
	version += fmt.Sprintf("Git branch:   %s\n", v.Branch)
	version += fmt.Sprintf("GO version:   %s\n", v.GOVersion)
	version += fmt.Sprintf("Built:        %s\n", v.BuiltAt)
	version += fmt.Sprintf("OS/Arch:      %s/%s\n", v.OS, v.Architecture)

	return version
}

// NewMetricsCollector returns a prometheus.Collector which represents current build information.
func (v *AppVersionInfo) NewMetricsCollector() *prometheus.GaugeVec {
	labels := map[string]string{
		"name":         v.Name,
		"version":      v.Version,
		"revision":     v.Revision,
		"branch":       v.Branch,
		"go_version":   v.GOVersion,
		"built_at":     v.BuiltAt,
		"os":           v.OS,
		"architecture": v.Architecture,
	}
	labelNames := make([]string, 0, len(labels))
	for n := range labels {
		labelNames = append(labelNames, n)
	}

	buildInfo := prometheus.NewGaugeVec(
		prometheus.GaugeOpts{
			Name: "gitlab_runner_version_info",
			Help: "A metric with a constant '1' value labeled by different build stats fields.",
		},
		labelNames,
	)
	buildInfo.With(labels).Set(1)
	return buildInfo
}

func init() {
	info, ok := debug.ReadBuildInfo()
	if ok {
		if AppVersion.Version == "" {
			AppVersion.Version = info.Main.Version
		}

		for _, setting := range info.Settings {
			switch {
			case setting.Key == "vcs.revision" && AppVersion.Revision == "" && len(setting.Value) >= 8:
				AppVersion.Revision = setting.Value[:8]

			case setting.Key == "vcs.time" && AppVersion.BuiltAt == "":
				AppVersion.BuiltAt = setting.Value
			}
		}
	}

	if AppVersion.Version == "" || AppVersion.Version == "(devel)" {
		AppVersion.Version = "development version"
	}

	if AppVersion.Revision == "" {
		AppVersion.Revision = "HEAD"
	}
}