diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..58948d4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +*.pyc +*~ + +# Unit test / coverage reports +.coverage +.tox + +# Sphinx +doc/build + +# pbr generates these +AUTHORS +ChangeLog diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..bb250f8 --- /dev/null +++ b/README.rst @@ -0,0 +1,4 @@ +Zuul Sphinx +=========== + +A Sphinx extension for documenting Zuul jobs. diff --git a/bindep.txt b/bindep.txt new file mode 100644 index 0000000..9b8bcf3 --- /dev/null +++ b/bindep.txt @@ -0,0 +1,4 @@ +# This is a cross-platform list tracking distribution packages needed by tests; +# see http://docs.openstack.org/infra/bindep/ for additional information. + +# Nothing here yet. diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100755 index 0000000..1c0114c --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,76 @@ +# -*- coding: utf-8 -*- +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import os +import sys + +sys.path.insert(0, os.path.abspath('../..')) +# -- General configuration ---------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [ + 'sphinx.ext.autodoc', + #'sphinx.ext.intersphinx', + 'zuul_sphinx.zuul', + 'oslosphinx' +] + +# autodoc generation is a bit aggressive and a nuisance when doing heavy +# text edit cycles. +# execute "export SPHINX_DEBUG=1" in your terminal to disable + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'zuul-sphinx' +copyright = u'2017, Zuul contributors' + +# If true, '()' will be appended to :func: etc. cross-reference text. +add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +add_module_names = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# -- Options for HTML output -------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +# html_theme_path = ["."] +# html_theme = '_theme' +# html_static_path = ['static'] + +# Output file base name for HTML help builder. +htmlhelp_basename = '%sdoc' % project + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass +# [howto/manual]). +latex_documents = [ + ('index', + '%s.tex' % project, + u'%s Documentation' % project, + u'OpenStack Foundation', 'manual'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +#intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..fffa3da --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,12 @@ +.. include:: ../../README.rst + + +.. toctree:: + :maxdepth: 2 + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..fd2681f --- /dev/null +++ b/setup.cfg @@ -0,0 +1,21 @@ +[metadata] +name = zuul-sphinx +summary = A Sphinx extension for documenting Zuul jobs +description-file = + README.rst +author = OpenStack Infrastructure Team +author-email = openstack-infra@lists.openstack.org +home-page = http://www.openstack.org/ +classifier = + Environment :: OpenStack + Intended Audience :: Information Technology + Intended Audience :: System Administrators + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux + Programming Language :: Python + +[build_sphinx] +all-files = 1 +warning-is-error = 1 +source-dir = doc/source +build-dir = doc/build diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..5343f6d --- /dev/null +++ b/setup.py @@ -0,0 +1,28 @@ +# Copyright (c) 2013 Hewlett-Packard Development Company, L.P. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import setuptools + +# In python < 2.7.4, a lazy loading of package `pbr` will break +# setuptools if some other modules registered functions in `atexit`. +# solution from: http://bugs.python.org/issue15881#msg170215 +try: + import multiprocessing # noqa +except ImportError: + pass + +setuptools.setup( + setup_requires=['pbr>=2.0'], + pbr=True) diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..d6676fe --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,9 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. + +hacking>=0.12.0,<0.13 # Apache-2.0 + +bashate>=0.2 +sphinx>=1.5.1,<1.6.0 # BSD +oslosphinx>=4.7.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..723d6a3 --- /dev/null +++ b/tox.ini @@ -0,0 +1,38 @@ +[tox] +minversion = 1.6 +skipsdist = True +envlist = pep8 + +[testenv] +install_command = pip install {opts} {packages} +deps = -r{toxinidir}/test-requirements.txt +commands = + python setup.py testr --slowest --testr-args='{posargs}' + +[testenv:bindep] +# Do not install any requirements. We want this to be fast and work even if +# system dependencies are missing, since it's used to tell you what system +# dependencies are missing! This also means that bindep must be installed +# separately, outside of the requirements files. +deps = bindep +commands = bindep test + +[testenv:docs] +commands = python setup.py build_sphinx + +[testenv:pep8] +whitelist_externals = bash +commands = + flake8 {posargs} + bash -c "cd roles; find . -type f -regex '.*.y[a]?ml' -print0 | xargs -t -n1 -0 \ + ansible-lint" + +[testenv:venv] +commands = {posargs} + +[flake8] +# These are ignored intentionally in openstack-infra projects; +# please don't submit patches that solely correct them or enable them. +ignore = E125,E129,H +show-source = True +exclude = .venv,.tox,dist,doc,build,*.egg diff --git a/zuul_sphinx/__init__.py b/zuul_sphinx/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/zuul_sphinx/zuul.py b/zuul_sphinx/zuul.py new file mode 100644 index 0000000..80d98c9 --- /dev/null +++ b/zuul_sphinx/zuul.py @@ -0,0 +1,231 @@ +# Copyright 2017 Red Hat, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +from sphinx import addnodes +from docutils.parsers.rst import Directive +from sphinx.domains import Domain, ObjType +from sphinx.directives import ObjectDescription +import os + +import yaml + + +class Layout(object): + def __init__(self): + self.jobs = [] + + +class BaseZuulDirective(Directive): + has_content = True + + def find_zuul_yaml(self): + root = self.state.document.settings.env.relfn2path('.')[1] + while root: + for fn in ['zuul.yaml', '.zuul.yaml']: + path = os.path.join(root, fn) + if os.path.exists(path): + return path + root = os.path.split(root)[0] + raise Exception("Unable to find zuul.yaml or .zuul.yaml") + + def parse_zuul_yaml(self, path): + with open(path) as f: + data = yaml.safe_load(f) + layout = Layout() + for obj in data: + if 'job' in obj: + layout.jobs.append(obj['job']) + return layout + + def _parse_zuul_layout(self): + env = self.state.document.settings.env + if not env.domaindata['zuul']['layout']: + path = self.find_zuul_yaml() + layout = self.parse_zuul_yaml(path) + env.domaindata['zuul']['layout_path'] = path + env.domaindata['zuul']['layout'] = layout + + @property + def zuul_layout(self): + self._parse_zuul_layout() + env = self.state.document.settings.env + return env.domaindata['zuul']['layout'] + + @property + def zuul_layout_path(self): + self._parse_zuul_layout() + env = self.state.document.settings.env + return env.domaindata['zuul']['layout_path'] + + def generate_zuul_job_content(self, name): + lines = [] + for job in self.zuul_layout.jobs: + if job['name'] == name: + lines.append('.. zuul:job:: %s' % name) + if 'branches' in job: + branches = job['branches'] + if not isinstance(branches, list): + branches = [branches] + variant = ', '.join(branches) + lines.append(' :variant: %s' % variant) + lines.append('') + for l in job.get('description', '').split('\n'): + lines.append(' ' + l) + lines.append('') + return lines + + def find_zuul_roles(self): + root = os.path.dirname(self.zuul_layout_path) + roledir = os.path.join(root, 'roles') + env = self.state.document.settings.env + roles = env.domaindata['zuul']['role_paths'] + for p in os.listdir(roledir): + role_readme = os.path.join(roledir, p, 'README.rst') + if os.path.exists(role_readme): + roles[p] = role_readme + + @property + def zuul_role_paths(self): + env = self.state.document.settings.env + roles = env.domaindata['zuul']['role_paths'] + if roles is None: + roles = {} + env.domaindata['zuul']['role_paths'] = roles + self.find_zuul_roles() + return roles + + def generate_zuul_role_content(self, name): + lines = [] + lines.append('.. zuul:role:: %s' % name) + lines.append('') + role_readme = self.zuul_role_paths[name] + with open(role_readme) as f: + role_lines = f.read().split('\n') + for l in role_lines: + lines.append(' ' + l) + return lines + + +class ZuulJobDirective(BaseZuulDirective, ObjectDescription): + option_spec = { + 'variant': lambda x: x, + } + + def handle_signature(self, sig, signode): + signode += addnodes.desc_name(sig, sig) + return sig + + def add_target_and_index(self, name, sig, signode): + targetname = self.objtype + '-' + name + if 'variant' in self.options: + targetname += '-' + self.options['variant'] + if targetname not in self.state.document.ids: + signode['names'].append(targetname) + signode['ids'].append(targetname) + signode['first'] = (not self.names) + self.state.document.note_explicit_target(signode) + + indextext = '%s (%s)' % (name, self.objtype) + self.indexnode['entries'].append(('single', indextext, + targetname, '', None)) + + +class ZuulAutoJobDirective(BaseZuulDirective): + def run(self): + name = self.content[0] + lines = self.generate_zuul_job_content(name) + self.state_machine.insert_input(lines, self.zuul_layout_path) + return [] + + +class ZuulAutoJobsDirective(BaseZuulDirective): + has_content = False + + def run(self): + lines = [] + names = set() + for job in self.zuul_layout.jobs: + name = job['name'] + if name in names: + continue + lines.extend(self.generate_zuul_job_content(name)) + names.add(name) + self.state_machine.insert_input(lines, self.zuul_layout_path) + return [] + + +class ZuulRoleDirective(BaseZuulDirective, ObjectDescription): + def handle_signature(self, sig, signode): + signode += addnodes.desc_name(sig, sig) + return sig + + def add_target_and_index(self, name, sig, signode): + targetname = self.objtype + '-' + name + if targetname not in self.state.document.ids: + signode['names'].append(targetname) + signode['ids'].append(targetname) + signode['first'] = (not self.names) + self.state.document.note_explicit_target(signode) + + indextext = '%s (%s)' % (name, self.objtype) + self.indexnode['entries'].append(('single', indextext, + targetname, '', None)) + + +class ZuulAutoRoleDirective(BaseZuulDirective): + def run(self): + name = self.content[0] + lines = self.generate_zuul_role_content(name) + self.state_machine.insert_input(lines, self.zuul_role_paths[name]) + return [] + + +class ZuulAutoRolesDirective(BaseZuulDirective): + has_content = False + + def run(self): + role_names = reversed(sorted(self.zuul_role_paths.keys())) + for name in role_names: + lines = self.generate_zuul_role_content(name) + self.state_machine.insert_input(lines, self.zuul_role_paths[name]) + return [] + + +class ZuulDomain(Domain): + name = 'zuul' + label = 'Zuul' + + object_types = { + 'job': ObjType('job'), + 'role': ObjType('role'), + } + + directives = { + 'job': ZuulJobDirective, + 'autojob': ZuulAutoJobDirective, + 'autojobs': ZuulAutoJobsDirective, + 'role': ZuulRoleDirective, + 'autorole': ZuulAutoRoleDirective, + 'autoroles': ZuulAutoRolesDirective, + } + + initial_data = { + 'layout': None, + 'layout_path': None, + 'role_paths': None, + } + + +def setup(app): + app.add_domain(ZuulDomain)