Skip to content

CFE-4699: Fixed reports promise being kept when the report could not be written #6269

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
+27 −14
Open

CFE-4699: Fixed reports promise being kept when the report could not be written #6269

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
29 changes: 22 additions & 7 deletions libpromises/verify_reports.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
#include <actuator.h>

static bool PrintFile(const char *filename, ssize_t max_lines);
static void ReportToFile(const char *logfile, const char *message);
static bool ReportToFile(const char *logfile, const char *message);
static void ReportToLog(const char *message);

PromiseResult VerifyReportPromise(EvalContext *ctx, const Promise *pp)
Expand Down Expand Up @@ -109,16 +109,20 @@ PromiseResult VerifyReportPromise(EvalContext *ctx, const Promise *pp)
return PROMISE_RESULT_WARN;
}

PromiseResult result = PROMISE_RESULT_NOOP;

if (a.report.to_file)
{
ReportToFile(a.report.to_file, pp->promiser);
if (!ReportToFile(a.report.to_file, pp->promiser))
{
result = PromiseResultUpdate(result, PROMISE_RESULT_FAIL);
}
}
else
{
ReportToLog(pp->promiser);
}

PromiseResult result = PROMISE_RESULT_NOOP;
if (a.report.haveprintfile)
{
if (!PrintFile(a.report.filename, a.report.numlines))
Expand All @@ -145,18 +149,29 @@ static void ReportToLog(const char *message)
free(report_message);
}

static void ReportToFile(const char *logfile, const char *message)
static bool ReportToFile(const char *logfile, const char *message)
{
FILE *fp = safe_fopen_create_perms(logfile, "a", CF_PERMS_DEFAULT);
if (!fp)
{
Log(LOG_LEVEL_ERR, "Could not open log file '%s', message '%s'. (fopen: %s)", logfile, message, GetErrorStr());
return false;
}
else

bool reported = (fprintf(fp, "%s\n", message) >= 0);
if (!reported)
{
Log(LOG_LEVEL_ERR, "Could not write to log file '%s', message '%s'. (fprintf: %s)", logfile, message, GetErrorStr());
}

/* The write may still be buffered, so a failed close loses the message too */
if (fclose(fp) != 0)
{
fprintf(fp, "%s\n", message);
fclose(fp);
Log(LOG_LEVEL_ERR, "Could not close log file '%s', message '%s'. (fclose: %s)", logfile, message, GetErrorStr());
reported = false;
}

return reported;
}

static bool PrintFile(const char *filename, ssize_t max_lines)
Expand Down
12 changes: 5 additions & 7 deletions ...14_reports/failed_reports_are_not_kept.cf → ...rts/unsafe/failed_reports_are_not_kept.cf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Check that reports are printed just once (Redmine#3446 https://cfengine.com/dev/issues/3446)
body common control
{
inputs => { "../default.sub.cf" };
inputs => { "../../default.sub.cf" };
bundlesequence => { default("$(this.promise_filename)") };
version => "1.0";
}
Expand All @@ -22,13 +22,11 @@ bundle agent init
bundle agent test
{
meta:
"description"
string => "Test that we do not conisder failure to report to a file a kept outcome";
"description" -> { "CFE-4699", "redmine7833" }
string => "Test that we do not consider failure to report to a file a kept outcome";

# this test should be skipped on platforms that do not have chattr!
"test_soft_fail"
string => "any",
meta => { "redmine7833" };
# The test makes the file immutable with chattr to provoke the failure
"test_skip_unsupported" string => "hpux|aix|solaris|windows";

reports:
"Hello World"
Expand Down
Loading