cvs2svn_lib/check_dependencies_pass.py

   1 # (Be in -*- python -*- mode.)
   2 #
   3 # ====================================================================
   4 # Copyright (c) 2000-2008 CollabNet.  All rights reserved.
   5 #
   6 # This software is licensed as described in the file COPYING, which
   7 # you should have received as part of this distribution.  The terms
   8 # are also available at http://subversion.tigris.org/license-1.html.
   9 # If newer versions of this license are posted there, you may use a
  10 # newer version instead, at your option.
  11 #
  12 # This software consists of voluntary contributions made by many
  13 # individuals.  For exact contribution history, see the revision
  14 # history and logs, available at http://cvs2svn.tigris.org/.
  15 # ====================================================================
  16
  17 """This module defines some passes that can be used for debugging cv2svn."""
  18
  19
  20 from cvs2svn_lib import config
  21 from cvs2svn_lib.context import Ctx
  22 from cvs2svn_lib.common import FatalException
  23 from cvs2svn_lib.common import DB_OPEN_READ
  24 from cvs2svn_lib.log import logger
  25 from cvs2svn_lib.pass_manager import Pass
  26 from cvs2svn_lib.project import read_projects
  27 from cvs2svn_lib.artifact_manager import artifact_manager
  28 from cvs2svn_lib.cvs_path_database import CVSPathDatabase
  29 from cvs2svn_lib.symbol_database import SymbolDatabase
  30 from cvs2svn_lib.cvs_item_database import OldCVSItemStore
  31 from cvs2svn_lib.cvs_item_database import IndexedCVSItemStore
  32
  33
  34 class CheckDependenciesPass(Pass):
  35   """Check that the dependencies are self-consistent."""
  36
  37   def __init__(self):
  38     Pass.__init__(self)
  39
  40   def register_artifacts(self):
  41     self._register_temp_file_needed(config.PROJECTS)
  42     self._register_temp_file_needed(config.SYMBOL_DB)
  43     self._register_temp_file_needed(config.CVS_PATHS_DB)
  44
  45   def iter_cvs_items(self):
  46     raise NotImplementedError()
  47
  48   def get_cvs_item(self, item_id):
  49     raise NotImplementedError()
  50
  51   def run(self, run_options, stats_keeper):
  52     Ctx()._projects = read_projects(
  53         artifact_manager.get_temp_file(config.PROJECTS)
  54         )
  55     Ctx()._cvs_path_db = CVSPathDatabase(DB_OPEN_READ)
  56     self.symbol_db = SymbolDatabase()
  57     Ctx()._symbol_db = self.symbol_db
  58
  59     logger.quiet("Checking dependency consistency...")
  60
  61     fatal_errors = []
  62     for cvs_item in self.iter_cvs_items():
  63       # Check that the pred_ids and succ_ids are mutually consistent:
  64       for pred_id in cvs_item.get_pred_ids():
  65         pred = self.get_cvs_item(pred_id)
  66         if not cvs_item.id in pred.get_succ_ids():
  67           fatal_errors.append(
  68               '%s lists pred=%s, but not vice versa.' % (cvs_item, pred,))
  69
  70       for succ_id in cvs_item.get_succ_ids():
  71         succ = self.get_cvs_item(succ_id)
  72         if not cvs_item.id in succ.get_pred_ids():
  73           fatal_errors.append(
  74               '%s lists succ=%s, but not vice versa.' % (cvs_item, succ,))
  75
  76     if fatal_errors:
  77       raise FatalException(
  78           'Dependencies inconsistent:\n'
  79           '%s\n'
  80           'Exited due to fatal error(s).'
  81           % ('\n'.join(fatal_errors),)
  82           )
  83
  84     self.symbol_db.close()
  85     self.symbol_db = None
  86     Ctx()._cvs_path_db.close()
  87     logger.quiet("Done")
  88
  89
  90 class CheckItemStoreDependenciesPass(CheckDependenciesPass):
  91   def __init__(self, cvs_items_store_file):
  92     CheckDependenciesPass.__init__(self)
  93     self.cvs_items_store_file = cvs_items_store_file
  94
  95   def register_artifacts(self):
  96     CheckDependenciesPass.register_artifacts(self)
  97     self._register_temp_file_needed(self.cvs_items_store_file)
  98
  99   def iter_cvs_items(self):
 100     cvs_item_store = OldCVSItemStore(
 101         artifact_manager.get_temp_file(self.cvs_items_store_file))
 102
 103     for cvs_file_items in cvs_item_store.iter_cvs_file_items():
 104       self.current_cvs_file_items = cvs_file_items
 105       for cvs_item in cvs_file_items.values():
 106         yield cvs_item
 107
 108     del self.current_cvs_file_items
 109
 110     cvs_item_store.close()
 111
 112   def get_cvs_item(self, item_id):
 113     return self.current_cvs_file_items[item_id]
 114
 115
 116 class CheckIndexedItemStoreDependenciesPass(CheckDependenciesPass):
 117   def __init__(self, cvs_items_store_file, cvs_items_store_index_file):
 118     CheckDependenciesPass.__init__(self)
 119     self.cvs_items_store_file = cvs_items_store_file
 120     self.cvs_items_store_index_file = cvs_items_store_index_file
 121
 122   def register_artifacts(self):
 123     CheckDependenciesPass.register_artifacts(self)
 124     self._register_temp_file_needed(self.cvs_items_store_file)
 125     self._register_temp_file_needed(self.cvs_items_store_index_file)
 126
 127   def iter_cvs_items(self):
 128     return self.cvs_item_store.itervalues()
 129
 130   def get_cvs_item(self, item_id):
 131     return self.cvs_item_store[item_id]
 132
 133   def run(self, run_options, stats_keeper):
 134     self.cvs_item_store = IndexedCVSItemStore(
 135         artifact_manager.get_temp_file(self.cvs_items_store_file),
 136         artifact_manager.get_temp_file(self.cvs_items_store_index_file),
 137         DB_OPEN_READ)
 138
 139     CheckDependenciesPass.run(self, run_options, stats_keeper)
 140
 141     self.cvs_item_store.close()
 142     self.cvs_item_store = None
 143
 144