a703ca2ec6eada1c57a0861985790b2742a623dc
[WebKit-https.git] / Tools / Scripts / webkitpy / tool / steps / preparechangelog_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 # Do not import changelog_unittest.ChangeLogTest directly as that will cause it to be run again.
32 from webkitpy.common.checkout import changelog_unittest
33
34 from webkitpy.common.system.filesystem_mock import MockFileSystem
35 from webkitpy.common.system.outputcapture import OutputCapture
36 from webkitpy.tool.mocktool import MockOptions, MockTool
37 from webkitpy.tool.steps.preparechangelog import PrepareChangeLog
38
39 class PrepareChangeLogTest(changelog_unittest.ChangeLogTest):
40     def test_resolve_existing_entry(self):
41         step = PrepareChangeLog(MockTool(), MockOptions())
42
43         roll_over = "== Rolled over to ChangeLog-2012-10-02 =="
44
45         headers = ["2013-01-18  Timothy Loh  <timloh@chromium.com>\n\n",
46                    "2013-01-20  Timothy Loh  <timloh@chromium.com>\n\n",
47                   u"2009-08-17  Tor Arne Vestb\xf8  <vestbo@webkit.org>\n\n",
48                   u"2009-08-18  Tor Arne Vestb\xf8  <vestbo@webkit.org>\n\n",
49                   ]
50
51         bug_descs = ["        prepare-Changelog should support updating the list of changed files\n",
52                      "        webkit-patch upload should support updating the list of changed files\n"]
53
54         bug_url = "        https://bugs.webkit.org/show_bug.cgi?id=74358\n\n"
55
56         descriptions = ["", "        A description of the changes.\n\n",
57                 "        A description.\n\n        With some\n        line breaks\n\n"]
58
59         changes = [
60 """        * Scripts/webkitpy/tool/steps/preparechangelog.py:
61         (PrepareChangeLog):
62         (PrepareChangeLog.run):\n\n""",
63 """        * Scripts/webkitpy/tool/steps/preparechangelog.py:
64         (PrepareChangeLog._resolve_existing_entry):
65         (PrepareChangeLog):
66         (PrepareChangeLog.run):\n\n""",
67 """        * Scripts/webkitpy/tool/steps/preparechangelog.py:
68         (PrepareChangeLog): Some annotations
69         (PrepareChangeLog.run):
70             More annotations\n\n""",
71 """        * Scripts/webkitpy/tool/steps/preparechangelog.py:
72         (PrepareChangeLog): Some annotations
73         (PrepareChangeLog.run):
74             More annotations
75
76         * Scripts/webkitpy/tool/steps/preparechangelog.py:
77         (PrepareChangeLog._resolve_existing_entry):
78         (PrepareChangeLog):
79         (PrepareChangeLog.run):\n\n""",
80             ]
81
82         def make_entry(indices):
83             a, b, c, d = indices
84             return headers[a] + bug_descs[b] + bug_url + descriptions[c] + changes[d]
85
86         test_cases = [((0, 0, 0, 0), (0, 0, 0, 0), (0, 0, 0, 0)),
87                       ((0, 0, 0, 0), (0, 0, 1, 0), (0, 0, 1, 0)),
88                       ((1, 0, 0, 0), (0, 0, 2, 0), (1, 0, 2, 0)),
89                       ((0, 1, 0, 0), (0, 0, 1, 0), (0, 1, 1, 0)),
90                       ((0, 0, 0, 1), (0, 0, 0, 0), (0, 0, 0, 1)),
91                       ((0, 0, 0, 0), (0, 0, 1, 1), (0, 0, 1, 0)),
92                       ((0, 0, 0, 0), (0, 0, 2, 2), (0, 0, 2, 2)),
93                       ((0, 0, 0, 1), (0, 0, 1, 2), (0, 0, 1, 3)),
94                       ((1, 1, 0, 1), (0, 0, 0, 2), (1, 1, 0, 3)),
95                       ((3, 0, 0, 0), (2, 0, 1, 0), (3, 0, 1, 0)),
96         ]
97
98         for new, old, final in test_cases:
99             new_entry = make_entry(new)
100             old_entry = make_entry(old)
101             start_file = new_entry + old_entry + roll_over
102
103             final_entry = make_entry(final)
104             end_file = final_entry + roll_over
105
106             path = "ChangeLog"
107             step._tool.filesystem = MockFileSystem()
108             step._tool.filesystem.write_text_file(path, start_file)
109             step._resolve_existing_entry(path)
110             actual_output = step._tool.filesystem.read_text_file(path)
111             self.assertEquals(actual_output, end_file)
112
113     def test_ensure_bug_url(self):
114         capture = OutputCapture()
115         step = PrepareChangeLog(MockTool(), MockOptions())
116         changelog_contents = u"%s\n%s" % (self._new_entry_boilerplate, self._example_changelog)
117         changelog_path = "ChangeLog"
118         state = {
119             "bug_title": "Example title",
120             "bug_id": 1234,
121             "changelogs": [changelog_path],
122         }
123         step._tool.filesystem = MockFileSystem()
124         step._tool.filesystem.write_text_file(changelog_path, changelog_contents)
125         capture.assert_outputs(self, step._ensure_bug_url, [state])
126         actual_contents = step._tool.filesystem.read_text_file(changelog_path)
127         expected_message = "Example title\n        http://example.com/1234"
128         expected_contents = changelog_contents.replace("Need a short description (OOPS!).\n        Need the bug URL (OOPS!).", expected_message)
129         self.assertEqual(actual_contents, expected_contents)