Add cgit compatibility testing framework.
[jelmer/dulwich-libgit2.git] / dulwich / tests / compat / utils.py
1 # utils.py -- Git compatibility utilities
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 """Utilities for interacting with cgit."""
21
22 import os
23 import subprocess
24 import tempfile
25 import unittest
26
27 import nose
28
29 from dulwich.repo import Repo
30 from dulwich.tests.utils import open_repo
31
32
33 _DEFAULT_GIT = 'git'
34
35
36 def git_version(git_path=_DEFAULT_GIT):
37     """Attempt to determine the version of git currently installed.
38
39     :param git_path: Path to the git executable; defaults to the version in
40         the system path.
41     :return: A tuple of ints of the form (major, minor, point), or None if no
42         git installation was found.
43     """
44     try:
45         _, output = run_git(['--version'], git_path=git_path,
46                             capture_stdout=True)
47     except OSError:
48         return None
49     version_prefix = 'git version '
50     if not output.startswith(version_prefix):
51         return None
52     output = output[len(version_prefix):]
53     nums = output.split('.')
54     if len(nums) == 2:
55         nums.add('0')
56     else:
57         nums = nums[:3]
58     try:
59         return tuple(int(x) for x in nums)
60     except ValueError:
61         return None
62
63
64 def require_git_version(required_version, git_path=_DEFAULT_GIT):
65     """Require git version >= version, or skip the calling test."""
66     found_version = git_version(git_path=git_path)
67     if found_version < required_version:
68         required_version = '.'.join(map(str, required_version))
69         found_version = '.'.join(map(str, found_version))
70         raise nose.SkipTest('Test requires git >= %s, found %s' %
71                             (required_version, found_version))
72
73
74 def run_git(args, git_path=_DEFAULT_GIT, input=None, capture_stdout=False,
75             **popen_kwargs):
76     """Run a git command.
77
78     Input is piped from the input parameter and output is sent to the standard
79     streams, unless capture_stdout is set.
80
81     :param args: A list of args to the git command.
82     :param git_path: Path to to the git executable.
83     :param input: Input data to be sent to stdin.
84     :param capture_stdout: Whether to capture and return stdout.
85     :param popen_kwargs: Additional kwargs for subprocess.Popen;
86         stdin/stdout args are ignored.
87     :return: A tuple of (returncode, stdout contents). If capture_stdout is
88         False, None will be returned as stdout contents.
89     :raise OSError: if the git executable was not found.
90     """
91     args = [git_path] + args
92     popen_kwargs['stdin'] = subprocess.PIPE
93     if capture_stdout:
94         popen_kwargs['stdout'] = subprocess.PIPE
95     else:
96         popen_kwargs.pop('stdout', None)
97     p = subprocess.Popen(args, **popen_kwargs)
98     stdout, stderr = p.communicate(input=input)
99     return (p.returncode, stdout)
100
101
102 def run_git_or_fail(args, git_path=_DEFAULT_GIT, input=None, **popen_kwargs):
103     """Run a git command, capture stdout/stderr, and fail if git fails."""
104     popen_kwargs['stderr'] = subprocess.STDOUT
105     returncode, stdout = run_git(args, git_path=git_path, input=input,
106                                  capture_stdout=True, **popen_kwargs)
107     assert returncode == 0
108     return stdout
109
110
111 def import_repo(name):
112     """Import a repo from a fast-export file in a temporary directory.
113
114     These are used rather than binary repos for compat tests because they are
115     more compact an human-editable, and we already depend on git.
116
117     :param name: The name of the repository export file, relative to
118         dulwich/tests/data/repos
119     :returns: An initialized Repo object that lives in a temporary directory.
120     """
121     temp_dir = tempfile.mkdtemp()
122     export_path = os.path.join(os.path.dirname(__file__), os.pardir, 'data',
123                                'repos', name)
124     temp_repo_dir = os.path.join(temp_dir, name)
125     export_file = open(export_path, 'rb')
126     run_git_or_fail(['init', '--bare', temp_repo_dir])
127     run_git_or_fail(['fast-import'], input=export_file.read(),
128                     cwd=temp_repo_dir)
129     export_file.close()
130     return Repo(temp_repo_dir)
131
132
133 class CompatTestCase(unittest.TestCase):
134     """Test case that requires git for compatibility checks.
135
136     Subclasses can change the git version required by overriding
137     min_git_version.
138     """
139
140     min_git_version = (1, 5, 0)
141
142     def setUp(self):
143         require_git_version(self.min_git_version)