Merge lp:~canonical-platform-qa/autopilot/pdf-build into lp:autopilot

[Allan LeSage]

Provide pdf build.

Provide pdf-building via LaTeX.

Required minor modification for a unicode char unprovided-for. Where/how would we want to install the result?

This'll be on hold until I fix a noodly Makefile/bash issue (marked as FIXME in debian/rules), but wanting to get some feedback.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:529
http://jenkins.qa.ubuntu.com/job/autopilot-ci/994/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-amd64-ci/57/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-armhf-ci/57/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-i386-ci/57/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-vivid-autopilot/74/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-amd64/499/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/994/rebuild

review: Needs Fixing (continuous-integration)

[lp:~canonical-platform-qa/autopilot/pdf-build]

530. By Allan LeSage on 2015-01-22

Correct .svg extensions.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:530
http://jenkins.qa.ubuntu.com/job/autopilot-ci/995/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-amd64-ci/58/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-armhf-ci/58/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-i386-ci/58/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-vivid-autopilot/76/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-amd64/501/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/995/rebuild

review: Needs Fixing (continuous-integration)

[lp:~canonical-platform-qa/autopilot/pdf-build]

531. By Allan LeSage on 2015-01-22

Revert whitespace change.

532. By Allan LeSage on 2015-01-22

Makefile hackery to convert .svgs to .pdf, revert wildcard .svg change, add imagemagick build-dep.

533. By Allan LeSage on 2015-01-22

Merge trunk.

534. By Allan LeSage on 2015-01-22

Clean up debian/rules comments :/ .

[Allan LeSage (allanlesage)]

To build/test, just do a normal debian build--the .pdf arrives in build/sphinx/latex/Autopilot.pdf , else just follow the steps listed in debian/rules. Note that you'll need the added dependencies.

Also note that the man.rst changes convert that unicode em-dash to a normal hyphen, wasn't supported during the LaTeX generation.

[lp:~canonical-platform-qa/autopilot/pdf-build]

535. By Allan LeSage on 2015-01-22

debian/control whitespace fix.

[Thomi Richards (thomir-deactivatedaccount)]

LGTM, but I'd like to see someone review the packaging bits.

Cheers,

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:534
http://jenkins.qa.ubuntu.com/job/autopilot-ci/999/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-amd64-ci/62/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-armhf-ci/62/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-i386-ci/62/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-vivid-autopilot/83/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-amd64/511/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/999/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:535
http://jenkins.qa.ubuntu.com/job/autopilot-ci/1000/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-amd64-ci/63/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-armhf-ci/63/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-i386-ci/63/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-vivid-autopilot/86/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-amd64/514/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/1000/rebuild

review: Needs Fixing (continuous-integration)

[Martin Pitt (pitti)]

The packaging in debian/rules looks fine to me. However, it fails to build:

   debian/rules override_dh_auto_build
make[1]: Entering directory '/«BUILDDIR»/autopilot-1.5.0+14.10.20140806'
convert /«BUILDDIR»/autopilot-1.5.0+14.10.20140806/docs/images/test_pyramid.svg /«BUILDDIR»/autopilot-1.5.0+14.10.20140806/docs/images/test_pyramid.pdf
convert: delegate failed `"rsvg-convert" -o "%o" "%i"' @ error/delegate.c/InvokeDelegate/1310.
convert: unable to open image `/tmp/magick-28976RCFje6T2VDtX': No such file or directory @ error/blob.c/OpenBlob/2709.
convert: unable to open file `/tmp/magick-28976RCFje6T2VDtX': No such file or directory @ error/constitute.c/ReadImage/540.
convert: no images defined `/«BUILDDIR»/autopilot-1.5.0+14.10.20140806/docs/images/test_pyramid.pdf' @ error/convert.c/ConvertImageCommand/3210.
make[1]: *** [/«BUILDDIR»/autopilot-1.5.0+14.10.20140806/docs/images/test_pyramid.pdf] Error 1
debian/rules:8: recipe for target '/«BUILDDIR»/autopilot-1.5.0+14.10.20140806/docs/images/test_pyramid.pdf' failed
make[1]: Leaving directory '/«BUILDDIR»/autopilot-1.5.0+14.10.20140806'
make: *** [build] Error 2
debian/rules:14: recipe for target 'build' failed

Maybe that's still missing some build dep?

I can't quite see what changed in docs/man.rst, that seems to be some whitespace noise?

review: Needs Fixing

[lp:~canonical-platform-qa/autopilot/pdf-build]

536. By Allan LeSage on 2015-01-23

Add librsvg2-bin build-dep.

[Allan LeSage (allanlesage)]

Mysterious missing dependency; this builds under pbuilder; we'll wait for Jenkins' approval--thanks for your notes pitti.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:536
http://jenkins.qa.ubuntu.com/job/autopilot-ci/1004/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-amd64-ci/67/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-armhf-ci/67
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-armhf-ci/67/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-i386-ci/67/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-vivid-autopilot/96/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-amd64/560/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/1004/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:536
http://jenkins.qa.ubuntu.com/job/autopilot-ci/1005/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-amd64-ci/68/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-armhf-ci/68
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-armhf-ci/68/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-i386-ci/68
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-i386-ci/68/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-vivid-autopilot/97
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-vivid-autopilot/94
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-amd64/562
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-amd64/562/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/1005/rebuild

review: Needs Fixing (continuous-integration)

[Francis Ginther (fginther)]

The jenkins node for the amd64 build failed, I've restarted a new ci run.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:536
http://jenkins.qa.ubuntu.com/job/autopilot-ci/1007/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-amd64-ci/70
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-amd64-ci/70/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-armhf-ci/70
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-armhf-ci/70/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-i386-ci/70
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-i386-ci/70/artifact/work/output/*zip*/output.zip
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1003
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-vivid-autopilot/100
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/888
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1001
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1001/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/17473
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-vivid-autopilot/97
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-amd64/570
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-amd64/570/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/1007/rebuild

review: Approve (continuous-integration)

[Nicholas Skaggs (nskaggs)]

Unsure as to why there are newline changes in docs/man.rst. But otherwise, LGTM. Did you find texlive-fonts-recommended required? Is our font special?

[platform-qa-bot (platform-qa-bot)]

PASSED: Continuous integration, rev:536
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/11/
Executed test runs:
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/11/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/autopilot-ci/11/rebuild

review: Approve (continuous-integration)

Unmerged revisions

536. By Allan LeSage on 2015-01-23

Add librsvg2-bin build-dep.

535. By Allan LeSage on 2015-01-22

debian/control whitespace fix.

534. By Allan LeSage on 2015-01-22

Clean up debian/rules comments :/ .

533. By Allan LeSage on 2015-01-22

Merge trunk.

532. By Allan LeSage on 2015-01-22

Makefile hackery to convert .svgs to .pdf, revert wildcard .svg change, add imagemagick build-dep.

531. By Allan LeSage on 2015-01-22

Revert whitespace change.

530. By Allan LeSage on 2015-01-22

Correct .svg extensions.

529. By Allan LeSage on 2015-01-22

Provide for pdf in debian-build.

=== modified file 'debian/control'
--- debian/control	2014-10-30 08:10:12 +0000
+++ debian/control	2015-01-23 16:16:27 +0000
@@ -11,9 +11,11 @@
                gir1.2-ibus-1.0,
                gir1.2-ubuntu-app-launch-2 | gir1.2-upstart-app-launch-2,
                graphviz,
+               imagemagick,
                libjs-jquery,
                libjs-underscore,
                liblttng-ust-dev,
+               librsvg2-bin,
                python3-all-dev (>= 3.4),
                python3-dateutil,
                python3-dbus,
@@ -32,6 +34,7 @@
                python3-testtools,
                python3-xlib,
                sphinx-common,
+               texlive-fonts-recommended,
                texlive-latex-extra,
 Standards-Version: 3.9.5
 Homepage: https://launchpad.net/autopilot

=== modified file 'debian/rules' (properties changed: -x to +x)
--- debian/rules	2014-07-23 03:37:24 +0000
+++ debian/rules	2015-01-23 16:16:27 +0000
@@ -4,6 +4,12 @@
 # Uncomment this to turn on verbose mode.
 # export DH_VERBOSE=1
 
+%.pdf : %.svg
+	convert $< $@
+
+# find .svgs, make list of .pdfs to generate
+PDFs := $(patsubst %.svg,%.pdf,$(wildcard $(CURDIR)/docs/images/*.svg))
+
 %:
 	dh $@ --with python3,sphinxdoc --buildsystem=pybuild
 
@@ -11,11 +17,13 @@
 	# https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=745690
 	-dh_sphinxdoc
 
-override_dh_auto_build:
+override_dh_auto_build: $(PDFs)
 	python3 -m flake8.run .
 	dh_auto_build
 	python3 setup.py build_sphinx -b html
 	python3 setup.py build_sphinx -b man
+	python3 setup.py build_sphinx -b latex
+	$(MAKE) -C $(CURDIR)/build/sphinx/latex all-pdf
 
 override_dh_auto_test:
 ifeq (, $(findstring nocheck, $(DEB_BUILD_OPTIONS)))

=== modified file 'docs/man.rst'
--- docs/man.rst	2015-01-21 05:28:45 +0000
+++ docs/man.rst	2015-01-23 16:16:27 +0000
@@ -16,8 +16,8 @@
 General Options
        -h, --help
             Get help from autopilot. This command can also be present after  a
-            sub-command (such as run or list) to get help on the specific com‐
-            mand.  Further options are restricted to particular autopilot com‐
+            sub-command (such as run or list) to get help on the specific com-
+            mand.  Further options are restricted to particular autopilot com-
             mands.
 
        -v, --version
@@ -35,7 +35,7 @@
             See `SPECIFYING SUITES`_
 
        -ro, --run-order
-            List tests in the order they will be run in, rather than alphabet‐
+            List tests in the order they will be run in, rather than alphabet-
             ically (which is the default).
 
        --suites
@@ -49,7 +49,7 @@
 
        -o FILE, --output FILE
             Specify where the test log should be written. Defaults to  stdout.
-            If  a directory is specified the file will be created with a file‐
+            If  a directory is specified the file will be created with a file-
             name of <hostname>_<dd.mm.yyy_HHMMSS>.log
 
        -f FORMAT, --format FORMAT
@@ -60,7 +60,7 @@
             Stop the test run on the first error or failure.
 
        -r, --record
-            Record failed tests. Using this option requires the 'recordmydesk‐
+            Record failed tests. Using this option requires the 'recordmydesk-
             top' application be installed. By default, videos  are  stored  in
             /tmp/autopilot