-
Notifications
You must be signed in to change notification settings - Fork 305
/
extend.go
352 lines (293 loc) · 10.2 KB
/
extend.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
package feature
import (
"encoding/json"
"fmt"
"os"
"path/filepath"
"regexp"
"strconv"
"strings"
"github.com/google/go-containerregistry/pkg/name"
"github.com/loft-sh/devpod/pkg/copy"
"github.com/loft-sh/devpod/pkg/devcontainer/config"
"github.com/loft-sh/devpod/pkg/devcontainer/graph"
"github.com/loft-sh/devpod/pkg/devcontainer/metadata"
"github.com/loft-sh/log"
"github.com/pkg/errors"
)
var featureSafeIDRegex1 = regexp.MustCompile(`[^\w_]`)
var featureSafeIDRegex2 = regexp.MustCompile(`^[\d_]+`)
const FEATURE_BASE_DOCKERFILE = `
FROM $_DEV_CONTAINERS_BASE_IMAGE AS dev_containers_target_stage
USER root
COPY ./` + config.DevPodContextFeatureFolder + `/ /tmp/build-features/
RUN chmod -R 0755 /tmp/build-features && ls /tmp/build-features
#{featureLayer}
ARG _DEV_CONTAINERS_IMAGE_USER=root
USER $_DEV_CONTAINERS_IMAGE_USER
`
type ExtendedBuildInfo struct {
Features []*config.FeatureSet
FeaturesBuildInfo *BuildInfo
MetadataConfig *config.ImageMetadataConfig
MetadataLabel string
}
type BuildInfo struct {
FeaturesFolder string
DockerfileContent string
OverrideTarget string
DockerfilePrefixContent string
BuildArgs map[string]string
}
func GetExtendedBuildInfo(substitutionContext *config.SubstitutionContext, baseImageMetadata *config.ImageMetadataConfig, user, target string, devContainerConfig *config.SubstitutedConfig, log log.Logger, forceBuild bool) (*ExtendedBuildInfo, error) {
features, err := fetchFeatures(devContainerConfig.Config, log, forceBuild)
if err != nil {
return nil, errors.Wrap(err, "fetch features")
}
mergedImageMetadataConfig, err := metadata.GetDevContainerMetadata(substitutionContext, baseImageMetadata, devContainerConfig, features)
if err != nil {
return nil, errors.Wrap(err, "get dev container metadata")
}
marshalled, err := json.Marshal(mergedImageMetadataConfig.Raw)
if err != nil {
return nil, err
}
// no features?
if len(features) == 0 {
return &ExtendedBuildInfo{
MetadataLabel: string(marshalled),
MetadataConfig: mergedImageMetadataConfig,
}, nil
}
contextPath := config.GetContextPath(devContainerConfig.Config)
buildInfo, err := getFeatureBuildOptions(contextPath, baseImageMetadata, user, target, features)
if err != nil {
return nil, err
}
return &ExtendedBuildInfo{
Features: features,
FeaturesBuildInfo: buildInfo,
MetadataConfig: mergedImageMetadataConfig,
MetadataLabel: string(marshalled),
}, nil
}
func getFeatureBuildOptions(contextPath string, baseImageMetadata *config.ImageMetadataConfig, user, target string, features []*config.FeatureSet) (*BuildInfo, error) {
containerUser, remoteUser := findContainerUsers(baseImageMetadata, "", user)
// copy features
featureFolder := filepath.Join(contextPath, config.DevPodContextFeatureFolder)
err := copyFeaturesToDestination(features, featureFolder)
if err != nil {
return nil, err
}
// write devcontainer-features.builtin.env, its important to have a terminating \n here as we append to that file later
err = os.WriteFile(filepath.Join(featureFolder, "devcontainer-features.builtin.env"), []byte(`_CONTAINER_USER=`+containerUser+`
_REMOTE_USER=`+remoteUser+"\n"), 0600)
if err != nil {
return nil, err
}
// prepare dockerfile
dockerfileContent := strings.ReplaceAll(FEATURE_BASE_DOCKERFILE, "#{featureLayer}", getFeatureLayers(containerUser, remoteUser, features))
dockerfilePrefix := `
# syntax=docker.io/docker/dockerfile:1.4
ARG _DEV_CONTAINERS_BASE_IMAGE=placeholder`
return &BuildInfo{
FeaturesFolder: featureFolder,
DockerfileContent: dockerfileContent,
DockerfilePrefixContent: dockerfilePrefix,
OverrideTarget: "dev_containers_target_stage",
BuildArgs: map[string]string{
"_DEV_CONTAINERS_BASE_IMAGE": target,
"_DEV_CONTAINERS_IMAGE_USER": user,
},
}, nil
}
func copyFeaturesToDestination(features []*config.FeatureSet, targetDir string) error {
// make sure the folder doesn't exist initially
_ = os.RemoveAll(targetDir)
for i, feature := range features {
featureDir := filepath.Join(targetDir, strconv.Itoa(i))
err := os.MkdirAll(featureDir, 0755)
if err != nil {
return err
}
err = copy.Directory(feature.Folder, featureDir)
if err != nil {
return errors.Wrapf(err, "copy feature %s", feature.ConfigID)
}
// copy feature folder
envPath := filepath.Join(featureDir, "devcontainer-features.env")
variables := getFeatureEnvVariables(feature.Config, feature.Options)
err = os.WriteFile(envPath, []byte(strings.Join(variables, "\n")), 0600)
if err != nil {
return errors.Wrapf(err, "write variables of feature %s", feature.ConfigID)
}
installWrapperPath := filepath.Join(featureDir, "devcontainer-features-install.sh")
installWrapperContent := getFeatureInstallWrapperScript(feature.ConfigID, feature.Config, variables)
err = os.WriteFile(installWrapperPath, []byte(installWrapperContent), 0600)
if err != nil {
return errors.Wrapf(err, "write install wrapper script for feature %s", feature.ConfigID)
}
}
return nil
}
func getFeatureSafeID(featureID string) string {
return strings.ToUpper(featureSafeIDRegex2.ReplaceAllString(featureSafeIDRegex1.ReplaceAllString(featureID, "_"), "_"))
}
func getFeatureLayers(containerUser, remoteUser string, features []*config.FeatureSet) string {
result := `RUN \
echo "_CONTAINER_USER_HOME=$(getent passwd ` + containerUser + ` | cut -d: -f6)" >> /tmp/build-features/devcontainer-features.builtin.env && \
echo "_REMOTE_USER_HOME=$(getent passwd ` + remoteUser + ` | cut -d: -f6)" >> /tmp/build-features/devcontainer-features.builtin.env
`
for i, feature := range features {
result += generateContainerEnvs(feature)
result += `
RUN cd /tmp/build-features/` + strconv.Itoa(i) + ` \
&& chmod +x ./devcontainer-features-install.sh \
&& ./devcontainer-features-install.sh
`
}
return result
}
func generateContainerEnvs(feature *config.FeatureSet) string {
result := []string{}
if len(feature.Config.ContainerEnv) == 0 {
return ""
}
for k, v := range feature.Config.ContainerEnv {
result = append(result, fmt.Sprintf("ENV %s=%s", k, v))
}
return strings.Join(result, "\n")
}
func findContainerUsers(baseImageMetadata *config.ImageMetadataConfig, composeServiceUser, imageUser string) (string, string) {
reversed := config.ReverseSlice(baseImageMetadata.Config)
containerUser := ""
remoteUser := ""
for _, imageMetadata := range reversed {
if containerUser == "" && imageMetadata.ContainerUser != "" {
containerUser = imageMetadata.ContainerUser
}
if remoteUser == "" && imageMetadata.RemoteUser != "" {
remoteUser = imageMetadata.RemoteUser
}
}
if containerUser == "" {
if composeServiceUser != "" {
containerUser = composeServiceUser
} else if imageUser != "" {
containerUser = imageUser
}
}
if remoteUser == "" {
if composeServiceUser != "" {
remoteUser = composeServiceUser
} else if imageUser != "" {
remoteUser = imageUser
}
}
return containerUser, remoteUser
}
func fetchFeatures(devContainerConfig *config.DevContainerConfig, log log.Logger, forceBuild bool) ([]*config.FeatureSet, error) {
featureSets := []*config.FeatureSet{}
for featureID, featureOptions := range devContainerConfig.Features {
featureFolder, err := ProcessFeatureID(featureID, devContainerConfig, log, forceBuild)
if err != nil {
return nil, errors.Wrap(err, "process feature "+featureID)
}
// parse feature
log.Debugf("Parse dev container feature in %s", featureFolder)
featureConfig, err := config.ParseDevContainerFeature(featureFolder)
if err != nil {
return nil, errors.Wrap(err, "parse feature "+featureID)
}
// add to return array
featureSets = append(featureSets, &config.FeatureSet{
ConfigID: NormalizeFeatureID(featureID),
Folder: featureFolder,
Config: featureConfig,
Options: featureOptions,
})
}
// compute order here
featureSets, err := computeFeatureOrder(devContainerConfig, featureSets)
if err != nil {
return nil, errors.Wrap(err, "compute feature order")
}
return featureSets, nil
}
func NormalizeFeatureID(featureID string) string {
ref, err := name.ParseReference(featureID)
if err != nil {
return featureID
}
tag, ok := ref.(name.Tag)
if ok {
return tag.Repository.Name()
}
return ref.String()
}
func computeFeatureOrder(devContainer *config.DevContainerConfig, features []*config.FeatureSet) ([]*config.FeatureSet, error) {
if len(devContainer.OverrideFeatureInstallOrder) == 0 {
return computeAutomaticFeatureOrder(features)
}
automaticOrder, err := computeAutomaticFeatureOrder(features)
if err != nil {
return nil, err
}
orderedFeatures := []*config.FeatureSet{}
for _, feature := range devContainer.OverrideFeatureInstallOrder {
featureID := NormalizeFeatureID(feature)
// remove from automaticOrder and move to orderedFeatures
newAutomaticOrder := []*config.FeatureSet{}
for _, featureConfig := range automaticOrder {
if featureConfig.ConfigID == featureID {
orderedFeatures = append(orderedFeatures, featureConfig)
continue
}
newAutomaticOrder = append(newAutomaticOrder, featureConfig)
}
automaticOrder = newAutomaticOrder
}
orderedFeatures = append(orderedFeatures, automaticOrder...)
return orderedFeatures, nil
}
func computeAutomaticFeatureOrder(features []*config.FeatureSet) ([]*config.FeatureSet, error) {
g := graph.NewGraph[*config.FeatureSet](graph.NewNode[*config.FeatureSet]("root", nil))
// build lookup map
lookup := map[string]*config.FeatureSet{}
for _, feature := range features {
lookup[feature.ConfigID] = feature
}
// build graph
for _, feature := range features {
_, err := g.InsertNodeAt("root", feature.ConfigID, feature)
if err != nil {
return nil, err
}
// add edges
for _, installAfter := range feature.Config.InstallsAfter {
installAfterFeature, ok := lookup[installAfter]
if !ok {
continue
}
// add an edge from feature to installAfterFeature
_, err = g.InsertNodeAt(feature.ConfigID, installAfter, installAfterFeature)
if err != nil {
return nil, err
}
}
}
// now remove node after node
ordered := []*config.FeatureSet{}
for {
leaf := g.GetNextLeaf(g.Root)
if leaf == g.Root {
break
}
err := g.RemoveNode(leaf.ID)
if err != nil {
return nil, err
}
ordered = append(ordered, leaf.Data)
}
return ordered, nil
}