[Mac] Rewrite Omnibox field-editor frame-changing tests.

chrome/browser/cocoa/autocomplete_text_field_unittest.mm

 // Copyright (c) 2009 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/cocoa_protocols_mac.h"
 #include "base/scoped_nsobject.h"
 #import "chrome/browser/cocoa/autocomplete_text_field.h"
 #import "chrome/browser/cocoa/autocomplete_text_field_cell.h"
@@ skipping 47 matching lines @@
                        modifierFlags:flags
                            timestamp:0.0
                         windowNumber:[cocoa_helper_.window() windowNumber]
                              context:nil
                           characters:@"a"
          charactersIgnoringModifiers:@"a"
                            isARepeat:NO
                              keyCode:'a'];
   }
 
+  // Helper to return the field-editor frame being used w/in |field_|.
+  NSRect EditorFrame() {
+    EXPECT_TRUE([field_.get() currentEditor]);

[rohitrao (ping after 24h), 2009/09/23 22:05:35]

I want this to be an ASSERT_TRUE, but I have a feeling that won't do what I
want, since this is all inside a function.

[Scott Hess - ex-Googler, 2009/09/23 23:06:26]

Yes, ASSERT_TRUE won't work (it's more relevant for the -count check, because
accessing the first object throws an exception).  I tried working around that,
but it wasn't reasonable.  Making the function return void allows ASSERT_TRUE(),
but makes the helper function useless.  Putting the ASSERT higher up likewise
reduces the utility.

Now that I go look, I find that -lastObject will return the last object in the
array, or nil if empty.  That might have had potential, but I'm not sure what
[nil frame] would return ...

+    EXPECT_EQ([[field_.get() subviews] count], 1U);
+    if ([[field_.get() subviews] count] > 0) {
+      return [[[field_.get() subviews] objectAtIndex:0] frame];
+    } else {
+      // Return something which won't work so the caller can soldier
+      // on.
+      return NSZeroRect;
+    }
+  }
+
   CocoaTestHelper cocoa_helper_;  // Inits Cocoa, creates window, etc...
   scoped_nsobject<AutocompleteTextField> field_;
   MockAutocompleteTextFieldObserver field_observer_;
   scoped_nsobject<AutocompleteTextFieldWindowTestDelegate> window_delegate_;
 };
 
 // Test that we have the right cell class.
 TEST_F(AutocompleteTextFieldTest, CellClass) {
   EXPECT_TRUE([[field_ cell] isKindOfClass:[AutocompleteTextFieldCell class]]);
 }
 
 // Test adding/removing from the view hierarchy, mostly to ensure nothing
 // leaks or crashes.
 TEST_F(AutocompleteTextFieldTest, AddRemove) {
   EXPECT_EQ(cocoa_helper_.contentView(), [field_ superview]);
   [field_.get() removeFromSuperview];
   EXPECT_FALSE([field_ superview]);
 }
 
 // Test that we get the same cell from -cell and
 // -autocompleteTextFieldCell.
 TEST_F(AutocompleteTextFieldTest, Cell) {
   AutocompleteTextFieldCell* cell = [field_ autocompleteTextFieldCell];
   EXPECT_EQ(cell, [field_ cell]);
   EXPECT_TRUE(cell != nil);
 }
 
+// Test that becoming first responder sets things up correctly.
+TEST_F(AutocompleteTextFieldTest, FirstResponder) {
+  EXPECT_EQ(nil, [field_ currentEditor]);
+  EXPECT_EQ([[field_ subviews] count], 0U);
+  cocoa_helper_.makeFirstResponder(field_);
+  EXPECT_FALSE(nil == [field_ currentEditor]);
+  EXPECT_EQ([[field_ subviews] count], 1U);
+  EXPECT_TRUE([[field_ currentEditor] isDescendantOf:field_.get()]);
+
+  // Check that the window delegate is providing the right editor.
+  Class c = [AutocompleteTextFieldEditor class];
+  EXPECT_TRUE([[field_ currentEditor] isKindOfClass:c]);
+}
+
 // Test drawing, mostly to ensure nothing leaks or crashes.
 TEST_F(AutocompleteTextFieldTest, Display) {
   [field_ display];
 
   // Test focussed drawing.
   cocoa_helper_.makeFirstResponder(field_);
   [field_ display];
   cocoa_helper_.clearFirstResponder();
 
   // Test display of various cell configurations.
@@ skipping 37 matching lines @@
 
   // Test without Control key down, but some other modifier down.
   EXPECT_CALL(field_observer_, OnControlKeyChanged(false));
   [firstResponder flagsChanged:KeyDownEventWithFlags(NSShiftKeyMask)];
 
   // Test with Control key down.
   EXPECT_CALL(field_observer_, OnControlKeyChanged(true));
   [firstResponder flagsChanged:KeyDownEventWithFlags(NSControlKeyMask)];
 }
 
-// Test that the field editor is reset correctly when search keyword
-// or hints change.
-TEST_F(AutocompleteTextFieldTest, ResetFieldEditor) {
-  EXPECT_EQ(nil, [field_ currentEditor]);
-  EXPECT_EQ([[field_ subviews] count], 0U);
-  [[field_ window] makeFirstResponder:field_];
-  EXPECT_FALSE(nil == [field_ currentEditor]);
-  EXPECT_EQ([[field_ subviews] count], 1U);
-
-  // Check that the window delegate is working right.
-  {
-    Class c = [AutocompleteTextFieldEditor class];
-    EXPECT_TRUE([[field_ currentEditor] isKindOfClass:c]);
-  }
-
-  // The field editor may not be an immediate subview of |field_|, it
-  // may be a subview of a clipping view (for purposes of scrolling).
-  // So just look at the immediate subview.
-  EXPECT_EQ([[field_ subviews] count], 1U);
-  const NSRect baseEditorFrame([[[field_ subviews] objectAtIndex:0] frame]);
-
+// Test that the field editor gets the same bounds when focus is
+// delivered by the standard focusing machinery, or by
+// -resetFieldEditorFrameIfNeeded.
+TEST_F(AutocompleteTextFieldTest, ResetFieldEditorBase) {
   AutocompleteTextFieldCell* cell = [field_ autocompleteTextFieldCell];
   EXPECT_FALSE([cell fieldEditorNeedsReset]);
 
-  // Asking the cell to add a search hint should leave the field
-  // editor alone until -resetFieldEditorFrameIfNeeded is called.
-  // Then the field editor should be moved to a smaller region with
-  // the same left-hand side.
-  [cell setSearchHintString:@"Type to search"];
+  // Capture the editor frame resulting from the standard focus
+  // machinery.
+  cocoa_helper_.makeFirstResponder(field_);
+  const NSRect baseEditorFrame(EditorFrame());
+
+  // Setting a hint should result in a strictly smaller editor frame.
+  [cell setSearchHintString:@"search hint"];
   EXPECT_TRUE([cell fieldEditorNeedsReset]);
-  NSRect r = [[[field_ subviews] objectAtIndex:0] frame];
-  EXPECT_TRUE(NSEqualRects(r, baseEditorFrame));
   [field_ resetFieldEditorFrameIfNeeded];
-  r = [[[field_ subviews] objectAtIndex:0] frame];
   EXPECT_FALSE([cell fieldEditorNeedsReset]);
-  EXPECT_FALSE(NSEqualRects(r, baseEditorFrame));
-  EXPECT_TRUE(NSContainsRect(baseEditorFrame, r));
-  EXPECT_EQ(NSMinX(r), NSMinX(baseEditorFrame));
-  EXPECT_LT(NSWidth(r), NSWidth(baseEditorFrame));
+  EXPECT_FALSE(NSEqualRects(baseEditorFrame, EditorFrame()));
+  EXPECT_TRUE(NSContainsRect(baseEditorFrame, EditorFrame()));
 
-  // Save the search-hint editor frame for later.
-  const NSRect searchHintEditorFrame(r);
-
-  // Asking the cell to change to keyword mode should leave the field
-  // editor alone until -resetFieldEditorFrameIfNeeded is called.
-  // Then the field editor should be moved to a smaller region with
-  // the same right-hand side.
-  [cell setKeywordString:@"Search Engine:"];
-  EXPECT_TRUE([cell fieldEditorNeedsReset]);
-  r = [[[field_ subviews] objectAtIndex:0] frame];
-  EXPECT_TRUE(NSEqualRects(r, searchHintEditorFrame));
-  [field_ resetFieldEditorFrameIfNeeded];
-  r = [[[field_ subviews] objectAtIndex:0] frame];
-  EXPECT_FALSE([cell fieldEditorNeedsReset]);
-  EXPECT_FALSE(NSEqualRects(r, baseEditorFrame));
-  EXPECT_FALSE(NSEqualRects(r, searchHintEditorFrame));
-  EXPECT_TRUE(NSContainsRect(baseEditorFrame, r));
-  EXPECT_EQ(NSMaxX(r), NSMaxX(baseEditorFrame));
-  EXPECT_LT(NSWidth(r), NSWidth(baseEditorFrame));
-
-  // Asking the cell to clear everything should leave the field editor
-  // alone until -resetFieldEditorFrameIfNeeded is called.  Then the
-  // field editor should be back to baseEditorFrame.
+  // Clearing hint string and using -resetFieldEditorFrameIfNeeded
+  // should result in the same frame as the standard focus machinery.
   [cell clearKeywordAndHint];
   EXPECT_TRUE([cell fieldEditorNeedsReset]);
   [field_ resetFieldEditorFrameIfNeeded];
-  r = [[[field_ subviews] objectAtIndex:0] frame];
   EXPECT_FALSE([cell fieldEditorNeedsReset]);
-  EXPECT_TRUE(NSEqualRects(r, baseEditorFrame));
+  EXPECT_TRUE(NSEqualRects(baseEditorFrame, EditorFrame()));
 }
 
-// Test that the field editor is reset correctly when search keyword
-// or hints change.
+// Test that the field editor gets the same bounds when focus is
+// delivered by the standard focusing machinery, or by
+// -resetFieldEditorFrameIfNeeded.
+TEST_F(AutocompleteTextFieldTest, ResetFieldEditorSearchHint) {
+  AutocompleteTextFieldCell* cell = [field_ autocompleteTextFieldCell];
+  EXPECT_FALSE([cell fieldEditorNeedsReset]);
+
+  const NSString* kHintString(@"Type to search");
+
+  // Capture the editor frame resulting from the standard focus
+  // machinery.
+  [cell setSearchHintString:kHintString];
+  EXPECT_TRUE([cell fieldEditorNeedsReset]);
+  [cell setFieldEditorNeedsReset:NO];
+  EXPECT_FALSE([cell fieldEditorNeedsReset]);
+  cocoa_helper_.makeFirstResponder(field_);
+  const NSRect baseEditorFrame(EditorFrame());
+
+  // Clearing the hint should result in a strictly larger editor
+  // frame.
+  [cell clearKeywordAndHint];
+  EXPECT_TRUE([cell fieldEditorNeedsReset]);
+  [field_ resetFieldEditorFrameIfNeeded];
+  EXPECT_FALSE([cell fieldEditorNeedsReset]);
+  EXPECT_FALSE(NSEqualRects(baseEditorFrame, EditorFrame()));
+  EXPECT_TRUE(NSContainsRect(EditorFrame(), baseEditorFrame));
+
+  // Setting the same hint string and using
+  // -resetFieldEditorFrameIfNeeded should result in the same frame as
+  // the standard focus machinery.
+  [cell setSearchHintString:kHintString];
+  EXPECT_TRUE([cell fieldEditorNeedsReset]);
+  [field_ resetFieldEditorFrameIfNeeded];
+  EXPECT_FALSE([cell fieldEditorNeedsReset]);
+  EXPECT_TRUE(NSEqualRects(baseEditorFrame, EditorFrame()));
+}
+
+// Test that the field editor gets the same bounds when focus is
+// delivered by the standard focusing machinery, or by
+// -resetFieldEditorFrameIfNeeded.
+TEST_F(AutocompleteTextFieldTest, ResetFieldEditorKeywordHint) {
+  AutocompleteTextFieldCell* cell = [field_ autocompleteTextFieldCell];
+  EXPECT_FALSE([cell fieldEditorNeedsReset]);
+
+  const NSString* kHintString(@"Search Engine:");
+
+  // Capture the editor frame resulting from the standard focus
+  // machinery.
+  [cell setKeywordString:kHintString];
+  EXPECT_TRUE([cell fieldEditorNeedsReset]);
+  [cell setFieldEditorNeedsReset:NO];
+  EXPECT_FALSE([cell fieldEditorNeedsReset]);
+  cocoa_helper_.makeFirstResponder(field_);
+  const NSRect baseEditorFrame(EditorFrame());
+
+  // Clearing the hint should result in a strictly larger editor
+  // frame.
+  [cell clearKeywordAndHint];
+  EXPECT_TRUE([cell fieldEditorNeedsReset]);
+  [field_ resetFieldEditorFrameIfNeeded];
+  EXPECT_FALSE([cell fieldEditorNeedsReset]);
+  EXPECT_FALSE(NSEqualRects(baseEditorFrame, EditorFrame()));
+  EXPECT_TRUE(NSContainsRect(EditorFrame(), baseEditorFrame));
+
+  // Setting the same hint string and using
+  // -resetFieldEditorFrameIfNeeded should result in the same frame as
+  // the standard focus machinery.
+  [cell setKeywordString:kHintString];
+  EXPECT_TRUE([cell fieldEditorNeedsReset]);
+  [field_ resetFieldEditorFrameIfNeeded];
+  EXPECT_FALSE([cell fieldEditorNeedsReset]);
+  EXPECT_TRUE(NSEqualRects(baseEditorFrame, EditorFrame()));
+}
+
+// Test that resetting the field editor bounds does not cause untoward
+// messages to the field's delegate.
 TEST_F(AutocompleteTextFieldTest, ResetFieldEditorBlocksEndEditing) {
-  [[field_ window] makeFirstResponder:field_];
+  cocoa_helper_.makeFirstResponder(field_);
 
   // First, test that -makeFirstResponder: sends
   // -controlTextDidBeginEditing: and -control:textShouldEndEditing at
   // the expected times.
   {
     scoped_nsobject<AutocompleteTextFieldTestDelegate> delegate(
         [[AutocompleteTextFieldTestDelegate alloc] init]);
     EXPECT_FALSE([delegate receivedControlTextDidBeginEditing]);
     EXPECT_FALSE([delegate receivedControlTextShouldEndEditing]);
 
@@ skipping 60 matching lines @@
 - (void)controlTextDidBeginEditing:(NSNotification*)aNotification {
   receivedControlTextDidBeginEditing_ = YES;
 }
 
 - (BOOL)control:(NSControl*)control textShouldEndEditing:(NSText*)fieldEditor {
   receivedControlTextShouldEndEditing_ = YES;
   return YES;
 }
 
 @end