Android: uses a fifo rather than logcat for the test runner.

testing/android/native_test_launcher.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // This class sets up the environment for running the native tests inside an
 // android application. It outputs (to logcat) markers identifying the
 // START/END/CRASH of the test suite, FAILURE/SUCCESS of individual tests etc.

[nilesh, 2012/09/18 15:18:02]

I think this needs to be updated.

[bulach, 2012/09/19 08:43:42]

Done.

 // These markers are read by the test runner script to generate test results.
 // It injects an event listener in gtest to detect various test stages and
 // installs signal handlers to detect crashes.
 
 #include <android/log.h>
 #include <signal.h>
+#include <stdarg.h>
 #include <stdio.h>
 
 #include "base/android/base_jni_registrar.h"
 #include "base/android/jni_android.h"
 #include "base/android/jni_string.h"
 #include "base/android/locale_utils.h"
 #include "base/android/path_utils.h"
 #include "base/android/scoped_java_ref.h"
 #include "base/at_exit.h"
 #include "base/base_switches.h"
 #include "base/command_line.h"
 #include "base/file_path.h"
 #include "base/file_util.h"
 #include "base/logging.h"
 #include "base/stringprintf.h"
 #include "base/string_tokenizer.h"
 #include "base/string_util.h"
 #include "gtest/gtest.h"
 #include "testing/jni/ChromeNativeTestActivity_jni.h"
 
 // The main function of the program to be wrapped as a test apk.
 extern int main(int argc, char** argv);
 
 namespace {
 
-void log_write(int level, const char* msg) {
-  __android_log_write(level, "chromium", msg);
+const char kLogTag[] = "chromium";
+const char kCrashedMarker[] = "[ CRASHED      ]\n";
+
+void AndroidLogError(const char* format, ...) {
+  va_list args;
+  va_start(args, format);
+  __android_log_vprint(ANDROID_LOG_ERROR, kLogTag, format, args);
+  va_end(args);
 }
 
 // The list of signals which are considered to be crashes.
 const int kExceptionSignals[] = {
   SIGSEGV, SIGABRT, SIGFPE, SIGILL, SIGBUS, -1
 };
 
 struct sigaction g_old_sa[NSIG];
 
 // This function runs in a compromised context. It should not allocate memory.

[nilesh, 2012/09/18 15:18:02]

Now that we have a FIFO, we can use EOF in test scripts to detect crashes.
Please add a TODO in my name to try get rid of signal handler.

[bulach, 2012/09/19 08:43:42]

Done.

-void SignalHandler(int sig, siginfo_t *info, void *reserved)
-{
+void SignalHandler(int sig, siginfo_t* info, void* reserved) {
   // Output the crash marker.
-  log_write(ANDROID_LOG_ERROR, "[ CRASHED      ]");
+  write(STDOUT_FILENO, kCrashedMarker, sizeof(kCrashedMarker));
   g_old_sa[sig].sa_sigaction(sig, info, reserved);
 }
 
 void InstallHandlers() {
   struct sigaction sa;
   memset(&sa, 0, sizeof(sa));
 
   sa.sa_sigaction = SignalHandler;
   sa.sa_flags = SA_SIGINFO;
 
@@ skipping 31 matching lines @@
   int argc = args.size();
 
   argv->resize(argc + 1);
   for (int i = 0; i < argc; ++i)
     (*argv)[i] = const_cast<char*>(args[i].c_str());
   (*argv)[argc] = NULL;  // argv must be NULL terminated.
 
   return argc;
 }
 
-// As we are the native side of an Android app, we don't have any 'console', so
-// gtest's standard output goes nowhere.
-// Instead, we inject an "EventListener" in gtest and then we print the results
-// using LOG, which goes to adb logcat.
-class AndroidLogPrinter : public ::testing::EmptyTestEventListener {
- public:
-  void Init(int* argc, char** argv);
-
-  // EmptyTestEventListener
-  virtual void OnTestProgramStart(
-      const ::testing::UnitTest& unit_test) OVERRIDE;
-  virtual void OnTestStart(const ::testing::TestInfo& test_info) OVERRIDE;
-  virtual void OnTestPartResult(
-      const ::testing::TestPartResult& test_part_result) OVERRIDE;
-  virtual void OnTestEnd(const ::testing::TestInfo& test_info) OVERRIDE;
-  virtual void OnTestProgramEnd(const ::testing::UnitTest& unit_test) OVERRIDE;
-};
-
-void AndroidLogPrinter::Init(int* argc, char** argv) {
-  // InitGoogleTest must be called befure we add ourselves as a listener.
-  ::testing::InitGoogleTest(argc, argv);
-  ::testing::TestEventListeners& listeners =
-      ::testing::UnitTest::GetInstance()->listeners();
-  // Adds a listener to the end.  Google Test takes the ownership.
-  listeners.Append(this);
+void CreateFIFO(const char* fifo_path) {
+  unlink(fifo_path);
+  if (mkfifo(fifo_path, 0666)) {
+    AndroidLogError("Failed to create fifo %s: %s\n",
+                    fifo_path, strerror(errno));
+    exit(EXIT_FAILURE);
+  }
 }
 
-void AndroidLogPrinter::OnTestProgramStart(
-    const ::testing::UnitTest& unit_test) {
-  std::string msg = StringPrintf("[ START      ] %d",
-                                 unit_test.test_to_run_count());
-  log_write(ANDROID_LOG_ERROR, msg.c_str());
+void Redirect(FILE* stream, const char* path, const char* mode) {
+  if (!freopen(path, mode, stream)) {
+    AndroidLogError("Failed to redirect stream to file: %s: %s\n",
+                    path, strerror(errno));
+    exit(EXIT_FAILURE);
+  }
 }
 
-void AndroidLogPrinter::OnTestStart(const ::testing::TestInfo& test_info) {
-  std::string msg = StringPrintf("[ RUN      ] %s.%s",
-                                 test_info.test_case_name(), test_info.name());
-  log_write(ANDROID_LOG_ERROR, msg.c_str());
-}
+class ScopedMainEntryLogger {
+ public:
+  ScopedMainEntryLogger() {
+    printf(">>ScopedMainEntryLogger\n");
+  }
 
-void AndroidLogPrinter::OnTestPartResult(
-    const ::testing::TestPartResult& test_part_result) {
-  std::string msg = StringPrintf(
-      "%s in %s:%d\n%s\n",
-      test_part_result.failed() ? "*** Failure" : "Success",
-      test_part_result.file_name(),
-      test_part_result.line_number(),
-      test_part_result.summary());
-  log_write(ANDROID_LOG_ERROR, msg.c_str());
-}
-
-void AndroidLogPrinter::OnTestEnd(const ::testing::TestInfo& test_info) {
-  std::string msg = StringPrintf("%s %s.%s",
-      test_info.result()->Failed() ? "[  FAILED  ]" : "[       OK ]",
-      test_info.test_case_name(), test_info.name());
-  log_write(ANDROID_LOG_ERROR, msg.c_str());
-}
-
-void AndroidLogPrinter::OnTestProgramEnd(
-    const ::testing::UnitTest& unit_test) {
-  std::string msg = StringPrintf("[ END      ] %d",
-         unit_test.successful_test_count());
-  log_write(ANDROID_LOG_ERROR, msg.c_str());
-}
+  ~ScopedMainEntryLogger() {
+    printf("<<ScopedMainEntryLogger\n");
+    fflush(stdout);
+    fflush(stderr);
+  }
+};
 
 }  // namespace
 
 // This method is called on a separate java thread so that we won't trigger
 // an ANR.
 static void RunTests(JNIEnv* env,
                      jobject obj,
                      jstring jfiles_dir,
                      jobject app_context) {
   base::AtExitManager exit_manager;
 
   // Command line initialized basically, will be fully initialized later.
   static const char* const kInitialArgv[] = { "ChromeTestActivity" };
   CommandLine::Init(arraysize(kInitialArgv), kInitialArgv);
 
   // Set the application context in base.
   base::android::ScopedJavaLocalRef<jobject> scoped_context(
       env, env->NewLocalRef(app_context));
   base::android::InitApplicationContext(scoped_context);
   base::android::RegisterJni(env);
 
   FilePath files_dir(base::android::ConvertJavaStringToUTF8(env, jfiles_dir));
   // A few options, such "--gtest_list_tests", will just use printf directly
-  // and won't use the "AndroidLogPrinter". Redirect stdout to a known file.
-  FilePath stdout_path(files_dir.Append(FilePath("stdout.txt")));
-  freopen(stdout_path.value().c_str(), "w", stdout);
+  // Redirect stdout and stderr to a known file.
+  FilePath fifo_path(files_dir.Append(FilePath("test.fifo")));
+  CreateFIFO(fifo_path.value().c_str());
+  Redirect(stdout, fifo_path.value().c_str(), "w");
+  Redirect(stderr, fifo_path.value().c_str(), "w");
 
   std::vector<std::string> args;
   ParseArgsFromCommandLineFile(&args);
 
   // We need to pass in a non-const char**.
   std::vector<char*> argv;
   int argc = ArgsToArgv(args, &argv);
 
-  // This object is owned by gtest.
-  AndroidLogPrinter* log = new AndroidLogPrinter();
-  log->Init(&argc, &argv[0]);
-
   // Fully initialize command line with arguments.
   CommandLine::ForCurrentProcess()->AppendArguments(
       CommandLine(argc, &argv[0]), false);
   const CommandLine& command_line = *CommandLine::ForCurrentProcess();
   if (command_line.HasSwitch(switches::kWaitForDebugger)) {
     std::string msg = StringPrintf("Native test waiting for GDB because "
                                    "flag %s was supplied",
                                    switches::kWaitForDebugger);
-    log_write(ANDROID_LOG_VERBOSE, msg.c_str());
+    __android_log_write(ANDROID_LOG_VERBOSE, kLogTag, msg.c_str());
     base::debug::WaitForDebugger(24 * 60 * 60, false);
   }
 
+  ScopedMainEntryLogger scoped_main_entry_logger;
   main(argc, &argv[0]);
 }
 
 // This is called by the VM when the shared library is first loaded.
 JNI_EXPORT jint JNI_OnLoad(JavaVM* vm, void* reserved) {
   // Install signal handlers to detect crashes.
   InstallHandlers();
 
   base::android::InitVM(vm);
   JNIEnv* env = base::android::AttachCurrentThread();
   if (!RegisterNativesImpl(env)) {
     return -1;
   }
 
   return JNI_VERSION_1_4;
 }