forked from hyperledger/fabric
/
checkcommitreadiness.go
282 lines (242 loc) · 8.56 KB
/
checkcommitreadiness.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
/*
Copyright IBM Corp. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
*/
package chaincode
import (
"context"
"fmt"
"io"
"os"
"sort"
"strings"
"github.com/golang/protobuf/proto"
cb "github.com/hyperledger/fabric-protos-go/common"
pb "github.com/hyperledger/fabric-protos-go/peer"
lb "github.com/hyperledger/fabric-protos-go/peer/lifecycle"
"github.com/hyperledger/fabric/bccsp"
"github.com/hyperledger/fabric/internal/pkg/identity"
"github.com/hyperledger/fabric/protoutil"
"github.com/pkg/errors"
"github.com/spf13/cobra"
"github.com/spf13/viper"
)
// CommitReadinessChecker holds the dependencies needed to
// check whether a chaincode definition is ready to be committed
// on a channel (i.e. has approvals from enough organizations to satisfy
// the lifecycle endorsement policy) and receive the list of orgs that
// have approved the definition.
type CommitReadinessChecker struct {
Command *cobra.Command
EndorserClient pb.EndorserClient
Input *CommitReadinessCheckInput
Signer identity.SignerSerializer
Writer io.Writer
}
// CommitReadinessCheckInput holds all of the input parameters for checking
// whether a chaincode definition is ready to be committed ValidationParameter
// bytes is the (marshalled) endorsement policy when using the default
// endorsement and validation plugins.
type CommitReadinessCheckInput struct {
ChannelID string
Name string
Version string
PackageID string
Sequence int64
EndorsementPlugin string
ValidationPlugin string
ValidationParameterBytes []byte
CollectionConfigPackage *pb.CollectionConfigPackage
InitRequired bool
PeerAddresses []string
TxID string
OutputFormat string
}
// Validate the input for a CheckCommitReadiness proposal
func (c *CommitReadinessCheckInput) Validate() error {
if c.ChannelID == "" {
return errors.New("The required parameter 'channelID' is empty. Rerun the command with -C flag")
}
if c.Name == "" {
return errors.New("The required parameter 'name' is empty. Rerun the command with -n flag")
}
if c.Version == "" {
return errors.New("The required parameter 'version' is empty. Rerun the command with -v flag")
}
if c.Sequence == 0 {
return errors.New("The required parameter 'sequence' is empty. Rerun the command with --sequence flag")
}
return nil
}
// CheckCommitReadinessCmd returns the cobra command for the
// CheckCommitReadiness lifecycle operation
func CheckCommitReadinessCmd(c *CommitReadinessChecker, cryptoProvider bccsp.BCCSP) *cobra.Command {
chaincodeCheckCommitReadinessCmd := &cobra.Command{
Use: "checkcommitreadiness",
Short: fmt.Sprintf("Check whether a chaincode definition is ready to be committed on a channel."),
Long: fmt.Sprintf("Check whether a chaincode definition is ready to be committed on a channel."),
RunE: func(cmd *cobra.Command, args []string) error {
if c == nil {
// set input from CLI flags
input, err := c.createInput()
if err != nil {
return err
}
ccInput := &ClientConnectionsInput{
CommandName: cmd.Name(),
EndorserRequired: true,
ChannelID: channelID,
PeerAddresses: peerAddresses,
TLSRootCertFiles: tlsRootCertFiles,
ConnectionProfilePath: connectionProfilePath,
TLSEnabled: viper.GetBool("peer.tls.enabled"),
}
cc, err := NewClientConnections(ccInput, cryptoProvider)
if err != nil {
return err
}
c = &CommitReadinessChecker{
Command: cmd,
Input: input,
EndorserClient: cc.EndorserClients[0],
Signer: cc.Signer,
Writer: os.Stdout,
}
}
return c.ReadinessCheck()
},
}
flagList := []string{
"channelID",
"name",
"version",
"sequence",
"endorsement-plugin",
"validation-plugin",
"signature-policy",
"channel-config-policy",
"init-required",
"collections-config",
"peerAddresses",
"tlsRootCertFiles",
"connectionProfile",
"output",
}
attachFlags(chaincodeCheckCommitReadinessCmd, flagList)
return chaincodeCheckCommitReadinessCmd
}
// ReadinessCheck submits a CheckCommitReadiness proposal
// and prints the result.
func (c *CommitReadinessChecker) ReadinessCheck() error {
err := c.Input.Validate()
if err != nil {
return err
}
if c.Command != nil {
// Parsing of the command line is done so silence cmd usage
c.Command.SilenceUsage = true
}
proposal, err := c.createProposal(c.Input.TxID)
if err != nil {
return errors.WithMessage(err, "failed to create proposal")
}
signedProposal, err := signProposal(proposal, c.Signer)
if err != nil {
return errors.WithMessage(err, "failed to create signed proposal")
}
// checkcommitreadiness currently only supports a single peer
proposalResponse, err := c.EndorserClient.ProcessProposal(context.Background(), signedProposal)
if err != nil {
return errors.WithMessage(err, "failed to endorse proposal")
}
if proposalResponse == nil {
return errors.New("received nil proposal response")
}
if proposalResponse.Response == nil {
return errors.New("received proposal response with nil response")
}
if proposalResponse.Response.Status != int32(cb.Status_SUCCESS) {
return errors.Errorf("query failed with status: %d - %s", proposalResponse.Response.Status, proposalResponse.Response.Message)
}
if strings.ToLower(c.Input.OutputFormat) == "json" {
return printResponseAsJSON(proposalResponse, &lb.CheckCommitReadinessResult{}, c.Writer)
}
return c.printResponse(proposalResponse)
}
// printResponse prints the information included in the response
// from the server as human readable plain-text.
func (c *CommitReadinessChecker) printResponse(proposalResponse *pb.ProposalResponse) error {
result := &lb.CheckCommitReadinessResult{}
err := proto.Unmarshal(proposalResponse.Response.Payload, result)
if err != nil {
return errors.Wrap(err, "failed to unmarshal proposal response's response payload")
}
orgs := []string{}
for org := range result.Approvals {
orgs = append(orgs, org)
}
sort.Strings(orgs)
fmt.Fprintf(c.Writer, "Chaincode definition for chaincode '%s', version '%s', sequence '%d' on channel '%s' approval status by org:\n", c.Input.Name, c.Input.Version, c.Input.Sequence, c.Input.ChannelID)
for _, org := range orgs {
fmt.Fprintf(c.Writer, "%s: %t\n", org, result.Approvals[org])
}
return nil
}
// setInput creates the input struct based on the CLI flags
func (c *CommitReadinessChecker) createInput() (*CommitReadinessCheckInput, error) {
policyBytes, err := createPolicyBytes(signaturePolicy, channelConfigPolicy)
if err != nil {
return nil, err
}
ccp, err := createCollectionConfigPackage(collectionsConfigFile)
if err != nil {
return nil, err
}
input := &CommitReadinessCheckInput{
ChannelID: channelID,
Name: chaincodeName,
Version: chaincodeVersion,
PackageID: packageID,
Sequence: int64(sequence),
EndorsementPlugin: endorsementPlugin,
ValidationPlugin: validationPlugin,
ValidationParameterBytes: policyBytes,
InitRequired: initRequired,
CollectionConfigPackage: ccp,
PeerAddresses: peerAddresses,
OutputFormat: output,
}
return input, nil
}
func (c *CommitReadinessChecker) createProposal(inputTxID string) (*pb.Proposal, error) {
args := &lb.CheckCommitReadinessArgs{
Name: c.Input.Name,
Version: c.Input.Version,
Sequence: c.Input.Sequence,
EndorsementPlugin: c.Input.EndorsementPlugin,
ValidationPlugin: c.Input.ValidationPlugin,
ValidationParameter: c.Input.ValidationParameterBytes,
InitRequired: c.Input.InitRequired,
Collections: c.Input.CollectionConfigPackage,
}
argsBytes, err := proto.Marshal(args)
if err != nil {
return nil, err
}
ccInput := &pb.ChaincodeInput{Args: [][]byte{[]byte(checkCommitReadinessFuncName), argsBytes}}
cis := &pb.ChaincodeInvocationSpec{
ChaincodeSpec: &pb.ChaincodeSpec{
ChaincodeId: &pb.ChaincodeID{Name: lifecycleName},
Input: ccInput,
},
}
creatorBytes, err := c.Signer.Serialize()
if err != nil {
return nil, errors.WithMessage(err, "failed to serialize identity")
}
proposal, _, err := protoutil.CreateChaincodeProposalWithTxIDAndTransient(cb.HeaderType_ENDORSER_TRANSACTION, c.Input.ChannelID, cis, creatorBytes, inputTxID, nil)
if err != nil {
return nil, errors.WithMessage(err, "failed to create ChaincodeInvocationSpec proposal")
}
return proposal, nil
}