cvs2svn_lib/bzr_run_options.py

   1 # (Be in -*- python -*- mode.)
   2 #
   3 # ====================================================================
   4 # Copyright (c) 2000-2009 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 manages cvs2bzr run options."""
  18
  19 import tempfile
  20
  21 from cvs2svn_lib.common import FatalError
  22 from cvs2svn_lib.context import Ctx
  23 from cvs2svn_lib.dvcs_common import DVCSRunOptions
  24 from cvs2svn_lib.run_options import ContextOption
  25 from cvs2svn_lib.run_options import IncompatibleOption
  26 from cvs2svn_lib.run_options import not_both
  27 from cvs2svn_lib.revision_manager import NullRevisionCollector
  28 from cvs2svn_lib.rcs_revision_manager import RCSRevisionReader
  29 from cvs2svn_lib.cvs_revision_manager import CVSRevisionReader
  30 from cvs2svn_lib.output_option import NullOutputOption
  31 from cvs2svn_lib.git_output_option import GitRevisionInlineWriter
  32 from cvs2svn_lib.bzr_output_option import BzrOutputOption
  33
  34
  35 class BzrRunOptions(DVCSRunOptions):
  36
  37   short_desc = 'convert a cvs repository into a Bazaar repository'
  38
  39   synopsis = """\
  40 .B cvs2bzr
  41 [\\fIOPTION\\fR]... \\fIOUTPUT-OPTIONS CVS-REPOS-PATH\\fR
  42 .br
  43 .B cvs2bzr
  44 [\\fIOPTION\\fR]... \\fI--options=PATH\\fR
  45 """
  46
  47   long_desc = """\
  48 Create a new Bazaar repository based on the version history stored in a
  49 CVS repository. Each CVS commit will be mirrored in the Bazaar
  50 repository, including such information as date of commit and id of the
  51 committer.
  52 .P
  53 The output of this program is a "fast-import dumpfile", which
  54 can be loaded into a Bazaar repository using the Bazaar FastImport
  55 Plugin, available from https://launchpad.net/bzr-fastimport.
  56
  57 .P
  58 \\fICVS-REPOS-PATH\\fR is the filesystem path of the part of the CVS
  59 repository that you want to convert.  This path doesn't have to be the
  60 top level directory of a CVS repository; it can point at a project
  61 within a repository, in which case only that project will be
  62 converted.  This path or one of its parent directories has to contain
  63 a subdirectory called CVSROOT (though the CVSROOT directory can be
  64 empty).
  65 .P
  66 It is not possible directly to convert a CVS repository to which you
  67 only have remote access, but the FAQ describes tools that may be used
  68 to create a local copy of a remote CVS repository.
  69 """
  70
  71   files = """\
  72 A directory under \\fI%s\\fR (or the directory specified by
  73 \\fB--tmpdir\\fR) is used as scratch space for temporary data files.
  74 """ % (tempfile.gettempdir(),)
  75
  76   see_also = [
  77     ('cvs', '1'),
  78     ('bzr', '1'),
  79     ]
  80
  81   DEFAULT_USERNAME = 'cvs2bzr'
  82
  83   def _get_output_options_group(self):
  84     group = super(BzrRunOptions, self)._get_output_options_group()
  85
  86     group.add_option(IncompatibleOption(
  87         '--dumpfile', type='string',
  88         action='store',
  89         help='path to which the data should be written',
  90         man_help=(
  91             'Write the blobs and revision data to \\fIpath\\fR.'
  92             ),
  93         metavar='PATH',
  94         ))
  95     group.add_option(ContextOption(
  96         '--dry-run',
  97         action='store_true',
  98         help=(
  99             'do not create any output; just print what would happen.'
 100             ),
 101         man_help=(
 102             'Do not create any output; just print what would happen.'
 103             ),
 104         ))
 105
 106     return group
 107
 108   def _get_extraction_options_group(self):
 109     group = super(BzrRunOptions, self)._get_extraction_options_group()
 110     self._add_use_cvs_option(group)
 111     self._add_use_rcs_option(group)
 112     return group
 113
 114   def process_extraction_options(self):
 115     """Process options related to extracting data from the CVS repository."""
 116
 117     options = self.options
 118
 119     not_both(options.use_rcs, '--use-rcs',
 120              options.use_cvs, '--use-cvs')
 121
 122     # cvs2bzr defers acting on extraction options to process_output_options
 123
 124   def process_output_options(self):
 125     """Process options related to fastimport output."""
 126     ctx = Ctx()
 127     options = self.options
 128
 129     if options.use_rcs:
 130       revision_reader = RCSRevisionReader(
 131           co_executable=options.co_executable
 132           )
 133     else:
 134       # --use-cvs is the default:
 135       revision_reader = CVSRevisionReader(
 136           cvs_executable=options.cvs_executable
 137           )
 138
 139     if not ctx.dry_run and not options.dumpfile:
 140       raise FatalError("must pass '--dry-run' or '--dumpfile' option.")
 141
 142     # See cvs2bzr-example.options for explanations of these
 143     ctx.revision_collector = NullRevisionCollector()
 144     ctx.revision_reader = None
 145
 146     if ctx.dry_run:
 147       ctx.output_option = NullOutputOption()
 148     else:
 149       ctx.output_option = BzrOutputOption(
 150           options.dumpfile,
 151           GitRevisionInlineWriter(revision_reader),
 152           # Optional map from CVS author names to bzr author names:
 153           author_transforms={}, # FIXME
 154           )