Add Debug Operation #33
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| // Copyright 2023 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| // Package os provides gNOI os operations. | ||
| package debug | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| dbgpb "github.com/openconfig/gnoi/debug" | ||
| "github.com/openconfig/gnoigo/internal" | ||
| ) | ||
|
|
||
| // DebugOperation represents the parameters of a Debug operation. | ||
| // Debug will execute the set of commands provided in the request. | ||
| // The command will be executed in the mode provided. | ||
| // All command modes must support an exit code on completion of the | ||
| // command. (e.g. Cli modes must exit after sending a command) | ||
| // Errors: | ||
| // | ||
| // InvalidArgument: for unspecified mode | ||
| type DebugOperation struct { | ||
| req *dbgpb.DebugRequest | ||
| } | ||
|
|
||
| // Mode the commands will be executed in. | ||
| // | ||
| // enum Mode { | ||
|
There was a problem hiding this comment. Putting the full enum in the comment creates a double-maintenance burden. I'd just let people look it up in the proto. |
||
| // MODE_UNSPECIFIED = 0; | ||
| // MODE_SHELL = 1; | ||
| // MODE_CLI = 2; | ||
| // } | ||
| func (a *DebugOperation) Mode(mode dbgpb.DebugRequest_Mode) *DebugOperation { | ||
| a.req.Mode = mode | ||
| return a | ||
| } | ||
|
|
||
| // Raw bytes for the command to be executed. | ||
| func (a *DebugOperation) Command(command []byte) *DebugOperation { | ||
| a.req.Command = command | ||
| return a | ||
| } | ||
|
|
||
| // Truncate the amount of data returned for the command. | ||
| func (a *DebugOperation) ByteLimit(byteLimit int64) *DebugOperation { | ||
| a.req.ByteLimit = byteLimit | ||
| return a | ||
| } | ||
|
|
||
| // Timeout in nanoseconds. | ||
| func (a *DebugOperation) Timeout(timeout int64) *DebugOperation { | ||
| a.req.Timeout = timeout | ||
| return a | ||
| } | ||
|
|
||
| // Role account to use for the command. | ||
| func (a *DebugOperation) RoleAccount(roleAccount string) *DebugOperation { | ||
| a.req.RoleAccount = roleAccount | ||
| return a | ||
| } | ||
|
|
||
| // NewDebugOperation creates an empty DebugOperation. | ||
| func NewDebugOperation() *DebugOperation { | ||
| return &DebugOperation{req: &dbgpb.DebugRequest{}} | ||
| } | ||
|
|
||
| // Execute performs the Debug operation. | ||
| func (a *DebugOperation) Execute(ctx context.Context, c *internal.Clients) (dbgpb.Debug_DebugClient, error) { | ||
| return c.DEBUG().Debug(ctx, a.req) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,146 +1,18 @@ | ||
| github.com/golang/glog v1.2.3 h1:oDTdz9f5VGVVNGu/Q7UXKWYsD0873HXLHdJUNBsSEKM= | ||
| github.com/golang/glog v1.2.3/go.mod h1:6AhwSGph0fcJtXVM/PEHPqZlFeoLxhs7/t5UDAwmO+w= | ||
| github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= | ||
| github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= | ||
| github.com/openconfig/gnoi v0.5.0 h1:r0cbY1biqAcVLCUjsQjF3UZlU1yZAgbmW24dK0R53MI= | ||
| github.com/openconfig/gnoi v0.5.0/go.mod h1:qjMeFac9SfHyedDWjUU/x4pozK4kvgBngdIO1MwjhCs= | ||
| golang.org/x/net v0.23.0 h1:7EYJ93RZ9vYSZAIb2x3lnuvqO5zneoD6IvWjuhfxjTs= | ||
| golang.org/x/net v0.23.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg= | ||
| golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4= | ||
| golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= | ||
| golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ= | ||
| golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= | ||
| google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237 h1:NnYq6UN9ReLM9/Y01KWNOWyI5xQ9kbIms5GGJVwS/Yc= | ||
| google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237/go.mod h1:WtryC6hu0hhx87FDGxWCDptyssuo68sk10vYjF+T9fY= | ||
| google.golang.org/grpc v1.64.0 h1:KH3VH9y/MgNQg1dE7b3XfVK0GsPSIzJwdF617gUSbvY= | ||
| google.golang.org/grpc v1.64.0/go.mod h1:oxjF8E3FBnjp+/gVFYdWacaLDx9na1aqy9oovLpxQYg= | ||
| google.golang.org/protobuf v1.34.1 h1:9ddQBjfCyZPOHPUiPxpYESBLc+T8P3E+Vo4IbKZgFWg= | ||
| google.golang.org/protobuf v1.34.1/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos= |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2024