OLD | NEW |
| (Empty) |
1 // Copyright 2014 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 #include "chrome/browser/extensions/extension_user_script_loader.h" | |
6 | |
7 #include <set> | |
8 #include <string> | |
9 | |
10 #include "base/files/file_path.h" | |
11 #include "base/files/file_util.h" | |
12 #include "base/files/scoped_temp_dir.h" | |
13 #include "base/message_loop/message_loop.h" | |
14 #include "base/strings/string_util.h" | |
15 #include "chrome/browser/chrome_notification_types.h" | |
16 #include "chrome/test/base/testing_profile.h" | |
17 #include "content/public/browser/notification_observer.h" | |
18 #include "content/public/browser/notification_registrar.h" | |
19 #include "content/public/browser/notification_service.h" | |
20 #include "content/public/test/test_browser_thread.h" | |
21 #include "extensions/common/host_id.h" | |
22 #include "testing/gtest/include/gtest/gtest.h" | |
23 | |
24 using content::BrowserThread; | |
25 using extensions::URLPatternSet; | |
26 | |
27 namespace { | |
28 | |
29 static void AddPattern(URLPatternSet* extent, const std::string& pattern) { | |
30 int schemes = URLPattern::SCHEME_ALL; | |
31 extent->AddPattern(URLPattern(schemes, pattern)); | |
32 } | |
33 } | |
34 | |
35 namespace extensions { | |
36 | |
37 // Test bringing up a script loader on a specific directory, putting a script | |
38 // in there, etc. | |
39 | |
40 class ExtensionUserScriptLoaderTest : public testing::Test, | |
41 public content::NotificationObserver { | |
42 public: | |
43 ExtensionUserScriptLoaderTest() : shared_memory_(NULL) {} | |
44 | |
45 void SetUp() override { | |
46 ASSERT_TRUE(temp_dir_.CreateUniqueTempDir()); | |
47 | |
48 // Register for all user script notifications. | |
49 registrar_.Add(this, | |
50 extensions::NOTIFICATION_USER_SCRIPTS_UPDATED, | |
51 content::NotificationService::AllSources()); | |
52 | |
53 // ExtensionUserScriptLoader posts tasks to the file thread so make the | |
54 // current thread look like one. | |
55 file_thread_.reset(new content::TestBrowserThread( | |
56 BrowserThread::FILE, base::MessageLoop::current())); | |
57 ui_thread_.reset(new content::TestBrowserThread( | |
58 BrowserThread::UI, base::MessageLoop::current())); | |
59 } | |
60 | |
61 void TearDown() override { | |
62 file_thread_.reset(); | |
63 ui_thread_.reset(); | |
64 } | |
65 | |
66 void Observe(int type, | |
67 const content::NotificationSource& source, | |
68 const content::NotificationDetails& details) override { | |
69 DCHECK(type == extensions::NOTIFICATION_USER_SCRIPTS_UPDATED); | |
70 | |
71 shared_memory_ = content::Details<base::SharedMemory>(details).ptr(); | |
72 if (base::MessageLoop::current() == &message_loop_) | |
73 base::MessageLoop::current()->Quit(); | |
74 } | |
75 | |
76 // Directory containing user scripts. | |
77 base::ScopedTempDir temp_dir_; | |
78 | |
79 content::NotificationRegistrar registrar_; | |
80 | |
81 // MessageLoop used in tests. | |
82 base::MessageLoopForUI message_loop_; | |
83 | |
84 scoped_ptr<content::TestBrowserThread> file_thread_; | |
85 scoped_ptr<content::TestBrowserThread> ui_thread_; | |
86 | |
87 // Updated to the script shared memory when we get notified. | |
88 base::SharedMemory* shared_memory_; | |
89 }; | |
90 | |
91 // Test that we get notified even when there are no scripts. | |
92 TEST_F(ExtensionUserScriptLoaderTest, NoScripts) { | |
93 TestingProfile profile; | |
94 ExtensionUserScriptLoader loader( | |
95 &profile, | |
96 HostID(), | |
97 true /* listen_for_extension_system_loaded */); | |
98 loader.StartLoad(); | |
99 message_loop_.PostTask(FROM_HERE, base::MessageLoop::QuitClosure()); | |
100 message_loop_.Run(); | |
101 | |
102 ASSERT_TRUE(shared_memory_ != NULL); | |
103 } | |
104 | |
105 TEST_F(ExtensionUserScriptLoaderTest, Parse1) { | |
106 const std::string text( | |
107 "// This is my awesome script\n" | |
108 "// It does stuff.\n" | |
109 "// ==UserScript== trailing garbage\n" | |
110 "// @name foobar script\n" | |
111 "// @namespace http://www.google.com/\n" | |
112 "// @include *mail.google.com*\n" | |
113 "// \n" | |
114 "// @othergarbage\n" | |
115 "// @include *mail.yahoo.com*\r\n" | |
116 "// @include \t *mail.msn.com*\n" // extra spaces after "@include" OK | |
117 "//@include not-recognized\n" // must have one space after "//" | |
118 "// ==/UserScript== trailing garbage\n" | |
119 "\n" | |
120 "\n" | |
121 "alert('hoo!');\n"); | |
122 | |
123 UserScript script; | |
124 EXPECT_TRUE(ExtensionUserScriptLoader::ParseMetadataHeader(text, &script)); | |
125 ASSERT_EQ(3U, script.globs().size()); | |
126 EXPECT_EQ("*mail.google.com*", script.globs()[0]); | |
127 EXPECT_EQ("*mail.yahoo.com*", script.globs()[1]); | |
128 EXPECT_EQ("*mail.msn.com*", script.globs()[2]); | |
129 } | |
130 | |
131 TEST_F(ExtensionUserScriptLoaderTest, Parse2) { | |
132 const std::string text("default to @include *"); | |
133 | |
134 UserScript script; | |
135 EXPECT_TRUE(ExtensionUserScriptLoader::ParseMetadataHeader(text, &script)); | |
136 ASSERT_EQ(1U, script.globs().size()); | |
137 EXPECT_EQ("*", script.globs()[0]); | |
138 } | |
139 | |
140 TEST_F(ExtensionUserScriptLoaderTest, Parse3) { | |
141 const std::string text( | |
142 "// ==UserScript==\n" | |
143 "// @include *foo*\n" | |
144 "// ==/UserScript=="); // no trailing newline | |
145 | |
146 UserScript script; | |
147 ExtensionUserScriptLoader::ParseMetadataHeader(text, &script); | |
148 ASSERT_EQ(1U, script.globs().size()); | |
149 EXPECT_EQ("*foo*", script.globs()[0]); | |
150 } | |
151 | |
152 TEST_F(ExtensionUserScriptLoaderTest, Parse4) { | |
153 const std::string text( | |
154 "// ==UserScript==\n" | |
155 "// @match http://*.mail.google.com/*\n" | |
156 "// @match \t http://mail.yahoo.com/*\n" | |
157 "// ==/UserScript==\n"); | |
158 | |
159 URLPatternSet expected_patterns; | |
160 AddPattern(&expected_patterns, "http://*.mail.google.com/*"); | |
161 AddPattern(&expected_patterns, "http://mail.yahoo.com/*"); | |
162 | |
163 UserScript script; | |
164 EXPECT_TRUE(ExtensionUserScriptLoader::ParseMetadataHeader(text, &script)); | |
165 EXPECT_EQ(0U, script.globs().size()); | |
166 EXPECT_EQ(expected_patterns, script.url_patterns()); | |
167 } | |
168 | |
169 TEST_F(ExtensionUserScriptLoaderTest, Parse5) { | |
170 const std::string text( | |
171 "// ==UserScript==\n" | |
172 "// @match http://*mail.google.com/*\n" | |
173 "// ==/UserScript==\n"); | |
174 | |
175 // Invalid @match value. | |
176 UserScript script; | |
177 EXPECT_FALSE(ExtensionUserScriptLoader::ParseMetadataHeader(text, &script)); | |
178 } | |
179 | |
180 TEST_F(ExtensionUserScriptLoaderTest, Parse6) { | |
181 const std::string text( | |
182 "// ==UserScript==\n" | |
183 "// @include http://*.mail.google.com/*\n" | |
184 "// @match \t http://mail.yahoo.com/*\n" | |
185 "// ==/UserScript==\n"); | |
186 | |
187 // Allowed to match @include and @match. | |
188 UserScript script; | |
189 EXPECT_TRUE(ExtensionUserScriptLoader::ParseMetadataHeader(text, &script)); | |
190 } | |
191 | |
192 TEST_F(ExtensionUserScriptLoaderTest, Parse7) { | |
193 // Greasemonkey allows there to be any leading text before the comment marker. | |
194 const std::string text( | |
195 "// ==UserScript==\n" | |
196 "adsasdfasf// @name hello\n" | |
197 " // @description\twiggity woo\n" | |
198 "\t// @match \t http://mail.yahoo.com/*\n" | |
199 "// ==/UserScript==\n"); | |
200 | |
201 UserScript script; | |
202 EXPECT_TRUE(ExtensionUserScriptLoader::ParseMetadataHeader(text, &script)); | |
203 ASSERT_EQ("hello", script.name()); | |
204 ASSERT_EQ("wiggity woo", script.description()); | |
205 ASSERT_EQ(1U, script.url_patterns().patterns().size()); | |
206 EXPECT_EQ("http://mail.yahoo.com/*", | |
207 script.url_patterns().begin()->GetAsString()); | |
208 } | |
209 | |
210 TEST_F(ExtensionUserScriptLoaderTest, Parse8) { | |
211 const std::string text( | |
212 "// ==UserScript==\n" | |
213 "// @name myscript\n" | |
214 "// @match http://www.google.com/*\n" | |
215 "// @exclude_match http://www.google.com/foo*\n" | |
216 "// ==/UserScript==\n"); | |
217 | |
218 UserScript script; | |
219 EXPECT_TRUE(ExtensionUserScriptLoader::ParseMetadataHeader(text, &script)); | |
220 ASSERT_EQ("myscript", script.name()); | |
221 ASSERT_EQ(1U, script.url_patterns().patterns().size()); | |
222 EXPECT_EQ("http://www.google.com/*", | |
223 script.url_patterns().begin()->GetAsString()); | |
224 ASSERT_EQ(1U, script.exclude_url_patterns().patterns().size()); | |
225 EXPECT_EQ("http://www.google.com/foo*", | |
226 script.exclude_url_patterns().begin()->GetAsString()); | |
227 } | |
228 | |
229 TEST_F(ExtensionUserScriptLoaderTest, SkipBOMAtTheBeginning) { | |
230 base::FilePath path = temp_dir_.path().AppendASCII("script.user.js"); | |
231 const std::string content("\xEF\xBB\xBF alert('hello');"); | |
232 size_t written = base::WriteFile(path, content.c_str(), content.size()); | |
233 ASSERT_EQ(written, content.size()); | |
234 | |
235 UserScript user_script; | |
236 user_script.js_scripts().push_back( | |
237 UserScript::File(temp_dir_.path(), path.BaseName(), GURL())); | |
238 | |
239 UserScriptList user_scripts; | |
240 user_scripts.push_back(user_script); | |
241 | |
242 TestingProfile profile; | |
243 ExtensionUserScriptLoader loader( | |
244 &profile, | |
245 HostID(), | |
246 true /* listen_for_extension_system_loaded */); | |
247 loader.LoadScriptsForTest(&user_scripts); | |
248 | |
249 EXPECT_EQ(content.substr(3), | |
250 user_scripts[0].js_scripts()[0].GetContent().as_string()); | |
251 } | |
252 | |
253 TEST_F(ExtensionUserScriptLoaderTest, LeaveBOMNotAtTheBeginning) { | |
254 base::FilePath path = temp_dir_.path().AppendASCII("script.user.js"); | |
255 const std::string content("alert('here's a BOOM: \xEF\xBB\xBF');"); | |
256 size_t written = base::WriteFile(path, content.c_str(), content.size()); | |
257 ASSERT_EQ(written, content.size()); | |
258 | |
259 UserScript user_script; | |
260 user_script.js_scripts().push_back(UserScript::File( | |
261 temp_dir_.path(), path.BaseName(), GURL())); | |
262 | |
263 UserScriptList user_scripts; | |
264 user_scripts.push_back(user_script); | |
265 | |
266 TestingProfile profile; | |
267 ExtensionUserScriptLoader loader( | |
268 &profile, | |
269 HostID(), | |
270 true /* listen_for_extension_system_loaded */); | |
271 loader.LoadScriptsForTest(&user_scripts); | |
272 | |
273 EXPECT_EQ(content, user_scripts[0].js_scripts()[0].GetContent().as_string()); | |
274 } | |
275 | |
276 } // namespace extensions | |
OLD | NEW |