summaryrefslogtreecommitdiff
path: root/internal/executable/executable_test.go
blob: 3915f1af20ba054651321d4ecf5aca483f64353f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
package executable

import (
	"errors"
	"testing"

	"gitlab.com/gitlab-org/gitlab-shell/internal/testhelper"

	"github.com/stretchr/testify/require"
)

type fakeOs struct {
	OldExecutable func() (string, error)
	Path          string
	Error         error
}

func (f *fakeOs) Executable() (string, error) {
	return f.Path, f.Error
}

func (f *fakeOs) Setup() {
	f.OldExecutable = osExecutable
	osExecutable = f.Executable
}

func (f *fakeOs) Cleanup() {
	osExecutable = f.OldExecutable
}

func TestNewSuccess(t *testing.T) {
	testCases := []struct {
		desc            string
		fakeOs          *fakeOs
		environment     map[string]string
		expectedRootDir string
	}{
		{
			desc:            "GITLAB_SHELL_DIR env var is not defined",
			fakeOs:          &fakeOs{Path: "/tmp/bin/gitlab-shell"},
			expectedRootDir: "/tmp",
		},
		{
			desc:   "GITLAB_SHELL_DIR env var is defined",
			fakeOs: &fakeOs{Path: "/opt/bin/gitlab-shell"},
			environment: map[string]string{
				"GITLAB_SHELL_DIR": "/tmp",
			},
			expectedRootDir: "/tmp",
		},
	}

	for _, tc := range testCases {
		t.Run(tc.desc, func(t *testing.T) {
			restoreEnv := testhelper.TempEnv(tc.environment)
			defer restoreEnv()

			fake := tc.fakeOs
			fake.Setup()
			defer fake.Cleanup()

			result, err := New("gitlab-shell")

			require.NoError(t, err)
			require.Equal(t, result.Name, "gitlab-shell")
			require.Equal(t, result.RootDir, tc.expectedRootDir)
		})
	}
}

func TestNewFailure(t *testing.T) {
	testCases := []struct {
		desc        string
		fakeOs      *fakeOs
		environment map[string]string
	}{
		{
			desc:   "failed to determine executable",
			fakeOs: &fakeOs{Path: "", Error: errors.New("error")},
		},
		{
			desc:   "GITLAB_SHELL_DIR doesn't exist",
			fakeOs: &fakeOs{Path: "/tmp/bin/gitlab-shell"},
			environment: map[string]string{
				"GITLAB_SHELL_DIR": "/tmp/non/existing/directory",
			},
		},
	}

	for _, tc := range testCases {
		t.Run(tc.desc, func(t *testing.T) {
			restoreEnv := testhelper.TempEnv(tc.environment)
			defer restoreEnv()

			fake := tc.fakeOs
			fake.Setup()
			defer fake.Cleanup()

			_, err := New("gitlab-shell")

			require.Error(t, err)
		})
	}
}