# Copyright (C) 2005-2011 Aaron Bentley # Alexander Belchenko # Chris Ball # Gianluca Montecchi # Oleg Romanyshyn # W. Trevor King # # 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 . """Define the :class:`BugDir` class for storing a collection of bugs. """ import copy import errno import os import os.path import time 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/.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.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._uuids_cache = [] # 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.append(id) return list(set([bug.uuid for bug in self] + self._uuids_cache)) 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) self._bug_map_gen() if hasattr(self, '_uuids_cache') and not bg.uuid in self._uuids_cache: self._uuids_cache.append(bg.uuid) return bg 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 # 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 ' bug_a.time = 0 bug_b = self.new_bug(summary='Bug B', _uuid='b') bug_b.creator = 'Jane Doe ' 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)