[Mac] Fix handling of download shelf auto close.

chrome/browser/ui/cocoa/download/download_shelf_controller_unittest.mm

+// Copyright 2013 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.
+
+#import <Cocoa/Cocoa.h>
+
+#import "base/memory/scoped_nsobject.h"
+#include "base/memory/scoped_ptr.h"
+#include "chrome/browser/download/download_shelf.h"
+#include "chrome/browser/ui/cocoa/cocoa_profile_test.h"
+#import "chrome/browser/ui/cocoa/download/download_item_controller.h"
+#import "chrome/browser/ui/cocoa/download/download_shelf_controller.h"
+#import "chrome/browser/ui/cocoa/view_resizer_pong.h"
+#include "content/public/test/mock_download_item.h"
+#include "testing/gtest/include/gtest/gtest.h"
+#include "testing/platform_test.h"
+#import "third_party/ocmock/OCMock/OCMock.h"
+#import "third_party/ocmock/gtest_support.h"
+
+using ::testing::Return;
+using ::testing::AnyNumber;
+
+// Wraps a content::MockDownloadItem so it can be retained by the mock
+// DownloadItemController.
+@interface WrappedMockDownloadItem : NSObject {
+ @private
+  scoped_ptr<content::MockDownloadItem> download_;
+}
+- (id)initWithMockDownload:(scoped_ptr<content::MockDownloadItem>)download;
+- (content::DownloadItem*)download;
+- (content::MockDownloadItem*)mockDownload;
+@end
+
+@implementation WrappedMockDownloadItem
+- (id)initWithMockDownload:(scoped_ptr<content::MockDownloadItem>)download {
+  if ((self = [super init])) {
+    download_ = download.Pass();
+  }
+  return self;
+}
+
+- (content::DownloadItem*)download {
+  return download_.get();
+}
+
+- (content::MockDownloadItem*)mockDownload {
+  return download_.get();
+}
+@end
+
+// Test method for accessing the wrapped MockDownloadItem.
+@interface DownloadItemController (DownloadShelfControllerTest) {
+}
+- (WrappedMockDownloadItem*)wrappedMockDownload;
+@end
+
+@implementation DownloadItemController (DownloadShelfControllerTest)
+- (WrappedMockDownloadItem*)wrappedMockDownload {
+  return nil;
+}
+@end
+
+// Subclass of the DownloadShelfController to override scheduleAutoClose and
+// cancelAutoClose. During regular operation, a scheduled autoClose waits for 5
+// seconds before closing the shelf (unless it is cancelled during this
+// time). For testing purposes, we count the number of invocations of
+// {schedule,cancel}AutoClose instead of actually scheduling and cancelling.
+@interface CountingDownloadShelfController : DownloadShelfController {
+ @public
+  int scheduleAutoCloseCount_;
+  int cancelAutoCloseCount_;
+}
+@end
+
+@implementation CountingDownloadShelfController
+
+-(void)scheduleAutoClose {
+  ++scheduleAutoCloseCount_;
+}
+
+-(void)cancelAutoClose {
+  ++cancelAutoCloseCount_;
+}
+@end
+
+namespace {
+
+class DownloadShelfControllerTest : public CocoaProfileTest {
+ public:
+  virtual void SetUp() OVERRIDE {
+    CocoaProfileTest::SetUp();
+    ASSERT_TRUE(browser());
+
+    resize_delegate_.reset([[ViewResizerPong alloc] init]);
+    shelf_.reset([[CountingDownloadShelfController alloc]
+                   initWithBrowser:browser()
+                    resizeDelegate:resize_delegate_.get()]);
+    EXPECT_TRUE([shelf_ view]);
+    [[test_window() contentView] addSubview:[shelf_ view]];
+  }
+
+  virtual void TearDown() OVERRIDE {
+    [shelf_ exiting];
+    shelf_.reset();
+    CocoaProfileTest::TearDown();
+  }
+
+ protected:
+  id CreateItemController();
+
+  scoped_nsobject<CountingDownloadShelfController> shelf_;
+  scoped_nsobject<ViewResizerPong> resize_delegate_;
+};
+
+id DownloadShelfControllerTest::CreateItemController() {
+  scoped_ptr<content::MockDownloadItem> download(
+      new ::testing::NiceMock<content::MockDownloadItem>);
+  ON_CALL(*download.get(), GetOpened())
+      .WillByDefault(Return(false));
+  ON_CALL(*download.get(), IsInProgress())
+      .WillByDefault(Return(true));
+
+  scoped_nsobject<WrappedMockDownloadItem> wrappedMockDownload(
+      [[WrappedMockDownloadItem alloc] initWithMockDownload:download.Pass()]);
+
+  id item_controller =
+      [OCMockObject mockForClass:[DownloadItemController class]];
+  scoped_nsobject<NSView> view([[NSView alloc] initWithFrame:NSZeroRect]);
+  [[[item_controller stub] andCall:@selector(download)
+                          onObject:wrappedMockDownload.get()] download];
+  [[item_controller stub] updateVisibility:[OCMArg any]];
+  [[[item_controller stub]
+     andReturnValue:[NSValue valueWithSize:NSMakeSize(10,10)]] preferredSize];
+  [[[item_controller stub] andReturn:view.get()] view];
+  [[[item_controller stub]
+     andReturn:wrappedMockDownload.get()] wrappedMockDownload];
+  return [item_controller retain];
+}
+
+TEST_VIEW(DownloadShelfControllerTest, [shelf_ view]);
+
+// Removing the last download from the shelf should cause it to close
+// immediately.
+TEST_F(DownloadShelfControllerTest, AddAndRemoveDownload) {
+  scoped_nsobject<DownloadItemController> item(CreateItemController());
+  [shelf_ showDownloadShelf:YES
+               isUserAction:NO];
+  EXPECT_TRUE([shelf_ isVisible]);
+  EXPECT_TRUE([shelf_ bridge]->IsShowing());
+  [shelf_ add:item];
+  [shelf_ remove:item];
+  EXPECT_FALSE([shelf_ isVisible]);
+  EXPECT_FALSE([shelf_ bridge]->IsShowing());
+  // The shelf should be closed without scheduling an autoClose.
+  EXPECT_EQ(0, shelf_.get()->scheduleAutoCloseCount_);
+}
+
+// Test that the shelf doesn't close automatically after a removal if there are
+// active download items still on the shelf.
+TEST_F(DownloadShelfControllerTest, AddAndRemoveWithActiveItem) {
+  scoped_nsobject<DownloadItemController> item1(CreateItemController());
+  scoped_nsobject<DownloadItemController> item2(CreateItemController());
+  [shelf_ showDownloadShelf:YES
+               isUserAction:NO];
+  EXPECT_TRUE([shelf_ isVisible]);
+  [shelf_ add:item1.get()];
+  [shelf_ add:item2.get()];
+  [shelf_ remove:item1.get()];
+  EXPECT_TRUE([shelf_ isVisible]);
+  [shelf_ remove:item2.get()];
+  EXPECT_FALSE([shelf_ isVisible]);
+  EXPECT_EQ(0, shelf_.get()->scheduleAutoCloseCount_);
+}
+
+// DownloadShelf::Unhide() should cause the shelf to be displayed if there are
+// active downloads on it.
+TEST_F(DownloadShelfControllerTest, HideAndUnhide) {
+  scoped_nsobject<DownloadItemController> item(CreateItemController());
+  [shelf_ showDownloadShelf:YES
+               isUserAction:NO];
+  EXPECT_TRUE([shelf_ isVisible]);
+  [shelf_ add:item.get()];
+  [shelf_ bridge]->Hide();
+  EXPECT_FALSE([shelf_ isVisible]);
+  [shelf_ bridge]->Unhide();
+  EXPECT_TRUE([shelf_ isVisible]);
+  [shelf_ remove:item.get()];
+  EXPECT_FALSE([shelf_ isVisible]);
+}
+
+// DownloadShelf::Unhide() shouldn't cause the shelf to be displayed if all
+// active downloads are removed from the shelf while the shelf was hidden.
+TEST_F(DownloadShelfControllerTest, HideAutocloseUnhide) {
+  scoped_nsobject<DownloadItemController> item(CreateItemController());
+  [shelf_ showDownloadShelf:YES
+               isUserAction:NO];
+  EXPECT_TRUE([shelf_ isVisible]);
+  [shelf_ add:item.get()];
+  [shelf_ bridge]->Hide();
+  EXPECT_FALSE([shelf_ isVisible]);
+  [shelf_ remove:item.get()];
+  EXPECT_FALSE([shelf_ isVisible]);
+  [shelf_ bridge]->Unhide();
+  EXPECT_FALSE([shelf_ isVisible]);
+}
+
+// Test of autoclosing behavior after opening a download item. The mouse is on
+// the download shelf at the time the autoclose is scheduled.
+TEST_F(DownloadShelfControllerTest, AutoCloseAfterOpenWithMouseInShelf) {
+  scoped_nsobject<DownloadItemController> item(CreateItemController());
+  [shelf_ showDownloadShelf:YES
+               isUserAction:NO];
+  EXPECT_TRUE([shelf_ isVisible]);
+  [shelf_ add:item.get()];
+
+  // The mouse enters the shelf.
+  [shelf_ mouseEntered:nil];
+  EXPECT_EQ(0, shelf_.get()->scheduleAutoCloseCount_);
+
+  // The download opens.
+  EXPECT_CALL(*[[item wrappedMockDownload] mockDownload], GetOpened())
+      .WillRepeatedly(Return(true));
+  [shelf_ downloadWasOpened:item.get()];
+
+  // The shelf should now be waiting for the mouse to exit. autoClose should not
+  // be scheduled yet.
+  EXPECT_TRUE([shelf_ isVisible]);
+  EXPECT_EQ(0, shelf_.get()->scheduleAutoCloseCount_);
+
+  // The mouse exits the shelf. autoClose should be scheduled now.
+  [shelf_ mouseExited:nil];
+  EXPECT_EQ(1, shelf_.get()->scheduleAutoCloseCount_);
+  EXPECT_EQ(0, shelf_.get()->cancelAutoCloseCount_);
+
+  // The mouse enters the shelf again. The autoClose should be cancelled.
+  [shelf_ mouseEntered:nil];
+  EXPECT_EQ(1, shelf_.get()->scheduleAutoCloseCount_);
+  EXPECT_EQ(1, shelf_.get()->cancelAutoCloseCount_);
+}
+
+// Test of autoclosing behavior after opening a download item.
+TEST_F(DownloadShelfControllerTest, AutoCloseAfterOpenWithMouseOffShelf) {
+  scoped_nsobject<DownloadItemController> item(CreateItemController());
+  [shelf_ showDownloadShelf:YES
+               isUserAction:NO];
+  EXPECT_TRUE([shelf_ isVisible]);
+  [shelf_ add:item.get()];
+
+  // The download is opened.
+  EXPECT_CALL(*[[item wrappedMockDownload] mockDownload], GetOpened())
+      .WillRepeatedly(Return(true));
+  [shelf_ downloadWasOpened:item.get()];
+
+  // The shelf should be closed immediately since the mouse is not over the
+  // shelf.
+  EXPECT_FALSE([shelf_ isVisible]);
+}
+
+}  // namespace