Skip to content

chore: Add helper for uniform flags and env vars #588

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 5 commits into from
Mar 28, 2022
Merged

chore: Add helper for uniform flags and env vars #588

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fda02fe
chore: Add helper for uniform flags and env vars
f0ssel Mar 27, 2022
15c9aaa
pr comments
f0ssel Mar 28, 2022
e22539b
pr comments
f0ssel Mar 28, 2022
e95c20d
pr comments
f0ssel Mar 28, 2022
13c71df
pr comments
f0ssel Mar 28, 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
Prev Previous commit
Next Next commit
pr comments
  • Loading branch information
@f0ssel
f0ssel committed Mar 28, 2022
commit e22539bad455615ad34fac343af4f8fcde0614e4
72 changes: 72 additions & 0 deletions cli/cliflag/cliflag.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
// Package cliflags extends flagset with environment variable defaults.
// Helpers will set flags to their default value if the environment variable and flag are unset.
// Helpers inject environment variable into flag usage docs if provided.
//
// Usage:
//
// cliflag.String(root.Flags(), &address, "address", "a", "CODER_ADDRESS", "127.0.0.1:3000", "The address to serve the API and dashboard")
//
// Will produce the following usage docs:
//
// -a, --address string The address to serve the API and dashboard (uses $CODER_ADDRESS). (default "127.0.0.1:3000")
//
package cliflag

import (
"fmt"
"os"
"strconv"

"github.com/spf13/pflag"
)

// StringVarP sets a string flag on the given flag set.
func StringVarP(flagset *pflag.FlagSet, p *string, name string, shorthand string, env string, def string, usage string) {
v, ok := os.LookupEnv(env)
if !ok || v == "" {
v = def
}
flagset.StringVarP(p, name, shorthand, v, fmtUsage(usage, env))
}

// Uint8VarP sets a uint8 flag on the given flag set.
func Uint8VarP(flagset *pflag.FlagSet, ptr *uint8, name string, shorthand string, env string, def uint8, usage string) {
val, ok := os.LookupEnv(env)
if !ok || val == "" {
flagset.Uint8VarP(ptr, name, shorthand, def, fmtUsage(usage, env))
return
}

vi64, err := strconv.ParseUint(val, 10, 8)
if err != nil {
flagset.Uint8VarP(ptr, name, shorthand, def, fmtUsage(usage, env))
return
}

flagset.Uint8VarP(ptr, name, shorthand, uint8(vi64), fmtUsage(usage, env))
}

// BoolVarP sets a bool flag on the given flag set.
func BoolVarP(flagset *pflag.FlagSet, ptr *bool, name string, shorthand string, env string, def bool, usage string) {
val, ok := os.LookupEnv(env)
if !ok || val == "" {
flagset.BoolVarP(ptr, name, shorthand, def, fmtUsage(usage, env))
return
}

valb, err := strconv.ParseBool(val)
if err != nil {
flagset.BoolVarP(ptr, name, shorthand, def, fmtUsage(usage, env))
return
}

flagset.BoolVarP(ptr, name, shorthand, valb, fmtUsage(usage, env))
}

func fmtUsage(u string, env string) string {
if env == "" {
return fmt.Sprintf("%s.", u)
}

return fmt.Sprintf("%s (uses $%s).", u, env)
}
147 changes: 147 additions & 0 deletions cli/cliflag/cliflag_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
package cliflag_test

import (
"fmt"
"strconv"
"testing"

"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) {
var p string
flagset, name, shorthand, env, usage := randomFlag()
def, _ := cryptorand.String(10)

cliflag.StringVarP(flagset, &p, 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("(uses $%s).", env))
})

t.Run("StringEnvVar", func(t *testing.T) {
var p string
flagset, name, shorthand, env, usage := randomFlag()
envValue, _ := cryptorand.String(10)
t.Setenv(env, envValue)
def, _ := cryptorand.String(10)

cliflag.StringVarP(flagset, &p, 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 p string
flagset, name, shorthand, env, usage := randomFlag()
env = ""
def, _ := cryptorand.String(10)

cliflag.StringVarP(flagset, &p, 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.NotContains(t, flagset.FlagUsages(), fmt.Sprintf("(uses $%s).", env))
})

t.Run("IntDefault", func(t *testing.T) {
var p uint8
flagset, name, shorthand, env, usage := randomFlag()
def, _ := cryptorand.Int63n(10)

cliflag.Uint8VarP(flagset, &p, 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("(uses $%s).", env))
})

t.Run("IntEnvVar", func(t *testing.T) {
var p 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, &p, 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 p uint8
flagset, name, shorthand, env, usage := randomFlag()
envValue, _ := cryptorand.String(10)
t.Setenv(env, envValue)
def, _ := cryptorand.Int63n(10)

cliflag.Uint8VarP(flagset, &p, 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 p bool
flagset, name, shorthand, env, usage := randomFlag()
def, _ := cryptorand.Bool()

cliflag.BoolVarP(flagset, &p, 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("(uses $%s).", env))
})

t.Run("BoolEnvVar", func(t *testing.T) {
var p bool
flagset, name, shorthand, env, usage := randomFlag()
envValue, _ := cryptorand.Bool()
t.Setenv(env, strconv.FormatBool(envValue))
def, _ := cryptorand.Bool()

cliflag.BoolVarP(flagset, &p, 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 p bool
flagset, name, shorthand, env, usage := randomFlag()
envValue, _ := cryptorand.String(10)
t.Setenv(env, envValue)
def, _ := cryptorand.Bool()

cliflag.BoolVarP(flagset, &p, name, shorthand, env, def, usage)
got, err := flagset.GetBool(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
}