Skip to content

environment variables and subcommands #904

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 2 commits into from
Jul 9, 2023
Merged

environment variables and subcommands #904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8aae3ae
Do not check environment variables if a subcommand has not been trigg…
phlptp Jul 9, 2023
c2ec0b9
style: pre-commit.ci fixes
pre-commit-ci[bot] Jul 9, 2023
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
8 changes: 6 additions & 2 deletions include/CLI/impl/App_inl.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1061,8 +1061,12 @@ CLI11_INLINE void App::_process_env() {
}

for(App_p &sub : subcommands_) {
if(sub->get_name().empty() || !sub->parse_complete_callback_)
sub->_process_env();
if(sub->get_name().empty() || !sub->parse_complete_callback_) {
if(sub->count_all() > 0) {
// only process environment variables if the callback has actually been triggered already
sub->_process_env();
}
}
}
}

Expand Down
23 changes: 23 additions & 0 deletions tests/SubcommandTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2118,3 +2118,26 @@ TEST_CASE_METHOD(TApp, "DotNotationSubcommandRecusive2", "[subcom]") {
CHECK(extras.size() == 1);
CHECK(extras.front() == "sub1.sub2.sub3.bob");
}

// Reported bug #903 on github
TEST_CASE_METHOD(TApp, "subcommandEnvironmentName", "[subcom]") {
auto *sub1 = app.add_subcommand("sub1");
std::string someFile;
int sub1value{0};
sub1->add_option("-f,--file", someFile)->envname("SOME_FILE")->required()->check(CLI::ExistingFile);
sub1->add_option("-v", sub1value);
auto *sub2 = app.add_subcommand("sub2");
int completelyUnrelatedToSub1 = 0;
sub2->add_option("-v,--value", completelyUnrelatedToSub1)->required();

args = {"sub2", "-v", "111"};
CHECK_NOTHROW(run());

put_env("SOME_FILE", "notafile.txt");

CHECK_NOTHROW(run());

args = {"sub1", "-v", "111"};
CHECK_THROWS_AS(run(), CLI::ValidationError);
unset_env("SOME_FILE");
}