Mac: Clicking an omnibox decoration should not highlight the omnibox.

chrome/browser/ui/cocoa/location_bar/autocomplete_text_field_unittest.mm

 // 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.
 
 #import <ApplicationServices/ApplicationServices.h>
 #import <Cocoa/Cocoa.h>
 
 #include "base/mac/foundation_util.h"
 #include "base/mac/scoped_nsobject.h"
 #import "chrome/browser/ui/cocoa/cocoa_test_helper.h"
@@ skipping 33 matching lines @@
   // Note: It does not matter which images are used here - but ButtonDecoration
   // needs _some_ images to work properly.
   MockButtonDecoration()
       : ButtonDecoration(IMAGE_GRID(IDR_OMNIBOX_EV_BUBBLE),
                          IDR_OMNIBOX_EV_BUBBLE_CENTER,
                          IMAGE_GRID(IDR_OMNIBOX_EV_BUBBLE),
                          IDR_OMNIBOX_EV_BUBBLE_CENTER,
                          IMAGE_GRID(IDR_OMNIBOX_EV_BUBBLE),
                          IDR_OMNIBOX_EV_BUBBLE_CENTER,
                          3) {}
-  void Hide() { SetVisible(false); }
   MOCK_METHOD2(OnMousePressed, bool(NSRect frame, NSPoint location));
 };

[Scott Hess - ex-Googler, 2015/05/08 19:38:28]

Given the current code, this class seems like it is no longer relevant, and
MockDecoration could be used instead.

[erikchen, 2015/05/08 20:02:20]

Yup, removed.

 
 // Mock up an incrementing event number.
 NSUInteger eventNumber = 0;
 
 // Create an event of the indicated |type| at |point| within |view|.
 // TODO(shess): Would be nice to have a MockApplication which provided
 // nifty accessors to create these things and inject them.  It could
 // even provide functions for "Click and drag mouse from point A to
 // point B".
 // TODO(groby): This is very similar to cocoa_testing_utils - unify.
@@ skipping 96 matching lines @@
 
   virtual void TearDown() {
     // Clear the observer so that we don't show output for
     // uninteresting messages to the mock (for instance, if |field_| has
     // focus at the end of the test).
     [field_ setObserver:NULL];
 
     AutocompleteTextFieldTest::TearDown();
   }
 
+  // Returns the center point of the decoration.
+  NSPoint ClickLocationForDecoration(LocationBarDecoration* decoration) {
+    AutocompleteTextFieldCell* cell = [field_ cell];
+    NSRect decoration_rect =
+        [cell frameForDecoration:decoration inFrame:[field_ bounds]];
+    EXPECT_FALSE(NSIsEmptyRect(decoration_rect));
+    return NSMakePoint(NSMidX(decoration_rect), NSMidY(decoration_rect));
+  }
+
+  void SendMouseClickToDecoration(LocationBarDecoration* decoration) {
+    NSPoint point = ClickLocationForDecoration(decoration);
+    NSEvent* downEvent = Event(field_, point, NSLeftMouseDown);
+    NSEvent* upEvent = Event(field_, point, NSLeftMouseUp);
+
+    // Can't just use -sendEvent:, since that doesn't populate -currentEvent.
+    [NSApp postEvent:downEvent atStart:YES];
+    [NSApp postEvent:upEvent atStart:NO];
+
+    NSEvent* next_event = [NSApp nextEventMatchingMask:NSAnyEventMask
+                                             untilDate:nil
+                                                inMode:NSDefaultRunLoopMode
+                                               dequeue:YES];
+    [NSApp sendEvent:next_event];
+  }
+
   StrictMock<MockAutocompleteTextFieldObserver> field_observer_;
 };
 
 // Test that we have the right cell class.
 TEST_F(AutocompleteTextFieldTest, CellClass) {
   EXPECT_TRUE([[field_ cell] isKindOfClass:[AutocompleteTextFieldCell class]]);
 }
 
 // Test that becoming first responder sets things up correctly.
 TEST_F(AutocompleteTextFieldTest, FirstResponder) {
@@ skipping 404 matching lines @@
   EXPECT_TRUE(NSEqualRanges(allRange, [[field_ currentEditor] selectedRange]));
 
   // Generate another click on the decoration.
   downEvent = Event(field_, location, NSLeftMouseDown, 1);
   upEvent = Event(field_, location, NSLeftMouseUp, 1);
   [NSApp postEvent:upEvent atStart:YES];
   EXPECT_CALL(mock_left_decoration_, OnMousePressed(_, _))
       .WillOnce(Return(true));
   [field_ mouseDown:downEvent];
 
+  // The text field should no longer be first responder.
   // The selection should not have changed.
-  EXPECT_TRUE(NSEqualRanges(allRange, [[field_ currentEditor] selectedRange]));
+  EXPECT_FALSE([base::mac::ObjCCast<NSView>([[field_ window] firstResponder])
+      isDescendantOf:field_]);
 
   // TODO(shess): Test that mouse drags are initiated if the next
   // event is a drag, or if the mouse-up takes too long to arrive.
   // IDEA: mock decoration to return a pasteboard which a mock
   // AutocompleteTextField notes in -dragImage:*.
 }
 
 // Clicking a decoration should call decoration's OnMousePressed.
 TEST_F(AutocompleteTextFieldTest, RightDecorationMouseDown) {
   // At this point, not focussed.
@@ skipping 173 matching lines @@
                             ofView:field_];
   EXPECT_FALSE([[field_ cell] showsFirstResponder]);
   EXPECT_FALSE([FieldEditor() shouldDrawInsertionPoint]);
 
   [[field_ cell] setHideFocusState:NO
                             ofView:field_];
   EXPECT_TRUE([[field_ cell] showsFirstResponder]);
   EXPECT_TRUE([FieldEditor() shouldDrawInsertionPoint]);
 }
 
-// Verify that OnSetFocus for button decorations is only sent after the
-// decoration is picked as the target for the subsequent -mouseDown:. Otherwise
-// hiding a ButtonDecoration in OnSetFocus will prevent a call to
-// OnMousePressed, since it is already hidden at the time of mouseDown.
-TEST_F(AutocompleteTextFieldObserverTest, ButtonDecorationFocus) {
-  // Add the mock button.
-  MockButtonDecoration mock_button;
-  mock_button.SetVisible(true);
+// Verify that clicking decorations defocuses the omnibox.
+TEST_F(AutocompleteTextFieldObserverTest, ClickingDecorationDefocusesOmnibox) {
   AutocompleteTextFieldCell* cell = [field_ cell];
-  [cell addLeftDecoration:&mock_button];
 
-  // Ensure button is hidden when OnSetFocus() is called.
-  EXPECT_CALL(field_observer_, OnSetFocus(false)).WillOnce(
-      testing::InvokeWithoutArgs(&mock_button, &MockButtonDecoration::Hide));
+  // Set up a non-interactive decoration.
+  MockDecoration noninteractive_decoration;
+  noninteractive_decoration.SetVisible(true);
+  EXPECT_CALL(noninteractive_decoration, AcceptsMousePress())
+      .WillRepeatedly(testing::Return(false));
+  [cell addLeftDecoration:&noninteractive_decoration];
 
-  // Ignore incidental calls.
+  // Set up an interactive decoration.
+  MockButtonDecoration interactive_decoration;
+  interactive_decoration.SetVisible(true);
+  [cell addLeftDecoration:&interactive_decoration];
+  EXPECT_CALL(interactive_decoration, OnMousePressed(_, _))
+      .WillOnce(testing::Return(true));
+
+  // Ignore incidental calls. The exact frequency of these calls doesn't
+  // matter, as they auxiliary to the behavior being tested.

[Scott Hess - ex-Googler, 2015/05/08 19:38:28]

probably "they are auxiliary"

[erikchen, 2015/05/08 20:02:21]

Done.

   EXPECT_CALL(field_observer_, SelectionRangeForProposedRange(_))
       .WillRepeatedly(testing::Return(NSMakeRange(0, 0)));
-  EXPECT_CALL(field_observer_, OnMouseDown(_));
-
-  // Still expect an OnMousePressed on the button.
-  EXPECT_CALL(mock_button, OnMousePressed(_, _))
-      .WillOnce(testing::Return(true));
-
-  // Get click point for button decoration.
-  NSRect button_rect =
-      [cell frameForDecoration:&mock_button inFrame:[field_ bounds]];
-  EXPECT_FALSE(NSIsEmptyRect(button_rect));
-  NSPoint click_location =
-      NSMakePoint(NSMidX(button_rect), NSMidY(button_rect));
+  EXPECT_CALL(field_observer_, OnMouseDown(_)).Times(testing::AnyNumber());
+  EXPECT_CALL(field_observer_, OnSetFocus(false)).Times(testing::AnyNumber());
+  EXPECT_CALL(field_observer_, OnKillFocus()).Times(testing::AnyNumber());
+  EXPECT_CALL(field_observer_, OnDidEndEditing()).Times(testing::AnyNumber());
 
   // Ensure the field is currently not first responder.
   [test_window() makePretendKeyWindowAndSetFirstResponder:nil];
-  EXPECT_NSNE([[field_ window] firstResponder], field_);
+  EXPECT_FALSE([base::mac::ObjCCast<NSView>([[field_ window] firstResponder])
+      isDescendantOf:field_]);
 
-  // Execute button click event sequence.
-  NSEvent* downEvent = Event(field_, click_location, NSLeftMouseDown);
-  NSEvent* upEvent = Event(field_, click_location, NSLeftMouseUp);
+  SendMouseClickToDecoration(&noninteractive_decoration);
+  EXPECT_TRUE([base::mac::ObjCCast<NSView>([[field_ window] firstResponder])
+      isDescendantOf:field_]);
 
-  // Can't just use -sendEvent:, since that doesn't populate -currentEvent.
-  [NSApp postEvent:downEvent atStart:YES];
-  [NSApp postEvent:upEvent atStart:NO];
-  NSEvent* next_event = [NSApp nextEventMatchingMask:NSAnyEventMask
-                                           untilDate:nil
-                                              inMode:NSDefaultRunLoopMode
-                                             dequeue:YES];
-  [NSApp sendEvent:next_event];
+  SendMouseClickToDecoration(&interactive_decoration);
+  EXPECT_FALSE([base::mac::ObjCCast<NSView>([[field_ window] firstResponder])
+      isDescendantOf:field_]);

[Scott Hess - ex-Googler, 2015/05/08 19:38:28]

This ties in with the comment in the implementation, I think this should verify
that the interactive_decoration click does not change the first responder,
whoever it was beforehand.

[erikchen, 2015/05/08 20:02:20]

See my response to the earlier comment.

 
-  // Expectations check that both OnSetFocus and OnMouseDown were called.
-  // Additionally, ensure button is hidden and field is firstResponder.
-  EXPECT_FALSE(mock_button.IsVisible());
-  EXPECT_TRUE(NSIsEmptyRect([cell frameForDecoration:&mock_left_decoration_
-                                             inFrame:[field_ bounds]]));
-  EXPECT_TRUE([base::mac::ObjCCastStrict<NSView>(
-      [[field_ window] firstResponder]) isDescendantOf:field_]);
+  SendMouseClickToDecoration(&noninteractive_decoration);
+  EXPECT_TRUE([base::mac::ObjCCast<NSView>([[field_ window] firstResponder])
+      isDescendantOf:field_]);
 }
 
 TEST_F(AutocompleteTextFieldObserverTest, SendsEditingMessages) {
   // Many of these methods try to change the selection.
   EXPECT_CALL(field_observer_, SelectionRangeForProposedRange(A<NSRange>()))
       .WillRepeatedly(ReturnArg<0>());
 
   EXPECT_CALL(field_observer_, OnSetFocus(false));
   // Becoming first responder doesn't begin editing.
   [test_window() makePretendKeyWindowAndSetFirstResponder:field_];
@@ skipping 38 matching lines @@
   base::scoped_nsobject<AutocompleteTextField> pin([field_ retain]);
   [field_ removeFromSuperview];
   [test_window() resignKeyWindow];
 
   [[test_window() contentView] addSubview:field_];
   EXPECT_CALL(field_observer_, ClosePopup());
   [test_window() resignKeyWindow];
 }
 
 }  // namespace