jjb/jenkins-job-builder
Code Issues Proposed changes

docs: sphinx upgrade and warnings as erros

Browse Source 
Change-Id: I455ac0d79cca3883d3a758a2709c8c0255f4cc7d
This commit is contained in:
Sorin Sbarnea 2018-01-26 14:06:57 +00:00
parent 8d489abece
commit d8ace6802d
16 changed files with 165 additions and 143 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/view_list.rst
View File

@ -1,7 +1,7 @@
.. view_list:
.. _view_list:
List View
=========
.. automodule:: view_list
:members:
:members:

4
doc/source/view_pipeline.rst
View File

@ -1,7 +1,7 @@
.. view_pipeline:
.. _view_pipeline:
Pipeline View
=============
.. automodule:: view_pipeline
:members:
:members:

2
doc/source/wrappers.rst
View File

@ -4,4 +4,4 @@ Wrappers
========
.. automodule:: wrappers
:members:
:members:

2
doc/source/zuul.rst
View File

@ -4,4 +4,4 @@ Zuul
====
.. automodule:: zuul
:members:
:members:

5
jenkins_jobs/modules/base.py
View File

@ -54,8 +54,9 @@ class Base(object):
return ``True``, otherwise, it must return ``False``.
:arg dict job_data: the intermediate representation of job data
loaded from JJB Yaml files without variables interpolation or other
yaml expansions.
loaded from JJB Yaml files without variables interpolation or other
yaml expansions.
:rtype: boolean
"""

4
jenkins_jobs/modules/builders.py
View File

@ -3779,10 +3779,12 @@ def docker_build_publish(parse, xml_parent, data):
:arg str repo-name: Name of repository to push to.
:arg str repo-tag: Tag for image. (default '')
:arg dict server: The docker daemon (optional)
* **uri** (str): Define the docker server to use. (optional)
* **credentials-id** (str): ID of credentials to use to connect
(optional)
:arg dict registry: Registry to push to
* **url** (str) repository url to use (optional)
* **credentials-id** (str): ID of credentials to use to connect
(optional)
@ -3922,7 +3924,7 @@ def nexus_artifact_uploader(registry, xml_parent, data):
File Example:
.. literalinclude::
/../../tests/builders/fixtures/nexus-artifact-uploader.yaml
/../../tests/builders/fixtures/nexus_artifact_uploader001.yaml
:language: yaml
"""
nexus_artifact_uploader = XML.SubElement(

19
jenkins_jobs/modules/parameters.py
View File

@ -309,9 +309,9 @@ def credentials_param(registry, xml_parent, data):
Example::
.. literalinclude:: \
/../../tests/parameters/fixtures/credentials-param001.yaml
:language: yaml
.. literalinclude::
/../../tests/parameters/fixtures/credentials-param001.yaml
:language: yaml
"""
cred_impl_types = {
@ -398,14 +398,15 @@ def extended_choice_param(registry, xml_parent, data):
Minimal Example:
.. literalinclude:: \
/../../tests/parameters/fixtures/extended-choice-param-minimal.yaml
:language: yaml
.. literalinclude:: \
/../../tests/parameters/fixtures/extended-choice-param-minimal.yaml
:language: yaml
Full Example:
.. literalinclude:: \
/../../tests/parameters/fixtures/extended-choice-param-full.yaml
:language: yaml
.. literalinclude:: \
/../../tests/parameters/fixtures/extended-choice-param-full.yaml
:language: yaml
"""
pdef = base_param(registry, xml_parent, data, False,
'com.cwctravel.hudson.plugins.'

18
jenkins_jobs/modules/properties.py
View File

@ -291,23 +291,19 @@ def branch_api(registry, xml_parent, data):
:arg str time-period: The time period within which the maximum number
of builds will be enforced. (default 'Hour')
:valid values:
* **Hour**
* **Day**
* **Week**
* **Month**
* **Year**
:valid values: **Hour**, **Day**, **Week**, **Month**, **Year**
Minimal Example:
.. literalinclude::
/../../tests/properties/fixtures/branch-api-minimal.yaml
:language: yaml
.. literalinclude::
/../../tests/properties/fixtures/branch-api-minimal.yaml
:language: yaml
Full example:
.. literalinclude:: /../../tests/properties/fixtures/branch-api-full.yaml
:language: yaml
.. literalinclude::
/../../tests/properties/fixtures/branch-api-full.yaml
:language: yaml
"""
branch = XML.SubElement(xml_parent, 'jenkins.branch.'
'RateLimitBranchProperty_-JobPropertyImpl')

237
jenkins_jobs/modules/publishers.py
View File

@ -48,23 +48,24 @@ def allure(registry, xml_parent, data):
:arg str jdk: String identifier for a JDK installation in Jenkins
:arg str commandline: String identifier for a Allure-commandline tool
installation
installation
:arg str report-build-policy: String identifier for a report build
policy enum. Possible values: 'ALWAYS', 'UNSTABLE', 'UNSUCCESSFUL'.
(By default is 'ALWAYS')
policy enum. Possible values: 'ALWAYS', 'UNSTABLE', 'UNSUCCESSFUL'.
(By default is 'ALWAYS')
:arg bool include-properties: Flag to include specified properties
:arg list results-paths: List of results directories
:arg list properties: List of key:value property pairs
Minimal Example:
.. literalinclude:: /../../tests/publishers/fixtures/allure-minimal.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/allure-minimal.yaml
:language: yaml
Full Example:
.. literalinclude:: /../../tests/publishers/fixtures/allure-full.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/allure-full.yaml
:language: yaml
"""
publisher_class = 'ru.yandex.qatools.allure.jenkins.AllureReportPublisher'
@ -127,8 +128,8 @@ def archive(registry, xml_parent, data):
Example:
.. literalinclude:: /../../tests/publishers/fixtures/archive001.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/archive001.yaml
:language: yaml
"""
archiver = XML.SubElement(xml_parent, 'hudson.tasks.ArtifactArchiver')
mapping = [
@ -153,8 +154,8 @@ def blame_upstream(registry, xml_parent, data):
Example:
.. literalinclude:: /../../tests/publishers/fixtures/blame001.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/blame001.yaml
:language: yaml
"""
XML.SubElement(xml_parent,
@ -178,7 +179,7 @@ def jclouds(registry, xml_parent, data):
Example:
.. literalinclude:: /../../tests/publishers/fixtures/jclouds001.yaml
.. literalinclude:: /../../tests/publishers/fixtures/jclouds001.yaml
"""
@ -224,8 +225,8 @@ def javadoc(registry, xml_parent, data):
Example:
.. literalinclude:: /../../tests/publishers/fixtures/javadoc001.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/javadoc001.yaml
:language: yaml
"""
root = XML.SubElement(xml_parent, 'hudson.tasks.JavadocArchiver')
@ -246,8 +247,8 @@ def jdepend(registry, xml_parent, data):
Example:
.. literalinclude:: /../../tests/publishers/fixtures/jdepend001.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/jdepend001.yaml
:language: yaml
"""
jdepend = XML.SubElement(
xml_parent,
@ -273,13 +274,15 @@ def hue_light(registry, xml_parent, data):
Full Example:
.. literalinclude:: /../../tests/publishers/fixtures/hue-light-full.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/hue-light-full.yaml
:language: yaml
Minimal Example:
.. literalinclude:: /../../tests/publishers/fixtures/hue-light-minimal.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/hue-light-minimal.yaml
:language: yaml
"""
hue_light = XML.SubElement(
@ -317,8 +320,8 @@ def campfire(registry, xml_parent, data):
Example:
.. literalinclude:: /../../tests/publishers/fixtures/campfire001.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/campfire001.yaml
:language: yaml
"""
root = XML.SubElement(xml_parent,
@ -350,23 +353,23 @@ def mqtt(registry, xml_parent, data):
:arg str broker-url: the broker URL, as protocol://address:port (required)
:arg str credentials-id: credentials to use to connect to the broker
(optional)
(optional)
:arg str topic: the message topic (default "jenkins/$PROJECT_URL")
:arg str message: the message itself (default "$BUILD_RESULT")
:arg str qos: one of AT_MOST_ONCE, AT_LEAST_ONCE, or EXACTLY_ONCE
(default AT_MOST_ONCE)
(default AT_MOST_ONCE)
:arg bool retain-message: whether to resend message or not when a new
client connects (default false)
client connects (default false)
Minimal Example:
.. literalinclude:: /../../tests/publishers/fixtures/mqtt-minimal.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/mqtt-minimal.yaml
:language: yaml
Full Example:
.. literalinclude:: /../../tests/publishers/fixtures/mqtt-full.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/mqtt-full.yaml
:language: yaml
"""
mqtt = XML.SubElement(xml_parent,
@ -407,13 +410,15 @@ def codecover(registry, xml_parent, data):
Minimal Example:
.. literalinclude:: /../../tests/publishers/fixtures/codecover-minimal.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/codecover-minimal.yaml
:language: yaml
Full Example:
.. literalinclude:: /../../tests/publishers/fixtures/codecover-full.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/codecover-full.yaml
:language: yaml
"""
codecover = XML.SubElement(
@ -447,8 +452,9 @@ def emotional_jenkins(registry, xml_parent, data):
Example:
.. literalinclude:: /../../tests/publishers/fixtures/emotional-jenkins.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/emotional-jenkins.yaml
:language: yaml
"""
XML.SubElement(xml_parent,
'org.jenkinsci.plugins.emotional__jenkins.'
@ -521,12 +527,12 @@ def trigger_parameterized_builds(registry, xml_parent, data):
Example:
.. literalinclude::
/../../tests/publishers/fixtures/trigger_parameterized_builds001.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/trigger_parameterized_builds003.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/trigger_parameterized_builds001.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/trigger_parameterized_builds003.yaml
:language: yaml
"""
pt_prefix = 'hudson.plugins.parameterizedtrigger.'
tbuilder = XML.SubElement(xml_parent, pt_prefix + 'BuildTrigger')
@ -931,11 +937,11 @@ def jacoco(registry, xml_parent, data):
Requires the Jenkins :jenkins-wiki:`JaCoCo Plugin <JaCoCo+Plugin>`.
:arg str exec-pattern: This is a file name pattern that can be used to
locate the jacoco report files (default '**/**.exec')
locate the jacoco report files (default ``**/**.exec``)
:arg str class-pattern: This is a file name pattern that can be used
to locate class files (default '**/classes')
to locate class files (default ``**/classes``)
:arg str source-pattern: This is a file name pattern that can be used
to locate source files (default '**/src/main/java')
to locate source files (default ``**/src/main/java``)
:arg bool update-build-status: Update the build according to the results
(default false)
:arg str inclusion-pattern: This is a file name pattern that can be used
@ -2178,15 +2184,18 @@ def cppcheck(registry, xml_parent, data):
is also determined by thresholds. If the actual number of issues
is between the provided thresholds, then the build health is
interpolated.
* **unstable** (`str`): Total number unstable threshold (default '')
* **new-unstable** (`str`): New number unstable threshold (default '')
* **failure** (`str`): Total number failure threshold (default '')
* **new-failure** (`str`): New number failure threshold (default '')
* **healthy** (`str`): Healthy threshold (default '')
* **unhealthy** (`str`): Unhealthy threshold (default '')
:arg dict severity:
:severity: Determines which severity of issues should be considered
when evaluating the build status and health, default all true
* **error** (`bool`): Severity error (default true)
* **warning** (`bool`): Severity warning (default true)
* **style** (`bool`): Severity style (default true)
@ -2194,12 +2203,16 @@ def cppcheck(registry, xml_parent, data):
* **information** (`bool`): Severity information (default true)
* **nocategory** (`bool`): Severity nocategory (default true)
* **portability** (`bool`): Severity portability (default true)
:arg dict graph:
:graph: Graph configuration
* **xysize** (`array`): Chart width and height (default [500, 200])
* **num-builds-in-graph** (`int`): Builds number in graph (default 0)
:arg dict display
:display: which errors to display, default only sum
* **sum** (`bool`): Display sum of all issues (default true)
* **error** (`bool`): Display errors (default false)
* **warning** (`bool`): Display warnings (default false)
@ -2211,14 +2224,15 @@ def cppcheck(registry, xml_parent, data):
Minimal Example:
.. literalinclude::
/../../tests/publishers/fixtures/cppcheck-minimal.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/cppcheck-minimal.yaml
:language: yaml
Full Example:
.. literalinclude::
/../../tests/publishers/fixtures/cppcheck-full.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/cppcheck-full.yaml
:language: yaml
"""
cppextbase = XML.SubElement(xml_parent,
@ -2302,13 +2316,15 @@ def logparser(registry, xml_parent, data):
Minimal Example:
.. literalinclude:: /../../tests/publishers/fixtures/logparser-minimal.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/logparser-minimal.yaml
:language: yaml
Full Example:
.. literalinclude:: /../../tests/publishers/fixtures/logparser-full.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/logparser-full.yaml
:language: yaml
"""
clog = XML.SubElement(xml_parent,
@ -2370,8 +2386,8 @@ def jira(registry, xml_parent, data):
Example:
.. literalinclude:: /../../tests/publishers/fixtures/jira001.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/jira001.yaml
:language: yaml
"""
XML.SubElement(xml_parent, 'hudson.plugins.jira.JiraIssueUpdater')
@ -2387,13 +2403,13 @@ def growl(registry, xml_parent, data):
Minimal Example:
.. literalinclude:: /../../tests/publishers/fixtures/growl-minimal.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/growl-minimal.yaml
:language: yaml
Full Example:
.. literalinclude:: /../../tests/publishers/fixtures/growl-full.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/growl-full.yaml
:language: yaml
"""
growl = XML.SubElement(xml_parent, 'hudson.plugins.growl.GrowlPublisher')
growl.set('plugin', 'growl')
@ -2429,9 +2445,9 @@ def groovy_postbuild(registry, xml_parent, data):
Example:
.. literalinclude::
/../../tests/publishers/fixtures/groovy-postbuild001.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/groovy-postbuild001.yaml
:language: yaml
"""
logger = logging.getLogger("%s:groovy-postbuild" % __name__)
# Backward compatibility with old format
@ -2571,8 +2587,8 @@ def cifs(registry, xml_parent, data):
Example:
.. literalinclude:: /../../tests/publishers/fixtures/cifs001.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/cifs001.yaml
:language: yaml
"""
console_prefix = 'CIFS: '
@ -2599,8 +2615,8 @@ def cigame(registry, xml_parent, data):
Example:
.. literalinclude:: /../../tests/publishers/fixtures/cigame.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/cigame.yaml
:language: yaml
"""
XML.SubElement(xml_parent, 'hudson.plugins.cigame.GamePublisher')
@ -2644,12 +2660,13 @@ def sonar(registry, xml_parent, data):
Minimal Example:
.. literalinclude:: /../../tests/publishers/fixtures/sonar-minimal.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/sonar-minimal.yaml
:language: yaml
Full Example:
.. literalinclude:: /../../tests/publishers/fixtures/sonar-full.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/sonar-full.yaml
:language: yaml
"""
sonar = XML.SubElement(xml_parent, 'hudson.plugins.sonar.SonarPublisher')
@ -2730,15 +2747,15 @@ def performance(registry, xml_parent, data):
Minimal Example:
.. literalinclude::
/../../tests/publishers/fixtures/performance-minimal.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/performance-minimal.yaml
:language: yaml
Full Example:
.. literalinclude::
/../../tests/publishers/fixtures/performance-full.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/performance-full.yaml
:language: yaml
"""
perf = XML.SubElement(xml_parent, 'hudson.plugins.performance.'
'PerformancePublisher')
@ -2825,8 +2842,9 @@ def join_trigger(registry, xml_parent, data):
Example:
.. literalinclude:: /../../tests/publishers/fixtures/join-trigger001.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/join-trigger001.yaml
:language: yaml
"""
jointrigger = XML.SubElement(xml_parent, 'join.JoinTrigger')
@ -2879,13 +2897,14 @@ def jabber(registry, xml_parent, data):
Minimal Example:
.. literalinclude:: /../../tests/publishers/fixtures/jabber-minimal.yaml
:language: yaml
.. literalinclude::
/../../tests/publishers/fixtures/jabber-minimal.yaml
:language: yaml
Full Example:
.. literalinclude:: /../../tests/publishers/fixtures/jabber-full.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/jabber-full.yaml
:language: yaml
"""
j = XML.SubElement(xml_parent, 'hudson.plugins.jabber.im.transport.'
'JabberPublisher')
@ -6662,15 +6681,15 @@ def jms_messaging(registry, xml_parent, data):
Full Example:
.. literalinclude::
../../tests/publishers/fixtures/jms-messaging-full.yaml
:language: yaml
.. literalinclude::
../../tests/publishers/fixtures/jms-messaging-full.yaml
:language: yaml
Minimal Example:
.. literalinclude::
../../tests/publishers/fixtures/jms-messaging-minimal.yaml
:language: yaml
.. literalinclude::
../../tests/publishers/fixtures/jms-messaging-minimal.yaml
:language: yaml
"""
helpers.jms_messaging_common(xml_parent, 'com.redhat.jenkins.plugins.ci.'
'CIMessageNotifier', data)
@ -6702,15 +6721,15 @@ def openshift_build_canceller(registry, xml_parent, data):
Full Example:
.. literalinclude::
../../tests/publishers/fixtures/openshift-build-canceller001.yaml
:language: yaml
.. literalinclude::
../../tests/publishers/fixtures/openshift-build-canceller001.yaml
:language: yaml
Minimal Example:
.. literalinclude::
../../tests/publishers/fixtures/openshift-build-canceller002.yaml
:language: yaml
.. literalinclude::
../../tests/publishers/fixtures/openshift-build-canceller002.yaml
:language: yaml
"""
osb = XML.SubElement(xml_parent,
@ -6750,15 +6769,15 @@ def openshift_deploy_canceller(registry, xml_parent, data):
Full Example:
.. literalinclude::
../../tests/publishers/fixtures/openshift-deploy-canceller001.yaml
:language: yaml
.. literalinclude::
../../tests/publishers/fixtures/openshift-deploy-canceller001.yaml
:language: yaml
Minimal Example:
.. literalinclude::
../../tests/publishers/fixtures/openshift-deploy-canceller002.yaml
:language: yaml
.. literalinclude::
../../tests/publishers/fixtures/openshift-deploy-canceller002.yaml
:language: yaml
"""
osb = XML.SubElement(xml_parent,
@ -6796,15 +6815,15 @@ def github_pull_request_merge(registry, xml_parent, data):
Full Example:
.. literalinclude::
../../tests/publishers/fixtures/github-pull-request-merge001.yaml
:language: yaml
.. literalinclude::
../../tests/publishers/fixtures/github-pull-request-merge001.yaml
:language: yaml
Minimal Example:
.. literalinclude::
../../tests/publishers/fixtures/github-pull-request-merge002.yaml
:language: yaml
.. literalinclude::
../../tests/publishers/fixtures/github-pull-request-merge002.yaml
:language: yaml
"""
osb = XML.SubElement(xml_parent,
@ -6830,8 +6849,8 @@ def chuck_norris(registry, xml_parent, data):
Example:
.. literalinclude:: /../../tests/publishers/fixtures/chuck-norris.yaml
:language: yaml
.. literalinclude:: /../../tests/publishers/fixtures/chuck-norris.yaml
:language: yaml
"""
chuck = XML.SubElement(xml_parent,

2
jenkins_jobs/modules/scm.py
View File

@ -793,8 +793,10 @@ def svn(registry, xml_parent, data):
:arg list repos: list of repositories to checkout (optional)
:arg list additional-credentials: list of additional credentials (optional)
:Additional-Credentials:
* **realm** (`str`) -- realm to use
* **credentials-id** (`str`) -- optional ID of credentials to use
:arg str viewvc-url: URL of the svn web interface (optional)
:Repo:

2
jenkins_jobs/modules/triggers.py
View File

@ -1928,7 +1928,7 @@ def stash_pull_request(registry, xml_parent, data):
"""yaml: stash-pull-request
Trigger builds via Stash/Bitbucket Server Pull Requests.
Requires the Jenkins :jenkins-wiki:`Stash Pull Request Builder Plugin
<Stash+pullrequest+builder+plugin>`.
<Stash+pullrequest+builder+plugin>`.
:arg str cron: cron syntax of when to run (required)
:arg str stash-host: The HTTP or HTTPS URL of the Stash host (NOT ssh).

2
jenkins_jobs/modules/view_list.py
View File

@ -16,7 +16,7 @@
The view list module handles creating Jenkins List views.
To create a list view specify ``list`` in the ``view-type`` attribute
to the :ref:`View-list` definition.
to the :ref:`view_list` definition.
:View Parameters:
* **name** (`str`): The name of the view.

2
jenkins_jobs/modules/view_pipeline.py
View File

@ -15,7 +15,7 @@
"""
The view pipeline module handles creating Jenkins Build Pipeline views.
To create a list view specify ``list`` in the ``view-type`` attribute
to the :ref:`View-pipeline` definition.
to the :ref:`view_pipeline` definition.
Requires the Jenkins
:jenkins-wiki:`Build Pipeline Plugin <build+pipeline+plugin>`.

1
setup.cfg
View File

@ -2,6 +2,7 @@
all_files = 1
build-dir = doc/build
source-dir = doc/source
warning-is-error = 1
[metadata]
name = jenkins-job-builder

2
test-requirements.txt
View File

@ -6,7 +6,7 @@ hacking<0.13,>=0.12.0 # Apache-2.0
coverage>=4.0 # Apache-2.0
fixtures>=3.0.0 # Apache-2.0/BSD
python-subunit>=0.0.18 # Apache-2.0/BSD
sphinx>=1.3.1,<1.5.0
sphinx>=1.5.0,<1.7.0
testscenarios>=0.4 # Apache-2.0/BSD
testtools>=1.4.0 # MIT
testrepository>=0.0.18 # Apache-2.0/BSD

2
tests/base.py
View File

@ -52,7 +52,7 @@ from jenkins_jobs.xml_config import XmlJobGenerator
# This dance deals with the fact that we want unittest.mock if
# we're on Python 3.4 and later, and non-stdlib mock otherwise.
try:
from unittest import mock
from unittest import mock # noqa
except ImportError:
import mock # noqa