auto_stub.SimpleMock: add sanity - sort kwargs in expectations.

testing_support/auto_stub.py

 # Copyright (c) 2011 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 collections
 import inspect
 
 from testing_support import thread_watcher
 
 
@@ skipping 14 matching lines @@
   def tearDown(self):
     """Restore all the mocked members."""
     if self._saved:
       for obj, items in self._saved.iteritems():
         for member, previous_value in items.iteritems():
           setattr(obj, member, previous_value)
 
 
 class SimpleMock(object):
   """Really simple manual class mock."""
-  def __init__(self, unit_test):
+  def __init__(self, unit_test, sorted_kwargs=False):
     """Do not call __init__ if you want to use the global call list to detect
     ordering across different instances.
 
     Args:
       unit_test (unittest.TestCase): instance of a test class.
+      sorted_kwargs (bool): if True, kwargs in expectations will always be
+        sorted by key.
     """
+    # TODO(tandrii): sorted_kwargs MUST BE REALLY TRUE by default, but i don't
+    # want to fix all the tests, so keeping backwards compatability.
     self.calls = []
+    self.sorted_kwargs = sorted_kwargs
     self.unit_test = unit_test
     self.assertEqual = unit_test.assertEqual
 
   def pop_calls(self):
     """Returns the list of calls up to date.
 
     Good to do self.assertEqual(expected, mock.pop_calls()).
     """
     calls = self.calls
     self.calls = []
     return calls
 
   def check_calls(self, expected):
     self.assertEqual(expected, self.pop_calls())
 
   def _register_call(self, *args, **kwargs):
     """Registers the name of the caller function."""
     caller_name = kwargs.pop('caller_name', None) or inspect.stack()[1][3]
     str_args = ', '.join(repr(arg) for arg in args)
-    str_kwargs = ', '.join('%s=%r' % (k, v) for k, v in kwargs.iteritems())
+
+    kwargs_items = kwargs.items()
+    if self.sorted_kwargs:
+      kwargs_items.sort()
+    str_kwargs = ', '.join('%s=%r' % (k, v) for k, v in kwargs_items)
     self.calls.append('%s(%s)' % (
         caller_name, ', '.join(filter(None, [str_args, str_kwargs]))))
 
 
 class TestCase(thread_watcher.TestCase, AutoStubMixIn):
   """Adds self.mock() and self.has_failed() to a TestCase."""
   def tearDown(self):
     AutoStubMixIn.tearDown(self)
     super(TestCase, self).tearDown()