Skip to content

Commit 3b66f3b

Browse files
pfi79pfi79
authored
add call update channel config to osnadmin (hyperledger#5257)
Signed-off-by: Fedor Partanskiy <fredprtnsk@gmail.com>
1 parent 43fd1a5 commit 3b66f3b

File tree

8 files changed

+417
-9
lines changed

8 files changed

+417
-9
lines changed

‎cmd/osnadmin/main.go‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,11 @@ func executeForArgs(args []string) (output string, exit int, err error) {
5858
remove := channel.Command("remove", "Remove a channel from an Ordering Service Node (OSN).")
5959
removeChannelID := remove.Flag("channelID", "Channel ID").Short('c').Required().String()
6060

61+
update := channel.Command("update", "Update an Ordering Service Node (OSN) to a channel.")
62+
updateChannelID := update.Flag("channelID", "Channel ID").Short('c').Required().String()
63+
configUpdateEnvelopePath := update.Flag("config-update-envelope", "Path to the file containing an up-to-date config update envelope for the channel").Short('e').Required().String()
64+
tlsHandshakeTimeShift := update.Flag("tlsHandshakeTimeShift", "The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint").Short('t').Default("0").Duration()
65+
6166
command, err := app.Parse(args)
6267
if err != nil {
6368
return "", 1, err
@@ -105,6 +110,19 @@ func executeForArgs(args []string) (output string, exit int, err error) {
105110
}
106111
}
107112

113+
var marshaledConfigEnvelope []byte
114+
if *configUpdateEnvelopePath != "" {
115+
marshaledConfigEnvelope, err = os.ReadFile(*configUpdateEnvelopePath)
116+
if err != nil {
117+
return "", 1, fmt.Errorf("reading config updte envelope: %s", err)
118+
}
119+
120+
err = validateEnvelopeChannelID(marshaledConfigEnvelope, *updateChannelID)
121+
if err != nil {
122+
return "", 1, err
123+
}
124+
}
125+
108126
//
109127
// call the underlying implementations
110128
//
@@ -121,6 +139,8 @@ func executeForArgs(args []string) (output string, exit int, err error) {
121139
resp, err = osnadmin.ListAllChannels(osnURL, caCertPool, tlsClientCert)
122140
case remove.FullCommand():
123141
resp, err = osnadmin.Remove(osnURL, *removeChannelID, caCertPool, tlsClientCert)
142+
case update.FullCommand():
143+
resp, err = osnadmin.Update(osnURL, marshaledConfigEnvelope, caCertPool, tlsClientCert, *tlsHandshakeTimeShift)
124144
}
125145
if err != nil {
126146
return errorOutput(err), 1, nil
@@ -186,3 +206,24 @@ func validateBlockChannelID(blockBytes []byte, channelID string) error {
186206

187207
return nil
188208
}
209+
210+
func validateEnvelopeChannelID(envelopeBytes []byte, channelID string) error {
211+
envelope := &common.Envelope{}
212+
err := proto.Unmarshal(envelopeBytes, envelope)
213+
if err != nil {
214+
return fmt.Errorf("unmarshalling envelope: %s", err)
215+
}
216+
217+
envelopeChannelID, err := protoutil.GetChannelIDFromEnvelope(envelope)
218+
if err != nil {
219+
return err
220+
}
221+
222+
// quick sanity check that the orderer admin is joining
223+
// the channel they think they're joining.
224+
if channelID != envelopeChannelID {
225+
return fmt.Errorf("specified --channelID %s does not match channel ID %s in config update envelope", channelID, envelopeChannelID)
226+
}
227+
228+
return nil
229+
}

‎cmd/osnadmin/main_test.go‎

Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -532,6 +532,187 @@ var _ = Describe("osnadmin", func() {
532532
})
533533
})
534534

535+
Describe("Update", func() {
536+
var envelopePath string
537+
538+
BeforeEach(func() {
539+
configEnvelope := envelopeUpdateConfigWithGroups("testing123")
540+
envelopePath = createEnvelopeFile(tempDir, configEnvelope)
541+
542+
mockChannelManagement.UpdateChannelReturns(types.ChannelInfo{
543+
Name: "apple",
544+
Height: 123,
545+
}, nil)
546+
})
547+
548+
It("uses the channel participation API to update a channel", func() {
549+
args := []string{
550+
"channel",
551+
"update",
552+
"--orderer-address", ordererURL,
553+
"--channelID", channelID,
554+
"--config-update-envelope", envelopePath,
555+
"--ca-file", ordererCACert,
556+
"--client-cert", clientCert,
557+
"--client-key", clientKey,
558+
}
559+
output, exit, err := executeForArgs(args)
560+
expectedOutput := types.ChannelInfo{
561+
Name: "apple",
562+
URL: "/participation/v1/channels/apple",
563+
Height: 123,
564+
}
565+
checkStatusOutput(output, exit, err, 201, expectedOutput)
566+
})
567+
568+
Context("when the envelope is empty", func() {
569+
BeforeEach(func() {
570+
envelopePath = createEnvelopeFile(tempDir, &cb.Envelope{})
571+
})
572+
573+
It("returns with exit code 1 and prints the error", func() {
574+
args := []string{
575+
"channel",
576+
"update",
577+
"--orderer-address", ordererURL,
578+
"--channelID", channelID,
579+
"--config-update-envelope", envelopePath,
580+
"--ca-file", ordererCACert,
581+
"--client-cert", clientCert,
582+
"--client-key", clientKey,
583+
}
584+
output, exit, err := executeForArgs(args)
585+
586+
checkFlagError(output, exit, err, "failed to retrieve channel id - payload header is empty")
587+
})
588+
})
589+
590+
Context("when the --channelID does not match the channel ID in the envelope", func() {
591+
BeforeEach(func() {
592+
channelID = "not-the-channel-youre-looking-for"
593+
})
594+
595+
It("returns with exit code 1 and prints the error", func() {
596+
args := []string{
597+
"channel",
598+
"update",
599+
"--orderer-address", ordererURL,
600+
"--channelID", channelID,
601+
"--config-update-envelope", envelopePath,
602+
"--ca-file", ordererCACert,
603+
"--client-cert", clientCert,
604+
"--client-key", clientKey,
605+
}
606+
output, exit, err := executeForArgs(args)
607+
608+
checkFlagError(output, exit, err, "specified --channelID not-the-channel-youre-looking-for does not match channel ID testing123 in config update envelope")
609+
})
610+
})
611+
612+
Context("when the envelope isn't a valid config update", func() {
613+
BeforeEach(func() {
614+
envelope := &cb.Envelope{
615+
Payload: protoutil.MarshalOrPanic(&cb.Payload{
616+
Header: &cb.Header{
617+
ChannelHeader: protoutil.MarshalOrPanic(&cb.ChannelHeader{
618+
Type: int32(cb.HeaderType_ENDORSER_TRANSACTION),
619+
ChannelId: channelID,
620+
}),
621+
},
622+
}),
623+
}
624+
envelopePath = createEnvelopeFile(tempDir, envelope)
625+
})
626+
627+
It("returns 405 bad request", func() {
628+
args := []string{
629+
"channel",
630+
"update",
631+
"--orderer-address", ordererURL,
632+
"--channelID", channelID,
633+
"--config-update-envelope", envelopePath,
634+
"--ca-file", ordererCACert,
635+
"--client-cert", clientCert,
636+
"--client-key", clientKey,
637+
}
638+
output, exit, err := executeForArgs(args)
639+
Expect(err).NotTo(HaveOccurred())
640+
Expect(exit).To(Equal(0))
641+
642+
expectedOutput := types.ErrorResponse{
643+
Error: "invalid config update envelope: bad type",
644+
}
645+
checkStatusOutput(output, exit, err, 400, expectedOutput)
646+
})
647+
})
648+
649+
Context("when updating the channel fails", func() {
650+
BeforeEach(func() {
651+
mockChannelManagement.UpdateChannelReturns(types.ChannelInfo{}, types.ErrChannelNotExist)
652+
})
653+
654+
It("returns 405 not allowed", func() {
655+
args := []string{
656+
"channel",
657+
"update",
658+
"--orderer-address", ordererURL,
659+
"--channelID", channelID,
660+
"--config-update-envelope", envelopePath,
661+
"--ca-file", ordererCACert,
662+
"--client-cert", clientCert,
663+
"--client-key", clientKey,
664+
}
665+
output, exit, err := executeForArgs(args)
666+
expectedOutput := types.ErrorResponse{
667+
Error: "cannot update: channel does not exist",
668+
}
669+
checkStatusOutput(output, exit, err, 405, expectedOutput)
670+
})
671+
672+
It("returns 405 not allowed (without status)", func() {
673+
args := []string{
674+
"channel",
675+
"update",
676+
"--orderer-address", ordererURL,
677+
"--channelID", channelID,
678+
"--config-update-envelope", envelopePath,
679+
"--ca-file", ordererCACert,
680+
"--client-cert", clientCert,
681+
"--client-key", clientKey,
682+
"--no-status",
683+
}
684+
output, exit, err := executeForArgs(args)
685+
expectedOutput := types.ErrorResponse{
686+
Error: "cannot update: channel does not exist",
687+
}
688+
checkOutput(output, exit, err, expectedOutput)
689+
})
690+
})
691+
692+
Context("when TLS is disabled", func() {
693+
BeforeEach(func() {
694+
tlsConfig = nil
695+
})
696+
697+
It("uses the channel participation API to join a channel", func() {
698+
args := []string{
699+
"channel",
700+
"update",
701+
"--orderer-address", ordererURL,
702+
"--channelID", channelID,
703+
"--config-update-envelope", envelopePath,
704+
}
705+
output, exit, err := executeForArgs(args)
706+
expectedOutput := types.ChannelInfo{
707+
Name: "apple",
708+
URL: "/participation/v1/channels/apple",
709+
Height: 123,
710+
}
711+
checkStatusOutput(output, exit, err, 201, expectedOutput)
712+
})
713+
})
714+
})
715+
535716
Describe("Flags", func() {
536717
It("accepts short versions of the --orderer-address, --channelID, and --config-block flags", func() {
537718
configBlock := blockWithGroups(
@@ -834,3 +1015,34 @@ func createBlockFile(tempDir string, configBlock *cb.Block) string {
8341015
Expect(err).NotTo(HaveOccurred())
8351016
return blockPath
8361017
}
1018+
1019+
func envelopeUpdateConfigWithGroups(channelID string) *cb.Envelope {
1020+
data := &cb.Envelope{
1021+
Payload: protoutil.MarshalOrPanic(&cb.Payload{
1022+
Data: protoutil.MarshalOrPanic(&cb.ConfigUpdateEnvelope{
1023+
ConfigUpdate: protoutil.MarshalOrPanic(&cb.ConfigUpdate{
1024+
ChannelId: channelID,
1025+
ReadSet: &cb.ConfigGroup{},
1026+
WriteSet: &cb.ConfigGroup{},
1027+
}),
1028+
}),
1029+
Header: &cb.Header{
1030+
ChannelHeader: protoutil.MarshalOrPanic(&cb.ChannelHeader{
1031+
Type: int32(cb.HeaderType_CONFIG_UPDATE),
1032+
ChannelId: channelID,
1033+
}),
1034+
},
1035+
}),
1036+
}
1037+
1038+
return data
1039+
}
1040+
1041+
func createEnvelopeFile(tempDir string, configEnvelope *cb.Envelope) string {
1042+
envelopeBytes, err := proto.Marshal(configEnvelope)
1043+
Expect(err).NotTo(HaveOccurred())
1044+
envelopePath := filepath.Join(tempDir, "envelope.pb")
1045+
err = os.WriteFile(envelopePath, envelopeBytes, 0o644)
1046+
Expect(err).NotTo(HaveOccurred())
1047+
return envelopePath
1048+
}

‎docs/source/commands/osnadminchannel.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@ Subcommands:
5353
5454
channel remove --channelID=CHANNELID
5555
Remove a channel from an Ordering Service Node (OSN).
56+
57+
channel update --channelID=CHANNELID --config-update-envelope=CONFIG-UPDATE-ENVELOPE [<flags>]
58+
Update an Ordering Service Node (OSN) to a channel.
5659
```
5760

5861

@@ -135,6 +138,37 @@ Flags:
135138
-c, --channelID=CHANNELID Channel ID
136139
```
137140

141+
142+
## osnadmin channel update
143+
```
144+
usage: osnadmin channel update --channelID=CHANNELID --config-update-envelope=CONFIG-UPDATE-ENVELOPE [<flags>]
145+
146+
Update an Ordering Service Node (OSN) to a channel.
147+
148+
Flags:
149+
--help Show context-sensitive help (also try
150+
--help-long and --help-man).
151+
-o, --orderer-address=ORDERER-ADDRESS
152+
Admin endpoint of the OSN
153+
--ca-file=CA-FILE Path to file containing PEM-encoded TLS CA
154+
certificate(s) for the OSN
155+
--client-cert=CLIENT-CERT Path to file containing PEM-encoded X509 public
156+
key to use for mutual TLS communication with
157+
the OSN
158+
--client-key=CLIENT-KEY Path to file containing PEM-encoded private key
159+
to use for mutual TLS communication with the
160+
OSN
161+
--no-status Remove the HTTP status message from the command
162+
output
163+
-c, --channelID=CHANNELID Channel ID
164+
-e, --config-update-envelope=CONFIG-UPDATE-ENVELOPE
165+
Path to the file containing an up-to-date
166+
config update envelope for the channel
167+
-t, --tlsHandshakeTimeShift=0 The amount of time to shift backwards for
168+
certificate expiration checks during TLS
169+
handshakes with the orderer endpoint
170+
```
171+
138172
## Example Usage
139173

140174
### osnadmin channel join examples
@@ -220,4 +254,30 @@ Here's an example of the `osnadmin channel remove` command.
220254

221255
Status 204 is returned upon successful removal of a channel.
222256

257+
### osnadmin channel update examples
258+
259+
Here's an example of the `osnadmin channel update` command.
260+
261+
* Update the example of the `my channel` channel defined by the modified config
262+
contained in the `my channel-config-envelope.pb` file.
263+
Use the endpoint of the order administrator
264+
at `order.example.com:9443`.
265+
266+
```
267+
osnadmin channel update -o orderer.example.com:9443 --ca-file $CA_FILE --client-cert $CLIENT_CERT --client-key $CLIENT_KEY --channelID mychannel --config-update-envelope mychannel-genesis-block.pb
268+
269+
Status: 201
270+
{
271+
"name": "mychannel",
272+
"url": "/participation/v1/channels/mychannel",
273+
"consensusRelation": "consenter",
274+
"status": "active",
275+
"height": 1
276+
}
277+
278+
```
279+
280+
Status 201 and the channel details are returned indicating that the channel has been
281+
successfully updated.
282+
223283
<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.

‎docs/wrappers/osnadmin_channel_postscript.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,4 +83,30 @@ Here's an example of the `osnadmin channel remove` command.
8383

8484
Status 204 is returned upon successful removal of a channel.
8585

86+
### osnadmin channel update examples
87+
88+
Here's an example of the `osnadmin channel update` command.
89+
90+
* Update the example of the `my channel` channel defined by the modified config
91+
contained in the `my channel-config-envelope.pb` file.
92+
Use the endpoint of the order administrator
93+
at `order.example.com:9443`.
94+
95+
```
96+
osnadmin channel update -o orderer.example.com:9443 --ca-file $CA_FILE --client-cert $CLIENT_CERT --client-key $CLIENT_KEY --channelID mychannel --config-update-envelope mychannel-genesis-block.pb
97+
98+
Status: 201
99+
{
100+
"name": "mychannel",
101+
"url": "/participation/v1/channels/mychannel",
102+
"consensusRelation": "consenter",
103+
"status": "active",
104+
"height": 1
105+
}
106+
107+
```
108+
109+
Status 201 and the channel details are returned indicating that the channel has been
110+
successfully updated.
111+
86112
<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.

0 commit comments

Comments
 (0)