summaryrefslogtreecommitdiffstats
path: root/chrome/browser/extensions/PRESUBMIT_test.py
blob: ba7f9160f9c968b09c86c19ac522f06ae007e841 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
#!/usr/bin/env python
# Copyright (c) 2012 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 difflib
import os
import re
import unittest

import PRESUBMIT

class MockLogging(object):
  def __init__(self):
    self.lines = []

  def info(self, message):
    self.lines.append(message)

  def debug(self, message):
    self.lines.append(message)

class MockInputApi(object):
  def __init__(self):
    self.re = re
    self.os_path = os.path
    self.files = []
    self.is_committing = False
    self.logging = MockLogging()

  def AffectedFiles(self, include_deletes=None):
    return self.files


class MockOutputApi(object):
  class PresubmitResult(object):
    def __init__(self, message, items=None, long_text=''):
      self.message = message
      self.items = items
      self.long_text = long_text

  class PresubmitError(PresubmitResult):
    def __init__(self, message, items, long_text=''):
      MockOutputApi.PresubmitResult.__init__(self, message, items, long_text)
      self.type = 'error'

  class PresubmitPromptWarning(PresubmitResult):
    def __init__(self, message, items, long_text=''):
      MockOutputApi.PresubmitResult.__init__(self, message, items, long_text)
      self.type = 'warning'

  class PresubmitNotifyResult(PresubmitResult):
    def __init__(self, message, items, long_text=''):
      MockOutputApi.PresubmitResult.__init__(self, message, items, long_text)
      self.type = 'notify'


class MockFile(object):
  def __init__(self, local_path, old_contents, new_contents):
    self._local_path = local_path
    self._new_contents = new_contents
    self._old_contents = old_contents
    self._cached_changed_contents = None

  def ChangedContents(self):
    return self._changed_contents

  def NewContents(self):
    return self._new_contents

  def LocalPath(self):
    return self._local_path

  def IsDirectory(self):
    return False

  def GenerateScmDiff(self):
    result = ""
    for line in difflib.unified_diff(self._old_contents, self._new_contents,
                                     self._local_path, self._local_path):
      result += line
    return result

  # NOTE: This method is a copy of ChangeContents method of AffectedFile in
  # presubmit_support.py
  def ChangedContents(self):
    """Returns a list of tuples (line number, line text) of all new lines.

     This relies on the scm diff output describing each changed code section
     with a line of the form

     ^@@ <old line num>,<old size> <new line num>,<new size> @@$
    """
    if self._cached_changed_contents is not None:
      return self._cached_changed_contents[:]
    self._cached_changed_contents = []
    line_num = 0

    if self.IsDirectory():
      return []

    for line in self.GenerateScmDiff().splitlines():
      m = re.match(r'^@@ [0-9\,\+\-]+ \+([0-9]+)\,[0-9]+ @@', line)
      if m:
        line_num = int(m.groups(1)[0])
        continue
      if line.startswith('+') and not line.startswith('++'):
        self._cached_changed_contents.append((line_num, line[1:]))
      if not line.startswith('-'):
        line_num += 1
    return self._cached_changed_contents[:]


class MockChange(object):
  def __init__(self, changed_files):
    self._changed_files = changed_files

  def LocalPaths(self):
    return self._changed_files


class HistogramValueCheckerTest(unittest.TestCase):
  TEST_FILE_PATTERN = "PRESUBMIT_test_new_file_%s.txt"

  def _ReadTextFileContents(self, path):
    """Given a path, returns a list of strings corresponding to the text lines
    in the file. Reads files in text format.

    """
    fo = open(path, 'r')
    try:
      contents = fo.readlines()
    finally:
      fo.close()
    return contents

  def _ReadInputFile(self):
    return self._ReadTextFileContents("PRESUBMIT_test_old_file.txt")

  def _PrepareTest(self, new_file_path):
    old_contents = self._ReadInputFile()
    if not new_file_path:
      new_contents = []
    else:
      new_contents = self._ReadTextFileContents(new_file_path)
    input_api = MockInputApi()
    mock_file = MockFile(PRESUBMIT.HistogramValueChecker.LOCAL_PATH,
                         old_contents,
                         new_contents)
    input_api.files.append(mock_file)
    output_api = MockOutputApi()
    return input_api, output_api

  def _RunTest(self, new_file_path):
    input_api, output_api = self._PrepareTest(new_file_path)
    checker = PRESUBMIT.HistogramValueChecker(input_api, output_api)
    results = checker.Run()
    return results

  def testDeleteFile(self):
    results = self._RunTest(new_file_path=None)
    # TODO(rpaquay) How to check it's the expected warning?'
    self.assertEquals(1, len(results),
                      "We hould get a single warning about file deletion.")

  def testSimpleValidEdit(self):
    results = self._RunTest(self.TEST_FILE_PATTERN % "1")
    # TODO(rpaquay) How to check it's the expected warning?'
    self.assertEquals(0, len(results),
                      "We should get no warning for simple edits.")

  def testSingleDeletionOfEntry(self):
    results = self._RunTest(self.TEST_FILE_PATTERN % "2")
    # TODO(rpaquay) How to check it's the expected warning?'
    self.assertEquals(1, len(results),
                      "We should get a warning for an entry deletion.")

  def testSingleRenameOfEntry(self):
    results = self._RunTest(self.TEST_FILE_PATTERN % "3")
    # TODO(rpaquay) How to check it's the expected warning?'
    self.assertEquals(1, len(results),
                      "We should get a warning for an entry rename, even "
                      "though it is not optimal.")

  def testMissingEnumStartOfEntry(self):
    results = self._RunTest(self.TEST_FILE_PATTERN % "4")
    # TODO(rpaquay) How to check it's the expected warning?'
    self.assertEquals(1, len(results),
                      "We should get a warning for a missing enum marker.")

  def testMissingEnumEndOfEntry(self):
    results = self._RunTest(self.TEST_FILE_PATTERN % "5")
    # TODO(rpaquay) How to check it's the expected warning?'
    self.assertEquals(1, len(results),
                      "We should get a warning for a missing enum marker.")

  def testInvertedEnumMarkersOfEntry(self):
    results = self._RunTest(self.TEST_FILE_PATTERN % "6")
    # TODO(rpaquay) How to check it's the expected warning?'
    self.assertEquals(1, len(results),
                      "We should get a warning for inverted enum markers.")

  def testMultipleInvalidEdits(self):
    results = self._RunTest(self.TEST_FILE_PATTERN % "7")
    # TODO(rpaquay) How to check it's the expected warning?'
    self.assertEquals(3, len(results),
                      "We should get 3 warnings (one per edit).")

  def testSingleInvalidInserts(self):
    results = self._RunTest(self.TEST_FILE_PATTERN % "8")
    # TODO(rpaquay) How to check it's the expected warning?'
    self.assertEquals(1, len(results),
                      "We should get a warning for a single invalid "
                      "insertion inside the enum.")

  def testMulitpleValidInserts(self):
    results = self._RunTest(self.TEST_FILE_PATTERN % "9")
    # TODO(rpaquay) How to check it's the expected warning?'
    self.assertEquals(0, len(results),
                      "We should not get a warning mulitple valid edits")

  def testSingleValidDeleteOutsideOfEnum(self):
    results = self._RunTest(self.TEST_FILE_PATTERN % "10")
    # TODO(rpaquay) How to check it's the expected warning?'
    self.assertEquals(0, len(results),
                      "We should not get a warning for a deletion outside of "
                      "the enum")


if __name__ == '__main__':
  unittest.main()