rpm-ch: implement --meta-bts option
authorMarkus Lehtonen <markus.lehtonen@linux.intel.com>
Fri, 6 Jun 2014 09:40:32 +0000 (12:40 +0300)
committerMarkus Lehtonen <markus.lehtonen@linux.intel.com>
Tue, 3 Mar 2015 08:07:47 +0000 (10:07 +0200)
This gives the user the possibility to define what meta tags (in git
commit message) git-rpm-ch recognizes as bug tracking system references.
Or, makes it possible to disable bts meta tag tracking altogether.

Signed-off-by: Markus Lehtonen <markus.lehtonen@linux.intel.com>
gbp/config.py
gbp/rpm/policy.py
gbp/scripts/rpm_ch.py
tests/component/rpm/test_rpm_ch.py

index ff0fba9ae7af6d244dbe80244d28260fbdcb0184..acbc0465397b204e940ed821524111befe810658 100644 (file)
@@ -633,6 +633,7 @@ class GbpOptionParserRpm(GbpOptionParser):
             'changelog-revision'        : '',
             'spawn-editor'              : 'always',
             'editor-cmd'                : 'vim',
+            'meta-bts'                  : '(Close|Closes|Fixes|Fix)',
                     })
 
     help = dict(GbpOptionParser.help)
@@ -708,6 +709,8 @@ class GbpOptionParserRpm(GbpOptionParser):
             'git-author':
                 "Use name and email from git-config for the changelog header, "
                 "default is '%(git-author)s'",
+            'meta-bts':
+                "Meta tags for the bts commands, default is '%(meta-bts)s'",
                  })
 
 # vim:et:ts=4:sw=4:et:sts=4:ai:set list listchars=tab\:»·,trail\:·:
index 2fa2423dd68d3bc723d000a780c5ff54fff04f6f..fab6393fc6be45b89cf6ea95b470fa2cb726eeeb 100644 (file)
@@ -97,8 +97,6 @@ class RpmPkgPolicy(PkgPolicy):
 
         # Maximum length for a changelog entry line
         max_entry_line_length = 76
-        # Bug tracking system related meta tags recognized from git commit msg
-        bts_meta_tags = ("Close", "Closes", "Fixes", "Fix")
         # Regexp for matching bug tracking system ids (e.g. "bgo#123")
         bug_id_re = r'[A-Za-z0-9#_\-]+'
 
@@ -110,15 +108,18 @@ class RpmPkgPolicy(PkgPolicy):
 
             @param lines: commit message
             @type lines: C{list} of C{str}
-            @param meta_tags: meta tags to look for
-            @type meta_tags: C{tuple} of C{str}
+            @param meta_tags: meta tags (regexp) to look for
+            @type meta_tags: C{str}
             @return: bts-ids per meta tag and the non-mathced lines
             @rtype: (C{dict}, C{list} of C{str})
             """
+            if not meta_tags:
+                return ({}, lines[:])
+
             tags = {}
             other_lines = []
-            bts_re = re.compile(r'^(?P<tag>%s):\s*(?P<ids>.*)' %
-                                ('|'.join(meta_tags)), re.I)
+            bts_re = re.compile(r'^(?P<tag>%s):\s*(?P<ids>.*)' % meta_tags,
+                                re.I)
             bug_id_re = re.compile(cls.bug_id_re)
             for line in lines:
                 match = bts_re.match(line)
@@ -175,7 +176,7 @@ class RpmPkgPolicy(PkgPolicy):
                 return None
 
             # Parse and filter out bts-related meta-tags
-            bts_tags, body = cls._parse_bts_tags(body, cls.bts_meta_tags)
+            bts_tags, body = cls._parse_bts_tags(body, kwargs['meta_bts'])
 
             # Additional filtering
             body = cls._extra_filter(body, kwargs['ignore_re'])
index 65cfef2cca8f3eea7860131570ffb34efe780206..ab4cdd200459b0f29b3627df4984ffe6398c4e49 100755 (executable)
@@ -284,7 +284,8 @@ def entries_from_commits(changelog, repo, commits, options):
     for commit in commits:
         info = repo.get_commit_info(commit)
         entry_text = ChangelogEntryFormatter.compose(info, full=options.full,
-                        ignore_re=options.ignore_regex, id_len=options.idlen)
+                        ignore_re=options.ignore_regex, id_len=options.idlen,
+                        meta_bts=options.meta_bts)
         if entry_text:
             entries.append(changelog.create_entry(author=info['author'].name,
                                                   text=entry_text))
@@ -442,6 +443,7 @@ def build_parser(name):
                     help="use all commits from the Git history, overrides "
                          "--since")
     # Formatting group options
+    format_grp.add_config_file_option(option_name="meta-bts", dest="meta_bts")
     format_grp.add_option("--no-release", action="store_false", default=True,
                     dest="release",
                     help="no release, just update the last changelog section")
index e8f9b71170ed1b9f8421227b3e0b7511c1543073..ce82653eabdc5c886405481edb84e0060d1f2488 100644 (file)
@@ -181,6 +181,26 @@ class TestRpmCh(RpmRepoTestBase):
 
         eq_(mock_ch(['--packaging-branch=foo', '--ignore-branch']), 0)
 
+    def test_option_meta_bts(self):
+        """Test parsing of the bts meta tags"""
+        repo = self.init_test_repo('gbp-test-native')
+
+        # Create a dummy commit that references bts
+        with open('new-file', 'w') as fobj:
+            fobj.write('foobar\n')
+        repo.add_files('new-file')
+        repo.commit_all('Fix\n\nCloses: #123\nFixes: #456\n Fixes: #789')
+
+        eq_(mock_ch(['--since=HEAD^']), 0)
+        content = self.read_file('packaging/gbp-test-native.changes')
+        # rpm-ch shouldn't have picked the ref with leading whitespace
+        eq_(content[1], '- Fix (Closes: #123) (Fixes: #456)\n')
+
+        # Check the --meta-bts option
+        eq_(mock_ch(['--since=HEAD^', '--meta-bts=Fixes']), 0)
+        content = self.read_file('packaging/gbp-test-native.changes')
+        eq_(content[1], '- Fix (Fixes: #456)\n')
+
     def test_option_no_release(self):
         """Test the --no-release cmdline option"""
         self.init_test_repo('gbp-test-native')