← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_msgeditor.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-01-03 18:09:01 UTC
  • mfrom: (3159.1.1 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20080103180901-w987y1ftqoh02qbm
(vila) Fix #179368 by keeping the current range hint on
        ShortReadvErrors

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_msgeditor.py
20
20
import os
21
21
import sys
22
22
 
 
23
import bzrlib
 
24
from bzrlib import (
 
25
    errors,
 
26
    msgeditor,
 
27
    osutils,
 
28
    )
23
29
from bzrlib.branch import Branch
24
30
from bzrlib.config import ensure_config_dir_exists, config_filename
25
 
import bzrlib.msgeditor 
26
 
from bzrlib.tests import TestCaseWithTransport, TestSkipped
 
31
from bzrlib.msgeditor import (
 
32
    make_commit_message_template_encoded,
 
33
    edit_commit_message_encoded
 
34
)
 
35
from bzrlib.tests import (
 
36
    iter_suite_tests,
 
37
    probe_bad_non_ascii,
 
38
    split_suite_by_re,
 
39
    TestCaseWithTransport,
 
40
    TestNotApplicable,
 
41
    TestSkipped,
 
42
    )
 
43
from bzrlib.tests.EncodingAdapter import EncodingTestAdapter
27
44
from bzrlib.trace import mutter
28
45
 
29
46
 
 
47
def load_tests(standard_tests, module, loader):
 
48
    """Parameterize the test for tempfile creation with different encodings."""
 
49
    to_adapt, result = split_suite_by_re(standard_tests,
 
50
        "test__create_temp_file_with_commit_template_in_unicode_dir")
 
51
    for test in iter_suite_tests(to_adapt):
 
52
        result.addTests(EncodingTestAdapter().adapt(test))
 
53
    return result
 
54
 
 
55
 
30
56
class MsgEditorTest(TestCaseWithTransport):
31
57
 
32
58
    def make_uncommitted_tree(self):
45
71
    def test_commit_template(self):
46
72
        """Test building a commit message template"""
47
73
        working_tree = self.make_uncommitted_tree()
48
 
        template = bzrlib.msgeditor.make_commit_message_template(working_tree, None)
 
74
        template = msgeditor.make_commit_message_template(working_tree,
 
75
                                                                 None)
49
76
        self.assertEqualDiff(template,
50
77
u"""\
51
78
added:
52
79
  hell\u00d8
53
80
""")
54
81
 
55
 
    def setUp(self):
56
 
        super(MsgEditorTest, self).setUp()
57
 
        self._bzr_editor = os.environ.get('BZR_EDITOR', None)
58
 
 
59
 
    def tearDown(self):
60
 
        if self._bzr_editor is not None:
61
 
            os.environ['BZR_EDITOR'] = self._bzr_editor
62
 
        else:
63
 
            if os.environ.get('BZR_EDITOR', None) is not None:
64
 
                del os.environ['BZR_EDITOR']
65
 
        super(MsgEditorTest, self).tearDown()
 
82
    def test_commit_template_encoded(self):
 
83
        """Test building a commit message template"""
 
84
        working_tree = self.make_uncommitted_tree()
 
85
        template = make_commit_message_template_encoded(working_tree,
 
86
                                                        None,
 
87
                                                        output_encoding='utf8')
 
88
        self.assertEqualDiff(template,
 
89
u"""\
 
90
added:
 
91
  hell\u00d8
 
92
""".encode("utf8"))
 
93
 
 
94
 
 
95
    def test_commit_template_and_diff(self):
 
96
        """Test building a commit message template"""
 
97
        working_tree = self.make_uncommitted_tree()
 
98
        template = make_commit_message_template_encoded(working_tree,
 
99
                                                        None,
 
100
                                                        diff=True,
 
101
                                                        output_encoding='utf8')
 
102
 
 
103
        self.assertTrue("""\
 
104
@@ -0,0 +1,1 @@
 
105
+contents of hello
 
106
""" in template)
 
107
        self.assertTrue(u"""\
 
108
added:
 
109
  hell\u00d8
 
110
""".encode('utf8') in template)
66
111
 
67
112
    def test_run_editor(self):
68
113
        if sys.platform == "win32":
77
122
            os.chmod('fed.sh', 0755)
78
123
            os.environ['BZR_EDITOR'] = './fed.sh'
79
124
 
80
 
        self.assertEqual(True, bzrlib.msgeditor._run_editor(''),
 
125
        self.assertEqual(True, msgeditor._run_editor(''),
81
126
                         'Unable to run dummy fake editor')
82
127
 
83
 
    def make_fake_editor(self):
 
128
    def make_fake_editor(self, message='test message from fed\\n'):
84
129
        """Set up environment so that an editor will be a known script.
85
130
 
86
131
        Sets up BZR_EDITOR so that if an editor is spawned it will run a
89
134
        f = file('fed.py', 'wb')
90
135
        f.write('#!%s\n' % sys.executable)
91
136
        f.write("""\
 
137
# coding=utf-8
92
138
import sys
93
139
if len(sys.argv) == 2:
94
140
    fn = sys.argv[1]
96
142
    s = f.read()
97
143
    f.close()
98
144
    f = file(fn, 'wb')
99
 
    f.write('test message from fed\\n')
 
145
    f.write('%s')
100
146
    f.write(s)
101
147
    f.close()
102
 
""")
 
148
""" % (message, ))
103
149
        f.close()
104
150
        if sys.platform == "win32":
105
151
            # [win32] make batch file and set BZR_EDITOR
121
167
 
122
168
        mutter('edit_commit_message without infotext')
123
169
        self.assertEqual('test message from fed\n',
124
 
                         bzrlib.msgeditor.edit_commit_message(''))
 
170
                         msgeditor.edit_commit_message(''))
 
171
 
 
172
        mutter('edit_commit_message with ascii string infotext')
 
173
        self.assertEqual('test message from fed\n',
 
174
                         msgeditor.edit_commit_message('spam'))
125
175
 
126
176
        mutter('edit_commit_message with unicode infotext')
127
177
        self.assertEqual('test message from fed\n',
128
 
                         bzrlib.msgeditor.edit_commit_message(u'\u1234'))
 
178
                         msgeditor.edit_commit_message(u'\u1234'))
 
179
 
 
180
        tmpl = edit_commit_message_encoded(u'\u1234'.encode("utf8"))
 
181
        self.assertEqual('test message from fed\n', tmpl)
129
182
 
130
183
    def test_start_message(self):
131
184
        self.make_uncommitted_tree()
132
185
        self.make_fake_editor()
133
186
        self.assertEqual('test message from fed\nstart message\n',
134
 
                         bzrlib.msgeditor.edit_commit_message('',
 
187
                         msgeditor.edit_commit_message('',
135
188
                                              start_message='start message\n'))
136
189
        self.assertEqual('test message from fed\n',
137
 
                         bzrlib.msgeditor.edit_commit_message('',
 
190
                         msgeditor.edit_commit_message('',
138
191
                                              start_message=''))
139
192
 
140
193
    def test_deleted_commit_message(self):
145
198
        else:
146
199
            os.environ['BZR_EDITOR'] = 'rm'
147
200
 
148
 
        self.assertRaises((IOError, OSError), bzrlib.msgeditor.edit_commit_message, '')
 
201
        self.assertRaises((IOError, OSError), msgeditor.edit_commit_message, '')
149
202
 
150
203
    def test__get_editor(self):
151
204
        # Test that _get_editor can return a decent list of items
162
215
            f.write('editor = config_editor\n')
163
216
            f.close()
164
217
 
165
 
            editors = list(bzrlib.msgeditor._get_editor())
 
218
            editors = list(msgeditor._get_editor())
166
219
 
167
220
            self.assertEqual(['bzr_editor', 'config_editor', 'visual',
168
221
                              'editor'], editors[:4])
191
244
    def test__create_temp_file_with_commit_template(self):
192
245
        # check that commit template written properly
193
246
        # and has platform native line-endings (CRLF on win32)
194
 
        create_file = bzrlib.msgeditor._create_temp_file_with_commit_template
 
247
        create_file = msgeditor._create_temp_file_with_commit_template
195
248
        msgfilename, hasinfo = create_file('infotext','----','start message')
196
249
        self.assertNotEqual(None, msgfilename)
197
250
        self.assertTrue(hasinfo)
203
256
                                    'infotext'])
204
257
        self.assertFileEqual(expected, msgfilename)
205
258
 
 
259
    def test__create_temp_file_with_commit_template_in_unicode_dir(self):
 
260
        from bzrlib.tests.test_diff import UnicodeFilename
 
261
        self.requireFeature(UnicodeFilename)
 
262
        if hasattr(self, 'info'):
 
263
            os.mkdir(self.info['directory'])
 
264
            os.chdir(self.info['directory'])
 
265
            msgeditor._create_temp_file_with_commit_template('infotext')
 
266
        else:
 
267
            raise TestNotApplicable('Test run elsewhere with non-ascii data.')
 
268
 
206
269
    def test__create_temp_file_with_empty_commit_template(self):
207
270
        # empty file
208
 
        create_file = bzrlib.msgeditor._create_temp_file_with_commit_template
 
271
        create_file = msgeditor._create_temp_file_with_commit_template
209
272
        msgfilename, hasinfo = create_file('')
210
273
        self.assertNotEqual(None, msgfilename)
211
274
        self.assertFalse(hasinfo)
212
275
        self.assertFileEqual('', msgfilename)
 
276
 
 
277
    def test_unsupported_encoding_commit_message(self):
 
278
        old_env = osutils.set_or_unset_env('LANG', 'C')
 
279
        try:
 
280
            # LANG env variable has no effect on Windows
 
281
            # but some characters anyway cannot be represented
 
282
            # in default user encoding
 
283
            char = probe_bad_non_ascii(bzrlib.user_encoding)
 
284
            if char is None:
 
285
                raise TestSkipped('Cannot find suitable non-ascii character '
 
286
                    'for user_encoding (%s)' % bzrlib.user_encoding)
 
287
 
 
288
            self.make_fake_editor(message=char)
 
289
 
 
290
            working_tree = self.make_uncommitted_tree()
 
291
            self.assertRaises(errors.BadCommitMessageEncoding,
 
292
                              msgeditor.edit_commit_message, '')
 
293
        finally:
 
294
            osutils.set_or_unset_env('LANG', old_env)