depot_tools/tests/super_mox.py

#!/usr/bin/python
# 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.

"""Simplify unit tests based on pymox."""

import __builtin__
import os
import random
import string
import subprocess
import sys
from pymox 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 SuperMoxBaseTestBase(mox.MoxTestBase):
  """Base class with some additional functionalities. People will usually want
  to use SuperMoxTestBase instead."""
  # Backup the separator in case it gets mocked
  _OS_SEP = os.sep
  _RANDOM_CHOICE = random.choice
  _RANDOM_RANDINT = random.randint
  _STRING_LETTERS = string.letters

  ## Some utilities for generating arbitrary arguments.
  def String(self, max_length):
    return ''.join([self._RANDOM_CHOICE(self._STRING_LETTERS)
                    for x in xrange(self._RANDOM_RANDINT(1, max_length))])

  def Strings(self, max_arg_count, max_arg_length):
    return [self.String(max_arg_length) for x in xrange(max_arg_count)]

  def Args(self, max_arg_count=8, max_arg_length=16):
    return self.Strings(max_arg_count,
                        self._RANDOM_RANDINT(1, max_arg_length))

  def _DirElts(self, max_elt_count=4, max_elt_length=8):
    return self._OS_SEP.join(self.Strings(max_elt_count, max_elt_length))

  def Dir(self, max_elt_count=4, max_elt_length=8):
    return (self._RANDOM_CHOICE((self._OS_SEP, '')) +
            self._DirElts(max_elt_count, max_elt_length))

  def Url(self, max_elt_count=4, max_elt_length=8):
    return ('svn://random_host:port/a' +
            self._DirElts(max_elt_count, max_elt_length
                ).replace(self._OS_SEP, '/'))

  def RootDir(self, max_elt_count=4, max_elt_length=8):
    return self._OS_SEP + self._DirElts(max_elt_count, max_elt_length)

  def compareMembers(self, object, members):
    """If you add a member, be sure to add the relevant test!"""
    # Skip over members starting with '_' since they are usually not meant to
    # be for public use.
    actual_members = [x for x in sorted(dir(object))
                      if not x.startswith('_')]
    expected_members = sorted(members)
    if actual_members != expected_members:
      diff = ([i for i in actual_members if i not in expected_members] +
              [i for i in expected_members if i not in actual_members])
      print diff
    self.assertEqual(actual_members, expected_members)

  def UnMock(self, object, name):
    """Restore an object inside a test."""
    for (parent, old_child, child_name) in self.mox.stubs.cache:
      if parent == object and child_name == name:
        setattr(parent, child_name, old_child)
        break


class SuperMoxTestBase(SuperMoxBaseTestBase):
  def setUp(self):
    """Patch a few functions with know side-effects."""
    SuperMoxBaseTestBase.setUp(self)
    #self.mox.StubOutWithMock(__builtin__, 'open')
    self.mox.StubOutWithMock(os, 'chdir')
    self.mox.StubOutWithMock(os, 'chown')
    self.mox.StubOutWithMock(os, 'close')
    #self.mox.StubOutWithMock(os, 'closerange')
    self.mox.StubOutWithMock(os, 'dup')
    self.mox.StubOutWithMock(os, 'dup2')
    self.mox.StubOutWithMock(os, 'fchdir')
    #self.mox.StubOutWithMock(os, 'fchmod')
    #self.mox.StubOutWithMock(os, 'fchown')
    self.mox.StubOutWithMock(os, 'fdopen')
    self.mox.StubOutWithMock(os, 'getcwd')
    self.mox.StubOutWithMock(os, 'getpid')
    self.mox.StubOutWithMock(os, 'lseek')
    self.mox.StubOutWithMock(os, 'makedirs')
    self.mox.StubOutWithMock(os, 'mkdir')
    self.mox.StubOutWithMock(os, 'open')
    self.mox.StubOutWithMock(os, 'popen')
    self.mox.StubOutWithMock(os, 'popen2')
    self.mox.StubOutWithMock(os, 'popen3')
    self.mox.StubOutWithMock(os, 'popen4')
    self.mox.StubOutWithMock(os, 'read')
    self.mox.StubOutWithMock(os, 'remove')
    self.mox.StubOutWithMock(os, 'removedirs')
    self.mox.StubOutWithMock(os, 'rename')
    self.mox.StubOutWithMock(os, 'renames')
    self.mox.StubOutWithMock(os, 'rmdir')
    self.mox.StubOutWithMock(os, 'symlink')
    self.mox.StubOutWithMock(os, 'system')
    self.mox.StubOutWithMock(os, 'tmpfile')
    self.mox.StubOutWithMock(os, 'walk')
    self.mox.StubOutWithMock(os, 'write')
    self.mox.StubOutWithMock(os.path, 'abspath')
    self.mox.StubOutWithMock(os.path, 'exists')
    self.mox.StubOutWithMock(os.path, 'getsize')
    self.mox.StubOutWithMock(os.path, 'isdir')
    self.mox.StubOutWithMock(os.path, 'isfile')
    self.mox.StubOutWithMock(os.path, 'islink')
    self.mox.StubOutWithMock(os.path, 'ismount')
    self.mox.StubOutWithMock(os.path, 'lexists')
    self.mox.StubOutWithMock(os.path, 'realpath')
    self.mox.StubOutWithMock(os.path, 'samefile')
    self.mox.StubOutWithMock(os.path, 'walk')
    self.mox.StubOutWithMock(subprocess, 'call')
    self.mox.StubOutWithMock(subprocess, 'Popen')
    #self.mox.StubOutWithMock(sys, 'stderr')
    self.mox.StubOutWithMock(sys, 'stdin')
    self.mox.StubOutWithMock(sys, 'stdout')