Merge "fetch-sphinx-tarball: don't run merge-output-to-logs"

roles/fetch-sphinx-output/README.rst

@@ -35,10 +35,17 @@ to the log root of the executor.
 
    The location of the main working directory of the job.
 
+
 .. zuul:rolevar:: zuul_use_fetch_output
    :default: false
 
-   Whether to synchronize files to the executor work dir, or to copy them
+   Whether to synchronize files to the executor work dir, or to only
-   on the test instance.
+   copy them on the test instance.
-   When set to false, the role synchronizes the file to the executor.
+
-   When set to true, the job needs to use the fetch-output role later.
+   When set to ``False``, the default, the role synchronizes the
+   tarball archives and extracted documentation files to the executor
+   ``log_root``.
+
+   When set to ``True``, the content is copied locally to
+   ``{{  ansible_user_dir }}/zuul-output/logs/``.  The ``fetch-output`` role
+   needs to be run to copy this output to the executor ``log_root``.

roles/fetch-sphinx-tarball/README.rst

@@ -27,7 +27,13 @@ archive into the log root for viewing.
 .. zuul:rolevar:: zuul_use_fetch_output
    :default: false
 
-   Whether to synchronize files to the executor work dir, or to copy them
+   Whether to synchronize files to the executor work dir, or to only
-   on the test instance.
+   copy them on the test instance.
-   When set to false, the role synchronizes the file to the executor.
+
-   When set to true, the job needs to use the fetch-output role later.
+   When set to ``False``, the default, the role synchronizes the
+   tarball archives and extracted documentation files to the executor
+   ``log_root``.
+
+   When set to ``True``, the content is copied locally to
+   ``{{  ansible_user_dir }}/zuul-output/logs/``.  The ``fetch-output`` role
+   needs to be run to copy this output to the executor ``log_root``.

test-playbooks/python/fetch-sphinx-tarball.yaml

@@ -32,7 +32,7 @@
     #  The generated .tar.gz files are copied into
     #  {{ ansible_user_dir }}/zuul-output/logs/ and extracted into
     #  zuul-output/logs/<docs|pdf> on the host.  They need to be brought back
-    #  to the executor using fetch-output/merge-output-to-logs
+    #  to the executor using fetch-output
     - import_role:
         name: fetch-sphinx-tarball
 
@@ -43,21 +43,6 @@
         name: fetch-output
       when: zuul_use_fetch_output
 
-    # This moves <docs|artifacts> in zuul.executor.work_root into
-    # zuul.executor.log_root so they are published when operating in a
-    # change context.
-    #
-    # For example, in the release pipeline, jobs might build artifacts
-    # like sdist/wheels, copy them to the executor and upload them and
-    # do not need to publish those actual artifacts in the logs.  Thus
-    # when triggered from a tag/periodic job this job won't copy
-    # anything.  However, when triggered from a change, this *will*
-    # copy the docs/artifacts into the logs so they can be browsed
-    # from the change result.
-    - import_role:
-        name: merge-output-to-logs
-      when: zuul_use_fetch_output
-
   post_tasks:
     - name: Check for artifact on the test instance
       stat:

zuul-tests.d/python-jobs.yaml

@@ -455,19 +455,16 @@
     vars:
       zuul_use_fetch_output: false
 
-# Disabled because "Move artifacts and docs to logs dir" task would
+- job:
-# fail with "Executing local code is prohibited" during testing
+    name: zuul-jobs-test-fetch-sphinx-tarball-with-zuul-output
-# - job:
+    description: Test the fetch-sphinx-tarball
-#     name: zuul-jobs-test-fetch-sphinx-tarball-with-zuul-output
+    files:
-#     description: Test the fetch-sphinx-tarball
+      - roles/ensure-output-dirs/.*
-#     files:
+      - roles/fetch-sphinx-tarball/.*
-#       - roles/ensure-output-dirs/.*
+      - roles/fetch-output/.*
-#       - roles/fetch-sphinx-tarball/.*
+    run: test-playbooks/python/fetch-sphinx-tarball.yaml
-#       - roles/fetch-output/.*
+    vars:
-#     run: test-playbooks/python/fetch-sphinx-tarball.yaml
+      zuul_use_fetch_output: true
-#     voting: false
-#     vars:
-#       zuul_use_fetch_output: true
 
 - job:
     name: zuul-jobs-test-fetch-sphinx-tarball-synchronize
@@ -522,6 +519,7 @@
         - zuul-jobs-test-fetch-subunit-output-synchronize
         - zuul-jobs-test-fetch-sphinx-output
         - zuul-jobs-test-fetch-sphinx-output-synchronize
+        - zuul-jobs-test-fetch-sphinx-tarball-with-zuul-output
         - zuul-jobs-test-fetch-sphinx-tarball-synchronize
     gate:
       jobs: &id001
@@ -563,6 +561,7 @@
         - zuul-jobs-test-fetch-subunit-output-synchronize
         - zuul-jobs-test-fetch-sphinx-output
         - zuul-jobs-test-fetch-sphinx-output-synchronize
+        - zuul-jobs-test-fetch-sphinx-tarball-with-zuul-output
         - zuul-jobs-test-fetch-sphinx-tarball-synchronize
     periodic-weekly:
       jobs: *id001