#include "base/memory/scoped_vector.h"
#include "base/time/time.h"
#include "base/values.h"
+#include "chrome/test/chromedriver/chrome/devtools_client_impl.h"
#include "chrome/test/chromedriver/chrome/log.h"
#include "chrome/test/chromedriver/chrome/status.h"
#include "chrome/test/chromedriver/chrome/stub_devtools_client.h"
+#include "chrome/test/chromedriver/session.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace {
+struct DevToolsCommand {
+ DevToolsCommand(const std::string& in_method,
+ base::DictionaryValue* in_params)
+ : method(in_method) {
+ params.reset(in_params);
+ }
+ ~DevToolsCommand() {}
+
+ std::string method;
+ scoped_ptr<base::DictionaryValue> params;
+};
+
class FakeDevToolsClient : public StubDevToolsClient {
public:
explicit FakeDevToolsClient(const std::string& id)
- : id_(id), listener_(NULL) {}
+ : id_(id), listener_(NULL), command_index_(0) {}
virtual ~FakeDevToolsClient() {}
- std::string PopSentCommand() {
- std::string command;
- if (!sent_command_queue_.empty()) {
- command = sent_command_queue_.front();
- sent_command_queue_.pop_front();
+ bool PopSentCommand(DevToolsCommand** out_command) {
+ if (sent_commands_.size() > command_index_) {
+ *out_command = sent_commands_.get().at(command_index_++);
+ return true;
}
- return command;
+ return false;
}
Status TriggerEvent(const std::string& method) {
return listener_->OnEvent(this, method, empty_params);
}
+ Status TriggerEvent(const std::string& method,
+ const base::DictionaryValue& params) {
+ return listener_->OnEvent(this, method, params);
+ }
+
// Overridden from DevToolsClient:
virtual Status ConnectIfNecessary() OVERRIDE {
return listener_->OnConnected(this);
const std::string& method,
const base::DictionaryValue& params,
scoped_ptr<base::DictionaryValue>* result) OVERRIDE {
- sent_command_queue_.push_back(method);
+ sent_commands_.push_back(new DevToolsCommand(method,
+ params.DeepCopy()));
return Status(kOk);
}
private:
const std::string id_; // WebView id.
- std::list<std::string> sent_command_queue_; // Commands that were sent.
+ ScopedVector<DevToolsCommand> sent_commands_; // Commands that were sent.
DevToolsEventListener* listener_; // The fake allows only one event listener.
+ size_t command_index_;
};
struct LogEntry {
void ValidateLogEntry(const LogEntry *entry,
const std::string& expected_webview,
- const std::string& expected_method) {
+ const std::string& expected_method,
+ const base::DictionaryValue& expected_params) {
EXPECT_EQ(Log::kInfo, entry->level);
EXPECT_LT(0, entry->timestamp.ToTimeT());
EXPECT_EQ(expected_method, method);
base::DictionaryValue* params;
EXPECT_TRUE(message->GetDictionary("message.params", ¶ms));
- EXPECT_EQ(0u, params->size());
+ EXPECT_TRUE(params->Equals(&expected_params));
+}
+
+void ValidateLogEntry(const LogEntry *entry,
+ const std::string& expected_webview,
+ const std::string& expected_method) {
+ base::DictionaryValue empty_params;
+ ValidateLogEntry(entry, expected_webview, expected_method, empty_params);
+}
+
+void ExpectCommand(FakeDevToolsClient& client, const std::string& method) {
+ DevToolsCommand* cmd;
+ // Use ASSERT so that test fails if no command is returned.
+ ASSERT_TRUE(client.PopSentCommand(&cmd));
+ EXPECT_EQ(method, cmd->method);
}
void ExpectEnableDomains(FakeDevToolsClient& client) {
- EXPECT_EQ("Network.enable", client.PopSentCommand());
- EXPECT_EQ("Page.enable", client.PopSentCommand());
- EXPECT_EQ("Timeline.start", client.PopSentCommand());
- EXPECT_TRUE(client.PopSentCommand().empty());
+ ExpectCommand(client, "Network.enable");
+ ExpectCommand(client, "Page.enable");
+ ExpectCommand(client, "Timeline.start");
}
} // namespace
TEST(PerformanceLogger, OneWebView) {
FakeDevToolsClient client("webview-1");
FakeLog log;
- PerformanceLogger logger(&log);
+ Session session("test");
+ PerformanceLogger logger(&log, &session);
client.AddListener(&logger);
logger.OnConnected(&client);
FakeDevToolsClient client1("webview-1");
FakeDevToolsClient client2("webview-2");
FakeLog log;
- PerformanceLogger logger(&log);
+ Session session("test");
+ PerformanceLogger logger(&log, &session);
client1.AddListener(&logger);
client2.AddListener(&logger);
// OnConnected sends the enable command only to that client, not others.
client1.ConnectIfNecessary();
ExpectEnableDomains(client1);
- EXPECT_TRUE(client2.PopSentCommand().empty());
+ DevToolsCommand* cmd;
+ ASSERT_FALSE(client2.PopSentCommand(&cmd));
ASSERT_EQ(kOk, client1.TriggerEvent("Page.gaga1").code());
ASSERT_EQ(kOk, client2.TriggerEvent("Timeline.gaga2").code());
TEST(PerformanceLogger, PerfLoggingPrefs) {
FakeDevToolsClient client("webview-1");
FakeLog log;
+ Session session("test");
PerfLoggingPrefs prefs;
- ASSERT_EQ(PerfLoggingPrefs::InspectorDomainStatus::kDefaultEnabled,
+ EXPECT_EQ(PerfLoggingPrefs::InspectorDomainStatus::kDefaultEnabled,
prefs.network);
prefs.network = PerfLoggingPrefs::InspectorDomainStatus::kExplicitlyDisabled;
- // Trace categories should be ignored until tracing support is implemented.
- prefs.trace_categories = "benchmark,webkit.console";
- PerformanceLogger logger(&log, prefs);
+ prefs.trace_categories = "benchmark,blink.console";
+ PerformanceLogger logger(&log, &session, prefs);
+
+ client.AddListener(&logger);
+ logger.OnConnected(&client);
+ ExpectCommand(client, "Page.enable");
+ // Do not expect Timeline.enable command since specifying trace categories
+ // implicitly disables Timeline feed.
+ DevToolsCommand* cmd;
+ ASSERT_FALSE(client.PopSentCommand(&cmd));
+}
+
+namespace {
+
+class FakeBrowserwideClient : public FakeDevToolsClient {
+ public:
+ FakeBrowserwideClient()
+ : FakeDevToolsClient(DevToolsClientImpl::kBrowserwideDevToolsClientId),
+ events_handled_(false) {}
+ virtual ~FakeBrowserwideClient() {}
+
+ bool events_handled() const {
+ return events_handled_;
+ }
+
+ // Overridden from DevToolsClient:
+ virtual Status HandleEventsUntil(
+ const ConditionalFunc& conditional_func,
+ const base::TimeDelta& timeout) OVERRIDE {
+ TriggerEvent("Tracing.tracingComplete");
+ events_handled_ = true;
+ return Status(kOk);
+ }
+
+ private:
+ bool events_handled_;
+};
+
+} // namespace
+
+TEST(PerformanceLogger, TracingStartStop) {
+ FakeBrowserwideClient client;
+ FakeLog log;
+ Session session("test");
+ PerfLoggingPrefs prefs;
+ prefs.trace_categories = "benchmark,blink.console";
+ PerformanceLogger logger(&log, &session, prefs);
+
+ client.AddListener(&logger);
+ logger.OnConnected(&client);
+ DevToolsCommand* cmd;
+ ASSERT_TRUE(client.PopSentCommand(&cmd));
+ EXPECT_EQ("Tracing.start", cmd->method);
+ std::string expected_cats;
+ EXPECT_TRUE(cmd->params->GetString("categories", &expected_cats));
+ EXPECT_EQ("benchmark,blink.console", expected_cats);
+ int expected_interval = 0;
+ EXPECT_TRUE(cmd->params->GetInteger("bufferUsageReportingInterval",
+ &expected_interval));
+ EXPECT_GT(expected_interval, 0);
+ ASSERT_FALSE(client.PopSentCommand(&cmd));
+
+ EXPECT_FALSE(client.events_handled());
+ // Trigger a dump of the DevTools trace buffer.
+ ASSERT_EQ(kOk, logger.BeforeCommand("GetLog").code());
+ EXPECT_TRUE(client.events_handled());
+ ExpectCommand(client, "Tracing.end");
+ ExpectCommand(client, "Tracing.start"); // Tracing should re-start.
+ ASSERT_FALSE(client.PopSentCommand(&cmd));
+}
+
+TEST(PerformanceLogger, RecordTraceEvents) {
+ FakeBrowserwideClient client;
+ FakeLog log;
+ Session session("test");
+ PerfLoggingPrefs prefs;
+ prefs.trace_categories = "benchmark,blink.console";
+ PerformanceLogger logger(&log, &session, prefs);
+
+ client.AddListener(&logger);
+ logger.OnConnected(&client);
+ base::DictionaryValue params;
+ base::ListValue* trace_events = new base::ListValue();
+ base::DictionaryValue* event1 = new base::DictionaryValue();
+ event1->SetString("cat", "foo");
+ trace_events->Append(event1);
+ base::DictionaryValue* event2 = new base::DictionaryValue();
+ event2->SetString("cat", "bar");
+ trace_events->Append(event2);
+ params.Set("value", trace_events);
+ ASSERT_EQ(kOk, client.TriggerEvent("Tracing.dataCollected", params).code());
+
+ ASSERT_EQ(2u, log.GetEntries().size());
+ ValidateLogEntry(log.GetEntries()[0],
+ DevToolsClientImpl::kBrowserwideDevToolsClientId,
+ "Tracing.dataCollected", *event1);
+ ValidateLogEntry(log.GetEntries()[1],
+ DevToolsClientImpl::kBrowserwideDevToolsClientId,
+ "Tracing.dataCollected", *event2);
+}
+
+TEST(PerformanceLogger, ShouldRequestTraceEvents) {
+ FakeBrowserwideClient client;
+ FakeLog log;
+ Session session("test");
+ PerfLoggingPrefs prefs;
+ prefs.trace_categories = "benchmark,blink.console";
+ PerformanceLogger logger(&log, &session, prefs);
client.AddListener(&logger);
logger.OnConnected(&client);
- EXPECT_EQ("Page.enable", client.PopSentCommand());
- // Trace categories ignored, so Timeline shouldn't be implicitly disabled.
- EXPECT_EQ("Timeline.start", client.PopSentCommand());
- EXPECT_TRUE(client.PopSentCommand().empty());
+ EXPECT_FALSE(client.events_handled());
+ // Trace events should not be dumped for commands not in whitelist.
+ ASSERT_EQ(kOk, logger.BeforeCommand("Blah").code());
+ EXPECT_FALSE(client.events_handled());
+ ASSERT_EQ(kOk, logger.BeforeCommand("Foo").code());
+ EXPECT_FALSE(client.events_handled());
+ // Trace events should always be dumped for GetLog command.
+ ASSERT_EQ(kOk, logger.BeforeCommand("GetLog").code());
+ EXPECT_TRUE(client.events_handled());
+}
+
+TEST(PerformanceLogger, WarnWhenTraceBufferFull) {
+ FakeBrowserwideClient client;
+ FakeLog log;
+ Session session("test");
+ PerfLoggingPrefs prefs;
+ prefs.trace_categories = "benchmark,blink.console";
+ PerformanceLogger logger(&log, &session, prefs);
+
+ client.AddListener(&logger);
+ logger.OnConnected(&client);
+ base::DictionaryValue params;
+ params.SetDouble("value", 1.0);
+ ASSERT_EQ(kOk, client.TriggerEvent("Tracing.bufferUsage", params).code());
+
+ ASSERT_EQ(1u, log.GetEntries().size());
+ LogEntry* entry = log.GetEntries()[0];
+ EXPECT_EQ(Log::kWarning, entry->level);
+ EXPECT_LT(0, entry->timestamp.ToTimeT());
+ scoped_ptr<base::DictionaryValue> message(ParseDictionary(entry->message));
+ std::string webview;
+ EXPECT_TRUE(message->GetString("webview", &webview));
+ EXPECT_EQ(DevToolsClientImpl::kBrowserwideDevToolsClientId, webview);
+ std::string method;
+ EXPECT_TRUE(message->GetString("message.method", &method));
+ EXPECT_EQ("Tracing.bufferUsage", method);
+ base::DictionaryValue* actual_params;
+ EXPECT_TRUE(message->GetDictionary("message.params", &actual_params));
+ EXPECT_TRUE(actual_params->HasKey("error"));
}