nacl_browsertest_util.h revision eb525c5499e34cc9c4b825d6d9e75bb07cc06ace
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, ...} 15class 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. 40class 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 60class 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 IsPnacl(); 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, 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 void RunNaClIntegrationTest(const base::FilePath::StringType& url_fragment); 100 101 private: 102 bool StartTestServer(); 103 104 scoped_ptr<net::SpawnedTestServer> test_server_; 105}; 106 107class NaClBrowserTestNewlib : public NaClBrowserTestBase { 108 public: 109 virtual base::FilePath::StringType Variant() OVERRIDE; 110}; 111 112class NaClBrowserTestGLibc : public NaClBrowserTestBase { 113 public: 114 virtual base::FilePath::StringType Variant() OVERRIDE; 115}; 116 117class NaClBrowserTestPnacl : public NaClBrowserTestBase { 118 public: 119 virtual void SetUpCommandLine(CommandLine* command_line) OVERRIDE; 120 121 virtual base::FilePath::StringType Variant() OVERRIDE; 122 123 virtual bool IsPnacl() OVERRIDE; 124}; 125 126// Temporary class for running tests with the new cache enabled. Once all the 127// pieces land, this will go away and the new cache will be on by default. 128class NaClBrowserTestPnaclWithNewCache : public NaClBrowserTestPnacl { 129 public: 130 NaClBrowserTestPnaclWithNewCache(); 131}; 132 133// A NaCl browser test only using static files. 134class NaClBrowserTestStatic : public NaClBrowserTestBase { 135 public: 136 virtual base::FilePath::StringType Variant() OVERRIDE; 137 virtual bool GetDocumentRoot(base::FilePath* document_root) OVERRIDE; 138}; 139 140// PNaCl's cache and PPB_FileIO currently trip up under ASAN: 141// https://code.google.com/p/chromium/issues/detail?id=171810 142// PNaCl tests take a long time on windows debug builds 143// and sometimes time out. Disable until it is made faster: 144// https://code.google.com/p/chromium/issues/detail?id=177555 145#if defined(ADDRESS_SANITIZER) || (defined(OS_WIN) && !defined(NDEBUG)) 146#define MAYBE_PNACL(test_name) DISABLED_##test_name 147#else 148#define MAYBE_PNACL(test_name) test_name 149#endif 150 151#if defined(ARCH_CPU_ARM_FAMILY) 152 153// There is no support for Glibc on ARM NaCl. 154#define NACL_BROWSER_TEST_F(suite, name, body) \ 155IN_PROC_BROWSER_TEST_F(suite##Newlib, name) \ 156body 157 158#else 159 160// Otherwise, we have Glibc, Newlib and PNaCl tests 161#define NACL_BROWSER_TEST_F(suite, name, body) \ 162IN_PROC_BROWSER_TEST_F(suite##Newlib, name) \ 163body \ 164IN_PROC_BROWSER_TEST_F(suite##GLibc, name) \ 165body \ 166IN_PROC_BROWSER_TEST_F(suite##Pnacl, MAYBE_PNACL(name)) \ 167body 168 169#endif 170 171#endif // CHROME_TEST_NACL_NACL_BROWSERTEST_UTIL_H_ 172