Repository navigation
Fix: read flags from environment variables, as documented #70
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.
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
Open
briankane
wants to merge
3
commits into
kubevela:main
Choose a base branch
from
briankane:feat/flags-from-env
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| /* | ||
| Copyright 2026 The KubeVela Authors. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package cmd | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "os" | ||
| "strings" | ||
|
|
||
| "github.com/spf13/pflag" | ||
| ) | ||
|
|
||
| // applyEnv sets each flag not given on the command line from its environment | ||
| // variable, so the order is command line, then environment, then default. | ||
| func applyEnv(fs *pflag.FlagSet) error { | ||
| var errs []error | ||
| fs.VisitAll(func(f *pflag.Flag) { | ||
|
cubic-dev-ai[bot] marked this conversation as resolved.
Resolved
|
||
| if f.Changed || f.Name == "help" { | ||
| return | ||
| } | ||
| name := envName(f.Name) | ||
| v, ok := os.LookupEnv(name) | ||
| if !ok { | ||
| return | ||
| } | ||
| if err := fs.Set(f.Name, v); err != nil { | ||
| errs = append(errs, fmt.Errorf("$%s: %w", name, err)) | ||
| } | ||
| }) | ||
| return errors.Join(errs...) | ||
| } | ||
|
|
||
| // envName is a flag's environment variable: its name in capitals, with - as _. | ||
| func envName(flag string) string { | ||
| return strings.ToUpper(strings.ReplaceAll(flag, "-", "_")) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| /* | ||
| Copyright 2026 The KubeVela Authors. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package cmd | ||
|
|
||
| import ( | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/spf13/pflag" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| // parse reads args into a fresh option, then applies the environment. | ||
| func parse(t *testing.T, args ...string) (*option, error) { | ||
| o := newOption() | ||
| fs := pflag.NewFlagSet("kubetrigger", pflag.ContinueOnError) | ||
| addFlags(o, fs) | ||
| require.NoError(t, fs.Parse(args)) | ||
| return o, applyEnv(fs) | ||
| } | ||
|
|
||
| func TestEnvSetsAFlagNotGiven(t *testing.T) { | ||
| t.Setenv("MAX_RETRY", "9") | ||
| o, err := parse(t) | ||
|
briankane marked this conversation as resolved.
Resolved
|
||
| require.NoError(t, err) | ||
| assert.Equal(t, 9, o.MaxRetry) | ||
| } | ||
|
|
||
| func TestFlagBeatsEnv(t *testing.T) { | ||
| t.Setenv("MAX_RETRY", "9") | ||
| o, err := parse(t, "--max-retry=3") | ||
| require.NoError(t, err) | ||
| assert.Equal(t, 3, o.MaxRetry) | ||
| } | ||
|
|
||
| func TestDefaultWithoutEither(t *testing.T) { | ||
| o, err := parse(t) | ||
| require.NoError(t, err) | ||
| assert.Equal(t, defaultMaxRetry, o.MaxRetry) | ||
| } | ||
|
|
||
| func TestEnvNames(t *testing.T) { | ||
| t.Setenv("PER_WORKER_QPS", "7") | ||
| t.Setenv("LEADER_ELECT", "true") | ||
| t.Setenv("LEADER_ELECTION_LEASE_DURATION", "42s") | ||
| o, err := parse(t) | ||
| require.NoError(t, err) | ||
| assert.Equal(t, 7, o.PerWorkerQPS) | ||
| assert.True(t, enableLeaderElection) | ||
| assert.Equal(t, 42*time.Second, leaseDuration) | ||
| } | ||
|
|
||
| func TestBadEnvValueNamesItsVariable(t *testing.T) { | ||
| t.Setenv("MAX_RETRY", "lots") | ||
| _, err := parse(t) | ||
| assert.ErrorContains(t, err, "MAX_RETRY") | ||
| } | ||
|
|
||
| func TestValidationSeesFlagsAndEnv(t *testing.T) { | ||
| t.Setenv("WORKERS", "0") | ||
| c := NewCommand() | ||
| require.NoError(t, c.ParseFlags(nil)) | ||
| assert.ErrorContains(t, c.PreRunE(c, nil), "workers") | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.