Message ID | d52db89bc2f40a9df5e9fafe4e1bb8c173a7f45f.1618847606.git.ps@pks.im (mailing list archive) |
---|---|
State | Superseded |
Headers | show |
Series | git: support separate arg for `--config-env`'s value | expand |
On Mon, Apr 19 2021, Patrick Steinhardt wrote: > While not documented as such, many of the top-level options like > `--git-dir` and `--work-tree` support two syntaxes: they accept both an > equals sign between option and its value, and they do support option and > value as two separate arguments. The recently added `--config-env` > option only supports the syntax with an equals sign. > > Mitigate this inconsistency by accepting both syntaxes and add tests to > verify both work. > > Signed-off-by: Patrick Steinhardt <ps@pks.im> This whole series LGTM. > git.c | 8 ++++++++ > t/t1300-config.sh | 15 ++++++++++++++- > 2 files changed, 22 insertions(+), 1 deletion(-) > > diff --git a/git.c b/git.c > index b53e665671..ad365c05c7 100644 > --- a/git.c > +++ b/git.c > @@ -255,6 +255,14 @@ static int handle_options(const char ***argv, int *argc, int *envchanged) > git_config_push_parameter((*argv)[1]); > (*argv)++; > (*argc)--; > + } else if (!strcmp(cmd, "--config-env")) { > + if (*argc < 2) { > + fprintf(stderr, _("no config key given for --config-env\n" )); I found this use of fprintf() slightly odd, why not error(), but then went back and read the function and saw that it has N number of "fprintf(stderr, [...])" already. That could probably all be converted to error(), but better to be consistent for now. > + usage(git_usage_string); > + } > + git_config_push_env((*argv)[1]); > + (*argv)++; > + (*argc)--; > } else if (skip_prefix(cmd, "--config-env=", &cmd)) { > git_config_push_env(cmd); > } else if (!strcmp(cmd, "--literal-pathspecs")) { > diff --git a/t/t1300-config.sh b/t/t1300-config.sh > index e0dd5d65ce..18803f9953 100755 > --- a/t/t1300-config.sh > +++ b/t/t1300-config.sh > @@ -1374,16 +1374,29 @@ test_expect_success 'git --config-env=key=envvar support' ' > cat >expect <<-\EOF && > value > value > + value > + value > + false > false > EOF > { > ENVVAR=value git --config-env=core.name=ENVVAR config core.name && > + ENVVAR=value git --config-env core.name=ENVVAR config core.name && > ENVVAR=value git --config-env=foo.CamelCase=ENVVAR config foo.camelcase && > - ENVVAR= git --config-env=foo.flag=ENVVAR config --bool foo.flag > + ENVVAR=value git --config-env foo.CamelCase=ENVVAR config foo.camelcase && > + ENVVAR= git --config-env=foo.flag=ENVVAR config --bool foo.flag && > + ENVVAR= git --config-env foo.flag=ENVVAR config --bool foo.flag > } >actual && > test_cmp expect actual > ' > > +test_expect_success 'git --config-env with missing value' ' > + test_must_fail env ENVVAR=value git --config-env 2>error && > + test_i18ngrep "no config key given for --config-env" error && > + test_must_fail env ENVVAR=value git --config-env config core.name 2>error && > + test_i18ngrep "invalid config format: config" error > +' > + > test_expect_success 'git --config-env fails with invalid parameters' ' > test_must_fail git --config-env=foo.flag config --bool foo.flag 2>error && > test_i18ngrep "invalid config format: foo.flag" error &&
On Mon, Apr 19 2021, Patrick Steinhardt wrote: > +test_expect_success 'git --config-env with missing value' ' > + test_must_fail env ENVVAR=value git --config-env 2>error && > + test_i18ngrep "no config key given for --config-env" error && > + test_must_fail env ENVVAR=value git --config-env config core.name 2>error && > + test_i18ngrep "invalid config format: config" error > +' > + Nit: (not spotted on the first reading): s/test_i18ngrep/grep/. > test_expect_success 'git --config-env fails with invalid parameters' ' > test_must_fail git --config-env=foo.flag config --bool foo.flag 2>error && > test_i18ngrep "invalid config format: foo.flag" error &&
On Tue, Apr 20, 2021 at 12:52:43PM +0200, Ævar Arnfjörð Bjarmason wrote: > > Mitigate this inconsistency by accepting both syntaxes and add tests to > > verify both work. > > > > Signed-off-by: Patrick Steinhardt <ps@pks.im> > > This whole series LGTM. Me too. Thanks for finding it (and Patrick for fixing it). > > + } else if (!strcmp(cmd, "--config-env")) { > > + if (*argc < 2) { > > + fprintf(stderr, _("no config key given for --config-env\n" )); > > > I found this use of fprintf() slightly odd, why not error(), but then > went back and read the function and saw that it has N number of > "fprintf(stderr, [...])" already. > > That could probably all be converted to error(), but better to be > consistent for now. Yep. Likewise the weird extra space at the end of the string. -Peff
diff --git a/git.c b/git.c index b53e665671..ad365c05c7 100644 --- a/git.c +++ b/git.c @@ -255,6 +255,14 @@ static int handle_options(const char ***argv, int *argc, int *envchanged) git_config_push_parameter((*argv)[1]); (*argv)++; (*argc)--; + } else if (!strcmp(cmd, "--config-env")) { + if (*argc < 2) { + fprintf(stderr, _("no config key given for --config-env\n" )); + usage(git_usage_string); + } + git_config_push_env((*argv)[1]); + (*argv)++; + (*argc)--; } else if (skip_prefix(cmd, "--config-env=", &cmd)) { git_config_push_env(cmd); } else if (!strcmp(cmd, "--literal-pathspecs")) { diff --git a/t/t1300-config.sh b/t/t1300-config.sh index e0dd5d65ce..18803f9953 100755 --- a/t/t1300-config.sh +++ b/t/t1300-config.sh @@ -1374,16 +1374,29 @@ test_expect_success 'git --config-env=key=envvar support' ' cat >expect <<-\EOF && value value + value + value + false false EOF { ENVVAR=value git --config-env=core.name=ENVVAR config core.name && + ENVVAR=value git --config-env core.name=ENVVAR config core.name && ENVVAR=value git --config-env=foo.CamelCase=ENVVAR config foo.camelcase && - ENVVAR= git --config-env=foo.flag=ENVVAR config --bool foo.flag + ENVVAR=value git --config-env foo.CamelCase=ENVVAR config foo.camelcase && + ENVVAR= git --config-env=foo.flag=ENVVAR config --bool foo.flag && + ENVVAR= git --config-env foo.flag=ENVVAR config --bool foo.flag } >actual && test_cmp expect actual ' +test_expect_success 'git --config-env with missing value' ' + test_must_fail env ENVVAR=value git --config-env 2>error && + test_i18ngrep "no config key given for --config-env" error && + test_must_fail env ENVVAR=value git --config-env config core.name 2>error && + test_i18ngrep "invalid config format: config" error +' + test_expect_success 'git --config-env fails with invalid parameters' ' test_must_fail git --config-env=foo.flag config --bool foo.flag 2>error && test_i18ngrep "invalid config format: foo.flag" error &&
While not documented as such, many of the top-level options like `--git-dir` and `--work-tree` support two syntaxes: they accept both an equals sign between option and its value, and they do support option and value as two separate arguments. The recently added `--config-env` option only supports the syntax with an equals sign. Mitigate this inconsistency by accepting both syntaxes and add tests to verify both work. Signed-off-by: Patrick Steinhardt <ps@pks.im> --- git.c | 8 ++++++++ t/t1300-config.sh | 15 ++++++++++++++- 2 files changed, 22 insertions(+), 1 deletion(-)