Repository navigation
Expand file tree
/
Copy pathfinalize_test.go
More file actions
330 lines (272 loc) · 11.1 KB
/
Copy pathfinalize_test.go
File metadata and controls
330 lines (272 loc) · 11.1 KB
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
package finalize_test
import (
"os"
"path/filepath"
"regexp"
"time"
"github.com/cloudfoundry/java-buildpack/src/internal/mocks"
"github.com/cloudfoundry/java-buildpack/src/java/finalize"
"github.com/cloudfoundry/libbuildpack"
"github.com/golang/mock/gomock"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
"gopkg.in/yaml.v2"
)
var _ = Describe("Finalize", func() {
var (
buildDir string
cacheDir string
depsDir string
depsIdx string
stager *libbuildpack.Stager
mockCtrl *gomock.Controller
mockManifest *mocks.MockManifest
mockInstaller *mocks.MockInstaller
finalizer *finalize.Finalizer
logger *libbuildpack.Logger
)
BeforeEach(func() {
var err error
buildDir, err = os.MkdirTemp("", "finalize-build")
Expect(err).NotTo(HaveOccurred())
cacheDir, err = os.MkdirTemp("", "finalize-cache")
Expect(err).NotTo(HaveOccurred())
depsDir, err = os.MkdirTemp("", "finalize-deps")
Expect(err).NotTo(HaveOccurred())
depsIdx = "0"
buildpackDir, err := os.MkdirTemp("", "finalize-buildpack")
Expect(err).NotTo(HaveOccurred())
versionFile := filepath.Join(buildpackDir, "VERSION")
Expect(os.WriteFile(versionFile, []byte("1.0.0"), 0644)).To(Succeed())
manifestFile := filepath.Join(buildpackDir, "manifest.yml")
manifestContent := `---
language: java
default_versions: []
dependencies: []
`
Expect(os.WriteFile(manifestFile, []byte(manifestContent), 0644)).To(Succeed())
// The finalizer installs the javaexec launcher from <buildpackDir>/bin.
binDir := filepath.Join(buildpackDir, "bin")
Expect(os.MkdirAll(binDir, 0755)).To(Succeed())
Expect(os.WriteFile(filepath.Join(binDir, "javaexec"), []byte("#!/bin/sh\n"), 0755)).To(Succeed())
logger = libbuildpack.NewLogger(GinkgoWriter)
mockCtrl = gomock.NewController(GinkgoT())
mockManifest = mocks.NewMockManifest(mockCtrl)
mockInstaller = mocks.NewMockInstaller(mockCtrl)
manifest, err := libbuildpack.NewManifest(buildpackDir, logger, time.Now())
Expect(err).NotTo(HaveOccurred())
stager = libbuildpack.NewStager([]string{buildDir, cacheDir, depsDir, depsIdx}, logger, manifest)
finalizer = &finalize.Finalizer{
Stager: stager,
Manifest: mockManifest,
Installer: mockInstaller,
Log: logger,
Command: &libbuildpack.Command{},
BuildpackDir: buildpackDir,
}
})
AfterEach(func() {
mockCtrl.Finish()
os.RemoveAll(buildDir)
os.RemoveAll(cacheDir)
os.RemoveAll(depsDir)
})
Describe("Various Container Finalize", func() {
Context("When a Spring Boot application is present", func() {
BeforeEach(func() {
// Create a Spring Boot JAR with BOOT-INF
bootInfDir := filepath.Join(buildDir, "BOOT-INF")
Expect(os.MkdirAll(bootInfDir, 0755)).To(Succeed())
Expect(os.MkdirAll(filepath.Join(buildDir, "META-INF"), 0755)).To(Succeed())
// Create META-INF/MANIFEST.MF with corresponding content of a Spring Boot app
manifestFile := filepath.Join(buildDir, "META-INF", "MANIFEST.MF")
Expect(os.WriteFile(manifestFile, []byte("Spring-Boot-Version: 3.x.x"), 0644)).To(Succeed())
finalizer.JREName = "OpenJDK"
finalizer.ContainerName = "Spring Boot"
})
It("Finalize passes successfully", func() {
Expect(finalize.Run(finalizer)).To(Succeed())
})
})
Context("When a Tomcat application is present", func() {
BeforeEach(func() {
webInfDir := filepath.Join(buildDir, "WEB-INF")
Expect(os.MkdirAll(webInfDir, 0755)).To(Succeed())
finalizer.JREName = "OpenJDK"
finalizer.ContainerName = "Tomcat"
})
It("Finalize passes successfully", func() {
Expect(finalize.Run(finalizer)).To(Succeed())
})
})
Context("When a Groovy application is present", func() {
BeforeEach(func() {
// Create a .groovy file
groovyFile := filepath.Join(buildDir, "app.groovy")
Expect(os.WriteFile(groovyFile, []byte("println 'hello'"), 0644)).To(Succeed())
finalizer.JREName = "OpenJDK"
finalizer.ContainerName = "Groovy"
})
It("Finalize passes successfully", func() {
Expect(finalize.Run(finalizer)).To(Succeed())
})
})
})
Describe("Startup Script Generation", func() {
It("creates .java-buildpack directory", func() {
javaBuildpackDir := filepath.Join(buildDir, ".java-buildpack")
Expect(os.MkdirAll(javaBuildpackDir, 0755)).To(Succeed())
Expect(javaBuildpackDir).To(BeADirectory())
})
It("would generate start.sh in .java-buildpack directory", func() {
javaBuildpackDir := filepath.Join(buildDir, ".java-buildpack")
Expect(os.MkdirAll(javaBuildpackDir, 0755)).To(Succeed())
startScript := filepath.Join(javaBuildpackDir, "start.sh")
Expect(filepath.Dir(startScript)).To(Equal(javaBuildpackDir))
})
})
Describe("Environment Setup", func() {
It("has access to deps directory for environment files", func() {
depDir := stager.DepDir()
envDir := filepath.Join(depDir, "env")
Expect(os.MkdirAll(envDir, 0755)).To(Succeed())
Expect(envDir).To(BeADirectory())
})
It("can write environment variables to env directory", func() {
depDir := stager.DepDir()
envDir := filepath.Join(depDir, "env")
Expect(os.MkdirAll(envDir, 0755)).To(Succeed())
javaHomeFile := filepath.Join(envDir, "JAVA_HOME")
Expect(os.WriteFile(javaHomeFile, []byte("/deps/0/jre"), 0644)).To(Succeed())
Expect(javaHomeFile).To(BeAnExistingFile())
})
})
Describe("Profile.d Script Creation", func() {
It("can create profile.d directory in build dir", func() {
profileDir := filepath.Join(buildDir, ".profile.d")
Expect(os.MkdirAll(profileDir, 0755)).To(Succeed())
Expect(profileDir).To(BeADirectory())
})
It("can write profile.d scripts", func() {
profileDir := filepath.Join(buildDir, ".profile.d")
Expect(os.MkdirAll(profileDir, 0755)).To(Succeed())
javaScript := filepath.Join(profileDir, "java.sh")
scriptContent := "export JAVA_HOME=$DEPS_DIR/" + depsIdx + "/jre\n"
Expect(os.WriteFile(javaScript, []byte(scriptContent), 0755)).To(Succeed())
Expect(javaScript).To(BeAnExistingFile())
})
})
Describe("Config Persistence", func() {
It("NewFinalizer reads all keys written by the supply phase", func() {
// Simulate what supply phase writes: all keys in a single call
config := map[string]string{
"container": "spring-boot",
"jre": "OpenJDK",
"jre_version": "17.0.9",
"java_home": "/deps/0/jre",
}
err := stager.WriteConfigYml(config)
Expect(err).NotTo(HaveOccurred())
// NewFinalizer must successfully read the config.yml written above
f, err := finalize.NewFinalizer(stager, mockManifest, mockInstaller, logger, &libbuildpack.Command{})
Expect(err).NotTo(HaveOccurred())
Expect(f.ContainerName).To(Equal("spring-boot"))
Expect(f.JREName).To(Equal("OpenJDK"))
})
It("NewFinalizer fails when config.yml is missing", func() {
// No config.yml written — NewFinalizer must return an error
_, err := finalize.NewFinalizer(stager, mockManifest, mockInstaller, logger, &libbuildpack.Command{})
Expect(err).To(HaveOccurred())
})
It("NewFinalizer fails when required keys are absent", func() {
// Write config with empty map — container and jre keys missing
err := stager.WriteConfigYml(map[string]string{})
Expect(err).NotTo(HaveOccurred())
_, err = finalize.NewFinalizer(stager, mockManifest, mockInstaller, logger, &libbuildpack.Command{})
Expect(err).To(HaveOccurred())
})
})
Describe("Stager Configuration", func() {
It("has access to build directory", func() {
Expect(stager.BuildDir()).To(Equal(buildDir))
})
It("has access to cache directory", func() {
Expect(stager.CacheDir()).To(Equal(cacheDir))
})
It("has access to deps directory", func() {
depDir := stager.DepDir()
Expect(depDir).To(ContainSubstring(depsDir))
})
})
Describe("Release YAML", func() {
BeforeEach(func() {
os.Setenv("JBP_CONFIG_JAVA_MAIN", "{java_main_class: com.example.App}")
finalizer.JREName = "OpenJDK"
finalizer.ContainerName = "Java Main"
})
AfterEach(func() {
os.Unsetenv("JBP_CONFIG_JAVA_MAIN")
})
It("emits web and task process types with identical commands", func() {
Expect(finalize.Run(finalizer)).To(Succeed())
content, err := os.ReadFile(filepath.Join(buildDir, "tmp", "java-buildpack-release-step.yml"))
Expect(err).NotTo(HaveOccurred())
re := regexp.MustCompile(`(?m)^\s+(web|task):\s+'(.+)'$`)
matches := re.FindAllStringSubmatch(string(content), -1)
Expect(matches).To(HaveLen(2), "expected both web and task process types")
commands := map[string]string{}
for _, m := range matches {
commands[m[1]] = m[2]
}
Expect(commands).To(HaveKey("web"))
Expect(commands).To(HaveKey("task"))
Expect(commands["web"]).To(Equal(commands["task"]))
})
It("escapes single quotes in commands so release YAML is valid", func() {
os.Setenv("JBP_CONFIG_JAVA_MAIN", `{java_main_class: com.example.App, arguments: "--message=it's alive"}`)
Expect(finalize.Run(finalizer)).To(Succeed())
content, err := os.ReadFile(filepath.Join(buildDir, "tmp", "java-buildpack-release-step.yml"))
Expect(err).NotTo(HaveOccurred())
var parsed struct {
DefaultProcessTypes map[string]string `yaml:"default_process_types"`
}
Expect(yaml.Unmarshal(content, &parsed)).To(Succeed(), "release YAML must be valid")
Expect(parsed.DefaultProcessTypes["web"]).To(ContainSubstring("it's alive"))
Expect(parsed.DefaultProcessTypes["task"]).To(ContainSubstring("it's alive"))
})
})
Describe("javaexec launcher installation", func() {
It("installs launcher from buildpack bin/ for packaged buildpack usage", func() {
// Default path: <buildpackDir>/bin/javaexec already written in BeforeEach.
Expect(finalizer.InstallJavaexecLauncher()).To(Succeed())
installed := filepath.Join(stager.DepDir(), "bin", "javaexec")
Expect(installed).To(BeARegularFile())
})
It("installs launcher from JAVAEXEC_BINARY_PATH for source/git buildpack usage", func() {
// Simulate bin/finalize wrapper: javaexec built into a temp dir, path passed via env var.
// <buildpackDir>/bin/javaexec is still present from BeforeEach, but the env var must take precedence.
altBinary, err := os.CreateTemp("", "javaexec-alt-*")
Expect(err).NotTo(HaveOccurred())
defer os.Remove(altBinary.Name())
_, err = altBinary.WriteString("#!/bin/sh\n# alt\n")
Expect(err).NotTo(HaveOccurred())
Expect(altBinary.Close()).To(Succeed())
os.Setenv("JAVAEXEC_BINARY_PATH", altBinary.Name())
defer os.Unsetenv("JAVAEXEC_BINARY_PATH")
Expect(finalizer.InstallJavaexecLauncher()).To(Succeed())
installed := filepath.Join(stager.DepDir(), "bin", "javaexec")
Expect(installed).To(BeARegularFile())
content, err := os.ReadFile(installed)
Expect(err).NotTo(HaveOccurred())
Expect(string(content)).To(ContainSubstring("# alt"))
})
It("fails when launcher is missing and JAVAEXEC_BINARY_PATH is not set", func() {
// Point BuildpackDir at an empty dir so bin/javaexec doesn't exist.
emptyDir, err := os.MkdirTemp("", "finalize-no-javaexec")
Expect(err).NotTo(HaveOccurred())
defer os.RemoveAll(emptyDir)
finalizer.BuildpackDir = emptyDir
Expect(finalizer.InstallJavaexecLauncher()).NotTo(Succeed())
})
})
})