ash/shelf/shelf_model_unittest.cc

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "ash/shelf/shelf_model.h"
   6
   7 #include <set>
   8 #include <string>
   9
  10 #include "ash/ash_switches.h"
  11 #include "ash/shelf/shelf_model_observer.h"
  12 #include "base/command_line.h"
  13 #include "base/strings/stringprintf.h"
  14 #include "testing/gtest/include/gtest/gtest.h"
  15
  16 namespace ash {
  17
  18 namespace {
  19
  20 // ShelfModelObserver implementation that tracks what message are invoked.
  21 class TestShelfModelObserver : public ShelfModelObserver {
  22  public:
  23   TestShelfModelObserver()
  24       : added_count_(0),
  25         removed_count_(0),
  26         changed_count_(0),
  27         moved_count_(0) {
  28   }
  29
  30   // Returns a string description of the changes that have occurred since this
  31   // was last invoked. Resets state to initial state.
  32   std::string StateStringAndClear() {
  33     std::string result;
  34     AddToResult("added=%d", added_count_, &result);
  35     AddToResult("removed=%d", removed_count_, &result);
  36     AddToResult("changed=%d", changed_count_, &result);
  37     AddToResult("moved=%d", moved_count_, &result);
  38     added_count_ = removed_count_ = changed_count_ = moved_count_ = 0;
  39     return result;
  40   }
  41
  42   // ShelfModelObserver overrides:
  43   void ShelfItemAdded(int index) override { added_count_++; }
  44   void ShelfItemRemoved(int index, ShelfID id) override { removed_count_++; }
  45   void ShelfItemChanged(int index, const ShelfItem& old_item) override {
  46     changed_count_++;
  47   }
  48   void ShelfItemMoved(int start_index, int target_index) override {
  49     moved_count_++;
  50   }
  51   void ShelfStatusChanged() override {}
  52
  53  private:
  54   void AddToResult(const std::string& format, int count, std::string* result) {
  55     if (!count)
  56       return;
  57     if (!result->empty())
  58       *result += " ";
  59     *result += base::StringPrintf(format.c_str(), count);
  60   }
  61
  62   int added_count_;
  63   int removed_count_;
  64   int changed_count_;
  65   int moved_count_;
  66
  67   DISALLOW_COPY_AND_ASSIGN(TestShelfModelObserver);
  68 };
  69
  70 }  // namespace
  71
  72 class ShelfModelTest : public testing::Test {
  73  public:
  74   ShelfModelTest() {}
  75   ~ShelfModelTest() override {}
  76
  77   void SetUp() override {
  78     model_.reset(new ShelfModel);
  79     observer_.reset(new TestShelfModelObserver);
  80     EXPECT_EQ(0, model_->item_count());
  81
  82     ShelfItem item;
  83     item.type = TYPE_APP_LIST;
  84     model_->Add(item);
  85     EXPECT_EQ(1, model_->item_count());
  86
  87     model_->AddObserver(observer_.get());
  88   }
  89
  90   void TearDown() override {
  91     observer_.reset();
  92     model_.reset();
  93   }
  94
  95   scoped_ptr<ShelfModel> model_;
  96   scoped_ptr<TestShelfModelObserver> observer_;
  97
  98  private:
  99   DISALLOW_COPY_AND_ASSIGN(ShelfModelTest);
 100 };
 101
 102 TEST_F(ShelfModelTest, BasicAssertions) {
 103   // Add an item.
 104   ShelfItem item;
 105   item.type = TYPE_APP_SHORTCUT;
 106   int index = model_->Add(item);
 107   EXPECT_EQ(2, model_->item_count());
 108   EXPECT_EQ("added=1", observer_->StateStringAndClear());
 109
 110   // Change to a platform app item.
 111   ShelfID original_id = model_->items()[index].id;
 112   item.type = TYPE_PLATFORM_APP;
 113   model_->Set(index, item);
 114   EXPECT_EQ(original_id, model_->items()[index].id);
 115   EXPECT_EQ("changed=1", observer_->StateStringAndClear());
 116   EXPECT_EQ(TYPE_PLATFORM_APP, model_->items()[index].type);
 117
 118   // Remove the item.
 119   model_->RemoveItemAt(index);
 120   EXPECT_EQ(1, model_->item_count());
 121   EXPECT_EQ("removed=1", observer_->StateStringAndClear());
 122
 123   // Add an app item.
 124   item.type = TYPE_APP_SHORTCUT;
 125   index = model_->Add(item);
 126   observer_->StateStringAndClear();
 127
 128   // Change everything.
 129   model_->Set(index, item);
 130   EXPECT_EQ("changed=1", observer_->StateStringAndClear());
 131   EXPECT_EQ(TYPE_APP_SHORTCUT, model_->items()[index].type);
 132
 133   // Add another item.
 134   item.type = TYPE_APP_SHORTCUT;
 135   model_->Add(item);
 136   observer_->StateStringAndClear();
 137
 138   // Move the second to the first.
 139   model_->Move(1, 0);
 140   EXPECT_EQ("moved=1", observer_->StateStringAndClear());
 141
 142   // And back.
 143   model_->Move(0, 1);
 144   EXPECT_EQ("moved=1", observer_->StateStringAndClear());
 145
 146   // Verifies all the items get unique ids.
 147   std::set<ShelfID> ids;
 148   for (int i = 0; i < model_->item_count(); ++i)
 149     ids.insert(model_->items()[i].id);
 150   EXPECT_EQ(model_->item_count(), static_cast<int>(ids.size()));
 151 }
 152
 153 // Assertions around where items are added.
 154 TEST_F(ShelfModelTest, AddIndices) {
 155   // Insert browser short cut at index 1.
 156   ShelfItem browser_shortcut;
 157   browser_shortcut.type = TYPE_BROWSER_SHORTCUT;
 158   int browser_shortcut_index = model_->Add(browser_shortcut);
 159   EXPECT_EQ(1, browser_shortcut_index);
 160
 161   // platform app items should be after browser shortcut.
 162   ShelfItem item;
 163   item.type = TYPE_PLATFORM_APP;
 164   int platform_app_index1 = model_->Add(item);
 165   EXPECT_EQ(2, platform_app_index1);
 166
 167   // Add another platform app item, it should follow first.
 168   int platform_app_index2 = model_->Add(item);
 169   EXPECT_EQ(3, platform_app_index2);
 170
 171   // APP_SHORTCUT priority is higher than PLATFORM_APP but same as
 172   // BROWSER_SHORTCUT. So APP_SHORTCUT is located after BROWSER_SHORCUT.
 173   item.type = TYPE_APP_SHORTCUT;
 174   int app_shortcut_index1 = model_->Add(item);
 175   EXPECT_EQ(2, app_shortcut_index1);
 176
 177   item.type = TYPE_APP_SHORTCUT;
 178   int app_shortcut_index2 = model_->Add(item);
 179   EXPECT_EQ(3, app_shortcut_index2);
 180
 181   // Check that AddAt() figures out the correct indexes for app shortcuts.
 182   // APP_SHORTCUT and BROWSER_SHORTCUT has the same weight.
 183   // So APP_SHORTCUT is located at index 0. And, BROWSER_SHORTCUT is located at
 184   // index 1.
 185   item.type = TYPE_APP_SHORTCUT;
 186   int app_shortcut_index3 = model_->AddAt(1, item);
 187   EXPECT_EQ(1, app_shortcut_index3);
 188
 189   item.type = TYPE_APP_SHORTCUT;
 190   int app_shortcut_index4 = model_->AddAt(6, item);
 191   EXPECT_EQ(5, app_shortcut_index4);
 192
 193   item.type = TYPE_APP_SHORTCUT;
 194   int app_shortcut_index5 = model_->AddAt(3, item);
 195   EXPECT_EQ(3, app_shortcut_index5);
 196
 197   // Before there are any panels, no icons should be right aligned.
 198   EXPECT_EQ(model_->item_count(), model_->FirstPanelIndex());
 199
 200   // Check that AddAt() figures out the correct indexes for platform apps and
 201   // panels.
 202   item.type = TYPE_PLATFORM_APP;
 203   int platform_app_index3 = model_->AddAt(3, item);
 204   EXPECT_EQ(7, platform_app_index3);
 205
 206   item.type = TYPE_APP_PANEL;
 207   int app_panel_index1 = model_->AddAt(2, item);
 208   EXPECT_EQ(10, app_panel_index1);
 209
 210   item.type = TYPE_PLATFORM_APP;
 211   int platform_app_index4 = model_->AddAt(11, item);
 212   EXPECT_EQ(10, platform_app_index4);
 213
 214   item.type = TYPE_APP_PANEL;
 215   int app_panel_index2 = model_->AddAt(12, item);
 216   EXPECT_EQ(12, app_panel_index2);
 217
 218   item.type = TYPE_PLATFORM_APP;
 219   int platform_app_index5 = model_->AddAt(7, item);
 220   EXPECT_EQ(7, platform_app_index5);
 221
 222   item.type = TYPE_APP_PANEL;
 223   int app_panel_index3 = model_->AddAt(13, item);
 224   EXPECT_EQ(13, app_panel_index3);
 225
 226   // Right aligned index should be the first app panel index.
 227   EXPECT_EQ(12, model_->FirstPanelIndex());
 228
 229   EXPECT_EQ(TYPE_BROWSER_SHORTCUT, model_->items()[2].type);
 230   EXPECT_EQ(TYPE_APP_LIST, model_->items()[0].type);
 231 }
 232
 233 // Test that the indexes for the running applications are properly determined
 234 // when the first running application is a windowed application.
 235 TEST_F(ShelfModelTest, FirstRunningAppIndexUsingWindowedAppFirst) {
 236   // Insert the browser shortcut at index 1 and check that the running
 237   // application index would be behind it.
 238   ShelfItem item;
 239   item.type = TYPE_BROWSER_SHORTCUT;
 240   EXPECT_EQ(1, model_->Add(item));
 241   EXPECT_EQ(2, model_->FirstRunningAppIndex());
 242
 243   // Insert a panel application at the end and check that the running
 244   // application index would be at / before the application panel.
 245   item.type = TYPE_APP_PANEL;
 246   EXPECT_EQ(2, model_->Add(item));
 247   EXPECT_EQ(2, model_->FirstRunningAppIndex());
 248
 249   // Insert an application shortcut and make sure that the running application
 250   // index would be behind it.
 251   item.type = TYPE_APP_SHORTCUT;
 252   EXPECT_EQ(2, model_->Add(item));
 253   EXPECT_EQ(3, model_->FirstRunningAppIndex());
 254
 255   // Insert different running application shortcuts - but first a windowed
 256   // application - and make sure that the same index gets returned.
 257   item.type = TYPE_WINDOWED_APP;
 258   int running_app_index = model_->Add(item);
 259   EXPECT_EQ(3, running_app_index);
 260   EXPECT_EQ(running_app_index, model_->FirstRunningAppIndex());
 261   item.type = TYPE_PLATFORM_APP;
 262   EXPECT_EQ(running_app_index + 1, model_->Add(item));
 263   EXPECT_EQ(running_app_index, model_->FirstRunningAppIndex());
 264 }
 265
 266 // Test that the indexes for the running applications are properly determined
 267 // when the first running application is a platform application.
 268 TEST_F(ShelfModelTest, FirstRunningAppIndexUsingPlatformAppFirst) {
 269   // Insert the browser shortcut at index 1 and check that the running
 270   // application index would be behind it.
 271   ShelfItem item;
 272   item.type = TYPE_BROWSER_SHORTCUT;
 273   EXPECT_EQ(1, model_->Add(item));
 274   EXPECT_EQ(2, model_->FirstRunningAppIndex());
 275
 276   // Insert a panel application at the end and check that the running
 277   // application index would be at / before the application panel.
 278   item.type = TYPE_APP_PANEL;
 279   EXPECT_EQ(2, model_->Add(item));
 280   EXPECT_EQ(2, model_->FirstRunningAppIndex());
 281
 282   // Insert an application shortcut and make sure that the running application
 283   // index would be behind it.
 284   item.type = TYPE_APP_SHORTCUT;
 285   EXPECT_EQ(2, model_->Add(item));
 286   EXPECT_EQ(3, model_->FirstRunningAppIndex());
 287
 288   // Insert different running application shortcuts - but first a platfom
 289   // application - and make sure that the same index gets returned.
 290   item.type = TYPE_PLATFORM_APP;
 291   int running_app_index = model_->Add(item);
 292   EXPECT_EQ(3, running_app_index);
 293   EXPECT_EQ(running_app_index, model_->FirstRunningAppIndex());
 294   item.type = TYPE_WINDOWED_APP;
 295   EXPECT_EQ(running_app_index + 1, model_->Add(item));
 296   EXPECT_EQ(running_app_index, model_->FirstRunningAppIndex());
 297 }
 298
 299 // Assertions around id generation and usage.
 300 TEST_F(ShelfModelTest, ShelfIDTests) {
 301   // Get the next to use ID counter.
 302   ShelfID id = model_->next_id();
 303
 304   // Calling this function multiple times does not change the returned ID.
 305   EXPECT_EQ(model_->next_id(), id);
 306
 307   // Check that when we reserve a value it will be the previously retrieved ID,
 308   // but it will not change the item count and retrieving the next ID should
 309   // produce something new.
 310   EXPECT_EQ(model_->reserve_external_id(), id);
 311   EXPECT_EQ(1, model_->item_count());
 312   ShelfID id2 = model_->next_id();
 313   EXPECT_NE(id2, id);
 314
 315   // Adding another item to the list should also produce a new ID.
 316   ShelfItem item;
 317   item.type = TYPE_PLATFORM_APP;
 318   model_->Add(item);
 319   EXPECT_NE(model_->next_id(), id2);
 320 }
 321
 322 // This verifies that converting an existing item into a lower weight category
 323 // (e.g. shortcut to running but not pinned app) will move it to the proper
 324 // location. See crbug.com/248769.
 325 TEST_F(ShelfModelTest, CorrectMoveItemsWhenStateChange) {
 326   // The first item is the app list and last item is the browser.
 327   ShelfItem browser_shortcut;
 328   browser_shortcut.type = TYPE_BROWSER_SHORTCUT;
 329   int browser_shortcut_index = model_->Add(browser_shortcut);
 330   EXPECT_EQ(TYPE_APP_LIST, model_->items()[0].type);
 331   EXPECT_EQ(1, browser_shortcut_index);
 332
 333   // Add three shortcuts. They should all be moved between the two.
 334   ShelfItem item;
 335   item.type = TYPE_APP_SHORTCUT;
 336   int app1_index = model_->Add(item);
 337   EXPECT_EQ(2, app1_index);
 338   int app2_index = model_->Add(item);
 339   EXPECT_EQ(3, app2_index);
 340   int app3_index = model_->Add(item);
 341   EXPECT_EQ(4, app3_index);
 342
 343   // Now change the type of the second item and make sure that it is moving
 344   // behind the shortcuts.
 345   item.type = TYPE_PLATFORM_APP;
 346   model_->Set(app2_index, item);
 347
 348   // The item should have moved in front of the app launcher.
 349   EXPECT_EQ(TYPE_PLATFORM_APP, model_->items()[4].type);
 350 }
 351
 352 }  // namespace ash