have env trim whitespace

Author: linkdata

internal/gitsemver/environment.go

@@ -1,8 +1,12 @@
 package gitsemver
 
-import "os"
+import (
+	"os"
+	"strings"
+)
 
-// Environment allows us to mock the OS environment
+// Environment allows us to mock the OS environment.
+// Returns values with leading and trailing space trimmed.
 type Environment interface {
 	Getenv(string) string
 	LookupEnv(string) (string, bool)
@@ -12,9 +16,11 @@ type Environment interface {
 type OsEnvironment struct{}
 
 func (OsEnvironment) Getenv(key string) string {
-	return os.Getenv(key)
+	return strings.TrimSpace(os.Getenv(key))
 }
 
-func (OsEnvironment) LookupEnv(key string) (string, bool) {
-	return os.LookupEnv(key)
+func (OsEnvironment) LookupEnv(key string) (v string, ok bool) {
+	v, ok = os.LookupEnv(key)
+	v = strings.TrimSpace(v)
+	return
 }

internal/gitsemver/environment_test.go

@@ -2,6 +2,7 @@ package gitsemver_test
 
 import (
 	"os"
+	"strings"
 	"testing"
 
 	gitsemver "github.com/linkdata/gitsemver/internal/gitsemver"
@@ -17,7 +18,16 @@ func Test_OsEnvironment_Getenv(t *testing.T) {
 	}
 	expect := os.Getenv(VarName)
 	actual := env.Getenv(VarName)
-	if expect != actual {
+	if strings.TrimSpace(expect) != actual {
 		t.Error(actual)
 	}
 }
+
+func Test_OsEnvironment_Getenv_TrimsSpace(t *testing.T) {
+	const varName = "MKENV_TEST_TRIM_SPACE"
+	t.Setenv(varName, " \t trimmed value \n")
+	env := gitsemver.OsEnvironment{}
+	if got := env.Getenv(varName); got != "trimmed value" {
+		t.Fatalf("expected trimmed value, got %q", got)
+	}
+}

internal/gitsemver/gitsemver.go

@@ -5,7 +5,6 @@ import (
 	"fmt"
 	"io"
 	"strconv"
-	"strings"
 )
 
 // GitSemVer holds git metadata used while computing a version.
@@ -58,7 +57,7 @@ func (vs *GitSemVer) IsReleaseBranch(branchName string) bool {
 
 	// GitLab gives us the default branch name directly.
 	if defBranch, ok := vs.Env.LookupEnv("CI_DEFAULT_BRANCH"); ok {
-		return branchName == strings.TrimSpace(defBranch)
+		return branchName == defBranch
 	}
 
 	// Fallback to common default branch names.
@@ -145,7 +144,7 @@ func (vs *GitSemVer) examineTags(repo string) (err error) {
 // the closest semver tag if none match exactly. It also returns a bool
 // that is true if the tree hashes match and there are no uncommitted changes.
 func (vs *GitSemVer) GetTag(repo string) (tag string, match bool, err error) {
-	if ciTag := strings.TrimSpace(vs.Env.Getenv("CI_COMMIT_TAG")); ciTag != "" {
+	if ciTag := vs.Env.Getenv("CI_COMMIT_TAG"); ciTag != "" {
 		if isSemverTag(ciTag) {
 			return ciTag, true, nil
 		}
@@ -179,9 +178,9 @@ type gitHubPullRequestEvent struct {
 }
 
 func (vs *GitSemVer) getBranchGitHub(repo string) (branchName string, err error) {
-	if branchName = strings.TrimSpace(vs.Env.Getenv("GITHUB_BASE_REF")); branchName == "" {
-		if refName := strings.TrimSpace(vs.Env.Getenv("GITHUB_REF_NAME")); refName != "" {
-			if strings.TrimSpace(vs.Env.Getenv("GITHUB_REF_TYPE")) == "tag" {
+	if branchName = vs.Env.Getenv("GITHUB_BASE_REF"); branchName == "" {
+		if refName := vs.Env.Getenv("GITHUB_REF_NAME"); refName != "" {
+			if vs.Env.Getenv("GITHUB_REF_TYPE") == "tag" {
 				var branches []string
 				if branches, err = vs.Git.GetBranchesFromTag(repo, refName); err == nil {
 					for _, branchName = range branches {
@@ -198,10 +197,10 @@ func (vs *GitSemVer) getBranchGitHub(repo string) (branchName string, err error)
 }
 
 func (vs *GitSemVer) getBranchGitLab(repo string) (branchName string, err error) {
-	if branchName = strings.TrimSpace(vs.Env.Getenv("CI_MERGE_REQUEST_TARGET_BRANCH_NAME")); branchName == "" {
-		if branchName = strings.TrimSpace(vs.Env.Getenv("CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_NAME")); branchName == "" {
-			if branchName = strings.TrimSpace(vs.Env.Getenv("CI_COMMIT_REF_NAME")); branchName != "" {
-				if strings.TrimSpace(vs.Env.Getenv("CI_COMMIT_TAG")) == branchName {
+	if branchName = vs.Env.Getenv("CI_MERGE_REQUEST_TARGET_BRANCH_NAME"); branchName == "" {
+		if branchName = vs.Env.Getenv("CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_NAME"); branchName == "" {
+			if branchName = vs.Env.Getenv("CI_COMMIT_REF_NAME"); branchName != "" {
+				if vs.Env.Getenv("CI_COMMIT_TAG") == branchName {
 					var branches []string
 					if branches, err = vs.Git.GetBranchesFromTag(repo, branchName); err == nil {
 						for _, branchName = range branches {
@@ -236,8 +235,8 @@ func (vs *GitSemVer) GetBranch(repo string) (branchName string, err error) {
 // otherwise the Git commit count is used. Returns an empty string if no reasonable build
 // counter can be found.
 func (vs *GitSemVer) GetBuild(repo string) (build string, err error) {
-	if build = strings.TrimSpace(vs.Env.Getenv("CI_PIPELINE_IID")); build == "" {
-		if build = strings.TrimSpace(vs.Env.Getenv("GITHUB_RUN_NUMBER")); build == "" {
+	if build = vs.Env.Getenv("CI_PIPELINE_IID"); build == "" {
+		if build = vs.Env.Getenv("GITHUB_RUN_NUMBER"); build == "" {
 			build, err = vs.Git.GetBuild(repo)
 		}
 	}

internal/gitsemver/mockgitter_test.go

@@ -10,11 +10,12 @@ import (
 type MockEnvironment map[string]string
 
 func (me MockEnvironment) Getenv(key string) string {
-	return me[key]
+	return strings.TrimSpace(me[key])
 }
 
 func (me MockEnvironment) LookupEnv(key string) (val string, ok bool) {
 	val, ok = me[key]
+	val = strings.TrimSpace(val)
 	return
 }