Bug#1007232: python-ara: please make the build reproducible

[Chris Lamb]

Source: python-ara
Version: 1.5.7-1
Severity: wishlist
Tags: patch
User: reproducible-builds at lists.alioth.debian.org
Usertags: buildpath
X-Debbugs-Cc: reproducible-bugs at lists.alioth.debian.org

Hi,

Whilst working on the Reproducible Builds effort [0] we noticed that
python-ara could not be built reproducibly. There were a number of
issues when creating the docs:

 * Unless python3-ara was already installed (to /usr/bin, etc.), the
   example command-line programs couldn't be found in the PATH when
   generating the docs.
 * Ditto as before, but with the PYTHONPATH; it couldn't find "itself"
   when running, even if the Python scripts were found.
 * Missing python3-cliff dependency during the build.
 * Ignoring any warnings generated during the documentation build;
   the PyTz warnings included the current build path, rendering the
   package unreproducible.

Patch attached.

 [0] https://reproducible-builds.org/


Regards,

-- 
      ,''`.
     : :'  :     Chris Lamb
     `. `'`      lamby at debian.org / chris-lamb.co.uk
       `-
-------------- next part --------------
--- a/debian/control	2022-03-14 08:35:25.942897280 +0000
--- b/debian/control	2022-03-14 08:54:52.198976805 +0000
@@ -11,6 +11,7 @@
  python3-pbr,
  python3-setuptools,
 Build-Depends-Indep:
+ python3-cliff,
  python3-django (>= 2:2.1.5),
  python3-django-cors-headers,
  python3-django-filters,
--- a/debian/rules	2022-03-14 08:35:25.942897280 +0000
--- b/debian/rules	2022-03-14 09:05:12.820629127 +0000
@@ -2,6 +2,7 @@
 
 export ARA_BASE_DIR = /tmp/
 export PYBUILD_NAME = ara
+export PYTHONWARNINGS = ignore
 
 %:
 	dh $@ --buildsystem=pybuild --with python3,sphinxdoc
@@ -16,6 +17,6 @@
 
 override_dh_sphinxdoc:
 ifeq (,$(findstring nodocs, $(DEB_BUILD_OPTIONS)))
-	PYTHON=python3 python3 -m sphinx -b html doc/source debian/python-ara-doc/usr/share/doc/python-ara-doc/html
+	PATH=$(CURDIR)/debian/python3-ara/usr/bin:$$PATH PYTHONPATH=$(CURDIR) PYTHON=python3 python3 -m sphinx -b html doc/source debian/python-ara-doc/usr/share/doc/python-ara-doc/html
 	dh_sphinxdoc -O--buildsystem=python_distutils
 endif