utils: new method for writing git tree-ish meta informat

Implement a new write_treeish_meta() function that writes meta
information about a git tree-ish into a file in json format.

Change-Id: I7f7b265be335fc2670c66d25f6c97516cae74e12
Signed-off-by: Markus Lehtonen <markus.lehtonen@linux.intel.com>

diff --git a/obs_service_gbp_utils/__init__.py b/obs_service_gbp_utils/__init__.py
index 14afe245c522b12f4b5647bd180405e41ee1c85b..0d67aeb9a5ea9fbd111a1a02d89a77bbf0f3d8d9 100644 (file)
--- a/obs_service_gbp_utils/__init__.py
+++ b/obs_service_gbp_utils/__init__.py
@@ -18,6 +18,7 @@
 # MA 02110-1301, USA.
 """Helper functionality for the GBP OBS source service"""
 
+import json
 import os
 import grp
 import pwd
@@ -95,3 +96,41 @@ def fork_call(user, group, func, *args, **kwargs):
     else:
         raise ret_data
 
+
+def _commit_info_in_json(repo, committish):
+    """Get info about a committish in json-serializable format"""
+    ret = {}
+    info = repo.get_commit_info(committish)
+    ret['sha1'] = repo.rev_parse('%s^0' % committish)
+    ret['subject'] = info['subject']
+    ret['body'] = info['body']
+    ret['author'] = {'name': info['author'].name,
+                     'email': info['author'].email,
+                     'date': info['author'].date}
+    ret['committer'] = {'name': info['committer'].name,
+                        'email': info['committer'].email,
+                        'date': info['committer'].date}
+    ret['files'] = info['files']
+    return ret
+
+def write_treeish_meta(repo, treeish, outdir, filename):
+    """Write all information about a treeish in json format to a file"""
+    meta = {'treeish': treeish}
+    obj_type = repo.get_obj_type(treeish)
+    if obj_type == 'tag':
+        meta['tag'] = repo.get_tag_info(treeish)
+    if obj_type in ('tag', 'commit'):
+        meta['commit'] = _commit_info_in_json(repo, treeish)
+
+    # No dir components allowed in filename
+    filepath = os.path.join(outdir, os.path.basename(filename))
+
+    if os.path.exists(filepath):
+        raise GbpServiceError("File '%s' already exists, refusing to "
+                              "overwrite" % filename)
+    try:
+        with open(filepath, 'w') as meta_fp:
+            json.dump(meta, meta_fp, indent=4)
+    except IOError as err:
+        raise GbpServiceError("Failed to write '%s': %s" % (filename, err))
+

diff --git a/tests/test_obs_service_gbp_utils.py b/tests/test_obs_service_gbp_utils.py
index 2bbc4869b38905195952f54447cca11b402db058..0f2b3ad12d8866bc88e9ee0c227963ad0a4db175 100644 (file)
--- a/tests/test_obs_service_gbp_utils.py
+++ b/tests/test_obs_service_gbp_utils.py
@@ -19,13 +19,17 @@
 """Tests for the GBP OBS service helper functionality"""
 
 import grp
+import json
 import pwd
 import os
 from nose.tools import assert_raises, eq_, ok_  # pylint: disable=E0611
 from multiprocessing import Queue
 
-from obs_service_gbp_utils import (fork_call, _demoted_child_call,
-                                   GbpServiceError, _RET_FORK_OK)
+from gbp_repocache import MirrorGitRepository
+from obs_service_gbp_utils import fork_call, _demoted_child_call, _RET_FORK_OK
+from obs_service_gbp_utils import GbpServiceError, write_treeish_meta
+
+from tests import UnitTestsBase
 
 
 class _DummyException(Exception):
@@ -109,3 +113,100 @@ class TestForkCall(object):
         with assert_raises(_DummyException):
             self._no_fork_call(self._uid, self._gid, self._dummy_raise)
 
+class TestGitMeta(UnitTestsBase):
+    """Test writing treeish meta into a file"""
+
+    @classmethod
+    def setup_class(cls):
+        """Set-up tests"""
+        # Fake committer and author
+        author = {'name': 'John Doe',
+                  'email': 'j@example.com',
+                  'date': '1390000000 +0200'}
+        os.environ['GIT_AUTHOR_NAME'] = author['name']
+        os.environ['GIT_AUTHOR_EMAIL'] = author['email']
+        os.environ['GIT_AUTHOR_DATE'] = author['date']
+        committer = {'name': 'Jane Doe',
+                     'email': 'j2@example.com',
+                     'date': '1391000000 +0200'}
+        os.environ['GIT_COMMITTER_NAME'] = committer['name']
+        os.environ['GIT_COMMITTER_EMAIL'] = committer['email']
+        os.environ['GIT_COMMITTER_DATE'] = committer['date']
+
+        # Initialize repo
+        super(TestGitMeta, cls).setup_class()
+        cls.repo = MirrorGitRepository.clone('myrepo', cls._template_repo.path)
+
+        # Create test tag
+        cls.repo.create_tag('tag', msg='Subject\n\nBody')
+
+        # Reference meta
+        cls.tag_meta = {'sha1': cls.repo.rev_parse('tag'),
+                        'tagger': committer,
+                        'subject': 'Subject',
+                        'body': 'Body\n'}
+
+        commit = cls.repo.rev_parse('tag^0')
+        cls.commit_meta = {'sha1': commit,
+                           'author': author,
+                           'committer': committer,
+                           'subject': 'Add debian packaging files',
+                           'body': '',
+                           'files':
+                                {'A': ['debian/changelog', 'debian/control']}}
+
+    @classmethod
+    def teardown_class(cls):
+        """Clean-up"""
+        del os.environ['GIT_AUTHOR_NAME']
+        del os.environ['GIT_AUTHOR_EMAIL']
+        del os.environ['GIT_AUTHOR_DATE']
+        del os.environ['GIT_COMMITTER_NAME']
+        del os.environ['GIT_COMMITTER_EMAIL']
+        del os.environ['GIT_COMMITTER_DATE']
+        super(TestGitMeta, cls).teardown_class()
+
+    def test_tag(self):
+        """Test meta from tag object"""
+        write_treeish_meta(self.repo, 'tag', '.', 'meta1.txt')
+        # Read back and check
+        with open('meta1.txt') as meta_fp:
+            meta = json.load(meta_fp)
+        eq_(meta['treeish'], 'tag')
+        eq_(meta['tag'], self.tag_meta)
+        eq_(meta['commit'], self.commit_meta)
+
+    def test_commit(self):
+        """Test meta from commit object"""
+        write_treeish_meta(self.repo, 'HEAD', '.', 'meta2.txt')
+        # Read back and check
+        with open('meta2.txt') as meta_fp:
+            meta = json.load(meta_fp)
+        eq_(meta['treeish'], 'HEAD')
+        ok_('tag' not in meta)
+        eq_(meta['commit'], self.commit_meta)
+
+    def test_tree(self):
+        """Test meta from tree object"""
+        tree = self.repo.write_tree()
+        write_treeish_meta(self.repo, tree, '.', 'meta3.txt')
+        # Read back and check
+        with open('meta3.txt') as meta_fp:
+            meta = json.load(meta_fp)
+        eq_(meta['treeish'], tree)
+        ok_('tag' not in meta)
+        ok_('commit' not in meta)
+
+    def test_failures(self):
+        write_treeish_meta(self.repo, 'HEAD', '.', 'meta4.txt')
+
+        # Overwriting existing file should fail and not change file
+        orig_stat = os.stat('meta4.txt')
+        with assert_raises(GbpServiceError):
+            write_treeish_meta(self.repo, 'tag', '.', 'meta4.txt')
+        eq_(os.stat('meta4.txt'), orig_stat)
+
+        # Non-existent dir -> failure
+        with assert_raises(GbpServiceError):
+            write_treeish_meta(self.repo, 'tag', 'non-existent-dir', 'meta.txt')
+