1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
|
# Copyright 2009-2011 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
"""Tests for the safe branch open code."""
__metaclass__ = type
from bzrlib.branch import (
Branch,
BranchReferenceFormat,
BzrBranchFormat7,
)
from bzrlib.bzrdir import (
BzrDir,
BzrDirMetaFormat1,
BzrProber,
)
from bzrlib.controldir import ControlDirFormat
from bzrlib.errors import NotBranchError
from bzrlib.repofmt.knitpack_repo import RepositoryFormatKnitPack1
from bzrlib.tests import TestCaseWithTransport
from bzrlib.transport import chroot
from lazr.uri import URI
from lp.codehosting.safe_open import (
BadUrl,
BlacklistPolicy,
BranchLoopError,
BranchReferenceForbidden,
safe_open,
SafeBranchOpener,
WhitelistPolicy,
)
from lp.testing import TestCase
class TestSafeBranchOpenerCheckAndFollowBranchReference(TestCase):
"""Unit tests for `SafeBranchOpener.checkAndFollowBranchReference`."""
def setUp(self):
super(TestSafeBranchOpenerCheckAndFollowBranchReference, self).setUp()
SafeBranchOpener.install_hook()
class StubbedSafeBranchOpener(SafeBranchOpener):
"""SafeBranchOpener that provides canned answers.
We implement the methods we need to to be able to control all the
inputs to the `BranchMirrorer.checkSource` method, which is what is
being tested in this class.
"""
def __init__(self, references, policy):
parent_cls = TestSafeBranchOpenerCheckAndFollowBranchReference
super(parent_cls.StubbedSafeBranchOpener, self).__init__(policy)
self._reference_values = {}
for i in range(len(references) - 1):
self._reference_values[references[i]] = references[i + 1]
self.follow_reference_calls = []
def followReference(self, url):
self.follow_reference_calls.append(url)
return self._reference_values[url]
def makeBranchOpener(self, should_follow_references, references,
unsafe_urls=None):
policy = BlacklistPolicy(should_follow_references, unsafe_urls)
opener = self.StubbedSafeBranchOpener(references, policy)
return opener
def testCheckInitialURL(self):
# checkSource rejects all URLs that are not allowed.
opener = self.makeBranchOpener(None, [], set(['a']))
self.assertRaises(
BadUrl, opener.checkAndFollowBranchReference, 'a')
def testNotReference(self):
# When branch references are forbidden, checkAndFollowBranchReference
# does not raise on non-references.
opener = self.makeBranchOpener(False, ['a', None])
self.assertEquals(
'a', opener.checkAndFollowBranchReference('a'))
self.assertEquals(['a'], opener.follow_reference_calls)
def testBranchReferenceForbidden(self):
# checkAndFollowBranchReference raises BranchReferenceForbidden if
# branch references are forbidden and the source URL points to a
# branch reference.
opener = self.makeBranchOpener(False, ['a', 'b'])
self.assertRaises(
BranchReferenceForbidden,
opener.checkAndFollowBranchReference, 'a')
self.assertEquals(['a'], opener.follow_reference_calls)
def testAllowedReference(self):
# checkAndFollowBranchReference does not raise if following references
# is allowed and the source URL points to a branch reference to a
# permitted location.
opener = self.makeBranchOpener(True, ['a', 'b', None])
self.assertEquals(
'b', opener.checkAndFollowBranchReference('a'))
self.assertEquals(['a', 'b'], opener.follow_reference_calls)
def testCheckReferencedURLs(self):
# checkAndFollowBranchReference checks if the URL a reference points
# to is safe.
opener = self.makeBranchOpener(
True, ['a', 'b', None], unsafe_urls=set('b'))
self.assertRaises(
BadUrl, opener.checkAndFollowBranchReference, 'a')
self.assertEquals(['a'], opener.follow_reference_calls)
def testSelfReferencingBranch(self):
# checkAndFollowBranchReference raises BranchReferenceLoopError if
# following references is allowed and the source url points to a
# self-referencing branch reference.
opener = self.makeBranchOpener(True, ['a', 'a'])
self.assertRaises(
BranchLoopError, opener.checkAndFollowBranchReference, 'a')
self.assertEquals(['a'], opener.follow_reference_calls)
def testBranchReferenceLoop(self):
# checkAndFollowBranchReference raises BranchReferenceLoopError if
# following references is allowed and the source url points to a loop
# of branch references.
references = ['a', 'b', 'a']
opener = self.makeBranchOpener(True, references)
self.assertRaises(
BranchLoopError, opener.checkAndFollowBranchReference, 'a')
self.assertEquals(['a', 'b'], opener.follow_reference_calls)
class TrackingProber(BzrProber):
"""Subclass of BzrProber which tracks URLs it has been asked to open."""
seen_urls = []
@classmethod
def probe_transport(klass, transport):
klass.seen_urls.append(transport.base)
return BzrProber.probe_transport(transport)
class TestSafeBranchOpenerStacking(TestCaseWithTransport):
def setUp(self):
super(TestSafeBranchOpenerStacking, self).setUp()
SafeBranchOpener.install_hook()
def makeBranchOpener(self, allowed_urls, probers=None):
policy = WhitelistPolicy(True, allowed_urls, True)
return SafeBranchOpener(policy, probers)
def makeBranch(self, path, branch_format, repository_format):
"""Make a Bazaar branch at 'path' with the given formats."""
bzrdir_format = BzrDirMetaFormat1()
bzrdir_format.set_branch_format(branch_format)
bzrdir = self.make_bzrdir(path, format=bzrdir_format)
repository_format.initialize(bzrdir)
return bzrdir.create_branch()
def testProbers(self):
# Only the specified probers should be used
b = self.make_branch('branch')
opener = self.makeBranchOpener([b.base], probers=[])
self.assertRaises(NotBranchError, opener.open, b.base)
opener = self.makeBranchOpener([b.base], probers=[BzrProber])
self.assertEquals(b.base, opener.open(b.base).base)
def testDefaultProbers(self):
# If no probers are specified to the constructor
# of SafeBranchOpener, then a safe set will be used,
# rather than all probers registered in bzr.
self.addCleanup(ControlDirFormat.unregister_prober, TrackingProber)
ControlDirFormat.register_prober(TrackingProber)
# Open a location without any branches, so that all probers are
# tried.
# First, check that the TrackingProber tracks correctly.
TrackingProber.seen_urls = []
opener = self.makeBranchOpener(["."], probers=[TrackingProber])
self.assertRaises(NotBranchError, opener.open, ".")
self.assertEquals(1, len(TrackingProber.seen_urls))
TrackingProber.seen_urls = []
# And make sure it's registered in such a way that BzrDir.open would
# use it.
self.assertRaises(NotBranchError, BzrDir.open, ".")
self.assertEquals(1, len(TrackingProber.seen_urls))
TrackingProber.seen_urls = []
# Make sure that SafeBranchOpener doesn't use it if no
# probers were specified
opener = self.makeBranchOpener(["."])
self.assertRaises(NotBranchError, opener.open, ".")
self.assertEquals(0, len(TrackingProber.seen_urls))
def testAllowedURL(self):
# checkSource does not raise an exception for branches stacked on
# branches with allowed URLs.
stacked_on_branch = self.make_branch('base-branch', format='1.6')
stacked_branch = self.make_branch('stacked-branch', format='1.6')
stacked_branch.set_stacked_on_url(stacked_on_branch.base)
opener = self.makeBranchOpener(
[stacked_branch.base, stacked_on_branch.base])
# This doesn't raise an exception.
opener.open(stacked_branch.base)
def testUnstackableRepository(self):
# checkSource treats branches with UnstackableRepositoryFormats as
# being not stacked.
branch = self.makeBranch(
'unstacked', BzrBranchFormat7(), RepositoryFormatKnitPack1())
opener = self.makeBranchOpener([branch.base])
# This doesn't raise an exception.
opener.open(branch.base)
def testAllowedRelativeURL(self):
# checkSource passes on absolute urls to checkOneURL, even if the
# value of stacked_on_location in the config is set to a relative URL.
stacked_on_branch = self.make_branch('base-branch', format='1.6')
stacked_branch = self.make_branch('stacked-branch', format='1.6')
stacked_branch.set_stacked_on_url('../base-branch')
opener = self.makeBranchOpener(
[stacked_branch.base, stacked_on_branch.base])
# Note that stacked_on_branch.base is not '../base-branch', it's an
# absolute URL.
self.assertNotEqual('../base-branch', stacked_on_branch.base)
# This doesn't raise an exception.
opener.open(stacked_branch.base)
def testAllowedRelativeNested(self):
# Relative URLs are resolved relative to the stacked branch.
self.get_transport().mkdir('subdir')
a = self.make_branch('subdir/a', format='1.6')
b = self.make_branch('b', format='1.6')
b.set_stacked_on_url('../subdir/a')
c = self.make_branch('subdir/c', format='1.6')
c.set_stacked_on_url('../../b')
opener = self.makeBranchOpener([c.base, b.base, a.base])
# This doesn't raise an exception.
opener.open(c.base)
def testForbiddenURL(self):
# checkSource raises a BadUrl exception if a branch is stacked on a
# branch with a forbidden URL.
stacked_on_branch = self.make_branch('base-branch', format='1.6')
stacked_branch = self.make_branch('stacked-branch', format='1.6')
stacked_branch.set_stacked_on_url(stacked_on_branch.base)
opener = self.makeBranchOpener([stacked_branch.base])
self.assertRaises(BadUrl, opener.open, stacked_branch.base)
def testForbiddenURLNested(self):
# checkSource raises a BadUrl exception if a branch is stacked on a
# branch that is in turn stacked on a branch with a forbidden URL.
a = self.make_branch('a', format='1.6')
b = self.make_branch('b', format='1.6')
b.set_stacked_on_url(a.base)
c = self.make_branch('c', format='1.6')
c.set_stacked_on_url(b.base)
opener = self.makeBranchOpener([c.base, b.base])
self.assertRaises(BadUrl, opener.open, c.base)
def testSelfStackedBranch(self):
# checkSource raises StackingLoopError if a branch is stacked on
# itself. This avoids infinite recursion errors.
a = self.make_branch('a', format='1.6')
# Bazaar 1.17 and up make it harder to create branches like this.
# It's still worth testing that we don't blow up in the face of them,
# so we grovel around a bit to create one anyway.
a.get_config().set_user_option('stacked_on_location', a.base)
opener = self.makeBranchOpener([a.base])
self.assertRaises(BranchLoopError, opener.open, a.base)
def testLoopStackedBranch(self):
# checkSource raises StackingLoopError if a branch is stacked in such
# a way so that it is ultimately stacked on itself. e.g. a stacked on
# b stacked on a.
a = self.make_branch('a', format='1.6')
b = self.make_branch('b', format='1.6')
a.set_stacked_on_url(b.base)
b.set_stacked_on_url(a.base)
opener = self.makeBranchOpener([a.base, b.base])
self.assertRaises(BranchLoopError, opener.open, a.base)
self.assertRaises(BranchLoopError, opener.open, b.base)
def testCustomOpener(self):
# A custom function for opening a control dir can be specified.
a = self.make_branch('a', format='2a')
b = self.make_branch('b', format='2a')
b.set_stacked_on_url(a.base)
TrackingProber.seen_urls = []
opener = self.makeBranchOpener(
[a.base, b.base], probers=[TrackingProber])
opener.open(b.base)
self.assertEquals(
set(TrackingProber.seen_urls), set([b.base, a.base]))
def testCustomOpenerWithBranchReference(self):
# A custom function for opening a control dir can be specified.
a = self.make_branch('a', format='2a')
b_dir = self.make_bzrdir('b')
b = BranchReferenceFormat().initialize(b_dir, target_branch=a)
TrackingProber.seen_urls = []
opener = self.makeBranchOpener(
[a.base, b.base], probers=[TrackingProber])
opener.open(b.base)
self.assertEquals(
set(TrackingProber.seen_urls), set([b.base, a.base]))
class TestSafeOpen(TestCaseWithTransport):
"""Tests for `safe_open`."""
def setUp(self):
super(TestSafeOpen, self).setUp()
SafeBranchOpener.install_hook()
def test_hook_does_not_interfere(self):
# The transform_fallback_location hook does not interfere with regular
# stacked branch access outside of safe_open.
self.make_branch('stacked')
self.make_branch('stacked-on')
Branch.open('stacked').set_stacked_on_url('../stacked-on')
Branch.open('stacked')
def get_chrooted_scheme(self, relpath):
"""Create a server that is chrooted to `relpath`.
:return: ``(scheme, get_url)`` where ``scheme`` is the scheme of the
chroot server and ``get_url`` returns URLs on said server.
"""
transport = self.get_transport(relpath)
chroot_server = chroot.ChrootServer(transport)
chroot_server.start_server()
self.addCleanup(chroot_server.stop_server)
def get_url(relpath):
return chroot_server.get_url() + relpath
return URI(chroot_server.get_url()).scheme, get_url
def test_stacked_within_scheme(self):
# A branch that is stacked on a URL of the same scheme is safe to
# open.
self.get_transport().mkdir('inside')
self.make_branch('inside/stacked')
self.make_branch('inside/stacked-on')
scheme, get_chrooted_url = self.get_chrooted_scheme('inside')
Branch.open(get_chrooted_url('stacked')).set_stacked_on_url(
get_chrooted_url('stacked-on'))
safe_open(scheme, get_chrooted_url('stacked'))
def test_stacked_outside_scheme(self):
# A branch that is stacked on a URL that is not of the same scheme is
# not safe to open.
self.get_transport().mkdir('inside')
self.get_transport().mkdir('outside')
self.make_branch('inside/stacked')
self.make_branch('outside/stacked-on')
scheme, get_chrooted_url = self.get_chrooted_scheme('inside')
Branch.open(get_chrooted_url('stacked')).set_stacked_on_url(
self.get_url('outside/stacked-on'))
self.assertRaises(
BadUrl, safe_open, scheme, get_chrooted_url('stacked'))
|