Fixed tests far enough to allow basic repository tests to be applied to any of the new database types. This reduces code duplication to the mere minimum, but allows custom tests to be added on top easily and flexibly

Author: Byron

doc/source/changes.rst

@@ -21,6 +21,10 @@ NEXT
 * ### Module Changes ###
 
  * Removed rev_parse function from git.repo.fun - the respective functionality is available only through the repository's rev_parse method, which might in turn translate to any implementation.
+ 
+* ### Exceptions ###
+ 
+ * There is a new common base for all exceptions git-python will throw, namely `GitPythonError`.
 
 0.3.1 Beta 2
 ============

git/db/cmd/__init__.py

@@ -1,2 +1,4 @@
-
-from complex import *
+# Copyright (C) 2010, 2011 Sebastian Thiel (byronimo@gmail.com) and contributors
+#
+# This module is part of GitDB and is released under
+# the New BSD License: http://www.opensource.org/licenses/bsd-license.php

git/db/cmd/base.py

@@ -15,7 +15,7 @@
 							bin_to_hex, 
 							hex_to_bin
 						)
-from git.db.compat import RepoCompatInterface
+from git.db.compat import RepoCompatibilityInterface
 from git.util import RemoteProgress
 from git.db.interface import FetchInfo as GitdbFetchInfo
 from git.db.interface import PushInfo as GitdbPushInfo

git/db/cmd/complex.py

@@ -1,17 +1,27 @@
 """Module with our own git implementation - it uses the git command"""
 
-from git.db.compat import RepoCompatInterface
+from git.db.compat import RepoCompatibilityInterface
 from git.db.py.complex import PureGitDB
 
 from base import *
 
 
-__all__ = ['GitCmdDB', 'CmdCompatibilityGitDB']
+__all__ = ['GitCmdDB', 'CmdCompatibilityGitDB', 'CmdPartialGitDB']
 
 
-class CmdGitDB(	GitCommandMixin, CmdObjectDBRMixin, CmdTransportMixin, 
-				CmdHighLevelRepository, PureGitDB):
+class CmdPartialGitDB( 	GitCommandMixin, CmdObjectDBRMixin, CmdTransportMixin, 
+						CmdHighLevelRepository ):
+	"""Utility repository which only partially implements all required methods.
+	It cannot be reliably used alone, but is provided to allow mixing it with other 
+	implementations"""
 	pass
 
-class CmdCompatibilityGitDB(CmdGitDB, RepoCompatInterface):
+
+class CmdGitDB(CmdPartialGitDB, PureGitDB):
+	"""A database which fills in its missing implementation using the pure python 
+	implementation"""
+	pass
+
+
+class CmdCompatibilityGitDB(CmdGitDB, RepoCompatibilityInterface):
 	"""Command git database with the compatabilty interface added for 0.3x code"""

git/db/compat.py

@@ -4,7 +4,7 @@
 # the New BSD License: http://www.opensource.org/licenses/bsd-license.php
 """Module providing adaptors to maintain backwards compatability"""
 
-class RepoCompatInterface(object):
+class RepoCompatibilityInterface(object):
 	"""Interface to install backwards compatability of the new complex repository
 	types with the previous, all in one, repository."""
 

git/db/complex.py

@@ -1,12 +1,12 @@
 """Module with many useful complex databases with different useful combinations of primary implementations"""
 
 from py.complex import PureGitDB
-from cmd.complex import CmdGitDB
-from compat import RepoCompatInterface
+from cmd.complex import CmdPartialGitDB
+from compat import RepoCompatibilityInterface
 
-__all__ = ['CmdGitDB', 'PureGitDB', 'PureCmdGitDB']
+__all__ = ['CmdPartialGitDB', 'PureGitDB', 'PureCmdGitDB']
 
-class PureCmdGitDB(PureGitDB, CmdGitDB, RepoCompatInterface):
+class PureCmdGitDB(PureGitDB, CmdPartialGitDB, RepoCompatibilityInterface):
 	"""Repository which uses the pure implementation primarily, but falls back
 	to the git command implementation. Please note that the CmdGitDB does it
 	the opposite way around."""

git/db/py/__init__.py

@@ -2,5 +2,3 @@
 #
 # This module is part of GitDB and is released under
 # the New BSD License: http://www.opensource.org/licenses/bsd-license.php
-
-from complex import *

git/db/py/complex.py

@@ -20,7 +20,7 @@
 from ref import PureReferenceDB
 from submodule import PureSubmoduleDB
 
-from git.db.compat import RepoCompatInterface
+from git.db.compat import RepoCompatibilityInterface
 
 from git.util import (
 						LazyMixin, 
@@ -123,6 +123,6 @@ def __init__(self, root_path):
 
 
 
-class PureCompatibilityGitDB(PureGitDB, RepoCompatInterface):
+class PureCompatibilityGitDB(PureGitDB, RepoCompatibilityInterface):
 	"""Pure git database with a compatability layer required by 0.3x code"""
 

git/db/py/resolve.py

@@ -3,12 +3,19 @@
 
 from git.db.interface import ReferencesMixin
 from git.exc import BadObject
-from git.refs import SymbolicReference
-from git.objects.base import Object
-from git.objects.commit import Commit
+from git.refs import (
+						SymbolicReference, 
+						Reference,
+						HEAD,
+						Head,
+						TagReference
+					)
 from git.refs.head import HEAD
 from git.refs.headref import Head
 from git.refs.tag import TagReference
+
+from git.objects.base import Object
+from git.objects.commit import Commit
 from git.util import (
 							join,
 							isdir, 

git/exc.py

@@ -7,7 +7,10 @@
 
 from util import to_hex_sha
 
-class ODBError(Exception):
+class GitPythonError(Exception):
+	"""Base exception for all git-python related errors"""
+
+class ODBError(GitPythonError):
 	"""All errors thrown by the object database"""
 
 
@@ -40,15 +43,15 @@ class UnsupportedOperation(ODBError):
 	"""Thrown if the given operation cannot be supported by the object database"""
 
 
-class InvalidGitRepositoryError(Exception):
+class InvalidGitRepositoryError(GitPythonError):
 	""" Thrown if the given repository appears to have an invalid format.  """
 
 
-class NoSuchPathError(OSError):
+class NoSuchPathError(GitPythonError):
 	""" Thrown if a path could not be access by the system. """
 
 
-class GitCommandError(Exception):
+class GitCommandError(GitPythonError):
 	""" Thrown if execution of the git command fails with non-zero status code. """
 	def __init__(self, command, status, stderr=None):
 		self.stderr = stderr
@@ -60,7 +63,7 @@ def __str__(self):
 					(' '.join(str(i) for i in self.command), self.status, self.stderr))
 
 
-class CheckoutError( Exception ):
+class CheckoutError(GitPythonError):
 	"""Thrown if a file could not be checked out from the index as it contained
 	changes.
 
@@ -83,7 +86,7 @@ def __str__(self):
 		return Exception.__str__(self) + ":%s" % self.failed_files
 
 
-class CacheError(Exception):
+class CacheError(GitPythonError):
 	"""Base for all errors related to the git index, which is called cache internally"""
 
 

git/index/base.py

@@ -63,7 +63,6 @@
 				)
 
 from git.base import IStream
-from git.db.py.mem import PureMemoryDB
 from git.util import to_bin_sha
 from itertools import izip
 
@@ -512,7 +511,9 @@ def write_tree(self):
 		:raise UnmergedEntriesError: """
 		# we obtain no lock as we just flush our contents to disk as tree
 		# If we are a new index, the entries access will load our data accordingly
-		mdb = PureMemoryDB()
+		# Needs delayed import as db.py import IndexFile as well
+		import git.db.py.mem
+		mdb = git.db.py.mem.PureMemoryDB()
 		entries = self._entries_sorted()
 		binsha, tree_items = write_tree_from_cache(entries, mdb, slice(0, len(entries)))
 

git/repo.py

@@ -5,7 +5,7 @@
 # the BSD License: http://www.opensource.org/licenses/bsd-license.php
 """This module is just to maintain compatibility to git-python 0.3x"""
 
-from git.db.cmd import CmdCompatibilityGitDB 
+from git.db.cmd.complex import CmdCompatibilityGitDB
 
 
 import warnings

git/test/test_repo.py renamed to git/test/db/base.py

@@ -3,7 +3,8 @@
 #
 # This module is part of GitPython and is released under
 # the BSD License: http://www.opensource.org/licenses/bsd-license.php
-from git.test.lib import TestBase
+from lib import TestDBBase
+from git.test.lib import *
 from git import *
 from git.util import join_path_native
 from git.exc import BadObject
@@ -15,18 +16,22 @@
 from cStringIO import StringIO
 
 
-class TestRepo(TestBase):
+class RepoGlobalsItemDeletorMetaCls(GlobalsItemDeletorMetaCls):
+	ModuleToDelete = 'RepoBase'
+	
+
+class RepoBase(TestDBBase):
+	"""Basic test for everything a fully implemented repository should support"""
+	__metaclass__ = RepoGlobalsItemDeletorMetaCls
 
-	@raises(InvalidGitRepositoryError)
 	def test_new_should_raise_on_invalid_repo_location(self):
-		Repo(tempfile.gettempdir())
+		self.failUnlessRaises(InvalidGitRepositoryError, self.RepoCls, tempfile.gettempdir())
 
-	@raises(NoSuchPathError)
 	def test_new_should_raise_on_non_existant_path(self):
-		Repo("repos/foobar")
+		self.failUnlessRaises(NoSuchPathError, self.RepoCls, "repos/foobar")
 
 	def test_repo_creation_from_different_paths(self):
-		r_from_gitdir = Repo(self.rorepo.git_dir)
+		r_from_gitdir = self.RepoCls(self.rorepo.git_dir)
 		assert r_from_gitdir.git_dir == self.rorepo.git_dir
 		assert r_from_gitdir.git_dir.endswith('.git')
 		assert not self.rorepo.git.working_dir.endswith('.git')
@@ -184,7 +189,10 @@ def test_init(self):
 		# END restore previous state
 
 	def test_bare_property(self):
-		self.rorepo.bare
+		if isinstance(self.rorepo, RepoCompatibilityInterface):
+			self.rorepo.bare
+		#END handle compatability 
+		self.rorepo.is_bare
 
 	def test_daemon_export(self):
 		orig_val = self.rorepo.daemon_export
@@ -204,7 +212,7 @@ def test_alternates(self):
 		self.rorepo.alternates = cur_alternates
 
 	def test_repr(self):
-		path = os.path.join(os.path.abspath(GIT_REPO), '.git')
+		path = os.path.join(os.path.abspath(rorepo_dir()), '.git')
 		assert_equal('<git.Repo "%s">' % path, repr(self.rorepo))
 
 	def test_is_dirty_with_bare_repository(self):

git/test/db/cmd/__init__.py

@@ -0,0 +1,4 @@
+# Copyright (C) 2010, 2011 Sebastian Thiel (byronimo@gmail.com) and contributors
+#
+# This module is part of GitDB and is released under
+# the New BSD License: http://www.opensource.org/licenses/bsd-license.php

git/test/db/cmd/test_base.py

@@ -0,0 +1,13 @@
+# Copyright (C) 2010, 2011 Sebastian Thiel (byronimo@gmail.com) and contributors
+#
+# This module is part of GitDB and is released under
+# the New BSD License: http://www.opensource.org/licenses/bsd-license.php
+from git.test.lib import *
+from git.db import RefSpec
+
+class TestBase(TestDBBase):
+	
+	@with_rw_directory
+	def test_basics(self, path):
+		assert False
+		

git/test/db/lib.py

@@ -12,11 +12,6 @@
 	)
 
 from git.stream import Sha1Writer
-
-# import database types we want to support
-# they will be set to None if the respective library could not be loaded
-from git.db.py import PureGitDB
-
 from git.base import (
 							IStream,
 							OStream,
@@ -40,8 +35,6 @@ class TestDBBase(TestBase):
 	two_lines = "1234\nhello world"
 	all_data = (two_lines, )
 
-	# all supported database types. Add your own type 
-	ref_db_types = (PureGitDB, )
 
 	def _assert_object_writing_simple(self, db):
 		# write a bunch of objects and query their streams and info

git/test/db/py/__init__.py

@@ -0,0 +1,4 @@
+# Copyright (C) 2010, 2011 Sebastian Thiel (byronimo@gmail.com) and contributors
+#
+# This module is part of GitDB and is released under
+# the New BSD License: http://www.opensource.org/licenses/bsd-license.php

git/test/db/py/test_base.py

@@ -0,0 +1,18 @@
+# Copyright (C) 2010, 2011 Sebastian Thiel (byronimo@gmail.com) and contributors
+#
+# This module is part of GitDB and is released under
+# the New BSD License: http://www.opensource.org/licenses/bsd-license.php
+from git.test.lib import *
+from git.test.db.base import RepoBase
+from git.db.py.complex import *
+
+from git.db.complex import PureCmdGitDB
+
+class TestPyDBBase(RepoBase):
+	
+	RepoCls = PureCmdGitDB
+	
+	def test_instantiation(self):
+		db = PureGitDB(rorepo_dir())
+		cdb = PureCompatibilityGitDB(rorepo_dir())
+		

git/test/lib/base.py

@@ -1,10 +1,9 @@
 # Copyright (C) 2010, 2011 Sebastian Thiel (byronimo@gmail.com) and contributors
 #
-# This module is part of PureGitDB and is released under
+# This module is part of PureCmdGitDB and is released under
 # the New BSD License: http://www.opensource.org/licenses/bsd-license.php
 """Utilities used in ODB testing"""
 from git.base import OStream
-from git.db.py import PureGitDB
 from git.stream import ( 
 							Sha1Writer, 
 							ZippedStoreShaWriter
@@ -73,7 +72,7 @@ def wrapper(self, path):
 		shutil.copytree(src_dir, path)
 		target_gitdir = os.path.join(path, '.git')
 		assert os.path.isdir(target_gitdir)
-		return func(self, PureGitDB(target_gitdir))
+		return func(self, self.RepoCls(target_gitdir))
 	#END wrapper
 	wrapper.__name__ = func.__name__
 	return with_rw_directory(wrapper)
@@ -98,17 +97,17 @@ def wrapper(self, path):
 
 #{ Routines
 
-def repo_dir():
+def rorepo_dir():
 	""":return: path to our own repository, being our own .git directory.
 	:note: doesn't work in bare repositories"""
 	base = os.path.join(dirname(dirname(dirname(dirname(__file__)))), '.git')
 	assert os.path.isdir(base)
 	return base
 
 
-def maketemp(*args):
+def maketemp(*args, **kwargs):
 	"""Wrapper around default tempfile.mktemp to fix an osx issue"""
-	tdir = tempfile.mktemp(*args)
+	tdir = tempfile.mktemp(*args, **kwargs)
 	if sys.platform == 'darwin':
 		tdir = '/private' + tdir
 	return tdir
@@ -192,12 +191,3 @@ def _assert(self):
 
 #} END stream utilitiess
 
-#{ Bases
-
-class TestBase(unittest.TestCase):
-	"""Base class for all tests"""
-	# The non-database specific tests just provides a default pure git database
-	rorepo = PureGitDB(repo_dir())
-
-#} END bases
-