8000 chore: `version` sub command remove `--version` and `-v` flag by Emyrk · Pull Request #2090 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

chore: version sub command remove --version and -v flag #2090

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 6, 2022
Merged

chore: version sub command remove --version and -v flag #2090

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1c0cf42
feat: Reserve "-v" on root. Add "version" subcommand
Emyrk Jun 6, 2022
bec0e88
test: Add unit test for version cmd
Emyrk Jun 6, 2022
ae779c6
Fix test
Emyrk Jun 6, 2022
b509594
Only support 'coder version'
Emyrk Jun 6, 2022
273ad88
rename test
Emyrk Jun 6, 2022
5a6b0f2
Linter
Emyrk Jun 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 22 additions & 13 deletions cli/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ func init() {
func Root() *cobra.Command {
cmd := &cobra.Command{
Use: "coder",
Version: buildinfo.Version(),
SilenceErrors: true,
SilenceUsage: true,
Long: `Coder — A tool for provisioning self-hosted development environments.
Expand Down Expand Up @@ -90,10 +89,10 @@ func Root() *cobra.Command {
users(),
portForward(),
workspaceAgent(),
versionCmd(),
)

cmd.SetUsageTemplate(usageTemplate())
cmd.SetVersionTemplate(versionTemplate())

cmd.PersistentFlags().String(varURL, "", "Specify the URL to your deployment.")
cmd.PersistentFlags().String(varToken, "", "Specify an authentication token.")
Expand All @@ -110,6 +109,27 @@ func Root() *cobra.Command {
return cmd
}

// versionCmd prints the coder version
func versionCmd() *cobra.Command {
return &cobra.Command{
Use: "version",
Short: "Show coder version",
Example: "coder version",
RunE: func(cmd *cobra.Command, args []string) error {
var str strings.Builder
_, _ = str.WriteString(fmt.Sprintf("Coder %s", buildinfo.Version()))
buildTime, valid := buildinfo.Time()
if valid {
_, _ = str.WriteString(" " + buildTime.Format(time.UnixDate))
}
_, _ = str.WriteString("\r\n" + buildinfo.ExternalURL() + "\r\n")

_, _ = fmt.Fprint(cmd.OutOrStdout(), str.String())
return nil
},
}
}

// createClient returns a new client from the command context.
// It reads from global configuration files if flags are not set.
func createClient(cmd *cobra.Command) (*codersdk.Client, error) {
Expand Down Expand Up @@ -286,17 +306,6 @@ Use "{{.CommandPath}} [command] --help" for more information about a command.
{{end}}`
}

func versionTemplate() string {
template := `Coder {{printf "%s" .Version}}`
buildTime, valid := buildinfo.Time()
if valid {
template += " " + buildTime.Format(time.UnixDate)
}
template += "\r\n" + buildinfo.ExternalURL()
template += "\r\n"
return template
}

// FormatCobraError colorizes and adds "--help" docs to cobra commands.
func FormatCobraError(err error, cmd *cobra.Command) string {
helpErrMsg := fmt.Sprintf("Run '%s --help' for usage.", cmd.CommandPath())
Expand Down
17 changes: 17 additions & 0 deletions cli/root_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
package cli_test

import (
"bytes"
"testing"

"github.com/coder/coder/buildinfo"

"github.com/stretchr/testify/require"

"github.com/coder/coder/cli"
Expand All @@ -19,4 +22,18 @@ func TestRoot(t *testing.T) {
errStr := cli.FormatCobraError(err, cmd)
require.Contains(t, errStr, "Run 'coder delete --help' for usage.")
})

t.Run("Version", func(t *testing.T) {
t.Parallel()

buf := new(bytes.Buffer)
cmd, _ := clitest.New(t, "version")
cmd.SetOut(buf)
err := cmd.Execute()
require.NoError(t, err)

output := buf.String()
require.Contains(t, output, buildinfo.Version(), "has version")
require.Contains(t, output, buildinfo.ExternalURL(), "has url")
})
}
0