Properly handle promise locking with edit line

Fixed bug causing rendered files can result in erroneously empty files
as a result of promise locking.

Ticket: ENT-9980
Changelog: Commit
Signed-off-by: Lars Erik Wik <[email protected]>

Author: larsewi

cf-agent/files_edit.c

@@ -103,9 +103,9 @@ EditContext *NewEditContext(char *filename, const Attributes *a)
 /*****************************************************************************/
 
 void FinishEditContext(EvalContext *ctx, EditContext *ec, const Attributes *a, const Promise *pp,
-                       PromiseResult *result)
+                       PromiseResult *result, bool save_file)
 {
-    if ((*result != PROMISE_RESULT_NOOP) && (*result != PROMISE_RESULT_CHANGE))
+    if (!save_file || ((*result != PROMISE_RESULT_NOOP) && (*result != PROMISE_RESULT_CHANGE)))
     {
         // Failure or skipped. Don't update the file.
         goto end;

cf-agent/files_edit.h

@@ -57,7 +57,7 @@ typedef struct
 EditContext *NewEditContext(char *filename, const Attributes *a);
 void FinishEditContext(EvalContext *ctx, EditContext *ec,
                        const Attributes *a, const Promise *pp,
-                       PromiseResult *result);
+                       PromiseResult *result, bool save_file);
 
 #ifdef HAVE_LIBXML2
 bool LoadFileAsXmlDoc(xmlDocPtr *doc, const char *file, EditDefaults ed, bool only_checks);

cf-agent/verify_files.c

@@ -729,7 +729,8 @@ static PromiseResult RenderTemplateCFEngine(EvalContext *ctx,
                                             const Rlist *bundle_args,
                                             const Attributes *attr,
                                             EditContext *edcontext,
-                                            bool file_exists)
+                                            bool file_exists,
+                                            bool *save_file)
 {
     assert(edcontext != NULL);
     assert(attr != NULL);
@@ -754,7 +755,7 @@ static PromiseResult RenderTemplateCFEngine(EvalContext *ctx,
         EvalContextStackPushBundleFrame(ctx, bp, bundle_args, a.edits.inherit);
         BundleResolve(ctx, bp);
 
-        ScheduleEditLineOperations(ctx, bp, &a, pp, edcontext);
+        *save_file = ScheduleEditLineOperations(ctx, bp, &a, pp, edcontext);
 
         EvalContextStackPopFrame(ctx);
 
@@ -1057,6 +1058,7 @@ PromiseResult ScheduleEditOperation(EvalContext *ctx, char *filename,
         }
     }
 
+    bool save_file = true;
     if (strcmp("cfengine", a->template_method) == 0)
     {
         if (a->edit_template)
@@ -1067,7 +1069,8 @@ PromiseResult ScheduleEditOperation(EvalContext *ctx, char *filename,
             PromiseResult render_result = RenderTemplateCFEngine(ctx, pp,
                                                                  args, a,
                                                                  edcontext,
-                                                                 file_exists);
+                                                                 file_exists,
+                                                                 &save_file);
             result = PromiseResultUpdate(result, render_result);
         }
     }
@@ -1099,7 +1102,7 @@ PromiseResult ScheduleEditOperation(EvalContext *ctx, char *filename,
     }
 
 exit:
-    FinishEditContext(ctx, edcontext, a, pp, &result);
+    FinishEditContext(ctx, edcontext, a, pp, &result, save_file);
     YieldCurrentLock(thislock);
     if (result == PROMISE_RESULT_CHANGE)
     {