Skip to content
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

Add option to configure fly by env #3789

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Add option to configure fly by env #3789

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
707adf0
Add option to configure by env
fliepeltje Jul 27, 2024
9591ece
extend functionality to string/duration type vars
fliepeltje Jul 29, 2024
8c490ea
add first parent to flag lookup
fliepeltje Jul 30, 2024
70702d9
add hierarchical env lookup
fliepeltje Jul 30, 2024
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
102 changes: 78 additions & 24 deletions internal/flag/context.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@ package flag
import (
"context"
"slices"
"strconv"
"strings"
"time"

"github.com/spf13/cobra"
"github.com/spf13/pflag"
"github.com/superfly/flyctl/internal/command_context"
"github.com/superfly/flyctl/internal/env"
"github.com/superfly/flyctl/internal/flag/flagctx"
"github.com/superfly/flyctl/internal/flag/flagnames"
Expand Down Expand Up @@ -38,12 +41,40 @@ func FirstArg(ctx context.Context) string {
return ""
}

func EnvNameFromCmd(cmd *cobra.Command) string {
if cmd.Parent() != nil {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this break existing users of FLY_ORG?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, I broke that elsewhere; this is the "fix", but with a caveat:
FLY_ORG by itself as an env var will do what you expect, but if you for instance do FLY_LAUNCH_ORG, that will get precedence. Some examples:

list apps for org xxx:

FLY_ORG=xxx fly apps list

list apps for org yyy:

FLY_APPS_ORG=yyy fly apps list

list apps for org yyy:

FLY_ORG=xxx FLY_APPS_ORG=yyy fly apps list

varname := EnvNameFromCmd(cmd.Parent()) + "_" + cmd.Name()
return strings.ToUpper(varname)
} else {
return strings.ToUpper(cmd.Name())
}

}

func FromEnv(ctx context.Context, name string) string {
cmd := command_context.FromContext(ctx)
value := ""
for cmd != nil {
var_name := EnvNameFromCmd(cmd) + "_" + strings.ToUpper(name)
var_name = strings.ReplaceAll(var_name, "-", "_")
value = env.First(var_name)
if value == "" {
cmd = cmd.Parent()
} else {
return value
}
}
return value
}

// GetString returns the value of the named string flag ctx carries.
func GetString(ctx context.Context, name string) string {
if v, err := FromContext(ctx).GetString(name); err != nil {
return ""
} else {
if v, err := FromContext(ctx).GetString(name); err == nil && v != "" {
return v
} else if v := FromEnv(ctx, name); v != "" {
return v
} else {
return ""
}
}

Expand All @@ -55,41 +86,57 @@ func SetString(ctx context.Context, name, value string) error {
// GetInt returns the value of the named int flag ctx carries. It panics
// in case ctx carries no flags or in case the named flag isn't an int one.
func GetInt(ctx context.Context, name string) int {
if v, err := FromContext(ctx).GetInt(name); err != nil {
panic(err)
} else {
if v, err := FromContext(ctx).GetInt(name); err == nil {
return v
} else if v := FromEnv(ctx, name); v != "" {
if i, err := strconv.Atoi(v); err == nil {
return i
} else {
panic(err)
}
} else {
panic(err)
}
}

// GetFloat64 returns the value of the named int flag ctx carries. It panics
// in case ctx carries no flags or in case the named flag isn't a float64 one.
func GetFloat64(ctx context.Context, name string) float64 {
if v, err := FromContext(ctx).GetFloat64(name); err != nil {
panic(err)
} else {
if v, err := FromContext(ctx).GetFloat64(name); err == nil {
return v
} else if v := FromEnv(ctx, name); v != "" {
if f, err := strconv.ParseFloat(v, 64); err == nil {
return f
} else {
panic(err)
}
} else {
panic(err)
}
}

// GetStringArray returns the values of the named string flag ctx carries.
// Preserves commas (unlike the following `GetStringSlice`): in `--flag x,y` the value is string[]{`x,y`}.
// This is useful to pass key-value pairs like environment variables or build arguments.
func GetStringArray(ctx context.Context, name string) []string {
if v, err := FromContext(ctx).GetStringArray(name); err != nil {
return []string{}
} else {
if v, err := FromContext(ctx).GetStringArray(name); err == nil {
return v
} else if v := FromEnv(ctx, name); v != "" {
return []string{v}
} else {
return []string{}
}
}

// GetStringSlice returns the values of the named string flag ctx carries.
// Can be comma separated or passed "by repeated flags": `--flag x,y` is equivalent to `--flag x --flag y`.
func GetStringSlice(ctx context.Context, name string) []string {
if v, err := FromContext(ctx).GetStringSlice(name); err != nil {
return []string{}
} else {
if v, err := FromContext(ctx).GetStringSlice(name); err == nil {
return v
} else if v := FromEnv(ctx, name); v != "" {
return strings.Split(v, ",")
} else {
return []string{}
}
}

Expand All @@ -110,20 +157,30 @@ func GetNonEmptyStringSlice(ctx context.Context, name string) []string {

// GetDuration returns the value of the named duration flag ctx carries.
func GetDuration(ctx context.Context, name string) time.Duration {
if v, err := FromContext(ctx).GetDuration(name); err != nil {
return 0
} else {
if v, err := FromContext(ctx).GetDuration(name); err == nil {
return v
} else if v := FromEnv(ctx, name); v != "" {
if d, err := time.ParseDuration(v); err == nil {
return d
} else {
return 0
}
} else {
return 0
}
}

// GetBool returns the value of the named boolean flag ctx carries.
func GetBool(ctx context.Context, name string) bool {
if v, err := FromContext(ctx).GetBool(name); err != nil {
return false
} else {
isSpecified := IsSpecified(ctx, name)
if v, err := FromContext(ctx).GetBool(name); err == nil && isSpecified {
return v
} else if v := FromEnv(ctx, name); v != "" {
if b, err := strconv.ParseBool(v); err == nil {
return b
}
}
return false
}

// IsSpecified returns whether a flag has been specified at all or not.
Expand All @@ -136,9 +193,6 @@ func IsSpecified(ctx context.Context, name string) bool {
// GetOrg is shorthand for GetString(ctx, Org).
func GetOrg(ctx context.Context) string {
org := GetString(ctx, flagnames.Org)
if org == "" {
org = env.First("FLY_ORG")
}
return org
}

Expand Down
Loading