Skip to content

CFE-942: Fixed usemodule() reporting success when the module exited non-zero #6273

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

Open
nickanderson wants to merge 1 commit into
base: master
Choose a base branch
from
+26 −12
Open

CFE-942: Fixed usemodule() reporting success when the module exited non-zero #6273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 13 additions & 5 deletions libpromises/evalfunction.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ static char *StripPatterns(char *file_buffer, const char *pattern, const char *f
static int BuildLineArray(EvalContext *ctx, const Bundle *bundle, const char *array_lval, const char *file_buffer,
const char *split, int maxent, DataType type, bool int_index);
static JsonElement* BuildData(EvalContext *ctx, const char *file_buffer, const char *split, int maxent, bool make_array);
static bool ExecModule(EvalContext *ctx, char *command);
static bool ExecModule(EvalContext *ctx, char *command, int *retcode);

static bool CheckIDChar(const char ch);
static bool CheckID(const char *id);
Expand Down Expand Up @@ -3199,12 +3199,15 @@ static FnCallResult FnCallUseModule(EvalContext *ctx,

Log(LOG_LEVEL_VERBOSE, "Executing and using module [%s]", modulecmd);

if (!ExecModule(ctx, modulecmd))
/* A module which exits non-zero has not told us anything we should act on,
* so the function is false. Not being able to run it at all is a failure. */
int retcode = 0;
if (!ExecModule(ctx, modulecmd, &retcode))
{
return FnFailure();
}

return FnReturnContext(true);
return FnReturnContext(retcode == 0);
}

/*********************************************************************/
Expand Down Expand Up @@ -10083,7 +10086,7 @@ static FnCallResult FnCallFindfilesUp(ARG_UNUSED EvalContext *ctx, ARG_UNUSED co

/*********************************************************************/

static bool ExecModule(EvalContext *ctx, char *command)
static bool ExecModule(EvalContext *ctx, char *command, int *retcode)
{
FILE *pp = cf_popen(command, "rt", true);
if (!pp)
Expand Down Expand Up @@ -10114,7 +10117,7 @@ static bool ExecModule(EvalContext *ctx, char *command)
ModuleProtocol(ctx, command, line, print, context, sizeof(context), tags, &persistence);
}
bool atend = feof(pp);
cf_pclose(pp);
*retcode = cf_pclose(pp);
free(line);
StringSetDestroy(tags);

Expand All @@ -10124,6 +10127,11 @@ static bool ExecModule(EvalContext *ctx, char *command)
return false;
}

if (*retcode != 0)
{
Log(LOG_LEVEL_ERR, "Module '%s' returned non-zero exit code %d", command, *retcode);
}

return true;
}

Expand Down
20 changes: 13 additions & 7 deletions tests/acceptance/02_classes/02_functions/usemodule-returns-nonzero.cf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,37 +43,43 @@ bundle agent test
"description" -> { "CFE-942" }
string => "Test that when a module executed by usemodule() returns nonzero, it's not interpreted as successful";

"test_soft_fail"
string => "any",
meta => { "CFE-942" },
comment => "usemodule seems to return true no matter if the module exists returning 0 or nonzero";
# The modules this test writes are /bin/sh scripts
"test_skip_unsupported" string => "windows";

classes:
# Since the module exits with non zero, we should not get this class
"usemodule_expect_no_class_defined_because_return_nonzero"
expression => usemodule("foo-usemodule", ""),
scope => "namespace",
if => isexecutable("$(sys.workdir)/foo-usemodule");
if => isexecutable("$(sys.workdir)/modules/foo-usemodule");

# Since the module exists non zero, we should get this class
"usemodule_expect_class_defined_because_return_nonzero"
not => usemodule("foo-usemodule", ""),
scope => "namespace",
if => isexecutable("$(sys.workdir)/foo-usemodule");
if => isexecutable("$(sys.workdir)/modules/foo-usemodule");

commands:
"$(sys.workdir)/modules/foo-commands_module"
module => "true",
classes => expected_nonzero_exit,
if => isexecutable($(this.promiser));
}

body classes expected_nonzero_exit
# @brief The module here exits non-zero on purpose, so don't fail the promise
# over it and take the whole test bundle down with it
{
kept_returncodes => { "1" };
}

bundle agent check
{
methods:
usemodule_expect_no_class_defined_because_return_nonzero.!usemodule_expect_class_defined_because_return_nonzero::
"FAIL" usebundle => dcs_fail($(this.promise_filename));

!usemodule_expect_class_defined_because_return_nonzero.usemodule_expect_class_defined_because_return_nonzero::
!usemodule_expect_no_class_defined_because_return_nonzero.usemodule_expect_class_defined_because_return_nonzero::
"Pass" usebundle => dcs_pass($(this.promise_filename));

reports:
Expand Down
Loading