[Memory Sheriff] Force a well-defined path for system leak.

ui/gfx/test/ui_cocoa_test_helper.mm

 // Copyright 2014 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 "ui/gfx/test/ui_cocoa_test_helper.h"
 
 #include "base/debug/debugger.h"
 #include "base/logging.h"
 #include "base/stl_util.h"
 #include "base/test/test_timeouts.h"
 
+namespace {
+
+// Some AppKit function leak intentionally, e.g. for caching purposes.
+// Force those leaks here, so there can be a unique calling path, allowing
+// to flag intentional leaks without having to suppress all calls to
+// potentially leaky functions.
+void NOINLINE ForceSystemLeaks() {
+  // First NSCursor push always leaks.
+  [[NSCursor openHandCursor] push];
+  [NSCursor pop];
+}
+
+}  // namespace.
+
 @implementation CocoaTestHelperWindow
 
 - (id)initWithContentRect:(NSRect)contentRect {
   return [self initWithContentRect:contentRect
                          styleMask:NSBorderlessWindowMask
                            backing:NSBackingStoreBuffered
                              defer:NO];
 }
 
 - (id)init {
@@ skipping 22 matching lines @@
 
 - (BOOL)isKeyWindow {
   return pretendIsKeyWindow_;
 }
 
 @end
 
 namespace ui {
 
 CocoaTest::CocoaTest() : called_tear_down_(false), test_window_(nil) {
   Init();

[Scott Hess - ex-Googler, 2014/05/30 23:58:06]

I'm looking at this and thinking "Wait, what?"  I bet I wrote it, too.

[groby-ooo-7-16, 2014/05/31 00:37:04]

Nope, Avi :)

This used to call BootstrapCocoa, too, but that was moved into the
Chrome-specific CocoaTest. (It's just setting the bundle path)

 }
 
 CocoaTest::~CocoaTest() {
   // Must call CocoaTest's teardown from your overrides.
   DCHECK(called_tear_down_);
 }
 
 void CocoaTest::Init() {
   // Set the duration of AppKit-evaluated animations (such as frame changes)
   // to zero for testing purposes. That way they take effect immediately.
   [[NSAnimationContext currentContext] setDuration:0.0];
 
   // The above does not affect window-resize time, such as for an
   // attached sheet dropping in.  Set that duration for the current
   // process (this is not persisted).  Empirically, the value of 0.0
   // is ignored.
   NSDictionary* dict =
       [NSDictionary dictionaryWithObject:@"0.01" forKey:@"NSWindowResizeTime"];
   [[NSUserDefaults standardUserDefaults] registerDefaults:dict];
 
   // Collect the list of windows that were open when the test started so
   // that we don't wait for them to close in TearDown. Has to be done
   // after BootstrapCocoa is called.
   initial_windows_ = ApplicationWindows();
+
+  ForceSystemLeaks();

[Scott Hess - ex-Googler, 2014/05/30 23:58:06]

Stepping back and putting on my "What would another reviewer say?" cap, I find
myself wondering if this shouldn't be at the top of the function?

[groby-ooo-7-16, 2014/05/31 00:37:04]

Moved to top of ctor.

 }
 
 void CocoaTest::TearDown() {
   called_tear_down_ = true;
   // Call close on our test_window to clean it up if one was opened.
   [test_window_ clearPretendKeyWindowAndFirstResponder];
   [test_window_ close];
   test_window_ = nil;
 
   // Recycle the pool to clean up any stuff that was put on the
@@ skipping 102 matching lines @@
     if (base::debug::BeingDebugged()) {
       [test_window_ orderFront:nil];
     } else {
       [test_window_ orderBack:nil];
     }
   }
   return test_window_;
 }
 
 }  // namespace ui