gitinfo_test.go

package main

import (
	"os"
	"testing"
)

func TestLoadBranchFromEnv(t *testing.T) {
	t.Parallel()

	var tests = []struct {
		testCase       string
		envs           map[string]string
		expectedBranch string
	}{
		{
			"all vars defined",
			map[string]string{
				"GIT_BRANCH":           "master",
				"CIRCLE_BRANCH":        "circle-master",
				"TRAVIS_BRANCH":        "travis-master",
				"CI_BRANCH":            "ci-master",
				"APPVEYOR_REPO_BRANCH": "appveyor-master",
				"WERCKER_GIT_BRANCH":   "wercker-master",
				"DRONE_BRANCH":         "drone-master",
				"BUILDKITE_BRANCH":     "buildkite-master",
				"BRANCH_NAME":          "jenkins-master",
				"CI_COMMIT_REF_NAME":   "gitlab-master",
			},
			"master",
		},
		{
			"all except GIT_BRANCH",
			map[string]string{
				"CIRCLE_BRANCH":        "circle-master",
				"TRAVIS_BRANCH":        "travis-master",
				"CI_BRANCH":            "ci-master",
				"APPVEYOR_REPO_BRANCH": "appveyor-master",
				"WERCKER_GIT_BRANCH":   "wercker-master",
				"DRONE_BRANCH":         "drone-master",
				"BUILDKITE_BRANCH":     "buildkite-master",
				"BRANCH_NAME":          "jenkins-master",
				"CI_COMMIT_REF_NAME":   "gitlab-master",
			},
			"circle-master",
		},
		{
			"all except GIT_BRANCH and CIRCLE_BRANCH",
			map[string]string{
				"TRAVIS_BRANCH":        "travis-master",
				"CI_BRANCH":            "ci-master",
				"APPVEYOR_REPO_BRANCH": "appveyor-master",
				"WERCKER_GIT_BRANCH":   "wercker-master",
				"DRONE_BRANCH":         "drone-master",
				"BUILDKITE_BRANCH":     "buildkite-master",
				"BRANCH_NAME":          "jenkins-master",
				"CI_COMMIT_REF_NAME":   "gitlab-master",
			},
			"travis-master",
		},
		{
			"only CI_BRANCH defined",
			map[string]string{
				"CI_BRANCH": "ci-master",
			},
			"ci-master",
		},
		{
			"only APPVEYOR_REPO_BRANCH defined",
			map[string]string{
				"APPVEYOR_REPO_BRANCH": "appveyor-master",
			},
			"appveyor-master",
		},
		{
			"only WERCKER_GIT_BRANCH defined",
			map[string]string{
				"WERCKER_GIT_BRANCH": "wercker-master",
			},
			"wercker-master",
		},
		{
			"only BRANCH_NAME defined",
			map[string]string{
				"BRANCH_NAME": "jenkins-master",
			},
			"jenkins-master",
		},
		{
			"only BUILDKITE_BRANCH defined",
			map[string]string{
				"BUILDKITE_BRANCH": "buildkite-master",
			},
			"buildkite-master",
		},
		{
			"only DRONE_BRANCH defined",
			map[string]string{
				"DRONE_BRANCH": "drone-master",
			},
			"drone-master",
		},
		{
			"only CI_COMMIT_REF_NAME defined",
			map[string]string{
				"CI_COMMIT_REF_NAME": "gitlab-master",
			},
			"gitlab-master",
		},
		{
			"GitHub Action push event",
			map[string]string{
				"GITHUB_REF": "refs/heads/github-master",
			},
			"github-master",
		},
		{
			"no branch var defined",
			map[string]string{},
			"",
		},
	}
	for _, test := range tests {
		resetBranchEnvs(test.envs)
		envBranch := loadBranchFromEnv()
		if envBranch != test.expectedBranch {
			t.Errorf("%s: wrong branch returned. Expected %q, but got %q", test.testCase, test.expectedBranch, envBranch)
		}
	}
}

func resetBranchEnvs(values map[string]string) {
	for _, envVar := range varNames {
		os.Unsetenv(envVar)
	}
	for k, v := range values {
		os.Setenv(k, v)
	}
}