Build version qualifier (elastic#8310)

using the BEAT_VERSION_QUALIFIER environment variable
Richardjgq · Sep 18, 2018 · 8137c44 · 8137c44
1 parent 06ae246
commit 8137c44
Show file tree

Hide file tree

Showing 11 changed files with 53 additions and 15 deletions.
diff --git a/auditbeat/magefile.go b/auditbeat/magefile.go
@@ -75,6 +75,7 @@ func Clean() error {
 // Package packages the Beat for distribution.
 // Use SNAPSHOT=true to build snapshots.
 // Use PLATFORMS to control the target platforms.
+// Use BEAT_VERSION_QUALIFIER to control the version qualifier.
 func Package() {
 	start := time.Now()
 	defer func() { fmt.Println("package ran for", time.Since(start)) }()

diff --git a/dev-tools/mage/build.go b/dev-tools/mage/build.go
@@ -53,6 +53,10 @@ func DefaultBuildArgs() BuildArgs {
 		},
 	}
 
+	if versionQualified {
+		args.Vars["github.com/elastic/beats/libbeat/version.qualifier"] = "{{ .Qualifier }}"
+	}
+
 	repo, err := GetProjectRepoInfo()
 	if err != nil {
 		panic(errors.Wrap(err, "failed to determine project repo info"))

diff --git a/dev-tools/mage/crossbuild.go b/dev-tools/mage/crossbuild.go
@@ -223,6 +223,9 @@ func (b GolangCrossBuilder) Build() error {
 			"--env", "EXEC_GID="+strconv.Itoa(os.Getgid()),
 		)
 	}
+	if versionQualified {
+		args = append(args, "--env", "BEAT_VERSION_QUALIFIER="+versionQualifier)
+	}
 	args = append(args,
 		"--rm",
 		"--env", "MAGEFILE_VERBOSE="+verbose,

diff --git a/dev-tools/mage/settings.go b/dev-tools/mage/settings.go
@@ -65,9 +65,12 @@ var (
 
 	Snapshot bool
 
+	versionQualified bool
+	versionQualifier string
+
 	FuncMap = map[string]interface{}{
 		"beat_doc_branch":   BeatDocBranch,
-		"beat_version":      BeatVersion,
+		"beat_version":      BeatQualifiedVersion,
 		"commit":            CommitHash,
 		"date":              BuildDate,
 		"elastic_beats_dir": ElasticBeatsDir,
@@ -98,6 +101,8 @@ func init() {
 	if err != nil {
 		panic(errors.Errorf("failed to parse SNAPSHOT env value", err))
 	}
+
+	versionQualifier, versionQualified = os.LookupEnv("BEAT_VERSION_QUALIFIER")
 }
 
 // EnvMap returns map containing the common settings variables and all variables
@@ -130,6 +135,7 @@ func varMap(args ...map[string]interface{}) map[string]interface{} {
 		"BeatLicense":     BeatLicense,
 		"BeatURL":         BeatURL,
 		"Snapshot":        Snapshot,
+		"Qualifier":       versionQualifier,
 	}
 
 	// Add the extra args to the map.
@@ -145,18 +151,19 @@ func varMap(args ...map[string]interface{}) map[string]interface{} {
 func dumpVariables() (string, error) {
 	var dumpTemplate = `## Variables
 
-GOOS            = {{.GOOS}}
-GOARCH          = {{.GOARCH}}
-GOARM           = {{.GOARM}}
-Platform        = {{.Platform}}
-BinaryExt       = {{.BinaryExt}}
-BeatName        = {{.BeatName}}
-BeatServiceName = {{.BeatServiceName}}
-BeatIndexPrefix = {{.BeatIndexPrefix}}
-BeatDescription = {{.BeatDescription}}
-BeatVendor      = {{.BeatVendor}}
-BeatLicense     = {{.BeatLicense}}
-BeatURL         = {{.BeatURL}}
+GOOS             = {{.GOOS}}
+GOARCH           = {{.GOARCH}}
+GOARM            = {{.GOARM}}
+Platform         = {{.Platform}}
+BinaryExt        = {{.BinaryExt}}
+BeatName         = {{.BeatName}}
+BeatServiceName  = {{.BeatServiceName}}
+BeatIndexPrefix  = {{.BeatIndexPrefix}}
+BeatDescription  = {{.BeatDescription}}
+BeatVendor       = {{.BeatVendor}}
+BeatLicense      = {{.BeatLicense}}
+BeatURL          = {{.BeatURL}}
+VersionQualifier = {{.Qualifier}}
 
 ## Functions
 
@@ -310,6 +317,20 @@ var (
 	beatVersionOnce  sync.Once
 )
 
+// BeatQualifiedVersion returns the Beat's qualified version.  The value can be overwritten by
+// setting BEAT_VERSION_QUALIFIER in the environment.
+func BeatQualifiedVersion() (string, error) {
+	version, err := BeatVersion()
+	if err != nil {
+		return "", err
+	}
+	// version qualifier can intentionally be set to "" to override build time var
+	if !versionQualified || versionQualifier == "" {
+		return version, nil
+	}
+	return version + "-" + versionQualifier, nil
+}
+
 // BeatVersion returns the Beat's version. The value can be overridden by
 // setting BEAT_VERSION in the environment.
 func BeatVersion() (string, error) {

diff --git a/filebeat/magefile.go b/filebeat/magefile.go
@@ -75,6 +75,7 @@ func Clean() error {
 // Package packages the Beat for distribution.
 // Use SNAPSHOT=true to build snapshots.
 // Use PLATFORMS to control the target platforms.
+// Use BEAT_VERSION_QUALIFIER to control the version qualifier.
 func Package() {
 	start := time.Now()
 	defer func() { fmt.Println("package ran for", time.Since(start)) }()

diff --git a/heartbeat/magefile.go b/heartbeat/magefile.go
@@ -75,6 +75,7 @@ func Clean() error {
 // Package packages the Beat for distribution.
 // Use SNAPSHOT=true to build snapshots.
 // Use PLATFORMS to control the target platforms.
+// Use BEAT_VERSION_QUALIFIER to control the version qualifier.
 func Package() {
 	start := time.Now()
 	defer func() { fmt.Println("package ran for", time.Since(start)) }()

diff --git a/libbeat/version/helper.go b/libbeat/version/helper.go
@@ -22,12 +22,16 @@ import "time"
 // GetDefaultVersion returns the current libbeat version.
 // This method is in a separate file as the version.go file is auto generated
 func GetDefaultVersion() string {
-	return defaultBeatVersion
+	if qualifier == "" {
+		return defaultBeatVersion
+	}
+	return defaultBeatVersion + "-" + qualifier
 }
 
 var (
 	buildTime = "unknown"
 	commit    = "unknown"
+	qualifier = "alpha1"
 )
 
 // BuildTime exposes the compile-time build time information.

diff --git a/libbeat/version/version.go b/libbeat/version/version.go
diff --git a/metricbeat/magefile.go b/metricbeat/magefile.go
@@ -75,6 +75,7 @@ func Clean() error {
 // Package packages the Beat for distribution.
 // Use SNAPSHOT=true to build snapshots.
 // Use PLATFORMS to control the target platforms.
+// Use BEAT_VERSION_QUALIFIER to control the version qualifier.
 func Package() {
 	start := time.Now()
 	defer func() { fmt.Println("package ran for", time.Since(start)) }()

diff --git a/packetbeat/magefile.go b/packetbeat/magefile.go
@@ -113,6 +113,7 @@ func Clean() error {
 // Package packages the Beat for distribution.
 // Use SNAPSHOT=true to build snapshots.
 // Use PLATFORMS to control the target platforms.
+// Use BEAT_VERSION_QUALIFIER to control the version qualifier.
 func Package() {
 	start := time.Now()
 	defer func() { fmt.Println("package ran for", time.Since(start)) }()

diff --git a/winlogbeat/magefile.go b/winlogbeat/magefile.go
@@ -75,6 +75,7 @@ func Clean() error {
 // Package packages the Beat for distribution.
 // Use SNAPSHOT=true to build snapshots.
 // Use PLATFORMS to control the target platforms.
+// Use BEAT_VERSION_QUALIFIER to control the version qualifier.
 func Package() {
 	start := time.Now()
 	defer func() { fmt.Println("package ran for", time.Since(start)) }()