1 // Copyright (c) 2012 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 CHROME_TEST_NACL_NACL_BROWSERTEST_UTIL_H_ 6 #define CHROME_TEST_NACL_NACL_BROWSERTEST_UTIL_H_ 7 8 #include "base/files/file_path.h" 9 #include "base/memory/scoped_ptr.h" 10 #include "chrome/test/base/in_process_browser_test.h" 11 #include "content/public/test/javascript_test_observer.h" 12 13 // A helper base class that decodes structured automation messages of the form: 14 // {"type": type_name, ...} 15 class StructuredMessageHandler : public content::TestMessageHandler { 16 public: 17 virtual MessageResponse HandleMessage(const std::string& json) OVERRIDE; 18 19 // This method provides a higher-level interface for handling JSON messages 20 // from the DOM automation controler. Instead of handling a string 21 // containing a JSON-encoded object, this specialization of TestMessageHandler 22 // decodes the string into a dictionary. This makes it easier to send and 23 // receive structured messages. It is assumed the dictionary will always have 24 // a "type" field that indicates the nature of message. 25 virtual MessageResponse HandleStructuredMessage( 26 const std::string& type, 27 base::DictionaryValue* msg) = 0; 28 29 protected: 30 // The structured message is missing an expected field. 31 MessageResponse MissingField( 32 const std::string& type, 33 const std::string& field) WARN_UNUSED_RESULT; 34 35 // Something went wrong while decoding the message. 36 MessageResponse InternalError(const std::string& reason) WARN_UNUSED_RESULT; 37 }; 38 39 // A simple structured message handler for tests that load nexes. 40 class LoadTestMessageHandler : public StructuredMessageHandler { 41 public: 42 LoadTestMessageHandler(); 43 44 void Log(const std::string& type, const std::string& message); 45 46 virtual MessageResponse HandleStructuredMessage( 47 const std::string& type, 48 base::DictionaryValue* msg) OVERRIDE; 49 50 bool test_passed() const { 51 return test_passed_; 52 } 53 54 private: 55 bool test_passed_; 56 57 DISALLOW_COPY_AND_ASSIGN(LoadTestMessageHandler); 58 }; 59 60 class NaClBrowserTestBase : public InProcessBrowserTest { 61 public: 62 NaClBrowserTestBase(); 63 virtual ~NaClBrowserTestBase(); 64 65 virtual void SetUpCommandLine(base::CommandLine* command_line) OVERRIDE; 66 67 virtual void SetUpOnMainThread() OVERRIDE; 68 69 // What variant are we running - newlib, glibc, pnacl, etc? 70 // This is used to compute what directory we're pulling data from, but it can 71 // also be used to affect the behavior of the test. 72 virtual base::FilePath::StringType Variant() = 0; 73 74 // Where are the files for this class of test located on disk? 75 virtual bool GetDocumentRoot(base::FilePath* document_root); 76 77 virtual bool IsAPnaclTest(); 78 79 // Map a file relative to the variant directory to a URL served by the test 80 // web server. 81 GURL TestURL(const base::FilePath::StringType& url_fragment); 82 83 // Load a URL and listen to automation events with a given handler. 84 // Returns true if the test glue function correctly. (The handler should 85 // seperately indicate if the test failed.) 86 bool RunJavascriptTest(const GURL& url, content::TestMessageHandler* handler); 87 88 // Run a simple test that checks that a nexe loads correctly. Useful for 89 // setting up other tests, such as checking that UMA data was logged. 90 void RunLoadTest(const base::FilePath::StringType& test_file); 91 92 // Run a test that was originally written to use NaCl's integration testing 93 // jig. These tests were originally driven by NaCl's SCons build in the 94 // nacl_integration test stage on the Chrome waterfall. Changes in the 95 // boundaries between the Chrome and NaCl repos have resulted in many of 96 // these tests having a stronger affinity with the Chrome repo. This method 97 // provides a compatibility layer to simplify turning nacl_integration tests 98 // into browser tests. 99 // |full_url| is true if the full URL is given, otherwise it is a 100 // relative URL. 101 void RunNaClIntegrationTest(const base::FilePath::StringType& url, 102 bool full_url = false); 103 104 private: 105 bool StartTestServer(); 106 107 scoped_ptr<net::SpawnedTestServer> test_server_; 108 }; 109 110 class NaClBrowserTestNewlib : public NaClBrowserTestBase { 111 public: 112 virtual base::FilePath::StringType Variant() OVERRIDE; 113 }; 114 115 class NaClBrowserTestGLibc : public NaClBrowserTestBase { 116 public: 117 virtual base::FilePath::StringType Variant() OVERRIDE; 118 }; 119 120 class NaClBrowserTestPnacl : public NaClBrowserTestBase { 121 public: 122 virtual base::FilePath::StringType Variant() OVERRIDE; 123 124 virtual bool IsAPnaclTest() OVERRIDE; 125 }; 126 127 class NaClBrowserTestPnaclNonSfi : public NaClBrowserTestBase { 128 public: 129 virtual void SetUpCommandLine(base::CommandLine* command_line) OVERRIDE; 130 virtual base::FilePath::StringType Variant() OVERRIDE; 131 }; 132 133 class NaClBrowserTestNonSfiMode : public NaClBrowserTestBase { 134 public: 135 virtual void SetUpCommandLine(base::CommandLine* command_line) OVERRIDE; 136 virtual base::FilePath::StringType Variant() OVERRIDE; 137 }; 138 139 // A NaCl browser test only using static files. 140 class NaClBrowserTestStatic : public NaClBrowserTestBase { 141 public: 142 virtual base::FilePath::StringType Variant() OVERRIDE; 143 virtual bool GetDocumentRoot(base::FilePath* document_root) OVERRIDE; 144 }; 145 146 // A NaCl browser test that loads from an unpacked chrome extension. 147 // The directory of the unpacked extension files is determined by 148 // the tester's document root. 149 class NaClBrowserTestNewlibExtension : public NaClBrowserTestNewlib { 150 public: 151 virtual void SetUpCommandLine(base::CommandLine* command_line) OVERRIDE; 152 }; 153 154 class NaClBrowserTestGLibcExtension : public NaClBrowserTestGLibc { 155 public: 156 virtual void SetUpCommandLine(base::CommandLine* command_line) OVERRIDE; 157 }; 158 159 // PNaCl tests take a long time on windows debug builds 160 // and sometimes time out. Disable until it is made faster: 161 // https://code.google.com/p/chromium/issues/detail?id=177555 162 #if (defined(OS_WIN) && !defined(NDEBUG)) 163 # define MAYBE_PNACL(test_name) DISABLED_##test_name 164 #else 165 # define MAYBE_PNACL(test_name) test_name 166 #endif 167 168 // NaCl glibc tests are included for x86 only, as there is no glibc support 169 // for other architectures (ARM/MIPS). 170 #if defined(ARCH_CPU_X86_FAMILY) 171 # define MAYBE_GLIBC(test_name) test_name 172 #else 173 # define MAYBE_GLIBC(test_name) DISABLED_##test_name 174 #endif 175 176 // Sanitizers internally use some syscalls which non-SFI NaCl disallows. 177 #if defined(OS_LINUX) && !defined(ADDRESS_SANITIZER) && \ 178 !defined(THREAD_SANITIZER) && !defined(MEMORY_SANITIZER) && \ 179 !defined(LEAK_SANITIZER) 180 # define MAYBE_NONSFI(test_case) test_case 181 #else 182 # define MAYBE_NONSFI(test_case) DISABLED_##test_case 183 #endif 184 185 // Currently, translation from pexe to non-sfi nexe is supported only for 186 // x86-32 binary. 187 #if defined(OS_LINUX) && defined(ARCH_CPU_X86) 188 # define MAYBE_PNACL_NONSFI(test_case) test_case 189 #else 190 # define MAYBE_PNACL_NONSFI(test_case) DISABLED_##test_case 191 #endif 192 193 #define NACL_BROWSER_TEST_F(suite, name, body) \ 194 IN_PROC_BROWSER_TEST_F(suite##Newlib, name) \ 195 body \ 196 IN_PROC_BROWSER_TEST_F(suite##GLibc, MAYBE_GLIBC(name)) \ 197 body \ 198 IN_PROC_BROWSER_TEST_F(suite##Pnacl, MAYBE_PNACL(name)) \ 199 body 200 201 #endif // CHROME_TEST_NACL_NACL_BROWSERTEST_UTIL_H_ 202
