9ffc305392
This commit cleans up the command constructors in an attempt to make the codebase more uniform and approachable. This includes several refactors: * Removed the FlagConstants - this makes the help messages and examples significantly more readable without needed to compile and run airshipctl * Long help messages and examples are now constant * Short, Long, and Examples all begin with a capitol letter * Flag descriptions begin with a lowercase letter. This matches the flag description for the builtin "help" flag, making formatting uniform for all flags * Removed redundant unit tests on non-leaf commands This change also updates the documentation for the affected commands. Change-Id: I8b9dcbfd9846b3deaab06dec17f80643dae78de9
49 lines
1.3 KiB
Go
49 lines
1.3 KiB
Go
/*
|
|
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 document
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
|
|
"opendev.org/airship/airshipctl/testutil"
|
|
)
|
|
|
|
func TestPlugin(t *testing.T) {
|
|
cmdTests := []*testutil.CmdTest{
|
|
{
|
|
Name: "document-plugin-cmd-with-help",
|
|
CmdLine: "--help",
|
|
Cmd: NewPluginCommand(nil),
|
|
},
|
|
{
|
|
Name: "document-plugin-cmd-with-empty-args",
|
|
CmdLine: "",
|
|
Error: fmt.Errorf("requires at least 1 arg(s), only received 0"),
|
|
Cmd: NewPluginCommand(nil),
|
|
},
|
|
{
|
|
Name: "document-plugin-cmd-with-nonexistent-config",
|
|
CmdLine: "/some/random/path.yaml",
|
|
Error: fmt.Errorf("open /some/random/path.yaml: no such file or directory"),
|
|
Cmd: NewPluginCommand(nil),
|
|
},
|
|
}
|
|
|
|
for _, tt := range cmdTests {
|
|
testutil.RunTest(t, tt)
|
|
}
|
|
}
|