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 e95c20d20ef5521f9fa4089e872ec69dc8e179fa
4 changes: 1 addition & 3 deletions cli/cliflag/cliflag.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
// 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:
//
Expand Down Expand Up @@ -68,5 +66,5 @@ func fmtUsage(u string, env string) string {
return fmt.Sprintf("%s.", u)
}

return fmt.Sprintf("%s (uses $%s).", u, env)
return fmt.Sprintf("%s - consumes $%s.", u, env)
}
14 changes: 6 additions & 8 deletions cli/cliflag/cliflag_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ import (
// 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()
Expand All @@ -26,7 +25,7 @@ func TestCliflag(t *testing.T) {
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))
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf(" - consumes $%s", env))
})

t.Run("StringEnvVar", func(t *testing.T) {
Expand All @@ -44,16 +43,15 @@ func TestCliflag(t *testing.T) {

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

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

t.Run("IntDefault", func(t *testing.T) {
Expand All @@ -66,7 +64,7 @@ func TestCliflag(t *testing.T) {
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))
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf(" - consumes $%s", env))
})

t.Run("IntEnvVar", func(t *testing.T) {
Expand Down Expand Up @@ -105,7 +103,7 @@ func TestCliflag(t *testing.T) {
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))
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf(" - consumes $%s", env))
})

t.Run("BoolEnvVar", func(t *testing.T) {
Expand Down