Sort streams in "-B help" output, and match case-insensitively throug…

src/DebugLogger.cc

@@ -22,8 +22,9 @@ DebugLogger::Stream DebugLogger::streams[NUM_DBGS] =
      {"scripts", 0, false},   {"supervisor", 0, false}, {"hashkey", 0, false},         {"spicy", 0, false}};
 
 DebugLogger::DebugLogger() {
-    verbose = false;
     file = nullptr;
+    verbose = false;
+    all = false;
 }
 
 DebugLogger::~DebugLogger() {
@@ -53,21 +54,28 @@ void DebugLogger::OpenDebugLog(const char* filename) {
 }
 
 void DebugLogger::ShowStreamsHelp() {
-    fprintf(stderr, "\n");
     fprintf(stderr, "Enable debug output into debug.log with -B <streams>.\n");
-    fprintf(stderr, "<streams> is a comma-separated list of streams to enable.\n");
+    fprintf(stderr, "<streams> is a case-insensitive, comma-separated list of streams to enable:\n");
     fprintf(stderr, "\n");
-    fprintf(stderr, "Available streams:\n");
 
-    for ( int i = 0; i < NUM_DBGS; ++i )
-        fprintf(stderr, "  %s\n", streams[i].prefix);
+    std::vector<std::string> prefixes;
 
+    for ( const auto& stream : streams )
+        prefixes.emplace_back(stream.prefix);
+    std::sort(prefixes.begin(), prefixes.end());
+
+    for ( const auto& prefix : prefixes )
+        fprintf(stderr, "  %s\n", prefix.c_str());
+
+    fprintf(stderr, "\n");
+    fprintf(stderr, "Every plugin (see -N) also has its own debug stream:\n");
     fprintf(stderr, "\n");
     fprintf(stderr,
             "  plugin-<plugin-name>   (replace '::' in name with '-'; e.g., '-B "
-            "plugin-Zeek-Netmap')\n");
+            "plugin-Zeek-JavaScript')\n");
+    fprintf(stderr, "\n");
+    fprintf(stderr, "Pseudo streams:\n");
     fprintf(stderr, "\n");
-    fprintf(stderr, "Pseudo streams\n");
     fprintf(stderr, "  verbose  Increase verbosity.\n");
     fprintf(stderr, "  all      Enable all streams at maximum verbosity.\n");
     fprintf(stderr, "\n");
@@ -79,12 +87,15 @@ void DebugLogger::EnableStreams(const char* s) {
     char* tok = strtok(tmp, ",");
 
     while ( tok ) {
+        std::string ltok{util::strtolower(tok)};
+
         if ( strcasecmp("all", tok) == 0 ) {
             for ( int i = 0; i < NUM_DBGS; ++i ) {
                 streams[i].enabled = true;
                 enabled_streams.insert(streams[i].prefix);
             }
 
+            all = true;
             verbose = true;
             goto next;
         }
@@ -99,10 +110,10 @@ void DebugLogger::EnableStreams(const char* s) {
             exit(0);
         }
 
-        if ( util::starts_with(tok, "plugin-") ) {
+        if ( util::starts_with(ltok, "plugin-") ) {
             // Cannot verify this at this time, plugins may not
             // have been loaded.
-            enabled_streams.insert(tok);
+            enabled_streams.insert(ltok);
             goto next;
         }
 
@@ -111,7 +122,7 @@ void DebugLogger::EnableStreams(const char* s) {
         for ( i = 0; i < NUM_DBGS; ++i ) {
             if ( strcasecmp(streams[i].prefix, tok) == 0 ) {
                 streams[i].enabled = true;
-                enabled_streams.insert(tok);
+                enabled_streams.insert(ltok);
                 goto next;
             }
         }
@@ -166,10 +177,11 @@ void DebugLogger::Log(DebugStream stream, const char* fmt, ...) {
 }
 
 void DebugLogger::Log(const plugin::Plugin& plugin, const char* fmt, ...) {
-    std::string tok = PluginStreamName(plugin.Name());
-
-    if ( enabled_streams.find(tok) == enabled_streams.end() )
-        return;
+    if ( ! all ) {
+        std::string tok = PluginStreamName(plugin.Name());
+        if ( enabled_streams.find(tok) == enabled_streams.end() )
+            return;
+    }
 
     fprintf(file, "%17.06f/%17.06f [plugin %s] ", run_state::network_time, util::current_time(true),
             plugin.Name().c_str());

src/DebugLogger.h

@@ -95,6 +95,7 @@ class DebugLogger {
 
 private:
     FILE* file;
+    bool all;
     bool verbose;
 
     struct Stream {
@@ -108,7 +109,7 @@ class DebugLogger {
     static Stream streams[NUM_DBGS];
 
     const std::string PluginStreamName(const std::string& plugin_name) {
-        return "plugin-" + util::strreplace(plugin_name, "::", "-");
+        return "plugin-" + util::strtolower(util::strreplace(plugin_name, "::", "-"));
     }
 };
 

testing/btest/Baseline/plugins.debug-streams/zeek.stderr

@@ -1,2 +1,2 @@
 ### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
-error in <command line>, line 3: No plugin debug stream 'plugin-zeek-http' found
+error in <command line>, line 3: No plugin debug stream 'plugin-notaplugin' found

testing/btest/plugins/debug-streams.zeek

@@ -2,6 +2,7 @@
 # @TEST-REQUIRES: test "$($BUILD/zeek-config --build_type)" = "debug"
 
 # @TEST-EXEC: zeek -B plugin-Zeek-HTTP -e 'event zeek_init() { print "zeek_init"; }' 2>zeek.stderr
-# @TEST-EXEC-FAIL: zeek -B plugin-zeek-http -e 'event zeek_init() { print "zeek_init"; }' 2>zeek.stderr
+# @TEST-EXEC: zeek -B PLUGIN-zeek-http -e 'event zeek_init() { print "zeek_init"; }' 2>zeek.stderr
+# @TEST-EXEC-FAIL: zeek -B plugin-notaplugin -e 'event zeek_init() { print "zeek_init"; }' 2>zeek.stderr
 
 # @TEST-EXEC: btest-diff zeek.stderr