Introduce gbp-pq-rpm

Initial version of gbp-pq-rpm - a tool for managing patch queues for rpm
packages. The functionality more or less corresponds to that of the
(Debian) gbp-pq. The only major difference probably being (in addition
to the obvious of working with .spec files instead of debian/) is that
patches are always imported on top of the upstream version, not on top
of the packaging branch (which might not even contain any source code).

Signed-off-by: Markus Lehtonen <markus.lehtonen@linux.intel.com>
Signed-off-by: Olev Kartau <olev.kartau@intel.com>

3 files changed, 435 insertions, 1 deletions

diff --git a/tests/component/rpm/__init__.py b/tests/component/rpm/__init__.py
index e84fca9..b5be3e7 100644
--- a/tests/component/rpm/__init__.py
+++ b/tests/component/rpm/__init__.py
@@ -16,15 +16,91 @@
 #    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 """Test module for RPM command line tools of the git-buildpackage suite"""
 
+from nose.tools import nottest
 import os
+import shutil
+from xml.dom import minidom
 
-from tests.component import ComponentTestGitRepository
+from gbp.git import GitRepository, GitRepositoryError
+
+from tests.component import ComponentTestBase, ComponentTestGitRepository
 
 RPM_TEST_DATA_SUBMODULE = os.path.join('tests', 'component', 'rpm', 'data')
 RPM_TEST_DATA_DIR = os.path.abspath(RPM_TEST_DATA_SUBMODULE)
 
+class RepoManifest(object):
+    """Class representing a test repo manifest file"""
+    def __init__(self, filename=None):
+        self._doc = minidom.Document()
+        if filename:
+            self._doc = minidom.parse(filename)
+            if self._doc.firstChild.nodeName != 'gbp-test-manifest':
+                raise Exception('%s is not a test repo manifest' % filename)
+        else:
+            self._doc.appendChild(self._doc.createElement("gbp-test-manifest"))
+
+    def projects_iter(self):
+        """Return an iterator over projects"""
+        for prj_e in self._doc.getElementsByTagName('project'):
+            branches = {}
+            for br_e in prj_e.getElementsByTagName('branch'):
+                rev = br_e.getAttribute('revision')
+                branches[br_e.getAttribute('name')] = rev
+            yield prj_e.getAttribute('name'), branches
+
+
+    def write(self, filename):
+        """Write to file"""
+        with open(filename, 'w') as fileobj:
+            fileobj.write(self._doc.toprettyxml())
+
 def setup():
     """Test Module setup"""
     ComponentTestGitRepository.check_testdata(RPM_TEST_DATA_SUBMODULE)
 
+
+class RpmRepoTestBase(ComponentTestBase):
+    """Baseclass for tests run in a Git repository with packaging data"""
+
+    @classmethod
+    def setup_class(cls):
+        """Initializations only made once per test run"""
+        super(RpmRepoTestBase, cls).setup_class()
+        cls.manifest = RepoManifest(os.path.join(RPM_TEST_DATA_DIR,
+                                                 'test-repo-manifest.xml'))
+        cls.orig_repos = {}
+        for prj, brs in cls.manifest.projects_iter():
+            repo = GitRepository.create(os.path.join(cls._tmproot,
+                                        '%s.repo' % prj))
+            try:
+                repo.add_remote_repo('origin', RPM_TEST_DATA_DIR, fetch=True)
+            except GitRepositoryError:
+                # Workaround for older git working on submodules initialized
+                # with newer git
+                gitfile = os.path.join(RPM_TEST_DATA_DIR, '.git')
+                if os.path.isfile(gitfile):
+                    with open(gitfile) as fobj:
+                        link = fobj.readline().replace('gitdir:', '').strip()
+                    link_dir = os.path.join(RPM_TEST_DATA_DIR, link)
+                    repo.remove_remote_repo('origin')
+                    repo.add_remote_repo('origin', link_dir, fetch=True)
+                else:
+                    raise
+            # Fetch all remote refs of the orig repo, too
+            repo.fetch('origin', tags=True,
+                       refspec='refs/remotes/*:refs/upstream/*')
+            for branch, rev in brs.iteritems():
+                repo.create_branch(branch, rev)
+            repo.force_head('master', hard=True)
+            cls.orig_repos[prj] = repo
+
+    @classmethod
+    @nottest
+    def init_test_repo(cls, pkg_name):
+        """Initialize git repository for testing"""
+        dirname = os.path.basename(cls.orig_repos[pkg_name].path)
+        shutil.copytree(cls.orig_repos[pkg_name].path, dirname)
+        os.chdir(dirname)
+        return GitRepository('.')
+
 # vim:et:ts=4:sw=4:et:sts=4:ai:set list listchars=tab\:»·,trail\:·:
diff --git a/tests/component/rpm/data b/tests/component/rpm/data
-Subproject 90bf36d7981fdd1677cf7e734d9e1056a5fced1
+Subproject bae44ddc98ae0ed15ae078cb7c2fc597dee48da
diff --git a/tests/component/rpm/test_pq_rpm.py b/tests/component/rpm/test_pq_rpm.py
new file mode 100644
index 0000000..f0dac8d
--- /dev/null
+++ b/tests/component/rpm/test_pq_rpm.py
@@ -0,0 +1,358 @@
+# vim: set fileencoding=utf-8 :
+#
+# (C) 2013 Intel Corporation <markus.lehtonen@linux.intel.com>
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program; if not, write to the Free Software
+#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+"""Tests for the gbp pq-rpm tool"""
+
+import os
+import tempfile
+from nose.tools import assert_raises, eq_, ok_ # pylint: disable=E0611
+
+from gbp.scripts.pq_rpm import main as pq
+from gbp.git import GitRepository
+from gbp.command_wrappers import GitCommand
+
+from tests.component.rpm import RpmRepoTestBase
+
+# Disable "Method could be a function warning"
+# pylint: disable=R0201
+
+
+def mock_pq(args):
+    """Wrapper for pq"""
+    # Call pq-rpm with added arg0
+    return pq(['arg0'] + args)
+
+class TestPqRpm(RpmRepoTestBase):
+    """Basic tests for gbp-pq-rpm"""
+
+    def test_invalid_args(self):
+        """See that pq-rpm fails gracefully when called with invalid args"""
+        GitRepository.create('.')
+        # Test empty args
+        eq_(mock_pq([]), 1)
+        self._check_log(0, 'gbp:error: No action given.')
+        self._clear_log()
+
+        # Test invalid command
+        eq_(mock_pq(['mycommand']), 1)
+        self._check_log(0, "gbp:error: Unknown action 'mycommand'")
+        self._clear_log()
+
+        # Test invalid cmdline options
+        with assert_raises(SystemExit):
+            mock_pq(['--invalid-arg=123'])
+
+    def test_import_outside_repo(self):
+        """Run pq-rpm when not in a git repository"""
+        eq_(mock_pq(['export']), 1)
+        self._check_log(0, 'gbp:error: %s is not a git repository' %
+                              os.path.abspath(os.getcwd()))
+
+    def test_invalid_config_file(self):
+        """Test invalid config file"""
+        # Create dummy invalid config file and run pq-rpm
+        GitRepository.create('.')
+        with open('.gbp.conf', 'w') as conffd:
+            conffd.write('foobar\n')
+        eq_(mock_pq(['foo']), 1)
+        self._check_log(0, 'gbp:error: Invalid config file: File contains no '
+                           'section headers.')
+
+    def test_import_export(self):
+        """Basic test for patch import and export"""
+        repo = self.init_test_repo('gbp-test')
+        branches = repo.get_local_branches() + ['patch-queue/master']
+        # Test import
+        eq_(mock_pq(['import']), 0)
+        files = ['AUTHORS', 'dummy.sh', 'Makefile', 'NEWS', 'README',
+                 'mydir/myfile.txt']
+        branches.append('patch-queue/master')
+        self._check_repo_state(repo, 'patch-queue/master', branches, files)
+        eq_(repo.get_merge_base('upstream', 'patch-queue/master'),
+            repo.rev_parse('upstream'))
+        ok_(len(repo.get_commits('', 'upstream')) <
+            len(repo.get_commits('', 'patch-queue/master')))
+
+        # Test export
+        eq_(mock_pq(['export', '--upstream-tag',
+                     'srcdata/gbp-test/upstream/%(version)s']), 0)
+        files = ['.gbp.conf', '.gitignore', 'bar.tar.gz', 'foo.txt',
+                 'gbp-test.spec', '0001-my-gz.patch', '0002-my-bzip2.patch',
+                 '0003-my2.patch', 'my.patch']
+        self._check_repo_state(repo, 'master', branches, files)
+        eq_(repo.status()[' M'], ['gbp-test.spec'])
+
+        # Another export after removing some patches
+        os.unlink('0001-my-gz.patch')
+        eq_(mock_pq(['export']), 0)
+        self._check_repo_state(repo, 'master', branches, files)
+
+    def test_import_export2(self):
+        """Another test for import and export"""
+        repo = self.init_test_repo('gbp-test2')
+        branches = repo.get_local_branches() + ['patch-queue/master-orphan']
+        repo.set_branch('master-orphan')
+        # Import
+        eq_(mock_pq(['import']), 0)
+        files = ['dummy.sh', 'Makefile', 'README', 'mydir/myfile.txt']
+        self._check_repo_state(repo, 'patch-queue/master-orphan', branches,
+                               files)
+
+        # Test export
+        eq_(mock_pq(['export', '--upstream-tag',
+                     'srcdata/gbp-test2/upstream/%(version)s', '--spec-file',
+                     'packaging/gbp-test2.spec']), 0)
+        self._check_repo_state(repo, 'master-orphan', branches)
+        eq_(repo.status()[' M'], ['packaging/gbp-test2.spec'])
+
+    def test_rebase(self):
+        """Basic test for rebase action"""
+        repo = self.init_test_repo('gbp-test')
+        repo.rename_branch('pq/master', 'patch-queue/master')
+        repo.set_branch('patch-queue/master')
+        branches = repo.get_local_branches()
+        # Make development branch out-of-sync
+        GitCommand("rebase")(['--onto', 'upstream^', 'upstream'])
+        # Sanity check for our git rebase...
+        ok_(repo.get_merge_base('patch-queue/master', 'upstream') !=
+            repo.rev_parse('upstream'))
+
+        # Do rebase
+        eq_(mock_pq(['rebase']), 0)
+        self._check_repo_state(repo, 'patch-queue/master', branches)
+        ok_(repo.get_merge_base('patch-queue/master', 'upstream') ==
+            repo.rev_parse('upstream'))
+
+        # Get to out-of-sync, again, and try rebase from master branch
+        GitCommand("rebase")(['--onto', 'upstream^', 'upstream'])
+        eq_(mock_pq(['switch']), 0)
+        eq_(mock_pq(['rebase']), 0)
+        self._check_repo_state(repo, 'patch-queue/master', branches)
+        ok_(repo.get_merge_base('patch-queue/master', 'upstream') ==
+            repo.rev_parse('upstream'))
+
+    def test_switch(self):
+        """Basic test for switch action"""
+        repo = self.init_test_repo('gbp-test')
+        pkg_files = repo.list_files()
+        branches = repo.get_local_branches() + ['patch-queue/master']
+        # Switch to non-existent pq-branch should create one
+        eq_(mock_pq(['switch']), 0)
+        self._check_repo_state(repo, 'patch-queue/master', branches)
+
+        # Switch to base branch and back to pq
+        eq_(mock_pq(['switch']), 0)
+        self._check_repo_state(repo, 'master', branches)
+        eq_(mock_pq(['switch']), 0)
+        self._check_repo_state(repo, 'patch-queue/master', branches)
+
+    def test_switch_drop(self):
+        """Basic test for drop action"""
+        repo = self.init_test_repo('gbp-test')
+        repo.rename_branch('pq/master', 'patch-queue/master')
+        repo.set_branch('patch-queue/master')
+        branches = repo.get_local_branches()
+
+        # Drop pq should fail when on pq branch
+        eq_(mock_pq(['drop']), 1)
+        self._check_log(-1, "gbp:error: On a patch-queue branch, can't drop it")
+        self._check_repo_state(repo, 'patch-queue/master', branches)
+
+        # Switch to master
+        eq_(mock_pq(['switch']), 0)
+        self._check_repo_state(repo, 'master', branches)
+
+        # Drop should succeed when on master branch
+        eq_(mock_pq(['drop']), 0)
+        branches.remove('patch-queue/master')
+        self._check_repo_state(repo, 'master', branches)
+
+    def test_force_import(self):
+        """Test force import"""
+        repo = self.init_test_repo('gbp-test')
+        pkg_files = repo.list_files()
+        repo.rename_branch('pq/master', 'patch-queue/master')
+        repo.set_branch('patch-queue/master')
+        branches = repo.get_local_branches()
+        pq_files = repo.list_files()
+
+        # Re-import should fail
+        eq_(mock_pq(['import']), 1)
+        self._check_log(0, "gbp:error: Already on a patch-queue branch")
+        self._check_repo_state(repo, 'patch-queue/master', branches, pq_files)
+
+        # Mangle pq branch and try force import on top of that
+        repo.force_head('master', hard=True)
+        self._check_repo_state(repo, 'patch-queue/master', branches, pkg_files)
+        eq_(mock_pq(['import', '--force']), 0)
+        # .gbp.conf won't get imported by pq
+        pq_files.remove('.gbp.conf')
+        self._check_repo_state(repo, 'patch-queue/master', branches, pq_files)
+
+        # Switch back to master
+        eq_(mock_pq(['switch']), 0)
+        self._check_repo_state(repo, 'master', branches, pkg_files)
+
+        # Import should fail
+        eq_(mock_pq(['import']), 1)
+        self._check_log(-1, "gbp:error: Patch-queue branch .* already exists")
+        self._check_repo_state(repo, 'master', branches, pkg_files)
+
+        # Force import should succeed
+        eq_(mock_pq(['import', '--force']), 0)
+        self._check_repo_state(repo, 'patch-queue/master', branches, pq_files)
+
+    def test_apply(self):
+        """Basic test for apply action"""
+        repo = self.init_test_repo('gbp-test')
+        upstr_files = ['dummy.sh', 'Makefile', 'README']
+        branches = repo.get_local_branches() + ['patch-queue/master']
+
+        # No patch given
+        eq_(mock_pq(['apply']), 1)
+        self._check_log(-1, "gbp:error: No patch name given.")
+
+        # Create a pristine pq-branch
+        repo.create_branch('patch-queue/master', 'upstream')
+
+        # Apply patch
+        with tempfile.NamedTemporaryFile() as tmp_patch:
+            tmp_patch.write(repo.show('master:%s' % 'my.patch'))
+            tmp_patch.file.flush()
+            eq_(mock_pq(['apply', tmp_patch.name]), 0)
+            self._check_repo_state(repo, 'patch-queue/master', branches,
+                                   upstr_files)
+
+        # Apply another patch, now when already on pq branch
+        with tempfile.NamedTemporaryFile() as tmp_patch:
+            tmp_patch.write(repo.show('master:%s' % 'my2.patch'))
+            tmp_patch.file.flush()
+            eq_(mock_pq(['apply', tmp_patch.name]), 0)
+        self._check_repo_state(repo, 'patch-queue/master', branches,
+                               upstr_files + ['mydir/myfile.txt'])
+
+    def test_option_patch_numbers(self):
+        """Test the --patch-numbers cmdline option"""
+        repo = self.init_test_repo('gbp-test')
+        repo.rename_branch('pq/master', 'patch-queue/master')
+        branches = repo.get_local_branches()
+        # Export
+        eq_(mock_pq(['export', '--no-patch-numbers']), 0)
+        files = ['.gbp.conf', '.gitignore', 'bar.tar.gz', 'foo.txt',
+                 'gbp-test.spec', 'my-gz.patch', 'my-bzip2.patch', 'my2.patch',
+                 'my.patch']
+        self._check_repo_state(repo, 'master', branches, files)
+
+    def test_option_tmp_dir(self):
+        """Test the --tmp-dir cmdline option"""
+        self.init_test_repo('gbp-test')
+        eq_(mock_pq(['import', '--tmp-dir=foo/bar']), 0)
+        # Check that the tmp dir basedir was created
+        ok_(os.path.isdir('foo/bar'))
+
+    def test_option_upstream_tag(self):
+        """Test the --upstream-tag cmdline option"""
+        repo = self.init_test_repo('gbp-test')
+
+        # Non-existent upstream-tag -> failure
+        eq_(mock_pq(['import', '--upstream-tag=foobar/%(upstreamversion)s']), 1)
+        self._check_log(-1, "gbp:error: Couldn't find upstream version")
+
+        # Create tag -> import should succeed
+        repo.create_tag('foobar/1.1', msg="test tag", commit='upstream')
+        eq_(mock_pq(['import', '--upstream-tag=foobar/%(upstreamversion)s']), 0)
+
+    def test_option_spec_file(self):
+        """Test --spec-file commandline option"""
+        self.init_test_repo('gbp-test')
+
+        # Non-existent spec file should lead to failure
+        eq_(mock_pq(['import', '--spec-file=foo.spec']), 1)
+        self._check_log(-1, "gbp:error: Can't parse spec: Unable to read spec")
+        # Correct spec file
+        eq_(mock_pq(['import', '--spec-file=gbp-test.spec']), 0)
+
+        # Force import on top to test parsing spec from another branch
+        eq_(mock_pq(['import', '--spec-file=gbp-test.spec', '--force',
+                     '--upstream-tag',
+                     'srcdata/gbp-test/upstream/%(version)s']), 0)
+
+        # Test with export, too
+        eq_(mock_pq(['export', '--spec-file=foo.spec']), 1)
+        self._check_log(-1, "gbp:error: Can't parse spec: Unable to read spec")
+        eq_(mock_pq(['export', '--spec-file=gbp-test.spec']), 0)
+
+    def test_option_packaging_dir(self):
+        """Test --packaging-dir command line option"""
+        self.init_test_repo('gbp-test')
+
+        # Wrong packaging dir should lead to failure
+        eq_(mock_pq(['import', '--packaging-dir=foo']), 1)
+        self._check_log(-1, "gbp:error: Can't parse spec: No spec file found")
+        # Use correct packaging dir
+        eq_(mock_pq(['import', '--packaging-dir=.']), 0)
+
+        # Test with export, --spec-file option should override packaging dir
+        eq_(mock_pq(['export', '--packaging-dir=foo', '--upstream-tag',
+                     'srcdata/gbp-test/upstream/%(version)s',
+                     '--spec-file=gbp-test.spec']), 0)
+
+    def test_export_with_merges(self):
+        """Test exporting pq-branch with merge commits"""
+        repo = self.init_test_repo('gbp-test')
+        repo.rename_branch('pq/master', 'patch-queue/master')
+        repo.set_branch('patch-queue/master')
+        branches = repo.get_local_branches()
+
+        # Create a merge commit in pq-branch
+        patches = repo.format_patches('HEAD^', 'HEAD', '.')
+        repo.force_head('HEAD^', hard=True)
+        repo.commit_dir('.', 'Merge with master', 'patch-queue/master',
+                        ['master'])
+        merge_rev = repo.rev_parse('HEAD', short=7)
+        eq_(mock_pq(['apply', patches[0]]), 0)
+        upstr_rev = repo.rev_parse('upstream', short=7)
+        os.unlink(patches[0])
+
+        # Export should create diff up to the merge point and one "normal" patch
+        eq_(mock_pq(['export']), 0)
+        files = ['.gbp.conf', '.gitignore', 'bar.tar.gz', 'foo.txt',
+                 'gbp-test.spec', 'my.patch',
+                  '%s-to-%s.diff' % (upstr_rev, merge_rev), '0002-my2.patch']
+        self._check_repo_state(repo, 'master', branches, files)
+
+    def test_import_unapplicable_patch(self):
+        """Test import when a patch does not apply"""
+        repo = self.init_test_repo('gbp-test')
+        branches = repo.get_local_branches()
+        # Mangle patch
+        with open('my2.patch', 'w') as patch_file:
+            patch_file.write('-this-does\n+not-apply\n')
+        eq_(mock_pq(['import']), 1)
+        self._check_log(-2, "("
+                             "Aborting|"
+                             "Please, commit your changes or stash them|"
+                             "gbp:error: Import failed.* You have local changes"
+                            ")")
+        self._check_repo_state(repo, 'master', branches)
+
+        # Now commit the changes to the patch and try again
+        repo.add_files(['my2.patch'], force=True)
+        repo.commit_files(['my2.patch'], msg="Mangle patch")
+        eq_(mock_pq(['import']), 1)
+        self._check_log(-2, "gbp:error: Import failed: Error running git apply")
+        self._check_repo_state(repo, 'master', branches)
+