cvs2svn_lib/test/rcs_stream_test.py

   1 #!/usr/bin/env python
   2 # (Be in -*- python -*- mode.)
   3 #
   4 # ====================================================================
   5 # Copyright (c) 2010 CollabNet.  All rights reserved.
   6 #
   7 # This software is licensed as described in the file COPYING, which
   8 # you should have received as part of this distribution.  The terms
   9 # are also available at http://subversion.tigris.org/license-1.html.
  10 # If newer versions of this license are posted there, you may use a
  11 # newer version instead, at your option.
  12 #
  13 # This software consists of voluntary contributions made by many
  14 # individuals.  For exact contribution history, see the revision
  15 # history and logs, available at http://cvs2svn.tigris.org/.
  16 # ====================================================================
  17
  18 """This program tests the RCSStream class.
  19
  20 When executed, this class conducts a number of unit tests of the
  21 RCSStream class.  It requires RCS's 'ci' program to be installed."""
  22
  23 import sys
  24 import os
  25 import shutil
  26 import unittest
  27 import subprocess
  28
  29 SRCPATH = os.path.normpath(os.path.join(os.path.dirname(__file__), '..', '..'))
  30 sys.path.insert(0, SRCPATH)
  31
  32 import unittest
  33
  34 from cvs2svn_lib.rcsparser import Sink
  35 from cvs2svn_lib.rcsparser import parse
  36 from cvs2svn_lib.rcs_stream import RCSStream
  37
  38 TMPDIR = os.path.join(SRCPATH, 'cvs2svn-tmp')
  39
  40
  41 # Do we require that the inverse of an inverse delta is identical to
  42 # the original delta?  (This is not really required; it would be
  43 # enough if the deltas were functionally the same.)
  44 STRICT_INVERSES = True
  45
  46
  47 class RCSRecorder(Sink):
  48   def __init__(self):
  49     self.texts = {}
  50
  51   def set_revision_info(self, rev, log, text):
  52     self.texts[rev] = text
  53
  54
  55 class RCSStreamTestCase(unittest.TestCase):
  56   def __init__(self, name, doc, v1, v2):
  57     unittest.TestCase.__init__(self)
  58     self.name = name
  59     self.doc = doc
  60     self.v1 = v1
  61     self.v2 = v2
  62     self.filename = os.path.join(TMPDIR, 'rcsstream-%s' % self.name, 'a.txt')
  63
  64   def shortDescription(self):
  65     return self.doc
  66
  67   def call(self, *args, **kwargs):
  68     retcode = subprocess.call(*args, **kwargs)
  69     self.assertEqual(retcode, 0)
  70
  71   def setUp(self):
  72     if not os.path.isdir(os.path.dirname(self.filename)):
  73       os.makedirs(os.path.dirname(self.filename))
  74
  75     f = open(self.filename, 'wb')
  76     f.write(self.v1)
  77     f.close()
  78
  79     self.call(
  80         ['ci', '-q', '-i', '-t-' + self.name, '-mv1', '-l', self.filename],
  81         )
  82
  83     f = open(self.filename, 'wb')
  84     f.write(self.v2)
  85     f.close()
  86
  87     self.call(
  88         ['ci', '-q', '-f', '-mv2', self.filename],
  89         )
  90
  91   def applyTest(self, old, delta, new):
  92     s1 = RCSStream(old)
  93     self.assertEqual(s1.get_text(), old)
  94     s1.apply_diff(delta)
  95     self.assertEqual(s1.get_text(), new)
  96
  97     s2 = RCSStream(old)
  98     self.assertEqual(s2.get_text(), old)
  99     s2.invert_diff(delta)
 100     self.assertEqual(s2.get_text(), new)
 101
 102   def runTest(self):
 103     self.assert_(os.path.isfile(self.filename + ',v'))
 104     recorder = RCSRecorder()
 105
 106     f = open(self.filename + ',v', 'rb')
 107     try:
 108       parse(f, recorder)
 109     finally:
 110       f.close()
 111
 112     v2 = recorder.texts['1.2']
 113     self.assertEqual(v2, self.v2)
 114     delta = recorder.texts['1.1']
 115     s = RCSStream(v2)
 116     self.assertEqual(s.get_text(), self.v2)
 117     invdelta = s.invert_diff(delta)
 118     self.assertEqual(s.get_text(), self.v1)
 119     delta2 = s.invert_diff(invdelta)
 120
 121     self.applyTest(self.v2, delta, self.v1)
 122     self.applyTest(self.v1, invdelta, self.v2)
 123
 124     if STRICT_INVERSES:
 125       self.assertEqual(delta2, delta)
 126     elif delta2 != delta:
 127       self.applyTest(self.v2, delta2, self.v1)
 128
 129   def tearDown(self):
 130     shutil.rmtree(os.path.dirname(self.filename))
 131
 132
 133 suite = unittest.TestSuite()
 134
 135
 136 def add_test_pair(name, v1, v2):
 137   suite.addTest(RCSStreamTestCase(name, name, v1, v2))
 138   if v1 != v2:
 139     suite.addTest(RCSStreamTestCase(name + '-reverse', name + '-reverse', v2, v1))
 140
 141
 142 def add_test(name, v1, v2):
 143   add_test_pair(name, v1, v2)
 144   if v1.endswith('\n'):
 145     add_test_pair(name + '-1', v1[:-1], v2)
 146   if v2.endswith('\n'):
 147     add_test_pair(name + '-2', v1, v2[:-1])
 148   if v1.endswith('\n') and  v2.endswith('\n'):
 149     add_test_pair(name + '-3', v1[:-1], v2[:-1])
 150
 151
 152 add_test('empty', '', '')
 153 add_test('ab-initio', '', 'blah\n')
 154
 155 add_test('delete-at-start', 'a\nb\nc\n', 'b\nc\n')
 156 add_test('delete-in-middle', 'a\nb\nc\n', 'a\nc\n')
 157 add_test('delete-at-end', 'a\nb\nc\n', 'a\nb\n')
 158
 159 add_test('replace-at-start', 'a\nb\nc\n', 'a1\nb\nc\n')
 160 add_test('replace-in-middle', 'a\nb\nc\n', 'a\nb1\nc\n')
 161 add_test('replace-at-end', 'a\nb\nc\n', 'a\nb\nc1\n')
 162
 163 add_test('enlarge-at-start', 'a\nb\nc\n', 'a1\na2\nb\nc\n')
 164 add_test('enlarge-in-middle', 'a\nb\nc\n', 'a\nb1\nb2\nc\n')
 165 add_test('enlarge-at-end', 'a\nb\nc\n', 'a\nb\nc1\nc2\n')
 166
 167
 168 unittest.TextTestRunner(verbosity=2).run(suite)
 169
 170