feat: add --config flag, an alternative to ZARF_CONFIG env var
#2328
Conversation
✅ Deploy Preview for zarf-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
waveywaves
requested review from
jeff-mccoy,
Racer159,
Noxsios,
lucasrod16 and
AustinAbro321
as code owners
|
Hey @waveywaves sorry for the delay but I would like to get this merged in at some point, I think it's pretty close. Could you merge main into this branch? There are a lot of conflicts but they're all from the new docs site so merging in main and running make docs-and-schema should fix it. Also could you add the following line to the appropriate block in src/cmd/internal.go |
waveywaves
force-pushed
the
en/2178
branch
2 times, most recently
from
5a57bd4
to
1e5f744
Compare
| if !argsConfigPathIsPresent() { | ||
| if cfgFile != "" { | ||
| // Use config file from the flag. | ||
| v.SetConfigFile(cfgFile) | ||
| } else { | ||
| // Search config paths in the current directory and $HOME/.zarf. | ||
| v.AddConfigPath(".") | ||
| v.AddConfigPath("$HOME/.zarf") | ||
| v.SetConfigName("zarf-config") | ||
| } | ||
| } |
There was a problem hiding this comment.
A lot of this block is duplicated directly under this
| func SetViperConfigFilePath(vcfgFilePath string) { | ||
| if vcfgFilePath != "" { | ||
| v.SetConfigFile(config.CommonOptions.ConfigPath) | ||
| vConfigError = v.ReadInConfig() | ||
| } | ||
| } |
There was a problem hiding this comment.
IMO it would be more clear to inline this function
| @@ -570,7 +571,7 @@ $ zarf tools update-creds \ | |||
| --artifact-push-username={USERNAME} --artifact-push-token={PASSWORD} | |||
|
|
|||
| # NOTE: Any credentials omitted from flags without a service key specified will be autogenerated - URLs will only change if specified. | |||
| # Config options can also be set with the 'init' section of a Zarf config file. | |||
| # ConfigPath options can also be set with the 'init' section of a Zarf config file. | |||
There was a problem hiding this comment.
| # ConfigPath options can also be set with the 'init' section of a Zarf config file. |
Let's just delete this comment, it seems that the config it's referring to is not the init file.
|
|
||
| e2e.CleanFiles(path) | ||
|
|
||
| // Test the config file flag | ||
| os.Unsetenv("ZARF_CONFIG") |
There was a problem hiding this comment.
This was originally necessary but can now be deleted. While it won't break anything, each test should not expect environment variables to have been set by other tests.
| @@ -38,15 +44,17 @@ func TestConfigFile(t *testing.T) { | |||
| e2e.CleanFiles(path) | |||
| } | |||
|
|
|||
| func configFileTests(t *testing.T, dir, path string) { | |||
| func configFileTests(t *testing.T, dir, path string, configPath string) { | |||
There was a problem hiding this comment.
A bit of a nit, but I think it would be simpler if the function signature was
func configFileTests(t *testing.T, dir, path string, extraArgs ...string)Then it could be called like below
configFileTests(t, dir, path, "--config-path", configPath)and the args could simply be appended like this
args := append([]string{"package", "create", dir, "--confirm"}, extraArgs...)
AustinAbro321
changed the title
--config flag, an alternative to ZARF_CONFIG env var--config flag, an alternative to ZARF_CONFIG env var
Description
add
--configflag, an alternative toZARF_CONFIGenv varRelated Issue
Fixes #2178
Type of change
Checklist before merging