ENT-14731: Added tests for cf-reactor

cf-agent/files_edit.h

@@ -41,6 +41,11 @@
                                    copy equal to the copied template file - not the
                                    copied + edited file. */
 
+/* The ifelapsed of the promises of edit bundles: CF_EDIT_IFELAPSED, unless the
+ * default ifelapsed is lower, e.g. 0 for the bundles cf-reactor runs on events,
+ * which may happen less than a minute apart */
+#define EDIT_IFELAPSED MIN(CF_EDIT_IFELAPSED, VIFELAPSED)
+
 typedef struct
 {
     char *filename;

cf-agent/files_editline.c

@@ -373,7 +373,7 @@ static PromiseResult VerifyLineDeletions(EvalContext *ctx, const Promise *pp, Ed
     char lockname[CF_BUFSIZE];
 
     Attributes a = GetDeletionAttributes(ctx, pp);
-    a.transaction.ifelapsed = CF_EDIT_IFELAPSED;
+    a.transaction.ifelapsed = EDIT_IFELAPSED;
 
     if (!SanityCheckDeletions(&a, pp))
     {
@@ -453,7 +453,7 @@ static PromiseResult VerifyColumnEdits(EvalContext *ctx, const Promise *pp, Edit
     char lockname[CF_BUFSIZE];
 
     Attributes a = GetColumnAttributes(ctx, pp);
-    a.transaction.ifelapsed = CF_EDIT_IFELAPSED;
+    a.transaction.ifelapsed = EDIT_IFELAPSED;
 
     if (a.column.column_separator == NULL)
     {
@@ -547,7 +547,7 @@ static PromiseResult VerifyPatterns(EvalContext *ctx, const Promise *pp, EditCon
 /* Are we working in a restricted region? */
 
     Attributes a = GetReplaceAttributes(ctx, pp);
-    a.transaction.ifelapsed = CF_EDIT_IFELAPSED;
+    a.transaction.ifelapsed = EDIT_IFELAPSED;
 
     if (!a.replace.replace_value)
     {
@@ -733,7 +733,7 @@ static PromiseResult VerifyLineInsertions(EvalContext *ctx, const Promise *pp, E
 
     Attributes a = GetInsertionAttributes(ctx, pp);
     int allow_multi_lines = StringEqual(a.sourcetype, "preserve_all_lines");
-    a.transaction.ifelapsed = CF_EDIT_IFELAPSED;
+    a.transaction.ifelapsed = EDIT_IFELAPSED;
 
     if (!SanityCheckInsertions(&a))
     {

cf-agent/files_editxml.c

@@ -353,7 +353,7 @@ static bool VerifyXPathBuild(EvalContext *ctx, const Attributes *attr, const Pro
     CfLock thislock;
     char lockname[CF_BUFSIZE], rawxpath[CF_BUFSIZE] = { 0 };
 
-    a.transaction.ifelapsed = CF_EDIT_IFELAPSED;
+    a.transaction.ifelapsed = EDIT_IFELAPSED;
 
     int ret = snprintf(rawxpath, sizeof(rawxpath), "%s",
         a.xml.havebuildxpath ? a.xml.build_xpath : pp->promiser);
@@ -417,7 +417,7 @@ static PromiseResult VerifyTreeDeletions(EvalContext *ctx, const Attributes *att
     CfLock thislock;
     char lockname[CF_BUFSIZE];
 
-    a.transaction.ifelapsed = CF_EDIT_IFELAPSED;
+    a.transaction.ifelapsed = EDIT_IFELAPSED;
 
     if (!SanityCheckTreeDeletions(&a))
     {
@@ -497,7 +497,7 @@ static PromiseResult VerifyTreeInsertions(EvalContext *ctx, const Attributes *at
     CfLock thislock;
     char lockname[CF_BUFSIZE];
 
-    a.transaction.ifelapsed = CF_EDIT_IFELAPSED;
+    a.transaction.ifelapsed = EDIT_IFELAPSED;
 
     PromiseResult result = PROMISE_RESULT_NOOP;
     if (!SanityCheckTreeInsertions(&a, edcontext))
@@ -590,7 +590,7 @@ static PromiseResult VerifyAttributeDeletions(EvalContext *ctx, const Attributes
     CfLock thislock;
     char lockname[CF_BUFSIZE];
 
-    a.transaction.ifelapsed = CF_EDIT_IFELAPSED;
+    a.transaction.ifelapsed = EDIT_IFELAPSED;
 
     PromiseResult result = PROMISE_RESULT_NOOP;
     if (!SanityCheckAttributeDeletions(&a))
@@ -673,7 +673,7 @@ static PromiseResult VerifyAttributeSet(EvalContext *ctx, const Attributes *attr
     CfLock thislock;
     char lockname[CF_BUFSIZE];
 
-    a.transaction.ifelapsed = CF_EDIT_IFELAPSED;
+    a.transaction.ifelapsed = EDIT_IFELAPSED;
 
     PromiseResult result = PROMISE_RESULT_NOOP;
     if (!SanityCheckAttributeSet(&a))
@@ -756,7 +756,7 @@ static PromiseResult VerifyTextDeletions(EvalContext *ctx, const Attributes *att
     CfLock thislock;
     char lockname[CF_BUFSIZE];
 
-    a.transaction.ifelapsed = CF_EDIT_IFELAPSED;
+    a.transaction.ifelapsed = EDIT_IFELAPSED;
 
     PromiseResult result = PROMISE_RESULT_NOOP;
     if (!SanityCheckTextDeletions(&a))
@@ -839,7 +839,7 @@ static PromiseResult VerifyTextSet(EvalContext *ctx, const Attributes *attr, con
     CfLock thislock;
     char lockname[CF_BUFSIZE];
 
-    a.transaction.ifelapsed = CF_EDIT_IFELAPSED;
+    a.transaction.ifelapsed = EDIT_IFELAPSED;
 
     PromiseResult result = PROMISE_RESULT_NOOP;
     if (!SanityCheckTextSet(&a))
@@ -922,7 +922,7 @@ static PromiseResult VerifyTextInsertions(EvalContext *ctx, const Attributes *at
     CfLock thislock;
     char lockname[CF_BUFSIZE];
 
-    a.transaction.ifelapsed = CF_EDIT_IFELAPSED;
+    a.transaction.ifelapsed = EDIT_IFELAPSED;
 
     PromiseResult result = PROMISE_RESULT_NOOP;
     if (!SanityCheckTextInsertions(&a))

cf-reactor/reactor_transform.c

@@ -505,7 +505,25 @@ static PromiseResult KeepEventsPromiseOnEvent(EvalContext *ctx, const Promise *p
         return PROMISE_RESULT_SKIPPED;
     }
 
-    return RunThenBundles(ctx, pp);
+    PromiseResult result;
+    switch (event->check)
+    {
+    case WATCHER_CHECK_EVENT:
+        result = RunThenBundles(ctx, pp);
+        break;
+
+    case WATCHER_CHECK_ERROR:
+        /* Already logged as an error by the watcher, see HandleQueuedEvents() */
+        result = PROMISE_RESULT_FAIL;
+        break;
+
+    default:
+        ProgrammingError("Unexpected watcher check result %d for reactor events promise '%s'",
+                         (int) event->check, pp->promiser);
+    }
+
+    RecordEventsPromiseOutcome(ctx, pp, result);
+    return result;
 }
 
 void HandleReactorEvent(EvalContext *ctx, const Promise *pp, const char *promise_hash, WatcherCheckResult check)

cf-reactor/watcher.c

@@ -299,7 +299,9 @@ bool EventWatcherInitialize(int *fd)
 
     *fd = WakeupChannelReadFd(&wakeup_channel);
 
-    Log(LOG_LEVEL_VERBOSE, "Started cf-reactor event watcher with %zu watcher(s)", MapSize(watchers));
+    /* No watchers yet, they are registered from the policy afterwards and
+     * counted by EventWatcherWakeUp() */
+    Log(LOG_LEVEL_VERBOSE, "Started cf-reactor event watcher");
     return true;
 }
 
@@ -395,6 +397,12 @@ void EventWatcherResume(void)
 
 void EventWatcherWakeUp(void)
 {
+    /* Called once the watchers of the (re-)read policy are registered */
+    ThreadLock(&watchers_mutex);
+    const size_t count = MapSize(watchers);
+    ThreadUnlock(&watchers_mutex);
+    Log(LOG_LEVEL_VERBOSE, "cf-reactor event watcher has %zu watcher(s)", count);
+
     if (watcher_thread != NULL)
     {
         StoppableThreadWake(watcher_thread);

cf-reactor/watcher.h

@@ -132,7 +132,8 @@ void EventWatcherResume(void);
  * immediately. Without watchers, the watcher thread sleeps until woken up, so
  * this must be called after registering watchers outside of an
  * EventWatcherPause()/EventWatcherResume() pair (which wakes it up itself),
- * i.e. after the watchers of the initial policy.
+ * i.e. after the watchers of the initial policy. Logs the number of
+ * registered watchers.
  */
 void EventWatcherWakeUp(void);
 void EventWatcherFinalize(void);

libpromises/cf3parse_logic.h

@@ -230,11 +230,13 @@ static bool RelevantBundle(const char *agent, const char *blocktype)
         return true;
     }
 
-    /* Here are some additional bundle types handled by cfAgent */
+    /* Here are some additional bundle types handled by cfAgent, and by
+     * cf-reactor for the agent bundles it runs */
 
     Item *ip = SplitString("edit_line,edit_xml", ',');
 
-    if (strcmp(agent, CF_AGENTTYPES[AGENT_TYPE_AGENT]) == 0)
+    if (StringEqual(agent, CF_AGENTTYPES[AGENT_TYPE_AGENT]) ||
+        StringEqual(agent, CF_AGENTTYPES[AGENT_TYPE_REACTOR]))
     {
         if (IsItemIn(ip, blocktype))
         {

tests/reactor/lib.cf

@@ -5,3 +5,28 @@ bundle agent record_event(file, message)
       with => strftime("localtime", "%Y-%m-%d %H:%M:%S", now()),
       report_to_file => "$(file)";
 }
+
+# Defines a class for the outcome of the promise it is used on:
+# <prefix>_kept, <prefix>_repaired or <prefix>_failed
+body classes then_outcome(prefix)
+{
+  promise_kept => { "$(prefix)_kept" };
+  promise_repaired => { "$(prefix)_repaired" };
+  repair_failed => { "$(prefix)_failed" };
+  repair_denied => { "$(prefix)_failed" };
+  repair_timeout => { "$(prefix)_failed" };
+}
+
+# Records "<prefix> <outcome>" for the outcome classes of then_outcome(prefix)
+# defined so far. Nothing is recorded if the promise was not evaluated (e.g.
+# skipped because of a lock).
+bundle agent record_then_outcome(file, prefix)
+{
+  vars:
+    "outcomes" slist => { "kept", "repaired", "failed" };
+
+  methods:
+    "$(prefix)_$(outcomes)"
+      if => "$(prefix)_$(outcomes)",
+      usebundle => record_event("$(file)", "$(prefix) $(outcomes)");
+}

tests/reactor/lib.sh

@@ -19,6 +19,21 @@ wait_for_log() {
     log_offset=$((log_offset + ${match%%:*}))
 }
 
+# Wait until cf-reactor has registered the watchers of the policy, $1 of them.
+# The watcher thread may log before this line, so search the whole log and
+# leave the offset of wait_for_log as is.
+wait_for_watchers() {
+    if ! timeout 60 sh -c '
+        until grep -q -F -- "$2" "$1"; do
+            sleep 0.1
+        done' _ "$LOG" "verbose: cf-reactor event watcher has $1 watcher(s)"
+    then
+        echo "Timed out waiting for $1 watcher(s) in reactor log:" >&2
+        cat "$LOG" >&2
+        return 1
+    fi
+}
+
 # Wait until file $1 has at least $2 lines, then fail if it has more than $2.
 wait_for_lines() {
     if ! timeout 60 sh -c '
@@ -39,6 +54,18 @@ wait_for_lines() {
     fi
 }
 
+# Fail unless line $2 of file $1, without the timestamp written by
+# record_event, is $3.
+check_event() {
+    line=$(sed -n "$2p" "$1" | cut -d' ' -f3-)
+    if [ "$line" != "$3" ]
+    then
+        echo "Expected line $2 of '$1' to be '$3', got '$line':" >&2
+        cat "$1" >&2
+        return 1
+    fi
+}
+
 # Start cf-reactor in the background with policy file $1, logging to $LOG.
 # It is stopped when the test exits.
 start_reactor() {

tests/reactor/run.sh

@@ -3,7 +3,7 @@
 fail=0
 
 banner() {
-    name=" $(basename "$1") "
+    name=" $(basename "$(dirname "$1")")/$(basename "$1") "
     width=72
     left=$(( (width - ${#name}) / 2 ))
     right=$(( width - ${#name} - left ))
@@ -23,7 +23,7 @@ error() {
 CF_BINDIR=${CF_BINDIR:-/var/cfengine/bin}
 export CF_BINDIR
 
-for t in "$PWD"/tests/*.sh; do
+for t in "$PWD"/tests/*/*.sh; do
     banner "$t"
 
     # create throwaway work dir

tests/reactor/tests/00_basics/001_vars.cf

@@ -0,0 +1,29 @@
+#######################################################
+#
+# Test vars promises in reactor bundle
+#
+#######################################################
+body common control
+{
+  inputs => { "../../lib.cf" };
+  bundlesequence => { "test" };
+  version => "1.0";
+}
+
+body when deleted(file)
+{
+  file_deleted => "$(file)";
+}
+
+bundle reactor test
+{
+  vars:
+    "test" string => getenv("TESTFILE", 999);
+    "events_file" string => getenv("EVENTS_FILE", 999);
+    "promise_name" string => basename("$(this.promise_filename)", ".cf");
+
+  events:
+    "$(promise_name)"
+      when => deleted("$(test)"),
+      then => record_event("$(events_file)", "$(test) was deleted");
+}

tests/reactor/tests/001_vars.sh → tests/reactor/tests/00_basics/001_vars.sh

@@ -2,7 +2,7 @@
 
 set -ex
 
-. "$(dirname "$0")/../lib.sh"
+. "$(dirname "$0")/../../lib.sh"
 
 TESTFILE="$WORKDIR/tmp/test"
 EVENTS_FILE="$WORKDIR/tmp/events"

tests/reactor/tests/00_basics/002_classes.cf

@@ -0,0 +1,38 @@
+#######################################################
+#
+# Test classes promises in reactor bundle
+#
+#######################################################
+body common control
+{
+  inputs => { "../../lib.cf" };
+  bundlesequence => { "test" };
+  version => "1.0";
+}
+
+body when deleted(file)
+{
+  file_deleted => "$(file)";
+}
+
+bundle reactor test
+{
+  vars:
+    "test" string => getenv("TESTFILE", 999);
+    "events_file" string => getenv("EVENTS_FILE", 999);
+    "promise_name" string => basename("$(this.promise_filename)", ".cf");
+
+  classes:
+    "true" expression => "true";
+
+  events:
+    true::
+      "$(promise_name)"
+        when => deleted("$(test)"),
+        then => record_event("$(events_file)", "$(test) was deleted");
+
+    false::
+      "$(promise_name)_2"
+        when => deleted("$(test)"),
+        then => record_event("$(events_file)", "$(test) was deleted");
+}

tests/reactor/tests/00_basics/002_classes.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+
+set -ex
+
+. "$(dirname "$0")/../../lib.sh"
+
+TESTFILE="$WORKDIR/tmp/test"
+EVENTS_FILE="$WORKDIR/tmp/events"
+export TESTFILE EVENTS_FILE
+
+# create initial file
+touch "$TESTFILE"
+
+start_reactor "$1"
+
+wait_for_watchers 1
+
+wait_for_log "File '$TESTFILE' is present, watching for its deletion"
+rm "$TESTFILE"
+wait_for_lines "$EVENTS_FILE" 1
+
+# recreate the file and wait for the watcher to see it before deleting it again
+touch "$TESTFILE"
+wait_for_log "File '$TESTFILE' is present, watching for its deletion"
+rm "$TESTFILE"
+wait_for_lines "$EVENTS_FILE" 2