Conf cli #170
Conf cli #170
Conversation
Signed-off-by: Liran Funaro <[email protected]>
Signed-off-by: May Rosenbaum <[email protected]>
cli/main.go
Outdated
| "fmt" | ||
| "github.com/hyperledger-labs/orion-server/pkg/types" | ||
| "io/ioutil" | ||
| "os" | ||
| "path" | ||
| "runtime/debug" | ||
|
|
||
| "github.com/hyperledger-labs/orion-sdk-go/pkg/bcdb" | ||
| "github.com/hyperledger-labs/orion-sdk-go/pkg/config" | ||
| orionconfig "github.com/hyperledger-labs/orion-server/config" | ||
| "github.com/hyperledger-labs/orion-server/pkg/logger" | ||
| "github.com/pkg/errors" | ||
| "github.com/spf13/cobra" | ||
| "github.com/spf13/viper" |
There was a problem hiding this comment.
remove empty lines and do goimports
cli/main.go
Outdated
|
|
||
| func OrionCliInit() *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "Orion-CLI", |
There was a problem hiding this comment.
As mentioned above, it is called bcdbadmin
cli/main.go
Outdated
| // CAs command | ||
| func CAsCmd() *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "CAs", |
There was a problem hiding this comment.
cas - lower case commands
cli/main.go
Outdated
| Short: "manage CA's", | ||
| Args: nil, | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| return nil |
There was a problem hiding this comment.
maybe return errors.New("not implemented yet") in all places that are not implemented.
cli/main.go
Outdated
| cmd.AddCommand(versionCmd()) | ||
| cmd.AddCommand(configCmd()) | ||
| cmd.AddCommand(adminCmd()) | ||
| cmd.AddCommand(nodeCmd()) | ||
| cmd.AddCommand(CAsCmd()) |
cli/main.go
Outdated
| } | ||
|
|
||
| // versionCmd - check what command it is | ||
| func versionCmd() *cobra.Command { |
cli/main.go
Outdated
| } | ||
|
|
||
| // config command | ||
| func configCmd() *cobra.Command { |
There was a problem hiding this comment.
Move the implementation of each command into a file of its own, and test it.
Lets start with
PR1 - version + basic structure, help etc
PR2 - a full implementation of dcdbadmin config get ..." with tests. PR3 - a full implementation of dcdbadmin config set ..." with tests.
There was a problem hiding this comment.
For testing, you can use regular unit tests on the implementation functions, using the approach from examples/cars.
For testing the parsing of flags etc you can use the approach from here
cli/main.go
Outdated
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| err := params.CreateDbAndOpenSession() |
There was a problem hiding this comment.
The implementation of the command should be in a function that receives only what it needs, and is tested separately. see the car example.
Signed-off-by: May Rosenbaum <[email protected]>
Signed-off-by: May Rosenbaum <[email protected]>
Signed-off-by: May Rosenbaum <[email protected]>
cli/README.md
Outdated
| @@ -0,0 +1,44 @@ | |||
| # Config Orion via CLI | |||
|
|
|||
| This command-line tool provides you a simple way to config an orion database server. | |||
There was a problem hiding this comment.
provides you a -> provides a
|
|
||
| This command-line tool provides you a simple way to config an orion database server. | ||
|
|
||
| ## Commands |
There was a problem hiding this comment.
please add a section about building the tool.
cli/commands/config.go
Outdated
| import ( | ||
| "encoding/pem" | ||
| "github.com/hyperledger-labs/orion-sdk-go/pkg/bcdb" | ||
| "github.com/hyperledger-labs/orion-sdk-go/pkg/config" | ||
| orionconfig "github.com/hyperledger-labs/orion-server/config" | ||
| "github.com/hyperledger-labs/orion-server/pkg/logger" | ||
| "github.com/hyperledger-labs/orion-server/pkg/types" | ||
| "github.com/pkg/errors" | ||
| "github.com/spf13/cobra" | ||
| "github.com/spf13/viper" | ||
| "gopkg.in/yaml.v2" | ||
| "io/ioutil" | ||
| "os" | ||
| "path" | ||
| "strconv" | ||
| ) |
cli/main.go
Outdated
| "github.com/hyperledger-labs/orion-sdk-go/cli/commands" | ||
| "os" |
cli/README.md
Outdated
| ##### Flags | ||
| | Flags | Description | | ||
| |-----------------------------|-------------------------------------------------------------------| | ||
| | `-c, --cli-config-path` | the absolute path of CLI connection configuration file | |
cli/commands/node.go
Outdated
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func NodeCmd() *cobra.Command { |
cli/commands/root.go
Outdated
| cmd.AddCommand(VersionCmd()) | ||
| cmd.AddCommand(configCmd()) |
There was a problem hiding this comment.
what about all the rest? either we add it here, or we don't have them at all in this PR. I am ok with adding them and having them return "not implemented"
There was a problem hiding this comment.
In addition, test this like you test the version, make sure it responds to help config etc, but not to command "fake", i.e. testing the usage
cli/commands/config_test.go
Outdated
| require.NoError(t, err) | ||
| err = compareFiles("../testdata/crypto/server/server.pem", "../../configTestRes/nodes/orion-server1.pem") | ||
| require.NoError(t, err) | ||
| err = compareFiles("../testdata/crypto/CA/CA.pem", "../../configTestRes/rootCAs/rootCA0.pem") |
There was a problem hiding this comment.
under testdata add a folder expected-get, and in it put the files you compare against.
this folder should include the a file version.yaml that includes that types.Version you read.
cli/commands/version_test.go
Outdated
|
|
||
| func TestVersionCommand(t *testing.T) { | ||
| // 1. Create BCDBHTTPServer and start server | ||
| testServer, err := SetupTestServer(t) |
There was a problem hiding this comment.
as above...
it leaves artifacts in the repo:
Untracked files:
(use "git add <file>..." to include in what will be committed)
cli/commands/ledger/
cli/commands/tmp/
you need to change the server config to some tmp location and cleanup afterwards, as done in examples
| err = rootCmd.Execute() | ||
| require.NoError(t, err) |
There was a problem hiding this comment.
It is not enough to test that there is no error, you can capture the output and check you get the desired output:
b := &strings.Builder{}
rootCmd.SetOut(b)
err = rootCmd.Execute()
require.NoError(t, err)
fmt.Printf(">>> %s \n", b.String()) // compare to expected
Signed-off-by: May Rosenbaum <[email protected]>
work in progress, last commit includes get config command + version command + tests and a README.md file