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
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_TEST_BASE_WEB_UI_MOCHA_BROWSER_TEST_H_
#define CHROME_TEST_BASE_WEB_UI_MOCHA_BROWSER_TEST_H_
#include <string>
#include <tuple>
#include "build/build_config.h"
#include "chrome/test/base/platform_browser_test.h"
#if BUILDFLAG(IS_ANDROID)
#include "base/test/scoped_feature_list.h"
#include "content/public/common/content_features.h"
#else
#include "chrome/test/base/devtools_agent_coverage_observer.h"
#endif
class Profile;
namespace content {
class WebContents;
} // namespace content
// The result of a single JS test.
struct SubTestResult {
SubTestResult();
SubTestResult(const SubTestResult& other);
SubTestResult(SubTestResult&& other);
SubTestResult& operator=(SubTestResult&& other);
~SubTestResult();
std::string name;
testing::TimeInMillis duration;
std::optional<std::string> failure_reason;
};
// Interface for reporting SubTestResults. Can be mocked.
class SubTestReporter {
public:
virtual ~SubTestReporter() = default;
virtual void Report(std::string_view name,
testing::TimeInMillis elapsed_time,
std::optional<std::string_view> failure_message) const;
};
namespace webui {
// Convert all non-alphanumeric characters to underscore in-place. Assumes
// ASCII. Intended to fit the regular expression used for GTest names.
void CanonicalizeTestName(std::string* test_name);
// Receive messages from JS.
std::tuple<bool, std::vector<SubTestResult>> ProcessMessagesFromJsTest(
content::WebContents* web_contents);
} // namespace webui
// Inherit from this class to run WebUI tests that are using Mocha.
class WebUIMochaBrowserTest : public PlatformBrowserTest {
public:
WebUIMochaBrowserTest(const WebUIMochaBrowserTest&) = delete;
WebUIMochaBrowserTest& operator=(const WebUIMochaBrowserTest&) = delete;
~WebUIMochaBrowserTest() override;
protected:
WebUIMochaBrowserTest();
// Runs the specified test.
// - file: The module file holding the Mocha test.
// - trigger: A JS string used to trigger the tests, defaults to
// "mocha.run()".
// - skip_test_loader: Whether to skip loading the test from
// chrome://<test_loader_host_>/test_loader.html and load
// it directly from chrome://<test_loader_host>. Defaults
// to false.
void RunTest(const std::string& file,
const std::string& trigger,
const bool& skip_test_loader);
// Convenience overloaded version of the RunTest above, which uses the default
// value for `skip_test_loader`.
void RunTest(const std::string& file, const std::string& trigger);
// Convenience overloaded version of the RunTest above, which uses
// `skip_test_loader=true`.
void RunTestWithoutTestLoader(const std::string& file,
const std::string& trigger);
// Similar to RunTest() but also accepts WebContents instance, for
// cases where the test loads the WebContents to be tested in an
// unconventional way.
// Note: Unlike other RunTestXYZ methods above, this method does not
// internally call FAIL on test failure, instead it returns an AssertionResult
// that needs to be manually checked by callers.
testing::AssertionResult RunTestOnWebContents(
content::WebContents* web_contents,
const std::string& file,
const std::string& trigger,
const bool& skip_test_loader);
// Tests may optionally call this before calling RunTest to opt into or out
// of SubTestResult reporting. This is useful for GTests that run
// intentionally failing JS tests.
void SetSubTestResultReportingEnabled(bool enabled);
// Hook for subclasses that need to perform additional setup steps that
// involve the WebContents, before the Mocha test runs.
virtual void OnWebContentsAvailable(content::WebContents* web_contents);
// Gets the Profile instance to set the chrome://webui-test data on.
// Defaults to chrome_test_utils::GetProfile(this);
virtual Profile* GetProfileForSetup();
// PlatformBrowserTest overrides.
void SetUpOnMainThread() override;
void set_test_loader_host(const std::string& host);
void set_test_loader_scheme(const std::string& scheme);
private:
// Helper that performs setup steps normally done by test_loader.html, invoked
// in tests that don't use test_loader.html. Specifically:
// 1) Programmatically loads mocha.js and mocha_adapter_simple.js.
// 2) Programmatically loads the Mocha test file.
testing::AssertionResult SimulateTestLoader(
content::WebContents* web_contents,
const std::string& file);
// The host to use when invoking the test loader URL, like
// "chrome://<host>/test_loader.html=...". Defaults to
// `chrome::kChromeUIWebUITestHost`.
// Note: It is also used by RunTest even when |skip_test_loader| is true.
std::string test_loader_host_;
// The scheme to use when invoking the test_loader URL, like
// "<scheme>://webui-test/test_loader.html=...". Defaults to
// content::kChromeUIScheme.
// Note: It is also used by RunTest even when |skip_test_loader| is true.
std::string test_loader_scheme_;
// Interface for reporting SubTestResults.
std::unique_ptr<SubTestReporter> sub_test_reporter_;
#if BUILDFLAG(IS_ANDROID)
// On Android, JavaScript console messages are only added to test logs if
// kLogJsConsoleMessages is enabled (on other platforms, such messages are
// included in test logs by default). Console messages are necessary for
// WebUI tests since they include logs indicating which tests in a suite
// passed/failed and the console errors related to any failures.
base::test::ScopedFeatureList scoped_feature_list_{
features::kLogJsConsoleMessages};
#else
// Handles collection of code coverage.
std::unique_ptr<DevToolsAgentCoverageObserver> coverage_handler_;
#endif
};
// Inherit from this class to explicitly focus the web contents before running
// any Mocha tests that exercise focus (necessary for Mac, see
// https://crbug.com/642467). This should only be used when running as part of
// interactive_ui_tests, and not as part of browser_tests.
class WebUIMochaFocusTest : public WebUIMochaBrowserTest {
protected:
void OnWebContentsAvailable(content::WebContents* web_contents) override;
};
#endif // CHROME_TEST_BASE_WEB_UI_MOCHA_BROWSER_TEST_H_
|
