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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
// 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.
//
// Unit tests for event trace controller.
#include "base/win/event_trace_controller.h"
#include <objbase.h>
#include <initguid.h>
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/logging.h"
#include "base/process/process_handle.h"
#include "base/strings/string_number_conversions_win.h"
#include "base/strings/string_util.h"
#include "base/system/sys_info.h"
#include "base/win/event_trace_provider.h"
#include "base/win/scoped_handle.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace base::win {
namespace {
const ULONG kTestProviderFlags = 0xCAFEBABE;
class TestingProvider : public EtwTraceProvider {
public:
explicit TestingProvider(const GUID& provider_name)
: EtwTraceProvider(provider_name) {
callback_event_.Set(::CreateEvent(nullptr, TRUE, FALSE, nullptr));
}
TestingProvider(const TestingProvider&) = delete;
TestingProvider& operator=(const TestingProvider&) = delete;
void WaitForCallback() {
::WaitForSingleObject(callback_event_.get(), INFINITE);
::ResetEvent(callback_event_.get());
}
private:
void OnEventsEnabled() override { ::SetEvent(callback_event_.get()); }
void PostEventsDisabled() override { ::SetEvent(callback_event_.get()); }
ScopedHandle callback_event_;
};
} // namespace
TEST(EtwTracePropertiesTest, Initialization) {
EtwTraceProperties prop;
EVENT_TRACE_PROPERTIES* p = prop.get();
EXPECT_NE(0u, p->Wnode.BufferSize);
EXPECT_EQ(0u, p->Wnode.ProviderId);
EXPECT_EQ(0u, p->Wnode.HistoricalContext);
EXPECT_TRUE(GUID_NULL == p->Wnode.Guid);
EXPECT_EQ(0u, p->Wnode.ClientContext);
EXPECT_EQ(static_cast<ULONG>(WNODE_FLAG_TRACED_GUID), p->Wnode.Flags);
EXPECT_EQ(0u, p->BufferSize);
EXPECT_EQ(0u, p->MinimumBuffers);
EXPECT_EQ(0u, p->MaximumBuffers);
EXPECT_EQ(0u, p->MaximumFileSize);
EXPECT_EQ(0u, p->LogFileMode);
EXPECT_EQ(0u, p->FlushTimer);
EXPECT_EQ(0u, p->EnableFlags);
EXPECT_EQ(0, p->AgeLimit);
EXPECT_EQ(0u, p->NumberOfBuffers);
EXPECT_EQ(0u, p->FreeBuffers);
EXPECT_EQ(0u, p->EventsLost);
EXPECT_EQ(0u, p->BuffersWritten);
EXPECT_EQ(0u, p->LogBuffersLost);
EXPECT_EQ(0u, p->RealTimeBuffersLost);
EXPECT_EQ(nullptr, p->LoggerThreadId);
EXPECT_NE(0u, p->LogFileNameOffset);
EXPECT_NE(0u, p->LoggerNameOffset);
}
TEST(EtwTracePropertiesTest, Strings) {
EtwTraceProperties prop;
ASSERT_STREQ(L"", prop.GetLoggerFileName());
ASSERT_STREQ(L"", prop.GetLoggerName());
std::wstring name(1023, L'A');
ASSERT_HRESULT_SUCCEEDED(prop.SetLoggerFileName(name.c_str()));
ASSERT_HRESULT_SUCCEEDED(prop.SetLoggerName(name.c_str()));
ASSERT_STREQ(name.c_str(), prop.GetLoggerFileName());
ASSERT_STREQ(name.c_str(), prop.GetLoggerName());
std::wstring name2(1024, L'A');
ASSERT_HRESULT_FAILED(prop.SetLoggerFileName(name2.c_str()));
ASSERT_HRESULT_FAILED(prop.SetLoggerName(name2.c_str()));
}
namespace {
class EtwTraceControllerTest : public testing::Test {
public:
EtwTraceControllerTest()
: session_name_(L"TestSession-" + NumberToWString(GetCurrentProcId())) {}
void SetUp() override {
EtwTraceProperties ignore;
EtwTraceController::Stop(session_name_.c_str(), &ignore);
// Allocate a new provider name GUID for each test.
ASSERT_HRESULT_SUCCEEDED(::CoCreateGuid(&test_provider_));
}
void TearDown() override {
EtwTraceProperties prop;
EtwTraceController::Stop(session_name_.c_str(), &prop);
}
protected:
GUID test_provider_;
std::wstring session_name_;
};
} // namespace
TEST_F(EtwTraceControllerTest, Initialize) {
EtwTraceController controller;
EXPECT_EQ(0u, controller.session());
EXPECT_STREQ(L"", controller.session_name());
}
TEST_F(EtwTraceControllerTest, StartRealTimeSession) {
EtwTraceController controller;
HRESULT hr = controller.StartRealtimeSession(session_name_.c_str(), 1024);
if (hr == E_ACCESSDENIED) {
VLOG(1) << "You must be an administrator to run this test on Vista";
return;
}
EXPECT_NE(0u, controller.session());
EXPECT_STREQ(session_name_.c_str(), controller.session_name());
EXPECT_HRESULT_SUCCEEDED(controller.Stop(nullptr));
EXPECT_EQ(0u, controller.session());
EXPECT_STREQ(L"", controller.session_name());
}
TEST_F(EtwTraceControllerTest, StartFileSession) {
ScopedTempDir temp_dir;
ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
FilePath temp;
ASSERT_TRUE(CreateTemporaryFileInDir(temp_dir.GetPath(), &temp));
EtwTraceController controller;
HRESULT hr =
controller.StartFileSession(session_name_.c_str(), temp.value().c_str());
if (hr == E_ACCESSDENIED) {
VLOG(1) << "You must be an administrator to run this test on Vista";
DeleteFile(temp);
return;
}
EXPECT_NE(0u, controller.session());
EXPECT_STREQ(session_name_.c_str(), controller.session_name());
EXPECT_HRESULT_SUCCEEDED(controller.Stop(nullptr));
EXPECT_EQ(0u, controller.session());
EXPECT_STREQ(L"", controller.session_name());
DeleteFile(temp);
}
// This test is flaky for unclear reasons. See bugs 525297 and 534184
TEST_F(EtwTraceControllerTest, DISABLED_EnableDisable) {
TestingProvider provider(test_provider_);
EXPECT_EQ(static_cast<DWORD>(ERROR_SUCCESS), provider.Register());
EXPECT_EQ(0u, provider.session_handle());
EtwTraceController controller;
HRESULT hr = controller.StartRealtimeSession(session_name_.c_str(), 1024);
if (hr == E_ACCESSDENIED) {
VLOG(1) << "You must be an administrator to run this test on Vista";
return;
}
EXPECT_HRESULT_SUCCEEDED(controller.EnableProvider(
test_provider_, TRACE_LEVEL_VERBOSE, kTestProviderFlags));
provider.WaitForCallback();
EXPECT_EQ(TRACE_LEVEL_VERBOSE, provider.enable_level());
EXPECT_EQ(kTestProviderFlags, provider.enable_flags());
EXPECT_HRESULT_SUCCEEDED(controller.DisableProvider(test_provider_));
provider.WaitForCallback();
EXPECT_EQ(0, provider.enable_level());
EXPECT_EQ(0u, provider.enable_flags());
EXPECT_EQ(static_cast<DWORD>(ERROR_SUCCESS), provider.Unregister());
// Enable the provider again, before registering.
EXPECT_HRESULT_SUCCEEDED(controller.EnableProvider(
test_provider_, TRACE_LEVEL_VERBOSE, kTestProviderFlags));
// Register the provider again, the settings above
// should take immediate effect.
EXPECT_EQ(static_cast<DWORD>(ERROR_SUCCESS), provider.Register());
EXPECT_EQ(TRACE_LEVEL_VERBOSE, provider.enable_level());
EXPECT_EQ(kTestProviderFlags, provider.enable_flags());
// Consume the callback event of the previous controller.EnableProvider().
provider.WaitForCallback();
EXPECT_HRESULT_SUCCEEDED(controller.Stop(nullptr));
provider.WaitForCallback();
// Session should have wound down.
EXPECT_EQ(0, provider.enable_level());
EXPECT_EQ(0u, provider.enable_flags());
}
} // namespace base::win
|
