Re-land part of r55416, minus actually moving the test_suite.h contents to a .cc file.

Cleanup in base. This moves the implementation (and a bunch of header file
dependencies) from the multiprocess test and the test_suite headers to .cc
files. Moves multiprocess_test to the test directory, and all of this stuff to
the existing base_test_support project. I also used the base namespace.

Previously other projects included this functionality just by #include because
it was all inline, so I had to add dependencies on base_test_support in a few
places.

Moves and renames the command line switch this was using to base_switches. Move
the base switch for process type to chrome switches.

TEST=none
BUG=none
Review URL: http://codereview.chromium.org/3026055


git-svn-id: svn://svn.chromium.org/chrome/trunk/src@56399 0039d316-1c4b-4281-b951-d872f2087c98

6 files changed, 337 insertions, 140 deletions

diff --git a/base/test/multiprocess_test.cc b/base/test/multiprocess_test.cc
new file mode 100644
index 0000000..a1a3bbe
--- /dev/null
+++ b/base/test/multiprocess_test.cc
@@ -0,0 +1,74 @@
+// Copyright (c) 2010 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.
+
+#include "base/test/multiprocess_test.h"
+
+#include "base/base_switches.h"
+#include "base/command_line.h"
+
+#if defined(OS_POSIX)
+#include <sys/types.h>
+#include <unistd.h>
+#endif
+
+namespace base {
+
+MultiProcessTest::MultiProcessTest() {
+}
+
+ProcessHandle MultiProcessTest::SpawnChild(const std::string& procname,
+                                           bool debug_on_start) {
+#if defined(OS_WIN)
+  return SpawnChildImpl(procname, debug_on_start);
+#elif defined(OS_POSIX)
+  file_handle_mapping_vector empty_file_list;
+  return SpawnChildImpl(procname, empty_file_list, debug_on_start);
+#endif
+}
+
+#if defined(OS_POSIX)
+ProcessHandle MultiProcessTest::SpawnChild(
+    const std::string& procname,
+    const file_handle_mapping_vector& fds_to_map,
+    bool debug_on_start) {
+  return SpawnChildImpl(procname, fds_to_map, debug_on_start);
+}
+#endif
+
+CommandLine MultiProcessTest::MakeCmdLine(const std::string& procname,
+                                          bool debug_on_start) {
+  CommandLine cl(*CommandLine::ForCurrentProcess());
+  cl.AppendSwitchASCII(switches::kTestChildProcess, procname);
+  if (debug_on_start)
+    cl.AppendSwitch(switches::kDebugOnStart);
+  return cl;
+}
+
+#if defined(OS_WIN)
+
+ProcessHandle MultiProcessTest::SpawnChildImpl(const std::string& procname,
+                                               bool debug_on_start) {
+  ProcessHandle handle = static_cast<ProcessHandle>(NULL);
+  LaunchApp(MakeCmdLine(procname, debug_on_start),
+                  false, true, &handle);
+  return handle;
+}
+
+#elif defined(OS_POSIX)
+
+// TODO(port): with the CommandLine refactoring, this code is very similar
+// to the Windows code.  Investigate whether this can be made shorter.
+ProcessHandle MultiProcessTest::SpawnChildImpl(
+    const std::string& procname,
+    const file_handle_mapping_vector& fds_to_map,
+    bool debug_on_start) {
+  ProcessHandle handle = kNullProcessHandle;
+  LaunchApp(MakeCmdLine(procname, debug_on_start).argv(),
+                  fds_to_map, false, &handle);
+  return handle;
+}
+
+#endif
+
+}  // namespace base
diff --git a/base/test/multiprocess_test.h b/base/test/multiprocess_test.h
new file mode 100644
index 0000000..5126abe
--- /dev/null
+++ b/base/test/multiprocess_test.h
@@ -0,0 +1,86 @@
+// Copyright (c) 2010 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.
+
+#ifndef BASE_TEST_MULTIPROCESS_TEST_H_
+#define BASE_TEST_MULTIPROCESS_TEST_H_
+#pragma once
+
+#include <string>
+
+#include "base/basictypes.h"
+#include "base/process.h"
+#include "base/process_util.h"
+#include "build/build_config.h"
+#include "testing/platform_test.h"
+
+class CommandLine;
+
+namespace base {
+
+// A MultiProcessTest is a test class which makes it easier to
+// write a test which requires code running out of process.
+//
+// To create a multiprocess test simply follow these steps:
+//
+// 1) Derive your test from MultiProcessTest. Example:
+//
+//    class MyTest : public MultiProcessTest {
+//    };
+//
+//    TEST_F(MyTest, TestCaseName) {
+//      ...
+//    }
+//
+// 2) Create a mainline function for the child processes and include
+//    testing/multiprocess_func_list.h.
+//    See the declaration of the MULTIPROCESS_TEST_MAIN macro
+//    in that file for an example.
+// 3) Call SpawnChild("foo"), where "foo" is the name of
+//    the function you wish to run in the child processes.
+// That's it!
+class MultiProcessTest : public PlatformTest {
+ public:
+  MultiProcessTest();
+
+ protected:
+  // Run a child process.
+  // 'procname' is the name of a function which the child will
+  // execute.  It must be exported from this library in order to
+  // run.
+  //
+  // Example signature:
+  //    extern "C" int __declspec(dllexport) FooBar() {
+  //         // do client work here
+  //    }
+  //
+  // Returns the handle to the child, or NULL on failure
+  ProcessHandle SpawnChild(const std::string& procname, bool debug_on_start);
+
+#if defined(OS_POSIX)
+  ProcessHandle SpawnChild(const std::string& procname,
+                           const file_handle_mapping_vector& fds_to_map,
+                           bool debug_on_start);
+#endif
+
+  CommandLine MakeCmdLine(const std::string& procname, bool debug_on_start);
+
+ private:
+#if defined(OS_WIN)
+  ProcessHandle SpawnChildImpl(const std::string& procname,
+                               bool debug_on_start);
+
+#elif defined(OS_POSIX)
+  // TODO(port): with the CommandLine refactoring, this code is very similar
+  // to the Windows code.  Investigate whether this can be made shorter.
+  ProcessHandle SpawnChildImpl(const std::string& procname,
+                               const file_handle_mapping_vector& fds_to_map,
+                               bool debug_on_start);
+#endif
+
+ DISALLOW_COPY_AND_ASSIGN(MultiProcessTest);
+};
+
+}  // namespace base
+
+#endif  // BASE_TEST_MULTIPROCESS_TEST_H_
diff --git a/base/test/perf_test_suite.h b/base/test/perf_test_suite.h
index bac5a63..37abea6 100644
--- a/base/test/perf_test_suite.h
+++ b/base/test/perf_test_suite.h
@@ -9,10 +9,12 @@
 #include "base/command_line.h"
 #include "base/debug_util.h"
 #include "base/file_path.h"
+#include "base/path_service.h"
 #include "base/perftimer.h"
 #include "base/process_util.h"
 #include "base/string_util.h"
 #include "base/test/test_suite.h"
+#include "testing/gtest/include/gtest/gtest.h"
 
 class PerfTestSuite : public TestSuite {
  public:
diff --git a/base/test/run_all_unittests.cc b/base/test/run_all_unittests.cc
index 841b353..8bfeb3b 100644
--- a/base/test/run_all_unittests.cc
+++ b/base/test/run_all_unittests.cc
@@ -5,5 +5,5 @@
 #include "base/test/test_suite.h"
 
 int main(int argc, char** argv) {
-  return TestSuite(argc, argv).Run();
+  return base::TestSuite(argc, argv).Run();
 }
diff --git a/base/test/test_suite.cc b/base/test/test_suite.cc
index a374034..6df1fb9 100644
--- a/base/test/test_suite.cc
+++ b/base/test/test_suite.cc
@@ -6,16 +6,19 @@
 
 #include "base/at_exit.h"
 #include "base/base_paths.h"
+#include "base/base_switches.h"
+#include "base/command_line.h"
 #include "base/debug_on_start.h"
 #include "base/debug_util.h"
 #include "base/file_path.h"
 #include "base/i18n/icu_util.h"
-#include "base/multiprocess_test.h"
+#include "base/logging.h"
 #include "base/nss_util.h"
 #include "base/path_service.h"
 #include "base/process_util.h"
 #include "base/scoped_nsautorelease_pool.h"
 #include "base/scoped_ptr.h"
+#include "base/test/multiprocess_test.h"
 #include "base/time.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "testing/multiprocess_func_list.h"
@@ -24,6 +27,22 @@
 #include <gtk/gtk.h>
 #endif
 
+namespace {
+
+class MaybeTestDisabler : public testing::EmptyTestEventListener {
+ public:
+  virtual void OnTestStart(const testing::TestInfo& test_info) {
+    ASSERT_FALSE(TestSuite::IsMarkedMaybe(test_info))
+        << "Probably the OS #ifdefs don't include all of the necessary "
+           "platforms.\nPlease ensure that no tests have the MAYBE_ prefix "
+           "after the code is preprocessed.";
+  }
+};
+
+}  // namespace
+
+const char TestSuite::kStrictFailureHandling[] = "strict_failure_handling";
+
 TestSuite::TestSuite(int argc, char** argv) {
   base::EnableTerminationOnHeapCorruption();
   CommandLine::Init(argc, argv);
@@ -36,6 +55,60 @@ TestSuite::TestSuite(int argc, char** argv) {
   // Initialize().  See bug 6436.
 }
 
+TestSuite::~TestSuite() {
+  CommandLine::Reset();
+}
+
+// static
+bool TestSuite::IsMarkedFlaky(const testing::TestInfo& test) {
+  return strncmp(test.name(), "FLAKY_", 6) == 0;
+}
+
+// static
+bool TestSuite::IsMarkedFailing(const testing::TestInfo& test) {
+  return strncmp(test.name(), "FAILS_", 6) == 0;
+}
+
+// static
+bool TestSuite::IsMarkedMaybe(const testing::TestInfo& test) {
+  return strncmp(test.name(), "MAYBE_", 6) == 0;
+}
+
+// static
+bool TestSuite::ShouldIgnoreFailure(const testing::TestInfo& test) {
+  if (CommandLine::ForCurrentProcess()->HasSwitch(kStrictFailureHandling))
+    return false;
+  return IsMarkedFlaky(test) || IsMarkedFailing(test);
+}
+
+// static
+bool TestSuite::NonIgnoredFailures(const testing::TestInfo& test) {
+  return test.should_run() && test.result()->Failed() &&
+      !ShouldIgnoreFailure(test);
+}
+
+int TestSuite::GetTestCount(TestMatch test_match) {
+  testing::UnitTest* instance = testing::UnitTest::GetInstance();
+  int count = 0;
+
+  for (int i = 0; i < instance->total_test_case_count(); ++i) {
+    const testing::TestCase& test_case = *instance->GetTestCase(i);
+    for (int j = 0; j < test_case.total_test_count(); ++j) {
+      if (test_match(*test_case.GetTestInfo(j))) {
+        count++;
+      }
+    }
+  }
+
+  return count;
+}
+
+void TestSuite::CatchMaybeTests() {
+  testing::TestEventListeners& listeners =
+      testing::UnitTest::GetInstance()->listeners();
+  listeners.Append(new MaybeTestDisabler);
+}
+
 // Don't add additional code to this method.  Instead add it to
 // Initialize().  See bug 6436.
 int TestSuite::Run() {
@@ -44,7 +117,7 @@ int TestSuite::Run() {
   Initialize();
   std::string client_func =
       CommandLine::ForCurrentProcess()->GetSwitchValueASCII(
-          kRunClientProcess);
+          switches::kTestChildProcess);
   // Check to see if we are being run as a client process.
   if (!client_func.empty())
     return multi_process_function_list::InvokeChildProcessTest(client_func);
@@ -77,3 +150,65 @@ int TestSuite::Run() {
 
   return result;
 }
+
+// static
+void TestSuite::UnitTestAssertHandler(const std::string& str) {
+  RAW_LOG(FATAL, str.c_str());
+}
+
+void TestSuite::SuppressErrorDialogs() {
+#if defined(OS_WIN)
+  UINT new_flags = SEM_FAILCRITICALERRORS |
+                   SEM_NOGPFAULTERRORBOX |
+                   SEM_NOOPENFILEERRORBOX;
+
+  // Preserve existing error mode, as discussed at
+  // http://blogs.msdn.com/oldnewthing/archive/2004/07/27/198410.aspx
+  UINT existing_flags = SetErrorMode(new_flags);
+  SetErrorMode(existing_flags | new_flags);
+#endif  // defined(OS_WIN)
+}
+
+void TestSuite::Initialize() {
+  // Initialize logging.
+  FilePath exe;
+  PathService::Get(base::FILE_EXE, &exe);
+  FilePath log_filename = exe.ReplaceExtension(FILE_PATH_LITERAL("log"));
+  logging::InitLogging(log_filename.value().c_str(),
+                       logging::LOG_TO_BOTH_FILE_AND_SYSTEM_DEBUG_LOG,
+                       logging::LOCK_LOG_FILE,
+                       logging::DELETE_OLD_LOG_FILE);
+  // We want process and thread IDs because we may have multiple processes.
+  // Note: temporarily enabled timestamps in an effort to catch bug 6361.
+  logging::SetLogItems(true, true, true, true);
+
+  CHECK(base::EnableInProcessStackDumping());
+#if defined(OS_WIN)
+  // Make sure we run with high resolution timer to minimize differences
+  // between production code and test code.
+  base::Time::EnableHighResolutionTimer(true);
+#endif  // defined(OS_WIN)
+
+  // In some cases, we do not want to see standard error dialogs.
+  if (!DebugUtil::BeingDebugged() &&
+      !CommandLine::ForCurrentProcess()->HasSwitch("show-error-dialogs")) {
+    SuppressErrorDialogs();
+    DebugUtil::SuppressDialogs();
+    logging::SetLogAssertHandler(UnitTestAssertHandler);
+  }
+
+  icu_util::Initialize();
+
+#if defined(USE_NSS)
+  // Trying to repeatedly initialize and cleanup NSS and NSPR may result in
+  // a deadlock. Such repeated initialization will happen when using test
+  // isolation. Prevent problems by initializing NSS here, so that the cleanup
+  // will be done only on process exit.
+  base::EnsureNSSInit();
+#endif  // defined(USE_NSS)
+
+  CatchMaybeTests();
+}
+
+void TestSuite::Shutdown() {
+}
diff --git a/base/test/test_suite.h b/base/test/test_suite.h
index c0a2891..2d4352b 100644
--- a/base/test/test_suite.h
+++ b/base/test/test_suite.h
@@ -1,4 +1,4 @@
-// Copyright (c) 2009 The Chromium Authors. All rights reserved.
+// Copyright (c) 2010 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.
 
@@ -10,178 +10,78 @@
 // instantiate this class in your main function and call its Run method to run
 // any gtest based tests that are linked into your executable.
 
+#include <string>
+
 #include "base/at_exit.h"
-#include "base/base_paths.h"
-#include "base/debug_on_start.h"
-#include "base/debug_util.h"
-#include "base/file_path.h"
-#include "base/i18n/icu_util.h"
-#include "base/multiprocess_test.h"
-#include "base/nss_util.h"
-#include "base/path_service.h"
-#include "base/process_util.h"
-#include "base/scoped_nsautorelease_pool.h"
-#include "base/scoped_ptr.h"
-#include "base/time.h"
-#include "testing/gtest/include/gtest/gtest.h"
-#include "testing/multiprocess_func_list.h"
-
-#if defined(TOOLKIT_USES_GTK)
-#include <gtk/gtk.h>
-#endif
-
-// A command-line flag that makes a test failure always result in a non-zero
-// process exit code.
-const char kStrictFailureHandling[] = "strict_failure_handling";
-
-// Match function used by the GetTestCount method.
-typedef bool (*TestMatch)(const testing::TestInfo&);
+
+namespace testing {
+class TestInfo;
+}
+
+namespace base {
 
 class TestSuite {
  public:
-  TestSuite(int argc, char** argv);
+  // Match function used by the GetTestCount method.
+  typedef bool (*TestMatch)(const testing::TestInfo&);
 
-  virtual ~TestSuite() {
-    CommandLine::Reset();
-  }
+  TestSuite(int argc, char** argv);
+  virtual ~TestSuite();
 
   // Returns true if the test is marked as flaky.
-  static bool IsMarkedFlaky(const testing::TestInfo& test) {
-    return strncmp(test.name(), "FLAKY_", 6) == 0;
-  }
+  static bool IsMarkedFlaky(const testing::TestInfo& test);
 
   // Returns true if the test is marked as failing.
-  static bool IsMarkedFailing(const testing::TestInfo& test) {
-    return strncmp(test.name(), "FAILS_", 6) == 0;
-  }
+  static bool IsMarkedFailing(const testing::TestInfo& test);
 
   // Returns true if the test is marked as "MAYBE_".
   // When using different prefixes depending on platform, we use MAYBE_ and
   // preprocessor directives to replace MAYBE_ with the target prefix.
-  static bool IsMarkedMaybe(const testing::TestInfo& test) {
-    return strncmp(test.name(), "MAYBE_", 6) == 0;
-  }
+  static bool IsMarkedMaybe(const testing::TestInfo& test);
 
   // Returns true if the test failure should be ignored.
-  static bool ShouldIgnoreFailure(const testing::TestInfo& test) {
-    if (CommandLine::ForCurrentProcess()->HasSwitch(kStrictFailureHandling))
-      return false;
-    return IsMarkedFlaky(test) || IsMarkedFailing(test);
-  }
+  static bool ShouldIgnoreFailure(const testing::TestInfo& test);
 
   // Returns true if the test failed and the failure shouldn't be ignored.
-  static bool NonIgnoredFailures(const testing::TestInfo& test) {
-    return test.should_run() && test.result()->Failed() &&
-        !ShouldIgnoreFailure(test);
-  }
+  static bool NonIgnoredFailures(const testing::TestInfo& test);
 
   // Returns the number of tests where the match function returns true.
-  int GetTestCount(TestMatch test_match) {
-    testing::UnitTest* instance = testing::UnitTest::GetInstance();
-    int count = 0;
-
-    for (int i = 0; i < instance->total_test_case_count(); ++i) {
-      const testing::TestCase& test_case = *instance->GetTestCase(i);
-      for (int j = 0; j < test_case.total_test_count(); ++j) {
-        if (test_match(*test_case.GetTestInfo(j))) {
-          count++;
-        }
-      }
-    }
-
-    return count;
-  }
-
-  void CatchMaybeTests() {
-    testing::TestEventListeners& listeners =
-        testing::UnitTest::GetInstance()->listeners();
-    listeners.Append(new MaybeTestDisabler);
-  }
+  int GetTestCount(TestMatch test_match);
+
+  void CatchMaybeTests();
 
   int Run();
 
- protected:
-  class MaybeTestDisabler : public testing::EmptyTestEventListener {
-   public:
-    virtual void OnTestStart(const testing::TestInfo& test_info) {
-      ASSERT_FALSE(TestSuite::IsMarkedMaybe(test_info))
-          << "Probably the OS #ifdefs don't include all of the necessary "
-             "platforms.\nPlease ensure that no tests have the MAYBE_ prefix "
-             "after the code is preprocessed.";
-    }
-  };
+  // A command-line flag that makes a test failure always result in a non-zero
+  // process exit code.
+  static const char kStrictFailureHandling[];
 
+ protected:
   // By default fatal log messages (e.g. from DCHECKs) result in error dialogs
   // which gum up buildbots. Use a minimalistic assert handler which just
   // terminates the process.
-  static void UnitTestAssertHandler(const std::string& str) {
-    RAW_LOG(FATAL, str.c_str());
-  }
+  static void UnitTestAssertHandler(const std::string& str);
 
   // Disable crash dialogs so that it doesn't gum up the buildbot
-  virtual void SuppressErrorDialogs() {
-#if defined(OS_WIN)
-    UINT new_flags = SEM_FAILCRITICALERRORS |
-                     SEM_NOGPFAULTERRORBOX |
-                     SEM_NOOPENFILEERRORBOX;
-
-    // Preserve existing error mode, as discussed at
-    // http://blogs.msdn.com/oldnewthing/archive/2004/07/27/198410.aspx
-    UINT existing_flags = SetErrorMode(new_flags);
-    SetErrorMode(existing_flags | new_flags);
-#endif  // defined(OS_WIN)
-  }
+  virtual void SuppressErrorDialogs();
 
   // Override these for custom initialization and shutdown handling.  Use these
   // instead of putting complex code in your constructor/destructor.
 
-  virtual void Initialize() {
-    // Initialize logging.
-    FilePath exe;
-    PathService::Get(base::FILE_EXE, &exe);
-    FilePath log_filename = exe.ReplaceExtension(FILE_PATH_LITERAL("log"));
-    logging::InitLogging(log_filename.value().c_str(),
-                         logging::LOG_TO_BOTH_FILE_AND_SYSTEM_DEBUG_LOG,
-                         logging::LOCK_LOG_FILE,
-                         logging::DELETE_OLD_LOG_FILE);
-    // We want process and thread IDs because we may have multiple processes.
-    // Note: temporarily enabled timestamps in an effort to catch bug 6361.
-    logging::SetLogItems(true, true, true, true);
-
-    CHECK(base::EnableInProcessStackDumping());
-#if defined(OS_WIN)
-    // Make sure we run with high resolution timer to minimize differences
-    // between production code and test code.
-    base::Time::EnableHighResolutionTimer(true);
-#endif  // defined(OS_WIN)
-
-    // In some cases, we do not want to see standard error dialogs.
-    if (!DebugUtil::BeingDebugged() &&
-        !CommandLine::ForCurrentProcess()->HasSwitch("show-error-dialogs")) {
-      SuppressErrorDialogs();
-      DebugUtil::SuppressDialogs();
-      logging::SetLogAssertHandler(UnitTestAssertHandler);
-    }
-
-    icu_util::Initialize();
-
-#if defined(USE_NSS)
-    // Trying to repeatedly initialize and cleanup NSS and NSPR may result in
-    // a deadlock. Such repeated initialization will happen when using test
-    // isolation. Prevent problems by initializing NSS here, so that the cleanup
-    // will be done only on process exit.
-    base::EnsureNSSInit();
-#endif  // defined(USE_NSS)
-
-    CatchMaybeTests();
-  }
-
-  virtual void Shutdown() {
-  }
+  virtual void Initialize();
+  virtual void Shutdown();
 
   // Make sure that we setup an AtExitManager so Singleton objects will be
   // destroyed.
   base::AtExitManager at_exit_manager_;
+
+  DISALLOW_COPY_AND_ASSIGN(TestSuite);
 };
 
+}  // namespace base
+
+// TODO(brettw) remove this. This is a temporary hack to allow WebKit to compile
+// until we can update it to use "base::" (preventing a two-sided patch).
+using base::TestSuite;
+
 #endif  // BASE_TEST_TEST_SUITE_H_