/
config.go
125 lines (102 loc) · 3.91 KB
/
config.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
/*
* 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 libcnb
//go:generate mockery --name EnvironmentWriter --case=underscore
// EnvironmentWriter is the interface implemented by a type that wants to serialize a map of environment variables to
// the file system.
type EnvironmentWriter interface {
// Write is called with the path to a directory where the environment variables should be serialized to and the
// environment variables to serialize to that directory.
Write(dir string, environment map[string]string) error
}
//go:generate mockery --name ExitHandler --case=underscore
// ExitHandler is the interface implemented by a type that wants to handle exit behavior when a buildpack encounters an
// error.
type ExitHandler interface {
// Error is called when an error is encountered.
Error(error)
// Fail is called when a buildpack fails.
Fail()
// Pass is called when a buildpack passes.
Pass()
}
//go:generate mockery --name TOMLWriter --case=underscore
// TOMLWriter is the interface implemented by a type that wants to serialize an object to a TOML file.
type TOMLWriter interface {
// Write is called with the path that a TOML file should be written to and the object to serialize to that file.
Write(path string, value interface{}) error
}
//go:generate mockery --name ExecDWriter --case=underscore
// ExecDWriter is the interface implemented by a type that wants to write exec.d output to file descriptor 3.
type ExecDWriter interface {
// Write is called with the map of environment value key value
// pairs that will be written out
Write(value map[string]string) error
}
// Config is an object that contains configurable properties for execution.
type Config struct {
arguments []string
bomLabel bool
environmentWriter EnvironmentWriter
exitHandler ExitHandler
tomlWriter TOMLWriter
execdWriter ExecDWriter
}
// Option is a function for configuring a Config instance.
type Option func(config Config) Config
// WithArguments creates an Option that sets a collection of arguments.
func WithArguments(arguments []string) Option {
return func(config Config) Config {
config.arguments = arguments
return config
}
}
// WithEnvironmentWriter creates an Option that sets an EnvironmentWriter implementation.
func WithEnvironmentWriter(environmentWriter EnvironmentWriter) Option {
return func(config Config) Config {
config.environmentWriter = environmentWriter
return config
}
}
// WithExitHandler creates an Option that sets an ExitHandler implementation.
func WithExitHandler(exitHandler ExitHandler) Option {
return func(config Config) Config {
config.exitHandler = exitHandler
return config
}
}
// WithTOMLWriter creates an Option that sets a TOMLWriter implementation.
func WithTOMLWriter(tomlWriter TOMLWriter) Option {
return func(config Config) Config {
config.tomlWriter = tomlWriter
return config
}
}
// WithExecDWriter creates an Option that sets a ExecDWriter implementation.
func WithExecDWriter(execdWriter ExecDWriter) Option {
return func(config Config) Config {
config.execdWriter = execdWriter
return config
}
}
// WithBOMLabel creates an Option that enables/disables writing the BOM Label
// Deprecated: as of Buildpack API 0.7, to be removed in a future version
func WithBOMLabel(bomLabel bool) Option {
return func(config Config) Config {
config.bomLabel = bomLabel
return config
}
}