-
Notifications
You must be signed in to change notification settings - Fork 1
/
client_test.go
255 lines (210 loc) · 10.3 KB
/
client_test.go
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
package vagrant_go
import (
"errors"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"testing"
)
func TestNewClient(t *testing.T) {
t.Run(
"with nil `config`, `commandRunFunc` and `lookPathFunc` given, it uses default config and probably `realCommandRunFunc` and `realLookPathFunc`",
func(t *testing.T) {
t.Parallel()
client, err := NewClient(nil, nil, nil)
require.NoError(t, err)
assert.NotNil(t, client)
assert.Equal(t, defaultBinaryName, client.Config.BinaryName)
assert.NotNil(t, client.commandRunFunc)
assert.NotNil(t, client.Box)
assert.NotNil(t, client.Global)
},
)
t.Run(
"with 'config.BinaryName' = vagrant123, it uses provided 'BinaryName'",
func(t *testing.T) {
t.Parallel()
config := DefaultConfig()
config.BinaryName = "vagrant123"
lookPathFunc := func(binaryName string) (string, error) {
return "/tmp/vagrant123", nil
}
client, err := NewClient(config, nil, lookPathFunc)
require.NoError(t, err)
assert.NotNil(t, client)
assert.Equal(t, "vagrant123", client.Config.BinaryName)
assert.NotNil(t, client.commandRunFunc)
assert.NotNil(t, client.Box)
assert.NotNil(t, client.Global)
},
)
t.Run(
"with 'clientLookPathFunc' returning an error, it returns error that 'config.BinaryName' is not found",
func(t *testing.T) {
t.Parallel()
config := DefaultConfig()
config.BinaryName = "vagrant123"
isLookPathFuncCalled := false
clientLookPathFunc := func(binaryName string) (string, error) {
assert.Equal(t, "vagrant123", binaryName)
isLookPathFuncCalled = true
return "/tmp/example", errors.New("fake error")
}
client, err := NewClient(
config,
nil,
clientLookPathFunc,
)
assert.Error(t, err, "fake error")
assert.Nil(t, client)
assert.True(t, isLookPathFuncCalled)
},
)
}
func TestExecuteVagrantCommand(t *testing.T) {
t.Run(
"when there's no command execution error, it executes command with given 'args' and returns parsed machine readable output and no error",
func(t *testing.T) {
t.Parallel()
client := emptyTestClient(t)
isCommandRunCalled := false
args := []string{"version"}
fakeOutput := "1546430404,default,provider-name,libvirt"
client.commandRunFunc = func(cmd string, args ...string) (bytes []byte, e error) {
assert.Equal(t, cmd, client.Config.BinaryName)
assert.Len(t, args, 2)
isCommandRunCalled = true
return []byte(fakeOutput), nil
}
outputLines, err := client.executeVagrantCommand(args...)
require.NoError(t, err)
assert.Equal(t, len(outputLines), 1)
assert.Equal(t, outputLines[0].timestamp, "1546430404")
assert.Equal(t, outputLines[0].target, "default")
assert.Equal(t, outputLines[0].kind, "provider-name")
assert.Equal(t, len(outputLines[0].data), 1)
assert.Equal(t, outputLines[0].data[0], "libvirt")
assert.True(t, isCommandRunCalled)
},
)
t.Run(
"when there's a command execution error, it executes command with given 'args' and returns parsed machine readable output and error",
func(t *testing.T) {
t.Parallel()
client := emptyTestClient(t)
isCommandRunCalled := false
args := []string{"version"}
fakeOutput := "1546430404,default,provider-name,libvirt"
fakeErrorMessage := "fakeCommandRunError"
client.commandRunFunc = func(cmd string, args ...string) (bytes []byte, e error) {
assert.Equal(t, cmd, client.Config.BinaryName)
assert.Len(t, args, 2)
assert.Equal(t, args[0], "--machine-readable")
assert.Equal(t, args[1], "version")
isCommandRunCalled = true
return []byte(fakeOutput), errors.New(fakeErrorMessage)
}
outputLines, err := client.executeVagrantCommand(args...)
require.Error(t, err, fakeErrorMessage)
assert.Equal(t, len(outputLines), 1)
assert.Equal(t, outputLines[0].timestamp, "1546430404")
assert.Equal(t, outputLines[0].target, "default")
assert.Equal(t, outputLines[0].kind, "provider-name")
assert.Equal(t, len(outputLines[0].data), 1)
assert.Equal(t, outputLines[0].data[0], "libvirt")
assert.True(t, isCommandRunCalled)
},
)
}
func TestParseMachineReadableOutput(t *testing.T) {
t.Run(
"with machine readable output in format 'timestamp,target,type,data...' as per https://www.vagrantup.com/docs/cli/machine-readable.html, it returns slice of parsed lines",
func(t *testing.T) {
t.Parallel()
client := emptyTestClient(t)
output := `
1546430404,default,metadata,provider,libvirt
1546430404,default,provider-name,libvirt
1546430404,default,state,running
1546430404,default,state-human-short,running
1546430404,default,state-human-long,The Libvirt domain is running. To stop this machine%!(VAGRANT_COMMA) you can run\n'vagrant halt''. To destroy the machine%!(VAGRANT_COMMA) you can run 'vagrant destroy'.
1546430404,,ui,info,Current machine states:\n\ndefault running (libvirt)\n\nThe Libvirt domain is running. To stop this machine%!(VAGRANT_COMMA) you can run\n'vagrant halt''. To destroy the machine%!(VAGRANT_COMMA) you can run 'vagrant destroy'.
`
lines := client.parseMachineReadableOutput(output)
require.NotNil(t, lines)
require.Len(t, lines, 4)
actualLine := lines[0]
assert.Equal(t, "1546430404", actualLine.timestamp)
assert.Equal(t, "default", actualLine.target)
assert.Equal(t, "provider-name", actualLine.kind)
require.Len(t, actualLine.data, 1)
assert.Equal(t, "libvirt", actualLine.data[0])
actualLine = lines[1]
assert.Equal(t, "1546430404", actualLine.timestamp)
assert.Equal(t, "default", actualLine.target)
assert.Equal(t, "state", actualLine.kind)
require.Len(t, actualLine.data, 1)
assert.Equal(t, "running", actualLine.data[0])
actualLine = lines[2]
assert.Equal(t, "1546430404", actualLine.timestamp)
assert.Equal(t, "default", actualLine.target)
assert.Equal(t, "state-human-short", actualLine.kind)
require.Len(t, actualLine.data, 1)
assert.Equal(t, "running", actualLine.data[0])
actualLine = lines[3]
assert.Equal(t, "1546430404", actualLine.timestamp)
assert.Equal(t, "default", actualLine.target)
assert.Equal(t, "state-human-long", actualLine.kind)
require.Len(t, actualLine.data, 1)
// NOTE: It's expected to lose the full actual output due to newlines
assert.Equal(t,
`The Libvirt domain is running. To stop this machine%!(VAGRANT_COMMA) you can run\n'vagrant halt''. To destroy the machine%!(VAGRANT_COMMA) you can run 'vagrant destroy'.`,
actualLine.data[0],
)
},
)
t.Run(
"with blank output, it returns empty slice of lines",
func(t *testing.T) {
t.Parallel()
client := emptyTestClient(t)
lines := client.parseMachineReadableOutput("")
require.NotNil(t, lines)
assert.Empty(t, lines)
},
)
t.Run(
"with non-machine readable output, that is not blank, it returns empty slice of lines",
func(t *testing.T) {
t.Parallel()
client := emptyTestClient(t)
// NOTE: Can you think of a more ridiculous output? :)
output := `
(Not all processes could be identified, non-owned process info
will not be shown, you would have to be root to see it all.)
Active Internet connections (servers and established)
Proto Recv-Q Send-Q Local Address Foreign Address State PID/Program name
tcp 0 0 127.0.0.1:63342 0.0.0.0:* LISTEN 7624/java
tcp 0 0 0.0.0.0:111 0.0.0.0:* LISTEN -
tcp 0 0 0.0.0.0:57621 0.0.0.0:* LISTEN 7376/spotify
tcp 0 0 0.0.0.0:39351 0.0.0.0:* LISTEN 7376/spotify
tcp 0 0 127.0.0.1:631 0.0.0.0:* LISTEN -
tcp 0 0 127.0.0.1:6942 0.0.0.0:* LISTEN 7624/java
tcp 0 0 127.0.0.1:38183 0.0.0.0:* LISTEN 4958/usr/share/jetb
tcp 0 0 192.168.13.37:43778 192.121.140.177:80 ESTABLISHED 7376/spotify
`
lines := client.parseMachineReadableOutput(output)
require.NotNil(t, lines)
assert.Empty(t, lines)
},
)
t.Run(
"with blank output, it returns empty slice of lines",
func(t *testing.T) {
t.Parallel()
client := emptyTestClient(t)
lines := client.parseMachineReadableOutput("")
require.NotNil(t, lines)
assert.Empty(t, lines)
},
)
}