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 "chrome/test/base/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 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(CommandLine* command_line) OVERRIDE; 66 67 virtual void SetUpInProcessBrowserTestFixture() 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 virtual bool IsPnaclDisabled(); 80 81 // Map a file relative to the variant directory to a URL served by the test 82 // web server. 83 GURL TestURL(const base::FilePath::StringType& url_fragment); 84 85 // Load a URL and listen to automation events with a given handler. 86 // Returns true if the test glue function correctly. (The handler should 87 // seperately indicate if the test failed.) 88 bool RunJavascriptTest(const GURL& url, TestMessageHandler* handler); 89 90 // Run a simple test that checks that a nexe loads correctly. Useful for 91 // setting up other tests, such as checking that UMA data was logged. 92 void RunLoadTest(const base::FilePath::StringType& test_file); 93 94 // Run a test that was originally written to use NaCl's integration testing 95 // jig. These tests were originally driven by NaCl's SCons build in the 96 // nacl_integration test stage on the Chrome waterfall. Changes in the 97 // boundaries between the Chrome and NaCl repos have resulted in many of 98 // these tests having a stronger affinity with the Chrome repo. This method 99 // provides a compatibility layer to simplify turning nacl_integration tests 100 // into browser tests. 101 void RunNaClIntegrationTest(const base::FilePath::StringType& url_fragment); 102 103 private: 104 bool StartTestServer(); 105 106 scoped_ptr<net::SpawnedTestServer> test_server_; 107 }; 108 109 class NaClBrowserTestNewlib : public NaClBrowserTestBase { 110 public: 111 virtual base::FilePath::StringType Variant() OVERRIDE; 112 }; 113 114 class NaClBrowserTestGLibc : public NaClBrowserTestBase { 115 public: 116 virtual base::FilePath::StringType Variant() OVERRIDE; 117 }; 118 119 class NaClBrowserTestPnacl : public NaClBrowserTestBase { 120 public: 121 virtual base::FilePath::StringType Variant() OVERRIDE; 122 123 virtual bool IsAPnaclTest() OVERRIDE; 124 }; 125 126 // Class used to test that when --disable-pnacl is specified the PNaCl mime 127 // type is not available. 128 class NaClBrowserTestPnaclDisabled : public NaClBrowserTestBase { 129 public: 130 virtual void SetUpCommandLine(CommandLine* command_line) OVERRIDE; 131 132 virtual base::FilePath::StringType Variant() OVERRIDE; 133 134 virtual bool IsAPnaclTest() OVERRIDE; 135 136 virtual bool IsPnaclDisabled() 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 // PNaCl tests take a long time on windows debug builds 147 // and sometimes time out. Disable until it is made faster: 148 // https://code.google.com/p/chromium/issues/detail?id=177555 149 #if (defined(OS_WIN) && !defined(NDEBUG)) 150 #define MAYBE_PNACL(test_name) DISABLED_##test_name 151 #else 152 #define MAYBE_PNACL(test_name) test_name 153 #endif 154 155 #if defined(ARCH_CPU_ARM_FAMILY) 156 157 // There is no support for Glibc on ARM NaCl. 158 #define NACL_BROWSER_TEST_F(suite, name, body) \ 159 IN_PROC_BROWSER_TEST_F(suite##Newlib, name) \ 160 body 161 162 #else 163 164 // Otherwise, we have Glibc, Newlib and Pnacl tests 165 #define NACL_BROWSER_TEST_F(suite, name, body) \ 166 IN_PROC_BROWSER_TEST_F(suite##Newlib, name) \ 167 body \ 168 IN_PROC_BROWSER_TEST_F(suite##GLibc, name) \ 169 body \ 170 IN_PROC_BROWSER_TEST_F(suite##Pnacl, MAYBE_PNACL(name)) \ 171 body 172 173 #endif 174 175 #endif // CHROME_TEST_NACL_NACL_BROWSERTEST_UTIL_H_ 176
