1
# Copyright (C) 2011, 2016 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 the ControlDir facility.
19
For interface contract tests, see tests/per_control_dir.
28
from .scenarios import load_tests_apply_scenarios
31
load_tests = load_tests_apply_scenarios
34
class TestErrors(tests.TestCase):
36
def test_must_have_working_tree(self):
37
err = controldir.MustHaveWorkingTree('foo', 'bar')
38
self.assertEqual(str(err), "Branching 'bar'(foo) must create a"
42
class SampleComponentFormat(controldir.ControlComponentFormat):
44
def get_format_string(self):
45
return b"Example component format."
48
class SampleExtraComponentFormat(controldir.ControlComponentFormat):
49
"""Extra format, no format string."""
52
class TestMetaComponentFormatRegistry(tests.TestCase):
55
super(TestMetaComponentFormatRegistry, self).setUp()
56
self.registry = controldir.ControlComponentFormatRegistry()
58
def test_register_unregister_format(self):
59
format = SampleComponentFormat()
60
self.registry.register(format)
61
self.assertEqual(format,
62
self.registry.get(b"Example component format."))
63
self.registry.remove(format)
64
self.assertRaises(KeyError, self.registry.get,
65
b"Example component format.")
67
def test_get_all(self):
68
format = SampleComponentFormat()
69
self.assertEqual([], self.registry._get_all())
70
self.registry.register(format)
71
self.assertEqual([format], self.registry._get_all())
73
def test_get_all_modules(self):
74
format = SampleComponentFormat()
75
self.assertEqual(set(), self.registry._get_all_modules())
76
self.registry.register(format)
78
{"breezy.tests.test_controldir"},
79
self.registry._get_all_modules())
81
def test_register_extra(self):
82
format = SampleExtraComponentFormat()
83
self.assertEqual([], self.registry._get_all())
84
self.registry.register_extra(format)
85
self.assertEqual([format], self.registry._get_all())
87
def test_register_extra_lazy(self):
88
self.assertEqual([], self.registry._get_all())
89
self.registry.register_extra_lazy("breezy.tests.test_controldir",
90
"SampleExtraComponentFormat")
91
formats = self.registry._get_all()
92
self.assertEqual(1, len(formats))
93
self.assertIsInstance(formats[0], SampleExtraComponentFormat)
96
class TestProber(tests.TestCaseWithTransport):
97
"""Per-prober tests."""
100
(prober_cls.__name__, {'prober_cls': prober_cls})
101
for prober_cls in controldir.ControlDirFormat._probers]
104
super(TestProber, self).setUp()
105
self.prober = self.prober_cls()
107
def test_probe_transport_empty(self):
108
transport = self.get_transport(".")
109
self.assertRaises(errors.NotBranchError,
110
self.prober.probe_transport, transport)
112
def test_known_formats(self):
113
known_formats = self.prober_cls.known_formats()
114
self.assertIsInstance(known_formats, list)
115
for format in known_formats:
116
self.assertIsInstance(format, controldir.ControlDirFormat,
120
class NotBzrDir(controldir.ControlDir):
121
"""A non .bzr based control directory."""
123
def __init__(self, transport, format):
124
self._format = format
125
self.root_transport = transport
126
self.transport = transport.clone('.not')
129
class NotBzrDirFormat(controldir.ControlDirFormat):
130
"""A test class representing any non-.bzr based disk format."""
132
def initialize_on_transport(self, transport):
133
"""Initialize a new .not dir in the base directory of a Transport."""
134
transport.mkdir('.not')
135
return self.open(transport)
137
def open(self, transport):
138
"""Open this directory."""
139
return NotBzrDir(transport, self)
142
class NotBzrDirProber(controldir.Prober):
144
def probe_transport(self, transport):
145
"""Our format is present if the transport ends in '.not/'."""
146
if transport.has('.not'):
147
return NotBzrDirFormat()
150
def known_formats(cls):
151
return [NotBzrDirFormat()]
154
class TestNotBzrDir(tests.TestCaseWithTransport):
155
"""Tests for using the controldir api with a non .bzr based disk format.
157
If/when one of these is in the core, we can let the implementation tests
161
def test_create_and_find_format(self):
162
# create a .notbzr dir
163
format = NotBzrDirFormat()
164
dir = format.initialize(self.get_url())
165
self.assertIsInstance(dir, NotBzrDir)
167
controldir.ControlDirFormat.register_prober(NotBzrDirProber)
169
found = controldir.ControlDirFormat.find_format(self.get_transport())
170
self.assertIsInstance(found, NotBzrDirFormat)
172
controldir.ControlDirFormat.unregister_prober(NotBzrDirProber)
174
def test_included_in_known_formats(self):
175
controldir.ControlDirFormat.register_prober(NotBzrDirProber)
176
self.addCleanup(controldir.ControlDirFormat.unregister_prober, NotBzrDirProber)
177
formats = controldir.ControlDirFormat.known_formats()
178
self.assertIsInstance(formats, list)
179
for format in formats:
180
if isinstance(format, NotBzrDirFormat):
183
self.fail("No NotBzrDirFormat in %s" % formats)
186
class UnsupportedControlComponentFormat(controldir.ControlComponentFormat):
188
def is_supported(self):
192
class OldControlComponentFormat(controldir.ControlComponentFormat):
194
def get_format_description(self):
195
return "An old format that is slow"
197
upgrade_recommended = True
200
class DefaultControlComponentFormatTests(tests.TestCase):
201
"""Tests for default ControlComponentFormat implementation."""
203
def test_check_support_status_unsupported(self):
204
self.assertRaises(errors.UnsupportedFormatError,
205
UnsupportedControlComponentFormat().check_support_status,
206
allow_unsupported=False)
207
UnsupportedControlComponentFormat().check_support_status(
208
allow_unsupported=True)
210
def test_check_support_status_supported(self):
211
controldir.ControlComponentFormat().check_support_status(
212
allow_unsupported=False)
213
controldir.ControlComponentFormat().check_support_status(
214
allow_unsupported=True)
216
def test_recommend_upgrade_current_format(self):
217
ui.ui_factory = tests.TestUIFactory()
218
format = controldir.ControlComponentFormat()
219
format.check_support_status(allow_unsupported=False,
220
recommend_upgrade=True)
221
self.assertEqual("", ui.ui_factory.stderr.getvalue())
223
def test_recommend_upgrade_old_format(self):
224
ui.ui_factory = tests.TestUIFactory()
225
format = OldControlComponentFormat()
226
format.check_support_status(allow_unsupported=False,
227
recommend_upgrade=False)
228
self.assertEqual("", ui.ui_factory.stderr.getvalue())
229
format.check_support_status(allow_unsupported=False,
230
recommend_upgrade=True, basedir='apath')
232
'An old format that is slow is deprecated and a better format '
233
'is available.\nIt is recommended that you upgrade by running '
234
'the command\n brz upgrade apath\n',
235
ui.ui_factory.stderr.getvalue())
238
class IsControlFilenameTest(tests.TestCase):
240
def test_is_bzrdir(self):
241
self.assertTrue(controldir.is_control_filename('.bzr'))
243
def test_is_not_bzrdir(self):
244
self.assertFalse(controldir.is_control_filename('.git'))
245
self.assertFalse(controldir.is_control_filename('bla'))