forked from hyperledger/fabric
-
Notifications
You must be signed in to change notification settings - Fork 0
/
externalbuilder.go
436 lines (371 loc) · 13 KB
/
externalbuilder.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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
/*
Copyright IBM Corp. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
*/
package externalbuilder
import (
"encoding/json"
"fmt"
"io"
"io/ioutil"
"os"
"os/exec"
"path/filepath"
"regexp"
"time"
"github.com/hyperledger/fabric/common/flogging"
"github.com/hyperledger/fabric/core/container/ccintf"
"github.com/hyperledger/fabric/core/peer"
"github.com/pkg/errors"
)
var (
// DefaultEnvWhitelist enumerates the list of environment variables that are
// implicitly propagated to external builder and launcher commands.
DefaultEnvWhitelist = []string{"LD_LIBRARY_PATH", "LIBPATH", "PATH", "TMPDIR"}
logger = flogging.MustGetLogger("chaincode.externalbuilder")
)
// BuildInfo contains metadata is that is saved to the local file system with the
// assets generated by an external builder. This is used to associate build output
// with the builder that generated it.
type BuildInfo struct {
// BuilderName is the user provided name of the external builder.
BuilderName string `json:"builder_name"`
}
// A Detector is responsible for orchestrating the external builder detection and
// build process.
type Detector struct {
// DurablePath is the file system location where chaincode assets are persisted.
DurablePath string
// Builders are the builders that detect and build processing will use.
Builders []*Builder
}
// CachedBuild returns a build instance that was already built or nil when no
// instance has been found. An error is returned only when an unexpected
// condition is encountered.
func (d *Detector) CachedBuild(ccid string) (*Instance, error) {
durablePath := filepath.Join(d.DurablePath, SanitizeCCIDPath(ccid))
_, err := os.Stat(durablePath)
if os.IsNotExist(err) {
return nil, nil
}
if err != nil {
return nil, errors.WithMessage(err, "existing build detected, but something went wrong inspecting it")
}
buildInfoPath := filepath.Join(durablePath, "build-info.json")
buildInfoData, err := ioutil.ReadFile(buildInfoPath)
if err != nil {
return nil, errors.WithMessagef(err, "could not read '%s' for build info", buildInfoPath)
}
var buildInfo BuildInfo
if err := json.Unmarshal(buildInfoData, &buildInfo); err != nil {
return nil, errors.WithMessagef(err, "malformed build info at '%s'", buildInfoPath)
}
for _, builder := range d.Builders {
if builder.Name == buildInfo.BuilderName {
return &Instance{
PackageID: ccid,
Builder: builder,
BldDir: filepath.Join(durablePath, "bld"),
ReleaseDir: filepath.Join(durablePath, "release"),
TermTimeout: 5 * time.Second,
}, nil
}
}
return nil, errors.Errorf("chaincode '%s' was already built with builder '%s', but that builder is no longer available", ccid, buildInfo.BuilderName)
}
// Build executes the external builder detect and build process.
//
// Before running the detect and build process, the detector first checks the
// durable path for the results of a previous build for the provided package.
// If found, the detect and build process is skipped and the existing instance
// is returned.
func (d *Detector) Build(ccid string, mdBytes []byte, codeStream io.Reader) (*Instance, error) {
// A small optimization: prevent exploding the build package out into the
// file system unless there are external builders defined.
if len(d.Builders) == 0 {
return nil, nil
}
// Look for a cached instance.
i, err := d.CachedBuild(ccid)
if err != nil {
return nil, errors.WithMessage(err, "existing build could not be restored")
}
if i != nil {
return i, nil
}
buildContext, err := NewBuildContext(ccid, mdBytes, codeStream)
if err != nil {
return nil, errors.WithMessage(err, "could not create build context")
}
defer buildContext.Cleanup()
builder := d.detect(buildContext)
if builder == nil {
logger.Debugf("no external builder detected for %s", ccid)
return nil, nil
}
if err := builder.Build(buildContext); err != nil {
return nil, errors.WithMessage(err, "external builder failed to build")
}
if err := builder.Release(buildContext); err != nil {
return nil, errors.WithMessage(err, "external builder failed to release")
}
durablePath := filepath.Join(d.DurablePath, SanitizeCCIDPath(ccid))
err = os.Mkdir(durablePath, 0700)
if err != nil {
return nil, errors.WithMessagef(err, "could not create dir '%s' to persist build output", durablePath)
}
buildInfo, err := json.Marshal(&BuildInfo{
BuilderName: builder.Name,
})
if err != nil {
os.RemoveAll(durablePath)
return nil, errors.WithMessage(err, "could not marshal for build-info.json")
}
err = ioutil.WriteFile(filepath.Join(durablePath, "build-info.json"), buildInfo, 0600)
if err != nil {
os.RemoveAll(durablePath)
return nil, errors.WithMessage(err, "could not write build-info.json")
}
durableReleaseDir := filepath.Join(durablePath, "release")
err = MoveOrCopyDir(logger, buildContext.ReleaseDir, durableReleaseDir)
if err != nil {
return nil, errors.WithMessagef(err, "could not move or copy build context release to persistent location '%s'", durablePath)
}
durableBldDir := filepath.Join(durablePath, "bld")
err = MoveOrCopyDir(logger, buildContext.BldDir, durableBldDir)
if err != nil {
return nil, errors.WithMessagef(err, "could not move or copy build context bld to persistent location '%s'", durablePath)
}
return &Instance{
PackageID: ccid,
Builder: builder,
BldDir: durableBldDir,
ReleaseDir: durableReleaseDir,
TermTimeout: 5 * time.Second,
}, nil
}
func (d *Detector) detect(buildContext *BuildContext) *Builder {
for _, builder := range d.Builders {
if builder.Detect(buildContext) {
return builder
}
}
return nil
}
// BuildContext holds references to the various assets locations necessary to
// execute the detect, build, release, and run programs for external builders
type BuildContext struct {
CCID string
ScratchDir string
SourceDir string
ReleaseDir string
MetadataDir string
BldDir string
}
// NewBuildContext creates the directories required to runt he external
// build process and extracts the chaincode package assets.
//
// Users of the BuildContext must call Cleanup when the build process is
// complete to remove the transient file system assets.
func NewBuildContext(ccid string, mdBytes []byte, codePackage io.Reader) (bc *BuildContext, err error) {
scratchDir, err := ioutil.TempDir("", "fabric-"+SanitizeCCIDPath(ccid))
if err != nil {
return nil, errors.WithMessage(err, "could not create temp dir")
}
defer func() {
if err != nil {
os.RemoveAll(scratchDir)
}
}()
sourceDir := filepath.Join(scratchDir, "src")
if err = os.Mkdir(sourceDir, 0700); err != nil {
return nil, errors.WithMessage(err, "could not create source dir")
}
metadataDir := filepath.Join(scratchDir, "metadata")
if err = os.Mkdir(metadataDir, 0700); err != nil {
return nil, errors.WithMessage(err, "could not create metadata dir")
}
outputDir := filepath.Join(scratchDir, "bld")
if err = os.Mkdir(outputDir, 0700); err != nil {
return nil, errors.WithMessage(err, "could not create build dir")
}
releaseDir := filepath.Join(scratchDir, "release")
if err = os.Mkdir(releaseDir, 0700); err != nil {
return nil, errors.WithMessage(err, "could not create release dir")
}
err = Untar(codePackage, sourceDir)
if err != nil {
return nil, errors.WithMessage(err, "could not untar source package")
}
err = ioutil.WriteFile(filepath.Join(metadataDir, "metadata.json"), mdBytes, 0700)
if err != nil {
return nil, errors.WithMessage(err, "could not write metadata file")
}
return &BuildContext{
ScratchDir: scratchDir,
SourceDir: sourceDir,
MetadataDir: metadataDir,
BldDir: outputDir,
ReleaseDir: releaseDir,
CCID: ccid,
}, nil
}
// Cleanup removes the build context artifacts.
func (bc *BuildContext) Cleanup() {
os.RemoveAll(bc.ScratchDir)
}
var pkgIDreg = regexp.MustCompile("[<>:\"/\\\\|\\?\\*&]")
// SanitizeCCIDPath is used to ensure that special characters are removed from
// file names.
func SanitizeCCIDPath(ccid string) string {
return pkgIDreg.ReplaceAllString(ccid, "-")
}
// A Builder is used to interact with an external chaincode builder and launcher.
type Builder struct {
EnvWhitelist []string
Location string
Logger *flogging.FabricLogger
Name string
MSPID string
}
// CreateBuilders will construct builders from the peer configuration.
func CreateBuilders(builderConfs []peer.ExternalBuilder, mspid string) []*Builder {
var builders []*Builder
for _, builderConf := range builderConfs {
builders = append(builders, &Builder{
Location: builderConf.Path,
Name: builderConf.Name,
EnvWhitelist: builderConf.EnvironmentWhitelist,
Logger: logger.Named(builderConf.Name),
MSPID: mspid,
})
}
return builders
}
// Detect runs the `detect` script.
func (b *Builder) Detect(buildContext *BuildContext) bool {
detect := filepath.Join(b.Location, "bin", "detect")
cmd := b.NewCommand(detect, buildContext.SourceDir, buildContext.MetadataDir)
err := b.runCommand(cmd)
if err != nil {
logger.Debugf("builder '%s' detect failed: %s", b.Name, err)
return false
}
return true
}
// Build runs the `build` script.
func (b *Builder) Build(buildContext *BuildContext) error {
build := filepath.Join(b.Location, "bin", "build")
cmd := b.NewCommand(build, buildContext.SourceDir, buildContext.MetadataDir, buildContext.BldDir)
err := b.runCommand(cmd)
if err != nil {
return errors.Wrapf(err, "external builder '%s' failed", b.Name)
}
return nil
}
// Release runs the `release` script.
func (b *Builder) Release(buildContext *BuildContext) error {
release := filepath.Join(b.Location, "bin", "release")
_, err := os.Stat(release)
if os.IsNotExist(err) {
b.Logger.Debugf("Skipping release step for '%s' as no release binary found", buildContext.CCID)
return nil
}
if err != nil {
return errors.WithMessagef(err, "could not stat release binary '%s'", release)
}
cmd := b.NewCommand(release, buildContext.BldDir, buildContext.ReleaseDir)
err = b.runCommand(cmd)
if err != nil {
return errors.Wrapf(err, "builder '%s' release failed", b.Name)
}
return nil
}
// runConfig is serialized to disk when launching.
type runConfig struct {
CCID string `json:"chaincode_id"`
PeerAddress string `json:"peer_address"`
ClientCert string `json:"client_cert"` // PEM encoded client certificate
ClientKey string `json:"client_key"` // PEM encoded client key
RootCert string `json:"root_cert"` // PEM encoded peer chaincode certificate
MSPID string `json:"mspid"`
}
func newRunConfig(ccid string, peerConnection *ccintf.PeerConnection, mspid string) runConfig {
var tlsConfig ccintf.TLSConfig
if peerConnection.TLSConfig != nil {
tlsConfig = *peerConnection.TLSConfig
}
return runConfig{
PeerAddress: peerConnection.Address,
CCID: ccid,
ClientCert: string(tlsConfig.ClientCert),
ClientKey: string(tlsConfig.ClientKey),
RootCert: string(tlsConfig.RootCert),
MSPID: mspid,
}
}
// Run starts the `run` script and returns a Session that can be used to
// signal it and wait for termination.
func (b *Builder) Run(ccid, bldDir string, peerConnection *ccintf.PeerConnection) (*Session, error) {
launchDir, err := ioutil.TempDir("", "fabric-run")
if err != nil {
return nil, errors.WithMessage(err, "could not create temp run dir")
}
rc := newRunConfig(ccid, peerConnection, b.MSPID)
marshaledRC, err := json.Marshal(rc)
if err != nil {
return nil, errors.WithMessage(err, "could not marshal run config")
}
if err := ioutil.WriteFile(filepath.Join(launchDir, "chaincode.json"), marshaledRC, 0600); err != nil {
return nil, errors.WithMessage(err, "could not write root cert")
}
run := filepath.Join(b.Location, "bin", "run")
cmd := b.NewCommand(run, bldDir, launchDir)
sess, err := Start(b.Logger, cmd)
if err != nil {
os.RemoveAll(launchDir)
return nil, errors.Wrapf(err, "builder '%s' run failed to start", b.Name)
}
go func() {
defer os.RemoveAll(launchDir)
sess.Wait()
}()
return sess, nil
}
// runCommand runs a command and waits for it to complete.
func (b *Builder) runCommand(cmd *exec.Cmd) error {
sess, err := Start(b.Logger, cmd)
if err != nil {
return err
}
return sess.Wait()
}
// NewCommand creates an exec.Cmd that is configured to prune the calling
// environment down to the environment variables specified in the external
// builder's EnvironmentWhitelist and the DefaultEnvWhitelist.
func (b *Builder) NewCommand(name string, args ...string) *exec.Cmd {
cmd := exec.Command(name, args...)
whitelist := appendDefaultWhitelist(b.EnvWhitelist)
for _, key := range whitelist {
if val, ok := os.LookupEnv(key); ok {
cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", key, val))
}
}
return cmd
}
func appendDefaultWhitelist(envWhitelist []string) []string {
for _, variable := range DefaultEnvWhitelist {
if !contains(envWhitelist, variable) {
envWhitelist = append(envWhitelist, variable)
}
}
return envWhitelist
}
func contains(envWhiteList []string, key string) bool {
for _, variable := range envWhiteList {
if key == variable {
return true
}
}
return false
}