File: set_icon_apitest.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (207 lines) | stat: -rw-r--r-- 7,508 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
// 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.

#include "chrome/browser/extensions/extension_apitest.h"
#include "chrome/browser/extensions/extension_tab_util.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/tabs/tab_strip_model.h"
#include "components/version_info/version_info.h"
#include "content/public/browser/storage_partition.h"
#include "content/public/test/browser_test.h"
#include "content/public/test/prerender_test_util.h"
#include "extensions/browser/api/declarative/rules_registry.h"
#include "extensions/browser/api/declarative/rules_registry_service.h"
#include "extensions/browser/extension_action.h"
#include "extensions/browser/extension_action_manager.h"
#include "extensions/browser/rules_registry_ids.h"
#include "extensions/common/features/feature_channel.h"
#include "extensions/test/extension_test_message_listener.h"
#include "extensions/test/test_extension_dir.h"
#include "net/test/embedded_test_server/embedded_test_server.h"
#include "ui/gfx/image/image.h"

namespace extensions {
namespace {

const char kDeclarativeContentManifest[] = R"({
  "name": "Declarative Content apitest",
  "version": "0.1",
  "manifest_version": 2,
  "description": "end-to-end browser test for the declarative Content API",
  "background": {"scripts": ["background.js"]},
  "page_action": {},
  "permissions": ["declarativeContent"]
})";

constexpr char kOneByOneImageData[] =
    "GAAAAAAAAAAQAAAAAAAAADAAAAAAAAAAKAAAAAAAAAACAAAAAQAAAAEAAAAAAAAAAAAAAAAAAA"
    "AAAAAAAAAAAAwAAAAEAAAAAAAAAAAAAAA=";

class SetIconAPITest : public ExtensionApiTest {
 public:
  SetIconAPITest()
      // Set the channel to "trunk" since declarativeContent is restricted
      // to trunk.
      : current_channel_(version_info::Channel::UNKNOWN) {}
  ~SetIconAPITest() override = default;

 protected:
  const Extension* LoadTestExtension() {
    ext_dir_.WriteManifest(kDeclarativeContentManifest);
    ext_dir_.WriteFile(FILE_PATH_LITERAL("background.js"), R"(
  var declarative = chrome.declarative;

  var PageStateMatcher = chrome.declarativeContent.PageStateMatcher;
  var SetIcon = chrome.declarativeContent.SetIcon;

  var canvas = document.createElement("canvas");
  var ctx = canvas.getContext("2d");
  var imageData = ctx.createImageData(1, 1);

  var rule0 = {
    conditions: [new PageStateMatcher({pageUrl: {queryContains: "show"}})],
    actions: [new SetIcon({"imageData": imageData})]
  };
  var testEvent = chrome.declarativeContent.onPageChanged;

  testEvent.removeRules(undefined, function() {
    testEvent.addRules([rule0], function() {
      chrome.test.sendMessage("ready", function(reply) {});
    });
  });
)");
    ExtensionTestMessageListener ready("ready");
    const Extension* extension = LoadExtension(ext_dir_.UnpackedPath());
    if (!extension) {
      return nullptr;
    }

    // Wait for declarative rules to be set up.
    profile()->GetDefaultStoragePartition()->FlushNetworkInterfaceForTesting();
    EXPECT_TRUE(GetExtensionAction(*extension));

    EXPECT_TRUE(ready.WaitUntilSatisfied());

    return extension;
  }

  const ExtensionAction* GetExtensionAction(const Extension& extension) {
    return ExtensionActionManager::Get(profile())->GetExtensionAction(
        extension);
  }

  content::WebContents* GetActiveWebContents() {
    return browser()->tab_strip_model()->GetWebContentsAt(0);
  }

 private:
  extensions::ScopedCurrentChannel current_channel_;
  TestExtensionDir ext_dir_;
};

IN_PROC_BROWSER_TEST_F(SetIconAPITest, Overview) {
  const Extension* extension = LoadTestExtension();
  ASSERT_TRUE(extension);

  content::WebContents* const tab = GetActiveWebContents();
  const int tab_id = ExtensionTabUtil::GetTabId(tab);

  // There should be no declarative icon until we navigate to a matched page.
  const ExtensionAction* action = GetExtensionAction(*extension);
  ASSERT_TRUE(action);

  EXPECT_TRUE(action->GetDeclarativeIcon(tab_id).IsEmpty());
  EXPECT_FALSE(NavigateInRenderer(tab, GURL("https://example.com/?show")));
  EXPECT_FALSE(action->GetDeclarativeIcon(tab_id).IsEmpty());

  // Navigating to an unmatched page should reset the icon.
  EXPECT_FALSE(NavigateInRenderer(tab, GURL("https://example.com/?hide")));
  EXPECT_TRUE(action->GetDeclarativeIcon(tab_id).IsEmpty());
}

// Regression test for crbug.com/1231027.
IN_PROC_BROWSER_TEST_F(SetIconAPITest, Parameter) {
  const Extension* extension = LoadTestExtension();
  ASSERT_TRUE(extension);

  scoped_refptr<RulesRegistry> rules_registry =
      extensions::RulesRegistryService::Get(browser()->profile())
          ->GetRulesRegistry(rules_registry_ids::kDefaultRulesRegistryID,
                             "declarativeContent.onPageChanged");
  ASSERT_TRUE(rules_registry);

  std::vector<const api::events::Rule*> rules;
  rules_registry->GetAllRules(extension->id(), &rules);
  ASSERT_EQ(1u, rules.size());
  ASSERT_EQ(rules[0]->actions.size(), 1u);

  const base::Value::Dict& action_value = rules[0]->actions[0].GetDict();
  const std::string* action_instance_type =
      action_value.FindString("instanceType");
  ASSERT_TRUE(action_instance_type);
  EXPECT_EQ("declarativeContent.SetIcon", *action_instance_type);

  const std::string* image_data_value =
      action_value.FindStringByDottedPath("imageData.1");
  ASSERT_TRUE(image_data_value);
  EXPECT_EQ(kOneByOneImageData, *image_data_value);
}

class SetIconAPIPrerenderingTest : public SetIconAPITest {
 public:
  SetIconAPIPrerenderingTest()
      : prerender_helper_(base::BindRepeating(
            &SetIconAPIPrerenderingTest::GetActiveWebContents,
            base::Unretained(this))) {}
  ~SetIconAPIPrerenderingTest() override = default;

 protected:
  content::FrameTreeNodeId Prerender(const GURL& url) {
    return prerender_helper_.AddPrerender(url);
  }
  void Activate(const GURL& url) { prerender_helper_.NavigatePrimaryPage(url); }

 private:
  void SetUp() override {
    prerender_helper_.RegisterServerRequestMonitor(embedded_test_server());
    ExtensionApiTest::SetUp();
  }

  content::test::PrerenderTestHelper prerender_helper_;
};

IN_PROC_BROWSER_TEST_F(SetIconAPIPrerenderingTest, Overview) {
  ASSERT_TRUE(embedded_test_server()->Start());
  const Extension* extension = LoadTestExtension();
  ASSERT_TRUE(extension);

  content::WebContents* const tab = GetActiveWebContents();
  const int tab_id = ExtensionTabUtil::GetTabId(tab);

  // There should be no declarative icon until we navigate to a matched page.
  const ExtensionAction* action = GetExtensionAction(*extension);
  ASSERT_TRUE(action);

  EXPECT_TRUE(action->GetDeclarativeIcon(tab_id).IsEmpty());

  const GURL kInitialUrl = embedded_test_server()->GetURL("/empty.html?show");
  EXPECT_TRUE(NavigateInRenderer(tab, kInitialUrl));
  EXPECT_FALSE(action->GetDeclarativeIcon(tab_id).IsEmpty());

  // Prerendering an unmatched page should not reset the icon.
  const GURL kPrerenderingUrl =
      embedded_test_server()->GetURL("/empty.html?hide");
  content::FrameTreeNodeId host_id = Prerender(kPrerenderingUrl);
  ASSERT_TRUE(host_id);
  EXPECT_FALSE(action->GetDeclarativeIcon(tab_id).IsEmpty());

  // Activating the unmatched page should reset the icon.
  Activate(kPrerenderingUrl);
  EXPECT_TRUE(action->GetDeclarativeIcon(tab_id).IsEmpty());
  EXPECT_EQ(tab->GetLastCommittedURL(), kPrerenderingUrl);
}

}  // namespace
}  // namespace extensions