blob: d23678299b758b9d073189447a24c4d5cae10ac6 [file] [log] [blame]
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <set>
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "base/test/scoped_task_environment.h"
#include "extensions/renderer/module_system.h"
#include "extensions/renderer/script_context.h"
#include "extensions/renderer/script_context_set.h"
#include "extensions/renderer/test_extensions_renderer_client.h"
#include "gin/public/context_holder.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "v8/include/v8.h"
namespace extensions {
class Extension;
class NativeExtensionBindingsSystem;
class StringSourceMap;
class ModuleSystemTestEnvironment {
class AssertNatives;
ModuleSystemTestEnvironment(v8::Isolate* isolate,
ScriptContextSet* context_set,
scoped_refptr<const Extension> extension);
// Register a named JS module in the module system.
void RegisterModule(const std::string& name, const std::string& code);
// Register a named JS module with source retrieved from a ResourceBundle.
void RegisterModule(const std::string& name,
int resource_id,
bool gzipped = false);
// Register a named JS module in the module system and tell the module system
// to use it to handle any requireNative() calls for native modules with that
// name.
void OverrideNativeHandler(const std::string& name, const std::string& code);
// Registers |file_name| from chrome/test/data/extensions as a module name
// |module_name|.
void RegisterTestFile(const std::string& module_name,
const std::string& file_name);
// Create an empty object in the global scope with name |name|.
v8::Local<v8::Object> CreateGlobal(const std::string& name);
void ShutdownGin();
void ShutdownModuleSystem();
ModuleSystem* module_system() { return context_->module_system(); }
ScriptContext* context() { return context_; }
v8::Isolate* isolate() { return isolate_; }
StringSourceMap* source_map() { return source_map_.get(); }
AssertNatives* assert_natives() { return assert_natives_; }
v8::Isolate* isolate_;
std::unique_ptr<gin::ContextHolder> context_holder_;
v8::HandleScope handle_scope_;
scoped_refptr<const Extension> extension_;
ScriptContextSet* context_set_;
ScriptContext* context_;
AssertNatives* assert_natives_;
std::unique_ptr<StringSourceMap> source_map_;
std::unique_ptr<NativeExtensionBindingsSystem> bindings_system_;
// Test fixture for testing JS that makes use of the module system.
// Typically tests will look like:
// TEST_F(MyModuleSystemTest, TestStuff) {
// ModuleSystem::NativesEnabledScope natives_enabled(module_system_.get());
// RegisterModule("test", "requireNative('assert').AssertTrue(true);");
// module_system_->Require("test");
// }
// By default a test will fail if no method in the native module 'assert' is
// called. This behaviour can be overridden by calling ExpectNoAssertionsMade().
class ModuleSystemTest : public testing::Test {
~ModuleSystemTest() override;
void SetUp() override;
void TearDown() override;
ModuleSystemTestEnvironment* env() { return env_.get(); }
// Create the extension used with the ModuleSystemTestEnvironment. Virtual so
// that subclasses can return extensions with different features.
virtual scoped_refptr<const Extension> CreateExtension();
std::unique_ptr<ModuleSystemTestEnvironment> CreateEnvironment();
// Make the test fail if any asserts are called. By default a test will fail
// if no asserts are called.
void ExpectNoAssertionsMade();
// Runs promises that have been resolved. Resolved promises will not run
// until this is called.
void RunResolvedPromises();
base::test::ScopedTaskEnvironment scoped_task_environment_;
v8::Isolate* isolate_;
std::set<std::string> extension_ids_;
ScriptContextSet context_set_;
TestExtensionsRendererClient renderer_client_;
scoped_refptr<const Extension> extension_;
std::unique_ptr<ModuleSystemTestEnvironment> env_;
bool should_assertions_be_made_;
} // namespace extensions