Merge lp:~cemil-azizoglu/mir/fix-chatty-logging-in-tests into lp:mir

[Cemil Azizoglu]

Fix https://bugs.launchpad.net/mir/+bug/1394221

Fix https://bugs.launchpad.net/mir/+bug/1394221

- An option was added to send logs to NullLogger.
- Acceptance tests now use this option.

[lp:~cemil-azizoglu/mir/fix-chatty-logging-in-tests]

2081. By Cemil Azizoglu on 2014-11-21

Whitespace

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:2081
http://jenkins.qa.ubuntu.com/job/mir-ci/2191/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/251
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/251/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/225/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-ci/180/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/225/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/2191/rebuild

review: Needs Fixing (continuous-integration)

[Alexandros Frantzis (afrantzis)]

> 3 - server-ABI-unchanged (Failed)
> 6 - platform-ABI-unchanged (Failed)

CI failure.

> 75 + (silent_logger_opt, "Send logs to a black hole.");

Clearer as "--disable-logging", "Disable logging."?

review: Needs Fixing

[Alan Griffiths (alan-griffiths)]

W: Failed to fetch http://archive.ubuntu.com/ubuntu/dists/vivid/universe/i18n/Translation-en Hash Sum mismatch

triggering rebuild

[Alan Griffiths (alan-griffiths)]

*Needs discussion*

I'm not convinced this should be a mirserver option - I think logging should be "always on".

I've MP'd an alternative that only touches the test framework:

lp:~alan-griffiths/mir/fix-1394221/+merge/242477

review: Needs Information

[Alan Griffiths (alan-griffiths)]

131 +#if !defined(ALLOW_CONSOLE_LOGGING_IN_TESTS)
132 + const int argc = 2;
133 + char const* argv[argc] = {
134 + __PRETTY_FUNCTION__,
135 + "-s" /* --silent-logger */
136 + };
137 +
138 + server.set_command_line(argc, argv);
139 +#endif

needing to recompile to operate a logging switch is not intuitive.

review: Needs Fixing

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:2081
http://jenkins.qa.ubuntu.com/job/mir-ci/2203/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/269
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/269/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/243/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-ci/192/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/243/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/2203/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:2081
http://jenkins.qa.ubuntu.com/job/mir-ci/2208/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/275
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/275/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/249/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-ci/197/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/249/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/2208/rebuild

review: Needs Fixing (continuous-integration)

Unmerged revisions

2081. By Cemil Azizoglu on 2014-11-21

Whitespace

2080. By Cemil Azizoglu on 2014-11-21

- Option to turn send logs to a black hole
- Use the option during tests

=== modified file 'include/platform/mir/options/configuration.h'
--- include/platform/mir/options/configuration.h	2014-11-17 13:43:52 +0000
+++ include/platform/mir/options/configuration.h	2014-11-21 00:12:57 +0000
@@ -45,6 +45,7 @@
 extern char const* const fatal_abort_opt;
 extern char const* const debug_opt;
 extern char const* const use_asio_main_loop_opt;
+extern char const* const silent_logger_opt;
 
 extern char const* const name_opt;
 extern char const* const offscreen_opt;

=== modified file 'src/common/logging/logger.cpp'
--- src/common/logging/logger.cpp	2014-11-17 18:26:11 +0000
+++ src/common/logging/logger.cpp	2014-11-21 00:12:57 +0000
@@ -16,7 +16,6 @@
  * Authored by: Cemil Azizoglu <[e-mail]>
  */
 
-#include "mir/logging/dumb_console_logger.h"
 #include "mir/logging/logger.h"
 
 #include <memory>
@@ -39,7 +38,7 @@
     {
         std::lock_guard<decltype(log_mutex)> lock{log_mutex};
         if (!the_logger)
-            the_logger = std::make_shared<ml::DumbConsoleLogger>();
+            the_logger = std::make_shared<ml::NullLogger>();
 
         return the_logger;
     }

=== modified file 'src/include/common/mir/logging/logger.h'
--- src/include/common/mir/logging/logger.h	2014-11-17 18:26:11 +0000
+++ src/include/common/mir/logging/logger.h	2014-11-21 00:12:57 +0000
@@ -52,6 +52,14 @@
     Logger& operator=(const Logger&) = delete;
 };
 
+class NullLogger : public Logger
+{
+public:
+    void log(Severity,
+             const std::string&,
+             const std::string&) override {}
+};
+
 void log(Severity severity, const std::string& message);
 void log(Severity severity, const std::string& message, const std::string& component);
 void set_logger(std::shared_ptr<Logger> const& new_logger);

=== modified file 'src/platform/options/default_configuration.cpp'
--- src/platform/options/default_configuration.cpp	2014-11-17 13:43:52 +0000
+++ src/platform/options/default_configuration.cpp	2014-11-21 00:12:57 +0000
@@ -43,10 +43,11 @@
 char const* const mo::frontend_threads_opt        = "ipc-thread-pool";
 char const* const mo::name_opt                    = "name";
 char const* const mo::offscreen_opt               = "offscreen";
-char const* const mo::touchspots_opt               = "enable-touchspots";
+char const* const mo::touchspots_opt              = "enable-touchspots";
 char const* const mo::fatal_abort_opt             = "on-fatal-error-abort";
 char const* const mo::debug_opt                   = "debug";
 char const* const mo::use_asio_main_loop_opt      = "use-asio-main-loop";
+char const* const mo::silent_logger_opt           = "silent-logger,s";
 
 char const* const mo::off_opt_value = "off";
 char const* const mo::log_opt_value = "log";
@@ -147,7 +148,8 @@
             "in unexpected ways] abort (to get a core dump)")
         (debug_opt, "Enable extra development debugging. "
             "This is only interesting for people doing Mir server or client development.")
-        (use_asio_main_loop_opt, "Use the ASIO main loop implementation");
+        (use_asio_main_loop_opt, "Use the ASIO main loop implementation")
+        (silent_logger_opt, "Send logs to a black hole.");
 
         add_platform_options();
 }

=== modified file 'src/platform/symbols.map'
--- src/platform/symbols.map	2014-11-19 13:45:25 +0000
+++ src/platform/symbols.map	2014-11-21 00:12:57 +0000
@@ -178,6 +178,7 @@
     mir::options::session_mediator_report_opt*;
     mir::options::touchspots_opt*;
     mir::options::use_asio_main_loop_opt*;
+    mir::options::silent_logger_opt*;
     non-virtual?thunk?to?mir::graphics::Cursor::?Cursor*;
     non-virtual?thunk?to?mir::graphics::CursorImage::?CursorImage*;
     non-virtual?thunk?to?mir::graphics::DisplayConfigurationPolicy::?DisplayConfigurationPolicy*;

=== modified file 'src/server/default_server_configuration.cpp'
--- src/server/default_server_configuration.cpp	2014-11-17 13:43:52 +0000
+++ src/server/default_server_configuration.cpp	2014-11-21 00:12:57 +0000
@@ -212,6 +212,9 @@
     return logger(
         [this]() -> std::shared_ptr<ml::Logger>
         {
-            return std::make_shared<ml::DumbConsoleLogger>();
+            if (the_options()->is_set(options::silent_logger_opt))
+                return std::make_shared<ml::NullLogger>();
+            else
+                return std::make_shared<ml::DumbConsoleLogger>();
         });
 }

=== modified file 'tests/mir_test_framework/CMakeLists.txt'
--- tests/mir_test_framework/CMakeLists.txt	2014-11-18 16:15:00 +0000
+++ tests/mir_test_framework/CMakeLists.txt	2014-11-21 00:12:57 +0000
@@ -35,6 +35,12 @@
   fake_event_hub_server_configuration.cpp
 )
 
+option(MIR_ALLOW_CONSOLE_LOGGING_IN_TESTS "Allow logs to stdout during tests" OFF)
+
+if (MIR_ALLOW_CONSOLE_LOGGING_IN_TESTS)
+add_definitions(-DALLOW_CONSOLE_LOGGING_IN_TESTS)
+endif (MIR_ALLOW_CONSOLE_LOGGING_IN_TESTS)
+
 list(APPEND TEST_FRAMEWORK_SRCS
   socket_detect_server.cpp
 )

=== modified file 'tests/mir_test_framework/headless_test.cpp'
--- tests/mir_test_framework/headless_test.cpp	2014-11-06 03:56:24 +0000
+++ tests/mir_test_framework/headless_test.cpp	2014-11-21 00:12:57 +0000
@@ -42,6 +42,16 @@
 
 void mtf::HeadlessTest::start_server()
 {
+#if !defined(ALLOW_CONSOLE_LOGGING_IN_TESTS)
+    const int argc = 2;
+    char const* argv[argc] = {
+        __PRETTY_FUNCTION__,
+        "-s" /* --silent-logger */
+    };
+
+    server.set_command_line(argc, argv);
+#endif
+
     server.add_init_callback([&]
         {
             auto const main_loop = server.the_main_loop();