Emit YAML for events cachemgr report

src/Makefile.am

@@ -2749,7 +2749,6 @@ tests_testEvent_SOURCES = \
 	tests/testEvent.cc
 nodist_tests_testEvent_SOURCES = \
 	MemBuf.cc \
-	tests/stub_SBuf.cc \
 	tests/stub_cache_manager.cc \
 	tests/stub_cbdata.cc \
 	tests/stub_debug.cc \
@@ -2758,6 +2757,7 @@ nodist_tests_testEvent_SOURCES = \
 	tests/stub_libtime.cc \
 	tests/stub_tools.cc
 tests_testEvent_LDADD = \
+	sbuf/libsbuf.la \
 	base/libbase.la \
 	$(LIBCPPUNIT_LIBS) \
 	$(COMPAT_LIB) \

src/event.cc

@@ -9,6 +9,8 @@
 /* DEBUG: section 41    Event Processing */
 
 #include "squid.h"
+#include "base/IoManip.h"
+#include "base/PackableStream.h"
 #include "base/Random.h"
 #include "event.h"
 #include "mgr/Registration.h"
@@ -138,7 +140,8 @@ eventInit(void)
 static void
 eventDump(StoreEntry * sentry)
 {
-    EventScheduler::GetInstance()->dump(sentry);
+    PackableStream yaml(*sentry);
+    EventScheduler::GetInstance()->dump(yaml);
 }
 
 int
@@ -258,21 +261,28 @@ EventScheduler::clean()
 }
 
 void
-EventScheduler::dump(Packable *out)
+EventScheduler::dump(std::ostream &yaml)
 {
+    static const SBuf indent("  ", 2);
+
     if (last_event_ran)
-        out->appendf("Last event to run: %s\n\n", last_event_ran);
+        yaml << "last event: " << last_event_ran << "\n";
 
-    out->appendf("%-25s\t%-15s\t%s\t%s\n",
-                 "Operation",
-                 "Next Execution",
-                 "Weight",
-                 "Callback Valid?");
+    const auto savedFlags = yaml.flags();
 
+    AtMostOnce header("scheduled events:\n");
+    AtMostOnce seconds_comment("# seconds");
     for (auto *e = tasks; e; e = e->next) {
-        out->appendf("%-25s\t%0.3f sec\t%5d\t %s\n",
-                     e->name, (e->when ? e->when - current_dtime : 0), e->weight,
-                     (e->arg && e->cbdata) ? cbdataReferenceValid(e->arg) ? "yes" : "no" : "N/A");
+        yaml << header << indent << "- operation: " << e->name << '\n' <<
+             indent << indent << "next execution in: " << std::setprecision(3) << std::fixed << (e->when ? e->when - current_dtime : 0) << seconds_comment << '\n';
+
+        yaml.flags(savedFlags);
+        yaml << indent << indent << "weight: " << e->weight << '\n';
+
+        if (e->arg && e->cbdata) {
+            yaml << indent << indent << "callback valid: " <<
+                 (cbdataReferenceValid(e->arg) ? "Yes" : "No") << '\n';
+        }
     }
 }
 

src/event.h

@@ -10,9 +10,10 @@
 #define SQUID_SRC_EVENT_H
 
 #include "AsyncEngine.h"
-#include "base/Packable.h"
 #include "mem/forward.h"
 
+#include <iosfwd>
+
 /* event scheduling facilities - run a callback after a given time period. */
 
 typedef void EVH(void *);
@@ -55,7 +56,7 @@ class EventScheduler : public AsyncEngine
     /* either EVENT_IDLE or milliseconds remaining until the next event */
     int timeRemaining() const;
     /* cache manager output for the event queue */
-    void dump(Packable *);
+    void dump(std::ostream &);
     /* find a scheduled event */
     bool find(EVH * func, void * arg);
     /* schedule a callback function to run in when seconds */

src/tests/stub_event.cc

@@ -27,7 +27,7 @@ EventScheduler::~EventScheduler() STUB
 void EventScheduler::cancel(EVH *, void *) STUB
 int EventScheduler::timeRemaining() const STUB_RETVAL(1)
 void EventScheduler::clean() STUB
-void EventScheduler::dump(Packable *) STUB
+void EventScheduler::dump(std::ostream &) STUB
 bool EventScheduler::find(EVH *, void *) STUB_RETVAL(false)
 void EventScheduler::schedule(const char *, EVH *, void *, double, int, bool) STUB
 int EventScheduler::checkEvents(int) STUB_RETVAL(-1)

src/tests/testEvent.cc

@@ -13,6 +13,8 @@
 #include "MemBuf.h"
 #include "unitTestMain.h"
 
+#include <sstream>
+
 /*
  * test the event module.
  */
@@ -83,14 +85,6 @@ TestEvent::testDump()
     EventScheduler scheduler;
     CalledEvent event;
     CalledEvent event2;
-    const char *expected = "Last event to run: last event\n"
-                           "\n"
-                           "Operation                \tNext Execution \tWeight\tCallback Valid?\n"
-                           "test event               \t0.000 sec\t    0\t N/A\n"
-                           "test event2              \t0.000 sec\t    0\t N/A\n";
-    MemBuf expect;
-    expect.init();
-    expect.append(expected, strlen(expected));
 
     scheduler.schedule("last event", CalledEvent::Handler, &event, 0, 0, false);
 
@@ -100,31 +94,19 @@ TestEvent::testDump()
     scheduler.schedule("test event", CalledEvent::Handler, &event, 0, 0, false);
     scheduler.schedule("test event2", CalledEvent::Handler, &event2, 0, 0, false);
 
-    MemBuf result;
-    result.init();
-    scheduler.dump(&result);
-
-    /* loop over the strings, showing exactly where they differ (if at all) */
-    printf("Actual Text:\n");
-    /* TODO: these should really be just [] lookups, but String doesn't have those here yet. */
-    for (size_t i = 0; i < size_t(result.contentSize()); ++i) {
-        CPPUNIT_ASSERT(expect.content()[i]);
-        CPPUNIT_ASSERT(result.content()[i]);
-
-        /* slight hack to make special chars visible */
-        switch (result.content()[i]) {
-        case '\t':
-            printf("\\t");
-            break;
-        default:
-            printf("%c", result.content()[i]);
-        }
-        /* make this an int comparison, so that we can see the ASCII code at failure */
-        CPPUNIT_ASSERT_EQUAL(int(expect.content()[i]), int(result.content()[i]));
-    }
-    printf("\n");
-    CPPUNIT_ASSERT_EQUAL(expect.contentSize(), result.contentSize());
-    CPPUNIT_ASSERT(strcmp(expect.content(), result.content()) == 0);
+    std::ostringstream os;
+    scheduler.dump(os);
+
+    const std::string expected("last event to run: last event\n"
+                               "scheduled events:\n"
+                               "  - operation: test event\n"
+                               "    secs to next execution: 0.000\n"
+                               "    weight: 0\n"
+                               "  - operation: test event2\n"
+                               "    secs to next execution: 0.000\n"
+                               "    weight: 0\n");
+
+    CPPUNIT_ASSERT_EQUAL(expected, os.str());
 }
 
 /* submit two callbacks, and find the right one.