1
# Copyright (C) 2006, 2007, 2009, 2011 Canonical Ltd
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.
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.
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
17
"""Tests for bzrlib/generate_ids.py"""
25
class TestFileIds(tests.TestCase):
26
"""Test functions which generate file ids"""
28
def assertGenFileId(self, regex, filename):
29
"""gen_file_id should create a file id matching the regex.
31
The file id should be ascii, and should be an 8-bit string
33
file_id = generate_ids.gen_file_id(filename)
34
self.assertContainsRe(file_id, '^'+regex+'$')
35
# It should be a utf8 file_id, not a unicode one
36
self.assertIsInstance(file_id, str)
37
# gen_file_id should always return ascii file ids.
38
file_id.decode('ascii')
40
def test_gen_file_id(self):
41
gen_file_id = generate_ids.gen_file_id
43
# We try to use the filename if possible
44
self.assertStartsWith(gen_file_id('bar'), 'bar-')
46
# but we squash capitalization, and remove non word characters
47
self.assertStartsWith(gen_file_id('Mwoo oof\t m'), 'mwoooofm-')
49
# We also remove leading '.' characters to prevent hidden file-ids
50
self.assertStartsWith(gen_file_id('..gam.py'), 'gam.py-')
51
self.assertStartsWith(gen_file_id('..Mwoo oof\t m'), 'mwoooofm-')
53
# we remove unicode characters, and still don't end up with a
55
self.assertStartsWith(gen_file_id(u'\xe5\xb5.txt'), 'txt-')
57
# Our current method of generating unique ids adds 33 characters
58
# plus an serial number (log10(N) characters)
59
# to the end of the filename. We now restrict the filename portion to
60
# be <= 20 characters, so the maximum length should now be approx < 60
62
# Test both case squashing and length restriction
63
fid = gen_file_id('A'*50 + '.txt')
64
self.assertStartsWith(fid, 'a'*20 + '-')
65
self.assertTrue(len(fid) < 60)
67
# restricting length happens after the other actions, so
68
# we preserve as much as possible
69
fid = gen_file_id('\xe5\xb5..aBcd\tefGhijKLMnop\tqrstuvwxyz')
70
self.assertStartsWith(fid, 'abcdefghijklmnopqrst-')
71
self.assertTrue(len(fid) < 60)
73
def test_file_ids_are_ascii(self):
74
tail = r'-\d{14}-[a-z0-9]{16}-\d+'
75
self.assertGenFileId('foo' + tail, 'foo')
76
self.assertGenFileId('foo' + tail, u'foo')
77
self.assertGenFileId('bar' + tail, u'bar')
78
self.assertGenFileId('br' + tail, u'b\xe5r')
80
def test__next_id_suffix_sets_suffix(self):
81
generate_ids._gen_file_id_suffix = None
82
generate_ids._next_id_suffix()
83
self.assertNotEqual(None, generate_ids._gen_file_id_suffix)
85
def test__next_id_suffix_increments(self):
86
generate_ids._gen_file_id_suffix = "foo-"
87
generate_ids._gen_file_id_serial = 1
89
self.assertEqual("foo-2", generate_ids._next_id_suffix())
90
self.assertEqual("foo-3", generate_ids._next_id_suffix())
91
self.assertEqual("foo-4", generate_ids._next_id_suffix())
92
self.assertEqual("foo-5", generate_ids._next_id_suffix())
93
self.assertEqual("foo-6", generate_ids._next_id_suffix())
94
self.assertEqual("foo-7", generate_ids._next_id_suffix())
95
self.assertEqual("foo-8", generate_ids._next_id_suffix())
96
self.assertEqual("foo-9", generate_ids._next_id_suffix())
97
self.assertEqual("foo-10", generate_ids._next_id_suffix())
99
# Reset so that all future ids generated in the test suite
100
# don't end in 'foo-XXX'
101
generate_ids._gen_file_id_suffix = None
102
generate_ids._gen_file_id_serial = 0
104
def test_gen_root_id(self):
105
# Mostly just make sure gen_root_id() exists
106
root_id = generate_ids.gen_root_id()
107
self.assertStartsWith(root_id, 'tree_root-')
110
class TestGenRevisionId(tests.TestCase):
111
"""Test generating revision ids"""
113
def assertGenRevisionId(self, regex, username, timestamp=None):
114
"""gen_revision_id should create a revision id matching the regex"""
115
revision_id = generate_ids.gen_revision_id(username, timestamp)
116
self.assertContainsRe(revision_id, '^'+regex+'$')
117
# It should be a utf8 revision_id, not a unicode one
118
self.assertIsInstance(revision_id, str)
119
# gen_revision_id should always return ascii revision ids.
120
revision_id.decode('ascii')
122
def test_timestamp(self):
123
"""passing a timestamp should cause it to be used"""
124
self.assertGenRevisionId(r'user@host-\d{14}-[a-z0-9]{16}', 'user@host')
125
self.assertGenRevisionId('user@host-20061102205056-[a-z0-9]{16}',
126
'user@host', 1162500656.688)
127
self.assertGenRevisionId(r'user@host-20061102205024-[a-z0-9]{16}',
128
'user@host', 1162500624.000)
130
def test_gen_revision_id_email(self):
131
"""gen_revision_id uses email address if present"""
132
regex = r'user\+joe_bar@foo-bar\.com-\d{14}-[a-z0-9]{16}'
133
self.assertGenRevisionId(regex,'user+joe_bar@foo-bar.com')
134
self.assertGenRevisionId(regex, '<user+joe_bar@foo-bar.com>')
135
self.assertGenRevisionId(regex, 'Joe Bar <user+joe_bar@foo-bar.com>')
136
self.assertGenRevisionId(regex, 'Joe Bar <user+Joe_Bar@Foo-Bar.com>')
137
self.assertGenRevisionId(regex, u'Joe B\xe5r <user+Joe_Bar@Foo-Bar.com>')
139
def test_gen_revision_id_user(self):
140
"""If there is no email, fall back to the whole username"""
141
tail = r'-\d{14}-[a-z0-9]{16}'
142
self.assertGenRevisionId('joe_bar' + tail, 'Joe Bar')
143
self.assertGenRevisionId('joebar' + tail, 'joebar')
144
self.assertGenRevisionId('joe_br' + tail, u'Joe B\xe5r')
145
self.assertGenRevisionId(r'joe_br_user\+joe_bar_foo-bar.com' + tail,
146
u'Joe B\xe5r <user+Joe_Bar_Foo-Bar.com>')
148
def test_revision_ids_are_ascii(self):
149
"""gen_revision_id should always return an ascii revision id."""
150
tail = r'-\d{14}-[a-z0-9]{16}'
151
self.assertGenRevisionId('joe_bar' + tail, 'Joe Bar')
152
self.assertGenRevisionId('joe_bar' + tail, u'Joe Bar')
153
self.assertGenRevisionId('joe@foo' + tail, u'Joe Bar <joe@foo>')
154
# We cheat a little with this one, because email-addresses shouldn't
155
# contain non-ascii characters, but generate_ids should strip them
157
self.assertGenRevisionId('joe@f' + tail, u'Joe Bar <joe@f\xb6>')