Add tox-docs and tox-cover shadow jobs

Author: mnasiadka

zuul.d/openstack-jobs-shadow.yaml

@@ -68,3 +68,156 @@
       # pin tox <4 for stable branches testing (<=(stable|unmaintained)/zed).
       ensure_tox_version: '<4'
 
+- job:
+    name: openstack-tox-cover
+    parent: tox-cover
+    description: |
+      Run code coverage tests.
+
+      Uses tox with the ``cover`` environment.
+    nodeset: ubuntu-noble
+    branches:
+      regex: ^.*/(victoria|wallaby|xena|yoga|zed|2023.1|2023.2|2024.1|2024.2)$
+      negate: true
+    required-projects:
+      - name: openstack/requirements
+    irrelevant-files: *common-irrelevant-files
+    vars:
+      tox_constraints_file: '{{ ansible_user_dir }}/src/github.com/stackhpc/requirements/upper-constraints.txt'
+    timeout: 3000
+
+- job:
+    name: openstack-tox-docs
+    parent: opendev-tox-docs
+    nodeset: ubuntu-noble
+    description: |
+      Run documentation build.
+
+      Uses tox with the ``docs`` environment.
+
+      .. zuul:jobvar: tox_envlist
+
+         The tox environment for building HTML, default is ``docs``.
+
+      .. zuul:jobvar: tox_pdf_envlist
+
+         The tox environment for building PDF, default is ``pdf-docs``.
+         If this environment does not exist, no PDF building is done.
+
+      .. zuul:jobvar: tox_skip_pdf
+
+         Whether to skip building of PDF documents. By default a PDF
+         file is build if the tox environment specified by
+         :zuul:jobvar:`tox_pdf_envlist` exists.
+
+    branches:
+      regex: ^stable/(victoria|wallaby|xena|yoga|zed|2023.1|2023.2|2024.1|2024.2)$
+      negate: true
+    required-projects:
+      - name: openstack/requirements
+    vars:
+      tox_constraints_file: '{{ ansible_user_dir }}/src/github.com/stackhpc/requirements/upper-constraints.txt'
+      bindep_profile: compile test doc
+      tox_envlist: docs
+      tox_pdf_envlist: pdf-docs
+      tox_skip_pdf: false
+      # TODO(frickler): drop this again when latest tox is unbroken
+      ensure_tox_version: '<4.48'
+    # PDF Building is only done from stein onwards.
+    pre-run: playbooks/tox-docs/pre.yaml
+    run: playbooks/tox-docs/run.yaml
+
+
+- job:
+    name: openstack-tox-docs
+    parent: opendev-tox-docs
+    nodeset: ubuntu-jammy
+    description: |
+      Run documentation build.
+
+      Uses tox with the ``docs`` environment.
+
+      .. zuul:jobvar: tox_envlist
+
+         The tox environment for building HTML, default is ``docs``.
+
+      .. zuul:jobvar: tox_pdf_envlist
+
+         The tox environment for building PDF, default is ``pdf-docs``.
+         If this environment does not exist, no PDF building is done.
+
+      .. zuul:jobvar: tox_skip_pdf
+
+         Whether to skip building of PDF documents. By default a PDF
+         file is build if the tox environment specified by
+         :zuul:jobvar:`tox_pdf_envlist` exists.
+    required-projects:
+      - name: openstack/requirements
+    vars:
+      tox_constraints_file: '{{ ansible_user_dir }}/src/github.com/stackhpc/requirements/upper-constraints.txt'
+      bindep_profile: compile test doc
+      tox_envlist: docs
+      tox_pdf_envlist: pdf-docs
+      tox_skip_pdf: false
+      # TODO(frickler): drop this again when latest tox is unbroken
+      ensure_tox_version: '<4.48'
+    # PDF Building is only done from stein onwards.
+    pre-run: playbooks/tox-docs/pre.yaml
+    run: playbooks/tox-docs/run.yaml
+    branches:
+      - ^.*/2023.1
+      - ^.*/2023.2
+      - ^.*/2024.1
+      - ^.*/2024.2
+
+- job:
+    name: openstack-tox-docs
+    parent: opendev-tox-docs
+    description: |
+      Run documentation build (focal).
+
+      Uses tox with the ``docs`` environment.
+
+      This job runs on focal from stable/victoria until stable/zed.
+
+      .. zuul:jobvar: tox_envlist
+
+         The tox environment for building HTML, default is ``docs``.
+
+      .. zuul:jobvar: tox_pdf_envlist
+
+         The tox environment for building PDF, default is ``pdf-docs``.
+         If this environment does not exist, no PDF building is done.
+
+      .. zuul:jobvar: tox_skip_pdf
+
+         Whether to skip building of PDF documents. By default a PDF
+         file is build if the tox environment specified by
+         :zuul:jobvar:`tox_pdf_envlist` exists.
+
+    required-projects:
+      - name: openstack/requirements
+    vars:
+      tox_constraints_file: '{{ ansible_user_dir }}/src/github.com/stackhpc/requirements/upper-constraints.txt'
+      tox_envlist: docs
+      bindep_profile: compile test doc
+      tox_pdf_envlist: pdf-docs
+      tox_skip_pdf: false
+      # NOTE(gmann): This is stable branch (<=(stable|unmaintained)/zed) job and new
+      # tox 4 require some changes in tox.ini to be compatible with it. Let's
+      # pin tox <4 for stable branches testing (<=(stable|unmaintained)/zed).
+      ensure_tox_version: '<4'
+    nodeset: ubuntu-focal
+    # PDF Building is only done from stein onwards, therefore these
+    # pre-run and run playbooks are not part of
+    # openstack-tox-docs job for older branches up to rocky.
+    pre-run: playbooks/tox-docs/pre.yaml
+    run: playbooks/tox-docs/run.yaml
+    branches:
+      - ^.*/victoria
+      - ^.*/wallaby
+      - ^.*/xena
+      - ^.*/yoga
+      - ^.*/zed
+
+