commit-queue should check for oops in changelog entries
[WebKit-https.git] / Tools / Scripts / webkitpy / tool / steps / validatechangelogs_unittest.py
1 # Copyright (C) 2010 Google Inc. All rights reserved.
2 #
3 # Redistribution and use in source and binary forms, with or without
4 # modification, are permitted provided that the following conditions are
5 # met:
6 #
7 #     * Redistributions of source code must retain the above copyright
8 # notice, this list of conditions and the following disclaimer.
9 #     * Redistributions in binary form must reproduce the above
10 # copyright notice, this list of conditions and the following disclaimer
11 # in the documentation and/or other materials provided with the
12 # distribution.
13 #     * Neither the name of Google Inc. nor the names of its
14 # contributors may be used to endorse or promote products derived from
15 # this software without specific prior written permission.
16 #
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29 import unittest2 as unittest
30
31 from webkitpy.common.system.outputcapture import OutputCapture
32 from webkitpy.thirdparty.mock import Mock
33 from webkitpy.tool.mocktool import MockOptions, MockTool
34 from webkitpy.tool.steps.validatechangelogs import ValidateChangeLogs
35
36
37 class ValidateChangeLogsTest(unittest.TestCase):
38
39     def _assert_start_line_produces_output(self, start_line, should_fail=False, non_interactive=False):
40         tool = MockTool()
41         step = ValidateChangeLogs(tool, MockOptions(git_commit=None, non_interactive=non_interactive))
42         diff_file = Mock()
43         diff_file.filename = "mock/ChangeLog"
44         diff_file.lines = [(start_line, start_line, "foo")]
45         expected_stdout = expected_stderr = expected_logs = ""
46         if should_fail and not non_interactive:
47             expected_logs = "The diff to mock/ChangeLog looks wrong. Are you sure your ChangeLog entry is at the top of the file?\nOK to continue?\n"
48         result = OutputCapture().assert_outputs(self, step._check_changelog_diff, [diff_file], expected_logs=expected_logs)
49         self.assertEqual(not result, should_fail)
50
51     def test_check_changelog_diff(self):
52         self._assert_start_line_produces_output(1)
53         self._assert_start_line_produces_output(7)
54         self._assert_start_line_produces_output(8, should_fail=True)
55
56         self._assert_start_line_produces_output(1, non_interactive=False)
57         self._assert_start_line_produces_output(8, non_interactive=True, should_fail=True)
58
59     def test_changelog_contains_oops(self):
60         tool = MockTool()
61         tool._checkout.is_path_to_changelog = lambda path: True
62         step = ValidateChangeLogs(tool, MockOptions(git_commit=None, non_interactive=True, check_oops=True))
63         diff_file = Mock()
64         diff_file.filename = "mock/ChangeLog"
65         diff_file.lines = [(1, 1, "foo"), (2, 2, "bar OOPS! bar"), (3, 3, "foo")]
66         self.assertTrue(OutputCapture().assert_outputs(self, step._changelog_contains_oops, [diff_file], expected_logs=''))
67
68         diff_file.lines = [(1, 1, "foo"), (2, 2, "bar OOPS bar"), (3, 3, "foo")]
69         self.assertFalse(OutputCapture().assert_outputs(self, step._changelog_contains_oops, [diff_file], expected_logs=''))