forked from testcontainers/testcontainers-go
/
main_test.go
234 lines (189 loc) · 7.74 KB
/
main_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
package main
import (
"os"
"path/filepath"
"strings"
"testing"
"github.com/stretchr/testify/assert"
)
func TestGenerateWrongExampleName(t *testing.T) {
rootTmp := t.TempDir()
examplesTmp := filepath.Join(rootTmp, "examples")
examplesDocTmp := filepath.Join(rootTmp, "docs", "examples")
githubWorkflowsTmp := filepath.Join(rootTmp, ".github", "workflows")
err := os.MkdirAll(examplesTmp, 0777)
assert.Nil(t, err)
err = os.MkdirAll(examplesDocTmp, 0777)
assert.Nil(t, err)
err = os.MkdirAll(githubWorkflowsTmp, 0777)
assert.Nil(t, err)
err = copyInitialConfig(t, rootTmp)
assert.Nil(t, err)
tests := []struct {
name string
}{
{name: " foo"},
{name: "foo "},
{name: "foo bar"},
{name: "foo-bar"},
{name: "foo/bar"},
{name: "foo\\bar"},
{name: "1foo"},
{name: "foo1"},
{name: "-foo"},
{name: "foo-"},
}
for _, test := range tests {
example := Example{
Name: test.name,
Image: "docker.io/example/" + test.name + ":latest",
TCVersion: "v0.0.0-test",
}
err = generate(example, rootTmp)
assert.Error(t, err)
}
}
func TestGenerate(t *testing.T) {
rootTmp := t.TempDir()
examplesTmp := filepath.Join(rootTmp, "examples")
examplesDocTmp := filepath.Join(rootTmp, "docs", "examples")
githubWorkflowsTmp := filepath.Join(rootTmp, ".github", "workflows")
err := os.MkdirAll(examplesTmp, 0777)
assert.Nil(t, err)
err = os.MkdirAll(examplesDocTmp, 0777)
assert.Nil(t, err)
err = os.MkdirAll(githubWorkflowsTmp, 0777)
assert.Nil(t, err)
err = copyInitialConfig(t, rootTmp)
assert.Nil(t, err)
originalConfig, err := readMkdocsConfig(rootTmp)
assert.Nil(t, err)
example := Example{
Name: "foo",
Image: "docker.io/example/foo:latest",
TCVersion: "v0.0.0-test",
}
exampleNameLower := example.Lower()
err = generate(example, rootTmp)
assert.Nil(t, err)
templatesDir, err := os.ReadDir(filepath.Join(".", "_template"))
assert.Nil(t, err)
exampleDirPath := filepath.Join(examplesTmp, exampleNameLower)
newExampleDir, err := os.ReadDir(exampleDirPath)
assert.Nil(t, err)
exampleDirFileInfo, err := os.Stat(exampleDirPath)
assert.Nil(t, err) // error nil implies the file exist
assert.True(t, exampleDirFileInfo.IsDir())
exampleDocFile := filepath.Join(examplesDocTmp, exampleNameLower+".md")
_, err = os.Stat(exampleDocFile)
assert.Nil(t, err) // error nil implies the file exist
exampleWorkflowFile := filepath.Join(githubWorkflowsTmp, exampleNameLower+"-example.yml")
_, err = os.Stat(exampleWorkflowFile)
assert.Nil(t, err) // error nil implies the file exist
// check the number of template files is equal to examples + 2 (the doc and the github workflow)
assert.Equal(t, len(newExampleDir)+2, len(templatesDir))
assertExampleDocContent(t, example, exampleDocFile)
assertExampleGithubWorkflowContent(t, example, exampleWorkflowFile)
generatedTemplatesDir := filepath.Join(examplesTmp, exampleNameLower)
assertExampleTestContent(t, example, filepath.Join(generatedTemplatesDir, exampleNameLower+"_test.go"))
assertExampleContent(t, example, filepath.Join(generatedTemplatesDir, exampleNameLower+".go"))
assertGoModContent(t, example, filepath.Join(generatedTemplatesDir, "go.mod"))
assertMakefileContent(t, example, filepath.Join(generatedTemplatesDir, "Makefile"))
assertToolsGoContent(t, example, filepath.Join(generatedTemplatesDir, "tools", "tools.go"))
assertMkdocsExamplesNav(t, example, originalConfig, rootTmp)
}
// assert content example file in the docs
func assertExampleDocContent(t *testing.T, example Example, exampleDocFile string) {
content, err := os.ReadFile(exampleDocFile)
assert.Nil(t, err)
lower := example.Lower()
title := example.Title()
data := strings.Split(string(content), "\n")
assert.Equal(t, data[0], "# "+title)
assert.Equal(t, data[2], "<!--codeinclude-->")
assert.Equal(t, data[3], "[Creating a "+title+" container](../../examples/"+lower+"/"+lower+".go)")
assert.Equal(t, data[4], "<!--/codeinclude-->")
assert.Equal(t, data[6], "<!--codeinclude-->")
assert.Equal(t, data[7], "[Test for a "+title+" container](../../examples/"+lower+"/"+lower+"_test.go)")
assert.Equal(t, data[8], "<!--/codeinclude-->")
}
// assert content example test
func assertExampleTestContent(t *testing.T, example Example, exampleTestFile string) {
content, err := os.ReadFile(exampleTestFile)
assert.Nil(t, err)
data := strings.Split(string(content), "\n")
assert.Equal(t, data[0], "package "+example.Lower())
assert.Equal(t, data[7], "func Test"+example.Title()+"(t *testing.T) {")
}
// assert content example
func assertExampleContent(t *testing.T, example Example, exampleFile string) {
content, err := os.ReadFile(exampleFile)
assert.Nil(t, err)
lower := example.Lower()
title := example.Title()
exampleName := example.Name
data := strings.Split(string(content), "\n")
assert.Equal(t, data[0], "package "+lower)
assert.Equal(t, data[8], "// "+lower+"Container represents the "+exampleName+" container type used in the module")
assert.Equal(t, data[9], "type "+lower+"Container struct {")
assert.Equal(t, data[13], "// setup"+title+" creates an instance of the "+exampleName+" container type")
assert.Equal(t, data[14], "func setup"+title+"(ctx context.Context) (*"+lower+"Container, error) {")
assert.Equal(t, data[16], "\t\tImage: \""+example.Image+"\",")
assert.Equal(t, data[26], "\treturn &"+lower+"Container{Container: container}, nil")
}
// assert content GitHub workflow for the example
func assertExampleGithubWorkflowContent(t *testing.T, example Example, exampleWorkflowFile string) {
content, err := os.ReadFile(exampleWorkflowFile)
assert.Nil(t, err)
lower := example.Lower()
title := example.Title()
data := strings.Split(string(content), "\n")
assert.Equal(t, "name: "+title+" example pipeline", data[0])
assert.Equal(t, " test-"+lower+":", data[5])
assert.Equal(t, " go-version: ${{ matrix.go-version }}", data[15])
assert.Equal(t, " working-directory: ./examples/"+lower, data[22])
assert.Equal(t, " working-directory: ./examples/"+lower, data[26])
assert.Equal(t, " working-directory: ./examples/"+lower, data[30])
assert.Equal(t, " paths: \"**/TEST-"+lower+"*.xml\"", data[40])
}
// assert content go.mod
func assertGoModContent(t *testing.T, example Example, goModFile string) {
content, err := os.ReadFile(goModFile)
assert.Nil(t, err)
data := strings.Split(string(content), "\n")
assert.Equal(t, "module github.com/testcontainers/testcontainers-go/examples/"+example.Lower(), data[0])
assert.Equal(t, "\tgithub.com/testcontainers/testcontainers-go v"+example.TCVersion, data[5])
}
// assert content Makefile
func assertMakefileContent(t *testing.T, example Example, makefile string) {
content, err := os.ReadFile(makefile)
assert.Nil(t, err)
data := strings.Split(string(content), "\n")
assert.Equal(t, data[4], "\t$(MAKE) test-"+example.Lower())
}
// assert content in the Examples nav from mkdocs.yml
func assertMkdocsExamplesNav(t *testing.T, example Example, originalConfig *MkDocsConfig, rootDir string) {
config, err := readMkdocsConfig(rootDir)
assert.Nil(t, err)
examples := config.Nav[3].Examples
assert.Equal(t, len(originalConfig.Nav[3].Examples)+1, len(examples))
// the example should be in the nav
found := false
for _, ex := range examples {
markdownExample := "examples/" + example.Lower() + ".md"
if markdownExample == ex {
found = true
}
}
assert.True(t, found)
// first item is the index
assert.Equal(t, "examples/index.md", examples[0], examples)
}
// assert content tools/tools.go
func assertToolsGoContent(t *testing.T, example Example, tools string) {
content, err := os.ReadFile(tools)
assert.Nil(t, err)
data := strings.Split(string(content), "\n")
assert.Equal(t, data[3], "// This package contains the tool dependencies of the "+example.Name+" example.")
assert.Equal(t, data[5], "package tools")
}