/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/tests/test_msgeditor.py

  • Committer: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/tests/test_msgeditor.py
 
1
# Copyright (C) 2005-2012, 2016 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Test commit message editor.
 
18
"""
 
19
 
 
20
import os
 
21
import sys
 
22
 
 
23
from .. import (
 
24
    commit,
 
25
    config,
 
26
    errors,
 
27
    msgeditor,
 
28
    osutils,
 
29
    trace,
 
30
    )
 
31
from ..msgeditor import (
 
32
    make_commit_message_template_encoded,
 
33
    edit_commit_message_encoded
 
34
)
 
35
from . import (
 
36
    features,
 
37
    TestCaseInTempDir,
 
38
    TestCaseWithTransport,
 
39
    TestNotApplicable,
 
40
    multiply_tests,
 
41
    probe_bad_non_ascii,
 
42
    probe_unicode_in_user_encoding,
 
43
    split_suite_by_re,
 
44
    )
 
45
from .EncodingAdapter import encoding_scenarios
 
46
from ..trace import mutter
 
47
 
 
48
 
 
49
def load_tests(loader, standard_tests, pattern):
 
50
    """Parameterize the test for tempfile creation with different encodings."""
 
51
    to_adapt, result = split_suite_by_re(
 
52
        standard_tests,
 
53
        "test__create_temp_file_with_commit_template_in_unicode_dir")
 
54
    return multiply_tests(to_adapt, encoding_scenarios, result)
 
55
 
 
56
 
 
57
class MsgEditorTest(TestCaseWithTransport):
 
58
 
 
59
    def make_uncommitted_tree(self):
 
60
        """Build a branch with uncommitted unicode named changes in the cwd."""
 
61
        working_tree = self.make_branch_and_tree('.')
 
62
        filename = u'hell\u00d8'
 
63
        try:
 
64
            self.build_tree_contents([(filename, b'contents of hello')])
 
65
        except UnicodeEncodeError:
 
66
            self.skipTest("can't build unicode working tree in "
 
67
                          "filesystem encoding %s" % sys.getfilesystemencoding())
 
68
        working_tree.add(filename)
 
69
        return working_tree
 
70
 
 
71
    def test_commit_template(self):
 
72
        """Test building a commit message template"""
 
73
        working_tree = self.make_uncommitted_tree()
 
74
        template = msgeditor.make_commit_message_template(working_tree,
 
75
                                                          None)
 
76
        self.assertEqualDiff(template,
 
77
                             u"""\
 
78
added:
 
79
  hell\u00d8
 
80
""")
 
81
 
 
82
    def make_multiple_pending_tree(self):
 
83
        config.GlobalStack().set('email', 'Bilbo Baggins <bb@hobbit.net>')
 
84
        tree = self.make_branch_and_tree('a')
 
85
        tree.commit('Initial checkin.', timestamp=1230912900, timezone=0)
 
86
        tree2 = tree.controldir.clone('b').open_workingtree()
 
87
        tree.commit('Minor tweak.', timestamp=1231977840, timezone=0)
 
88
        tree2.commit('Feature X work.', timestamp=1233186240, timezone=0)
 
89
        tree3 = tree2.controldir.clone('c').open_workingtree()
 
90
        tree2.commit('Feature X finished.', timestamp=1233187680, timezone=0)
 
91
        tree3.commit('Feature Y, based on initial X work.',
 
92
                     timestamp=1233285960, timezone=0)
 
93
        tree.merge_from_branch(tree2.branch)
 
94
        tree.merge_from_branch(tree3.branch, force=True)
 
95
        return tree
 
96
 
 
97
    def test_commit_template_pending_merges(self):
 
98
        """Test building a commit message template when there are pending
 
99
        merges.  The commit message should show all pending merge revisions,
 
100
        as does 'status -v', not only the merge tips.
 
101
        """
 
102
        working_tree = self.make_multiple_pending_tree()
 
103
        template = msgeditor.make_commit_message_template(working_tree, None)
 
104
        self.assertEqualDiff(template,
 
105
                             u"""\
 
106
pending merges:
 
107
  Bilbo Baggins 2009-01-29 Feature X finished.
 
108
    Bilbo Baggins 2009-01-28 Feature X work.
 
109
  Bilbo Baggins 2009-01-30 Feature Y, based on initial X work.
 
110
""")
 
111
 
 
112
    def test_commit_template_encoded(self):
 
113
        """Test building a commit message template"""
 
114
        working_tree = self.make_uncommitted_tree()
 
115
        template = make_commit_message_template_encoded(working_tree,
 
116
                                                        None,
 
117
                                                        output_encoding='utf8')
 
118
        self.assertEqualDiff(template,
 
119
                             u"""\
 
120
added:
 
121
  hell\u00d8
 
122
""".encode("utf8"))
 
123
 
 
124
    def test_commit_template_and_diff(self):
 
125
        """Test building a commit message template"""
 
126
        working_tree = self.make_uncommitted_tree()
 
127
        template = make_commit_message_template_encoded(working_tree,
 
128
                                                        None,
 
129
                                                        diff=True,
 
130
                                                        output_encoding='utf8')
 
131
 
 
132
        self.assertTrue(b"""\
 
133
@@ -0,0 +1,1 @@
 
134
+contents of hello
 
135
""" in template)
 
136
        self.assertTrue(u"""\
 
137
added:
 
138
  hell\u00d8
 
139
""".encode('utf8') in template)
 
140
 
 
141
    def make_do_nothing_editor(self, basename='fed'):
 
142
        if sys.platform == "win32":
 
143
            name = basename + '.bat'
 
144
            with open(name, 'w') as f:
 
145
                f.write('@rem dummy fed')
 
146
            return name
 
147
        else:
 
148
            name = basename + '.sh'
 
149
            with open(name, 'wb') as f:
 
150
                f.write(b'#!/bin/sh\n')
 
151
            os.chmod(name, 0o755)
 
152
            return './' + name
 
153
 
 
154
    def test_run_editor(self):
 
155
        self.overrideEnv('BRZ_EDITOR', self.make_do_nothing_editor())
 
156
        self.assertEqual(True, msgeditor._run_editor(''),
 
157
                         'Unable to run dummy fake editor')
 
158
 
 
159
    def test_parse_editor_name(self):
 
160
        """Correctly interpret names with spaces.
 
161
 
 
162
        See <https://bugs.launchpad.net/bzr/+bug/220331>
 
163
        """
 
164
        self.overrideEnv('BRZ_EDITOR',
 
165
                         '"%s"' % self.make_do_nothing_editor('name with spaces'))
 
166
        self.assertEqual(True, msgeditor._run_editor('a_filename'))
 
167
 
 
168
    def make_fake_editor(self, message='test message from fed\n'):
 
169
        """Set up environment so that an editor will be a known script.
 
170
 
 
171
        Sets up BRZ_EDITOR so that if an editor is spawned it will run a
 
172
        script that just adds a known message to the start of the file.
 
173
        """
 
174
        if not isinstance(message, bytes):
 
175
            message = message.encode('utf-8')
 
176
        with open('fed.py', 'w') as f:
 
177
            f.write('#!%s\n' % sys.executable)
 
178
            f.write("""\
 
179
# coding=utf-8
 
180
import sys
 
181
if len(sys.argv) == 2:
 
182
    fn = sys.argv[1]
 
183
    with open(fn, 'rb') as f:
 
184
        s = f.read()
 
185
    with open(fn, 'wb') as f:
 
186
        f.write(%r)
 
187
        f.write(s)
 
188
""" % (message, ))
 
189
        if sys.platform == "win32":
 
190
            # [win32] make batch file and set BRZ_EDITOR
 
191
            with open('fed.bat', 'w') as f:
 
192
                f.write("""\
 
193
@echo off
 
194
"%s" fed.py %%1
 
195
""" % sys.executable)
 
196
            self.overrideEnv('BRZ_EDITOR', 'fed.bat')
 
197
        else:
 
198
            # [non-win32] make python script executable and set BRZ_EDITOR
 
199
            os.chmod('fed.py', 0o755)
 
200
            self.overrideEnv('BRZ_EDITOR', './fed.py')
 
201
 
 
202
    def test_edit_commit_message_without_infotext(self):
 
203
        self.make_uncommitted_tree()
 
204
        self.make_fake_editor()
 
205
 
 
206
        mutter('edit_commit_message without infotext')
 
207
        self.assertEqual('test message from fed\n',
 
208
                         msgeditor.edit_commit_message(''))
 
209
 
 
210
    def test_edit_commit_message_with_ascii_infotext(self):
 
211
        self.make_uncommitted_tree()
 
212
        self.make_fake_editor()
 
213
 
 
214
        mutter('edit_commit_message with ascii string infotext')
 
215
        self.assertEqual('test message from fed\n',
 
216
                         msgeditor.edit_commit_message('spam'))
 
217
 
 
218
    def test_edit_commit_message_with_unicode_infotext(self):
 
219
        self.make_uncommitted_tree()
 
220
        self.make_fake_editor()
 
221
 
 
222
        mutter('edit_commit_message with unicode infotext')
 
223
        uni_val, ue_val = probe_unicode_in_user_encoding()
 
224
        if ue_val is None:
 
225
            self.skipTest(
 
226
                'Cannot find a unicode character that works in encoding %s'
 
227
                % (osutils.get_user_encoding(),))
 
228
 
 
229
        self.assertEqual('test message from fed\n',
 
230
                         msgeditor.edit_commit_message(uni_val))
 
231
 
 
232
        tmpl = edit_commit_message_encoded(u'\u1234'.encode("utf8"))
 
233
        self.assertEqual('test message from fed\n', tmpl)
 
234
 
 
235
    def test_start_message(self):
 
236
        self.make_uncommitted_tree()
 
237
        self.make_fake_editor()
 
238
        self.assertEqual('test message from fed\nstart message\n',
 
239
                         msgeditor.edit_commit_message(
 
240
                             '', start_message='start message\n'))
 
241
        self.assertEqual('test message from fed\n',
 
242
                         msgeditor.edit_commit_message(
 
243
                             '', start_message=''))
 
244
 
 
245
    def test_deleted_commit_message(self):
 
246
        self.make_uncommitted_tree()
 
247
 
 
248
        if sys.platform == 'win32':
 
249
            editor = 'cmd.exe /c del'
 
250
        else:
 
251
            editor = 'rm'
 
252
        self.overrideEnv('BRZ_EDITOR', editor)
 
253
 
 
254
        self.assertRaises((EnvironmentError, errors.NoSuchFile),
 
255
                          msgeditor.edit_commit_message, '')
 
256
 
 
257
    def test__get_editor(self):
 
258
        self.overrideEnv('BRZ_EDITOR', 'bzr_editor')
 
259
        self.overrideEnv('VISUAL', 'visual')
 
260
        self.overrideEnv('EDITOR', 'editor')
 
261
 
 
262
        conf = config.GlobalStack()
 
263
        conf.store._load_from_string(b'[DEFAULT]\neditor = config_editor\n')
 
264
        conf.store.save()
 
265
        editors = list(msgeditor._get_editor())
 
266
        editors = [editor for (editor, cfg_src) in editors]
 
267
 
 
268
        self.assertEqual(['bzr_editor', 'config_editor', 'visual', 'editor'],
 
269
                         editors[:4])
 
270
 
 
271
        if sys.platform == 'win32':
 
272
            self.assertEqual(['wordpad.exe', 'notepad.exe'], editors[4:])
 
273
        else:
 
274
            self.assertEqual(['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe'],
 
275
                             editors[4:])
 
276
 
 
277
    def test__run_editor_EACCES(self):
 
278
        """If running a configured editor raises EACESS, the user is warned."""
 
279
        self.overrideEnv('BRZ_EDITOR', 'eacces.py')
 
280
        with open('eacces.py', 'wb') as f:
 
281
            f.write(b'# Not a real editor')
 
282
        # Make the fake editor unreadable (and unexecutable)
 
283
        os.chmod('eacces.py', 0)
 
284
        # Set $EDITOR so that _run_editor will terminate before trying real
 
285
        # editors.
 
286
        self.overrideEnv('EDITOR', self.make_do_nothing_editor())
 
287
        # Call _run_editor, capturing mutter.warning calls.
 
288
        warnings = []
 
289
 
 
290
        def warning(*args):
 
291
            if len(args) > 1:
 
292
                warnings.append(args[0] % args[1:])
 
293
            else:
 
294
                warnings.append(args[0])
 
295
        _warning = trace.warning
 
296
        trace.warning = warning
 
297
        try:
 
298
            msgeditor._run_editor('')
 
299
        finally:
 
300
            trace.warning = _warning
 
301
        self.assertStartsWith(
 
302
            warnings[0], 'Could not start editor "eacces.py"')
 
303
 
 
304
    def test__create_temp_file_with_commit_template(self):
 
305
        # check that commit template written properly
 
306
        # and has platform native line-endings (CRLF on win32)
 
307
        create_file = msgeditor._create_temp_file_with_commit_template
 
308
        msgfilename, hasinfo = create_file(
 
309
            b'infotext', '----', b'start message')
 
310
        self.assertNotEqual(None, msgfilename)
 
311
        self.assertTrue(hasinfo)
 
312
        expected = os.linesep.join(['start message',
 
313
                                    '',
 
314
                                    '',
 
315
                                    '----',
 
316
                                    '',
 
317
                                    'infotext'])
 
318
        self.assertFileEqual(expected, msgfilename)
 
319
 
 
320
    def test__create_temp_file_with_commit_template_in_unicode_dir(self):
 
321
        self.requireFeature(features.UnicodeFilenameFeature)
 
322
        if hasattr(self, 'info'):
 
323
            tmpdir = self.info['directory']
 
324
            os.mkdir(tmpdir)
 
325
            # Force the creation of temp file in a directory whose name
 
326
            # requires some encoding support
 
327
            msgeditor._create_temp_file_with_commit_template(b'infotext',
 
328
                                                             tmpdir=tmpdir)
 
329
        else:
 
330
            raise TestNotApplicable('Test run elsewhere with non-ascii data.')
 
331
 
 
332
    def test__create_temp_file_with_empty_commit_template(self):
 
333
        # empty file
 
334
        create_file = msgeditor._create_temp_file_with_commit_template
 
335
        msgfilename, hasinfo = create_file('')
 
336
        self.assertNotEqual(None, msgfilename)
 
337
        self.assertFalse(hasinfo)
 
338
        self.assertFileEqual('', msgfilename)
 
339
 
 
340
    def test_unsupported_encoding_commit_message(self):
 
341
        self.overrideEnv('LANG', 'C')
 
342
        # LANG env variable has no effect on Windows
 
343
        # but some characters anyway cannot be represented
 
344
        # in default user encoding
 
345
        char = probe_bad_non_ascii(osutils.get_user_encoding())
 
346
        if char is None:
 
347
            self.skipTest(
 
348
                'Cannot find suitable non-ascii character '
 
349
                'for user_encoding (%s)' % osutils.get_user_encoding())
 
350
 
 
351
        self.make_fake_editor(message=char)
 
352
 
 
353
        self.make_uncommitted_tree()
 
354
        self.assertRaises(msgeditor.BadCommitMessageEncoding,
 
355
                          msgeditor.edit_commit_message, '')
 
356
 
 
357
    def test_set_commit_message_no_hooks(self):
 
358
        commit_obj = commit.Commit()
 
359
        self.assertIs(None,
 
360
                      msgeditor.set_commit_message(commit_obj))
 
361
 
 
362
    def test_set_commit_message_hook(self):
 
363
        msgeditor.hooks.install_named_hook("set_commit_message",
 
364
                                           lambda commit_obj, existing_message: "save me some typing\n", None)
 
365
        commit_obj = commit.Commit()
 
366
        self.assertEqual("save me some typing\n",
 
367
                         msgeditor.set_commit_message(commit_obj))
 
368
 
 
369
    def test_generate_commit_message_template_no_hooks(self):
 
370
        commit_obj = commit.Commit()
 
371
        self.assertIs(None,
 
372
                      msgeditor.generate_commit_message_template(commit_obj))
 
373
 
 
374
    def test_generate_commit_message_template_hook(self):
 
375
        msgeditor.hooks.install_named_hook("commit_message_template",
 
376
                                           lambda commit_obj, msg: "save me some typing\n", None)
 
377
        commit_obj = commit.Commit()
 
378
        self.assertEqual("save me some typing\n",
 
379
                         msgeditor.generate_commit_message_template(commit_obj))
 
380
 
 
381
 
 
382
# GZ 2009-11-17: This wants moving to osutils when the errno checking code is
 
383
class TestPlatformErrnoWorkarounds(TestCaseInTempDir):
 
384
    """Ensuring workarounds enshrined in code actually serve a purpose"""
 
385
 
 
386
    def test_subprocess_call_bad_file(self):
 
387
        if sys.platform != "win32":
 
388
            raise TestNotApplicable("Workarounds for windows only")
 
389
        import subprocess
 
390
        import errno
 
391
        ERROR_BAD_EXE_FORMAT = 193
 
392
        open("textfile.txt", "w").close()
 
393
        e = self.assertRaises(WindowsError, subprocess.call, "textfile.txt")
 
394
        self.assertEqual(e.errno, errno.ENOEXEC)
 
395
        self.assertEqual(e.winerror, ERROR_BAD_EXE_FORMAT)