/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 brzlib/tests/test_msgeditor.py

  • Committer: Jelmer Vernooij
  • Date: 2017-05-21 12:41:27 UTC
  • mto: This revision was merged to the branch mainline in revision 6623.
  • Revision ID: jelmer@jelmer.uk-20170521124127-iv8etg0vwymyai6y
s/bzr/brz/ in apport config.

Show diffs side-by-side

added added

removed removed

Lines of Context:
brzlib/tests/test_msgeditor.py
20
20
import os
21
21
import sys
22
22
 
23
 
from .. import (
 
23
from brzlib import (
24
24
    commit,
25
25
    config,
26
26
    errors,
28
28
    osutils,
29
29
    trace,
30
30
    )
31
 
from ..msgeditor import (
 
31
from brzlib.msgeditor import (
32
32
    make_commit_message_template_encoded,
33
33
    edit_commit_message_encoded
34
34
)
35
 
from . import (
 
35
from brzlib.tests import (
36
36
    features,
37
37
    TestCaseInTempDir,
38
38
    TestCaseWithTransport,
39
39
    TestNotApplicable,
 
40
    TestSkipped,
40
41
    multiply_tests,
41
42
    probe_bad_non_ascii,
42
 
    probe_unicode_in_user_encoding,
43
43
    split_suite_by_re,
44
44
    )
45
 
from .EncodingAdapter import encoding_scenarios
46
 
from ..trace import mutter
47
 
 
48
 
 
49
 
def load_tests(loader, standard_tests, pattern):
 
45
from brzlib.tests.EncodingAdapter import encoding_scenarios
 
46
from brzlib.trace import mutter
 
47
 
 
48
 
 
49
def load_tests(standard_tests, module, loader):
50
50
    """Parameterize the test for tempfile creation with different encodings."""
51
 
    to_adapt, result = split_suite_by_re(
52
 
        standard_tests,
 
51
    to_adapt, result = split_suite_by_re(standard_tests,
53
52
        "test__create_temp_file_with_commit_template_in_unicode_dir")
54
53
    return multiply_tests(to_adapt, encoding_scenarios, result)
55
54
 
59
58
    def make_uncommitted_tree(self):
60
59
        """Build a branch with uncommitted unicode named changes in the cwd."""
61
60
        working_tree = self.make_branch_and_tree('.')
 
61
        b = working_tree.branch
62
62
        filename = u'hell\u00d8'
63
63
        try:
64
 
            self.build_tree_contents([(filename, b'contents of hello')])
 
64
            self.build_tree_contents([(filename, 'contents of hello')])
65
65
        except UnicodeEncodeError:
66
 
            self.skipTest("can't build unicode working tree in "
67
 
                          "filesystem encoding %s" % sys.getfilesystemencoding())
 
66
            raise TestSkipped("can't build unicode working tree in "
 
67
                "filesystem encoding %s" % sys.getfilesystemencoding())
68
68
        working_tree.add(filename)
69
69
        return working_tree
70
70
 
72
72
        """Test building a commit message template"""
73
73
        working_tree = self.make_uncommitted_tree()
74
74
        template = msgeditor.make_commit_message_template(working_tree,
75
 
                                                          None)
 
75
                                                                 None)
76
76
        self.assertEqualDiff(template,
77
 
                             u"""\
 
77
u"""\
78
78
added:
79
79
  hell\u00d8
80
80
""")
83
83
        config.GlobalStack().set('email', 'Bilbo Baggins <bb@hobbit.net>')
84
84
        tree = self.make_branch_and_tree('a')
85
85
        tree.commit('Initial checkin.', timestamp=1230912900, timezone=0)
86
 
        tree2 = tree.controldir.clone('b').open_workingtree()
 
86
        tree2 = tree.bzrdir.clone('b').open_workingtree()
87
87
        tree.commit('Minor tweak.', timestamp=1231977840, timezone=0)
88
88
        tree2.commit('Feature X work.', timestamp=1233186240, timezone=0)
89
 
        tree3 = tree2.controldir.clone('c').open_workingtree()
 
89
        tree3 = tree2.bzrdir.clone('c').open_workingtree()
90
90
        tree2.commit('Feature X finished.', timestamp=1233187680, timezone=0)
91
91
        tree3.commit('Feature Y, based on initial X work.',
92
92
                     timestamp=1233285960, timezone=0)
102
102
        working_tree = self.make_multiple_pending_tree()
103
103
        template = msgeditor.make_commit_message_template(working_tree, None)
104
104
        self.assertEqualDiff(template,
105
 
                             u"""\
 
105
u"""\
106
106
pending merges:
107
107
  Bilbo Baggins 2009-01-29 Feature X finished.
108
108
    Bilbo Baggins 2009-01-28 Feature X work.
116
116
                                                        None,
117
117
                                                        output_encoding='utf8')
118
118
        self.assertEqualDiff(template,
119
 
                             u"""\
 
119
u"""\
120
120
added:
121
121
  hell\u00d8
122
122
""".encode("utf8"))
123
123
 
 
124
 
124
125
    def test_commit_template_and_diff(self):
125
126
        """Test building a commit message template"""
126
127
        working_tree = self.make_uncommitted_tree()
129
130
                                                        diff=True,
130
131
                                                        output_encoding='utf8')
131
132
 
132
 
        self.assertTrue(b"""\
 
133
        self.assertTrue("""\
133
134
@@ -0,0 +1,1 @@
134
135
+contents of hello
135
136
""" in template)
141
142
    def make_do_nothing_editor(self, basename='fed'):
142
143
        if sys.platform == "win32":
143
144
            name = basename + '.bat'
144
 
            with open(name, 'w') as f:
145
 
                f.write('@rem dummy fed')
 
145
            f = file(name, 'w')
 
146
            f.write('@rem dummy fed')
 
147
            f.close()
146
148
            return name
147
149
        else:
148
150
            name = basename + '.sh'
149
 
            with open(name, 'wb') as f:
150
 
                f.write(b'#!/bin/sh\n')
151
 
            os.chmod(name, 0o755)
 
151
            f = file(name, 'wb')
 
152
            f.write('#!/bin/sh\n')
 
153
            f.close()
 
154
            os.chmod(name, 0755)
152
155
            return './' + name
153
156
 
154
157
    def test_run_editor(self):
155
 
        self.overrideEnv('BRZ_EDITOR', self.make_do_nothing_editor())
 
158
        self.overrideEnv('BZR_EDITOR', self.make_do_nothing_editor())
156
159
        self.assertEqual(True, msgeditor._run_editor(''),
157
160
                         'Unable to run dummy fake editor')
158
161
 
161
164
 
162
165
        See <https://bugs.launchpad.net/bzr/+bug/220331>
163
166
        """
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
        self.overrideEnv('BZR_EDITOR',
 
168
            '"%s"' % self.make_do_nothing_editor('name with spaces'))
 
169
        self.assertEqual(True, msgeditor._run_editor('a_filename'))    
167
170
 
168
 
    def make_fake_editor(self, message='test message from fed\n'):
 
171
    def make_fake_editor(self, message='test message from fed\\n'):
169
172
        """Set up environment so that an editor will be a known script.
170
173
 
171
 
        Sets up BRZ_EDITOR so that if an editor is spawned it will run a
 
174
        Sets up BZR_EDITOR so that if an editor is spawned it will run a
172
175
        script that just adds a known message to the start of the file.
173
176
        """
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("""\
 
177
        f = file('fed.py', 'wb')
 
178
        f.write('#!%s\n' % sys.executable)
 
179
        f.write("""\
179
180
# coding=utf-8
180
181
import sys
181
182
if len(sys.argv) == 2:
182
183
    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)
 
184
    f = file(fn, 'rb')
 
185
    s = f.read()
 
186
    f.close()
 
187
    f = file(fn, 'wb')
 
188
    f.write('%s')
 
189
    f.write(s)
 
190
    f.close()
188
191
""" % (message, ))
 
192
        f.close()
189
193
        if sys.platform == "win32":
190
 
            # [win32] make batch file and set BRZ_EDITOR
191
 
            with open('fed.bat', 'w') as f:
192
 
                f.write("""\
 
194
            # [win32] make batch file and set BZR_EDITOR
 
195
            f = file('fed.bat', 'w')
 
196
            f.write("""\
193
197
@echo off
194
198
"%s" fed.py %%1
195
199
""" % sys.executable)
196
 
            self.overrideEnv('BRZ_EDITOR', 'fed.bat')
 
200
            f.close()
 
201
            self.overrideEnv('BZR_EDITOR', 'fed.bat')
197
202
        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')
 
203
            # [non-win32] make python script executable and set BZR_EDITOR
 
204
            os.chmod('fed.py', 0755)
 
205
            self.overrideEnv('BZR_EDITOR', './fed.py')
201
206
 
202
 
    def test_edit_commit_message_without_infotext(self):
203
 
        self.make_uncommitted_tree()
 
207
    def test_edit_commit_message(self):
 
208
        working_tree = self.make_uncommitted_tree()
204
209
        self.make_fake_editor()
205
210
 
206
211
        mutter('edit_commit_message without infotext')
207
212
        self.assertEqual('test message from fed\n',
208
213
                         msgeditor.edit_commit_message(''))
209
214
 
210
 
    def test_edit_commit_message_with_ascii_infotext(self):
211
 
        self.make_uncommitted_tree()
212
 
        self.make_fake_editor()
213
 
 
214
215
        mutter('edit_commit_message with ascii string infotext')
215
216
        self.assertEqual('test message from fed\n',
216
217
                         msgeditor.edit_commit_message('spam'))
217
218
 
218
 
    def test_edit_commit_message_with_unicode_infotext(self):
219
 
        self.make_uncommitted_tree()
220
 
        self.make_fake_editor()
221
 
 
222
219
        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
220
        self.assertEqual('test message from fed\n',
230
 
                         msgeditor.edit_commit_message(uni_val))
 
221
                         msgeditor.edit_commit_message(u'\u1234'))
231
222
 
232
223
        tmpl = edit_commit_message_encoded(u'\u1234'.encode("utf8"))
233
224
        self.assertEqual('test message from fed\n', tmpl)
236
227
        self.make_uncommitted_tree()
237
228
        self.make_fake_editor()
238
229
        self.assertEqual('test message from fed\nstart message\n',
239
 
                         msgeditor.edit_commit_message(
240
 
                             '', start_message='start message\n'))
 
230
                         msgeditor.edit_commit_message('',
 
231
                                              start_message='start message\n'))
241
232
        self.assertEqual('test message from fed\n',
242
 
                         msgeditor.edit_commit_message(
243
 
                             '', start_message=''))
 
233
                         msgeditor.edit_commit_message('',
 
234
                                              start_message=''))
244
235
 
245
236
    def test_deleted_commit_message(self):
246
 
        self.make_uncommitted_tree()
 
237
        working_tree = self.make_uncommitted_tree()
247
238
 
248
239
        if sys.platform == 'win32':
249
240
            editor = 'cmd.exe /c del'
250
241
        else:
251
242
            editor = 'rm'
252
 
        self.overrideEnv('BRZ_EDITOR', editor)
 
243
        self.overrideEnv('BZR_EDITOR', editor)
253
244
 
254
 
        self.assertRaises((EnvironmentError, errors.NoSuchFile),
255
 
                          msgeditor.edit_commit_message, '')
 
245
        self.assertRaises((IOError, OSError), msgeditor.edit_commit_message, '')
256
246
 
257
247
    def test__get_editor(self):
258
 
        self.overrideEnv('BRZ_EDITOR', 'bzr_editor')
 
248
        self.overrideEnv('BZR_EDITOR', 'bzr_editor')
259
249
        self.overrideEnv('VISUAL', 'visual')
260
250
        self.overrideEnv('EDITOR', 'editor')
261
251
 
262
252
        conf = config.GlobalStack()
263
 
        conf.store._load_from_string(b'[DEFAULT]\neditor = config_editor\n')
 
253
        conf.store._load_from_string('[DEFAULT]\neditor = config_editor\n')
264
254
        conf.store.save()
265
255
        editors = list(msgeditor._get_editor())
266
256
        editors = [editor for (editor, cfg_src) in editors]
274
264
            self.assertEqual(['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe'],
275
265
                             editors[4:])
276
266
 
 
267
 
277
268
    def test__run_editor_EACCES(self):
278
269
        """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')
 
270
        self.overrideEnv('BZR_EDITOR', 'eacces.py')
 
271
        f = file('eacces.py', 'wb')
 
272
        f.write('# Not a real editor')
 
273
        f.close()
282
274
        # Make the fake editor unreadable (and unexecutable)
283
275
        os.chmod('eacces.py', 0)
284
276
        # Set $EDITOR so that _run_editor will terminate before trying real
286
278
        self.overrideEnv('EDITOR', self.make_do_nothing_editor())
287
279
        # Call _run_editor, capturing mutter.warning calls.
288
280
        warnings = []
289
 
 
290
281
        def warning(*args):
291
282
            if len(args) > 1:
292
283
                warnings.append(args[0] % args[1:])
298
289
            msgeditor._run_editor('')
299
290
        finally:
300
291
            trace.warning = _warning
301
 
        self.assertStartsWith(
302
 
            warnings[0], 'Could not start editor "eacces.py"')
 
292
        self.assertStartsWith(warnings[0], 'Could not start editor "eacces.py"')
303
293
 
304
294
    def test__create_temp_file_with_commit_template(self):
305
295
        # check that commit template written properly
306
296
        # and has platform native line-endings (CRLF on win32)
307
297
        create_file = msgeditor._create_temp_file_with_commit_template
308
 
        msgfilename, hasinfo = create_file(
309
 
            b'infotext', '----', b'start message')
 
298
        msgfilename, hasinfo = create_file('infotext','----','start message')
310
299
        self.assertNotEqual(None, msgfilename)
311
300
        self.assertTrue(hasinfo)
312
301
        expected = os.linesep.join(['start message',
324
313
            os.mkdir(tmpdir)
325
314
            # Force the creation of temp file in a directory whose name
326
315
            # requires some encoding support
327
 
            msgeditor._create_temp_file_with_commit_template(b'infotext',
 
316
            msgeditor._create_temp_file_with_commit_template('infotext',
328
317
                                                             tmpdir=tmpdir)
329
318
        else:
330
319
            raise TestNotApplicable('Test run elsewhere with non-ascii data.')
344
333
        # in default user encoding
345
334
        char = probe_bad_non_ascii(osutils.get_user_encoding())
346
335
        if char is None:
347
 
            self.skipTest(
348
 
                'Cannot find suitable non-ascii character '
 
336
            raise TestSkipped('Cannot find suitable non-ascii character '
349
337
                'for user_encoding (%s)' % osutils.get_user_encoding())
350
338
 
351
339
        self.make_fake_editor(message=char)
352
340
 
353
 
        self.make_uncommitted_tree()
354
 
        self.assertRaises(msgeditor.BadCommitMessageEncoding,
 
341
        working_tree = self.make_uncommitted_tree()
 
342
        self.assertRaises(errors.BadCommitMessageEncoding,
355
343
                          msgeditor.edit_commit_message, '')
356
344
 
357
345
    def test_set_commit_message_no_hooks(self):
358
346
        commit_obj = commit.Commit()
359
347
        self.assertIs(None,
360
 
                      msgeditor.set_commit_message(commit_obj))
 
348
            msgeditor.set_commit_message(commit_obj))
361
349
 
362
350
    def test_set_commit_message_hook(self):
363
351
        msgeditor.hooks.install_named_hook("set_commit_message",
364
 
                                           lambda commit_obj, existing_message: "save me some typing\n", None)
 
352
                lambda commit_obj, existing_message: "save me some typing\n", None)
365
353
        commit_obj = commit.Commit()
366
354
        self.assertEqual("save me some typing\n",
367
 
                         msgeditor.set_commit_message(commit_obj))
 
355
            msgeditor.set_commit_message(commit_obj))
368
356
 
369
357
    def test_generate_commit_message_template_no_hooks(self):
370
358
        commit_obj = commit.Commit()
371
359
        self.assertIs(None,
372
 
                      msgeditor.generate_commit_message_template(commit_obj))
 
360
            msgeditor.generate_commit_message_template(commit_obj))
373
361
 
374
362
    def test_generate_commit_message_template_hook(self):
375
363
        msgeditor.hooks.install_named_hook("commit_message_template",
376
 
                                           lambda commit_obj, msg: "save me some typing\n", None)
 
364
                lambda commit_obj, msg: "save me some typing\n", None)
377
365
        commit_obj = commit.Commit()
378
366
        self.assertEqual("save me some typing\n",
379
 
                         msgeditor.generate_commit_message_template(commit_obj))
 
367
            msgeditor.generate_commit_message_template(commit_obj))
380
368
 
381
369
 
382
370
# GZ 2009-11-17: This wants moving to osutils when the errno checking code is
386
374
    def test_subprocess_call_bad_file(self):
387
375
        if sys.platform != "win32":
388
376
            raise TestNotApplicable("Workarounds for windows only")
389
 
        import subprocess
390
 
        import errno
 
377
        import subprocess, errno
391
378
        ERROR_BAD_EXE_FORMAT = 193
392
 
        open("textfile.txt", "w").close()
 
379
        file("textfile.txt", "w").close()
393
380
        e = self.assertRaises(WindowsError, subprocess.call, "textfile.txt")
394
381
        self.assertEqual(e.errno, errno.ENOEXEC)
395
382
        self.assertEqual(e.winerror, ERROR_BAD_EXE_FORMAT)