Added Ash.SystemMenu.DefaultView.VisibleItems histogram.

ash/common/system/tray/system_tray_unittest.cc

 // Copyright (c) 2012 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 "ash/common/system/tray/system_tray.h"
 
+#include <string>
 #include <vector>
 
 #include "ash/common/accessibility_delegate.h"
 #include "ash/common/shelf/wm_shelf.h"
 #include "ash/common/shell_window_ids.h"
 #include "ash/common/system/status_area_widget.h"
 #include "ash/common/system/tray/system_tray_bubble.h"
 #include "ash/common/system/tray/system_tray_item.h"
 #include "ash/common/system/tray/tray_constants.h"
 #include "ash/common/system/tray/tray_popup_item_container.h"
 #include "ash/common/system/web_notification/web_notification_tray.h"
 #include "ash/common/wm_root_window_controller.h"
 #include "ash/common/wm_shell.h"
 #include "ash/common/wm_window.h"
 #include "ash/test/ash_test_base.h"
 #include "ash/test/status_area_widget_test_helper.h"
+#include "ash/test/test_system_tray_item.h"
 #include "base/run_loop.h"
-#include "base/strings/utf_string_conversions.h"
+#include "base/test/histogram_tester.h"
 #include "ui/base/ui_base_types.h"
 #include "ui/compositor/scoped_animation_duration_scale_mode.h"
 #include "ui/events/test/event_generator.h"
 #include "ui/gfx/geometry/point.h"
 #include "ui/gfx/geometry/rect.h"
-#include "ui/views/controls/label.h"
-#include "ui/views/layout/fill_layout.h"
 #include "ui/views/view.h"
 #include "ui/views/widget/widget.h"
 #include "ui/views/widget/widget_delegate.h"
 
 #if defined(OS_WIN)
 #include "base/win/windows_version.h"
 #endif
 
 namespace ash {
 namespace test {
 
 namespace {
 
-// Trivial item implementation that tracks its views for testing.
-class TestItem : public SystemTrayItem {
- public:
-  TestItem()
-      : SystemTrayItem(AshTestBase::GetPrimarySystemTray()),
-        tray_view_(nullptr),
-        default_view_(nullptr),
-        detailed_view_(nullptr),
-        notification_view_(nullptr) {}
-
-  views::View* CreateTrayView(LoginStatus status) override {
-    tray_view_ = new views::View;
-    // Add a label so it has non-zero width.
-    tray_view_->SetLayoutManager(new views::FillLayout);
-    tray_view_->AddChildView(new views::Label(base::UTF8ToUTF16("Tray")));
-    return tray_view_;
-  }
-
-  views::View* CreateDefaultView(LoginStatus status) override {
-    default_view_ = new views::View;
-    default_view_->SetLayoutManager(new views::FillLayout);
-    default_view_->AddChildView(new views::Label(base::UTF8ToUTF16("Default")));
-    return default_view_;
-  }
-
-  views::View* CreateDetailedView(LoginStatus status) override {
-    detailed_view_ = new views::View;
-    detailed_view_->SetLayoutManager(new views::FillLayout);
-    detailed_view_->AddChildView(
-        new views::Label(base::UTF8ToUTF16("Detailed")));
-    return detailed_view_;
-  }
-
-  views::View* CreateNotificationView(LoginStatus status) override {
-    notification_view_ = new views::View;
-    return notification_view_;
-  }
-
-  void DestroyTrayView() override { tray_view_ = NULL; }
-
-  void DestroyDefaultView() override { default_view_ = NULL; }
-
-  void DestroyDetailedView() override { detailed_view_ = NULL; }
-
-  void DestroyNotificationView() override { notification_view_ = NULL; }
-
-  void UpdateAfterLoginStatusChange(LoginStatus status) override {}
-
-  views::View* tray_view() const { return tray_view_; }
-  views::View* default_view() const { return default_view_; }
-  views::View* detailed_view() const { return detailed_view_; }
-  views::View* notification_view() const { return notification_view_; }
-
- private:
-  views::View* tray_view_;
-  views::View* default_view_;
-  views::View* detailed_view_;
-  views::View* notification_view_;
-};
-
-// Trivial item implementation that returns NULL from tray/default/detailed
-// view creation methods.
-class TestNoViewItem : public SystemTrayItem {
- public:
-  TestNoViewItem() : SystemTrayItem(AshTestBase::GetPrimarySystemTray()) {}
-
-  views::View* CreateTrayView(LoginStatus status) override { return nullptr; }
-
-  views::View* CreateDefaultView(LoginStatus status) override {
-    return nullptr;
-  }
-
-  views::View* CreateDetailedView(LoginStatus status) override {
-    return nullptr;
-  }
-
-  views::View* CreateNotificationView(LoginStatus status) override {
-    return nullptr;
-  }
-
-  void DestroyTrayView() override {}
-  void DestroyDefaultView() override {}
-  void DestroyDetailedView() override {}
-  void DestroyNotificationView() override {}
-  void UpdateAfterLoginStatusChange(LoginStatus status) override {}
-};
+const std::string kVisibleRowsHistogramName =

[James Cook, 2016/07/20 20:13:49]

I don't think we're allowed to have statically initialized variables with
non-POD-types. I would use const char foo[]

[bruthig, 2016/07/21 14:34:58]

Done.

+    "Ash.SystemMenu.DefaultView.VisibleRows";
 
 class ModalWidgetDelegate : public views::WidgetDelegateView {
  public:
   ModalWidgetDelegate() {}
   ~ModalWidgetDelegate() override {}
 
   views::View* GetContentsView() override { return this; }
   ui::ModalType GetModalType() const override { return ui::MODAL_TYPE_SYSTEM; }
 
  private:
   DISALLOW_COPY_AND_ASSIGN(ModalWidgetDelegate);
 };
 
 }  // namespace
 
 typedef AshTestBase SystemTrayTest;
 
+// Verifies only the visible default views are recorded in the
+// "Ash.SystemMenu.DefaultView.VisibleItems" histogram.
+TEST_F(SystemTrayTest, OnlyVisibleItemsRecorded) {
+  SystemTray* tray = GetPrimarySystemTray();
+  ASSERT_TRUE(tray->GetWidget());
+
+  TestSystemTrayItem* test_item = new TestSystemTrayItem(true);
+  tray->AddTrayItem(test_item);
+
+  base::HistogramTester histogram_tester;
+
+  tray->ShowDefaultView(BUBBLE_CREATE_NEW);
+  RunAllPendingInMessageLoop();
+  histogram_tester.ExpectBucketCount(kVisibleRowsHistogramName,
+                                     SystemTrayItem::TEST, 1);
+
+  ASSERT_TRUE(tray->CloseSystemBubble());
+  RunAllPendingInMessageLoop();
+
+  tray->ShowDefaultView(BUBBLE_CREATE_NEW);
+  RunAllPendingInMessageLoop();
+  histogram_tester.ExpectBucketCount(kVisibleRowsHistogramName,
+                                     SystemTrayItem::TEST, 2);
+
+  ASSERT_TRUE(tray->CloseSystemBubble());
+  RunAllPendingInMessageLoop();
+
+  test_item->set_views_are_visible(false);
+
+  tray->ShowDefaultView(BUBBLE_CREATE_NEW);
+  RunAllPendingInMessageLoop();
+  histogram_tester.ExpectBucketCount(kVisibleRowsHistogramName,
+                                     SystemTrayItem::TEST, 2);
+
+  ASSERT_TRUE(tray->CloseSystemBubble());
+  RunAllPendingInMessageLoop();
+}
+
+// Verifies null default views are not recorded in the
+// "Ash.SystemMenu.DefaultView.VisibleItems" histogram.
+TEST_F(SystemTrayTest, NullDefaultViewIsNotRecorded) {
+  SystemTray* tray = GetPrimarySystemTray();
+  ASSERT_TRUE(tray->GetWidget());
+
+  TestSystemTrayItem* test_item = new TestSystemTrayItem(false);
+  tray->AddTrayItem(test_item);
+
+  base::HistogramTester histogram_tester;
+
+  tray->ShowDefaultView(BUBBLE_CREATE_NEW);
+  RunAllPendingInMessageLoop();
+  histogram_tester.ExpectBucketCount(kVisibleRowsHistogramName,
+                                     SystemTrayItem::TEST, 0);
+
+  ASSERT_TRUE(tray->CloseSystemBubble());
+  RunAllPendingInMessageLoop();
+}
+
+// Verifies visible detailed views are not recorded in the
+// "Ash.SystemMenu.DefaultView.VisibleItems" histogram.
+TEST_F(SystemTrayTest, VisibleDetailedViewsIsNotRecorded) {
+  SystemTray* tray = GetPrimarySystemTray();
+  ASSERT_TRUE(tray->GetWidget());
+
+  TestSystemTrayItem* test_item = new TestSystemTrayItem(true);
+  tray->AddTrayItem(test_item);
+
+  base::HistogramTester histogram_tester;
+
+  tray->ShowDetailedView(test_item, 0, false, BUBBLE_CREATE_NEW);
+  RunAllPendingInMessageLoop();
+
+  histogram_tester.ExpectTotalCount(kVisibleRowsHistogramName, 0);
+
+  ASSERT_TRUE(tray->CloseSystemBubble());
+  RunAllPendingInMessageLoop();
+}
+
+// Verifies visible default views are not recorded for menu re-shows in the
+// "Ash.SystemMenu.DefaultView.VisibleItems" histogram.
+TEST_F(SystemTrayTest, VisibleDefaultViewIsNotRecordedOnReshow) {
+  SystemTray* tray = GetPrimarySystemTray();
+  ASSERT_TRUE(tray->GetWidget());
+
+  TestSystemTrayItem* test_item = new TestSystemTrayItem(true);
+  tray->AddTrayItem(test_item);
+
+  base::HistogramTester histogram_tester;
+
+  tray->ShowDefaultView(BUBBLE_CREATE_NEW);
+  RunAllPendingInMessageLoop();
+  histogram_tester.ExpectBucketCount(kVisibleRowsHistogramName,
+                                     SystemTrayItem::TEST, 1);
+
+  tray->ShowDetailedView(test_item, 0, false, BUBBLE_USE_EXISTING);
+  RunAllPendingInMessageLoop();
+  histogram_tester.ExpectBucketCount(kVisibleRowsHistogramName,
+                                     SystemTrayItem::TEST, 1);
+
+  tray->ShowDefaultView(BUBBLE_USE_EXISTING);
+  RunAllPendingInMessageLoop();
+  histogram_tester.ExpectBucketCount(kVisibleRowsHistogramName,
+                                     SystemTrayItem::TEST, 1);
+
+  ASSERT_TRUE(tray->CloseSystemBubble());
+  RunAllPendingInMessageLoop();
+}

[James Cook, 2016/07/20 20:13:49]

Thanks for writing a nice test suite for this.

+
 TEST_F(SystemTrayTest, SystemTrayDefaultView) {
   SystemTray* tray = GetPrimarySystemTray();
   ASSERT_TRUE(tray->GetWidget());
 
   tray->ShowDefaultView(BUBBLE_CREATE_NEW);
 
   // Ensure that closing the bubble destroys it.
   ASSERT_TRUE(tray->CloseSystemBubble());
   RunAllPendingInMessageLoop();
   ASSERT_FALSE(tray->CloseSystemBubble());
@@ skipping 36 matching lines @@
   ASSERT_FALSE(tray->draw_background_as_active());
   RunAllPendingInMessageLoop();
   // The bubble should already be closed by now.
   ASSERT_FALSE(tray->CloseSystemBubble());
 }
 
 TEST_F(SystemTrayTest, SystemTrayTestItems) {
   SystemTray* tray = GetPrimarySystemTray();
   ASSERT_TRUE(tray->GetWidget());
 
-  TestItem* test_item = new TestItem;
-  TestItem* detailed_item = new TestItem;
+  TestSystemTrayItem* test_item = new TestSystemTrayItem(true);
+  TestSystemTrayItem* detailed_item = new TestSystemTrayItem(true);
   tray->AddTrayItem(test_item);
   tray->AddTrayItem(detailed_item);
 
   // Check items have been added
   const std::vector<SystemTrayItem*>& items = tray->GetTrayItems();
   ASSERT_TRUE(std::find(items.begin(), items.end(), test_item) != items.end());
   ASSERT_TRUE(std::find(items.begin(), items.end(), detailed_item) !=
               items.end());
 
   // Ensure the tray views are created.
@@ skipping 16 matching lines @@
   RunAllPendingInMessageLoop();
   ASSERT_TRUE(test_item->default_view() != NULL);
   ASSERT_TRUE(detailed_item->detailed_view() == NULL);
 }
 
 TEST_F(SystemTrayTest, SystemTrayNoViewItems) {
   SystemTray* tray = GetPrimarySystemTray();
   ASSERT_TRUE(tray->GetWidget());
 
   // Verify that no crashes occur on items lacking some views.
-  TestNoViewItem* no_view_item = new TestNoViewItem;
+  TestSystemTrayItem* no_view_item = new TestSystemTrayItem(false);
   tray->AddTrayItem(no_view_item);
   tray->ShowDefaultView(BUBBLE_CREATE_NEW);
   tray->ShowDetailedView(no_view_item, 0, false, BUBBLE_USE_EXISTING);
   RunAllPendingInMessageLoop();
 }
 
 TEST_F(SystemTrayTest, TrayWidgetAutoResizes) {
   SystemTray* tray = GetPrimarySystemTray();
   ASSERT_TRUE(tray->GetWidget());
 
   // Add an initial tray item so that the tray gets laid out correctly.
-  TestItem* initial_item = new TestItem;
+  TestSystemTrayItem* initial_item = new TestSystemTrayItem(true);
   tray->AddTrayItem(initial_item);
 
   gfx::Size initial_size = tray->GetWidget()->GetWindowBoundsInScreen().size();
 
-  TestItem* new_item = new TestItem;
+  TestSystemTrayItem* new_item = new TestSystemTrayItem(true);
   tray->AddTrayItem(new_item);
 
   gfx::Size new_size = tray->GetWidget()->GetWindowBoundsInScreen().size();
 
   // Adding the new item should change the size of the tray.
   EXPECT_NE(initial_size.ToString(), new_size.ToString());
 
   // Hiding the tray view of the new item should also change the size of the
   // tray.
   new_item->tray_view()->SetVisible(false);
   EXPECT_EQ(initial_size.ToString(),
             tray->GetWidget()->GetWindowBoundsInScreen().size().ToString());
 
   new_item->tray_view()->SetVisible(true);
   EXPECT_EQ(new_size.ToString(),
             tray->GetWidget()->GetWindowBoundsInScreen().size().ToString());
 }
 
 TEST_F(SystemTrayTest, SystemTrayNotifications) {
   SystemTray* tray = GetPrimarySystemTray();
   ASSERT_TRUE(tray->GetWidget());
 
-  TestItem* test_item = new TestItem;
-  TestItem* detailed_item = new TestItem;
+  TestSystemTrayItem* test_item = new TestSystemTrayItem(true);
+  TestSystemTrayItem* detailed_item = new TestSystemTrayItem(true);
   tray->AddTrayItem(test_item);
   tray->AddTrayItem(detailed_item);
 
   // Ensure the tray views are created.
   ASSERT_TRUE(test_item->tray_view() != NULL);
   ASSERT_TRUE(detailed_item->tray_view() != NULL);
 
   // Ensure a notification view is created.
   tray->ShowNotificationView(test_item);
   ASSERT_TRUE(test_item->notification_view() != NULL);
@@ skipping 13 matching lines @@
   ASSERT_TRUE(tray->CloseSystemBubble());
   RunAllPendingInMessageLoop();
   ASSERT_TRUE(detailed_item->detailed_view() == NULL);
   ASSERT_TRUE(test_item->notification_view() != NULL);
 }
 
 TEST_F(SystemTrayTest, BubbleCreationTypesTest) {
   SystemTray* tray = GetPrimarySystemTray();
   ASSERT_TRUE(tray->GetWidget());
 
-  TestItem* test_item = new TestItem;
+  TestSystemTrayItem* test_item = new TestSystemTrayItem(true);
   tray->AddTrayItem(test_item);
 
   // Ensure the tray views are created.
   ASSERT_TRUE(test_item->tray_view() != NULL);
 
   // Show the default view, ensure the notification view is destroyed.
   tray->ShowDefaultView(BUBBLE_CREATE_NEW);
   RunAllPendingInMessageLoop();
 
   views::Widget* widget = test_item->default_view()->GetWidget();
@@ skipping 49 matching lines @@
   shelf->SetAlignment(SHELF_ALIGNMENT_LEFT);
   window_bounds = widget->GetWindowBoundsInScreen();
   tray_bounds = tray->GetBoundsInScreen();
   EXPECT_TRUE(window_bounds.Contains(tray_bounds));
 }
 
 TEST_F(SystemTrayTest, PersistentBubble) {
   SystemTray* tray = GetPrimarySystemTray();
   ASSERT_TRUE(tray->GetWidget());
 
-  TestItem* test_item = new TestItem;
+  TestSystemTrayItem* test_item = new TestSystemTrayItem(true);
   tray->AddTrayItem(test_item);
 
   std::unique_ptr<views::Widget> widget(CreateTestWidget(
       nullptr, kShellWindowId_DefaultContainer, gfx::Rect(0, 0, 100, 100)));
 
   // Tests for usual default view while activating a window.
   tray->ShowDefaultView(BUBBLE_CREATE_NEW);
   ASSERT_TRUE(tray->HasSystemBubble());
   widget->Activate();
   base::RunLoop().RunUntilIdle();
@@ skipping 148 matching lines @@
   // Hide the default view, ensure the tray bubble height is back to zero.
   ASSERT_TRUE(tray->CloseSystemBubble());
   RunAllPendingInMessageLoop();
 
   EXPECT_EQ(0, notification_tray->tray_bubble_height_for_test());
 }
 #endif  // OS_CHROMEOS
 
 }  // namespace test
 }  // namespace ash