// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_TEST_NACL_NACL_BROWSERTEST_UTIL_H_
#define CHROME_TEST_NACL_NACL_BROWSERTEST_UTIL_H_
#include <memory>
#include "base/files/file_path.h"
#include "base/test/scoped_feature_list.h"
#include "base/values.h"
#include "build/build_config.h"
#include "chrome/browser/extensions/scoped_test_mv2_enabler.h"
#include "chrome/test/base/in_process_browser_test.h"
#include "content/public/test/javascript_test_observer.h"
#include "net/test/embedded_test_server/embedded_test_server.h"
// A helper base class that decodes structured automation messages of the form:
// {"type": type_name, ...}
class StructuredMessageHandler : public content::TestMessageHandler {
public:
MessageResponse HandleMessage(const std::string& json) override;
// This method provides a higher-level interface for handling JSON messages
// from the DOM automation controler. Instead of handling a string
// containing a JSON-encoded object, this specialization of TestMessageHandler
// decodes the string into a dictionary. This makes it easier to send and
// receive structured messages. It is assumed the dictionary will always have
// a "type" field that indicates the nature of message.
virtual MessageResponse HandleStructuredMessage(
const std::string& type,
const base::Value::Dict& msg) = 0;
protected:
// The structured message is missing an expected field.
[[nodiscard]] MessageResponse MissingField(const std::string& type,
const std::string& field);
// Something went wrong while decoding the message.
[[nodiscard]] MessageResponse InternalError(const std::string& reason);
};
// A simple structured message handler for tests that load nexes.
class LoadTestMessageHandler : public StructuredMessageHandler {
public:
LoadTestMessageHandler();
LoadTestMessageHandler(const LoadTestMessageHandler&) = delete;
LoadTestMessageHandler& operator=(const LoadTestMessageHandler&) = delete;
void Log(const std::string& type, const std::string& message);
MessageResponse HandleStructuredMessage(
const std::string& type,
const base::Value::Dict& msg) override;
bool test_passed() const {
return test_passed_;
}
private:
bool test_passed_;
};
class NaClBrowserTestBase : public InProcessBrowserTest {
public:
NaClBrowserTestBase();
~NaClBrowserTestBase() override;
void SetUpCommandLine(base::CommandLine* command_line) override;
void SetUpOnMainThread() override;
// What variant are we running - newlib, glibc, pnacl, etc?
// This is used to compute what directory we're pulling data from, but it can
// also be used to affect the behavior of the test.
virtual base::FilePath::StringType Variant() = 0;
// Where are the files for this class of test located on disk?
virtual bool GetDocumentRoot(base::FilePath* document_root);
virtual bool IsAPnaclTest();
// Map a file relative to the variant directory to a URL served by the test
// web server.
GURL TestURL(const base::FilePath::StringType& url_fragment);
// Load a URL and listen to automation events with a given handler.
// Returns true if the test glue function correctly. (The handler should
// seperately indicate if the test failed.)
bool RunJavascriptTest(const GURL& url, content::TestMessageHandler* handler);
// Run a simple test that checks that a nexe loads correctly. Useful for
// setting up other tests, such as checking that UMA data was logged.
void RunLoadTest(const base::FilePath::StringType& test_file);
// Run a test that was originally written to use NaCl's integration testing
// jig. These tests were originally driven by NaCl's SCons build in the
// nacl_integration test stage on the Chrome waterfall. Changes in the
// boundaries between the Chrome and NaCl repos have resulted in many of
// these tests having a stronger affinity with the Chrome repo. This method
// provides a compatibility layer to simplify turning nacl_integration tests
// into browser tests.
// |full_url| is true if the full URL is given, otherwise it is a
// relative URL.
void RunNaClIntegrationTest(const base::FilePath::StringType& url,
bool full_url = false);
private:
bool StartTestServer();
base::test::ScopedFeatureList feature_list_;
std::unique_ptr<net::EmbeddedTestServer> test_server_;
};
class NaClBrowserTestNewlib : public NaClBrowserTestBase {
public:
base::FilePath::StringType Variant() override;
};
class NaClBrowserTestGLibc : public NaClBrowserTestBase {
public:
base::FilePath::StringType Variant() override;
};
class NaClBrowserTestPnacl : public NaClBrowserTestBase {
public:
base::FilePath::StringType Variant() override;
bool IsAPnaclTest() override;
};
class NaClBrowserTestIrt : public NaClBrowserTestBase {
public:
base::FilePath::StringType Variant() override;
};
// TODO(jvoung): We can remove this and test the Subzero translator
// with NaClBrowserTestPnacl once Subzero is automatically chosen
// (not behind a flag).
class NaClBrowserTestPnaclSubzero : public NaClBrowserTestPnacl {
public:
void SetUpCommandLine(base::CommandLine* command_line) override;
};
// A NaCl browser test only using static files.
class NaClBrowserTestStatic : public NaClBrowserTestBase {
public:
base::FilePath::StringType Variant() override;
bool GetDocumentRoot(base::FilePath* document_root) override;
};
// A NaCl browser test that loads from an unpacked chrome extension.
// The directory of the unpacked extension files is determined by
// the tester's document root.
class NaClBrowserTestNewlibExtension : public NaClBrowserTestNewlib {
public:
void SetUpCommandLine(base::CommandLine* command_line) override;
// TODO(https://crbug.com/40804030): Remove when these tests use only MV3
// extensions.
extensions::ScopedTestMV2Enabler mv2_enabler_;
};
class NaClBrowserTestGLibcExtension : public NaClBrowserTestGLibc {
public:
void SetUpCommandLine(base::CommandLine* command_line) override;
// TODO(https://crbug.com/40804030): Remove when these tests use only MV3
// extensions.
extensions::ScopedTestMV2Enabler mv2_enabler_;
};
#if (BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)) && \
defined(ADDRESS_SANITIZER)
// NaClBrowserTestPnacl tests are very flaky on ASan, see crbug.com/1003259.
# define MAYBE_PNACL(test_name) DISABLED_##test_name
#else
# define MAYBE_PNACL(test_name) test_name
#endif
// NaCl glibc toolchain is not available on MIPS
#if defined(ARCH_CPU_MIPS_FAMILY)
# define MAYBE_GLIBC(test_name) DISABLED_##test_name
#else
# define MAYBE_GLIBC(test_name) test_name
#endif
#define NACL_BROWSER_TEST_F(suite, name, body) \
IN_PROC_BROWSER_TEST_F(suite##Newlib, name) \
body \
IN_PROC_BROWSER_TEST_F(suite##GLibc, MAYBE_GLIBC(name)) \
body \
IN_PROC_BROWSER_TEST_F(suite##Pnacl, MAYBE_PNACL(name)) \
body
#endif // CHROME_TEST_NACL_NACL_BROWSERTEST_UTIL_H_
Codebase Browser
chromium