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
208
209
210
211
212
213
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/tracing/common/background_tracing_utils.h"
#include <vector>
#include "base/base64.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/path_service.h"
#include "base/test/scoped_command_line.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/task_environment.h"
#include "base/test/test_proto_loader.h"
#include "base/threading/thread_restrictions.h"
#include "components/prefs/testing_pref_service.h"
#include "components/tracing/common/background_tracing_state_manager.h"
#include "components/tracing/common/pref_names.h"
#include "components/tracing/common/tracing_scenarios_config.h"
#include "components/tracing/common/tracing_switches.h"
#include "content/public/browser/background_tracing_manager.h"
#include "content/public/browser/tracing_delegate.h"
#include "content/public/test/browser_task_environment.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/snappy/src/snappy.h"
namespace {
class BackgroundTracingUtilsTest : public testing::Test {
content::BrowserTaskEnvironment task_environment{
base::test::TaskEnvironment::TimeSource::MOCK_TIME};
content::TracingDelegate tracing_delegate_;
std::unique_ptr<content::BackgroundTracingManager>
background_tracing_manager =
content::BackgroundTracingManager::CreateInstance(&tracing_delegate_);
};
const char kInvalidTracingConfig[] = "{][}";
const char kValidProtoTracingConfig[] = R"pb(
scenarios: {
scenario_name: "test_scenario"
start_rules: { name: "start_trigger" manual_trigger_name: "start_trigger" }
upload_rules: {
name: "upload_trigger"
manual_trigger_name: "upload_trigger"
}
trace_config: {
data_sources: { config: { name: "org.chromium.trace_metadata2" } }
}
}
)pb";
const char kValidProtoRuleConfig[] = R"pb(
rules: { name: "trigger1" manual_trigger_name: "trigger1" }
rules: { name: "trigger2" manual_trigger_name: "trigger2" }
)pb";
std::string GetFieldTracingConfigFromText(const std::string& proto_text) {
base::ScopedAllowBlockingForTesting allow_blocking;
base::TestProtoLoader config_loader(
base::PathService::CheckedGet(base::DIR_GEN_TEST_DATA_ROOT)
.Append(
FILE_PATH_LITERAL("third_party/perfetto/protos/perfetto/"
"config/chrome/scenario_config.descriptor")),
"perfetto.protos.ChromeFieldTracingConfig");
std::string serialized_message;
config_loader.ParseFromText(proto_text, serialized_message);
return serialized_message;
}
std::string GetTracingRulesConfigFromText(const std::string& proto_text) {
base::ScopedAllowBlockingForTesting allow_blocking;
base::TestProtoLoader config_loader(
base::PathService::CheckedGet(base::DIR_GEN_TEST_DATA_ROOT)
.Append(
FILE_PATH_LITERAL("third_party/perfetto/protos/perfetto/"
"config/chrome/scenario_config.descriptor")),
"perfetto.protos.TracingTriggerRulesConfig");
std::string serialized_message;
config_loader.ParseFromText(proto_text, serialized_message);
return serialized_message;
}
TEST_F(BackgroundTracingUtilsTest, SetupFieldTracingFromFieldTrial) {
std::string serialized_config =
GetFieldTracingConfigFromText(kValidProtoTracingConfig);
std::string compressed_config;
ASSERT_TRUE(snappy::Compress(serialized_config.data(),
serialized_config.size(), &compressed_config));
std::string encoded_config = base::Base64Encode(compressed_config);
base::test::ScopedFeatureList scoped_list;
scoped_list.InitAndEnableFeatureWithParameters(tracing::kFieldTracing,
{{"config", encoded_config}});
ASSERT_FALSE(tracing::IsBackgroundTracingEnabledFromCommandLine());
EXPECT_FALSE(tracing::SetupSystemTracingFromFieldTrial());
EXPECT_TRUE(tracing::SetupFieldTracingFromFieldTrial());
}
TEST_F(BackgroundTracingUtilsTest, SetupSystemTracingFromFieldTrial) {
std::string serialized_config =
GetTracingRulesConfigFromText(kValidProtoRuleConfig);
std::string compressed_config;
ASSERT_TRUE(snappy::Compress(serialized_config.data(),
serialized_config.size(), &compressed_config));
std::string encoded_config = base::Base64Encode(compressed_config);
base::test::ScopedFeatureList scoped_list;
scoped_list.InitAndEnableFeatureWithParameters(tracing::kTracingTriggers,
{{"config", encoded_config}});
ASSERT_FALSE(tracing::IsBackgroundTracingEnabledFromCommandLine());
EXPECT_TRUE(tracing::SetupSystemTracingFromFieldTrial());
}
TEST_F(BackgroundTracingUtilsTest, SetupBackgroundTracingFromProtoConfigFile) {
base::ScopedTempDir temp_dir;
ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
base::FilePath file_path = temp_dir.GetPath().AppendASCII("config.pb");
base::WriteFile(file_path,
GetFieldTracingConfigFromText(kValidProtoTracingConfig));
base::test::ScopedCommandLine scoped_command_line;
base::CommandLine* command_line = scoped_command_line.GetProcessCommandLine();
command_line->AppendSwitchPath(switches::kBackgroundTracingOutputPath,
temp_dir.GetPath());
command_line->AppendSwitchPath(switches::kEnableBackgroundTracing, file_path);
ASSERT_TRUE(tracing::IsBackgroundTracingEnabledFromCommandLine());
EXPECT_FALSE(tracing::SetupSystemTracingFromFieldTrial());
EXPECT_FALSE(tracing::SetupFieldTracingFromFieldTrial());
EXPECT_TRUE(tracing::SetupBackgroundTracingFromCommandLine());
}
TEST_F(BackgroundTracingUtilsTest, SetupFieldTracingFromFieldTrialOutputPath) {
auto pref_service = std::make_unique<TestingPrefServiceSimple>();
tracing::RegisterPrefs(pref_service->registry());
auto state_manager_ = tracing::BackgroundTracingStateManager::CreateInstance(
pref_service.get());
std::string serialized_config =
GetFieldTracingConfigFromText(kValidProtoTracingConfig);
std::string compressed_config;
ASSERT_TRUE(snappy::Compress(serialized_config.data(),
serialized_config.size(), &compressed_config));
std::string encoded_config = base::Base64Encode(compressed_config);
base::test::ScopedFeatureList scoped_list;
scoped_list.InitAndEnableFeatureWithParameters(tracing::kFieldTracing,
{{"config", encoded_config}});
base::ScopedTempDir temp_dir;
ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
base::test::ScopedCommandLine scoped_command_line;
base::CommandLine* command_line = scoped_command_line.GetProcessCommandLine();
command_line->AppendSwitchPath(switches::kBackgroundTracingOutputPath,
temp_dir.GetPath());
ASSERT_TRUE(tracing::HasBackgroundTracingOutputPath());
ASSERT_FALSE(tracing::IsBackgroundTracingEnabledFromCommandLine());
EXPECT_TRUE(tracing::SetupFieldTracingFromFieldTrial());
}
TEST_F(BackgroundTracingUtilsTest,
SetupBackgroundTracingFromProtoConfigFileFailed) {
base::test::ScopedCommandLine scoped_command_line;
base::CommandLine* command_line = scoped_command_line.GetProcessCommandLine();
command_line->AppendSwitchASCII(switches::kEnableBackgroundTracing, "");
ASSERT_TRUE(tracing::IsBackgroundTracingEnabledFromCommandLine());
EXPECT_FALSE(
tracing::SetupBackgroundTracingFromProtoConfigFile(base::FilePath()));
}
TEST_F(BackgroundTracingUtilsTest, SetupBackgroundTracingWithOutputPathFailed) {
base::test::ScopedCommandLine scoped_command_line;
base::CommandLine* command_line = scoped_command_line.GetProcessCommandLine();
command_line->AppendSwitchASCII(switches::kBackgroundTracingOutputPath, "");
EXPECT_TRUE(tracing::HasBackgroundTracingOutputPath());
EXPECT_FALSE(tracing::SetBackgroundTracingOutputPath());
}
TEST_F(BackgroundTracingUtilsTest,
SetupBackgroundTracingFromProtoConfigFileInvalidConfig) {
base::ScopedTempDir temp_dir;
ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
base::FilePath config_file_path = temp_dir.GetPath().AppendASCII("config.pb");
base::WriteFile(config_file_path, kInvalidTracingConfig);
base::test::ScopedCommandLine scoped_command_line;
base::CommandLine* command_line = scoped_command_line.GetProcessCommandLine();
command_line->AppendSwitchPath(switches::kEnableBackgroundTracing,
config_file_path);
ASSERT_TRUE(tracing::IsBackgroundTracingEnabledFromCommandLine());
EXPECT_FALSE(
tracing::SetupBackgroundTracingFromProtoConfigFile(config_file_path));
}
TEST_F(BackgroundTracingUtilsTest,
SetupBackgroundTracingFromCommandLineFieldTrial) {
ASSERT_FALSE(tracing::IsBackgroundTracingEnabledFromCommandLine());
EXPECT_FALSE(tracing::SetupBackgroundTracingFromCommandLine());
EXPECT_FALSE(
content::BackgroundTracingManager::GetInstance().HasActiveScenario());
}
} // namespace
|
