Merge ~ahasenack/ubuntu/+source/python-certbot:xenial-certbot-backport-1837673 into ubuntu/+source/python-certbot:ubuntu/cosmic-devel

[Andreas Hasenack]

Backport cosmic's python-certbot to xenial.

Bileto with ppa: https://bileto.ubuntu.com/#/ticket/3824

I'm not sure if we can use an MP for this, or if I used it correctly. I grabbed the cosmic package, and added the work to get it to build and function in xenial. That means I can't proposed this against xenial-devel, as there will be conflicts.

For this review, I suggest to view the differences between the current xenial package and this proposed one, and the current cosmic package and this proposed one. That will show what I changed from the cosmic package, and what changed in xenial when compared to what was there before.

This backport required more work, as xenial doesn't have all the python3 build-dependencies needed by this cosmic package. Upstream said it would be fine to have python2 packages only[1], but this means extra care should be taken when reviewing this.

Therefore the big list of changes is:
- drop py3 packages and use py2 only (and associated changes)
- add patch to allow building with sphinx 1.6
- downgrade debhelper from 11 to 9, which is what is available in xenial. That had other consequences, most notably around the systemd debhelpers.

The cosmic package has a lintian override for python3-certbot. I changed that to pyhon-certbot, since we are no longer producing the py3 version. This lintian warning/error doesn't seem to apply to xenial, but I opted to keep it just because it was there in the cosmic version. It is a delta when this package is compared to the one currently in xenial, though, so let me know if you'd rather have me drop that.

1. https://bugs.launchpad.net/ubuntu/+source/python-certbot/+bug/1837673/comments/8

[Andreas Hasenack (ahasenack)]

rbasak gave a +1 for hash 2fbc42e

<rbasak> ahasenack: +1 for both your acme and certbot branches, both for peer review and also for SRU accept
<rbasak> ahasenack: would you like to upload them? If you're not around, I can "sponsor" them
<ahasenack> rbasak: I'm here
<ahasenack> rbasak: I'll do it in a bit, could you please just confirm the hashes you +1ed?
<ahasenack> maybe in the ~canonical-server mps, for certbot?
<rbasak> ahasenack: actually the MPs for certbot have the wrong target branches, so I was ignoring them.
<rbasak> Let me put the hashes here
<ahasenack> rbasak: I wasn't sure how to target correctly, since these are backports
<ahasenack> I started from, say, cosmic-devel, and added changes for it to build on, say, xenial
<ahasenack> but that won't merge with xenial, there will be conflicts
<rbasak> acme: xenial 0907ce1; bionic 68149a9; disco a928edd
<rbasak> certbot: xenial 2fbc42e; bionic 97de715
<rbasak> I will check that the uploads match those before SRU accept
<rbasak> ("git ubuntu queue sync" makes it easy)
<rbasak> ahasenack: maybe best to avoid upload tags on these then?
<rbasak> I would base on the unapplied import tags of the backport source versions to preserve history.
<rbasak> I thought you did that for certbot at least
<rbasak> IIRC the acme branches are based on Debian VCS which won't be in git-ubuntu
<ahasenack> rbasak: right, acme I didn't start over
<rbasak> I suggest upload tags for certbot then, but not acme
<rbasak> (to be clear, you did exactly what I'd expect)

review: Approve

[Andreas Hasenack (ahasenack)]

This migrated

diff --git a/debian/changelog b/debian/changelog
index e1c9097..50da3f2 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,25 @@
+python-certbot (0.27.0-1~ubuntu16.04.1) xenial; urgency=medium
+
+  * Backport to xenial (LP: #1837673):
+    - d/control, d/compat: go back to debhelper 9, and drop R³
+    - d/p/0002-revert-sphinx-1.6-requirement.patch: revert upstream change
+      that allows build with sphinx 1.6
+    - d/control: drop requirement on version 1.6 or higher of sphinx
+    - d/control, d/rules: go back to python2
+    - d/python-certbot-doc.doc-base: go back to the py2 package
+    - d/python-certbot.lintian-overrides: go back to python2
+    - d/rules: add systemd to debhelper, since it's not automatic on this
+      dh level
+    - d/control: build-dep on systemd
+    - d/rules: no need to explicitly install examples/docs
+    - d/rules: install certbot.timer as dh-systemd in Xenial doesn't do it
+    - d/rules: go back to dh_systemd_enable and dh_systemd_start since
+      dh_installsystemd is only available in debhelper 11 and later
+    - d/letsencrypt.postrm: purging the transitional package shouldn't
+      remove the logs (Closes: #921423)
+
+ -- Andreas Hasenack <[e-mail]>  Thu, 17 Oct 2019 21:03:01 +0000
+
 python-certbot (0.27.0-1) unstable; urgency=medium
 
   * New upstream version 0.27.0
diff --git a/debian/compat b/debian/compat
index b4de394..ec63514 100644
--- a/debian/compat
+++ b/debian/compat
@@ -1 +1 @@
-11
+9
diff --git a/debian/control b/debian/control
index 4ee6e91..ef9c127 100644
--- a/debian/control
+++ b/debian/control
@@ -1,42 +1,43 @@
 Source: python-certbot
 Section: python
 Priority: optional
-Maintainer: Debian Let's Encrypt <[e-mail]>
+Maintainer: Ubuntu Developers <[e-mail]>
+XSBC-Original-Maintainer: Debian Let's Encrypt <[e-mail]>
 Uploaders: Harlan Lieberman-Berg <[e-mail]>,
            Francois Marier <[e-mail]>
-Build-Depends: debhelper (>= 11~),
+Build-Depends: debhelper (>= 9~),
+               dh-systemd (>= 1.5),
                dh-python,
-               python3,
-               python3-acme (>= 0.26.0~),
-               python3-configargparse (>= 0.10.0),
-               python3-configobj,
-               python3-cryptography (>= 1.2),
-	       python3-distutils | python3 (<< 3.6.5~),
-	       python3-josepy,
-               python3-mock,
-               python3-parsedatetime (>= 1.3),
-               python3-repoze.sphinx.autointerface,
-               python3-requests (>= 2.4.3),
-               python3-rfc3339,
-               python3-setuptools (>= 1.0),
-               python3-sphinx (>= 1.6),
-               python3-sphinx-rtd-theme,
-               python3-tz,
-               python3-zope.component,
-               python3-zope.interface
+               python,
+               python-acme (>= 0.26.0~),
+               python-configargparse (>= 0.10.0),
+               python-configobj,
+               python-cryptography (>= 1.2),
+	       python-distutils | python (<< 3.6.5~),
+	       python-josepy,
+               python-mock,
+               python-parsedatetime (>= 1.3),
+               python-repoze.sphinx.autointerface,
+               python-requests (>= 2.4.3),
+               python-rfc3339,
+               python-setuptools (>= 1.0),
+               python-sphinx,
+               python-sphinx-rtd-theme,
+               python-tz,
+               python-zope.component,
+               python-zope.interface
 Standards-Version: 4.2.1
 Homepage: https://certbot.eff.org/
 Vcs-Git: https://salsa.debian.org/letsencrypt-team/certbot/certbot.git
 Vcs-Browser: https://salsa.debian.org/letsencrypt-team/certbot/certbot
 Testsuite: autopkgtest-pkg-python
-Rules-Requires-Root: no
 
-Package: python3-certbot
+Package: python-certbot
 Architecture: all
-Depends: python3-acme (>= 0.25.0~),
-         python3-requests (>= 2.4.3),
+Depends: python-acme (>= 0.25.0~),
+         python-requests (>= 2.4.3),
          ${misc:Depends},
-         ${python3:Depends}
+         ${python:Depends}
 Recommends: certbot
 Suggests: python-certbot-doc
 Breaks: python-certbot-nginx (<< 0.20.0),
@@ -63,14 +64,14 @@ Description: main library for certbot
 Package: certbot
 Section: web
 Architecture: all
-Depends: python3-certbot (= ${source:Version}),
+Depends: python-certbot (= ${source:Version}),
          ${misc:Depends},
-         ${python3:Depends}
+         ${python:Depends}
 Breaks: letsencrypt (<= 0.6.0)
 Replaces: letsencrypt
 Provides: letsencrypt
-Suggests: python3-certbot-apache,
-	  python3-certbot-nginx,
+Suggests: python-certbot-apache,
+	  python-certbot-nginx,
           python-certbot-doc
 Description: automatically configure HTTPS using Let's Encrypt
  The objective of Certbot, Let's Encrypt, and the ACME (Automated
diff --git a/debian/letsencrypt.postrm b/debian/letsencrypt.postrm
 deleted file mode 100755
index 42ae566..0000000
--- a/debian/letsencrypt.postrm
+++ /dev/null
@@ -1,41 +0,0 @@
-#!/bin/sh
-# postrm script for letsencrypt
-#
-# see: dh_installdeb(1)
-
-set -e
-
-# summary of how this script can be called:
-#        * <postrm> `remove'
-#        * <postrm> `purge'
-#        * <old-postrm> `upgrade' <new-version>
-#        * <new-postrm> `failed-upgrade' <old-version>
-#        * <new-postrm> `abort-install'
-#        * <new-postrm> `abort-install' <old-version>
-#        * <new-postrm> `abort-upgrade' <old-version>
-#        * <disappearer's-postrm> `disappear' <overwriter>
-#          <overwriter-version>
-# for details, see https://www.debian.org/doc/debian-policy/ or
-# the debian-policy package
-
-
-case "$1" in
-    purge)
-        rm -rf /var/log/letsencrypt
-    ;;
-
-    remove|upgrade|failed-upgrade|abort-install|abort-upgrade|disappear)
-    ;;
-
-    *)
-        echo "postrm called with unknown argument \`$1'" >&2
-        exit 1
-    ;;
-esac
-
-# dh_installdeb will replace this with shell code automatically
-# generated by other debhelper scripts.
-
-#DEBHELPER#
-
-exit 0
diff --git a/debian/patches/0002-revert-sphinx-1.6-requirement.patch b/debian/patches/0002-revert-sphinx-1.6-requirement.patch
 new file mode 100644
index 0000000..0913701
--- /dev/null
+++ b/debian/patches/0002-revert-sphinx-1.6-requirement.patch
@@ -0,0 +1,38 @@
+Description: revert upstream change that allows build with sphinx 1.6
+ Upstream added a change so that sphinx 1.6 could be used. Xenial has an
+ older version of Sphinx, so we need to revert that change.
+ .
+ See
+ https://bugs.launchpad.net/ubuntu/+source/python-certbot/+bug/1837673/comments/6
+Origin: upstream, https://github.com/certbot/certbot/commit/d8057f0e17dc757fae662dad91a6fedc96ad6a2d
+Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/python-certbot/+bug/1837673
+Last-Update: 2019-10-17
+---
+This patch header follows DEP-3: http://dep.debian.net/deps/dep3/
+diff --git a/docs/conf.py b/docs/conf.py
+index 2e6c5a9..09bb442 100644
+--- a/docs/conf.py
++++ b/docs/conf.py
+@@ -40,7 +40,6 @@ needs_sphinx = '1.0'
+ # ones.
+ extensions = [
+     'sphinx.ext.autodoc',
+-    'sphinx.ext.imgconverter',
+     'sphinx.ext.intersphinx',
+     'sphinx.ext.todo',
+     'sphinx.ext.coverage',
+diff --git a/setup.py b/setup.py
+index a13b7cd..1827c4d 100644
+--- a/setup.py
++++ b/setup.py
+@@ -70,8 +70,8 @@ dev3_extras = [
+ 
+ docs_extras = [
+     'repoze.sphinx.autointerface',
+-    # sphinx.ext.imgconverter
+-    'Sphinx >=1.6',
++    # autodoc_member_order = 'bysource', autodoc_default_flags, and #4686
++    'Sphinx >=1.0,<=1.5.6',
+     'sphinx_rtd_theme',
+ ]
+ 
diff --git a/debian/patches/series b/debian/patches/series
index f869671..aed7114 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1 +1,2 @@
 0001-remove-external-images.patch
+0002-revert-sphinx-1.6-requirement.patch
diff --git a/debian/python-certbot-doc.doc-base b/debian/python-certbot-doc.doc-base
index 7fc1750..9ebba79 100644
--- a/debian/python-certbot-doc.doc-base
+++ b/debian/python-certbot-doc.doc-base
@@ -6,5 +6,5 @@ Abstract: These HTML documentation contain the auto-generated
 Section: Web Development
 
 Format: HTML
-Index: /usr/share/doc/python3-certbot/html/index.html
-Files: /usr/share/doc/python3-certbot/html/*.html
+Index: /usr/share/doc/python-certbot-doc/html/index.html
+Files: /usr/share/doc/python-certbot-doc/html/*.html
diff --git a/debian/python3-certbot.lintian-overrides b/debian/python-certbot.lintian-overrides
 similarity index 50%
 rename from debian/python3-certbot.lintian-overrides
 rename to debian/python-certbot.lintian-overrides
index 4fae888..200d5ef 100644
--- a/debian/python3-certbot.lintian-overrides
+++ b/debian/python-certbot.lintian-overrides
@@ -1,3 +1,3 @@
 # The README file detected in testdata/ is an explanation of how the
 # testdata keys were generated.
-python3-certbot binary: package-contains-documentation-outside-usr-share-doc usr/lib/python3/dist-packages/certbot/tests/testdata/README
 \ No newline at end of file
+python-certbot binary: package-contains-documentation-outside-usr-share-doc usr/lib/python3/dist-packages/certbot/tests/testdata/README
diff --git a/debian/rules b/debian/rules
index 8a9a762..6751046 100755
--- a/debian/rules
+++ b/debian/rules
@@ -3,12 +3,12 @@
 export PYBUILD_NAME = certbot
 
 %:
-	dh $@ --with python3,sphinxdoc --buildsystem=pybuild
+	dh $@ --with python2,sphinxdoc,systemd --buildsystem=pybuild
 
 override_dh_install:
 	mkdir -p debian/certbot/usr/bin debian/certbot/etc/letsencrypt
-	mv debian/python3-certbot/usr/bin/* debian/certbot/usr/bin
-	rm -rf debian/python3-certbot/usr/bin
+	mv debian/python-certbot/usr/bin/* debian/certbot/usr/bin
+	rm -rf debian/python-certbot/usr/bin
 	mv debian/cli.ini debian/certbot/etc/letsencrypt/cli.ini
 	http_proxy='127.0.0.1:9' \
 		https_proxy='127.0.0.1:9' \
@@ -16,16 +16,15 @@ override_dh_install:
 	http_proxy='127.0.0.1:9' \
 		https_proxy='127.0.0.1:8' \
 		sphinx-build -N -bman docs/ build/man
+	# Install certbot.timer as dh-systemd in Xenial doesn't do it
+	install -D --mode=644 --target-directory=debian/certbot/lib/systemd/system debian/certbot.timer
 
-override_dh_installsystemd:
-	dh_installsystemd --no-start --package=certbot
-	dh_installsystemd --package=certbot certbot.timer
+override_dh_systemd_enable:
+	dh_systemd_enable -pcertbot certbot.service
+	dh_systemd_enable -pcertbot certbot.timer
 
-override_dh_installinit:
-
-override_dh_installdocs:
-	dh_installdocs --doc-main-package=python3-certbot -p python-certbot-doc
-	dh_installdocs -p certbot -p python3-certbot -p letsencrypt
+override_dh_systemd_start:
+	dh_systemd_start -pcertbot --no-start certbot.service
+	dh_systemd_start -pcertbot certbot.timer
 
-override_dh_installexamples:
-	dh_installexamples --doc-main-package=python3-certbot -p python-certbot-doc
+override_dh_installinit: