Turn tests into doctests

so we can auto generate some examples

2 files changed, 262 insertions, 59 deletions

diff --git a/tests/03_test_gbp_branch.py b/tests/03_test_gbp_branch.py
deleted file mode 100644
index 49ba9b76..00000000
--- a/tests/03_test_gbp_branch.py
+++ /dev/null
@@ -1,59 +0,0 @@
-# vim: set fileencoding=utf-8 :
-
-import os
-import shutil
-import tempfile
-
-import gbp.git
-import gbp.command_wrappers
-
-repo = None
-repo_dir = None
-top = None
-
-def setup():
-    global repo, repo_dir, top
-
-    top = os.path.abspath(os.curdir)
-    repo_dir = os.path.join(top, 'gbp_%s_test_repo' % __name__)
-    repo = gbp.git.GitRepository.create(repo_dir)
-    os.chdir(repo_dir)
-
-
-def teardown():
-    os.chdir(top)
-    if not os.getenv("GBP_TESTS_NOCLEAN") and repo_dir:
-        shutil.rmtree(repo_dir)
-
-
-def test_branch():
-    """Empty repos have no branch"""
-    assert repo.get_branch() == None
-
-
-def test_is_empty():
-    """Repo is still empty"""
-    assert repo.is_empty()
-
-
-def test_add_files():
-    """Add some dummy data"""
-    shutil.copy(".git/HEAD", "testfile")
-    repo.add_files('.', force=True)
-    repo.commit_all(msg="foo")
-    assert True
-
-def test_branch_master():
-    """First branch is master"""
-    assert repo.get_branch() == "master"
-
-def test_create_branch_foo():
-    """Create branch foo"""
-    repo.create_branch("foo")
-
-def test_set_branch_foo():
-    """Switch to branch foo"""
-    repo.set_branch("foo")
-    assert repo.get_branch() == "foo"
-
-# vim:et:ts=4:sw=4:et:sts=4:ai:set list listchars=tab\:»·,trail\:·:
diff --git a/tests/test_GitRepository.py b/tests/test_GitRepository.py
new file mode 100644
index 00000000..88ea5df1
--- /dev/null
+++ b/tests/test_GitRepository.py
@@ -0,0 +1,262 @@
+# vim: set fileencoding=utf-8 :
+
+"""
+Test L{gbp.git.GitRepository}
+"""
+
+import os
+repo_dir = os.path.abspath(
+             os.path.join(os.path.curdir, 'gbp_%s_test_repo' % __name__))
+clone_dir = os.path.abspath(
+             os.path.join(os.path.curdir, 'gbp_%s_test_clone' % __name__))
+
+
+def test_create():
+    """
+    Create a repository
+
+    Methods tested:
+         - L{gbp.git.GitRepository.create}
+
+    Propeties tested:
+         - L{gbp.git.GitRepository.path}
+         - L{gbp.git.GitRepository.base_dir}
+
+    >>> import os, gbp.git
+    >>> repo = gbp.git.GitRepository.create(repo_dir)
+    >>> repo.path == repo_dir
+    True
+    >>> repo.base_dir == os.path.join(repo_dir, '.git')
+    True
+    >>> type(repo) == gbp.git.GitRepository
+    True
+    """
+
+
+def test_empty():
+    """
+    Empty repos have no branch
+
+    Methods tested:
+         - L{gbp.git.GitRepository.get_branch}
+         - L{gbp.git.GitRepository.is_empty}
+
+    >>> import gbp.git
+    >>> repo = gbp.git.GitRepository(repo_dir)
+    >>> repo.get_branch()
+    >>> repo.branch
+    >>> repo.is_empty()
+    True
+    """
+
+
+def test_add_files():
+    """
+    Add some dummy data
+
+    Methods tested:
+         - L{gbp.git.GitRepository.add_files}
+         - L{gbp.git.GitRepository.commit_all}
+         - L{gbp.git.GitRepository.is_clean}
+
+    >>> import gbp.git, shutil
+    >>> repo = gbp.git.GitRepository(repo_dir)
+    >>> shutil.copy(os.path.join(repo.path, ".git/HEAD"), \
+                                 os.path.join(repo.path, "testfile"))
+    >>> repo.is_clean()[0]
+    False
+    >>> repo.add_files(repo.path, force=True)
+    >>> repo.commit_all(msg="foo")
+    >>> repo.is_clean()[0]
+    True
+    """
+
+
+def test_branch_master():
+    """
+    First branch is called I{master}
+
+    Methods tested:
+         - L{gbp.git.GitRepository.get_branch}
+    >>> import gbp.git, shutil
+    >>> repo = gbp.git.GitRepository(repo_dir)
+    >>> repo.get_branch()
+    'master'
+    >>> repo.branch
+    'master'
+    """
+
+
+def test_create_branch():
+    """
+    Create a branch name I{foo}
+
+    Methods tested:
+         - L{gbp.git.GitRepository.create_branch}
+
+    >>> import gbp.git, shutil
+    >>> repo = gbp.git.GitRepository(repo_dir)
+    >>> repo.create_branch("foo")
+    """
+
+
+def test_set_branch():
+    """
+    Switch to branch named I{foo}
+
+    Methods tested:
+         - L{gbp.git.GitRepository.set_branch}
+         - L{gbp.git.GitRepository.get_branch}
+         - L{gbp.git.GitRepository.branch}
+
+    >>> import gbp.git
+    >>> repo = gbp.git.GitRepository(repo_dir)
+    >>> repo.set_branch("foo")
+    >>> repo.get_branch() == "foo"
+    True
+    >>> repo.branch == "foo"
+    True
+    """
+
+
+def test_tag():
+    """
+    Create a tag named I{tag}
+
+    Methods tested:
+         - L{gbp.git.GitRepository.create_tag}
+         - L{gbp.git.GitRepository.has_tag}
+
+    >>> import gbp.git
+    >>> repo = gbp.git.GitRepository(repo_dir)
+    >>> repo.create_tag("tag")
+    >>> repo.has_tag("tag")
+    True
+    >>> repo.has_tag("unknown")
+    False
+    >>> repo.create_tag("tag2", msg="foo")
+    >>> repo.has_tag("tag2")
+    True
+    """
+
+
+def test_move_tag():
+    """
+    Remove tags
+
+    Methods tested:
+         - L{gbp.git.GitRepository.move_tag}
+         - L{gbp.git.GitRepository.has_tag}
+
+    >>> import gbp.git
+    >>> repo = gbp.git.GitRepository(repo_dir)
+    >>> repo.move_tag("tag", "moved")
+    >>> repo.has_tag("tag")
+    False
+    >>> repo.has_tag("moved")
+    True
+    """
+
+def test_delete_tag():
+    """
+    Delete tags
+
+    Methods tested:
+         - L{gbp.git.GitRepository.delete_tag}
+         - L{gbp.git.GitRepository.has_tag}
+
+    >>> import gbp.git
+    >>> repo = gbp.git.GitRepository(repo_dir)
+    >>> repo.has_tag("moved")
+    True
+    >>> repo.delete_tag("moved")
+    >>> repo.has_tag("moved")
+    False
+    """
+
+def test_list_files():
+    """
+    List files in the index
+
+    Methods tested:
+         - L{gbp.git.GitRepository.list_files}
+         - L{gbp.git.GitRepository.add_files}
+         - L{gbp.git.GitRepository.commit_staged}
+         - L{gbp.git.GitRepository.commit_files}
+         - L{gbp.git.GitRepository.force_head}
+
+    >>> import gbp.git, os, shutil
+    >>> repo = gbp.git.GitRepository(repo_dir)
+    >>> src = os.path.join(repo.path, ".git/HEAD")
+    >>> dst = os.path.join(repo.path, "testfile")
+    >>> repo.list_files()
+    ['testfile']
+    >>> repo.list_files(['modified'])
+    []
+    >>> repo.list_files(['modified', 'deleted'])
+    []
+    >>> repo.list_files(['modified', 'deleted', 'cached'])
+    ['testfile']
+    >>> shutil.copy(src, dst)
+    >>> repo.list_files(['modified'])
+    ['testfile']
+    >>> repo.add_files(dst)
+    >>> repo.commit_staged(msg="foo")
+    >>> repo.list_files(['modified'])
+    []
+    >>> repo.list_files(['foo'])
+    Traceback (most recent call last):
+    ...
+    GitRepositoryError: Unknown type 'foo'
+    >>> repo.force_head('HEAD^', hard=True)
+    >>> repo.list_files(['modified'])
+    []
+    >>> shutil.copy(src, dst)
+    >>> repo.list_files(['modified'])
+    ['testfile']
+    >>> repo.commit_files(dst, msg="foo")
+    >>> repo.list_files(['modified'])
+    []
+    """
+
+
+def test_clone():
+    """
+    Clone a repository
+
+    Methods tested:
+         - L{gbp.git.GitRepository.clone}
+         - L{gbp.git.GitRepository.set_branch}
+         - L{gbp.git.GitRepository.has_branch}
+         - L{gbp.git.GitRepository.branch}
+
+    >>> import gbp.git
+    >>> repo = gbp.git.GitRepository(repo_dir)
+    >>> repo.set_branch('master')
+    >>> clone = gbp.git.GitRepository.clone(clone_dir, repo.path, mirror=True)
+    >>> clone.branch
+    'master'
+    >>> clone.has_branch('foo')
+    True
+    >>> clone.has_branch('bar')
+    False
+    >>> clone.set_branch('foo')
+    >>> clone.branch
+    'foo'
+    """
+
+
+def test_teardown():
+    """
+    Perform the teardown
+
+    >>> import shutil, os
+    >>> if not os.getenv("GBP_TESTS_NOCLEAN") and repo_dir: \
+            shutil.rmtree(repo_dir)
+    >>> if not os.getenv("GBP_TESTS_NOCLEAN") and clone_dir: \
+            shutil.rmtree(clone_dir)
+    """
+
+
+
+# vim:et:ts=4:sw=4:et:sts=4:ai:set list listchars=tab\:»·,trail\:·: