1 // Copyright (c) 2013 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.
8 #include "base/files/file_path.h"
9 #include "base/memory/scoped_ptr.h"
10 #include "base/stl_util.h"
11 #include "base/strings/utf_string_conversions.h"
12 #include "chrome/common/extensions/extension.h"
13 #include "chrome/common/extensions/extension_builder.h"
14 #include "chrome/common/extensions/manifest_handler.h"
15 #include "chrome/common/extensions/value_builder.h"
16 #include "extensions/common/install_warning.h"
17 #include "testing/gtest/include/gtest/gtest.h"
19 namespace extensions {
23 std::vector<std::string> SingleKey(const std::string& key) {
24 return std::vector<std::string>(1, key);
29 class ScopedTestingManifestHandlerRegistry {
31 ScopedTestingManifestHandlerRegistry() {
32 old_registry_ = ManifestHandlerRegistry::SetForTesting(®istry_);
35 ~ScopedTestingManifestHandlerRegistry() {
36 ManifestHandlerRegistry::SetForTesting(old_registry_);
39 ManifestHandlerRegistry registry_;
40 ManifestHandlerRegistry* old_registry_;
43 class ManifestHandlerTest : public testing::Test {
45 class ParsingWatcher {
47 // Called when a manifest handler parses.
48 void Record(const std::string& name) {
49 parsed_names_.push_back(name);
52 const std::vector<std::string>& parsed_names() {
56 // Returns true if |name_before| was parsed before |name_after|.
57 bool ParsedBefore(const std::string& name_before,
58 const std::string& name_after) {
59 size_t i_before = parsed_names_.size();
61 for (size_t i = 0; i < parsed_names_.size(); ++i) {
62 if (parsed_names_[i] == name_before)
64 if (parsed_names_[i] == name_after)
67 if (i_before < i_after)
73 // The order of manifest handlers that we watched parsing.
74 std::vector<std::string> parsed_names_;
77 class TestManifestHandler : public ManifestHandler {
79 TestManifestHandler(const std::string& name,
80 const std::vector<std::string>& keys,
81 const std::vector<std::string>& prereqs,
82 ParsingWatcher* watcher)
83 : name_(name), keys_(keys), prereqs_(prereqs), watcher_(watcher) {
86 virtual bool Parse(Extension* extension, string16* error) OVERRIDE {
87 watcher_->Record(name_);
91 virtual const std::vector<std::string> PrerequisiteKeys() const OVERRIDE {
97 std::vector<std::string> keys_;
98 std::vector<std::string> prereqs_;
99 ParsingWatcher* watcher_;
101 virtual const std::vector<std::string> Keys() const OVERRIDE {
106 class FailingTestManifestHandler : public TestManifestHandler {
108 FailingTestManifestHandler(const std::string& name,
109 const std::vector<std::string>& keys,
110 const std::vector<std::string>& prereqs,
111 ParsingWatcher* watcher)
112 : TestManifestHandler(name, keys, prereqs, watcher) {
114 virtual bool Parse(Extension* extension, string16* error) OVERRIDE {
115 *error = ASCIIToUTF16(name_);
120 class AlwaysParseTestManifestHandler : public TestManifestHandler {
122 AlwaysParseTestManifestHandler(const std::string& name,
123 const std::vector<std::string>& keys,
124 const std::vector<std::string>& prereqs,
125 ParsingWatcher* watcher)
126 : TestManifestHandler(name, keys, prereqs, watcher) {
129 virtual bool AlwaysParseForType(Manifest::Type type) const OVERRIDE {
134 class TestManifestValidator : public ManifestHandler {
136 TestManifestValidator(bool return_value,
137 bool always_validate,
138 std::vector<std::string> keys)
139 : return_value_(return_value),
140 always_validate_(always_validate),
144 virtual bool Parse(Extension* extension, string16* error) OVERRIDE {
148 virtual bool Validate(
149 const Extension* extension,
151 std::vector<InstallWarning>* warnings) const OVERRIDE {
152 return return_value_;
155 virtual bool AlwaysValidateForType(Manifest::Type type) const OVERRIDE {
156 return always_validate_;
160 virtual const std::vector<std::string> Keys() const OVERRIDE {
166 bool always_validate_;
167 std::vector<std::string> keys_;
171 TEST_F(ManifestHandlerTest, DependentHandlers) {
172 ScopedTestingManifestHandlerRegistry registry;
173 ParsingWatcher watcher;
174 std::vector<std::string> prereqs;
175 (new TestManifestHandler("A", SingleKey("a"), prereqs, &watcher))->Register();
176 (new TestManifestHandler("B", SingleKey("b"), prereqs, &watcher))->Register();
177 (new TestManifestHandler("J", SingleKey("j"), prereqs, &watcher))->Register();
178 (new AlwaysParseTestManifestHandler("K", SingleKey("k"), prereqs, &watcher))->
180 prereqs.push_back("c.d");
181 std::vector<std::string> keys;
182 keys.push_back("c.e");
183 keys.push_back("c.z");
184 (new TestManifestHandler("C.EZ", keys, prereqs, &watcher))->Register();
186 prereqs.push_back("b");
187 prereqs.push_back("k");
188 (new TestManifestHandler("C.D", SingleKey("c.d"), prereqs, &watcher))->
190 ManifestHandler::FinalizeRegistration();
192 scoped_refptr<Extension> extension = ExtensionBuilder()
193 .SetManifest(DictionaryBuilder()
194 .Set("name", "no name")
196 .Set("manifest_version", 2)
199 .Set("c", DictionaryBuilder()
206 // A, B, C.EZ, C.D, K
207 EXPECT_EQ(5u, watcher.parsed_names().size());
208 EXPECT_TRUE(watcher.ParsedBefore("B", "C.D"));
209 EXPECT_TRUE(watcher.ParsedBefore("K", "C.D"));
210 EXPECT_TRUE(watcher.ParsedBefore("C.D", "C.EZ"));
213 TEST_F(ManifestHandlerTest, FailingHandlers) {
214 ScopedTestingManifestHandlerRegistry registry;
215 // Can't use ExtensionBuilder, because this extension will fail to
217 scoped_ptr<base::DictionaryValue> manifest_a(
219 .Set("name", "no name")
221 .Set("manifest_version", 2)
225 // Succeeds when "a" is not recognized.
227 scoped_refptr<Extension> extension = Extension::Create(
229 Manifest::INVALID_LOCATION,
233 EXPECT_TRUE(extension.get());
235 // Register a handler for "a" that fails.
236 ParsingWatcher watcher;
237 (new FailingTestManifestHandler(
238 "A", SingleKey("a"), std::vector<std::string>(), &watcher))->Register();
239 ManifestHandler::FinalizeRegistration();
241 extension = Extension::Create(
243 Manifest::INVALID_LOCATION,
247 EXPECT_FALSE(extension.get());
248 EXPECT_EQ("A", error);
251 TEST_F(ManifestHandlerTest, Validate) {
252 ScopedTestingManifestHandlerRegistry registry;
253 scoped_refptr<Extension> extension = ExtensionBuilder()
254 .SetManifest(DictionaryBuilder()
255 .Set("name", "no name")
257 .Set("manifest_version", 2)
261 EXPECT_TRUE(extension.get());
264 std::vector<InstallWarning> warnings;
265 // Always validates and fails.
266 (new TestManifestValidator(false, true, SingleKey("c")))->Register();
268 ManifestHandler::ValidateExtension(extension.get(), &error, &warnings));
270 // This overrides the registered handler for "c".
271 (new TestManifestValidator(false, false, SingleKey("c")))->Register();
273 ManifestHandler::ValidateExtension(extension.get(), &error, &warnings));
275 // Validates "a" and fails.
276 (new TestManifestValidator(false, true, SingleKey("a")))->Register();
278 ManifestHandler::ValidateExtension(extension.get(), &error, &warnings));
281 } // namespace extensions