mojo/common/test/multiprocess_test_base.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef MOJO_COMMON_TEST_MULTIPROCESS_TEST_BASE_H_
   6 #define MOJO_COMMON_TEST_MULTIPROCESS_TEST_BASE_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/compiler_specific.h"
  12 #include "base/process/process_handle.h"
  13 #include "base/test/multiprocess_test.h"
  14 #include "mojo/system/embedder/scoped_platform_handle.h"
  15 #include "testing/multiprocess_func_list.h"
  16
  17 namespace mojo {
  18
  19 namespace embedder {
  20 class PlatformChannelPair;
  21 }
  22
  23 namespace test {
  24
  25 class MultiprocessTestBase : public base::MultiProcessTest {
  26  public:
  27   MultiprocessTestBase();
  28   virtual ~MultiprocessTestBase();
  29
  30   virtual void SetUp() OVERRIDE;
  31   virtual void TearDown() OVERRIDE;
  32
  33   // Start a child process and run the "main" function "named" |test_child_name|
  34   // declared using |MOJO_MULTIPROCESS_TEST_CHILD_MAIN()| (below).
  35   void StartChild(const std::string& test_child_name);
  36   // Wait for the child process to terminate.
  37   // Returns the exit code of the child process. Note that, though it's declared
  38   // to be an |int|, the exit code is subject to mangling by the OS. E.g., we
  39   // usually return -1 on error in the child (e.g., if |test_child_name| was not
  40   // found), but this is mangled to 255 on Linux. You should only rely on codes
  41   // 0-127 being preserved, and -1 being outside the range 0-127.
  42   int WaitForChildShutdown();
  43
  44   // For use by |MOJO_MULTIPROCESS_TEST_CHILD_MAIN()| only:
  45   static void ChildSetup();
  46
  47   // For use in the main process:
  48   embedder::ScopedPlatformHandle server_platform_handle;
  49
  50   // For use (and only valid) in the child process:
  51   static embedder::ScopedPlatformHandle client_platform_handle;
  52
  53  private:
  54   virtual CommandLine MakeCmdLine(const std::string& procname,
  55                                   bool debug_on_start) OVERRIDE;
  56
  57   scoped_ptr<embedder::PlatformChannelPair> platform_channel_pair_;
  58
  59   // Valid after |StartChild()| and before |WaitForChildShutdown()|.
  60   base::ProcessHandle test_child_handle_;
  61
  62   DISALLOW_COPY_AND_ASSIGN(MultiprocessTestBase);
  63 };
  64
  65 // Use this to declare the child process's "main()" function for tests using
  66 // |MultiprocessTestBase|. It returns an |int|, which will be the process's exit
  67 // code (but see the comment about |WaitForChildShutdown()|).
  68 #define MOJO_MULTIPROCESS_TEST_CHILD_MAIN(test_child_name) \
  69     MULTIPROCESS_TEST_MAIN_WITH_SETUP( \
  70         test_child_name ## TestChildMain, \
  71         ::mojo::test::MultiprocessTestBase::ChildSetup)
  72
  73 }  // namespace test
  74 }  // namespace mojo
  75
  76 #endif  // MOJO_COMMON_TEST_MULTIPROCESS_TEST_BASE_H_