mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
Mathias Fredriksson
c7681370b5
Because the actual flags take quite a bit of space, wrapping at 80 characters creates a very cramped output for e.g. `coder server`, for this reasons, flags are wrapped at 100 chars (vs. standard 80). The `Consumes $ENV_FLAG` message was put on a newline for consistency, this should allow users to learn where to look for the informations. Side note: we should perhaps stop adding period (`.`) at the end of flag descriptions to be consistent, for instance, command helps usually don't have one. This change fixes the biggest issue in #2363, but not all `--help` output is guaranteed (yet) to wrap at 80-100 chars. Fixes #2363
238 lines
7.3 KiB
Go
238 lines
7.3 KiB
Go
package cliflag_test
|
|
|
|
import (
|
|
"fmt"
|
|
"strconv"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/spf13/pflag"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/coder/coder/cli/cliflag"
|
|
"github.com/coder/coder/cryptorand"
|
|
)
|
|
|
|
// Testcliflag cannot run in parallel because it uses t.Setenv.
|
|
//nolint:paralleltest
|
|
func TestCliflag(t *testing.T) {
|
|
t.Run("StringDefault", func(t *testing.T) {
|
|
flagset, name, shorthand, env, usage := randomFlag()
|
|
def, _ := cryptorand.String(10)
|
|
cliflag.String(flagset, name, shorthand, env, def, usage)
|
|
got, err := flagset.GetString(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, def, got)
|
|
require.Contains(t, flagset.FlagUsages(), usage)
|
|
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf("Consumes $%s", env))
|
|
})
|
|
|
|
t.Run("StringEnvVar", func(t *testing.T) {
|
|
flagset, name, shorthand, env, usage := randomFlag()
|
|
envValue, _ := cryptorand.String(10)
|
|
t.Setenv(env, envValue)
|
|
def, _ := cryptorand.String(10)
|
|
cliflag.String(flagset, name, shorthand, env, def, usage)
|
|
got, err := flagset.GetString(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, envValue, got)
|
|
})
|
|
|
|
t.Run("StringVarPDefault", func(t *testing.T) {
|
|
var ptr string
|
|
flagset, name, shorthand, env, usage := randomFlag()
|
|
def, _ := cryptorand.String(10)
|
|
|
|
cliflag.StringVarP(flagset, &ptr, name, shorthand, env, def, usage)
|
|
got, err := flagset.GetString(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, def, got)
|
|
require.Contains(t, flagset.FlagUsages(), usage)
|
|
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf("Consumes $%s", env))
|
|
})
|
|
|
|
t.Run("StringVarPEnvVar", func(t *testing.T) {
|
|
var ptr string
|
|
flagset, name, shorthand, env, usage := randomFlag()
|
|
envValue, _ := cryptorand.String(10)
|
|
t.Setenv(env, envValue)
|
|
def, _ := cryptorand.String(10)
|
|
|
|
cliflag.StringVarP(flagset, &ptr, name, shorthand, env, def, usage)
|
|
got, err := flagset.GetString(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, envValue, got)
|
|
})
|
|
|
|
t.Run("EmptyEnvVar", func(t *testing.T) {
|
|
var ptr string
|
|
flagset, name, shorthand, _, usage := randomFlag()
|
|
def, _ := cryptorand.String(10)
|
|
|
|
cliflag.StringVarP(flagset, &ptr, name, shorthand, "", def, usage)
|
|
got, err := flagset.GetString(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, def, got)
|
|
require.Contains(t, flagset.FlagUsages(), usage)
|
|
require.NotContains(t, flagset.FlagUsages(), "Consumes")
|
|
})
|
|
|
|
t.Run("StringArrayDefault", func(t *testing.T) {
|
|
var ptr []string
|
|
flagset, name, shorthand, env, usage := randomFlag()
|
|
def := []string{"hello"}
|
|
cliflag.StringArrayVarP(flagset, &ptr, name, shorthand, env, def, usage)
|
|
got, err := flagset.GetStringArray(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, def, got)
|
|
})
|
|
|
|
t.Run("StringArrayEnvVar", func(t *testing.T) {
|
|
var ptr []string
|
|
flagset, name, shorthand, env, usage := randomFlag()
|
|
t.Setenv(env, "wow,test")
|
|
cliflag.StringArrayVarP(flagset, &ptr, name, shorthand, env, nil, usage)
|
|
got, err := flagset.GetStringArray(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, []string{"wow", "test"}, got)
|
|
})
|
|
|
|
t.Run("StringArrayEnvVarEmpty", func(t *testing.T) {
|
|
var ptr []string
|
|
flagset, name, shorthand, env, usage := randomFlag()
|
|
t.Setenv(env, "")
|
|
cliflag.StringArrayVarP(flagset, &ptr, name, shorthand, env, nil, usage)
|
|
got, err := flagset.GetStringArray(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, []string{}, got)
|
|
})
|
|
|
|
t.Run("IntDefault", func(t *testing.T) {
|
|
var ptr uint8
|
|
flagset, name, shorthand, env, usage := randomFlag()
|
|
def, _ := cryptorand.Int63n(10)
|
|
|
|
cliflag.Uint8VarP(flagset, &ptr, name, shorthand, env, uint8(def), usage)
|
|
got, err := flagset.GetUint8(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, uint8(def), got)
|
|
require.Contains(t, flagset.FlagUsages(), usage)
|
|
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf("Consumes $%s", env))
|
|
})
|
|
|
|
t.Run("IntEnvVar", func(t *testing.T) {
|
|
var ptr uint8
|
|
flagset, name, shorthand, env, usage := randomFlag()
|
|
envValue, _ := cryptorand.Int63n(10)
|
|
t.Setenv(env, strconv.FormatUint(uint64(envValue), 10))
|
|
def, _ := cryptorand.Int()
|
|
|
|
cliflag.Uint8VarP(flagset, &ptr, name, shorthand, env, uint8(def), usage)
|
|
got, err := flagset.GetUint8(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, uint8(envValue), got)
|
|
})
|
|
|
|
t.Run("IntFailParse", func(t *testing.T) {
|
|
var ptr uint8
|
|
flagset, name, shorthand, env, usage := randomFlag()
|
|
envValue, _ := cryptorand.String(10)
|
|
t.Setenv(env, envValue)
|
|
def, _ := cryptorand.Int63n(10)
|
|
|
|
cliflag.Uint8VarP(flagset, &ptr, name, shorthand, env, uint8(def), usage)
|
|
got, err := flagset.GetUint8(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, uint8(def), got)
|
|
})
|
|
|
|
t.Run("BoolDefault", func(t *testing.T) {
|
|
var ptr bool
|
|
flagset, name, shorthand, env, usage := randomFlag()
|
|
def, _ := cryptorand.Bool()
|
|
|
|
cliflag.BoolVarP(flagset, &ptr, name, shorthand, env, def, usage)
|
|
got, err := flagset.GetBool(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, def, got)
|
|
require.Contains(t, flagset.FlagUsages(), usage)
|
|
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf("Consumes $%s", env))
|
|
})
|
|
|
|
t.Run("BoolEnvVar", func(t *testing.T) {
|
|
var ptr bool
|
|
flagset, name, shorthand, env, usage := randomFlag()
|
|
envValue, _ := cryptorand.Bool()
|
|
t.Setenv(env, strconv.FormatBool(envValue))
|
|
def, _ := cryptorand.Bool()
|
|
|
|
cliflag.BoolVarP(flagset, &ptr, name, shorthand, env, def, usage)
|
|
got, err := flagset.GetBool(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, envValue, got)
|
|
})
|
|
|
|
t.Run("BoolFailParse", func(t *testing.T) {
|
|
var ptr bool
|
|
flagset, name, shorthand, env, usage := randomFlag()
|
|
envValue, _ := cryptorand.String(10)
|
|
t.Setenv(env, envValue)
|
|
def, _ := cryptorand.Bool()
|
|
|
|
cliflag.BoolVarP(flagset, &ptr, name, shorthand, env, def, usage)
|
|
got, err := flagset.GetBool(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, def, got)
|
|
})
|
|
|
|
t.Run("DurationDefault", func(t *testing.T) {
|
|
var ptr time.Duration
|
|
flagset, name, shorthand, env, usage := randomFlag()
|
|
def, _ := cryptorand.Duration()
|
|
|
|
cliflag.DurationVarP(flagset, &ptr, name, shorthand, env, def, usage)
|
|
got, err := flagset.GetDuration(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, def, got)
|
|
require.Contains(t, flagset.FlagUsages(), usage)
|
|
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf("Consumes $%s", env))
|
|
})
|
|
|
|
t.Run("DurationEnvVar", func(t *testing.T) {
|
|
var ptr time.Duration
|
|
flagset, name, shorthand, env, usage := randomFlag()
|
|
envValue, _ := cryptorand.Duration()
|
|
t.Setenv(env, envValue.String())
|
|
def, _ := cryptorand.Duration()
|
|
|
|
cliflag.DurationVarP(flagset, &ptr, name, shorthand, env, def, usage)
|
|
got, err := flagset.GetDuration(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, envValue, got)
|
|
})
|
|
|
|
t.Run("DurationFailParse", func(t *testing.T) {
|
|
var ptr time.Duration
|
|
flagset, name, shorthand, env, usage := randomFlag()
|
|
envValue, _ := cryptorand.String(10)
|
|
t.Setenv(env, envValue)
|
|
def, _ := cryptorand.Duration()
|
|
|
|
cliflag.DurationVarP(flagset, &ptr, name, shorthand, env, def, usage)
|
|
got, err := flagset.GetDuration(name)
|
|
require.NoError(t, err)
|
|
require.Equal(t, def, got)
|
|
})
|
|
}
|
|
|
|
func randomFlag() (*pflag.FlagSet, string, string, string, string) {
|
|
fsname, _ := cryptorand.String(10)
|
|
flagset := pflag.NewFlagSet(fsname, pflag.PanicOnError)
|
|
name, _ := cryptorand.String(10)
|
|
shorthand, _ := cryptorand.String(1)
|
|
env, _ := cryptorand.String(10)
|
|
usage, _ := cryptorand.String(10)
|
|
|
|
return flagset, name, shorthand, env, usage
|
|
}
|