Add testing of fetch-sphinx-tarball role

We discovered that role fails on some platform because of the missing
bzip2 package.  We can avoid this by using gzip which is much more
likely to exist on machines (and exists in the container images for
most operating systems).

Change-Id: Ia33a0f77343df809cd3c591a4a988e8e3712c133
Co-Authored-By: Mohammed Naser <mnaser@vexxhost.com>

roles/fetch-sphinx-tarball/tasks/html.yaml

@@ -1,17 +1,17 @@
 - name: Create temporary HTML archive file
   tempfile:
     state: file
-    suffix: ".tar.bz2"
+    suffix: ".tar.gz"
   register: html_archive
 
 - name: Archive HTML
-  command: "tar -f {{ html_archive.path }} -C {{ zuul_work_dir }}/{{ sphinx_build_dir }}/html --exclude=.doctrees -cj ."
+  command: "tar -f {{ html_archive.path }} -C {{ zuul_work_dir }}/{{ sphinx_build_dir }}/html --exclude=.doctrees -cz ."
   args:
     warn: false
 
 - name: Fetch archive HTML
   synchronize:
-    dest: "{{ zuul.executor.log_root }}/docs-html.tar.bz2"
+    dest: "{{ zuul.executor.log_root }}/docs-html.tar.gz"
     mode: pull
     src: "{{ html_archive.path }}"
     verify_host: true
@@ -25,7 +25,7 @@
 - name: Extract archive HTML
   delegate_to: localhost
   unarchive:
-    src: "{{ zuul.executor.log_root }}/docs-html.tar.bz2"
+    src: "{{ zuul.executor.log_root }}/docs-html.tar.gz"
     dest: "{{ zuul.executor.log_root }}/docs"
 
 - name: Return artifact to Zuul
@@ -34,7 +34,7 @@
       zuul:
         artifacts:
           - name: "Docs archive"
-            url: "docs-html.tar.bz2"
+            url: "docs-html.tar.gz"
             metadata:
               type: docs_archive
           - name: "Docs preview site"

zuul-tests.d/python-jobs.yaml

@@ -226,6 +226,118 @@
         - name: ubuntu-xenial
           label: ubuntu-xenial
 
+- job:
+    name: zuul-jobs-test-fetch-sphinx-tarball
+    description: Test the fetch-sphinx-tarball role
+    # parenting on tox-docs as we need builded docs first and also this is
+    # the main use-case for this role
+    parent: tox-docs
+    success-url: docs/
+    files:
+      - roles/fetch-sphinx-tarball/.*
+    tags: all-platforms
+
+- job:
+    name: zuul-jobs-test-fetch-sphinx-tarball-centos-7
+    description: Test the fetch-sphinx-tarball role on centos-7
+    parent: zuul-jobs-test-fetch-sphinx-tarball
+    tags: auto-generated
+    nodeset:
+      nodes:
+        - name: centos-7
+          label: centos-7
+
+- job:
+    name: zuul-jobs-test-fetch-sphinx-tarball-centos-8
+    description: Test the fetch-sphinx-tarball role on centos-8
+    parent: zuul-jobs-test-fetch-sphinx-tarball
+    tags: auto-generated
+    nodeset:
+      nodes:
+        - name: centos-8
+          label: centos-8
+
+- job:
+    name: zuul-jobs-test-fetch-sphinx-tarball-debian-stretch
+    description: Test the fetch-sphinx-tarball role on debian-stretch
+    parent: zuul-jobs-test-fetch-sphinx-tarball
+    tags: auto-generated
+    nodeset:
+      nodes:
+        - name: debian-stretch
+          label: debian-stretch
+
+- job:
+    name: zuul-jobs-test-fetch-sphinx-tarball-fedora-31
+    description: Test the fetch-sphinx-tarball role on fedora-31
+    parent: zuul-jobs-test-fetch-sphinx-tarball
+    tags: auto-generated
+    nodeset:
+      nodes:
+        - name: fedora-31
+          label: fedora-31
+
+- job:
+    name: zuul-jobs-test-fetch-sphinx-tarball-gentoo-17-0-systemd
+    description: Test the fetch-sphinx-tarball role on gentoo-17-0-systemd
+    parent: zuul-jobs-test-fetch-sphinx-tarball
+    tags: auto-generated
+    nodeset:
+      nodes:
+        - name: gentoo-17-0-systemd
+          label: gentoo-17-0-systemd
+
+- job:
+    name: zuul-jobs-test-fetch-sphinx-tarball-opensuse-15
+    description: Test the fetch-sphinx-tarball role on opensuse-15
+    parent: zuul-jobs-test-fetch-sphinx-tarball
+    tags: auto-generated
+    nodeset:
+      nodes:
+        - name: opensuse-15
+          label: opensuse-15
+
+- job:
+    name: zuul-jobs-test-fetch-sphinx-tarball-opensuse-tumbleweed-nv
+    voting: false
+    description: Test the fetch-sphinx-tarball role on opensuse-tumbleweed
+    parent: zuul-jobs-test-fetch-sphinx-tarball
+    tags: auto-generated
+    nodeset:
+      nodes:
+        - name: opensuse-tumbleweed
+          label: opensuse-tumbleweed
+
+- job:
+    name: zuul-jobs-test-fetch-sphinx-tarball-ubuntu-bionic
+    description: Test the fetch-sphinx-tarball role on ubuntu-bionic
+    parent: zuul-jobs-test-fetch-sphinx-tarball
+    tags: auto-generated
+    nodeset:
+      nodes:
+        - name: ubuntu-bionic
+          label: ubuntu-bionic
+
+- job:
+    name: zuul-jobs-test-fetch-sphinx-tarball-ubuntu-bionic-plain
+    description: Test the fetch-sphinx-tarball role on ubuntu-bionic-plain
+    parent: zuul-jobs-test-fetch-sphinx-tarball
+    tags: auto-generated
+    nodeset:
+      nodes:
+        - name: ubuntu-bionic-plain
+          label: ubuntu-bionic-plain
+
+- job:
+    name: zuul-jobs-test-fetch-sphinx-tarball-ubuntu-xenial
+    description: Test the fetch-sphinx-tarball role on ubuntu-xenial
+    parent: zuul-jobs-test-fetch-sphinx-tarball
+    tags: auto-generated
+    nodeset:
+      nodes:
+        - name: ubuntu-xenial
+          label: ubuntu-xenial
+
 - job:
     name: zuul-jobs-test-tox-siblings
     description: Test the tox role's sibling functionality
@@ -309,6 +421,16 @@
         - zuul-jobs-test-ensure-tox-ubuntu-bionic
         - zuul-jobs-test-ensure-tox-ubuntu-bionic-plain
         - zuul-jobs-test-ensure-tox-ubuntu-xenial
+        - zuul-jobs-test-fetch-sphinx-tarball-centos-7
+        - zuul-jobs-test-fetch-sphinx-tarball-centos-8
+        - zuul-jobs-test-fetch-sphinx-tarball-debian-stretch
+        - zuul-jobs-test-fetch-sphinx-tarball-fedora-31
+        - zuul-jobs-test-fetch-sphinx-tarball-gentoo-17-0-systemd
+        - zuul-jobs-test-fetch-sphinx-tarball-opensuse-15
+        - zuul-jobs-test-fetch-sphinx-tarball-opensuse-tumbleweed-nv
+        - zuul-jobs-test-fetch-sphinx-tarball-ubuntu-bionic
+        - zuul-jobs-test-fetch-sphinx-tarball-ubuntu-bionic-plain
+        - zuul-jobs-test-fetch-sphinx-tarball-ubuntu-xenial
         - zuul-jobs-test-tox-siblings
         - zuul-jobs-test-fetch-tox-output
         - zuul-jobs-test-fetch-tox-output-synchronize
@@ -335,6 +457,15 @@
         - zuul-jobs-test-ensure-tox-ubuntu-bionic
         - zuul-jobs-test-ensure-tox-ubuntu-bionic-plain
         - zuul-jobs-test-ensure-tox-ubuntu-xenial
+        - zuul-jobs-test-fetch-sphinx-tarball-centos-7
+        - zuul-jobs-test-fetch-sphinx-tarball-centos-8
+        - zuul-jobs-test-fetch-sphinx-tarball-debian-stretch
+        - zuul-jobs-test-fetch-sphinx-tarball-fedora-31
+        - zuul-jobs-test-fetch-sphinx-tarball-gentoo-17-0-systemd
+        - zuul-jobs-test-fetch-sphinx-tarball-opensuse-15
+        - zuul-jobs-test-fetch-sphinx-tarball-ubuntu-bionic
+        - zuul-jobs-test-fetch-sphinx-tarball-ubuntu-bionic-plain
+        - zuul-jobs-test-fetch-sphinx-tarball-ubuntu-xenial
         - zuul-jobs-test-tox-siblings
         - zuul-jobs-test-fetch-tox-output
         - zuul-jobs-test-fetch-tox-output-synchronize