-
Notifications
You must be signed in to change notification settings - Fork 8.8k
/
chaincode_package.go
326 lines (259 loc) · 8.9 KB
/
chaincode_package.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
/*
Copyright IBM Corp. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
*/
package persistence
import (
"archive/tar"
"bytes"
"compress/gzip"
"encoding/json"
"io"
"io/ioutil"
"os"
"path/filepath"
"regexp"
pb "github.com/hyperledger/fabric-protos-go/peer"
"github.com/pkg/errors"
)
// The chaincode package is simply a .tar.gz file. For the time being, we
// assume that the package contains a metadata.json file which contains a
// 'type', a 'path', and a 'label'. In the future, it would be nice if we
// move to a more buildpack type system, rather than the below presented
// JAR+manifest type system, but for expediency and incremental changes,
// moving to a tar format over the proto format for a user-inspectable
// artifact seems like a good step.
const (
// MetadataFile is the expected location of the metadata json document
// in the top level of the chaincode package.
MetadataFile = "metadata.json"
// CodePackageFile is the expected location of the code package in the
// top level of the chaincode package
CodePackageFile = "code.tar.gz"
)
//go:generate counterfeiter -o mock/legacy_cc_package_locator.go --fake-name LegacyCCPackageLocator . LegacyCCPackageLocator
type LegacyCCPackageLocator interface {
GetChaincodeDepSpec(nameVersion string) (*pb.ChaincodeDeploymentSpec, error)
}
type FallbackPackageLocator struct {
ChaincodePackageLocator *ChaincodePackageLocator
LegacyCCPackageLocator LegacyCCPackageLocator
}
func (fpl *FallbackPackageLocator) GetChaincodePackage(packageID string) (*ChaincodePackageMetadata, []byte, io.ReadCloser, error) {
// XXX, this path has too many return parameters. We could split it into two calls,
// or, we could deserialize the metadata where it's needed. But, as written was the
// fastest path to fixing a bug around the mutation of metadata.
streamer := fpl.ChaincodePackageLocator.ChaincodePackageStreamer(packageID)
if streamer.Exists() {
metadata, err := streamer.Metadata()
if err != nil {
return nil, nil, nil, errors.WithMessagef(err, "error retrieving chaincode package metadata '%s'", packageID)
}
mdBytes, err := streamer.MetadataBytes()
if err != nil {
return nil, nil, nil, errors.WithMessagef(err, "error retrieving chaincode package metadata bytes '%s'", packageID)
}
tarStream, err := streamer.Code()
if err != nil {
return nil, nil, nil, errors.WithMessagef(err, "error retrieving chaincode package code '%s'", packageID)
}
return metadata, mdBytes, tarStream, nil
}
cds, err := fpl.LegacyCCPackageLocator.GetChaincodeDepSpec(string(packageID))
if err != nil {
return nil, nil, nil, errors.WithMessagef(err, "could not get legacy chaincode package '%s'", packageID)
}
md := &ChaincodePackageMetadata{
Path: cds.ChaincodeSpec.ChaincodeId.Path,
Type: cds.ChaincodeSpec.Type.String(),
Label: cds.ChaincodeSpec.ChaincodeId.Name,
}
mdBytes, err := json.Marshal(md)
return md,
mdBytes,
ioutil.NopCloser(bytes.NewBuffer(cds.CodePackage)),
nil
}
type ChaincodePackageLocator struct {
ChaincodeDir string
}
func (cpl *ChaincodePackageLocator) ChaincodePackageStreamer(packageID string) *ChaincodePackageStreamer {
return &ChaincodePackageStreamer{
PackagePath: filepath.Join(cpl.ChaincodeDir, CCFileName(packageID)),
}
}
type ChaincodePackageStreamer struct {
PackagePath string
}
func (cps *ChaincodePackageStreamer) Exists() bool {
_, err := os.Stat(cps.PackagePath)
return err == nil
}
func (cps *ChaincodePackageStreamer) Metadata() (*ChaincodePackageMetadata, error) {
tarFileStream, err := cps.File(MetadataFile)
if err != nil {
return nil, errors.WithMessage(err, "could not get metadata file")
}
defer tarFileStream.Close()
metadata := &ChaincodePackageMetadata{}
err = json.NewDecoder(tarFileStream).Decode(metadata)
if err != nil {
return nil, errors.WithMessage(err, "could not parse metadata file")
}
return metadata, nil
}
func (cps *ChaincodePackageStreamer) MetadataBytes() ([]byte, error) {
tarFileStream, err := cps.File(MetadataFile)
if err != nil {
return nil, errors.WithMessage(err, "could not get metadata file")
}
defer tarFileStream.Close()
md, err := ioutil.ReadAll(tarFileStream)
if err != nil {
return nil, errors.WithMessage(err, "could read metadata file")
}
return md, nil
}
func (cps *ChaincodePackageStreamer) Code() (*TarFileStream, error) {
tarFileStream, err := cps.File(CodePackageFile)
if err != nil {
return nil, errors.WithMessage(err, "could not get code package")
}
return tarFileStream, nil
}
func (cps *ChaincodePackageStreamer) File(name string) (tarFileStream *TarFileStream, err error) {
file, err := os.Open(cps.PackagePath)
if err != nil {
return nil, errors.WithMessagef(err, "could not open chaincode package at '%s'", cps.PackagePath)
}
defer func() {
if err != nil {
file.Close()
}
}()
gzReader, err := gzip.NewReader(file)
if err != nil {
return nil, errors.Wrapf(err, "error reading as gzip stream")
}
tarReader := tar.NewReader(gzReader)
for {
header, err := tarReader.Next()
if err == io.EOF {
break
}
if err != nil {
return nil, errors.Wrapf(err, "error inspecting next tar header")
}
if header.Name != name {
continue
}
if header.Typeflag != tar.TypeReg {
return nil, errors.Errorf("tar entry %s is not a regular file, type %v", header.Name, header.Typeflag)
}
return &TarFileStream{
TarFile: tarReader,
FileStream: file,
}, nil
}
return nil, errors.Errorf("did not find file '%s' in package", name)
}
type TarFileStream struct {
TarFile io.Reader
FileStream io.Closer
}
func (tfs *TarFileStream) Read(p []byte) (int, error) {
return tfs.TarFile.Read(p)
}
func (tfs *TarFileStream) Close() error {
return tfs.FileStream.Close()
}
// ChaincodePackage represents the un-tar-ed format of the chaincode package.
type ChaincodePackage struct {
Metadata *ChaincodePackageMetadata
CodePackage []byte
DBArtifacts []byte
}
// ChaincodePackageMetadata contains the information necessary to understand
// the embedded code package.
type ChaincodePackageMetadata struct {
Type string `json:"type"`
Path string `json:"path"`
Label string `json:"label"`
}
// MetadataProvider provides the means to retrieve metadata
// information (for instance the DB indexes) from a code package.
type MetadataProvider interface {
GetDBArtifacts(codePackage []byte) ([]byte, error)
}
// ChaincodePackageParser provides the ability to parse chaincode packages.
type ChaincodePackageParser struct {
MetadataProvider MetadataProvider
}
// LabelRegexp is the regular expression controlling the allowed characters
// for the package label.
var LabelRegexp = regexp.MustCompile(`^[[:alnum:]][[:alnum:]_.+-]*$`)
// ValidateLabel return an error if the provided label contains any invalid
// characters, as determined by LabelRegexp.
func ValidateLabel(label string) error {
if !LabelRegexp.MatchString(label) {
return errors.Errorf("invalid label '%s'. Label must be non-empty, can only consist of alphanumerics, symbols from '.+-_', and can only begin with alphanumerics", label)
}
return nil
}
// Parse parses a set of bytes as a chaincode package
// and returns the parsed package as a struct
func (ccpp ChaincodePackageParser) Parse(source []byte) (*ChaincodePackage, error) {
gzReader, err := gzip.NewReader(bytes.NewBuffer(source))
if err != nil {
return nil, errors.Wrapf(err, "error reading as gzip stream")
}
tarReader := tar.NewReader(gzReader)
var codePackage []byte
var ccPackageMetadata *ChaincodePackageMetadata
for {
header, err := tarReader.Next()
if err == io.EOF {
break
}
if err != nil {
return nil, errors.Wrapf(err, "error inspecting next tar header")
}
if header.Typeflag != tar.TypeReg {
return nil, errors.Errorf("tar entry %s is not a regular file, type %v", header.Name, header.Typeflag)
}
fileBytes, err := ioutil.ReadAll(tarReader)
if err != nil {
return nil, errors.Wrapf(err, "could not read %s from tar", header.Name)
}
switch header.Name {
case MetadataFile:
ccPackageMetadata = &ChaincodePackageMetadata{}
err := json.Unmarshal(fileBytes, ccPackageMetadata)
if err != nil {
return nil, errors.Wrapf(err, "could not unmarshal %s as json", MetadataFile)
}
case CodePackageFile:
codePackage = fileBytes
default:
logger.Warningf("Encountered unexpected file '%s' in top level of chaincode package", header.Name)
}
}
if codePackage == nil {
return nil, errors.Errorf("did not find a code package inside the package")
}
if ccPackageMetadata == nil {
return nil, errors.Errorf("did not find any package metadata (missing %s)", MetadataFile)
}
if err := ValidateLabel(ccPackageMetadata.Label); err != nil {
return nil, err
}
dbArtifacts, err := ccpp.MetadataProvider.GetDBArtifacts(codePackage)
if err != nil {
return nil, errors.WithMessage(err, "error retrieving DB artifacts from code package")
}
return &ChaincodePackage{
Metadata: ccPackageMetadata,
CodePackage: codePackage,
DBArtifacts: dbArtifacts,
}, nil
}