/
Phase.java
154 lines (130 loc) · 3.83 KB
/
Phase.java
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
/*
* Copyright 2012-2022 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 org.springframework.boot.buildpack.platform.build;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.springframework.boot.buildpack.platform.docker.type.Binding;
import org.springframework.boot.buildpack.platform.docker.type.ContainerConfig;
import org.springframework.util.StringUtils;
/**
* An individual build phase executed as part of a {@link Lifecycle} run.
*
* @author Phillip Webb
* @author Scott Frederick
* @author Jeroen Meijer
*/
class Phase {
private final String name;
private final boolean verboseLogging;
private boolean daemonAccess = false;
private final List<String> args = new ArrayList<>();
private final List<Binding> bindings = new ArrayList<>();
private final Map<String, String> env = new LinkedHashMap<>();
private final List<String> securityOptions = new ArrayList<>();
private String networkMode;
/**
* Create a new {@link Phase} instance.
* @param name the name of the phase
* @param verboseLogging if verbose logging is requested
*/
Phase(String name, boolean verboseLogging) {
this.name = name;
this.verboseLogging = verboseLogging;
}
/**
* Update this phase with Docker daemon access.
*/
void withDaemonAccess() {
this.daemonAccess = true;
}
/**
* Update this phase with a debug log level arguments if verbose logging has been
* requested.
*/
void withLogLevelArg() {
if (this.verboseLogging) {
this.args.add("-log-level");
this.args.add("debug");
}
}
/**
* Update this phase with additional run arguments.
* @param args the arguments to add
*/
void withArgs(Object... args) {
Arrays.stream(args).map(Object::toString).forEach(this.args::add);
}
/**
* Update this phase with an addition volume binding.
* @param binding the binding
*/
void withBinding(Binding binding) {
this.bindings.add(binding);
}
/**
* Update this phase with an additional environment variable.
* @param name the variable name
* @param value the variable value
*/
void withEnv(String name, String value) {
this.env.put(name, value);
}
/**
* Update this phase with the network the build container will connect to.
* @param networkMode the network
*/
void withNetworkMode(String networkMode) {
this.networkMode = networkMode;
}
/**
* Update this phase with a security option.
* @param option the security option
*/
void withSecurityOption(String option) {
this.securityOptions.add(option);
}
/**
* Return the name of the phase.
* @return the phase name
*/
String getName() {
return this.name;
}
@Override
public String toString() {
return this.name;
}
/**
* Apply this phase settings to a {@link ContainerConfig} update.
* @param update the update to apply the phase to
*/
void apply(ContainerConfig.Update update) {
if (this.daemonAccess) {
update.withUser("root");
}
update.withCommand("/cnb/lifecycle/" + this.name, StringUtils.toStringArray(this.args));
update.withLabel("author", "spring-boot");
this.bindings.forEach(update::withBinding);
this.env.forEach(update::withEnv);
if (this.networkMode != null) {
update.withNetworkMode(this.networkMode);
}
this.securityOptions.forEach(update::withSecurityOption);
}
}