Merge ~zhsj/+git/pkgbinarymangler:lp2002871 into ~ubuntu-core-dev/+git/pkgbinarymangler:master

[Shengjing Zhu]

[Gunnar Hjalmarsson (gunnarhj)]

Approving this based on the short conversation here:

https://irclogs.ubuntu.com/2023/02/21/%23ubuntu-devel.html#t10:37

review: Approve

diff --git a/debian/changelog b/debian/changelog
index ac61184..cda2d25 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,9 +1,8 @@
-pkgbinarymangler (152) UNRELEASED; urgency=medium
+pkgbinarymangler (152) lunar; urgency=medium
 
   [ Shengjing Zhu ]
-  * pkgstripfiles: no longer strip debian changelog.
-    It's now enabled by default in debhelper >= 13.10. But debhelper
-    strips debian changelog for PPA as well.
+  * pkgstripfiles: only strip debian changelog if debhelper hasn't done so.
+    debhelper >= 13.10 strips debian changelog by default.
 
   [ Gunnar Hjalmarsson ]
   * Add VCS fields
diff --git a/pkgstripfiles b/pkgstripfiles
index a0ea6dd..ed68b9b 100755
--- a/pkgstripfiles
+++ b/pkgstripfiles
@@ -29,6 +29,38 @@ clean_upstream_changelogs()
 }
 
 #
+# Only keep the topmost ten entries in Debian changelogs. If we truncate, add a
+# pointer to apt-get changelog.
+#
+strip_debian_changelogs()
+{
+    record_sep="^[^ ]+ (.*) .*; urgency"
+    if [ -e "$dch" -a ! -L "$dch" ]; then
+	if zgrep -q "Older entries have been removed from this changelog." $dch;
+	    # already stripped by debhelper >= 13.10
+	    then return;
+	fi
+	record_count=0
+	changelog=""
+	gzip -cd $dch | (while read; do
+	    if [[ "$REPLY" =~ $record_sep ]]; then
+		((++record_count))
+		if [ "$record_count" -eq 11 ]; then
+		    echo "pkgstripfiles: Truncating $dch to topmost ten records"
+		    echo -e "${changelog}# For older changelog entries, run 'apt-get changelog $PKGNAME'" | gzip -9n > $dch
+		    if [ -f DEBIAN/md5sums ]; then
+			MD5=`md5sum "$dch"`
+			sed -i "s%^.*  $dch\$%$MD5%" DEBIAN/md5sums
+		    fi
+		    break
+		fi
+	    fi
+	    changelog="$changelog$REPLY\n"
+	done)
+    fi
+}
+
+#
 # Optimize PNGs
 #
 optimize_pngs()
@@ -269,6 +301,7 @@ trap clear_lock 1 2 3 7 10 13 15
 wait_for_lock
 
 symlink_doc
+strip_debian_changelogs
 optimize_pngs
 
 clear_lock
diff --git a/test/icecream/debian/rules b/test/icecream/debian/rules
index bc499e3..3f0cd14 100755
--- a/test/icecream/debian/rules
+++ b/test/icecream/debian/rules
@@ -1,4 +1,5 @@
 #!/usr/bin/make -f
+
 %:
 	dh $@ --with translations --parallel
 
diff --git a/test/run b/test/run
index 3a7da50..ca78a06 100755
--- a/test/run
+++ b/test/run
@@ -555,8 +555,6 @@ Purpose: PRIMARY
     def test_debian_changelog_truncation(self):
         '''Long Debian changelog gets truncated'''
 
-        # debian changelog truncations is moved to debhelper but the tests have been kept.
-
         # change into non-native package
         cpath = os.path.join(self.pkgdir, 'debian', 'changelog')
         with open(cpath) as f:
@@ -566,7 +564,7 @@ Purpose: PRIMARY
         f.write(''.join(contents))
         f.close()
 
-        self.build()
+        self.build(extra_env={'DEB_BUILD_OPTIONS': 'notrimdch'})
         self.check_deb_stripfiles(False)
 
         deb = glob(os.path.join(self.workdir, 'vanilla_12*_*.deb'))[0]
@@ -577,16 +575,15 @@ Purpose: PRIMARY
         self.assertEqual(err, b'')
         self.assertIn('icecream (12-1)', out)
         self.assertIn('\n  * release 12', out)
+        self.assertIn('icecream (3)', out)
         self.assertNotIn('icecream (2)', out)
         self.assertNotIn('icecream (1)', out)
-        self.assertIn('apt changelog', out)
+        self.assertIn('apt-get changelog', out)
 
     def test_native_changelog_truncation(self):
         '''Long Debian changelog for native packages gets truncated'''
 
-        # debian changelog truncations is moved to debhelper but the tests have been kept.
-
-        self.build()
+        self.build(extra_env={'DEB_BUILD_OPTIONS': 'notrimdch'})
         self.check_deb_stripfiles(False)
 
         deb = glob(os.path.join(self.workdir, 'vanilla_12*_*.deb'))[0]
@@ -597,9 +594,10 @@ Purpose: PRIMARY
         self.assertEqual(err, b'')
         self.assertIn('icecream (12)', out)
         self.assertIn('\n  * release 12', out)
+        self.assertIn('icecream (3)', out)
         self.assertNotIn('icecream (2)', out)
         self.assertNotIn('icecream (1)', out)
-        self.assertIn('apt changelog', out)
+        self.assertIn('apt-get changelog', out)
 
     def test_native_changelog_truncation_symlink(self):
         '''Long Debian changelog for native packages with symlinked doc dir'''
@@ -615,7 +613,7 @@ override_dh_installdocs:
 	ln -s vanilla-base debian/vanilla/usr/share/doc/vanilla
 ''')
 
-        self.build()
+        self.build(extra_env={'DEB_BUILD_OPTIONS': 'notrimdch'})
 
         deb = glob(os.path.join(self.workdir, 'vanilla_12*_*.deb'))[0]
         dpkg = subprocess.Popen('dpkg-deb --fsys-tarfile %s | tar xO ./usr/share/doc/vanilla-base/changelog.gz | gzip -cd' % deb,
@@ -630,8 +628,6 @@ override_dh_installdocs:
     def test_short_debian_changelog(self):
         '''Short Debian changelog remains unaltered'''
 
-        # debian changelog truncations is moved to debhelper but the tests have been kept.
-
         # change into non-native package
         cpath = os.path.join(self.pkgdir, 'debian', 'changelog')
         with open(cpath) as f:
@@ -640,7 +636,7 @@ override_dh_installdocs:
         with open(cpath, 'w') as f:
             f.write(''.join(contents))
 
-        self.build()
+        self.build(extra_env={'DEB_BUILD_OPTIONS': 'notrimdch'})
         self.check_deb_stripfiles(False)
 
         deb = glob(os.path.join(self.workdir, 'vanilla_12*_*.deb'))[0]
@@ -652,13 +648,11 @@ override_dh_installdocs:
         self.assertIn('icecream (12-1)', out)
         self.assertIn('icecream (11)', out)
         self.assertNotIn('icecream (10)', out)
-        self.assertNotIn('apt changelog', out)
+        self.assertNotIn('apt-get changelog', out)
 
     def test_short_native_changelog(self):
         '''Short Debian changelog for native packages remains unaltered'''
 
-        # debian changelog truncations is moved to debhelper but the tests have been kept.
-
         # truncate changelog
         cpath = os.path.join(self.pkgdir, 'debian', 'changelog')
         with open(cpath) as f:
@@ -666,7 +660,7 @@ override_dh_installdocs:
         with open(cpath, 'w') as f:
             f.write(''.join(contents))
 
-        self.build()
+        self.build(extra_env={'DEB_BUILD_OPTIONS': 'notrimdch'})
         self.check_deb_stripfiles(False)
 
         deb = glob(os.path.join(self.workdir, 'vanilla_12*_*.deb'))[0]
@@ -678,7 +672,54 @@ override_dh_installdocs:
         self.assertIn('icecream (12)', out)
         self.assertIn('icecream (11)', out)
         self.assertNotIn('icecream (10)', out)
-        self.assertNotIn('apt changelog', out)
+        self.assertNotIn('apt-get changelog', out)
+
+    def test_ppa_debian_changelog(self):
+        '''Debian changelog in PPA build remains unaltered'''
+
+        self.buildinfo = '''Package: icecream
+Component: main
+Suite: lucid
+Purpose: PPA
+'''
+
+        # change into non-native package
+        cpath = os.path.join(self.pkgdir, 'debian', 'changelog')
+        with open(cpath) as f:
+            contents = f.readlines()
+        contents[0] = contents[0].replace('(12)', '(12-1)')
+        with open(cpath, 'w') as f:
+            f.write(''.join(contents))
+
+        self.build(extra_env={'DEB_BUILD_OPTIONS': 'notrimdch'})
+        self.check_deb_stripfiles(True)
+
+        deb = glob(os.path.join(self.workdir, 'vanilla_12*_*.deb'))[0]
+        dpkg = subprocess.Popen('dpkg-deb --fsys-tarfile %s | tar xO ./usr/share/doc/vanilla/changelog.Debian.gz | gzip -cd' % deb,
+                                shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        (out, err) = dpkg.communicate()
+        out = out.decode()
+        self.assertEqual(err, b'')
+        self.assertIn('icecream (12-1)', out)
+        self.assertIn('icecream (11)', out)
+        self.assertIn('icecream (1)', out)
+        self.assertNotIn('apt-get changelog', out)
+
+    def test_debian_changelog_truncation_by_debhelper(self):
+        '''Long Debian changelog gets truncated by debhelper'''
+
+        self.build(extra_env={'DEB_BUILD_OPTIONS': 'trimdch'})
+
+        deb = glob(os.path.join(self.workdir, 'vanilla_12*_*.deb'))[0]
+        dpkg = subprocess.Popen('dpkg-deb --fsys-tarfile %s | tar xO ./usr/share/doc/vanilla/changelog.gz | gzip -cd' % deb,
+                                shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        (out, err) = dpkg.communicate()
+        out = out.decode()
+        self.assertEqual(err, b'')
+        self.assertNotIn('icecream (1)', out)
+        # we use "apt-get changelog"; but debhelper use "apt changelog"
+        self.assertIn('apt changelog', out)
+        self.assertNotIn('apt-get changelog', out)
 
     def test_png_shrinking(self):
         '''PNGs get optimized, and non-PNGs unmodified'''