aboutsummaryrefslogtreecommitdiffstats
path: root/libbe/bugdir.py
blob: d485f5dbb15f801200c6dbac76025df0e9043ac6 (plain) (blame)
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
953
954
955
956
# Copyright (C) 2005-2012 Aaron Bentley <abentley@panoramicfeedback.com>
#                         Alexander Belchenko <bialix@ukr.net>
#                         Chris Ball <cjb@laptop.org>
#                         Gianluca Montecchi <gian@grys.it>
#                         Oleg Romanyshyn <oromanyshyn@panoramicfeedback.com>
#                         W. Trevor King <wking@tremily.us>
#
# This file is part of Bugs Everywhere.
#
# Bugs Everywhere is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 2 of the License, or (at your option) any
# later version.
#
# Bugs Everywhere is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
# more details.
#
# You should have received a copy of the GNU General Public License along with
# Bugs Everywhere.  If not, see <http://www.gnu.org/licenses/>.

"""Define the :class:`BugDir` class for storing a collection of bugs.
"""

import copy
import errno
import os
import os.path
import time
import types
try: # import core module, Python >= 2.5
    from xml.etree import ElementTree
except ImportError: # look for non-core module
    from elementtree import ElementTree
import xml.sax.saxutils

import libbe
import libbe.storage as storage
from libbe.storage.util.properties import Property, doc_property, \
    local_property, defaulting_property, checked_property, \
    fn_checked_property, cached_property, primed_property, \
    change_hook_property, settings_property
import libbe.storage.util.settings_object as settings_object
import libbe.storage.util.mapfile as mapfile
import libbe.bug as bug
import libbe.util.utility as utility
import libbe.util.id

if libbe.TESTING == True:
    import doctest
    import sys
    import unittest

    import libbe.storage.base


class NoBugMatches(libbe.util.id.NoIDMatches):
    def __init__(self, *args, **kwargs):
        libbe.util.id.NoIDMatches.__init__(self, *args, **kwargs)
    def __str__(self):
        if self.msg == None:
            return 'No bug matches %s' % self.id
        return self.msg


class BugDir (list, settings_object.SavedSettingsObject):
    """A BugDir is a container for :class:`~libbe.bug.Bug`\s, with some
    additional attributes.

    Parameters
    ----------
    storage : :class:`~libbe.storage.base.Storage`
       Storage instance containing the bug directory.  If
       `from_storage` is `False`, `storage` may be `None`.
    uuid : str, optional
       Set the bugdir UUID (see :mod:`libbe.util.id`).
       Useful if you are loading one of several bugdirs
       stored in a single Storage instance.
    from_storage : bool, optional
       If `True`, attempt to load from storage.  Otherwise,
       setup in memory, saving to `storage` if it is not `None`.

    See Also
    --------
    :class:`SimpleBugDir` for some bugdir manipulation exampes.
    """

    settings_properties = []
    required_saved_properties = []
    _prop_save_settings = settings_object.prop_save_settings
    _prop_load_settings = settings_object.prop_load_settings
    def _versioned_property(settings_properties=settings_properties,
                            required_saved_properties=required_saved_properties,
                            **kwargs):
        if "settings_properties" not in kwargs:
            kwargs["settings_properties"] = settings_properties
        if "required_saved_properties" not in kwargs:
            kwargs["required_saved_properties"]=required_saved_properties
        return settings_object.versioned_property(**kwargs)

    @_versioned_property(name="target",
                         doc="The current project development target.")
    def target(): return {}

    def _setup_severities(self, severities):
        if severities not in [None, settings_object.EMPTY]:
            bug.load_severities(severities)
    def _set_severities(self, old_severities, new_severities):
        self._setup_severities(new_severities)
        self._prop_save_settings(old_severities, new_severities)
    @_versioned_property(name="severities",
                         doc="The allowed bug severities and their descriptions.",
                         change_hook=_set_severities)
    def severities(): return {}

    def _setup_status(self, active_status, inactive_status):
        bug.load_status(active_status, inactive_status)
    def _set_active_status(self, old_active_status, new_active_status):
        self._setup_status(new_active_status, self.inactive_status)
        self._prop_save_settings(old_active_status, new_active_status)
    @_versioned_property(name="active_status",
                         doc="The allowed active bug states and their descriptions.",
                         change_hook=_set_active_status)
    def active_status(): return {}

    def _set_inactive_status(self, old_inactive_status, new_inactive_status):
        self._setup_status(self.active_status, new_inactive_status)
        self._prop_save_settings(old_inactive_status, new_inactive_status)
    @_versioned_property(name="inactive_status",
                         doc="The allowed inactive bug states and their descriptions.",
                         change_hook=_set_inactive_status)
    def inactive_status(): return {}

    def _extra_strings_check_fn(value):
        return utility.iterable_full_of_strings(value, \
                         alternative=settings_object.EMPTY)
    def _extra_strings_change_hook(self, old, new):
        self.extra_strings.sort() # to make merging easier
        self._prop_save_settings(old, new)
    @_versioned_property(name="extra_strings",
                         doc="Space for an array of extra strings.  Useful for storing state for functionality implemented purely in becommands/<some_function>.py.",
                         default=[],
                         check_fn=_extra_strings_check_fn,
                         change_hook=_extra_strings_change_hook,
                         mutable=True)
    def extra_strings(): return {}

    def _bug_map_gen(self):
        map = {}
        for bug in self:
            map[bug.uuid] = bug
        for uuid in self.uuids():
            if uuid not in map:
                map[uuid] = None
        self._bug_map_value = map # ._bug_map_value used by @local_property

    @Property
    @primed_property(primer=_bug_map_gen)
    @local_property("bug_map")
    @doc_property(doc="A dict of (bug-uuid, bug-instance) pairs.")
    def _bug_map(): return {}

    def __init__(self, storage, uuid=None, from_storage=False):
        list.__init__(self)
        settings_object.SavedSettingsObject.__init__(self)
        self.storage = storage
        self.id = libbe.util.id.ID(self, 'bugdir')
        self.uuid = uuid
        if from_storage == True:
            if self.uuid == None:
                self.uuid = [c for c in self.storage.children()
                             if c != 'version'][0]
            self.load_settings()
        else:
            if self.uuid == None:
                self.uuid = libbe.util.id.uuid_gen()
            if self.storage != None and self.storage.is_writeable():
                self.save()

    # methods for saving/loading/accessing settings and properties.

    def load_settings(self, settings_mapfile=None):
        if settings_mapfile == None:
            settings_mapfile = \
                self.storage.get(self.id.storage('settings'), default='\n')
        try:
            settings = mapfile.parse(settings_mapfile)
        except mapfile.InvalidMapfileContents, e:
            raise Exception('Invalid settings file for bugdir %s\n'
                            '(BE version missmatch?)' % self.id.user())
        self._setup_saved_settings(settings)
        self._setup_severities(self.severities)
        self._setup_status(self.active_status, self.inactive_status)

    def save_settings(self):
        mf = mapfile.generate(self._get_saved_settings())
        self.storage.set(self.id.storage('settings'), mf)

    def load_all_bugs(self):
        """
        Warning: this could take a while.
        """
        self._clear_bugs()
        for uuid in self.uuids():
            self._load_bug(uuid)

    def save(self):
        """
        Save any loaded contents to storage.  Because of lazy loading
        of bugs and comments, this is actually not too inefficient.

        However, if self.storage.is_writeable() == True, then any
        changes are automatically written to storage as soon as they
        happen, so calling this method will just waste time (unless
        something else has been messing with your stored files).
        """
        self.storage.add(self.id.storage(), directory=True)
        self.storage.add(self.id.storage('settings'), parent=self.id.storage(),
                         directory=False)
        self.save_settings()
        for bug in self:
            bug.bugdir = self
            bug.storage = self.storage
            bug.save()

    # methods for managing bugs

    def uuids(self, use_cached_disk_uuids=True):
        if use_cached_disk_uuids==False or not hasattr(self, '_uuids_cache'):
            self._refresh_uuid_cache()
        self._uuids_cache = self._uuids_cache.union([bug.uuid for bug in self])
        return self._uuids_cache

    def _refresh_uuid_cache(self):
        self._uuids_cache = set()
        # list bugs that are in storage
        if self.storage != None and self.storage.is_readable():
            child_uuids = libbe.util.id.child_uuids(
                self.storage.children(self.id.storage()))
            for id in child_uuids:
                self._uuids_cache.add(id)

    def _clear_bugs(self):
        while len(self) > 0:
            self.pop()
        if hasattr(self, '_uuids_cache'):
            del(self._uuids_cache)
        self._bug_map_gen()

    def _load_bug(self, uuid):
        bg = bug.Bug(bugdir=self, uuid=uuid, from_storage=True)
        self.append(bg)
        self._bug_map_gen()
        return bg

    def new_bug(self, summary=None, _uuid=None):
        bg = bug.Bug(bugdir=self, uuid=_uuid, summary=summary,
                     from_storage=False)
        self.append(bg, update=True)
        return bg

    def append(self, bug, update=False):
        super(BugDir, self).append(bug)
        if update:
            bug.bugdir = self
            bug.storage = self.storage
            self._bug_map_gen()
            if (hasattr(self, '_uuids_cache') and
                not bug.uuid in self._uuids_cache):
                self._uuids_cache.add(bug.uuid)

    def remove_bug(self, bug):
        if hasattr(self, '_uuids_cache') and bug.uuid in self._uuids_cache:
            self._uuids_cache.remove(bug.uuid)
        self.remove(bug)
        if self.storage != None and self.storage.is_writeable():
            bug.remove()

    def bug_from_uuid(self, uuid):
        if not self.has_bug(uuid):
            raise NoBugMatches(
                uuid, self.uuids(),
                'No bug matches %s in %s' % (uuid, self.storage))
        if self._bug_map[uuid] == None:
            self._load_bug(uuid)
        return self._bug_map[uuid]

    def has_bug(self, bug_uuid):
        if bug_uuid not in self._bug_map:
            self._bug_map_gen()
            if bug_uuid not in self._bug_map:
                return False
        return True

    def xml(self, indent=0, show_bugs=False, show_comments=False):
        """
        >>> bug.load_severities(bug.severity_def)
        >>> bug.load_status(
        ...     active_status_def=bug.active_status_def,
        ...     inactive_status_def=bug.inactive_status_def)
        >>> bugdirA = SimpleBugDir(memory=True)
        >>> bugdirA.severities
        >>> bugdirA.severities = (('minor', 'The standard bug level.'),)
        >>> bugdirA.inactive_status = (
        ...     ('closed', 'The bug is no longer relevant.'),)
        >>> bugA = bugdirA.bug_from_uuid('a')
        >>> commA = bugA.comment_root.new_reply(body='comment A')
        >>> commA.uuid = 'commA'
        >>> commA.date = 'Thu, 01 Jan 1970 00:03:00 +0000'
        >>> print(bugdirA.xml(show_bugs=True, show_comments=True))
        ... # doctest: +REPORT_UDIFF
        <bugdir>
          <uuid>abc123</uuid>
          <short-name>abc</short-name>
          <severities>
            <entry>
              <key>minor</key>
              <value>The standard bug level.</value>
            </entry>
          </severities>
          <inactive-status>
            <entry>
              <key>closed</key>
              <value>The bug is no longer relevant.</value>
            </entry>
          </inactive-status>
          <bug>
            <uuid>a</uuid>
            <short-name>abc/a</short-name>
            <severity>minor</severity>
            <status>open</status>
            <creator>John Doe &lt;jdoe@example.com&gt;</creator>
            <created>Thu, 01 Jan 1970 00:00:00 +0000</created>
            <summary>Bug A</summary>
            <comment>
              <uuid>commA</uuid>
              <short-name>abc/a/com</short-name>
              <author></author>
              <date>Thu, 01 Jan 1970 00:03:00 +0000</date>
              <content-type>text/plain</content-type>
              <body>comment A</body>
            </comment>
          </bug>
          <bug>
            <uuid>b</uuid>
            <short-name>abc/b</short-name>
            <severity>minor</severity>
            <status>closed</status>
            <creator>Jane Doe &lt;jdoe@example.com&gt;</creator>
            <created>Thu, 01 Jan 1970 00:00:00 +0000</created>
            <summary>Bug B</summary>
          </bug>
        </bugdir>
        >>> bug.load_severities(bug.severity_def)
        >>> bug.load_status(
        ...     active_status_def=bug.active_status_def,
        ...     inactive_status_def=bug.inactive_status_def)
        >>> bugdirA.cleanup()
        """
        info = [('uuid', self.uuid),
                ('short-name', self.id.user()),
                ('target', self.target),
                ('severities', self.severities),
                ('active-status', self.active_status),
                ('inactive-status', self.inactive_status),
                ]
        lines = ['<bugdir>']
        for (k,v) in info:
            if v is not None:
                if k in ['severities', 'active-status', 'inactive-status']:
                    lines.append('  <{}>'.format(k))
                    for vk,vv in v:
                        lines.extend([
                                '    <entry>',
                                '      <key>{}</key>'.format(
                                    xml.sax.saxutils.escape(vk)),
                                '      <value>{}</value>'.format(
                                    xml.sax.saxutils.escape(vv)),
                                '    </entry>',
                                ])
                    lines.append('  </{}>'.format(k))
                else:
                    v = xml.sax.saxutils.escape(v)
                    lines.append('  <{0}>{1}</{0}>'.format(k, v))
        for estr in self.extra_strings:
            lines.append('  <extra-string>{}</extra-string>'.format(estr))
        if show_bugs:
            for bug in self:
                bug_xml = bug.xml(indent=indent+2, show_comments=show_comments)
                if bug_xml:
                    bug_xml = bug_xml[indent:]  # strip leading indent spaces
                    lines.append(bug_xml)
        lines.append('</bugdir>')
        istring = ' '*indent
        sep = '\n' + istring
        return istring + sep.join(lines).rstrip('\n')

    def from_xml(self, xml_string, preserve_uuids=False, verbose=True):
        """
        Note: If a bugdir uuid is given, set .alt_id to it's value.
        >>> bug.load_severities(bug.severity_def)
        >>> bug.load_status(
        ...     active_status_def=bug.active_status_def,
        ...     inactive_status_def=bug.inactive_status_def)
        >>> bugdirA = SimpleBugDir(memory=True)
        >>> bugdirA.severities = (('minor', 'The standard bug level.'),)
        >>> bugdirA.inactive_status = (
        ...     ('closed', 'The bug is no longer relevant.'),)
        >>> bugA = bugdirA.bug_from_uuid('a')
        >>> commA = bugA.comment_root.new_reply(body='comment A')
        >>> commA.uuid = 'commA'
        >>> xml = bugdirA.xml(show_bugs=True, show_comments=True)
        >>> bugdirB = BugDir(storage=None)
        >>> bugdirB.from_xml(xml)
        >>> bugdirB.xml(show_bugs=True, show_comments=True) == xml
        False
        >>> bugdirB.uuid = bugdirB.alt_id
        >>> for bug_ in bugdirB:
        ...     bug_.uuid = bug_.alt_id
        ...     bug_.alt_id = None
        ...     for comm in bug_.comments():
        ...         comm.uuid = comm.alt_id
        ...         comm.alt_id = None
        >>> bugdirB.xml(show_bugs=True, show_comments=True) == xml
        True
        >>> bugdirB.explicit_attrs  # doctest: +NORMALIZE_WHITESPACE
        ['severities', 'inactive_status']
        >>> bugdirC = BugDir(storage=None)
        >>> bugdirC.from_xml(xml, preserve_uuids=True)
        >>> bugdirC.uuid == bugdirA.uuid
        True
        >>> bugdirC.xml(show_bugs=True, show_comments=True) == xml
        True
        >>> bug.load_severities(bug.severity_def)
        >>> bug.load_status(
        ...     active_status_def=bug.active_status_def,
        ...     inactive_status_def=bug.inactive_status_def)
        >>> bugdirA.cleanup()
        """
        if type(xml_string) == types.UnicodeType:
            xml_string = xml_string.strip().encode('unicode_escape')
        if hasattr(xml_string, 'getchildren'): # already an ElementTree Element
            bugdir = xml_string
        else:
            bugdir = ElementTree.XML(xml_string)
        if bugdir.tag != 'bugdir':
            raise utility.InvalidXML(
                'bugdir', bugdir, 'root element must be <bugdir>')
        tags = ['uuid', 'short-name', 'target', 'severities', 'active-status',
                'inactive-status', 'extra-string']
        self.explicit_attrs = []
        uuid = None
        estrs = []
        for child in bugdir.getchildren():
            if child.tag == 'short-name':
                pass
            elif child.tag == 'bug':
                bg = bug.Bug(bugdir=self)
                bg.from_xml(
                    child, preserve_uuids=preserve_uuids, verbose=verbose)
                self.append(bg, update=True)
                continue
            elif child.tag in tags:
                if child.text == None or len(child.text) == 0:
                    text = settings_object.EMPTY
                elif child.tag in ['severities', 'active-status',
                                   'inactive-status']:
                    entries = []
                    for entry in child.getchildren():
                        if entry.tag != 'entry':
                            raise utility.InvalidXML(
                                '{} child element {} must be <entry>'.format(
                                    child.tag, entry))
                        key = value = None
                        for kv in entry.getchildren():
                            if kv.tag == 'key':
                                if key is not None:
                                    raise utility.InvalidXML(
                                        ('duplicate keys ({} and {}) in {}'
                                         ).format(key, kv.text, child.tag))
                                key = xml.sax.saxutils.unescape(kv.text)
                            elif kv.tag == 'value':
                                if value is not None:
                                    raise utility.InvalidXML(
                                        ('duplicate values ({} and {}) in {}'
                                         ).format(
                                            value, kv.text, child.tag))
                                value = xml.sax.saxutils.unescape(kv.text)
                            else:
                                raise utility.InvalidXML(
                                    ('{} child element {} must be <key> or '
                                     '<value>').format(child.tag, kv))
                        if key is None:
                            raise utility.InvalidXML(
                                'no key for {}'.format(child.tag))
                        if value is None:
                            raise utility.InvalidXML(
                                'no key for {}'.format(child.tag))
                        entries.append((key, value))
                    text = entries
                else:
                    text = xml.sax.saxutils.unescape(child.text)
                    if not isinstance(text, unicode):
                        text = text.decode('unicode_escape')
                    text = text.strip()
                if child.tag == 'uuid' and not preserve_uuids:
                    uuid = text
                    continue # don't set the bug's uuid tag.
                elif child.tag == 'extra-string':
                    estrs.append(text)
                    continue # don't set the bug's extra_string yet.
                attr_name = child.tag.replace('-','_')
                self.explicit_attrs.append(attr_name)
                setattr(self, attr_name, text)
            elif verbose == True:
                sys.stderr.write('Ignoring unknown tag {} in {}\n'.format(
                        child.tag, bugdir.tag))
        if uuid != self.uuid:
            if not hasattr(self, 'alt_id') or self.alt_id == None:
                self.alt_id = uuid
        self.extra_strings = estrs

    def merge(self, other, accept_changes=True,
              accept_extra_strings=True, accept_bugs=True,
              accept_comments=True, change_exception=False):
        """Merge info from other into this bugdir.

        Overrides any attributes in self that are listed in
        other.explicit_attrs.

        >>> bugdirA = SimpleBugDir()
        >>> bugdirA.extra_strings += ['TAG: favorite']
        >>> bugdirB = SimpleBugDir()
        >>> bugdirB.explicit_attrs = ['target']
        >>> bugdirB.target = '1234'
        >>> bugdirB.extra_strings += ['TAG: very helpful']
        >>> bugdirB.extra_strings += ['TAG: useful']
        >>> bugA = bugdirB.bug_from_uuid('a')
        >>> commA = bugA.comment_root.new_reply(body='comment A')
        >>> commA.uuid = 'uuid-commA'
        >>> commA.date = 'Thu, 01 Jan 1970 00:01:00 +0000'
        >>> bugC = bugdirB.new_bug(summary='bug C', _uuid='c')
        >>> bugC.alt_id = 'alt-c'
        >>> bugC.time_string = 'Thu, 01 Jan 1970 00:02:00 +0000'
        >>> bugdirA.merge(
        ...     bugdirB, accept_changes=False, accept_extra_strings=False,
        ...     accept_bugs=False, change_exception=False)
        >>> print(bugdirA.target)
        None
        >>> bugdirA.merge(
        ...     bugdirB, accept_changes=False, accept_extra_strings=False,
        ...     accept_bugs=False, change_exception=True)
        Traceback (most recent call last):
          ...
        ValueError: Merge would change target "None"->"1234" for bugdir abc123
        >>> print(bugdirA.target)
        None
        >>> bugdirA.merge(
        ...     bugdirB, accept_changes=True, accept_extra_strings=False,
        ...     accept_bugs=False, change_exception=True)
        Traceback (most recent call last):
          ...
        ValueError: Merge would add extra string "TAG: useful" for bugdir abc123
        >>> print(bugdirA.target)
        1234
        >>> print(bugdirA.extra_strings)
        ['TAG: favorite']
        >>> bugdirA.merge(
        ...     bugdirB, accept_changes=True, accept_extra_strings=True,
        ...     accept_bugs=False, change_exception=True)
        Traceback (most recent call last):
          ...
        ValueError: Merge would add bug c (alt: alt-c) to bugdir abc123
        >>> print(bugdirA.extra_strings)
        ['TAG: favorite', 'TAG: useful', 'TAG: very helpful']
        >>> bugdirA.merge(
        ...     bugdirB, accept_changes=True, accept_extra_strings=True,
        ...     accept_bugs=True, change_exception=True)
        >>> print(bugdirA.xml(show_bugs=True, show_comments=True))
        ... # doctest: +ELLIPSIS, +REPORT_UDIFF
        <bugdir>
          <uuid>abc123</uuid>
          <short-name>abc</short-name>
          <target>1234</target>
          <extra-string>TAG: favorite</extra-string>
          <extra-string>TAG: useful</extra-string>
          <extra-string>TAG: very helpful</extra-string>
          <bug>
            <uuid>a</uuid>
            <short-name>abc/a</short-name>
            <severity>minor</severity>
            <status>open</status>
            <creator>John Doe &lt;jdoe@example.com&gt;</creator>
            <created>Thu, 01 Jan 1970 00:00:00 +0000</created>
            <summary>Bug A</summary>
            <comment>
              <uuid>uuid-commA</uuid>
              <short-name>abc/a/uui</short-name>
              <author></author>
              <date>Thu, 01 Jan 1970 00:01:00 +0000</date>
              <content-type>text/plain</content-type>
              <body>comment A</body>
            </comment>
          </bug>
          <bug>
            <uuid>b</uuid>
            <short-name>abc/b</short-name>
            <severity>minor</severity>
            <status>closed</status>
            <creator>Jane Doe &lt;jdoe@example.com&gt;</creator>
            <created>Thu, 01 Jan 1970 00:00:00 +0000</created>
            <summary>Bug B</summary>
          </bug>
          <bug>
            <uuid>c</uuid>
            <short-name>abc/c</short-name>
            <severity>minor</severity>
            <status>open</status>
            <created>Thu, 01 Jan 1970 00:02:00 +0000</created>
            <summary>bug C</summary>
          </bug>
        </bugdir>
        >>> bugdirA.cleanup()
        >>> bugdirB.cleanup()
        """
        if hasattr(other, 'explicit_attrs'):
            for attr in other.explicit_attrs:
                old = getattr(self, attr)
                new = getattr(other, attr)
                if old != new:
                    if accept_changes:
                        setattr(self, attr, new)
                    elif change_exception:
                        raise ValueError(
                            ('Merge would change {} "{}"->"{}" for bugdir {}'
                             ).format(attr, old, new, self.uuid))
        for estr in other.extra_strings:
            if not estr in self.extra_strings:
                if accept_extra_strings:
                    self.extra_strings += [estr]
                elif change_exception:
                    raise ValueError(
                        ('Merge would add extra string "{}" for bugdir {}'
                         ).format(estr, self.uuid))
        for o_bug in other:
            try:
                s_bug = self.bug_from_uuid(o_bug.uuid)
            except KeyError as e:
                try:
                    s_bug = self.bug_from_uuid(o_bug.alt_id)
                except KeyError as e:
                    s_bug = None
            if s_bug is None:
                if accept_bugs:
                    o_bug_copy = copy.copy(o_bug)
                    o_bug_copy.bugdir = self
                    o_bug_copy.id = libbe.util.id.ID(o_bug_copy, 'bug')
                    self.append(o_bug_copy)
                elif change_exception:
                    raise ValueError(
                        ('Merge would add bug {} (alt: {}) to bugdir {}'
                         ).format(o_bug.uuid, o_bug.alt_id, self.uuid))
            else:
                s_bug.merge(o_bug, accept_changes=accept_changes,
                            accept_extra_strings=accept_extra_strings,
                            change_exception=change_exception)

    # methods for id generation

    def sibling_uuids(self):
        return []

class RevisionedBugDir (BugDir):
    """
    RevisionedBugDirs are read-only copies used for generating
    diffs between revisions.
    """
    def __init__(self, bugdir, revision):
        storage_version = bugdir.storage.storage_version(revision)
        if storage_version != libbe.storage.STORAGE_VERSION:
            raise libbe.storage.InvalidStorageVersion(storage_version)
        s = copy.deepcopy(bugdir.storage)
        s.writeable = False
        class RevisionedStorage (object):
            def __init__(self, storage, default_revision):
                self.s = storage
                self.sget = self.s.get
                self.sancestors = self.s.ancestors
                self.schildren = self.s.children
                self.schanged = self.s.changed
                self.r = default_revision
            def get(self, *args, **kwargs):
                if not 'revision' in kwargs or kwargs['revision'] == None:
                    kwargs['revision'] = self.r
                return self.sget(*args, **kwargs)
            def ancestors(self, *args, **kwargs):
                print 'getting ancestors', args, kwargs
                if not 'revision' in kwargs or kwargs['revision'] == None:
                    kwargs['revision'] = self.r
                ret = self.sancestors(*args, **kwargs)
                print 'got ancestors', ret
                return ret
            def children(self, *args, **kwargs):
                if not 'revision' in kwargs or kwargs['revision'] == None:
                    kwargs['revision'] = self.r
                return self.schildren(*args, **kwargs)
            def changed(self, *args, **kwargs):
                if not 'revision' in kwargs or kwargs['revision'] == None:
                    kwargs['revision'] = self.r
                return self.schanged(*args, **kwargs)
        rs = RevisionedStorage(s, revision)
        s.get = rs.get
        s.ancestors = rs.ancestors
        s.children = rs.children
        s.changed = rs.changed
        BugDir.__init__(self, s, from_storage=True)
        self.revision = revision
    def changed(self):
        return self.storage.changed()
    

if libbe.TESTING == True:
    class SimpleBugDir (BugDir):
        """
        For testing.  Set ``memory=True`` for a memory-only bugdir.

        >>> bugdir = SimpleBugDir()
        >>> uuids = list(bugdir.uuids())
        >>> uuids.sort()
        >>> print uuids
        ['a', 'b']
        >>> bugdir.cleanup()
        """
        def __init__(self, memory=True, versioned=False):
            if memory == True:
                storage = None
            else:
                dir = utility.Dir()
                self._dir_ref = dir # postpone cleanup since dir.cleanup() removes dir.
                if versioned == False:
                    storage = libbe.storage.base.Storage(dir.path)
                else:
                    storage = libbe.storage.base.VersionedStorage(dir.path)
                storage.init()
                storage.connect()
            BugDir.__init__(self, storage=storage, uuid='abc123')
            bug_a = self.new_bug(summary='Bug A', _uuid='a')
            bug_a.creator = 'John Doe <jdoe@example.com>'
            bug_a.time = 0
            bug_b = self.new_bug(summary='Bug B', _uuid='b')
            bug_b.creator = 'Jane Doe <jdoe@example.com>'
            bug_b.time = 0
            bug_b.status = 'closed'
            if self.storage != None:
                self.storage.disconnect() # flush to storage
                self.storage.connect()

        def cleanup(self):
            if self.storage != None:
                self.storage.writeable = True
                self.storage.disconnect()
                self.storage.destroy()
            if hasattr(self, '_dir_ref'):
                self._dir_ref.cleanup()

        def flush_reload(self):
            if self.storage != None:
                self.storage.disconnect()
                self.storage.connect()
                self._clear_bugs()

#    class BugDirTestCase(unittest.TestCase):
#        def setUp(self):
#            self.dir = utility.Dir()
#            self.bugdir = BugDir(self.dir.path, sink_to_existing_root=False,
#                                 allow_storage_init=True)
#            self.storage = self.bugdir.storage
#        def tearDown(self):
#            self.bugdir.cleanup()
#            self.dir.cleanup()
#        def fullPath(self, path):
#            return os.path.join(self.dir.path, path)
#        def assertPathExists(self, path):
#            fullpath = self.fullPath(path)
#            self.failUnless(os.path.exists(fullpath)==True,
#                            "path %s does not exist" % fullpath)
#            self.assertRaises(AlreadyInitialized, BugDir,
#                              self.dir.path, assertNewBugDir=True)
#        def versionTest(self):
#            if self.storage != None and self.storage.versioned == False:
#                return
#            original = self.bugdir.storage.commit("Began versioning")
#            bugA = self.bugdir.bug_from_uuid("a")
#            bugA.status = "fixed"
#            self.bugdir.save()
#            new = self.storage.commit("Fixed bug a")
#            dupdir = self.bugdir.duplicate_bugdir(original)
#            self.failUnless(dupdir.root != self.bugdir.root,
#                            "%s, %s" % (dupdir.root, self.bugdir.root))
#            bugAorig = dupdir.bug_from_uuid("a")
#            self.failUnless(bugA != bugAorig,
#                            "\n%s\n%s" % (bugA.string(), bugAorig.string()))
#            bugAorig.status = "fixed"
#            self.failUnless(bug.cmp_status(bugA, bugAorig)==0,
#                            "%s, %s" % (bugA.status, bugAorig.status))
#            self.failUnless(bug.cmp_severity(bugA, bugAorig)==0,
#                            "%s, %s" % (bugA.severity, bugAorig.severity))
#            self.failUnless(bug.cmp_assigned(bugA, bugAorig)==0,
#                            "%s, %s" % (bugA.assigned, bugAorig.assigned))
#            self.failUnless(bug.cmp_time(bugA, bugAorig)==0,
#                            "%s, %s" % (bugA.time, bugAorig.time))
#            self.failUnless(bug.cmp_creator(bugA, bugAorig)==0,
#                            "%s, %s" % (bugA.creator, bugAorig.creator))
#            self.failUnless(bugA == bugAorig,
#                            "\n%s\n%s" % (bugA.string(), bugAorig.string()))
#            self.bugdir.remove_duplicate_bugdir()
#            self.failUnless(os.path.exists(dupdir.root)==False,
#                            str(dupdir.root))
#        def testRun(self):
#            self.bugdir.new_bug(uuid="a", summary="Ant")
#            self.bugdir.new_bug(uuid="b", summary="Cockroach")
#            self.bugdir.new_bug(uuid="c", summary="Praying mantis")
#            length = len(self.bugdir)
#            self.failUnless(length == 3, "%d != 3 bugs" % length)
#            uuids = list(self.bugdir.uuids())
#            self.failUnless(len(uuids) == 3, "%d != 3 uuids" % len(uuids))
#            self.failUnless(uuids == ["a","b","c"], str(uuids))
#            bugA = self.bugdir.bug_from_uuid("a")
#            bugAprime = self.bugdir.bug_from_shortname("a")
#            self.failUnless(bugA == bugAprime, "%s != %s" % (bugA, bugAprime))
#            self.bugdir.save()
#            self.versionTest()
#        def testComments(self, sync_with_disk=False):
#            if sync_with_disk == True:
#                self.bugdir.set_sync_with_disk(True)
#            self.bugdir.new_bug(uuid="a", summary="Ant")
#            bug = self.bugdir.bug_from_uuid("a")
#            comm = bug.comment_root
#            rep = comm.new_reply("Ants are small.")
#            rep.new_reply("And they have six legs.")
#            if sync_with_disk == False:
#                self.bugdir.save()
#                self.bugdir.set_sync_with_disk(True)
#            self.bugdir._clear_bugs()
#            bug = self.bugdir.bug_from_uuid("a")
#            bug.load_comments()
#            if sync_with_disk == False:
#                self.bugdir.set_sync_with_disk(False)
#            self.failUnless(len(bug.comment_root)==1, len(bug.comment_root))
#            for index,comment in enumerate(bug.comments()):
#                if index == 0:
#                    repLoaded = comment
#                    self.failUnless(repLoaded.uuid == rep.uuid, repLoaded.uuid)
#                    self.failUnless(comment.sync_with_disk == sync_with_disk,
#                                    comment.sync_with_disk)
#                    self.failUnless(comment.content_type == "text/plain",
#                                    comment.content_type)
#                    self.failUnless(repLoaded.settings["Content-type"] == \
#                                        "text/plain",
#                                    repLoaded.settings)
#                    self.failUnless(repLoaded.body == "Ants are small.",
#                                    repLoaded.body)
#                elif index == 1:
#                    self.failUnless(comment.in_reply_to == repLoaded.uuid,
#                                    repLoaded.uuid)
#                    self.failUnless(comment.body == "And they have six legs.",
#                                    comment.body)
#                else:
#                    self.failIf(True,
#                                "Invalid comment: %d\n%s" % (index, comment))
#        def testSyncedComments(self):
#            self.testComments(sync_with_disk=True)

    class SimpleBugDirTestCase (unittest.TestCase):
        def setUp(self):
            # create a pre-existing bugdir in a temporary directory
            self.dir = utility.Dir()
            self.storage = libbe.storage.base.Storage(self.dir.path)
            self.storage.init()
            self.storage.connect()
            self.bugdir = BugDir(self.storage)
            self.bugdir.new_bug(summary="Hopefully not imported",
                                _uuid="preexisting")
            self.storage.disconnect()
            self.storage.connect()
        def tearDown(self):
            if self.storage != None:
                self.storage.disconnect()
                self.storage.destroy()
            self.dir.cleanup()
        def testOnDiskCleanLoad(self):
            """
            SimpleBugDir(memory==False) should not import
            preexisting bugs.
            """
            bugdir = SimpleBugDir(memory=False)
            self.failUnless(bugdir.storage.is_readable() == True,
                            bugdir.storage.is_readable())
            self.failUnless(bugdir.storage.is_writeable() == True,
                            bugdir.storage.is_writeable())
            uuids = sorted([bug.uuid for bug in bugdir])
            self.failUnless(uuids == ['a', 'b'], uuids)
            bugdir.flush_reload()
            uuids = sorted(bugdir.uuids())
            self.failUnless(uuids == ['a', 'b'], uuids)
            uuids = sorted([bug.uuid for bug in bugdir])
            self.failUnless(uuids == [], uuids)
            bugdir.load_all_bugs()
            uuids = sorted([bug.uuid for bug in bugdir])
            self.failUnless(uuids == ['a', 'b'], uuids)
            bugdir.cleanup()
        def testInMemoryCleanLoad(self):
            """
            SimpleBugDir(memory==True) should not import
            preexisting bugs.
            """
            bugdir = SimpleBugDir(memory=True)
            self.failUnless(bugdir.storage == None, bugdir.storage)
            uuids = sorted([bug.uuid for bug in bugdir])
            self.failUnless(uuids == ['a', 'b'], uuids)
            uuids = sorted([bug.uuid for bug in bugdir])
            self.failUnless(uuids == ['a', 'b'], uuids)
            bugdir._clear_bugs()
            uuids = sorted(bugdir.uuids())
            self.failUnless(uuids == [], uuids)
            uuids = sorted([bug.uuid for bug in bugdir])
            self.failUnless(uuids == [], uuids)
            bugdir.cleanup()

    unitsuite =unittest.TestLoader().loadTestsFromModule(sys.modules[__name__])
    suite = unittest.TestSuite([unitsuite, doctest.DocTestSuite()])

#    def _get_settings(self, settings_path, for_duplicate_bugdir=False):
#        allow_no_storage = not self.storage.path_in_root(settings_path)
#        if allow_no_storage == True:
#            assert for_duplicate_bugdir == True
#        if self.sync_with_disk == False and for_duplicate_bugdir == False:
#            # duplicates can ignore this bugdir's .sync_with_disk status
#            raise DiskAccessRequired("_get settings")
#        try:
#            settings = mapfile.map_load(self.storage, settings_path, allow_no_storage)
#        except storage.NoSuchFile:
#            settings = {"storage_name": "None"}
#        return settings

#    def _save_settings(self, settings_path, settings,
#                       for_duplicate_bugdir=False):
#        allow_no_storage = not self.storage.path_in_root(settings_path)
#        if allow_no_storage == True:
#            assert for_duplicate_bugdir == True
#        if self.sync_with_disk == False and for_duplicate_bugdir == False:
#            # duplicates can ignore this bugdir's .sync_with_disk status
#            raise DiskAccessRequired("_save settings")
#        self.storage.mkdir(self.get_path(), allow_no_storage)
#        mapfile.map_save(self.storage, settings_path, settings, allow_no_storage)