PRESUBMIT_test_mocks.py

   1 # Copyright 2014 The Chromium Authors. All rights reserved.
   2 # Use of this source code is governed by a BSD-style license that can be
   3 # found in the LICENSE file.
   4
   5 import json
   6 import os
   7 import re
   8 import subprocess
   9 import sys
  10
  11
  12 class MockInputApi(object):
  13   """Mock class for the InputApi class.
  14
  15   This class can be used for unittests for presubmit by initializing the files
  16   attribute as the list of changed files.
  17   """
  18
  19   def __init__(self):
  20     self.json = json
  21     self.re = re
  22     self.os_path = os.path
  23     self.python_executable = sys.executable
  24     self.subprocess = subprocess
  25     self.files = []
  26     self.is_committing = False
  27     self.change = MockChange([])
  28
  29   def AffectedFiles(self, file_filter=None):
  30     return self.files
  31
  32   def PresubmitLocalPath(self):
  33     return os.path.dirname(__file__)
  34
  35   def ReadFile(self, filename, mode='rU'):
  36     for file_ in self.files:
  37       if file_.LocalPath() == filename:
  38         return '\n'.join(file_.NewContents())
  39     # Otherwise, file is not in our mock API.
  40     raise IOError, "No such file or directory: '%s'" % filename
  41
  42
  43 class MockOutputApi(object):
  44   """Mock class for the OutputApi class.
  45
  46   An instance of this class can be passed to presubmit unittests for outputing
  47   various types of results.
  48   """
  49
  50   class PresubmitResult(object):
  51     def __init__(self, message, items=None, long_text=''):
  52       self.message = message
  53       self.items = items
  54       self.long_text = long_text
  55
  56   class PresubmitError(PresubmitResult):
  57     def __init__(self, message, items, long_text=''):
  58       MockOutputApi.PresubmitResult.__init__(self, message, items, long_text)
  59       self.type = 'error'
  60
  61   class PresubmitPromptWarning(PresubmitResult):
  62     def __init__(self, message, items, long_text=''):
  63       MockOutputApi.PresubmitResult.__init__(self, message, items, long_text)
  64       self.type = 'warning'
  65
  66   class PresubmitNotifyResult(PresubmitResult):
  67     def __init__(self, message, items, long_text=''):
  68       MockOutputApi.PresubmitResult.__init__(self, message, items, long_text)
  69       self.type = 'notify'
  70
  71   class PresubmitPromptOrNotify(PresubmitResult):
  72     def __init__(self, message, items, long_text=''):
  73       MockOutputApi.PresubmitResult.__init__(self, message, items, long_text)
  74       self.type = 'promptOrNotify'
  75
  76
  77 class MockFile(object):
  78   """Mock class for the File class.
  79
  80   This class can be used to form the mock list of changed files in
  81   MockInputApi for presubmit unittests.
  82   """
  83
  84   def __init__(self, local_path, new_contents):
  85     self._local_path = local_path
  86     self._new_contents = new_contents
  87     self._changed_contents = [(i + 1, l) for i, l in enumerate(new_contents)]
  88
  89   def ChangedContents(self):
  90     return self._changed_contents
  91
  92   def NewContents(self):
  93     return self._new_contents
  94
  95   def LocalPath(self):
  96     return self._local_path
  97
  98
  99 class MockChange(object):
 100   """Mock class for Change class.
 101
 102   This class can be used in presubmit unittests to mock the query of the
 103   current change.
 104   """
 105
 106   def __init__(self, changed_files):
 107     self._changed_files = changed_files
 108
 109   def LocalPaths(self):
 110     return self._changed_files