Add pymox, fixed non-deterministic pprint.pformat output expectation.

pymox auto-checkout never really worked well so check-in pymox directly.

pprint.pformat is non-determinist in one test. Worked around the issue.

TEST=unit tests
BUG=none
Review URL: http://codereview.chromium.org/266043

git-svn-id: svn://svn.chromium.org/chrome/trunk/tools/depot_tools@29398 0039d316-1c4b-4281-b951-d872f2087c98

tests/gclient_test.py

@@ -31,6 +31,17 @@ import super_mox
 from super_mox import mox
 
 
+class IsOneOf(mox.Comparator):
+  def __init__(self, keys):
+    self._keys = keys
+
+  def equals(self, rhs):
+    return rhs in self._keys
+
+  def __repr__(self):
+    return '<sequence or map containing \'%s\'>' % str(self._keys)
+
+
 class BaseTestCase(super_mox.SuperMoxTestBase):
   def setUp(self):
     super_mox.SuperMoxTestBase.setUp(self)
@@ -393,10 +404,15 @@ class GClientClassTestCase(GclientTestCase):
       "} ]\n"
     ) % (solution_name, self.url)
 
-    entries_content = (
+    # pprint.pformat() is non-deterministic in this case!!
+    entries_content1 = (
       "entries = \\\n"
       "{ '%s': '%s'}\n"
     ) % (solution_name, self.url)
+    entries_content2 = (
+      "entries = \\\n"
+      "{'%s': '%s'}\n"
+    ) % (solution_name, self.url)
 
     options = self.Options()
 
@@ -420,7 +436,7 @@ class GClientClassTestCase(GclientTestCase):
     # After everything is done, an attempt is made to write an entries
     # file.
     gclient.FileWrite(os.path.join(self.root_dir, options.entries_filename),
-        entries_content)
+        IsOneOf((entries_content1, entries_content2)))
 
     self.mox.ReplayAll()
     client = self._gclient_gclient(self.root_dir, options)

tests/pymox/COPYING

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tests/pymox/MANIFEST.in

@@ -0,0 +1,5 @@
+include COPYING
+include mox_test.py
+include mox_test_helper.py
+include stubout_test.py
+include stubout_testee.py

tests/pymox/README

@@ -0,0 +1,56 @@
+Mox is an open source mock object framework for Python, inspired by
+the Java library EasyMock.
+
+To install:
+
+  $ python setup.py install
+
+To run Mox's internal tests:
+
+  $ python mox_test.py
+
+Basic usage:
+
+  import unittest
+  import mox
+
+  class PersonTest(mox.MoxTestBase):
+
+    def testUsingMox(self):
+      # Create a mock Person
+      mock_person = self.mox.CreateMock(Person)
+
+      test_person = ...
+      test_primary_key = ...
+      unknown_person = ...
+
+      # Expect InsertPerson to be called with test_person; return
+      # test_primary_key at that point
+      mock_person.InsertPerson(test_person).AndReturn(test_primary_key)
+
+      # Raise an exception when this is called
+      mock_person.DeletePerson(unknown_person).AndRaise(UnknownPersonError())
+
+      # Switch from record mode to replay mode
+      self.mox.ReplayAll()
+
+      # Run the test
+      ret_pk = mock_person.InsertPerson(test_person)
+      self.assertEquals(test_primary_key, ret_pk)
+      self.assertRaises(UnknownPersonError, mock_person, unknown_person)
+
+For more documentation, see:
+
+  http://code.google.com/p/pymox/wiki/MoxDocumentation
+
+For more information, see:
+
+  http://code.google.com/p/pymox/
+
+Our user and developer discussion group is:
+
+  http://groups.google.com/group/mox-discuss
+
+Mox is Copyright 2008 Google Inc, and licensed under the Apache
+License, Version 2.0; see the file COPYING for details.  If you would
+like to help us improve Mox, join the group.

tests/pymox/mox_test_helper.py

@@ -0,0 +1,76 @@
+#!/usr/bin/python2.4
+#
+# Copyright 2008 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""A very basic test class derived from mox.MoxTestBase, used by mox_test.py.
+
+The class defined in this module is used to test the features of
+MoxTestBase and is not intended to be a standalone test.  It needs to
+be in a separate module, because otherwise the tests in this class
+(which should not all pass) would be executed as part of the
+mox_test.py test suite.
+
+See mox_test.MoxTestBaseTest for how this class is actually used.
+"""
+
+import os
+
+import mox
+
+class ExampleMoxTestMixin(object):
+  """Mix-in class for mox test case class.
+
+  It stubs out the same function as one of the test methods in
+  the example test case.  Both tests must pass as meta class wraps
+  test methods in all base classes.
+  """
+
+  def testStat(self):
+    self.mox.StubOutWithMock(os, 'stat')
+    os.stat(self.DIR_PATH)
+    self.mox.ReplayAll()
+    os.stat(self.DIR_PATH)
+
+
+class ExampleMoxTest(mox.MoxTestBase, ExampleMoxTestMixin):
+
+  DIR_PATH = '/path/to/some/directory'
+
+  def testSuccess(self):
+    self.mox.StubOutWithMock(os, 'listdir')
+    os.listdir(self.DIR_PATH)
+    self.mox.ReplayAll()
+    os.listdir(self.DIR_PATH)
+
+  def testExpectedNotCalled(self):
+    self.mox.StubOutWithMock(os, 'listdir')
+    os.listdir(self.DIR_PATH)
+    self.mox.ReplayAll()
+
+  def testUnexpectedCall(self):
+    self.mox.StubOutWithMock(os, 'listdir')
+    os.listdir(self.DIR_PATH)
+    self.mox.ReplayAll()
+    os.listdir('/path/to/some/other/directory')
+    os.listdir(self.DIR_PATH)
+
+  def testFailure(self):
+    self.assertTrue(False)
+
+  def testStatOther(self):
+    self.mox.StubOutWithMock(os, 'stat')
+    os.stat(self.DIR_PATH)
+    self.mox.ReplayAll()
+    os.stat(self.DIR_PATH)

tests/pymox/setup.py

@@ -0,0 +1,14 @@
+#!/usr/bin/python2.4
+from distutils.core import setup
+
+setup(name='mox',
+      version='0.5.1',
+      py_modules=['mox', 'stubout'],
+      url='http://code.google.com/p/pymox/',
+      maintainer='pymox maintainers',
+      maintainer_email='mox-discuss@googlegroups.com',
+      license='Apache License, Version 2.0',
+      description='Mock object framework',
+      long_description='''Mox is a mock object framework for Python based on the
+Java mock object framework EasyMock.''',
+      )

tests/pymox/stubout.py

@@ -0,0 +1,142 @@
+#!/usr/bin/python2.4
+#
+# Copyright 2008 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import inspect
+
+class StubOutForTesting:
+  """Sample Usage:
+     You want os.path.exists() to always return true during testing.
+
+     stubs = StubOutForTesting()
+     stubs.Set(os.path, 'exists', lambda x: 1)
+       ...
+     stubs.UnsetAll()
+
+     The above changes os.path.exists into a lambda that returns 1.  Once
+     the ... part of the code finishes, the UnsetAll() looks up the old value
+     of os.path.exists and restores it.
+
+  """
+  def __init__(self):
+    self.cache = []
+    self.stubs = []
+
+  def __del__(self):
+    self.SmartUnsetAll()
+    self.UnsetAll()
+
+  def SmartSet(self, obj, attr_name, new_attr):
+    """Replace obj.attr_name with new_attr. This method is smart and works
+       at the module, class, and instance level while preserving proper
+       inheritance. It will not stub out C types however unless that has been
+       explicitly allowed by the type.
+
+       This method supports the case where attr_name is a staticmethod or a
+       classmethod of obj.
+
+       Notes:
+      - If obj is an instance, then it is its class that will actually be
+        stubbed. Note that the method Set() does not do that: if obj is
+        an instance, it (and not its class) will be stubbed.
+      - The stubbing is using the builtin getattr and setattr. So, the __get__
+        and __set__ will be called when stubbing (TODO: A better idea would
+        probably be to manipulate obj.__dict__ instead of getattr() and
+        setattr()).
+
+       Raises AttributeError if the attribute cannot be found.
+    """
+    if (inspect.ismodule(obj) or
+        (not inspect.isclass(obj) and obj.__dict__.has_key(attr_name))):
+      orig_obj = obj
+      orig_attr = getattr(obj, attr_name)
+
+    else:
+      if not inspect.isclass(obj):
+        mro = list(inspect.getmro(obj.__class__))
+      else:
+        mro = list(inspect.getmro(obj))
+
+      mro.reverse()
+
+      orig_attr = None
+
+      for cls in mro:
+        try:
+          orig_obj = cls
+          orig_attr = getattr(obj, attr_name)
+        except AttributeError:
+          continue
+
+    if orig_attr is None:
+      raise AttributeError("Attribute not found.")
+
+    # Calling getattr() on a staticmethod transforms it to a 'normal' function.
+    # We need to ensure that we put it back as a staticmethod.
+    old_attribute = obj.__dict__.get(attr_name)
+    if old_attribute is not None and isinstance(old_attribute, staticmethod):
+      orig_attr = staticmethod(orig_attr)
+
+    self.stubs.append((orig_obj, attr_name, orig_attr))
+    setattr(orig_obj, attr_name, new_attr)
+
+  def SmartUnsetAll(self):
+    """Reverses all the SmartSet() calls, restoring things to their original
+    definition.  Its okay to call SmartUnsetAll() repeatedly, as later calls
+    have no effect if no SmartSet() calls have been made.
+
+    """
+    self.stubs.reverse()
+
+    for args in self.stubs:
+      setattr(*args)
+
+    self.stubs = []
+
+  def Set(self, parent, child_name, new_child):
+    """Replace child_name's old definition with new_child, in the context
+    of the given parent.  The parent could be a module when the child is a
+    function at module scope.  Or the parent could be a class when a class'
+    method is being replaced.  The named child is set to new_child, while
+    the prior definition is saved away for later, when UnsetAll() is called.
+
+    This method supports the case where child_name is a staticmethod or a
+    classmethod of parent.
+    """
+    old_child = getattr(parent, child_name)
+
+    old_attribute = parent.__dict__.get(child_name)
+    if old_attribute is not None:
+      if isinstance(old_attribute, staticmethod):
+        old_child = staticmethod(old_child)
+      elif isinstance(old_attribute, classmethod):
+        old_child = classmethod(old_child.im_func)
+
+    self.cache.append((parent, old_child, child_name))
+    setattr(parent, child_name, new_child)
+
+  def UnsetAll(self):
+    """Reverses all the Set() calls, restoring things to their original
+    definition.  Its okay to call UnsetAll() repeatedly, as later calls have
+    no effect if no Set() calls have been made.
+
+    """
+    # Undo calls to Set() in reverse order, in case Set() was called on the
+    # same arguments repeatedly (want the original call to be last one undone)
+    self.cache.reverse()
+
+    for (parent, old_child, child_name) in self.cache:
+      setattr(parent, child_name, old_child)
+    self.cache = []

tests/pymox/stubout_test.py

@@ -0,0 +1,47 @@
+#!/usr/bin/python2.4
+#
+# Unit tests for stubout.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import unittest
+
+import mox
+import stubout
+import stubout_testee
+
+
+class StubOutForTestingTest(unittest.TestCase):
+  def setUp(self):
+    self.mox = mox.Mox()
+    self.sample_function_backup = stubout_testee.SampleFunction
+
+  def tearDown(self):
+    stubout_testee.SampleFunction = self.sample_function_backup
+
+  def testSmartSetOnModule(self):
+    mock_function = self.mox.CreateMockAnything()
+    mock_function()
+
+    stubber = stubout.StubOutForTesting()
+    stubber.SmartSet(stubout_testee, 'SampleFunction', mock_function)
+
+    self.mox.ReplayAll()
+
+    stubout_testee.SampleFunction()
+
+    self.mox.VerifyAll()
+
+
+if __name__ == '__main__':
+  unittest.main()

tests/pymox/stubout_testee.py

@@ -0,0 +1,2 @@
+def SampleFunction():
+  raise Exception('I should never be called!')

tests/super_mox.py

@@ -8,39 +8,7 @@
 import os
 import random
 import string
-
+from pymox import mox 
-mox = None
-
-def OnTestsLoad():
-  import sys
-  old_path = sys.path
-  global mox
-  try:
-    directory, _file = os.path.split(__file__)
-    sys.path.append(os.path.abspath(os.path.join(directory, 'pymox')))
-    sys.path.append(os.path.abspath(os.path.join(directory, '..')))
-    try:
-      import mox as Mox
-      mox = Mox
-    except ImportError:
-      print "Trying to automatically checkout pymox."
-      import subprocess
-      subprocess.call(['svn', 'co', 'http://pymox.googlecode.com/svn/trunk',
-                       os.path.join(directory, 'pymox')],
-                      shell=sys.platform.startswith('win'))
-      try:
-        import pymox.mox as Mox
-        mox = Mox
-      except ImportError:
-        print >> sys.stderr, ("\nError, failed to load pymox\n")
-        raise
-  finally:
-    # Restore the path
-    sys.path = old_path
-
-
-# Automatically fetch pymox.
-OnTestsLoad()
 
 
 class SuperMoxTestBase(mox.MoxTestBase):