-
Notifications
You must be signed in to change notification settings - Fork 105
/
generator_test.go
361 lines (325 loc) · 13.1 KB
/
generator_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
package lifecycle_test
import (
"bytes"
"io/ioutil"
"os"
"path/filepath"
"strings"
"testing"
"github.com/apex/log"
"github.com/apex/log/handlers/discard"
"github.com/apex/log/handlers/memory"
"github.com/golang/mock/gomock"
"github.com/pkg/errors"
"github.com/sclevine/spec"
"github.com/sclevine/spec/report"
"github.com/buildpacks/lifecycle"
"github.com/buildpacks/lifecycle/api"
"github.com/buildpacks/lifecycle/buildpack"
llog "github.com/buildpacks/lifecycle/log"
"github.com/buildpacks/lifecycle/platform"
h "github.com/buildpacks/lifecycle/testhelpers"
"github.com/buildpacks/lifecycle/testmock"
)
func TestGenerator(t *testing.T) {
spec.Run(t, "unit-new-generator", testGeneratorFactory, spec.Report(report.Terminal{}))
spec.Run(t, "unit-generator", testGenerator, spec.Report(report.Terminal{}))
}
func testGeneratorFactory(t *testing.T, when spec.G, it spec.S) {
when("#NewGenerator", func() {
var (
generatorFactory *lifecycle.GeneratorFactory
fakeAPIVerifier *testmock.MockBuildpackAPIVerifier
fakeDirStore *testmock.MockDirStore
logger *log.Logger
mockController *gomock.Controller
stdout, stderr *bytes.Buffer
)
it.Before(func() {
mockController = gomock.NewController(t)
fakeAPIVerifier = testmock.NewMockBuildpackAPIVerifier(mockController)
fakeDirStore = testmock.NewMockDirStore(mockController)
logger = &log.Logger{Handler: &discard.Handler{}}
generatorFactory = lifecycle.NewGeneratorFactory(
fakeAPIVerifier,
fakeDirStore,
)
})
it.After(func() {
mockController.Finish()
})
it("configures the generator", func() {
fakeAPIVerifier.EXPECT().VerifyBuildpackAPI(buildpack.KindExtension, "A@v1", "0.9", logger)
providedPlan := platform.BuildPlan{Entries: []platform.BuildPlanEntry{
{
Providers: []buildpack.GroupElement{
{ID: "A", Version: "v1", API: "0.9", Extension: true},
},
Requires: []buildpack.Require{
{Name: "some-dep"},
},
},
}}
generator, err := generatorFactory.NewGenerator(
"some-app-dir",
[]buildpack.GroupElement{
{ID: "A", Version: "v1", API: "0.9"},
},
"some-output-dir",
providedPlan,
"some-platform-dir",
stdout, stderr,
logger,
)
h.AssertNil(t, err)
h.AssertEq(t, generator.AppDir, "some-app-dir")
h.AssertNotNil(t, generator.DirStore)
h.AssertEq(t, generator.Extensions, []buildpack.GroupElement{
{ID: "A", Version: "v1", API: "0.9"},
})
h.AssertEq(t, generator.GeneratedDir, "some-output-dir")
h.AssertEq(t, generator.Logger, logger)
h.AssertEq(t, generator.Plan, providedPlan)
h.AssertEq(t, generator.PlatformDir, "some-platform-dir")
h.AssertEq(t, generator.Out, stdout)
h.AssertEq(t, generator.Err, stderr)
})
})
}
func testGenerator(t *testing.T, when spec.G, it spec.S) {
var (
mockCtrl *gomock.Controller
generator *lifecycle.Generator
tmpDir string
appDir string
generatedDir string
platformDir string
dirStore *testmock.MockDirStore
executor *testmock.MockGenerateExecutor
logHandler = memory.New()
stdout, stderr *bytes.Buffer
)
it.Before(func() {
mockCtrl = gomock.NewController(t)
dirStore = testmock.NewMockDirStore(mockCtrl)
executor = testmock.NewMockGenerateExecutor(mockCtrl)
var err error
tmpDir, err = ioutil.TempDir("", "lifecycle")
h.AssertNil(t, err)
generatedDir = filepath.Join(tmpDir, "output")
appDir = filepath.Join(generatedDir, "app")
platformDir = filepath.Join(tmpDir, "platform")
h.Mkdir(t, generatedDir, appDir, filepath.Join(platformDir, "env"))
stdout, stderr = &bytes.Buffer{}, &bytes.Buffer{}
generator = &lifecycle.Generator{
AppDir: appDir,
DirStore: dirStore,
Executor: executor,
Extensions: []buildpack.GroupElement{
{ID: "A", Version: "v1", API: api.Buildpack.Latest().String(), Homepage: "A Homepage"},
{ID: "ext/B", Version: "v2", API: api.Buildpack.Latest().String()},
},
Logger: &log.Logger{Handler: logHandler},
GeneratedDir: generatedDir,
Plan: platform.BuildPlan{},
PlatformDir: platformDir,
Err: stderr,
Out: stdout,
}
})
it.After(func() {
os.RemoveAll(tmpDir)
mockCtrl.Finish()
})
when(".Generate", func() {
it("provides a subset of the build plan to each extension", func() {
generator.Plan = platform.BuildPlan{
Entries: []platform.BuildPlanEntry{
{
Providers: []buildpack.GroupElement{
{ID: "A", Version: "v1"}, // not provided to any extension because Extension is false
},
Requires: []buildpack.Require{
{Name: "buildpack-dep", Version: "v1"},
},
},
{
Providers: []buildpack.GroupElement{
{ID: "A", Version: "v1", Extension: true},
{ID: "ext/B", Version: "v2", Extension: true},
},
Requires: []buildpack.Require{
{Name: "some-dep", Version: "v1"}, // not provided to B because it is met
},
},
{
Providers: []buildpack.GroupElement{
{ID: "A", Version: "v1", Extension: true},
{ID: "ext/B", Version: "v2", Extension: true},
},
Requires: []buildpack.Require{
{Name: "some-unmet-dep", Version: "v2"}, // provided to ext/B because it is unmet
},
},
{
Providers: []buildpack.GroupElement{
{ID: "ext/B", Version: "v2", Extension: true},
},
Requires: []buildpack.Require{
{Name: "other-dep", Version: "v4"}, // only provided to ext/B
},
},
},
}
expectedInputs := buildpack.GenerateInputs{
AppDir: appDir,
PlatformDir: platformDir,
// OutputDir is ephemeral directory
}
extA := buildpack.ExtDescriptor{Extension: buildpack.ExtInfo{BaseInfo: buildpack.BaseInfo{ID: "A", Version: "v1"}}}
dirStore.EXPECT().LookupExt("A", "v1").Return(&extA, nil)
expectedAInputs := expectedInputs
expectedAInputs.Plan = buildpack.Plan{Entries: []buildpack.Require{
{Name: "some-dep", Version: "v1"},
{Name: "some-unmet-dep", Version: "v2"},
}}
executor.EXPECT().Generate(extA, gomock.Any(), gomock.Any()).DoAndReturn(
func(_ buildpack.ExtDescriptor, inputs buildpack.GenerateInputs, _ llog.Logger) (buildpack.GenerateOutputs, error) {
h.AssertEq(t, inputs.Plan, expectedAInputs.Plan)
h.AssertEq(t, inputs.AppDir, expectedAInputs.AppDir)
h.AssertEq(t, inputs.PlatformDir, expectedAInputs.PlatformDir)
return buildpack.GenerateOutputs{MetRequires: []string{"some-dep"}}, nil
})
extB := buildpack.ExtDescriptor{Extension: buildpack.ExtInfo{BaseInfo: buildpack.BaseInfo{ID: "ext/B", Version: "v1"}}}
dirStore.EXPECT().LookupExt("ext/B", "v2").Return(&extB, nil)
expectedBInputs := expectedInputs
expectedBInputs.Plan = buildpack.Plan{Entries: []buildpack.Require{
{Name: "some-unmet-dep", Version: "v2"},
{Name: "other-dep", Version: "v4"},
}}
executor.EXPECT().Generate(extB, gomock.Any(), gomock.Any()).Do(
func(_ buildpack.ExtDescriptor, inputs buildpack.GenerateInputs, _ llog.Logger) (buildpack.GenerateOutputs, error) {
h.AssertEq(t, inputs.Plan, expectedBInputs.Plan)
h.AssertEq(t, inputs.AppDir, expectedBInputs.AppDir)
h.AssertEq(t, inputs.PlatformDir, expectedBInputs.PlatformDir)
return buildpack.GenerateOutputs{}, nil
})
_, err := generator.Generate()
h.AssertNil(t, err)
})
it("aggregates dockerfiles from each extension and returns the correct run image in the build result", func() {
// Extension A outputs a run.Dockerfile to the provided output directory when invoked.
extA := buildpack.ExtDescriptor{Extension: buildpack.ExtInfo{BaseInfo: buildpack.BaseInfo{ID: "A", Version: "v1"}}}
dirStore.EXPECT().LookupExt("A", "v1").Return(&extA, nil)
executor.EXPECT().Generate(extA, gomock.Any(), gomock.Any()).DoAndReturn(
func(_ buildpack.ExtDescriptor, inputs buildpack.GenerateInputs, _ llog.Logger) (buildpack.GenerateOutputs, error) {
// check inputs
h.AssertEq(t, inputs.AppDir, generator.AppDir)
h.AssertEq(t, inputs.PlatformDir, generator.PlatformDir)
// create fixture
h.Mkdir(t, filepath.Join(inputs.OutputDir, "A"))
dockerfilePath1 := filepath.Join(inputs.OutputDir, "A", "run.Dockerfile")
h.Mkfile(t, `FROM some-run-image`, dockerfilePath1)
return buildpack.GenerateOutputs{
Dockerfiles: []buildpack.DockerfileInfo{
{ExtensionID: "A", Path: dockerfilePath1, Kind: "run"},
},
}, nil
},
)
// Extension B has a pre-populated root directory.
extB := buildpack.ExtDescriptor{Extension: buildpack.ExtInfo{BaseInfo: buildpack.BaseInfo{ID: "ext/B", Version: "v1"}}}
bRootDir := filepath.Join(tmpDir, "some-b-root-dir")
h.Mkdir(t, bRootDir)
bDockerfilePath := filepath.Join(bRootDir, "run.Dockerfile")
h.Mkfile(t, `FROM other-run-image`, bDockerfilePath)
dirStore.EXPECT().LookupExt("ext/B", "v2").Return(&extB, nil)
executor.EXPECT().Generate(extB, gomock.Any(), gomock.Any()).Return(buildpack.GenerateOutputs{
Dockerfiles: []buildpack.DockerfileInfo{
{ExtensionID: "ext/B", Path: bDockerfilePath, Kind: "run"},
},
}, nil)
// Extension C has a pre-populated root directory.
extC := buildpack.ExtDescriptor{Extension: buildpack.ExtInfo{BaseInfo: buildpack.BaseInfo{ID: "C", Version: "v1"}}}
cRootDir := filepath.Join(tmpDir, "some-c-root-dir")
h.Mkdir(t, cRootDir)
cDockerfilePath := filepath.Join(cRootDir, "build.Dockerfile")
h.Mkfile(t, `some-build.Dockerfile-content`, cDockerfilePath)
h.Mkfile(t, `some-extend-config-content`, filepath.Join(cRootDir, "extend-config.toml"))
dirStore.EXPECT().LookupExt("C", "v1").Return(&extC, nil)
executor.EXPECT().Generate(extC, gomock.Any(), gomock.Any()).Return(buildpack.GenerateOutputs{
Dockerfiles: []buildpack.DockerfileInfo{
{ExtensionID: "C", Path: cDockerfilePath, Kind: "build"},
},
}, nil)
generator.Extensions = append(generator.Extensions, buildpack.GroupElement{ID: "C", Version: "v1", API: api.Buildpack.Latest().String()})
result, err := generator.Generate()
h.AssertNil(t, err)
t.Log("copies Dockerfiles to the correct locations")
aContents := h.MustReadFile(t, filepath.Join(generatedDir, "run", "A", "Dockerfile"))
h.AssertEq(t, string(aContents), `FROM some-run-image`)
bContents := h.MustReadFile(t, filepath.Join(generatedDir, "run", "ext_B", "Dockerfile"))
h.AssertEq(t, string(bContents), `FROM other-run-image`)
cContents := h.MustReadFile(t, filepath.Join(generatedDir, "build", "C", "Dockerfile"))
h.AssertEq(t, string(cContents), `some-build.Dockerfile-content`)
t.Log("copies the extend-config.toml if exists")
configContents := h.MustReadFile(t, filepath.Join(generatedDir, "build", "C", "extend-config.toml"))
h.AssertEq(t, string(configContents), `some-extend-config-content`)
t.Log("does not pollute the output directory")
h.AssertPathDoesNotExist(t, filepath.Join(generatedDir, "A", "run.Dockerfile"))
t.Log("returns the correct run image")
h.AssertEq(t, result.RunImage, "other-run-image")
})
it("validates build.Dockerfiles", func() {
// TODO: validate the following conditions:
/*
build.Dockerfiles:
- MUST begin with:
```bash
ARG base_image
FROM ${base_image}
```
- MUST NOT contain any other `FROM` instructions
- MAY contain `ADD`, `ARG`, `COPY`, `ENV`, `LABEL`, `RUN`, `SHELL`, `USER`, and `WORKDIR` instructions
- SHOULD NOT contain any other instructions
*/
})
it("validates run.Dockerfiles", func() {
// TODO: validate the following conditions:
/*
run.Dockerfiles:
- MAY contain a single `FROM` instruction
- MUST NOT contain any other instructions
*/
})
when("extension generate failed", func() {
when("first extension fails", func() {
it("errors", func() {
extA := buildpack.ExtDescriptor{Extension: buildpack.ExtInfo{BaseInfo: buildpack.BaseInfo{ID: "A", Version: "v1"}}}
dirStore.EXPECT().LookupExt("A", "v1").Return(&extA, nil)
executor.EXPECT().Generate(extA, gomock.Any(), gomock.Any()).Return(buildpack.GenerateOutputs{}, errors.New("some error"))
if _, err := generator.Generate(); err == nil {
t.Fatal("Expected error.\n")
} else if !strings.Contains(err.Error(), "some error") {
t.Fatalf("Incorrect error: %s\n", err)
}
})
})
when("later extension fails", func() {
it("errors", func() {
extA := buildpack.ExtDescriptor{Extension: buildpack.ExtInfo{BaseInfo: buildpack.BaseInfo{ID: "A", Version: "v1"}}}
dirStore.EXPECT().LookupExt("A", "v1").Return(&extA, nil)
executor.EXPECT().Generate(extA, gomock.Any(), gomock.Any()).Return(buildpack.GenerateOutputs{}, nil)
extB := buildpack.ExtDescriptor{Extension: buildpack.ExtInfo{BaseInfo: buildpack.BaseInfo{ID: "ext/B", Version: "v1"}}}
dirStore.EXPECT().LookupExt("ext/B", "v2").Return(&extB, nil)
executor.EXPECT().Generate(extB, gomock.Any(), gomock.Any()).Return(buildpack.GenerateOutputs{}, errors.New("some error"))
if _, err := generator.Generate(); err == nil {
t.Fatal("Expected error.\n")
} else if !strings.Contains(err.Error(), "some error") {
t.Fatalf("Incorrect error: %s\n", err)
}
})
})
})
})
}