123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153 |
- // 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.
- #ifndef EXTENSIONS_RENDERER_MODULE_SYSTEM_TEST_H_
- #define EXTENSIONS_RENDERER_MODULE_SYSTEM_TEST_H_
- #include <set>
- #include "base/memory/ref_counted.h"
- #include "base/test/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 "gin/public/isolate_holder.h"
- #include "testing/gtest/include/gtest/gtest.h"
- #include "v8/include/v8-forward.h"
- namespace extensions {
- class Extension;
- class NativeExtensionBindingsSystem;
- class StringSourceMap;
- class ModuleSystemTestEnvironment {
- public:
- class AssertNatives;
- ModuleSystemTestEnvironment(v8::Isolate* isolate,
- ScriptContextSet* context_set,
- scoped_refptr<const Extension> extension);
- ModuleSystemTestEnvironment(const ModuleSystemTestEnvironment&) = delete;
- ModuleSystemTestEnvironment& operator=(const ModuleSystemTestEnvironment&) =
- delete;
- ~ModuleSystemTestEnvironment();
- // 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);
- // Registers a native field in the ModuleSystem.
- void SetLazyField(v8::Local<v8::Object> object,
- const std::string& field,
- const std::string& module_name,
- const std::string& module_field);
- 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_; }
- private:
- 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 {
- public:
- ModuleSystemTest();
- ModuleSystemTest(const ModuleSystemTest&) = delete;
- ModuleSystemTest& operator=(const ModuleSystemTest&) = delete;
- ~ModuleSystemTest() override;
- void SetUp() override;
- void TearDown() override;
- protected:
- 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();
- private:
- base::test::TaskEnvironment task_environment_;
- gin::IsolateHolder isolate_holder_;
- 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
- #endif // EXTENSIONS_RENDERER_MODULE_SYSTEM_TEST_H_
|