/
scaffold_test.go
363 lines (329 loc) · 10.4 KB
/
scaffold_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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
package main_test
import (
"io/ioutil"
"os"
"path/filepath"
. "github.com/rightscale/right_st"
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
"github.com/onsi/gomega/gbytes"
)
var _ = Describe("RightScript Scaffold", func() {
var (
buffer *gbytes.Buffer
tempDir string
emptyScript string
emptyScriptMetadata string
metadataScript string
metadataScriptContents string
shellScript string
shellScriptContents string
shellScriptMetadata string
rubyScript string
rubyScriptContents string
rubyScriptMetadata string
perlScript string
perlScriptContents string
perlScriptMetadata string
powershellScript string
powershellScriptContents string
powershellScriptMetadata string
)
BeforeEach(func() {
buffer = gbytes.NewBuffer()
var err error
tempDir, err = ioutil.TempDir("", "scaffold")
if err != nil {
panic(err)
}
emptyScript = filepath.Join(tempDir, "empty.sh")
metadataScript = filepath.Join(tempDir, "metadata.sh")
shellScript = filepath.Join(tempDir, "shell.sh")
rubyScript = filepath.Join(tempDir, "ruby.rb")
perlScript = filepath.Join(tempDir, "perl.pl")
powershellScript = filepath.Join(tempDir, "powershell.ps1")
})
AfterEach(func() {
os.RemoveAll(tempDir)
})
Context("With an empty script file", func() {
BeforeEach(func() {
emptyScriptMetadata = `# ---
# RightScript Name: Empty
# Description: (put your description here, it can be multiple lines using YAML syntax)
# Inputs: {}
# Attachments: []
# ...
`
if err := ioutil.WriteFile(emptyScript, nil, 0600); err != nil {
panic(err)
}
})
It("should add default metadata", func() {
err := ScaffoldRightScript(emptyScript, false, buffer, true)
Expect(err).To(Succeed())
Expect(buffer.Contents()).To(BeEquivalentTo(emptyScript + ": Added metadata\n"))
script, err := ioutil.ReadFile(emptyScript)
Expect(err).To(Succeed())
Expect(script).To(BeEquivalentTo(emptyScriptMetadata))
})
It("should create a backup file if desired", func() {
err := ScaffoldRightScript(emptyScript, true, buffer, true)
Expect(err).To(Succeed())
Expect(buffer.Contents()).To(BeEquivalentTo(emptyScript + ": Added metadata\n"))
script, err := ioutil.ReadFile(emptyScript)
Expect(err).To(Succeed())
Expect(script).To(BeEquivalentTo(emptyScriptMetadata))
info, err := os.Stat(emptyScript + ".bak")
Expect(err).To(Succeed())
Expect(info.Size()).To(BeEquivalentTo(0))
})
})
Context("With a script with metadata", func() {
BeforeEach(func() {
metadataScriptContents = `#!/bin/bash
# ---
# RightScript Name: Metadata Already
# Description: A script that already has metadata
# Inputs: {}
# Attachments: []
# ...
echo 'I have metadata already!'
`
if err := ioutil.WriteFile(metadataScript, []byte(metadataScriptContents), 0600); err != nil {
panic(err)
}
})
It("should not add metadata", func() {
err := ScaffoldRightScript(metadataScript, false, buffer, false)
Expect(err).To(Succeed())
Expect(string(buffer.Contents())).Should(ContainSubstring("Script unchanged, already contains metadata"))
script, err := ioutil.ReadFile(metadataScript)
Expect(err).To(Succeed())
Expect(script).To(BeEquivalentTo(metadataScriptContents))
})
})
Context("With rescaffolding a script with metadata", func() {
var metadataScriptBefore string
var metadataScriptAfter string
BeforeEach(func() {
metadataScriptBefore = `#!/bin/bash
# ---
# RightScript Name: Metadata Already
# Description: A script that already has metadata
# Inputs:
# FOO:
# Category: (put your input category here)
# Description: (put your input description here, it can be multiple lines using
# YAML syntax)
# Input Type: single
# Required: true
# Advanced: true
# BAR:
# Category: (put your input category here)
# Description: (put your input description here, it can be multiple lines using
# YAML syntax)
# Input Type: single
# Required: false
# Advanced: false
# Attachments: []
# ...
echo $FOO
# BAR was removed
${BAZ:=hello}
echo $BAZ
`
metadataScriptAfter = `#!/bin/bash
# ---
# RightScript Name: Metadata Already
# Description: A script that already has metadata
# Inputs:
# FOO:
# Category: (put your input category here)
# Description: (put your input description here, it can be multiple lines using
# YAML syntax)
# Input Type: single
# Required: true
# Advanced: true
# BAZ:
# Category: (put your input category here)
# Description: (put your input description here, it can be multiple lines using
# YAML syntax)
# Input Type: single
# Required: false
# Advanced: false
# Default: text:hello
# Attachments: []
# ...
echo $FOO
# BAR was removed
${BAZ:=hello}
echo $BAZ
`
if err := ioutil.WriteFile(metadataScript, []byte(metadataScriptBefore), 0600); err != nil {
panic(err)
}
})
It("should re-scaffold metadata", func() {
err := ScaffoldRightScript(metadataScript, false, buffer, true)
Expect(err).To(Succeed())
Expect(buffer.Contents()).To(BeEquivalentTo(metadataScript + ": Added metadata\n"))
script, err := ioutil.ReadFile(metadataScript)
Expect(err).To(Succeed())
Expect(script).To(BeEquivalentTo(metadataScriptAfter))
})
})
Context("With a shell script", func() {
BeforeEach(func() {
shebang := "#!/bin/bash\n"
shellScriptContents = `
: ${STRING:=hello}
: ${ARRAY:=hello,world}
echo "$STRING $ARRAY $PATH"
echo $RS_ATTACH_DIR/attachment.txt
`
shellScriptMetadata = shebang + `# ---
# RightScript Name: Shell
# Description: (put your description here, it can be multiple lines using YAML syntax)
# Inputs:
# STRING:
# Category: (put your input category here)
# Description: (put your input description here, it can be multiple lines using
# YAML syntax)
# Input Type: single
# Required: false
# Advanced: false
# Default: text:hello
# ARRAY:
# Category: (put your input category here)
# Description: (put your input description here, it can be multiple lines using
# YAML syntax)
# Input Type: array
# Required: false
# Advanced: false
# Default: array:["text:hello","text:world"]
# Attachments:
# - attachment.txt
# ...
` + shellScriptContents
shellScriptContents = shebang + shellScriptContents
if err := ioutil.WriteFile(shellScript, []byte(shellScriptContents), 0600); err != nil {
panic(err)
}
})
It("should add metadata with variables and their default values", func() {
err := ScaffoldRightScript(shellScript, false, buffer, true)
Expect(err).To(Succeed())
Expect(buffer.Contents()).To(BeEquivalentTo(shellScript + ": Added metadata\n"))
script, err := ioutil.ReadFile(shellScript)
Expect(err).To(Succeed())
Expect(script).To(BeEquivalentTo(shellScriptMetadata))
})
})
Context("With a Ruby script", func() {
BeforeEach(func() {
shebang := "#!/usr/bin/env ruby\n"
rubyScriptContents = `
puts "#{ENV['INPUT']} #{ENV["PATH"]}"
puts "#{ENV['RS_ATTACH_DIR']}/attachment.txt"
`
rubyScriptMetadata = shebang + `# ---
# RightScript Name: Ruby
# Description: (put your description here, it can be multiple lines using YAML syntax)
# Inputs:
# INPUT:
# Category: (put your input category here)
# Description: (put your input description here, it can be multiple lines using
# YAML syntax)
# Input Type: single
# Required: false
# Advanced: false
# Attachments:
# - attachment.txt
# ...
` + rubyScriptContents
rubyScriptContents = shebang + rubyScriptContents
if err := ioutil.WriteFile(rubyScript, []byte(rubyScriptContents), 0600); err != nil {
panic(err)
}
})
It("should add metadata with variables", func() {
err := ScaffoldRightScript(rubyScript, false, buffer, true)
Expect(err).To(Succeed())
Expect(buffer.Contents()).To(BeEquivalentTo(rubyScript + ": Added metadata\n"))
script, err := ioutil.ReadFile(rubyScript)
Expect(err).To(Succeed())
Expect(script).To(BeEquivalentTo(rubyScriptMetadata))
})
})
Context("With a Perl script", func() {
BeforeEach(func() {
shebang := "#!/usr/bin/env perl\n"
perlScriptContents = `
print "$ENV{INPUT} $ENV{PATH}\n";
print "$ENV{RS_ATTACH_DIR}/attachment.txt" . "\n";
`
perlScriptMetadata = shebang + `# ---
# RightScript Name: Perl
# Description: (put your description here, it can be multiple lines using YAML syntax)
# Inputs:
# INPUT:
# Category: (put your input category here)
# Description: (put your input description here, it can be multiple lines using
# YAML syntax)
# Input Type: single
# Required: false
# Advanced: false
# Attachments:
# - attachment.txt
# ...
` + perlScriptContents
perlScriptContents = shebang + perlScriptContents
if err := ioutil.WriteFile(perlScript, []byte(perlScriptContents), 0600); err != nil {
panic(err)
}
})
It("should add metadata with variables", func() {
err := ScaffoldRightScript(perlScript, false, buffer, true)
Expect(err).To(Succeed())
Expect(buffer.Contents()).To(BeEquivalentTo(perlScript + ": Added metadata\n"))
script, err := ioutil.ReadFile(perlScript)
Expect(err).To(Succeed())
Expect(script).To(BeEquivalentTo(perlScriptMetadata))
})
})
Context("With a PowerShell script", func() {
BeforeEach(func() {
powershellScriptContents = `
Write-Output "${env:INPUT} $env:PATH"
Write-Output "${env:RS_ATTACH_DIR}/attachment.txt"
`
powershellScriptMetadata = `# ---
# RightScript Name: Powershell
# Description: (put your description here, it can be multiple lines using YAML syntax)
# Inputs:
# INPUT:
# Category: (put your input category here)
# Description: (put your input description here, it can be multiple lines using
# YAML syntax)
# Input Type: single
# Required: false
# Advanced: false
# Attachments:
# - attachment.txt
# ...
` + powershellScriptContents
if err := ioutil.WriteFile(powershellScript, []byte(powershellScriptContents), 0600); err != nil {
panic(err)
}
})
It("should add metadata with variables", func() {
err := ScaffoldRightScript(powershellScript, false, buffer, true)
Expect(err).To(Succeed())
Expect(buffer.Contents()).To(BeEquivalentTo(powershellScript + ": Added metadata\n"))
script, err := ioutil.ReadFile(powershellScript)
Expect(err).To(Succeed())
Expect(script).To(BeEquivalentTo(powershellScriptMetadata))
})
})
})