Browse Source

Initial commit

Copied from openstack-infra/zuul-jobs repo.

Change-Id: If76b2313dc54557d6271dbaba8d8bb555ed5eae8
James E. Blair 1 year ago
parent
commit
7342ef9e80
12 changed files with 638 additions and 0 deletions
  1. 13
    0
      .gitignore
  2. 202
    0
      LICENSE
  3. 4
    0
      README.rst
  4. 4
    0
      bindep.txt
  5. 76
    0
      doc/source/conf.py
  6. 12
    0
      doc/source/index.rst
  7. 21
    0
      setup.cfg
  8. 28
    0
      setup.py
  9. 9
    0
      test-requirements.txt
  10. 38
    0
      tox.ini
  11. 0
    0
      zuul_sphinx/__init__.py
  12. 231
    0
      zuul_sphinx/zuul.py

+ 13
- 0
.gitignore View File

@@ -0,0 +1,13 @@
1
+*.pyc
2
+*~
3
+
4
+# Unit test / coverage reports
5
+.coverage
6
+.tox
7
+
8
+# Sphinx
9
+doc/build
10
+
11
+# pbr generates these
12
+AUTHORS
13
+ChangeLog

+ 202
- 0
LICENSE View File

@@ -0,0 +1,202 @@
1
+
2
+                                 Apache License
3
+                           Version 2.0, January 2004
4
+                        http://www.apache.org/licenses/
5
+
6
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+   1. Definitions.
9
+
10
+      "License" shall mean the terms and conditions for use, reproduction,
11
+      and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+      "Licensor" shall mean the copyright owner or entity authorized by
14
+      the copyright owner that is granting the License.
15
+
16
+      "Legal Entity" shall mean the union of the acting entity and all
17
+      other entities that control, are controlled by, or are under common
18
+      control with that entity. For the purposes of this definition,
19
+      "control" means (i) the power, direct or indirect, to cause the
20
+      direction or management of such entity, whether by contract or
21
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+      outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+      "You" (or "Your") shall mean an individual or Legal Entity
25
+      exercising permissions granted by this License.
26
+
27
+      "Source" form shall mean the preferred form for making modifications,
28
+      including but not limited to software source code, documentation
29
+      source, and configuration files.
30
+
31
+      "Object" form shall mean any form resulting from mechanical
32
+      transformation or translation of a Source form, including but
33
+      not limited to compiled object code, generated documentation,
34
+      and conversions to other media types.
35
+
36
+      "Work" shall mean the work of authorship, whether in Source or
37
+      Object form, made available under the License, as indicated by a
38
+      copyright notice that is included in or attached to the work
39
+      (an example is provided in the Appendix below).
40
+
41
+      "Derivative Works" shall mean any work, whether in Source or Object
42
+      form, that is based on (or derived from) the Work and for which the
43
+      editorial revisions, annotations, elaborations, or other modifications
44
+      represent, as a whole, an original work of authorship. For the purposes
45
+      of this License, Derivative Works shall not include works that remain
46
+      separable from, or merely link (or bind by name) to the interfaces of,
47
+      the Work and Derivative Works thereof.
48
+
49
+      "Contribution" shall mean any work of authorship, including
50
+      the original version of the Work and any modifications or additions
51
+      to that Work or Derivative Works thereof, that is intentionally
52
+      submitted to Licensor for inclusion in the Work by the copyright owner
53
+      or by an individual or Legal Entity authorized to submit on behalf of
54
+      the copyright owner. For the purposes of this definition, "submitted"
55
+      means any form of electronic, verbal, or written communication sent
56
+      to the Licensor or its representatives, including but not limited to
57
+      communication on electronic mailing lists, source code control systems,
58
+      and issue tracking systems that are managed by, or on behalf of, the
59
+      Licensor for the purpose of discussing and improving the Work, but
60
+      excluding communication that is conspicuously marked or otherwise
61
+      designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+      "Contributor" shall mean Licensor and any individual or Legal Entity
64
+      on behalf of whom a Contribution has been received by Licensor and
65
+      subsequently incorporated within the Work.
66
+
67
+   2. Grant of Copyright License. Subject to the terms and conditions of
68
+      this License, each Contributor hereby grants to You a perpetual,
69
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+      copyright license to reproduce, prepare Derivative Works of,
71
+      publicly display, publicly perform, sublicense, and distribute the
72
+      Work and such Derivative Works in Source or Object form.
73
+
74
+   3. Grant of Patent License. Subject to the terms and conditions of
75
+      this License, each Contributor hereby grants to You a perpetual,
76
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+      (except as stated in this section) patent license to make, have made,
78
+      use, offer to sell, sell, import, and otherwise transfer the Work,
79
+      where such license applies only to those patent claims licensable
80
+      by such Contributor that are necessarily infringed by their
81
+      Contribution(s) alone or by combination of their Contribution(s)
82
+      with the Work to which such Contribution(s) was submitted. If You
83
+      institute patent litigation against any entity (including a
84
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+      or a Contribution incorporated within the Work constitutes direct
86
+      or contributory patent infringement, then any patent licenses
87
+      granted to You under this License for that Work shall terminate
88
+      as of the date such litigation is filed.
89
+
90
+   4. Redistribution. You may reproduce and distribute copies of the
91
+      Work or Derivative Works thereof in any medium, with or without
92
+      modifications, and in Source or Object form, provided that You
93
+      meet the following conditions:
94
+
95
+      (a) You must give any other recipients of the Work or
96
+          Derivative Works a copy of this License; and
97
+
98
+      (b) You must cause any modified files to carry prominent notices
99
+          stating that You changed the files; and
100
+
101
+      (c) You must retain, in the Source form of any Derivative Works
102
+          that You distribute, all copyright, patent, trademark, and
103
+          attribution notices from the Source form of the Work,
104
+          excluding those notices that do not pertain to any part of
105
+          the Derivative Works; and
106
+
107
+      (d) If the Work includes a "NOTICE" text file as part of its
108
+          distribution, then any Derivative Works that You distribute must
109
+          include a readable copy of the attribution notices contained
110
+          within such NOTICE file, excluding those notices that do not
111
+          pertain to any part of the Derivative Works, in at least one
112
+          of the following places: within a NOTICE text file distributed
113
+          as part of the Derivative Works; within the Source form or
114
+          documentation, if provided along with the Derivative Works; or,
115
+          within a display generated by the Derivative Works, if and
116
+          wherever such third-party notices normally appear. The contents
117
+          of the NOTICE file are for informational purposes only and
118
+          do not modify the License. You may add Your own attribution
119
+          notices within Derivative Works that You distribute, alongside
120
+          or as an addendum to the NOTICE text from the Work, provided
121
+          that such additional attribution notices cannot be construed
122
+          as modifying the License.
123
+
124
+      You may add Your own copyright statement to Your modifications and
125
+      may provide additional or different license terms and conditions
126
+      for use, reproduction, or distribution of Your modifications, or
127
+      for any such Derivative Works as a whole, provided Your use,
128
+      reproduction, and distribution of the Work otherwise complies with
129
+      the conditions stated in this License.
130
+
131
+   5. Submission of Contributions. Unless You explicitly state otherwise,
132
+      any Contribution intentionally submitted for inclusion in the Work
133
+      by You to the Licensor shall be under the terms and conditions of
134
+      this License, without any additional terms or conditions.
135
+      Notwithstanding the above, nothing herein shall supersede or modify
136
+      the terms of any separate license agreement you may have executed
137
+      with Licensor regarding such Contributions.
138
+
139
+   6. Trademarks. This License does not grant permission to use the trade
140
+      names, trademarks, service marks, or product names of the Licensor,
141
+      except as required for reasonable and customary use in describing the
142
+      origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+   7. Disclaimer of Warranty. Unless required by applicable law or
145
+      agreed to in writing, Licensor provides the Work (and each
146
+      Contributor provides its Contributions) on an "AS IS" BASIS,
147
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+      implied, including, without limitation, any warranties or conditions
149
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+      PARTICULAR PURPOSE. You are solely responsible for determining the
151
+      appropriateness of using or redistributing the Work and assume any
152
+      risks associated with Your exercise of permissions under this License.
153
+
154
+   8. Limitation of Liability. In no event and under no legal theory,
155
+      whether in tort (including negligence), contract, or otherwise,
156
+      unless required by applicable law (such as deliberate and grossly
157
+      negligent acts) or agreed to in writing, shall any Contributor be
158
+      liable to You for damages, including any direct, indirect, special,
159
+      incidental, or consequential damages of any character arising as a
160
+      result of this License or out of the use or inability to use the
161
+      Work (including but not limited to damages for loss of goodwill,
162
+      work stoppage, computer failure or malfunction, or any and all
163
+      other commercial damages or losses), even if such Contributor
164
+      has been advised of the possibility of such damages.
165
+
166
+   9. Accepting Warranty or Additional Liability. While redistributing
167
+      the Work or Derivative Works thereof, You may choose to offer,
168
+      and charge a fee for, acceptance of support, warranty, indemnity,
169
+      or other liability obligations and/or rights consistent with this
170
+      License. However, in accepting such obligations, You may act only
171
+      on Your own behalf and on Your sole responsibility, not on behalf
172
+      of any other Contributor, and only if You agree to indemnify,
173
+      defend, and hold each Contributor harmless for any liability
174
+      incurred by, or claims asserted against, such Contributor by reason
175
+      of your accepting any such warranty or additional liability.
176
+
177
+   END OF TERMS AND CONDITIONS
178
+
179
+   APPENDIX: How to apply the Apache License to your work.
180
+
181
+      To apply the Apache License to your work, attach the following
182
+      boilerplate notice, with the fields enclosed by brackets "[]"
183
+      replaced with your own identifying information. (Don't include
184
+      the brackets!)  The text should be enclosed in the appropriate
185
+      comment syntax for the file format. We also recommend that a
186
+      file or class name and description of purpose be included on the
187
+      same "printed page" as the copyright notice for easier
188
+      identification within third-party archives.
189
+
190
+   Copyright [yyyy] [name of copyright owner]
191
+
192
+   Licensed under the Apache License, Version 2.0 (the "License");
193
+   you may not use this file except in compliance with the License.
194
+   You may obtain a copy of the License at
195
+
196
+       http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+   Unless required by applicable law or agreed to in writing, software
199
+   distributed under the License is distributed on an "AS IS" BASIS,
200
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+   See the License for the specific language governing permissions and
202
+   limitations under the License.

+ 4
- 0
README.rst View File

@@ -0,0 +1,4 @@
1
+Zuul Sphinx
2
+===========
3
+
4
+A Sphinx extension for documenting Zuul jobs.

+ 4
- 0
bindep.txt View File

@@ -0,0 +1,4 @@
1
+# This is a cross-platform list tracking distribution packages needed by tests;
2
+# see http://docs.openstack.org/infra/bindep/ for additional information.
3
+
4
+# Nothing here yet.

+ 76
- 0
doc/source/conf.py View File

@@ -0,0 +1,76 @@
1
+# -*- coding: utf-8 -*-
2
+# Licensed under the Apache License, Version 2.0 (the "License");
3
+# you may not use this file except in compliance with the License.
4
+# You may obtain a copy of the License at
5
+#
6
+#    http://www.apache.org/licenses/LICENSE-2.0
7
+#
8
+# Unless required by applicable law or agreed to in writing, software
9
+# distributed under the License is distributed on an "AS IS" BASIS,
10
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11
+# implied.
12
+# See the License for the specific language governing permissions and
13
+# limitations under the License.
14
+
15
+import os
16
+import sys
17
+
18
+sys.path.insert(0, os.path.abspath('../..'))
19
+# -- General configuration ----------------------------------------------------
20
+
21
+# Add any Sphinx extension module names here, as strings. They can be
22
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
23
+extensions = [
24
+    'sphinx.ext.autodoc',
25
+    #'sphinx.ext.intersphinx',
26
+    'zuul_sphinx.zuul',
27
+    'oslosphinx'
28
+]
29
+
30
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
31
+# text edit cycles.
32
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
33
+
34
+# The suffix of source filenames.
35
+source_suffix = '.rst'
36
+
37
+# The master toctree document.
38
+master_doc = 'index'
39
+
40
+# General information about the project.
41
+project = u'zuul-sphinx'
42
+copyright = u'2017, Zuul contributors'
43
+
44
+# If true, '()' will be appended to :func: etc. cross-reference text.
45
+add_function_parentheses = True
46
+
47
+# If true, the current module name will be prepended to all description
48
+# unit titles (such as .. function::).
49
+add_module_names = True
50
+
51
+# The name of the Pygments (syntax highlighting) style to use.
52
+pygments_style = 'sphinx'
53
+
54
+# -- Options for HTML output --------------------------------------------------
55
+
56
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
57
+# Sphinx are currently 'default' and 'sphinxdoc'.
58
+# html_theme_path = ["."]
59
+# html_theme = '_theme'
60
+# html_static_path = ['static']
61
+
62
+# Output file base name for HTML help builder.
63
+htmlhelp_basename = '%sdoc' % project
64
+
65
+# Grouping the document tree into LaTeX files. List of tuples
66
+# (source start file, target name, title, author, documentclass
67
+# [howto/manual]).
68
+latex_documents = [
69
+    ('index',
70
+     '%s.tex' % project,
71
+     u'%s Documentation' % project,
72
+     u'OpenStack Foundation', 'manual'),
73
+]
74
+
75
+# Example configuration for intersphinx: refer to the Python standard library.
76
+#intersphinx_mapping = {'http://docs.python.org/': None}

+ 12
- 0
doc/source/index.rst View File

@@ -0,0 +1,12 @@
1
+.. include:: ../../README.rst
2
+
3
+
4
+.. toctree::
5
+   :maxdepth: 2
6
+
7
+
8
+Indices and tables
9
+==================
10
+
11
+* :ref:`genindex`
12
+* :ref:`search`

+ 21
- 0
setup.cfg View File

@@ -0,0 +1,21 @@
1
+[metadata]
2
+name = zuul-sphinx
3
+summary = A Sphinx extension for documenting Zuul jobs
4
+description-file =
5
+    README.rst
6
+author = OpenStack Infrastructure Team
7
+author-email = openstack-infra@lists.openstack.org
8
+home-page = http://www.openstack.org/
9
+classifier =
10
+    Environment :: OpenStack
11
+    Intended Audience :: Information Technology
12
+    Intended Audience :: System Administrators
13
+    License :: OSI Approved :: Apache Software License
14
+    Operating System :: POSIX :: Linux
15
+    Programming Language :: Python
16
+
17
+[build_sphinx]
18
+all-files = 1
19
+warning-is-error = 1
20
+source-dir = doc/source
21
+build-dir = doc/build

+ 28
- 0
setup.py View File

@@ -0,0 +1,28 @@
1
+# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
2
+#
3
+# Licensed under the Apache License, Version 2.0 (the "License");
4
+# you may not use this file except in compliance with the License.
5
+# You may obtain a copy of the License at
6
+#
7
+#    http://www.apache.org/licenses/LICENSE-2.0
8
+#
9
+# Unless required by applicable law or agreed to in writing, software
10
+# distributed under the License is distributed on an "AS IS" BASIS,
11
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
12
+# implied.
13
+# See the License for the specific language governing permissions and
14
+# limitations under the License.
15
+
16
+import setuptools
17
+
18
+# In python < 2.7.4, a lazy loading of package `pbr` will break
19
+# setuptools if some other modules registered functions in `atexit`.
20
+# solution from: http://bugs.python.org/issue15881#msg170215
21
+try:
22
+    import multiprocessing  # noqa
23
+except ImportError:
24
+    pass
25
+
26
+setuptools.setup(
27
+    setup_requires=['pbr>=2.0'],
28
+    pbr=True)

+ 9
- 0
test-requirements.txt View File

@@ -0,0 +1,9 @@
1
+# The order of packages is significant, because pip processes them in the order
2
+# of appearance. Changing the order has an impact on the overall integration
3
+# process, which may cause wedges in the gate later.
4
+
5
+hacking>=0.12.0,<0.13 # Apache-2.0
6
+
7
+bashate>=0.2
8
+sphinx>=1.5.1,<1.6.0 # BSD
9
+oslosphinx>=4.7.0 # Apache-2.0

+ 38
- 0
tox.ini View File

@@ -0,0 +1,38 @@
1
+[tox]
2
+minversion = 1.6
3
+skipsdist = True
4
+envlist = pep8
5
+
6
+[testenv]
7
+install_command = pip install {opts} {packages}
8
+deps = -r{toxinidir}/test-requirements.txt
9
+commands =
10
+  python setup.py testr --slowest --testr-args='{posargs}'
11
+
12
+[testenv:bindep]
13
+# Do not install any requirements. We want this to be fast and work even if
14
+# system dependencies are missing, since it's used to tell you what system
15
+# dependencies are missing! This also means that bindep must be installed
16
+# separately, outside of the requirements files.
17
+deps = bindep
18
+commands = bindep test
19
+
20
+[testenv:docs]
21
+commands = python setup.py build_sphinx
22
+
23
+[testenv:pep8]
24
+whitelist_externals = bash
25
+commands =
26
+  flake8 {posargs}
27
+  bash -c "cd roles; find . -type f -regex '.*.y[a]?ml' -print0 | xargs -t -n1 -0 \
28
+    ansible-lint"
29
+
30
+[testenv:venv]
31
+commands = {posargs}
32
+
33
+[flake8]
34
+# These are ignored intentionally in openstack-infra projects;
35
+# please don't submit patches that solely correct them or enable them.
36
+ignore = E125,E129,H
37
+show-source = True
38
+exclude = .venv,.tox,dist,doc,build,*.egg

+ 0
- 0
zuul_sphinx/__init__.py View File


+ 231
- 0
zuul_sphinx/zuul.py View File

@@ -0,0 +1,231 @@
1
+# Copyright 2017 Red Hat, Inc.
2
+#
3
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
4
+# not use this file except in compliance with the License. You may obtain
5
+# a copy of the License at
6
+#
7
+#      http://www.apache.org/licenses/LICENSE-2.0
8
+#
9
+# Unless required by applicable law or agreed to in writing, software
10
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12
+# License for the specific language governing permissions and limitations
13
+# under the License.
14
+
15
+from sphinx import addnodes
16
+from docutils.parsers.rst import Directive
17
+from sphinx.domains import Domain, ObjType
18
+from sphinx.directives import ObjectDescription
19
+import os
20
+
21
+import yaml
22
+
23
+
24
+class Layout(object):
25
+    def __init__(self):
26
+        self.jobs = []
27
+
28
+
29
+class BaseZuulDirective(Directive):
30
+    has_content = True
31
+
32
+    def find_zuul_yaml(self):
33
+        root = self.state.document.settings.env.relfn2path('.')[1]
34
+        while root:
35
+            for fn in ['zuul.yaml', '.zuul.yaml']:
36
+                path = os.path.join(root, fn)
37
+                if os.path.exists(path):
38
+                    return path
39
+            root = os.path.split(root)[0]
40
+        raise Exception("Unable to find zuul.yaml or .zuul.yaml")
41
+
42
+    def parse_zuul_yaml(self, path):
43
+        with open(path) as f:
44
+            data = yaml.safe_load(f)
45
+        layout = Layout()
46
+        for obj in data:
47
+            if 'job' in obj:
48
+                layout.jobs.append(obj['job'])
49
+        return layout
50
+
51
+    def _parse_zuul_layout(self):
52
+        env = self.state.document.settings.env
53
+        if not env.domaindata['zuul']['layout']:
54
+            path = self.find_zuul_yaml()
55
+            layout = self.parse_zuul_yaml(path)
56
+            env.domaindata['zuul']['layout_path'] = path
57
+            env.domaindata['zuul']['layout'] = layout
58
+
59
+    @property
60
+    def zuul_layout(self):
61
+        self._parse_zuul_layout()
62
+        env = self.state.document.settings.env
63
+        return env.domaindata['zuul']['layout']
64
+
65
+    @property
66
+    def zuul_layout_path(self):
67
+        self._parse_zuul_layout()
68
+        env = self.state.document.settings.env
69
+        return env.domaindata['zuul']['layout_path']
70
+
71
+    def generate_zuul_job_content(self, name):
72
+        lines = []
73
+        for job in self.zuul_layout.jobs:
74
+            if job['name'] == name:
75
+                lines.append('.. zuul:job:: %s' % name)
76
+                if 'branches' in job:
77
+                    branches = job['branches']
78
+                    if not isinstance(branches, list):
79
+                        branches = [branches]
80
+                    variant = ', '.join(branches)
81
+                    lines.append('   :variant: %s' % variant)
82
+                lines.append('')
83
+                for l in job.get('description', '').split('\n'):
84
+                    lines.append('   ' + l)
85
+                lines.append('')
86
+        return lines
87
+
88
+    def find_zuul_roles(self):
89
+        root = os.path.dirname(self.zuul_layout_path)
90
+        roledir = os.path.join(root, 'roles')
91
+        env = self.state.document.settings.env
92
+        roles = env.domaindata['zuul']['role_paths']
93
+        for p in os.listdir(roledir):
94
+            role_readme = os.path.join(roledir, p, 'README.rst')
95
+            if os.path.exists(role_readme):
96
+                roles[p] = role_readme
97
+
98
+    @property
99
+    def zuul_role_paths(self):
100
+        env = self.state.document.settings.env
101
+        roles = env.domaindata['zuul']['role_paths']
102
+        if roles is None:
103
+            roles = {}
104
+            env.domaindata['zuul']['role_paths'] = roles
105
+            self.find_zuul_roles()
106
+        return roles
107
+
108
+    def generate_zuul_role_content(self, name):
109
+        lines = []
110
+        lines.append('.. zuul:role:: %s' % name)
111
+        lines.append('')
112
+        role_readme = self.zuul_role_paths[name]
113
+        with open(role_readme) as f:
114
+            role_lines = f.read().split('\n')
115
+            for l in role_lines:
116
+                lines.append('   ' + l)
117
+        return lines
118
+
119
+
120
+class ZuulJobDirective(BaseZuulDirective, ObjectDescription):
121
+    option_spec = {
122
+        'variant': lambda x: x,
123
+    }
124
+
125
+    def handle_signature(self, sig, signode):
126
+        signode += addnodes.desc_name(sig, sig)
127
+        return sig
128
+
129
+    def add_target_and_index(self, name, sig, signode):
130
+        targetname = self.objtype + '-' + name
131
+        if 'variant' in self.options:
132
+            targetname += '-' + self.options['variant']
133
+        if targetname not in self.state.document.ids:
134
+            signode['names'].append(targetname)
135
+            signode['ids'].append(targetname)
136
+            signode['first'] = (not self.names)
137
+            self.state.document.note_explicit_target(signode)
138
+
139
+        indextext = '%s (%s)' % (name, self.objtype)
140
+        self.indexnode['entries'].append(('single', indextext,
141
+                                          targetname, '', None))
142
+
143
+
144
+class ZuulAutoJobDirective(BaseZuulDirective):
145
+    def run(self):
146
+        name = self.content[0]
147
+        lines = self.generate_zuul_job_content(name)
148
+        self.state_machine.insert_input(lines, self.zuul_layout_path)
149
+        return []
150
+
151
+
152
+class ZuulAutoJobsDirective(BaseZuulDirective):
153
+    has_content = False
154
+
155
+    def run(self):
156
+        lines = []
157
+        names = set()
158
+        for job in self.zuul_layout.jobs:
159
+            name = job['name']
160
+            if name in names:
161
+                continue
162
+            lines.extend(self.generate_zuul_job_content(name))
163
+            names.add(name)
164
+        self.state_machine.insert_input(lines, self.zuul_layout_path)
165
+        return []
166
+
167
+
168
+class ZuulRoleDirective(BaseZuulDirective, ObjectDescription):
169
+    def handle_signature(self, sig, signode):
170
+        signode += addnodes.desc_name(sig, sig)
171
+        return sig
172
+
173
+    def add_target_and_index(self, name, sig, signode):
174
+        targetname = self.objtype + '-' + name
175
+        if targetname not in self.state.document.ids:
176
+            signode['names'].append(targetname)
177
+            signode['ids'].append(targetname)
178
+            signode['first'] = (not self.names)
179
+            self.state.document.note_explicit_target(signode)
180
+
181
+        indextext = '%s (%s)' % (name, self.objtype)
182
+        self.indexnode['entries'].append(('single', indextext,
183
+                                          targetname, '', None))
184
+
185
+
186
+class ZuulAutoRoleDirective(BaseZuulDirective):
187
+    def run(self):
188
+        name = self.content[0]
189
+        lines = self.generate_zuul_role_content(name)
190
+        self.state_machine.insert_input(lines, self.zuul_role_paths[name])
191
+        return []
192
+
193
+
194
+class ZuulAutoRolesDirective(BaseZuulDirective):
195
+    has_content = False
196
+
197
+    def run(self):
198
+        role_names = reversed(sorted(self.zuul_role_paths.keys()))
199
+        for name in role_names:
200
+            lines = self.generate_zuul_role_content(name)
201
+            self.state_machine.insert_input(lines, self.zuul_role_paths[name])
202
+        return []
203
+
204
+
205
+class ZuulDomain(Domain):
206
+    name = 'zuul'
207
+    label = 'Zuul'
208
+
209
+    object_types = {
210
+        'job': ObjType('job'),
211
+        'role': ObjType('role'),
212
+    }
213
+
214
+    directives = {
215
+        'job': ZuulJobDirective,
216
+        'autojob': ZuulAutoJobDirective,
217
+        'autojobs': ZuulAutoJobsDirective,
218
+        'role': ZuulRoleDirective,
219
+        'autorole': ZuulAutoRoleDirective,
220
+        'autoroles': ZuulAutoRolesDirective,
221
+    }
222
+
223
+    initial_data = {
224
+        'layout': None,
225
+        'layout_path': None,
226
+        'role_paths': None,
227
+    }
228
+
229
+
230
+def setup(app):
231
+    app.add_domain(ZuulDomain)

Loading…
Cancel
Save