Merge lp:~sil2100/cupstream2distro/whitelist_symbols_refresh into lp:cupstream2distro

[Łukasz Zemczak]

Change the refresh_package_versions() method to only update symbols in selected, whitelisted files. The debian/ directory can generally even ship with binaries in it, so replacing any file that's in the directory can potentially be very risky.

Change the refresh_package_versions() method to only update symbols in selected, whitelisted files. The debian/ directory can generally even ship with binaries in it, so replacing any file that's in the directory can potentially be very risky.
Barry already encountered a problem where the train barfed out trying to interpret a binary blob from debian/ as UTF-8.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:981
http://jenkins.qa.ubuntu.com/job/cu2d-choo-choo-ci/641/
Executed test runs:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/cu2d-choo-choo-ci/641/rebuild

review: Approve (continuous-integration)

[Barry Warsaw (barry)]

LGTM. The symbols globs might be a bit too wide, but I guess if that's ever a problem you can deal with it then.

review: Approve

[Łukasz Zemczak (sil2100)]

Tested on staging, looks fine - merging.

=== modified file 'cupstream2distro/packagemanager.py'
--- cupstream2distro/packagemanager.py	2015-03-16 02:14:52 +0000
+++ cupstream2distro/packagemanager.py	2015-05-11 17:56:40 +0000
@@ -171,14 +171,23 @@
                     return 'no-rewrite-version' in line
 
     def refresh_package_versions(self, version, tag='0replaceme'):
-        """Replace 0replaceme with real versions in any debian/* files.
+        """Replace 0replaceme with real versions in selected debian/ files.
 
         :param version: The version to insert.
         """
-        logging.info('Refreshing versions in debian/* files.')
+        logging.info('Refreshing versions in selected debian/ files.')
         replaced = set()
         upstream = V(version).get_upstream(epoch=True)
-        for path in glob(os_path_join_safe(self.debian, '*')):
+
+        whitelist = [
+            '*.symbols*', 'symbols*', 'rules',
+            'control', 'changelog', 'copyright'
+        ]
+        files = []
+        for entry in whitelist:
+            files.extend(glob(os_path_join_safe(self.debian, entry)))
+
+        for path in files:
             if os.path.isfile(path) and not os.path.islink(path):
                 for line, new in utf8_inplace(path):
                     if tag in line:

=== added file 'tests/data/results/simple_update_alone_arch.changelog'
--- tests/data/results/simple_update_alone_arch.changelog	1970-01-01 00:00:00 +0000
+++ tests/data/results/simple_update_alone_arch.changelog	2015-05-11 17:56:40 +0000
@@ -0,0 +1,12 @@
+foo (42.0daily83.09.13-0ubuntu2) UNRELEASED; urgency=low
+
+  * debian/symbols.amd64: update to released version.
+
+ -- CI Train Bot <[e-mail]>  Fri, 08 Mar 2013 16:33:04 +0100
+
+foo (42.0daily83.09.13-0ubuntu1) raring; urgency=low
+
+  * We snapshotted it for please
+  * Automatic snapshot from revision 1
+
+ -- Automatic Didrocks uploader <[e-mail]>  Fri, 13 Sep 1983 04:02:00 +0000

=== modified file 'tests/unit/test_packagemanager.py'
--- tests/unit/test_packagemanager.py	2015-03-16 02:14:52 +0000
+++ tests/unit/test_packagemanager.py	2015-05-11 17:56:40 +0000
@@ -620,6 +620,18 @@
         self.assertChangelogFilesAreIdenticals(result_changelog, changelog)
         self.assertFilesAreIdenticals(symbols, result_symbols)
 
+    def test_refresh_symbols_files_alone_symbol_with_arch(self):
+        """Update a symbols.arch file."""
+        changelog = self.prep_debian_file('changelog', s.BASE_CHANGELOG)
+        symbols = self.prep_debian_file('symbols.amd64', s.BASIC_SYMBOLS)
+        self.package.refresh_package_versions('42.0daily83.09.14-0ubuntu1')
+        result_symbols = os_path_join_safe(
+            self.result_dir, 'simple_update.symbols')
+        result_changelog = os_path_join_safe(
+            self.result_dir, 'simple_update_alone_arch.changelog')
+        self.assertFilesAreIdenticals(symbols, result_symbols)
+        self.assertChangelogFilesAreIdenticals(result_changelog, changelog)
+
     def test_dont_refresh_symbols_files_for_directory(self):
         """We don't fail for directories under debian/."""
         self.prep_debian_file('changelog', s.DUMMY_CHANGELOG)
@@ -639,3 +651,11 @@
         self.package.refresh_package_versions('42.0daily83.09.14-0ubuntu1')
         self.assertTrue(os.path.islink(symlink_path))
         self.assertEqual('foo.symbols', os.readlink(symlink_path))
+
+    def test_dont_refresh_symbols_files_for_others(self):
+        """We don't update unrelated files under debian/."""
+        self.prep_debian_file('changelog', s.BASE_CHANGELOG)
+        other = self.prep_debian_file('almostbinary', s.BASIC_SYMBOLS)
+        self.package.refresh_package_versions('42.0daily83.09.14-0ubuntu1')
+        with utf8_open(other) as fd:
+            self.assertEqual(fd.read(), s.BASIC_SYMBOLS)