info.go

// Copyright 2015 The Cockroach 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 build

import (
	"fmt"
	"runtime"
	"strings"
	"time"

	"github.com/cockroachdb/cockroach/pkg/util/envutil"
	version "github.com/hashicorp/go-version"
)

// const char* compilerVersion() {
// #if defined(__clang__)
// 	return __VERSION__;
// #elif defined(__GNUC__) || defined(__GNUG__)
// 	return "gcc " __VERSION__;
// #else
// 	return "non-gcc, non-clang (or an unrecognized version)";
// #endif
// }
import "C"

// TimeFormat is the reference format for build.Time. Make sure it stays in sync
// with the string passed to the linker in the root Makefile.
const TimeFormat = "2006/01/02 15:04:05"

var (
	// These variables are initialized via the linker -X flag in the
	// top-level Makefile when compiling release binaries.
	tag         = "unknown" // Tag of this build (git describe --tags w/ optional '-dirty' suffix)
	baseBranch  = "unknown" // Base branch of this build (git describe --tags --abbrev=0)
	utcTime     string      // Build time in UTC (year/month/day hour:min:sec)
	rev         string      // SHA-1 of this build (git rev-parse)
	cgoCompiler = C.GoString(C.compilerVersion())
	platform    = fmt.Sprintf("%s %s", runtime.GOOS, runtime.GOARCH)
	// Distribution is changed by the CCL init-time hook in non-APL builds.
	Distribution = "OSS"
	typ          string // Type of this build; <empty>, "release", or "musl"
)

// IsRelease returns true if the binary was produced by a "release" build.
func IsRelease() bool {
	return strings.HasPrefix(typ, "release")
}

// VersionPrefix returns the version prefix of the current build.
func VersionPrefix() string {
	v, err := version.NewVersion(baseBranch)
	if err != nil {
		return "dev"
	}
	semVer := v.Segments()[:2]
	return fmt.Sprintf("v%d.%d", semVer[0], semVer[1])
}

func init() {
	// Allow tests to override the tag.
	if tagOverride := envutil.EnvOrDefaultString(
		"COCKROACH_TESTING_VERSION_TAG", ""); tagOverride != "" {
		tag = tagOverride
	}
}

// Short returns a pretty printed build and version summary.
func (b Info) Short() string {
	return fmt.Sprintf("CockroachDB %s %s (%s, built %s, %s)", b.Distribution, b.Tag, b.Platform, b.Time, b.GoVersion)
}

// Timestamp parses the utcTime string and returns the number of seconds since epoch.
func (b Info) Timestamp() (int64, error) {
	val, err := time.Parse(TimeFormat, b.Time)
	if err != nil {
		return 0, err
	}
	return val.Unix(), nil
}

// GetInfo returns an Info struct populated with the build information.
func GetInfo() Info {
	return Info{
		GoVersion:    runtime.Version(),
		Tag:          tag,
		Time:         utcTime,
		Revision:     rev,
		CgoCompiler:  cgoCompiler,
		Platform:     platform,
		Distribution: Distribution,
		Type:         typ,
	}
}