~launchpad-pqm/launchpad/devel

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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
# Copyright 2009 Canonical Ltd.  This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).

"""In-memory doubles of core codehosting objects."""

__metaclass__ = type
__all__ = [
    'InMemoryFrontend',
    'XMLRPCWrapper',
    ]

import operator
from xmlrpclib import Fault

from bzrlib.urlutils import (
    escape,
    unescape,
    )
from twisted.internet import defer
from zope.component import (
    adapter,
    getSiteManager,
    )
from zope.interface import implementer

from canonical.database.constants import UTC_NOW
from canonical.launchpad.xmlrpc import faults
from lp.app.validators import LaunchpadValidationError
from lp.code.bzr import (
    BranchFormat,
    ControlFormat,
    RepositoryFormat,
    )
from lp.code.enums import BranchType
from lp.code.errors import UnknownBranchTypeError
from lp.code.interfaces.branch import IBranch
from lp.code.interfaces.branchtarget import IBranchTarget
from lp.code.interfaces.codehosting import (
    BRANCH_ALIAS_PREFIX,
    branch_id_alias,
    BRANCH_ID_ALIAS_PREFIX,
    BRANCH_TRANSPORT,
    CONTROL_TRANSPORT,
    LAUNCHPAD_ANONYMOUS,
    LAUNCHPAD_SERVICES,
    )
from lp.code.interfaces.linkedbranch import ICanHasLinkedBranch
from lp.code.model.branchnamespace import BranchNamespaceSet
from lp.code.model.branchtarget import (
    PackageBranchTarget,
    ProductBranchTarget,
    )
from lp.code.xmlrpc.codehosting import datetime_from_tuple
from lp.registry.interfaces.pocket import PackagePublishingPocket
from lp.services.utils import iter_split
from lp.services.xmlrpc import LaunchpadFault
from lp.testing.factory import ObjectFactory


class FakeStore:
    """Fake store that implements find well enough to pass tests.

    This is needed because some of the `test_codehosting` tests use
    assertSqlAttributeEqualsDate, which relies on ORM behaviour. Here, we fake
    enough of the ORM to pass the tests.
    """

    def __init__(self, object_set):
        self._object_set = object_set

    def find(self, cls, **kwargs):
        """Implement Store.find that takes two attributes: id and one other.

        This is called by `assertSqlAttributeEqualsDate`, which relies on
        `find` returning either a single match or None. Returning a match
        implies that the given attribute has the expected value. Returning
        None implies the opposite.
        """
        branch_id = kwargs.pop('id')
        assert len(kwargs) == 1, (
            'Expected only id and one other. Got %r' % kwargs)
        attribute = kwargs.keys()[0]
        expected_value = kwargs[attribute]
        branch = self._object_set.get(branch_id)
        if branch is None:
            return FakeResult(None)
        if expected_value is getattr(branch, attribute):
            return FakeResult(branch)
        return None


class FakeResult:
    """As with FakeStore, just enough of a result to pass tests."""

    def __init__(self, branch):
        self._branch = branch

    def one(self):
        return self._branch


class FakeDatabaseObject:
    """Base class for fake database objects."""

    def _set_object_set(self, object_set):
        self.__storm_object_info__ = {'store': FakeStore(object_set)}


class ObjectSet:
    """Generic set of database objects."""

    def __init__(self):
        self._objects = {}
        self._next_id = 1

    def _add(self, db_object):
        self._objects[self._next_id] = db_object
        db_object.id = self._next_id
        self._next_id += 1
        db_object._set_object_set(self)
        return db_object

    def _delete(self, db_object):
        del self._objects[db_object.id]

    def __iter__(self):
        return self._objects.itervalues()

    def _find(self, **kwargs):
        [(key, value)] = kwargs.items()
        for obj in self:
            if getattr(obj, key) == value:
                return obj

    def get(self, id):
        return self._objects.get(id, None)

    def getByName(self, name):
        return self._find(name=name)


class BranchSet(ObjectSet):
    """Extra find methods for branches."""

    def getByUniqueName(self, unique_name):
        return self._find(unique_name=unique_name)


class FakeSourcePackage:
    """Fake ISourcePackage."""

    def __init__(self, sourcepackagename, distroseries):
        self.sourcepackagename = sourcepackagename
        self.distroseries = distroseries

    def __hash__(self):
        return hash((self.sourcepackagename.id, self.distroseries.id))

    def __eq__(self, other):
        return (self.sourcepackagename.id == other.sourcepackagename.id
                and self.distroseries.id == other.distroseries.id)

    def __ne__(self, other):
        return not (self == other)

    @property
    def distribution(self):
        if self.distroseries is not None:
            return self.distroseries.distribution
        else:
            return None

    @property
    def development_version(self):
        name = '%s-devel' % self.distribution.name
        dev_series = self._distroseries_set.getByName(name)
        if dev_series is None:
            dev_series = FakeDistroSeries(name, self.distribution)
            self._distroseries_set._add(dev_series)
        return self.__class__(self.sourcepackagename, dev_series)

    @property
    def path(self):
        return '%s/%s/%s' % (
            self.distribution.name,
            self.distroseries.name,
            self.sourcepackagename.name)

    def getBranch(self, pocket):
        return self.distroseries._linked_branches.get(
            (self, pocket), None)

    def setBranch(self, pocket, branch, registrant):
        self.distroseries._linked_branches[self, pocket] = branch


@adapter(FakeSourcePackage)
@implementer(IBranchTarget)
def fake_source_package_to_branch_target(fake_package):
    return PackageBranchTarget(fake_package)


class FakeBranch(FakeDatabaseObject):
    """Fake branch object."""

    def __init__(self, branch_type, name, owner, url=None, product=None,
                 stacked_on=None, private=False, registrant=None,
                 distroseries=None, sourcepackagename=None):
        self.branch_type = branch_type
        self.last_mirror_attempt = None
        self.last_mirrored = None
        self.last_mirrored_id = None
        self.next_mirror_time = None
        self.url = url
        self.mirror_failures = 0
        self.name = name
        self.owner = owner
        self.stacked_on = None
        self.mirror_status_message = None
        self.stacked_on = stacked_on
        self.private = private
        self.product = product
        self.registrant = registrant
        self._mirrored = False
        self.distroseries = distroseries
        self.sourcepackagename = sourcepackagename

    @property
    def unique_name(self):
        if self.product is None:
            if self.distroseries is None:
                product = '+junk'
            else:
                product = '%s/%s/%s' % (
                    self.distroseries.distribution.name,
                    self.distroseries.name,
                    self.sourcepackagename.name)
        else:
            product = self.product.name
        return '~%s/%s/%s' % (self.owner.name, product, self.name)

    def getPullURL(self):
        return 'lp-fake:///' + self.unique_name

    @property
    def target(self):
        if self.product is None:
            if self.distroseries is None:
                target = self.owner
            else:
                target = self.sourcepackage
        else:
            target = self.product
        return IBranchTarget(target)

    def requestMirror(self):
        self.next_mirror_time = UTC_NOW


class FakePerson(FakeDatabaseObject):
    """Fake person object."""

    def __init__(self, name):
        self.name = self.displayname = name

    def isTeam(self):
        return False

    def inTeam(self, person_or_team):
        if self is person_or_team:
            return True
        if not person_or_team.isTeam():
            return False
        return self in person_or_team._members


class FakeTeam(FakePerson):
    """Fake team."""

    def __init__(self, name, members=None):
        super(FakeTeam, self).__init__(name)
        if members is None:
            self._members = []
        else:
            self._members = list(members)

    def isTeam(self):
        return True


class FakeProduct(FakeDatabaseObject):
    """Fake product."""

    def __init__(self, name, owner):
        self.name = name
        self.owner = owner
        self.bzr_path = name
        self.development_focus = FakeProductSeries(self, 'trunk')
        self.series = {
            'trunk': self.development_focus,
            }

    def getSeries(self, name):
        return self.series.get(name, None)


@adapter(FakeProduct)
@implementer(IBranchTarget)
def fake_product_to_branch_target(fake_product):
    """Adapt a `FakeProduct` to `IBranchTarget`."""
    return ProductBranchTarget(fake_product)


@adapter(FakeProduct)
@implementer(ICanHasLinkedBranch)
def fake_product_to_can_has_linked_branch(fake_product):
    """Adapt a `FakeProduct` to `ICanHasLinkedBranch`."""
    return fake_product.development_focus


class FakeProductSeries(FakeDatabaseObject):
    """Fake product series."""

    branch = None

    def __init__(self, product, name):
        self.product = product
        self.name = name

    @property
    def bzr_path(self):
        if self.product.development_focus is self:
            return self.product.name
        else:
            return "%s/%s" % (self.product.name, self.name)


@adapter(FakeProductSeries)
@implementer(ICanHasLinkedBranch)
def fake_productseries_to_can_has_linked_branch(fake_productseries):
    """Adapt a `FakeProductSeries` to `ICanHasLinkedBranch`."""
    return fake_productseries


class FakeScriptActivity(FakeDatabaseObject):
    """Fake script activity."""

    def __init__(self, name, hostname, date_started, date_completed):
        self.id = self.name = name
        self.hostname = hostname
        self.date_started = datetime_from_tuple(date_started)
        self.date_completed = datetime_from_tuple(date_completed)


class FakeDistribution(FakeDatabaseObject):

    def __init__(self, name):
        self.name = name


class FakeDistroSeries(FakeDatabaseObject):
    """Fake distroseries."""

    def __init__(self, name, distribution):
        self.name = name
        self.distribution = distribution
        self._linked_branches = {}


class FakeSourcePackageName(FakeDatabaseObject):
    """Fake SourcePackageName."""

    def __init__(self, name):
        self.name = name


DEFAULT_PRODUCT = object()


class FakeObjectFactory(ObjectFactory):

    def __init__(self, branch_set, person_set, product_set, distribution_set,
                 distroseries_set, sourcepackagename_set):
        super(FakeObjectFactory, self).__init__()
        self._branch_set = branch_set
        self._person_set = person_set
        self._product_set = product_set
        self._distribution_set = distribution_set
        self._distroseries_set = distroseries_set
        self._sourcepackagename_set = sourcepackagename_set

    def makeBranch(self, branch_type=None, stacked_on=None, private=False,
                   product=DEFAULT_PRODUCT, owner=None, name=None,
                   registrant=None, sourcepackage=None):
        if branch_type is None:
            branch_type = BranchType.HOSTED
        if branch_type == BranchType.MIRRORED:
            url = self.getUniqueURL()
        else:
            url = None
        if name is None:
            name = self.getUniqueString()
        if owner is None:
            owner = self.makePerson()
        if product is DEFAULT_PRODUCT:
            product = self.makeProduct()
        if registrant is None:
            registrant = self.makePerson()
        if sourcepackage is None:
            sourcepackagename = None
            distroseries = None
        else:
            sourcepackagename = sourcepackage.sourcepackagename
            distroseries = sourcepackage.distroseries
        IBranch['name'].validate(unicode(name))
        branch = FakeBranch(
            branch_type, name=name, owner=owner, url=url,
            stacked_on=stacked_on, product=product, private=private,
            registrant=registrant, distroseries=distroseries,
            sourcepackagename=sourcepackagename)
        self._branch_set._add(branch)
        return branch

    def makeAnyBranch(self, **kwargs):
        return self.makeProductBranch(**kwargs)

    def makePackageBranch(self, sourcepackage=None, **kwargs):
        if sourcepackage is None:
            sourcepackage = self.makeSourcePackage()
        return self.makeBranch(
            product=None, sourcepackage=sourcepackage, **kwargs)

    def makePersonalBranch(self, owner=None, **kwargs):
        if owner is None:
            owner = self.makePerson()
        return self.makeBranch(
            owner=owner, product=None, sourcepackage=None, **kwargs)

    def makeProductBranch(self, product=None, **kwargs):
        if product is None:
            product = self.makeProduct()
        return self.makeBranch(product=product, sourcepackage=None, **kwargs)

    def makeDistribution(self):
        distro = FakeDistribution(self.getUniqueString())
        self._distribution_set._add(distro)
        return distro

    def makeDistroRelease(self):
        distro = self.makeDistribution()
        distroseries_name = self.getUniqueString()
        distroseries = FakeDistroSeries(distroseries_name, distro)
        self._distroseries_set._add(distroseries)
        return distroseries

    makeDistroSeries = makeDistroRelease

    def makeSourcePackageName(self):
        sourcepackagename = FakeSourcePackageName(self.getUniqueString())
        self._sourcepackagename_set._add(sourcepackagename)
        return sourcepackagename

    def makeSourcePackage(self, distroseries=None, sourcepackagename=None):
        if distroseries is None:
            distroseries = self.makeDistroRelease()
        if sourcepackagename is None:
            sourcepackagename = self.makeSourcePackageName()
        package = FakeSourcePackage(sourcepackagename, distroseries)
        package._distroseries_set = self._distroseries_set
        return package

    def makeTeam(self, owner):
        team = FakeTeam(name=self.getUniqueString(), members=[owner])
        self._person_set._add(team)
        return team

    def makePerson(self, name=None):
        if name is None:
            name = self.getUniqueString()
        person = FakePerson(name=name)
        self._person_set._add(person)
        return person

    def makeProduct(self, name=None, owner=None):
        if name is None:
            name = self.getUniqueString()
        if owner is None:
            owner = self.makePerson()
        product = FakeProduct(name, owner)
        self._product_set._add(product)
        return product

    def makeProductSeries(self, product, name=None):
        if name is None:
            name = self.getUniqueString()
        series = FakeProductSeries(product, name)
        product.series[name] = series
        return series

    def enableDefaultStackingForProduct(self, product, branch=None):
        """Give 'product' a default stacked-on branch.

        :param product: The product to give a default stacked-on branch to.
        :param branch: The branch that should be the default stacked-on
            branch.  If not supplied, a fresh branch will be created.
        """
        if branch is None:
            branch = self.makeBranch(product=product)
        product.development_focus.branch = branch
        branch.last_mirrored_id = 'rev1'
        return branch

    def enableDefaultStackingForPackage(self, package, branch):
        """Give 'package' a default stacked-on branch.

        :param package: The package to give a default stacked-on branch to.
        :param branch: The branch that should be the default stacked-on
            branch.
        """
        package.development_version.setBranch(
            PackagePublishingPocket.RELEASE, branch, branch.owner)
        branch.last_mirrored_id = 'rev1'
        return branch


class FakeCodehosting:

    def __init__(self, branch_set, person_set, product_set, distribution_set,
                 distroseries_set, sourcepackagename_set, factory,
                 script_activity_set):
        self._branch_set = branch_set
        self._person_set = person_set
        self._product_set = product_set
        self._distribution_set = distribution_set
        self._distroseries_set = distroseries_set
        self._sourcepackagename_set = sourcepackagename_set
        self._factory = factory
        self._script_activity_set = script_activity_set

    def acquireBranchToPull(self, branch_type_names):
        if not branch_type_names:
            branch_type_names = 'HOSTED', 'MIRRORED', 'IMPORTED'
        branch_types = []
        for branch_type_name in branch_type_names:
            try:
                branch_types.append(BranchType.items[branch_type_name])
            except KeyError:
                raise UnknownBranchTypeError(
                    'Unknown branch type: %r' % (branch_type_name,))
        branches = sorted(
            [branch for branch in self._branch_set
             if branch.next_mirror_time is not None
             and branch.branch_type in branch_types],
            key=operator.attrgetter('next_mirror_time'))
        if branches:
            branch = branches[-1]
            # Mark it as started mirroring.
            branch.last_mirror_attempt = UTC_NOW
            branch.next_mirror_time = None
            default_branch = branch.target.default_stacked_on_branch
            if default_branch is None:
                default_branch_name = ''
            elif (branch.branch_type == BranchType.MIRRORED
                  and default_branch.private):
                default_branch_name = ''
            else:
                default_branch_name = '/' + default_branch.unique_name
            return (branch.id, branch.getPullURL(), branch.unique_name,
                    default_branch_name, branch.branch_type.name)
        else:
            return ()

    def mirrorFailed(self, branch_id, reason):
        branch = self._branch_set.get(branch_id)
        if branch is None:
            return faults.NoBranchWithID(branch_id)
        branch.mirror_failures += 1
        branch.mirror_status_message = reason
        return True

    def recordSuccess(self, name, hostname, date_started, date_completed):
        self._script_activity_set._add(
            FakeScriptActivity(name, hostname, date_started, date_completed))
        return True

    def _parseUniqueName(self, branch_path):
        """Return a dict of the parsed information and the branch name."""
        try:
            namespace_path, branch_name = branch_path.rsplit('/', 1)
        except ValueError:
            raise faults.PermissionDenied(
                "Cannot create branch at '/%s'" % branch_path)
        data = BranchNamespaceSet().parse(namespace_path)
        return data, branch_name

    def _createBranch(self, registrant, branch_path):
        """The guts of the create branch method.

        Raises exceptions on error conditions.
        """
        to_link = None
        if branch_path.startswith(BRANCH_ALIAS_PREFIX + '/'):
            branch_path = branch_path[len(BRANCH_ALIAS_PREFIX) + 1:]
            if branch_path.startswith('~'):
                data, branch_name = self._parseUniqueName(branch_path)
            else:
                tokens = branch_path.split('/')
                data = {
                    'person': registrant.name,
                    'product': tokens[0],
                    }
                branch_name = 'trunk'
                # check the series
                product = self._product_set.getByName(data['product'])
                if product is not None:
                    if len(tokens) > 1:
                        series = product.getSeries(tokens[1])
                        if series is None:
                            raise faults.NotFound(
                                "No such product series: '%s'." % tokens[1])
                        else:
                            to_link = ICanHasLinkedBranch(series)
                    else:
                        to_link = ICanHasLinkedBranch(product)
                # don't forget the link.
        else:
            data, branch_name = self._parseUniqueName(branch_path)

        owner = self._person_set.getByName(data['person'])
        if owner is None:
            raise faults.NotFound(
                "User/team '%s' does not exist." % (data['person'],))
        # The real code consults the branch creation policy of the product. We
        # don't need to do so here, since the tests above this layer never
        # encounter that behaviour. If they *do* change to rely on the branch
        # creation policy, the observed behaviour will be failure to raise
        # exceptions.
        if not registrant.inTeam(owner):
            raise faults.PermissionDenied(
                ('%s cannot create branches owned by %s'
                 % (registrant.displayname, owner.displayname)))
        product = sourcepackage = None
        if data['product'] == '+junk':
            product = None
        elif data['product'] is not None:
            product = self._product_set.getByName(data['product'])
            if product is None:
                raise faults.NotFound(
                    "Project '%s' does not exist." % (data['product'],))
        elif data['distribution'] is not None:
            distro = self._distribution_set.getByName(data['distribution'])
            if distro is None:
                raise faults.NotFound(
                    "No such distribution: '%s'." % (data['distribution'],))
            distroseries = self._distroseries_set.getByName(
                data['distroseries'])
            if distroseries is None:
                raise faults.NotFound(
                    "No such distribution series: '%s'."
                    % (data['distroseries'],))
            sourcepackagename = self._sourcepackagename_set.getByName(
                data['sourcepackagename'])
            if sourcepackagename is None:
                raise faults.NotFound(
                    "No such source package: '%s'."
                    % (data['sourcepackagename'],))
            sourcepackage = self._factory.makeSourcePackage(
                distroseries, sourcepackagename)
        else:
            raise faults.PermissionDenied(
                "Cannot create branch at '%s'" % branch_path)
        branch = self._factory.makeBranch(
            owner=owner, name=branch_name, product=product,
            sourcepackage=sourcepackage, registrant=registrant,
            branch_type=BranchType.HOSTED)
        if to_link is not None:
            if registrant.inTeam(to_link.product.owner):
                to_link.branch = branch
            else:
                self._branch_set._delete(branch)
                raise faults.PermissionDenied(
                    "Cannot create linked branch at '%s'." % branch_path)
        return branch.id

    def createBranch(self, requester_id, branch_path):
        if not branch_path.startswith('/'):
            return faults.InvalidPath(branch_path)
        escaped_path = unescape(branch_path.strip('/'))
        registrant = self._person_set.get(requester_id)
        try:
            return self._createBranch(registrant, escaped_path)
        except LaunchpadFault, e:
            return e
        except LaunchpadValidationError, e:
            msg = e.args[0]
            if isinstance(msg, unicode):
                msg = msg.encode('utf-8')
            return faults.PermissionDenied(msg)

    def requestMirror(self, requester_id, branch_id):
        self._branch_set.get(branch_id).requestMirror()

    def branchChanged(self, login_id, branch_id, stacked_on_location,
                      last_revision_id, control_string, branch_string,
                      repository_string):
        branch = self._branch_set._find(id=branch_id)
        if branch is None:
            return faults.NoBranchWithID(branch_id)
        branch.mirror_status_message = None
        if stacked_on_location == '':
            stacked_on_branch = None
        else:
            # We could log or something if the branch is not found here, but
            # we just wait until the scanner fails and sets up an appropriate
            # message.
            stacked_on_branch = self._branch_set._find(
                unique_name=stacked_on_location.strip('/'))
            if stacked_on_branch is None:
                branch.mirror_status_message = (
                    'Invalid stacked on location: ' + stacked_on_location)
        branch.stacked_on = stacked_on_branch
        branch.last_mirrored = UTC_NOW
        if branch.last_mirrored_id != last_revision_id:
            branch.last_mirrored_id = last_revision_id

        def match_title(enum, title, default):
            for value in enum.items:
                if value.title == title:
                    return value
            else:
                return default

        branch.control_format = match_title(
            ControlFormat, control_string, ControlFormat.UNRECOGNIZED)
        branch.branch_format = match_title(
            BranchFormat, branch_string, BranchFormat.UNRECOGNIZED)
        branch.repository_format = match_title(
            RepositoryFormat, repository_string,
            RepositoryFormat.UNRECOGNIZED)

        return True

    def _canRead(self, person_id, branch):
        """Can the person 'person_id' see 'branch'?"""
        # This is a substitute for an actual launchpad.View check on the
        # branch. It doesn't have to match the behaviour exactly, as long as
        # it's stricter than the real implementation (that way, mismatches in
        # behaviour should generate explicit errors.)
        if person_id == LAUNCHPAD_SERVICES:
            return True
        if person_id == LAUNCHPAD_ANONYMOUS:
            return not branch.private
        if not branch.private:
            return True
        person = self._person_set.get(person_id)
        return person.inTeam(branch.owner)

    def _canWrite(self, person_id, branch):
        """Can the person 'person_id' write to 'branch'?"""
        if person_id in [LAUNCHPAD_ANONYMOUS, LAUNCHPAD_SERVICES]:
            return False
        if branch.branch_type != BranchType.HOSTED:
            return False
        person = self._person_set.get(person_id)
        return person.inTeam(branch.owner)

    def _get_product_target(self, path):
        try:
            owner_name, product_name = path.split('/')
        except ValueError:
            # Wrong number of segments -- can't be a product.
            return
        product = self._product_set.getByName(product_name)
        return product

    def _get_package_target(self, path):
        try:
            owner_name, distro_name, series_name, package_name = (
                path.split('/'))
        except ValueError:
            # Wrong number of segments -- can't be a package.
            return
        distro = self._distribution_set.getByName(distro_name)
        distroseries = self._distroseries_set.getByName(series_name)
        sourcepackagename = self._sourcepackagename_set.getByName(
            package_name)
        if None in (distro, distroseries, sourcepackagename):
            return
        return self._factory.makeSourcePackage(
            distroseries, sourcepackagename)

    def _serializeControlDirectory(self, requester, product_path,
                                   trailing_path):
        if not ('.bzr' == trailing_path or trailing_path.startswith('.bzr/')):
            return
        target = self._get_product_target(product_path)
        if target is None:
            target = self._get_package_target(product_path)
        if target is None:
            return
        default_branch = IBranchTarget(target).default_stacked_on_branch
        if default_branch is None:
            return
        if not self._canRead(requester, default_branch):
            return
        path = branch_id_alias(default_branch)
        return (
            CONTROL_TRANSPORT,
            {'default_stack_on': escape(path)},
            trailing_path)

    def _serializeBranch(self, requester_id, branch, trailing_path,
                         force_readonly=False):
        if not self._canRead(requester_id, branch):
            return faults.PermissionDenied()
        elif branch.branch_type == BranchType.REMOTE:
            return None
        if force_readonly:
            writable = False
        else:
            writable = self._canWrite(requester_id, branch)
        return (
            BRANCH_TRANSPORT,
            {'id': branch.id, 'writable': writable},
            trailing_path)

    def _translateBranchIdAlias(self, requester, path):
        # If the path isn't a branch id alias, nothing more to do.
        stripped_path = unescape(path.strip('/'))
        if not stripped_path.startswith(BRANCH_ID_ALIAS_PREFIX + '/'):
            return None
        try:
            parts = stripped_path.split('/', 2)
            branch_id = int(parts[1])
        except (ValueError, IndexError):
            return faults.PathTranslationError(path)
        branch = self._branch_set.get(branch_id)
        if branch is None:
            return faults.PathTranslationError(path)
        try:
            trailing = parts[2]
        except IndexError:
            trailing = ''
        return self._serializeBranch(requester, branch, trailing, True)

    def translatePath(self, requester_id, path):
        if not path.startswith('/'):
            return faults.InvalidPath(path)
        branch = self._translateBranchIdAlias(requester_id, path)
        if branch is not None:
            return branch
        stripped_path = path.strip('/')
        for first, second in iter_split(stripped_path, '/'):
            first = unescape(first).encode('utf-8')
            # Is it a branch?
            if first.startswith('+branch/'):
                component_name = first[len('+branch/'):]
                product = self._product_set.getByName(component_name)
                if product:
                    branch = product.development_focus.branch
                else:
                    branch = self._branch_set._find(unique_name=component_name)
            else:
                branch = self._branch_set._find(unique_name=first)
            if branch is not None:
                branch = self._serializeBranch(requester_id, branch, second)
                if isinstance(branch, Fault):
                    return branch
                elif branch is None:
                    break
                return branch

            # Is it a product?
            product = self._serializeControlDirectory(
                requester_id, first, second)
            if product:
                return product
        return faults.PathTranslationError(path)


class InMemoryFrontend:
    """A in-memory 'frontend' to Launchpad's branch services.

    This is an in-memory version of `LaunchpadDatabaseFrontend`.
    """

    def __init__(self):
        self._branch_set = BranchSet()
        self._script_activity_set = ObjectSet()
        self._person_set = ObjectSet()
        self._product_set = ObjectSet()
        self._distribution_set = ObjectSet()
        self._distroseries_set = ObjectSet()
        self._sourcepackagename_set = ObjectSet()
        self._factory = FakeObjectFactory(
            self._branch_set, self._person_set, self._product_set,
            self._distribution_set, self._distroseries_set,
            self._sourcepackagename_set)
        self._codehosting = FakeCodehosting(
            self._branch_set, self._person_set, self._product_set,
            self._distribution_set, self._distroseries_set,
            self._sourcepackagename_set, self._factory,
            self._script_activity_set)
        sm = getSiteManager()
        sm.registerAdapter(fake_product_to_can_has_linked_branch)
        sm.registerAdapter(fake_product_to_branch_target)
        sm.registerAdapter(fake_source_package_to_branch_target)
        sm.registerAdapter(fake_productseries_to_can_has_linked_branch)

    def getCodehostingEndpoint(self):
        """See `LaunchpadDatabaseFrontend`.

        Return an in-memory implementation of IBranchFileSystem that passes
        the tests in `test_codehosting`.
        """
        return self._codehosting

    def getLaunchpadObjectFactory(self):
        """See `LaunchpadDatabaseFrontend`.

        Returns a partial, in-memory implementation of LaunchpadObjectFactory
        -- enough to pass the tests.
        """
        return self._factory

    def getBranchLookup(self):
        """See `LaunchpadDatabaseFrontend`.

        Returns a partial implementation of `IBranchLookup` -- enough to pass
        the tests.
        """
        return self._branch_set

    def getLastActivity(self, activity_name):
        """Get the last script activity with 'activity_name'."""
        return self._script_activity_set.getByName(activity_name)


class XMLRPCWrapper:
    """Wrapper around the endpoints that emulates an XMLRPC client."""

    def __init__(self, endpoint):
        self.endpoint = endpoint

    def _callRemote(self, method_name, *args):
        result = getattr(self.endpoint, method_name)(*args)
        if isinstance(result, Fault):
            raise result
        return result

    def callRemote(self, method_name, *args):
        return defer.maybeDeferred(self._callRemote, method_name, *args)