-
Notifications
You must be signed in to change notification settings - Fork 17
/
layer.go
330 lines (266 loc) · 10.7 KB
/
layer.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
/*
* Copyright 2018-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package libpak
import (
"fmt"
"os"
"path/filepath"
"reflect"
"github.com/heroku/color"
"github.com/pelletier/go-toml"
"github.com/buildpacks/libcnb"
"github.com/paketo-buildpacks/libpak/sbom"
"github.com/paketo-buildpacks/libpak/sherpa"
"github.com/paketo-buildpacks/libpak/bard"
)
// LayerContributor is a helper for implementing a libcnb.LayerContributor in order to get consistent logging and
// avoidance.
type LayerContributor struct {
// ExpectedMetadata is the metadata to compare against any existing layer metadata.
ExpectedMetadata interface{}
// Logger is the logger to use.
Logger bard.Logger
// Name is the user readable name of the contribution.
Name string
// ExpectedTypes indicates the types that should be set on the layer.
ExpectedTypes libcnb.LayerTypes
}
// NewLayerContributor creates a new instance.
func NewLayerContributor(name string, expectedMetadata interface{}, expectedTypes libcnb.LayerTypes) LayerContributor {
return LayerContributor{
ExpectedMetadata: expectedMetadata,
Name: name,
ExpectedTypes: expectedTypes,
}
}
// LayerFunc is a callback function that is invoked when a layer needs to be contributed.
type LayerFunc func() (libcnb.Layer, error)
// Contribute is the function to call when implementing your libcnb.LayerContributor.
func (l *LayerContributor) Contribute(layer libcnb.Layer, f LayerFunc) (libcnb.Layer, error) {
raw, err := toml.Marshal(l.ExpectedMetadata)
if err != nil {
return libcnb.Layer{}, fmt.Errorf("unable to encode metadata\n%w", err)
}
expected := map[string]interface{}{}
if err := toml.Unmarshal(raw, &expected); err != nil {
return libcnb.Layer{}, fmt.Errorf("unable to decode metadata\n%w", err)
}
l.Logger.Debugf("Expected metadata: %+v", expected)
l.Logger.Debugf("Actual metadata: %+v", layer.Metadata)
// TODO: compare entire layer not just metadata (in case build, launch, or cache have changed)
if reflect.DeepEqual(expected, layer.Metadata) {
l.Logger.Headerf("%s: %s cached layer", color.BlueString(l.Name), color.GreenString("Reusing"))
layer.LayerTypes = l.ExpectedTypes
return layer, nil
}
l.Logger.Headerf("%s: %s to layer", color.BlueString(l.Name), color.YellowString("Contributing"))
if err := os.RemoveAll(layer.Path); err != nil {
return libcnb.Layer{}, fmt.Errorf("unable to remove existing layer directory %s\n%w", layer.Path, err)
}
if err := os.MkdirAll(layer.Path, 0755); err != nil {
return libcnb.Layer{}, fmt.Errorf("unable to create layer directory %s\n%w", layer.Path, err)
}
layer, err = f()
if err != nil {
return libcnb.Layer{}, err
}
layer.LayerTypes = l.ExpectedTypes
layer.Metadata = expected
return layer, nil
}
// DependencyLayerContributor is a helper for implementing a libcnb.LayerContributor for a BuildpackDependency in order
// to get consistent logging and avoidance.
type DependencyLayerContributor struct {
// Dependency is the dependency being contributed.
Dependency BuildpackDependency
// DependencyCache is the cache to use to get the dependency.
DependencyCache DependencyCache
// ExpectedTypes indicates the types that should be set on the layer.
ExpectedTypes libcnb.LayerTypes
// ExpectedMetadata contains metadata describing the expected layer
ExpectedMetadata interface{}
// Logger is the logger to use.
Logger bard.Logger
// RequestModifierFuncs is an optional Request Modifier to use when downloading the dependency.
RequestModifierFuncs []RequestModifierFunc
}
// NewDependencyLayer returns a new DependencyLayerContributor for the given BuildpackDependency and a BOMEntry describing the layer contents.
//
// Deprecated: this method uses `libcnb.BOMEntry` which has been deprecated upstream, a future version will drop
// support for `libcnb.BOMEntry` which will change this method signature
func NewDependencyLayer(dependency BuildpackDependency, cache DependencyCache, types libcnb.LayerTypes) (DependencyLayerContributor, libcnb.BOMEntry) {
c := DependencyLayerContributor{
Dependency: dependency,
ExpectedMetadata: dependency,
DependencyCache: cache,
ExpectedTypes: types,
}
var entry libcnb.BOMEntry
if dependency.PURL == "" && len(dependency.CPEs) == 0 {
entry = dependency.AsBOMEntry()
entry.Metadata["layer"] = c.LayerName()
if types.Launch {
entry.Launch = true
}
if !(types.Launch && !types.Cache && !types.Build) {
// launch-only layers are the only layers NOT guaranteed to be present in the build environment
entry.Build = true
}
}
return c, entry
}
// DependencyLayerFunc is a callback function that is invoked when a dependency needs to be contributed.
type DependencyLayerFunc func(artifact *os.File) (libcnb.Layer, error)
// Contribute is the function to call whe implementing your libcnb.LayerContributor.
func (d *DependencyLayerContributor) Contribute(layer libcnb.Layer, f DependencyLayerFunc) (libcnb.Layer, error) {
lc := NewLayerContributor(d.Name(), d.ExpectedMetadata, d.ExpectedTypes)
lc.Logger = d.Logger
return lc.Contribute(layer, func() (libcnb.Layer, error) {
artifact, err := d.DependencyCache.Artifact(d.Dependency, d.RequestModifierFuncs...)
if err != nil {
return libcnb.Layer{}, fmt.Errorf("unable to get dependency %s\n%w", d.Dependency.ID, err)
}
defer artifact.Close()
sbomArtifact, err := d.Dependency.AsSyftArtifact()
if err != nil {
return libcnb.Layer{}, fmt.Errorf("unable to get SBOM artifact %s\n%w", d.Dependency.ID, err)
}
sbomPath := layer.SBOMPath(libcnb.SyftJSON)
dep := sbom.NewSyftDependency(layer.Path, []sbom.SyftArtifact{sbomArtifact})
d.Logger.Debugf("Writing Syft SBOM at %s: %+v", sbomPath, dep)
if err := dep.WriteTo(sbomPath); err != nil {
return libcnb.Layer{}, fmt.Errorf("unable to write SBOM\n%w", err)
}
return f(artifact)
})
}
// LayerName returns the conventional name of the layer for this contributor
func (d *DependencyLayerContributor) LayerName() string {
return d.Dependency.ID
}
// Name returns the human readable name of the layer
func (d *DependencyLayerContributor) Name() string {
return fmt.Sprintf("%s %s", d.Dependency.Name, d.Dependency.Version)
}
// HelperLayerContributor is a helper for implementing a libcnb.LayerContributor for a buildpack helper application in
// order to get consistent logging and avoidance.
type HelperLayerContributor struct {
// Path is the path to the helper application.
Path string
// BuildpackInfo describes the buildpack that provides the helper
BuildpackInfo libcnb.BuildpackInfo
// Logger is the logger to use.
Logger bard.Logger
// Names are the names of the helpers to create
Names []string
}
// NewHelperLayer returns a new HelperLayerContributor and a BOMEntry describing the layer contents.
//
// Deprecated: this method uses `libcnb.BOMEntry` which has been deprecated upstream, a future version will drop
// support for `libcnb.BOMEntry` which will change this method signature
func NewHelperLayer(buildpack libcnb.Buildpack, names ...string) (HelperLayerContributor, libcnb.BOMEntry) {
c := HelperLayerContributor{
Path: filepath.Join(buildpack.Path, "bin", "helper"),
Names: names,
BuildpackInfo: buildpack.Info,
}
var entry libcnb.BOMEntry
if buildpack.API == "0.6" || buildpack.API == "0.5" || buildpack.API == "0.4" || buildpack.API == "0.3" || buildpack.API == "0.2" || buildpack.API == "0.1" {
entry = libcnb.BOMEntry{
Name: "helper",
Metadata: map[string]interface{}{
"layer": c.Name(),
"names": names,
"version": buildpack.Info.Version,
},
Launch: true,
}
}
return c, entry
}
// Name returns the conventional name of the layer for this contributor
func (h HelperLayerContributor) Name() string {
return filepath.Base(h.Path)
}
// Contribute is the function to call whe implementing your libcnb.LayerContributor.
func (h HelperLayerContributor) Contribute(layer libcnb.Layer) (libcnb.Layer, error) {
lc := NewLayerContributor("Launch Helper", h.BuildpackInfo, libcnb.LayerTypes{
Launch: true,
})
lc.Logger = h.Logger
return lc.Contribute(layer, func() (libcnb.Layer, error) {
in, err := os.Open(h.Path)
if err != nil {
return libcnb.Layer{}, fmt.Errorf("unable to open %s\n%w", h.Path, err)
}
defer in.Close()
out := filepath.Join(layer.Path, "helper")
if err := sherpa.CopyFile(in, out); err != nil {
return libcnb.Layer{}, fmt.Errorf("unable to copy %s to %s", h.Path, out)
}
for _, n := range h.Names {
link := layer.Exec.FilePath(n)
h.Logger.Bodyf("Creating %s", link)
f := filepath.Dir(link)
if err := os.MkdirAll(f, 0755); err != nil {
return libcnb.Layer{}, fmt.Errorf("unable to create %s\n%w", f, err)
}
if err := os.Symlink(out, link); err != nil {
return libcnb.Layer{}, fmt.Errorf("unable to link %s to %s\n%w", out, link, err)
}
}
sbomArtifact, err := h.AsSyftArtifact()
if err != nil {
return libcnb.Layer{}, fmt.Errorf("unable to get SBOM artifact for helper\n%w", err)
}
sbomPath := layer.SBOMPath(libcnb.SyftJSON)
dep := sbom.NewSyftDependency(layer.Path, []sbom.SyftArtifact{sbomArtifact})
h.Logger.Debugf("Writing Syft SBOM at %s: %+v", sbomPath, dep)
if err := dep.WriteTo(sbomPath); err != nil {
return libcnb.Layer{}, fmt.Errorf("unable to write SBOM\n%w", err)
}
return layer, nil
})
}
func (h HelperLayerContributor) AsSyftArtifact() (sbom.SyftArtifact, error) {
licenses := []string{}
for _, license := range h.BuildpackInfo.Licenses {
licenses = append(licenses, license.Type)
}
locations := []sbom.SyftLocation{}
cpes := []string{}
for _, name := range h.Names {
locations = append(locations, sbom.SyftLocation{Path: name})
cpes = append(cpes, fmt.Sprintf("cpe:2.3:a:%s:%s:%s:*:*:*:*:*:*:*",
h.BuildpackInfo.ID, name, h.BuildpackInfo.Version))
}
artifact := sbom.SyftArtifact{
Name: "helper",
Version: h.BuildpackInfo.Version,
Type: "UnknownPackage",
FoundBy: "libpak",
Licenses: licenses,
Locations: locations,
CPEs: cpes,
PURL: fmt.Sprintf("pkg:generic/%s@%s", h.BuildpackInfo.ID, h.BuildpackInfo.Version),
}
var err error
artifact.ID, err = artifact.Hash()
if err != nil {
return sbom.SyftArtifact{}, fmt.Errorf("unable to generate hash\n%w", err)
}
return artifact, nil
}