Merge Dave's fixes for the compatibility tests and web.
[jelmer/dulwich-libgit2.git] / dulwich / tests / utils.py
1 # utils.py -- Test utilities for Dulwich.
2 # Copyright (C) 2010 Google, Inc.
3 #
4 # This program is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU General Public License
6 # as published by the Free Software Foundation; version 2
7 # of the License or (at your option) any later version of
8 # the License.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
18 # MA  02110-1301, USA.
19
20 """Utility functions common to Dulwich tests."""
21
22
23 import os
24 import shutil
25 import tempfile
26
27 from dulwich.repo import Repo
28
29
30 def open_repo(name):
31     """Open a copy of a repo in a temporary directory.
32
33     Use this function for accessing repos in dulwich/tests/data/repos to avoid
34     accidentally or intentionally modifying those repos in place. Use
35     tear_down_repo to delete any temp files created.
36
37     :param name: The name of the repository, relative to
38         dulwich/tests/data/repos
39     :returns: An initialized Repo object that lives in a temporary directory.
40     """
41     temp_dir = tempfile.mkdtemp()
42     repo_dir = os.path.join(os.path.dirname(__file__), 'data', 'repos', name)
43     temp_repo_dir = os.path.join(temp_dir, name)
44     shutil.copytree(repo_dir, temp_repo_dir, symlinks=True)
45     return Repo(temp_repo_dir)
46
47
48 def tear_down_repo(repo):
49     """Tear down a test repository."""
50     temp_dir = os.path.dirname(repo.path.rstrip(os.sep))
51     shutil.rmtree(temp_dir)