Implement Reactive Configuration in Background Tracing

content/browser/tracing/background_tracing_manager_browsertest.cc

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "base/bind.h"
 #include "content/public/browser/background_tracing_manager.h"
 #include "content/public/browser/background_tracing_preemptive_config.h"
 #include "content/public/browser/background_tracing_reactive_config.h"
 #include "content/public/test/content_browser_test.h"
 #include "content/public/test/content_browser_test_utils.h"
@@ skipping 49 matching lines @@
     callback.Run();
 }
 
 scoped_ptr<BackgroundTracingPreemptiveConfig> CreatePreemptiveConfig() {
   scoped_ptr<BackgroundTracingPreemptiveConfig> config(
       new BackgroundTracingPreemptiveConfig());
 
   BackgroundTracingPreemptiveConfig::MonitoringRule rule;
   rule.type =
       BackgroundTracingPreemptiveConfig::MONITOR_AND_DUMP_WHEN_TRIGGER_NAMED;
-  rule.named_trigger_info.trigger_name = "test";
+  rule.named_trigger_info.trigger_name = "preemptive_test";
 
   config->configs.push_back(rule);
 
+  return config.Pass();
+}
+
+scoped_ptr<BackgroundTracingReactiveConfig> CreateReactiveConfig() {
+  scoped_ptr<BackgroundTracingReactiveConfig> config(
+      new BackgroundTracingReactiveConfig());
+
+  BackgroundTracingReactiveConfig::TracingRule rule;
+  rule.type =
+      BackgroundTracingReactiveConfig::TRACE_UNTIL_10S_OR_TRIGGER_OR_FULL;
+  rule.trigger_name = "reactive_test";
+  rule.category_preset =
+      BackgroundTracingConfig::CategoryPreset::BENCHMARK_DEEP;
+
+  config->configs.push_back(rule);
+
   return config.Pass();
 }
 
 void SetupBackgroundTracingManager() {
   content::BackgroundTracingManager::GetInstance()
       ->InvalidateTriggerHandlesForTesting();
 }
 
 void DisableScenarioWhenIdle() {
   BackgroundTracingManager::GetInstance()->SetActiveScenario(
       NULL, BackgroundTracingManager::ReceiveCallback(), false);
 }
 
 // This tests that the endpoint receives the final trace data.
 IN_PROC_BROWSER_TEST_F(BackgroundTracingManagerBrowserTest,
                        ReceiveTraceFinalContentsOnTrigger) {
   {
     SetupBackgroundTracingManager();
 
     base::RunLoop run_loop;
     BackgroundTracingManagerUploadConfigWrapper upload_config_wrapper(
         run_loop.QuitClosure());
 
     scoped_ptr<BackgroundTracingPreemptiveConfig> config =
         CreatePreemptiveConfig();
 
     BackgroundTracingManager::TriggerHandle handle =
-        BackgroundTracingManager::GetInstance()->RegisterTriggerType("test");
+        BackgroundTracingManager::
+            GetInstance()->RegisterTriggerType("preemptive_test");
 
     BackgroundTracingManager::GetInstance()->SetActiveScenario(
         config.Pass(), upload_config_wrapper.get_receive_callback(), true);
 
     BackgroundTracingManager::GetInstance()->WhenIdle(
         base::Bind(&DisableScenarioWhenIdle));
 
     BackgroundTracingManager::GetInstance()->TriggerNamedEvent(
         handle, base::Bind(&StartedFinalizingCallback, base::Closure(), true));
 
@@ skipping 11 matching lines @@
 
     base::RunLoop run_loop;
     BackgroundTracingManagerUploadConfigWrapper upload_config_wrapper(
         run_loop.QuitClosure());
 
     scoped_ptr<BackgroundTracingPreemptiveConfig> config =
         CreatePreemptiveConfig();
 
     content::BackgroundTracingManager::TriggerHandle handle =
         content::BackgroundTracingManager::GetInstance()->RegisterTriggerType(
-            "test");
+            "preemptive_test");
 
     BackgroundTracingManager::GetInstance()->SetActiveScenario(
         config.Pass(), upload_config_wrapper.get_receive_callback(), true);
 
     BackgroundTracingManager::GetInstance()->WhenIdle(
         base::Bind(&DisableScenarioWhenIdle));
 
     BackgroundTracingManager::GetInstance()->TriggerNamedEvent(
         handle, base::Bind(&StartedFinalizingCallback, base::Closure(), true));
     BackgroundTracingManager::GetInstance()->TriggerNamedEvent(
@@ skipping 57 matching lines @@
     SetupBackgroundTracingManager();
 
     base::RunLoop run_loop;
     BackgroundTracingManagerUploadConfigWrapper upload_config_wrapper(
         (base::Closure()));
 
     scoped_ptr<BackgroundTracingConfig> config = CreatePreemptiveConfig();
 
     content::BackgroundTracingManager::TriggerHandle handle =
         content::BackgroundTracingManager::GetInstance()->RegisterTriggerType(
-            "test");
+            "preemptive_test");
 
     BackgroundTracingManager::GetInstance()->TriggerNamedEvent(
         handle,
         base::Bind(&StartedFinalizingCallback, run_loop.QuitClosure(), false));
 
     run_loop.Run();
 
     EXPECT_TRUE(upload_config_wrapper.get_receive_count() == 0);
   }
 }
@@ skipping 40 matching lines @@
 
     base::RunLoop run_loop;
     BackgroundTracingManagerUploadConfigWrapper upload_config_wrapper(
         (base::Closure()));
 
     scoped_ptr<BackgroundTracingPreemptiveConfig> config =
         CreatePreemptiveConfig();
 
     content::BackgroundTracingManager::TriggerHandle handle =
         content::BackgroundTracingManager::GetInstance()->RegisterTriggerType(
-            "test");
+            "preemptive_test");
 
     content::BackgroundTracingManager::GetInstance()
         ->InvalidateTriggerHandlesForTesting();
 
     BackgroundTracingManager::GetInstance()->SetActiveScenario(
         config.Pass(), upload_config_wrapper.get_receive_callback(), true);
 
     BackgroundTracingManager::GetInstance()->WhenIdle(
         base::Bind(&DisableScenarioWhenIdle));
 
     BackgroundTracingManager::GetInstance()->TriggerNamedEvent(
         handle,
         base::Bind(&StartedFinalizingCallback, run_loop.QuitClosure(), false));
 
     run_loop.Run();
 
     EXPECT_TRUE(upload_config_wrapper.get_receive_count() == 0);
   }
 }
 
-// This tests that reactive mode configs will fail.
+// This tests that preemptive mode configs will fail.
 IN_PROC_BROWSER_TEST_F(BackgroundTracingManagerBrowserTest,
                        DoesNotAllowPreemptiveConfigThatsNotManual) {
   {
     SetupBackgroundTracingManager();
 
     BackgroundTracingManagerUploadConfigWrapper upload_config_wrapper(
         (base::Closure()));
 
     scoped_ptr<BackgroundTracingPreemptiveConfig> config(
         new content::BackgroundTracingPreemptiveConfig());
 
     BackgroundTracingPreemptiveConfig::MonitoringRule rule;
     rule.type = BackgroundTracingPreemptiveConfig::
         MONITOR_AND_DUMP_WHEN_SPECIFIC_HISTOGRAM_AND_VALUE;
     rule.histogram_trigger_info.histogram_name_to_trigger_on = "fake";
     rule.histogram_trigger_info.histogram_bin_to_trigger_on = 0;
     config->configs.push_back(rule);
 
     bool result = BackgroundTracingManager::GetInstance()->SetActiveScenario(
         config.Pass(), upload_config_wrapper.get_receive_callback(), true);
 
     EXPECT_FALSE(result);
   }
 }
 
-// This tests that reactive mode configs will fail.
+// This tests that reactive mode records and terminates with timeout.
 IN_PROC_BROWSER_TEST_F(BackgroundTracingManagerBrowserTest,
-                       DoesNotAllowReactiveConfig) {
+                       ReactiveTimeoutTermination) {
   {
     SetupBackgroundTracingManager();
 
+
+    base::RunLoop run_loop;
     BackgroundTracingManagerUploadConfigWrapper upload_config_wrapper(
-        (base::Closure()));
+        run_loop.QuitClosure());
 
-    scoped_ptr<BackgroundTracingConfig> config(
-        new BackgroundTracingReactiveConfig());
+    scoped_ptr<BackgroundTracingReactiveConfig> config =
+        CreateReactiveConfig();
 
-    bool result = BackgroundTracingManager::GetInstance()->SetActiveScenario(
+    BackgroundTracingManager::TriggerHandle handle =
+        BackgroundTracingManager::
+            GetInstance()->RegisterTriggerType("reactive_test");
+
+    BackgroundTracingManager::GetInstance()->SetActiveScenario(
         config.Pass(), upload_config_wrapper.get_receive_callback(), true);
 
-    EXPECT_FALSE(result);
+    BackgroundTracingManager::GetInstance()->WhenIdle(
+        base::Bind(&DisableScenarioWhenIdle));
+
+    BackgroundTracingManager::GetInstance()->TriggerNamedEvent(

[dsinclair, 2015/06/01 19:14:52]

What is the timeout this is using? How long will this test require to timeout?

[fmeawad, 2015/06/02 21:15:27]

I added a Test fire to make it instant, it used to be 10s, another approach
would be to use a MockTimer but would require exposing the timer to the test.

+        handle, base::Bind(&StartedFinalizingCallback, base::Closure(), true));
+
+    run_loop.Run();
+
+    EXPECT_TRUE(upload_config_wrapper.get_receive_count() == 1);
   }
 }
 
+// This tests that reactive mode records and terminates with a second trigger.
+IN_PROC_BROWSER_TEST_F(BackgroundTracingManagerBrowserTest,
+                       ReactiveSecondTriggerTermination) {
+  {
+    SetupBackgroundTracingManager();
+
+

[dsinclair, 2015/06/01 19:14:52]

nit: extra blank line.

[fmeawad, 2015/06/02 21:15:28]

Done.

+    base::RunLoop run_loop;
+    BackgroundTracingManagerUploadConfigWrapper upload_config_wrapper(
+        run_loop.QuitClosure());
+
+    scoped_ptr<BackgroundTracingReactiveConfig> config =
+        CreateReactiveConfig();
+
+    BackgroundTracingManager::TriggerHandle handle =
+        BackgroundTracingManager::
+            GetInstance()->RegisterTriggerType("reactive_test");
+
+    BackgroundTracingManager::GetInstance()->SetActiveScenario(
+        config.Pass(), upload_config_wrapper.get_receive_callback(), true);
+
+    BackgroundTracingManager::GetInstance()->WhenIdle(
+        base::Bind(&DisableScenarioWhenIdle));
+
+    BackgroundTracingManager::GetInstance()->TriggerNamedEvent(
+        handle, base::Bind(&StartedFinalizingCallback, base::Closure(), true));
+    // second trigger to terminate.
+    BackgroundTracingManager::GetInstance()->TriggerNamedEvent(

[dsinclair, 2015/06/01 19:14:52]

How do we know this terminated because of the second event and not because of
timeout?

[fmeawad, 2015/06/02 21:15:28]

The timeout is 10 seconds. It is not guaranteed, but I would doubt it gets
de-scheduled for that long.

+        handle, base::Bind(&StartedFinalizingCallback, base::Closure(), true));
+
+    run_loop.Run();
+
+    EXPECT_TRUE(upload_config_wrapper.get_receive_count() == 1);
+  }
+}
+
+// This tests that reactive mode multiple still triggers gathers once.

[dsinclair, 2015/06/01 19:14:52]

I'm not sure what this is trying to say? triggers gathering once?

[fmeawad, 2015/06/02 21:15:28]

Fixed.

+IN_PROC_BROWSER_TEST_F(BackgroundTracingManagerBrowserTest,
+                       ReactiveThirdTriggerTimeout) {
+  {
+    SetupBackgroundTracingManager();
+
+

[dsinclair, 2015/06/01 19:14:52]

nit: remove blank link.

[fmeawad, 2015/06/02 21:15:28]

Done.

+    base::RunLoop run_loop;
+    BackgroundTracingManagerUploadConfigWrapper upload_config_wrapper(
+        run_loop.QuitClosure());
+
+    scoped_ptr<BackgroundTracingReactiveConfig> config =
+        CreateReactiveConfig();
+
+    BackgroundTracingManager::TriggerHandle handle =
+        BackgroundTracingManager::
+            GetInstance()->RegisterTriggerType("reactive_test");
+
+    BackgroundTracingManager::GetInstance()->SetActiveScenario(
+        config.Pass(), upload_config_wrapper.get_receive_callback(), true);
+
+    BackgroundTracingManager::GetInstance()->WhenIdle(
+        base::Bind(&DisableScenarioWhenIdle));
+
+    BackgroundTracingManager::GetInstance()->TriggerNamedEvent(
+        handle, base::Bind(&StartedFinalizingCallback, base::Closure(), true));
+    // second trigger to terminate.
+    BackgroundTracingManager::GetInstance()->TriggerNamedEvent(
+        handle, base::Bind(&StartedFinalizingCallback, base::Closure(), true));
+    // third trigger to trigger again, fails as it is still gathering.
+    BackgroundTracingManager::GetInstance()->TriggerNamedEvent(
+        handle, base::Bind(&StartedFinalizingCallback, base::Closure(), false));

[dsinclair, 2015/06/01 19:14:52]

How do we know this failed?

[fmeawad, 2015/06/02 21:15:28]

The callback (StartedFinalizingCallback) is bound using the expected value
(false here) and get the actual value comes from the callback.Run(false).
(called from TiggerNamedEvent).

+
+    run_loop.Run();
+
+    EXPECT_TRUE(upload_config_wrapper.get_receive_count() == 1);
+  }
+}
+
 }  // namespace content