jjb/jenkins-job-builder
Code Issues Proposed changes
jenkins-job-builder/jenkins_jobs/modules/triggers.py
Eric Ball 930dd24dd2
Fix: Update sphinx version pin, fix warnings 
Sphinx was pinned to >1.5.0 <=1.7.0 4 years ago. It is now on v4.4.0,
and we're seeing an incompatibility with the latest version of jinja2.

Along with updating the Sphinx version, this also includes fixes for
several warnings generated in the latest version:
  * Outdated docs due to the removal of the "parser" param from
    Base.get_xml
  * Class lookup issues
  * External links for which we have extlinks defined
  * Deprated PyModulelevel is replaced by PyFunction
  * sphinx.ext.autodoc.Documenter.get_doc signature changed

Signed-off-by: Eric Ball <eball@linuxfoundation.org>
Change-Id: Iba65fb724f098f3e4a0b20f2a183cb2ea3c450ea
2022-03-31 15:44:40 -07:00

2774 lines
112 KiB
Python
Raw Blame History

# Copyright 2012 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.
"""
Triggers define what causes a Jenkins job to start building.
**Component**: triggers
:Macro: trigger
:Entry Point: jenkins_jobs.triggers
Example::
job:
name: test_job
triggers:
- timed: '@daily'
"""
import logging
import pkg_resources
import re
import sys
import xml.etree.ElementTree as XML
import six
from jenkins_jobs.errors import InvalidAttributeError
from jenkins_jobs.errors import JenkinsJobsException
from jenkins_jobs.errors import MissingAttributeError
import jenkins_jobs.modules.base
from jenkins_jobs.modules import hudson_model
import jenkins_jobs.modules.helpers as helpers
logger = logging.getLogger(str(__name__))
def gerrit_handle_legacy_configuration(data):
hyphenizer = re.compile("[A-Z]")
def hyphenize(attr):
"""Convert strings like triggerOn to trigger-on."""
return hyphenizer.sub(lambda x: "-%s" % x.group(0).lower(), attr)
def convert_dict(d, old_keys):
for old_key in old_keys:
if old_key in d:
new_key = hyphenize(old_key)
logger.warning(
"'%s' is deprecated and will be removed after "
"1.0.0, please use '%s' instead",
old_key,
new_key,
)
d[new_key] = d[old_key]
del d[old_key]
convert_dict(
data,
[
"triggerOnPatchsetUploadedEvent",
"triggerOnChangeAbandonedEvent",
"triggerOnChangeMergedEvent",
"triggerOnChangeRestoredEvent",
"triggerOnCommentAddedEvent",
"triggerOnDraftPublishedEvent",
"triggerOnRefUpdatedEvent",
"triggerApprovalCategory",
"triggerApprovalValue",
"overrideVotes",
"gerritBuildSuccessfulVerifiedValue",
"gerritBuildFailedVerifiedValue",
"failureMessage",
"skipVote",
],
)
for project in data.get("projects", []):
convert_dict(
project,
[
"projectCompareType",
"projectPattern",
"branchCompareType",
"branchPattern",
],
)
mapping_obj_type = type(data)
old_format_events = mapping_obj_type(
(key, should_register)
for key, should_register in six.iteritems(data)
if key.startswith("trigger-on-")
)
trigger_on = data.setdefault("trigger-on", [])
if old_format_events:
logger.warning(
"The events: %s; which you used is/are deprecated. "
"Please use 'trigger-on' instead.",
", ".join(old_format_events),
)
if old_format_events and trigger_on:
raise JenkinsJobsException(
"Both, the new format (trigger-on) and old format (trigger-on-*) "
"gerrit events format found. Please use either the new or the old "
"format of trigger events definition."
)
trigger_on.extend(
event_name[len("trigger-on-") :]
for event_name, should_register in six.iteritems(old_format_events)
if should_register
)
for idx, event in enumerate(trigger_on):
if event == "comment-added-event":
trigger_on[idx] = events = mapping_obj_type()
try:
events["comment-added-event"] = mapping_obj_type(
(
("approval-category", data["trigger-approval-category"]),
("approval-value", data["trigger-approval-value"]),
)
)
except KeyError:
raise JenkinsJobsException(
"The comment-added-event trigger requires which approval "
"category and value you want to trigger the job. "
"It should be specified by the approval-category "
"and approval-value properties."
)
def build_gerrit_triggers(xml_parent, data, plugin_ver):
available_simple_triggers = {
"change-abandoned-event": "PluginChangeAbandonedEvent",
"change-merged-event": "PluginChangeMergedEvent",
"change-restored-event": "PluginChangeRestoredEvent",
"draft-published-event": "PluginDraftPublishedEvent",
"patchset-uploaded-event": "PluginPatchsetCreatedEvent",
"patchset-created-event": "PluginPatchsetCreatedEvent",
"private-state-changed-event": "PluginPrivateStateChangedEvent",
"ref-updated-event": "PluginRefUpdatedEvent",
"topic-changed-event": "PluginTopicChangedEvent",
"wip-state-changed-event": "PluginWipStateChangedEvent",
}
tag_namespace = (
"com.sonyericsson.hudson.plugins.gerrit.trigger." "hudsontrigger.events"
)
trigger_on_events = XML.SubElement(xml_parent, "triggerOnEvents")
for event in data.get("trigger-on", []):
if isinstance(event, six.string_types):
tag_name = available_simple_triggers.get(event)
if event == "patchset-uploaded-event":
logger.warning(
"'%s' is deprecated. Use 'patchset-created-event' "
"format instead.",
event,
)
if not tag_name:
known = ", ".join(
available_simple_triggers.keys()
+ ["comment-added-event", "comment-added-contains-event"]
)
msg = (
"The event '%s' under 'trigger-on' is not one of the " "known: %s."
) % (event, known)
raise JenkinsJobsException(msg)
XML.SubElement(trigger_on_events, "%s.%s" % (tag_namespace, tag_name))
else:
if "patchset-created-event" in event.keys():
pce = event["patchset-created-event"]
pc = XML.SubElement(
trigger_on_events,
"%s.%s" % (tag_namespace, "PluginPatchsetCreatedEvent"),
)
mapping = [
("exclude-drafts", "excludeDrafts", False),
("exclude-trivial-rebase", "excludeTrivialRebase", False),
("exclude-no-code-change", "excludeNoCodeChange", False),
("exclude-private", "excludePrivateState", False),
("exclude-wip", "excludeWipState", False),
]
if plugin_ver >= pkg_resources.parse_version("2.32.0"):
mapping.append(
(
"commit-message-contains-regex",
"commitMessageContainsRegEx",
"",
)
)
helpers.convert_mapping_to_xml(pc, pce, mapping, fail_required=True)
if "comment-added-event" in event.keys():
comment_added_event = event["comment-added-event"]
cadded = XML.SubElement(
trigger_on_events,
"%s.%s" % (tag_namespace, "PluginCommentAddedEvent"),
)
mapping = [
("approval-category", "verdictCategory", None),
("approval-value", "commentAddedTriggerApprovalValue", None),
]
helpers.convert_mapping_to_xml(
cadded, comment_added_event, mapping, fail_required=True
)
if "comment-added-contains-event" in event.keys():
comment_added_event = event["comment-added-contains-event"]
caddedc = XML.SubElement(
trigger_on_events,
"%s.%s" % (tag_namespace, "PluginCommentAddedContainsEvent"),
)
XML.SubElement(
caddedc, "commentAddedCommentContains"
).text = comment_added_event["comment-contains-value"]
def build_gerrit_skip_votes(xml_parent, data, plugin_ver):
outcomes = [
("successful", "onSuccessful"),
("failed", "onFailed"),
("unstable", "onUnstable"),
("notbuilt", "onNotBuilt"),
]
if plugin_ver >= pkg_resources.parse_version("2.32.0"):
outcomes.append(("aborted", "onAborted"))
skip_vote_node = XML.SubElement(xml_parent, "skipVote")
skip_vote = data.get("skip-vote", {})
for result_kind, tag_name in outcomes:
setting = skip_vote.get(result_kind, False)
XML.SubElement(skip_vote_node, tag_name).text = str(setting).lower()
def build_cancellation_policy(xml_parent, data, plugin_ver):
if plugin_ver >= pkg_resources.parse_version("2.32.0"):
options = [
("abort-new-patchsets", "abortNewPatchsets"),
("abort-manual-patchsets", "abortManualPatchsets"),
("abort-same-topic", "abortSameTopic"),
]
build_cancellation_policy_node = XML.SubElement(
xml_parent, "buildCancellationPolicy"
)
build_cancellation_policy_object = data.get("build-cancellation-policy", {})
XML.SubElement(build_cancellation_policy_node, "enabled").text = "true"
for tag, tag_name in options:
setting = build_cancellation_policy_object.get(tag, False)
XML.SubElement(build_cancellation_policy_node, tag_name).text = str(
setting
).lower()
def build_gerrit_parameter_modes(xml_parent, data, plugin_ver):
if plugin_ver < pkg_resources.parse_version("2.18.0"):
for parameter_name in (
"commit-message",
"name-and-email",
"change-subject",
"comment-text",
):
parameter_mode = "{}-parameter-mode".format(parameter_name)
if parameter_mode in data:
logger.warning(
"Gerrit Trigger property '{}' is not supported in this "
"plugin version".format(parameter_mode)
)
deprecated_mappings = (
("no-name-and-email", "noNameAndEmailParameters", False),
("readable-message", "readableMessage", False),
)
helpers.convert_mapping_to_xml(
xml_parent, data, deprecated_mappings, fail_required=True
)
else: # version >= 2.18.0
readable_message = data.get("readable-message")
if readable_message is not None:
logger.warning("Gerrit Trigger property 'readable-message' is deprecated")
no_name_and_email = data.get("no-name-and-email")
if no_name_and_email is not None:
logger.warning("Gerrit Trigger property 'no-name-and-email' is deprecated")
allowed_parameter_modes = ["NONE", "PLAIN", "BASE64"]
new_mappings = (
(
"commit-message-parameter-mode",
"commitMessageParameterMode",
"BASE64" if readable_message is not True else "PLAIN",
allowed_parameter_modes,
),
(
"name-and-email-parameter-mode",
"nameAndEmailParameterMode",
"PLAIN" if no_name_and_email is not True else "NONE",
allowed_parameter_modes,
),
(
"change-subject-parameter-mode",
"changeSubjectParameterMode",
"PLAIN",
allowed_parameter_modes,
),
(
"comment-text-parameter-mode",
"commentTextParameterMode",
"BASE64",
allowed_parameter_modes,
),
)
helpers.convert_mapping_to_xml(
xml_parent, data, new_mappings, fail_required=True
)
def gerrit(registry, xml_parent, data):
"""yaml: gerrit
Trigger on a Gerrit event.
Requires the Jenkins :jenkins-plugins:`Gerrit Trigger Plugin
<gerrit-trigger>` version >= 2.6.0.
:arg list trigger-on: Events to react on. Please use either the new
**trigger-on**, or the old **trigger-on-*** events definitions. You
cannot use both at once.
.. _trigger_on:
:Trigger on:
* **patchset-created-event** (`dict`) -- Trigger upon patchset
creation.
:Patchset created:
* **exclude-drafts** (`bool`) -- exclude drafts (default false)
* **exclude-trivial-rebase** (`bool`) -- exclude trivial rebase
(default false)
* **exclude-no-code-change** (`bool`) -- exclude no code change
(default false)
* **exclude-private** (`bool`) -- exclude private change
(default false)
* **exclude-wip** (`bool`) -- exclude wip change
(default false)
* **commit-message-contains-regex** (`str`) -- Commit message
contains regular expression. (default '')
Requires Gerrit Trigger Plugin >= 2.32.0
exclude-private|exclude-wip needs
Gerrit Trigger v2.29.0
Exclude drafts|trivial-rebase|no-code-change needs
Gerrit Trigger v2.12.0
* **patchset-uploaded-event** -- Trigger upon patchset creation
(this is a alias for `patchset-created-event`).
.. deprecated:: 1.1.0 Please use :ref:`trigger-on <trigger_on>`.
* **change-abandoned-event** -- Trigger on patchset abandoned.
Requires Gerrit Trigger Plugin version >= 2.8.0.
* **change-merged-event** -- Trigger on change merged
* **change-restored-event** -- Trigger on change restored. Requires
Gerrit Trigger Plugin version >= 2.8.0
* **draft-published-event** -- Trigger on draft published event.
* **ref-updated-event** -- Trigger on ref-updated.
Gerrit Trigger Plugin version >= 2.29.0
* **topic-changed-event** -- Trigger on topic-changed.
Gerrit Trigger Plugin version >= 2.26.0
* **private-state-changed-event** -- Trigger on private state changed event.
* **wip-state-changed-event** -- Trigger on wip state changed event.
Gerrit Trigger Plugin version >= 2.8.0
* **comment-added-event** (`dict`) -- Trigger on comment added.
:Comment added:
* **approval-category** (`str`) -- Approval (verdict) category
(for example 'APRV', 'CRVW', 'VRIF' -- see `Gerrit access
control
<https://gerrit-review.googlesource.com/Documentation/
access-control.html#access_categories>`_
* **approval-value** -- Approval value for the comment added.
* **comment-added-contains-event** (`dict`) -- Trigger on comment
added contains Regular Expression.
:Comment added contains:
* **comment-contains-value** (`str`) -- Comment contains
Regular Expression value.
:arg bool trigger-on-patchset-uploaded-event: Trigger on patchset upload.
.. deprecated:: 1.1.0. Please use :ref:`trigger-on <trigger_on>`.
:arg bool trigger-on-change-abandoned-event: Trigger on change abandoned.
Requires Gerrit Trigger Plugin version >= 2.8.0
.. deprecated:: 1.1.0. Please use :ref:`trigger-on <trigger_on>`.
:arg bool trigger-on-change-merged-event: Trigger on change merged
.. deprecated:: 1.1.0. Please use :ref:`trigger-on <trigger_on>`.
:arg bool trigger-on-change-restored-event: Trigger on change restored.
Requires Gerrit Trigger Plugin version >= 2.8.0
.. deprecated:: 1.1.0. Please use :ref:`trigger-on <trigger_on>`.
:arg bool trigger-on-comment-added-event: Trigger on comment added
.. deprecated:: 1.1.0. Please use :ref:`trigger-on <trigger_on>`.
:arg bool trigger-on-draft-published-event: Trigger on draft published
event
.. deprecated:: 1.1.0 Please use :ref:`trigger-on <trigger_on>`.
:arg bool trigger-on-ref-updated-event: Trigger on ref-updated
.. deprecated:: 1.1.0. Please use :ref:`trigger-on <trigger_on>`.
:arg str trigger-approval-category: Approval category for comment added
.. deprecated:: 1.1.0. Please use :ref:`trigger-on <trigger_on>`.
:arg int trigger-approval-value: Approval value for comment added
.. deprecated:: 1.1.0. Please use :ref:`trigger-on <trigger_on>`.
:arg bool override-votes: Override default vote values
:arg int gerrit-build-started-verified-value: Started ''Verified'' value
:arg int gerrit-build-successful-verified-value: Successful ''Verified''
value
:arg int gerrit-build-failed-verified-value: Failed ''Verified'' value
:arg int gerrit-build-unstable-verified-value: Unstable ''Verified'' value
:arg int gerrit-build-notbuilt-verified-value: Not built ''Verified''
value
:arg int gerrit-build-aborted-verified-value: Aborted ''Verified'' value
Requires Gerrit Trigger Plugin version >= 2.31.0
:arg int gerrit-build-started-codereview-value: Started ''CodeReview''
value
:arg int gerrit-build-successful-codereview-value: Successful
''CodeReview'' value
:arg int gerrit-build-failed-codereview-value: Failed ''CodeReview'' value
:arg int gerrit-build-unstable-codereview-value: Unstable ''CodeReview''
value
:arg int gerrit-build-notbuilt-codereview-value: Not built ''CodeReview''
value
:arg int gerrit-build-aborted-codereview-value: Aborted ''CodeReview''
value
Requires Gerrit Trigger Plugin version >= 2.31.0
:arg str failure-message: Message to leave on failure (default '')
:arg str successful-message: Message to leave on success (default '')
:arg str unstable-message: Message to leave when unstable (default '')
:arg str notbuilt-message: Message to leave when not built (default '')
:arg str aborted-message: Message to leave when aborted (default '')
:arg str failure-message-file: Sets the filename within the workspace from
which to retrieve the unsuccessful review message. (optional)
:arg list projects: list of projects to match
:Project: * **project-compare-type** (`str`) -- ''PLAIN'', ''ANT'' or
''REG_EXP''
* **project-pattern** (`str`) -- Project name pattern to match
* **branch-compare-type** (`str`) -- ''PLAIN'', ''ANT'' or
''REG_EXP'' (not used if `branches` list is specified)
.. deprecated:: 1.1.0 Please use :ref:`branches <branches>`.
* **branch-pattern** (`str`) -- Branch name pattern to match
(not used if `branches` list is specified)
.. deprecated:: 1.1.0 Please use :ref:`branches <branches>`.
.. _branches:
* **branches** (`list`) -- List of branches to match
(optional)
:Branch: * **branch-compare-type** (`str`) -- ''PLAIN'',
''ANT'' or ''REG_EXP'' (optional) (default
''PLAIN'')
* **branch-pattern** (`str`) -- Branch name pattern
to match
* **file-paths** (`list`) -- List of file paths to match
(optional)
:File Path: * **compare-type** (`str`) -- ''PLAIN'', ''ANT''
or ''REG_EXP'' (optional) (default ''PLAIN'')
* **pattern** (`str`) -- File path pattern to
match
* **forbidden-file-paths** (`list`) -- List of file paths to
skip triggering (optional)
:Forbidden File Path: * **compare-type** (`str`) --
''PLAIN'', ''ANT'' or ''REG_EXP'' (optional)
(default ''PLAIN'')
* **pattern** (`str`) -- File path pattern to
match
* **topics** (`list`) -- List of topics to match
(optional)
:Topic: * **compare-type** (`str`) -- ''PLAIN'', ''ANT'' or
''REG_EXP'' (optional) (default ''PLAIN'')
* **pattern** (`str`) -- Topic name pattern to
match
* **disable-strict-forbidden-file-verification** (`bool`) --
Enabling this option will allow an event to trigger a
build if the event contains BOTH one or more wanted file
paths AND one or more forbidden file paths. In other
words, with this option, the build will not get
triggered if the change contains only forbidden files,
otherwise it will get triggered. Requires plugin
version >= 2.16.0 (default false)
:arg dict skip-vote: map of build outcomes for which Jenkins must skip
vote. Requires Gerrit Trigger Plugin version >= 2.7.0
:Outcome: * **successful** (`bool`)
* **failed** (`bool`)
* **unstable** (`bool`)
* **notbuilt** (`bool`)
* **aborted** (`bool`) -- Requires Gerrit Trigger Plugin version >= 2.31.0
:arg bool silent: When silent mode is on there will be no communication
back to Gerrit, i.e. no build started/failed/successful approve
messages etc. If other non-silent jobs are triggered by the same
Gerrit event as this job, the result of this job's build will not be
counted in the end result of the other jobs. (default false)
:arg bool silent-start: Sets silent start mode to on or off. When silent
start mode is on there will be no 'build started' messages sent back
to Gerrit. (default false)
:arg bool escape-quotes: escape quotes in the values of Gerrit change
parameters (default true)
:arg dict build-cancellation-policy: If used, rules regarding
cancellation of builds can be set with this option when
patchsets of the same change comes in. This setting overrides global
server configuration. If build-cancellation-policy is not present in
YAML the global server configuration is used.
Requires Gerrit Trigger Plugin version >= 2.32.0
:Options: * **abort-new-patchsets** (`bool`) -- Only running jobs
will be cancelled if a new patch version is pushed over
(default false).
* **abort-manual-patchsets** (`bool`) -- Builds triggered
manually will be aborted when a new patch set arrives
(default false).
* **abort-same-topic** (`bool`) -- Builds triggered with
topic will be aborted when a new patch set with the
same topic arrives (default false).
:arg bool no-name-and-email: Do not pass compound 'name and email'
parameters (default false)
.. deprecated:: 3.5.0 Please use `name-and-email-parameter-mode`
parameter.
:arg bool readable-message: If parameters regarding multiline text,
e.g. commit message, should be as human readable or not. If false,
those parameters are Base64 encoded to keep environment variables
clean. (default false)
.. deprecated:: 3.5.0 Please use `commit-message-parameter-mode`
parameter.
:arg str name-and-email-parameter-mode: The parameter mode for the compound
"name and email" parameters (like GERRIT_PATCHSET_UPLOADER or
GERRIT_CHANGE_OWNER). This can either be 'NONE' to avoid passing the
parameter all together, 'PLAIN' to pass the parameter in human readable
form, or 'BASE64' to pass the parameter in base64 encoded form (default
'PLAIN'). Requires Gerrit Trigger Plugin version >= 2.18.0.
:arg str commit-message-parameter-mode: The parameter mode for the
GERRIT_CHANGE_COMMIT_MESSAGE parameter. This can either be 'NONE' to
avoid passing the parameter all together, 'PLAIN' to pass the parameter
in human readable form, or 'BASE64' to pass the parameter in base64
encoded form (default 'BASE64'). Requires Gerrit Trigger Plugin version
>= 2.18.0.
:arg str change-subject-parameter-mode: The parameter mode for the
GERRIT_CHANGE_SUBJECT parameter. This can either be 'NONE' to avoid
passing the parameter all together, 'PLAIN' to pass the parameter in
human readable form, or 'BASE64' to pass the parameter in base64
encoded form (default 'PLAIN'). Requires Gerrit Trigger Plugin version
>= 2.18.0.
:arg str comment-text-parameter-mode: The parameter mode for the
GERRIT_EVENT_COMMENT_TEXT parameter. This can either be 'NONE' to avoid
passing the parameter all together, 'PLAIN' to pass the parameter in
human readable form, or 'BASE64' to pass the parameter in base64
encoded form (default 'BASE64'). Requires Gerrit Trigger Plugin version
>= 2.18.0.
:arg str dependency-jobs: All jobs on which this job depends. If a commit
should trigger both a dependency and this job, the dependency will be
built first. Use commas to separate job names. Beware of cyclic
dependencies. (optional)
:arg str notification-level: Defines to whom email notifications should be
sent. This can either be nobody ('NONE'), the change owner ('OWNER'),
reviewers and change owner ('OWNER_REVIEWERS'), all interested users
i.e. owning, reviewing, watching, and starring ('ALL') or server
default ('SERVER_DEFAULT'). (default 'SERVER_DEFAULT')
:arg bool dynamic-trigger-enabled: Enable/disable the dynamic trigger
(default false)
:arg str dynamic-trigger-url: if you specify this option, the Gerrit
trigger configuration will be fetched from there on a regular interval
:arg bool trigger-for-unreviewed-patches: trigger patchset-created events
for changes that were uploaded while connection to Gerrit was down
(default false). Requires Gerrit Trigger Plugin version >= 2.11.0.
.. deprecated:: 3.5.0 Supported for Gerrit Trigger Plugin versions
< 2.14.0. See
:jenkins-plugins:`Missed Events Playback Feature <gerrit-trigger/#plugin-content-missed-events-playback-feature-available-from-v-2140>`.
:arg str custom-url: Custom URL for a message sent to Gerrit. Build
details URL will be used if empty. (default '')
:arg str server-name: Name of the server to trigger on, or ''__ANY__'' to
trigger on any configured Gerrit server (default '__ANY__'). Requires
Gerrit Trigger Plugin version >= 2.11.0
You may select one or more Gerrit events upon which to trigger.
You must also supply at least one project and branch, optionally
more. If you select the comment-added trigger, you should also
indicate which approval category and value you want to trigger the
job.
Until version 0.4.0 of Jenkins Job Builder, camelCase keys were used to
configure Gerrit Trigger Plugin, instead of hyphenated-keys. While still
supported, camedCase keys are deprecated and should not be used. Support
for this will be removed after 1.0.0 is released.
Example:
.. literalinclude:: /../../tests/triggers/fixtures/gerrit004.yaml
:language: yaml
"""
def get_compare_type(xml_tag, compare_type):
valid_compare_types = ["PLAIN", "ANT", "REG_EXP"]
if compare_type not in valid_compare_types:
raise InvalidAttributeError(xml_tag, compare_type, valid_compare_types)
return compare_type
gerrit_handle_legacy_configuration(data)
plugin_info = registry.get_plugin_info("Gerrit Trigger")
plugin_ver = pkg_resources.parse_version(
plugin_info.get("version", str(sys.maxsize))
)
projects = data.get("projects", [])
gtrig = XML.SubElement(
xml_parent,
"com.sonyericsson.hudson.plugins.gerrit.trigger." "hudsontrigger.GerritTrigger",
)
XML.SubElement(gtrig, "spec")
gprojects = XML.SubElement(gtrig, "gerritProjects")
for project in projects:
gproj = XML.SubElement(
gprojects,
"com.sonyericsson.hudson.plugins.gerrit."
"trigger.hudsontrigger.data.GerritProject",
)
XML.SubElement(gproj, "compareType").text = get_compare_type(
"project-compare-type", project.get("project-compare-type", "PLAIN")
)
XML.SubElement(gproj, "pattern").text = project["project-pattern"]
branches = XML.SubElement(gproj, "branches")
project_branches = project.get("branches", [])
if "branch-compare-type" in project and "branch-pattern" in project:
warning = (
"branch-compare-type and branch-pattern at project "
"level are deprecated and support will be removed "
"in a later version of Jenkins Job Builder; "
)
if project_branches:
warning += "discarding values and using values from " "branches section"
else:
warning += "please use branches section instead"
logger.warning(warning)
if not project_branches:
project_branches = [
{
"branch-compare-type": project.get("branch-compare-type", "PLAIN"),
"branch-pattern": project["branch-pattern"],
}
]
for branch in project_branches:
gbranch = XML.SubElement(
branches,
"com.sonyericsson.hudson.plugins."
"gerrit.trigger.hudsontrigger.data.Branch",
)
XML.SubElement(gbranch, "compareType").text = get_compare_type(
"branch-compare-type", branch.get("branch-compare-type", "PLAIN")
)
XML.SubElement(gbranch, "pattern").text = branch["branch-pattern"]
project_file_paths = project.get("file-paths", [])
if project_file_paths:
fps_tag = XML.SubElement(gproj, "filePaths")
for file_path in project_file_paths:
fp_tag = XML.SubElement(
fps_tag,
"com.sonyericsson.hudson.plugins."
"gerrit.trigger.hudsontrigger.data."
"FilePath",
)
XML.SubElement(fp_tag, "compareType").text = get_compare_type(
"compare-type", file_path.get("compare-type", "PLAIN")
)
XML.SubElement(fp_tag, "pattern").text = file_path["pattern"]
project_forbidden_file_paths = project.get("forbidden-file-paths", [])
if project_forbidden_file_paths:
ffps_tag = XML.SubElement(gproj, "forbiddenFilePaths")
for forbidden_file_path in project_forbidden_file_paths:
ffp_tag = XML.SubElement(
ffps_tag,
"com.sonyericsson.hudson.plugins."
"gerrit.trigger.hudsontrigger.data."
"FilePath",
)
XML.SubElement(ffp_tag, "compareType").text = get_compare_type(
"compare-type", forbidden_file_path.get("compare-type", "PLAIN")
)
XML.SubElement(ffp_tag, "pattern").text = forbidden_file_path["pattern"]
topics = project.get("topics", [])
if topics:
topics_tag = XML.SubElement(gproj, "topics")
for topic in topics:
topic_tag = XML.SubElement(
topics_tag,
"com.sonyericsson.hudson.plugins."
"gerrit.trigger.hudsontrigger.data."
"Topic",
)
XML.SubElement(topic_tag, "compareType").text = get_compare_type(
"compare-type", topic.get("compare-type", "PLAIN")
)
XML.SubElement(topic_tag, "pattern").text = topic["pattern"]
XML.SubElement(gproj, "disableStrictForbiddenFileVerification").text = str(
project.get("disable-strict-forbidden-file-verification", False)
).lower()
build_gerrit_skip_votes(gtrig, data, plugin_ver)
if "build-cancellation-policy" in data:
build_cancellation_policy(gtrig, data, plugin_ver)
general_mappings = [
("silent", "silentMode", False),
("silent-start", "silentStartMode", False),
("escape-quotes", "escapeQuotes", True),
("dependency-jobs", "dependencyJobsNames", ""),
]
helpers.convert_mapping_to_xml(gtrig, data, general_mappings, fail_required=True)
build_gerrit_parameter_modes(gtrig, data, plugin_ver)
notification_levels = ["NONE", "OWNER", "OWNER_REVIEWERS", "ALL", "SERVER_DEFAULT"]
notification_level = data.get("notification-level", "SERVER_DEFAULT")
if notification_level not in notification_levels:
raise InvalidAttributeError(
"notification-level", notification_level, notification_levels
)
if notification_level == "SERVER_DEFAULT":
XML.SubElement(gtrig, "notificationLevel").text = ""
else:
XML.SubElement(gtrig, "notificationLevel").text = notification_level
XML.SubElement(gtrig, "dynamicTriggerConfiguration").text = str(
data.get("dynamic-trigger-enabled", False)
).lower()
XML.SubElement(gtrig, "triggerConfigURL").text = str(
data.get("dynamic-trigger-url", "")
)
if data.get("dynamic-trigger-enabled", False) is False:
XML.SubElement(gtrig, "dynamicGerritProjects").set("class", "empty-list")
XML.SubElement(gtrig, "triggerInformationAction").text = str(
data.get("trigger-information-action", "")
)
if (plugin_ver >= pkg_resources.parse_version("2.11.0")) and (
plugin_ver < pkg_resources.parse_version("2.14.0")
):
XML.SubElement(gtrig, "allowTriggeringUnreviewedPatches").text = str(
data.get("trigger-for-unreviewed-patches", False)
).lower()
elif "trigger-for-unreviewed-patches" in data:
logger.warning(
"Gerrit Trigger property 'trigger-for-unreviewed-patches' is not "
"supported in this plugin version"
)
build_gerrit_triggers(gtrig, data, plugin_ver)
override = str(data.get("override-votes", False)).lower()
if override == "true":
votes = [
("gerrit-build-started-verified-value", "gerritBuildStartedVerifiedValue"),
(
"gerrit-build-successful-verified-value",
"gerritBuildSuccessfulVerifiedValue",
),
("gerrit-build-failed-verified-value", "gerritBuildFailedVerifiedValue"),
(
"gerrit-build-unstable-verified-value",
"gerritBuildUnstableVerifiedValue",
),
(
"gerrit-build-notbuilt-verified-value",
"gerritBuildNotBuiltVerifiedValue",
),
(
"gerrit-build-started-codereview-value",
"gerritBuildStartedCodeReviewValue",
),
(
"gerrit-build-successful-codereview-value",
"gerritBuildSuccessfulCodeReviewValue",
),
(
"gerrit-build-failed-codereview-value",
"gerritBuildFailedCodeReviewValue",
),
(
"gerrit-build-unstable-codereview-value",
"gerritBuildUnstableCodeReviewValue",
),
(
"gerrit-build-notbuilt-codereview-value",
"gerritBuildNotBuiltCodeReviewValue",
),
]
if plugin_ver >= pkg_resources.parse_version("2.31.0"):
votes.append(
(
"gerrit-build-aborted-verified-value",
"gerritBuildAbortedVerifiedValue",
)
)
votes.append(
(
"gerrit-build-aborted-codereview-value",
"gerritBuildAbortedCodeReviewValue",
)
)
for yamlkey, xmlkey in votes:
if data.get(yamlkey) is not None:
# str(int(x)) makes input values like '+1' work
XML.SubElement(gtrig, xmlkey).text = str(int(data.get(yamlkey)))
message_mappings = [
("start-message", "buildStartMessage", ""),
("failure-message", "buildFailureMessage", ""),
("successful-message", "buildSuccessfulMessage", ""),
("unstable-message", "buildUnstableMessage", ""),
("notbuilt-message", "buildNotBuiltMessage", ""),
("failure-message-file", "buildUnsuccessfulFilepath", ""),
("custom-url", "customUrl", ""),
("server-name", "serverName", "__ANY__"),
]
if plugin_ver >= pkg_resources.parse_version("2.31.0"):
message_mappings.append(("aborted-message", "buildAbortedMessage", ""))
helpers.convert_mapping_to_xml(gtrig, data, message_mappings, fail_required=True)
def dockerhub_notification(registry, xml_parent, data):
"""yaml: dockerhub-notification
The job will get triggered when Docker Hub/Registry notifies
that Docker image(s) used in this job has been rebuilt.
Requires the Jenkins :jenkins-plugins:`CloudBees Docker Hub Notification
<dockerhub-notification>`.
:arg bool referenced-image: Trigger the job based on repositories
used by any compatible docker plugin in this job. (default true)
:arg list repositories: Specified repositories to trigger the job.
(default [])
Minimal Example:
.. literalinclude::
/../../tests/triggers/fixtures/dockerhub-notification-minimal.yaml
:language: yaml
Full Example:
.. literalinclude::
/../../tests/triggers/fixtures/dockerhub-notification-full.yaml
:language: yaml
"""
dockerhub = XML.SubElement(
xml_parent, "org.jenkinsci.plugins." "registry.notification.DockerHubTrigger"
)
dockerhub.set("plugin", "dockerhub-notification")
option = XML.SubElement(dockerhub, "options", {"class": "vector"})
if data.get("referenced-image"):
XML.SubElement(
option,
"org.jenkinsci.plugins."
"registry.notification."
"opt.impl.TriggerForAllUsedInJob",
)
repos = data.get("repositories", [])
if repos:
specified_names = XML.SubElement(
option,
"org.jenkinsci.plugins.registry."
"notification.opt.impl."
"TriggerOnSpecifiedImageNames",
)
repo_tag = XML.SubElement(specified_names, "repoNames")
for repo in repos:
XML.SubElement(repo_tag, "string").text = repo
def pollscm(registry, xml_parent, data):
"""yaml: pollscm
Poll the SCM to determine if there has been a change.
:Parameter: the polling interval (cron syntax)
.. deprecated:: 1.3.0. Please use :ref:`cron <cron>`.
.. _cron:
:arg str cron: the polling interval (cron syntax, required)
:arg bool ignore-post-commit-hooks: Ignore changes notified by SCM
post-commit hooks. The subversion-plugin supports this since
version 1.44. (default false)
Example:
.. literalinclude:: /../../tests/triggers/fixtures/pollscm002.yaml
:language: yaml
"""
try:
cron = data["cron"]
ipch = str(data.get("ignore-post-commit-hooks", False)).lower()
except KeyError as e:
# ensure specific error on the attribute not being set is raised
# for new format
raise MissingAttributeError(e)
except TypeError:
# To keep backward compatibility
logger.warning(
"Your pollscm usage is deprecated, please use"
" the syntax described in the documentation"
" instead"
)
cron = data
ipch = "false"
if not cron and cron != "":
raise InvalidAttributeError("cron", cron)
scmtrig = XML.SubElement(xml_parent, "hudson.triggers.SCMTrigger")
XML.SubElement(scmtrig, "spec").text = cron
XML.SubElement(scmtrig, "ignorePostCommitHooks").text = ipch
def build_content_type(
xml_parent,
entries,
namespace,
collection_suffix,
entry_suffix,
prefix,
collection_name,
element_name,
):
content_type = XML.SubElement(
xml_parent, "{0}.{1}{2}".format(namespace, prefix, collection_suffix)
)
if entries:
collection = XML.SubElement(content_type, collection_name)
for entry in entries:
content_entry = XML.SubElement(
collection, "{0}.{1}{2}".format(namespace, prefix, entry_suffix)
)
XML.SubElement(content_entry, element_name).text = entry
def pollurl(registry, xml_parent, data):
"""yaml: pollurl
Trigger when the HTTP response from a URL changes.
Requires the Jenkins :jenkins-plugins:`URLTrigger Plugin <urltrigger>`.
:arg str cron: cron syntax of when to run (default '')
:arg str polling-node: Restrict where the polling should run.
(optional)
:arg list urls: List of URLs to monitor
:URL: * **url** (`str`) -- URL to monitor for changes (required)
* **proxy** (`bool`) -- Activate the Jenkins proxy (default false)
* **timeout** (`int`) -- Connect/read timeout in seconds
(default 300)
* **username** (`str`) -- User name for basic authentication
(optional)
* **password** (`str`) -- Password for basic authentication
(optional)
* **check-status** (`int`) -- Check for a specific HTTP status
code (optional)
* **check-etag** (`bool`) -- Check the HTTP ETag for changes
(default false)
* **check-date** (`bool`) -- Check the last modification date of
the URL (default false)
* **check-content** (`list`) -- List of content type changes to
monitor
:Content Type: * **simple** (`bool`) -- Trigger on any change to
the content of the URL (default false)
* **json** (`list`) -- Trigger on any change to
the listed JSON paths
* **text** (`list`) -- Trigger on any change to
the listed regular expressions
* **xml** (`list`) -- Trigger on any change to
the listed XPath expressions
Example:
.. literalinclude:: /../../tests/triggers/fixtures/pollurl001.yaml
"""
namespace = "org.jenkinsci.plugins.urltrigger."
valid_content_types = {
"simple": ["Simple", "", "", []],
"json": ["JSON", "jsonPaths", "jsonPath", None],
"text": ["TEXT", "regExElements", "regEx", None],
"xml": ["XML", "xPaths", "xPath", None],
}
urltrig = XML.SubElement(xml_parent, namespace + "URLTrigger")
node = data.get("polling-node")
XML.SubElement(urltrig, "spec").text = data.get("cron", "")
XML.SubElement(urltrig, "labelRestriction").text = str(bool(node)).lower()
if node:
XML.SubElement(urltrig, "triggerLabel").text = node
entries = XML.SubElement(urltrig, "entries")
urls = data.get("urls", [])
if not urls:
raise JenkinsJobsException("At least one url must be provided")
mapping = [
("proxy", "proxyActivated", False),
("timeout", "timeout", 300),
("check-etag", "checkETag", False),
("check-date", "checkLastModificationDate", False),
]
for url in urls:
entry = XML.SubElement(entries, namespace + "URLTriggerEntry")
XML.SubElement(entry, "url").text = url["url"]
if "username" in url:
XML.SubElement(entry, "username").text = url["username"]
if "password" in url:
XML.SubElement(entry, "password").text = url["password"]
if "check-status" in url:
XML.SubElement(entry, "checkStatus").text = "true"
mapping.append(("check-status", "statusCode", ""))
else:
XML.SubElement(entry, "checkStatus").text = "false"
XML.SubElement(entry, "statusCode").text = "200"
helpers.convert_mapping_to_xml(entry, url, mapping, fail_required=False)
check_content = url.get("check-content", [])
XML.SubElement(entry, "inspectingContent").text = str(
bool(check_content)
).lower()
content_types = XML.SubElement(entry, "contentTypes")
for entry in check_content:
type_name = next(iter(entry.keys()))
if type_name not in valid_content_types:
raise JenkinsJobsException(
"check-content must be one of : %s"
% ", ".join(valid_content_types.keys())
)
content_type = valid_content_types.get(type_name)
if entry[type_name]:
sub_entries = content_type[3]
if sub_entries is None:
sub_entries = entry[type_name]
build_content_type(
content_types,
sub_entries,
namespace + "content",
"ContentType",
"ContentEntry",
*content_type[0:3]
)
def jms_messaging(registry, xml_parent, data):
"""yaml: jms-messaging
The JMS Messaging Plugin provides the following functionality:
- A build trigger to submit jenkins jobs upon receipt
of a matching message.
- A builder that may be used to submit a message to the topic
upon the completion of a job
- A post-build action that may be used to submit a message to the topic
upon the completion of a job
JMS Messaging provider types supported:
- ActiveMQ
- FedMsg
Requires the Jenkins :jenkins-plugins:`JMS Messaging Plugin
<jms-messaging>`.
:arg bool no-squash: true = schedule a new job for every triggering message.
(default false)
Normally if a job is queued and another triggering message is received, a new job
is not submitted and the job is "squashed" into the job already queued.
Setting this option to 'True' forces a new job to be submitted for every triggering
message that is received.
:arg str override-topic: If you need to override the default topic.
(default '')
:arg str selector: The JSON or YAML formatted text that conforms to
the schema for defining the various OpenShift resources. (default '')
note: topic needs to be in double quotes
ex. topic = "org.fedoraproject.prod.fedimg.image.upload"
:arg str provider-name: Name of message provider setup in the
global config. (default '')
:arg list checks: List of checks to monitor. (default [])
:arg str field: Check the body of messages for a field. (default '')
:arg str expected-value: Expected value for the field. regex (default '')
Full Example:
.. literalinclude::
../../tests/triggers/fixtures/jms-messaging001.yaml
:language: yaml
Minimal Example:
.. literalinclude::
../../tests/triggers/fixtures/jms-messaging002.yaml
:language: yaml
"""
namespace = "com.redhat.jenkins.plugins.ci."
jmsm = XML.SubElement(xml_parent, namespace + "CIBuildTrigger")
if "override-topic" in data:
overrides = XML.SubElement(jmsm, "overrides")
XML.SubElement(overrides, "topic").text = str(data["override-topic"])
mapping = [
# option, xml name, default value
("spec", "spec", ""),
("no-squash", "noSquash", False),
("selector", "selector", ""),
("provider-name", "providerName", ""),
]
helpers.convert_mapping_to_xml(jmsm, data, mapping, fail_required=True)
checks = data.get("checks", [])
if len(checks) > 0:
msgchecks = XML.SubElement(jmsm, "checks")
for check in checks:
msgcheck = XML.SubElement(
msgchecks, namespace + "messaging.checks.MsgCheck"
)
mapping = [("field", "field", ""), ("expected-value", "expectedValue", "")]
helpers.convert_mapping_to_xml(msgcheck, check, mapping, fail_required=True)
def timed(registry, xml_parent, data):
"""yaml: timed
Trigger builds at certain times.
:Parameter: when to run the job (cron syntax)
Example::
triggers:
- timed: "@midnight"
"""
scmtrig = XML.SubElement(xml_parent, "hudson.triggers.TimerTrigger")
XML.SubElement(scmtrig, "spec").text = data
def bitbucket(registry, xml_parent, data):
"""yaml: bitbucket
Trigger a job when bitbucket repository is pushed to.
Requires the Jenkins :jenkins-plugins:`BitBucket Plugin
<bitbucket>`.
Example:
.. literalinclude:: /../../tests/triggers/fixtures/bitbucket.yaml
"""
bbtrig = XML.SubElement(
xml_parent, "com.cloudbees.jenkins." "plugins.BitBucketTrigger"
)
XML.SubElement(bbtrig, "spec").text = ""
def github(registry, xml_parent, data):
"""yaml: github
Trigger a job when github repository is pushed to.
Requires the Jenkins :jenkins-plugins:`GitHub Plugin <github>`.
Example::
triggers:
- github
"""
ghtrig = XML.SubElement(xml_parent, "com.cloudbees.jenkins." "GitHubPushTrigger")
XML.SubElement(ghtrig, "spec").text = ""
def github_pull_request(registry, xml_parent, data):
"""yaml: github-pull-request
Build pull requests in github and report results.
Requires the Jenkins :jenkins-plugins:`GitHub Pull Request Builder Plugin
<ghprb>`.
:arg list admin-list: the users with admin rights (optional)
:arg list white-list: users whose pull requests build (optional)
:arg list org-list: orgs whose users should be white listed (optional)
:arg bool allow-whitelist-orgs-as-admins: members of white listed orgs
will have admin rights. (default false)
:arg str cron: cron syntax of when to run (optional)
:arg str trigger-phrase: when filled, commenting this phrase
in the pull request will trigger a build (optional)
:arg bool only-trigger-phrase: only commenting the trigger phrase
in the pull request will trigger a build (default false)
:arg str skip-build-phrase: when filled, adding this phrase to
the pull request title or body will not trigger a build (optional)
:arg list black-list-commit-author: When filled, pull request commits from this user(s)
will not trigger a build (optional)
:arg str black-list-labels: list of GitHub labels for which the build
should not be triggered (optional)
:arg str white-list-labels: list of GitHub labels for which the build
should only be triggered. (Leave blank for 'any') (optional)
:arg bool github-hooks: use github hook (default false)
:arg bool permit-all: build every pull request automatically
without asking (default false)
:arg bool auto-close-on-fail: close failed pull request automatically
(default false)
:arg bool display-build-errors-on-downstream-builds: Display build errors on downstream builds
(default false)
:arg list white-list-target-branches: Adding branches to this whitelist
allows you to selectively test pull requests destined for these
branches only. Supports regular expressions (e.g. 'master',
'feature-.*'). (optional)
:arg list black-list-target-branches: Adding branches to this blacklist
allows you to selectively prevent pull requests builds destined for
these branches. Supports regular expressions (e.g. 'master',
'feature-.*'). (optional)
:arg str auth-id: the auth id to use (optional)
:arg str build-desc-template: the template for build descriptions in
jenkins (optional)
:arg str status-context: the context to include on PR status comments
(optional)
:arg str triggered-status: the status message to set when the build has
been triggered (optional)
:arg str started-status: the status comment to set when the build has
been started (optional)
:arg str status-url: the status URL to set (optional)
:arg bool status-add-test-results: add test result one-liner to status
message (optional)
:arg str success-status: the status message to set if the job succeeds
(optional)
:arg str failure-status: the status message to set if the job fails
(optional)
:arg str error-status: the status message to set if the job errors
(optional)
:arg str success-comment: comment to add to the PR on a successful job
(optional)
:arg str failure-comment: comment to add to the PR on a failed job
(optional)
:arg str error-comment: comment to add to the PR on an errored job
(optional)
:arg bool cancel-builds-on-update: cancel existing builds when a PR is
updated (optional)
:arg str comment-file: Extends the standard build comment message on
github with a custom message file. (optional)
:arg bool no-commit-status: Enables "Do not update commit status"
:arg list included-regions: Each inclusion uses regular expression pattern
matching, and must be separated by a new line. An empty list implies
that everything is included. (optional)
:arg list excluded-regions: Each exclusion uses regular expression pattern
matching, and must be separated by a new line. Exclusions take
precedence over inclusions, if there is an overlap between included
and excluded regions. (optional)
Full Example:
.. literalinclude::
/../../tests/triggers/fixtures/github-pull-request-full.yaml
:language: yaml
Minimal Example:
.. literalinclude::
/../../tests/triggers/fixtures/github-pull-request-minimal.yaml
:language: yaml
"""
ghprb = XML.SubElement(xml_parent, "org.jenkinsci.plugins.ghprb." "GhprbTrigger")
mapping = [
(
"allow-whitelist-orgs-as-admins",
"allowMembersOfWhitelistedOrgsAsAdmin",
False,
),
("trigger-phrase", "triggerPhrase", ""),
("skip-build-phrase", "skipBuildPhrase", ""),
("only-trigger-phrase", "onlyTriggerPhrase", False),
("github-hooks", "useGitHubHooks", False),
("permit-all", "permitAll", False),
("auto-close-on-fail", "autoCloseFailedPullRequests", False),
(
"display-build-errors-on-downstream-builds",
"displayBuildErrorsOnDownstreamBuilds",
False,
),
]
XML.SubElement(ghprb, "configVersion").text = "3"
cron_string = data.get("cron", "") or ""
XML.SubElement(ghprb, "spec").text = cron_string
XML.SubElement(ghprb, "cron").text = cron_string
admin_string = "\n".join(data.get("admin-list", []))
XML.SubElement(ghprb, "adminlist").text = admin_string
white_string = "\n".join(data.get("white-list", []))
XML.SubElement(ghprb, "whitelist").text = white_string
org_string = "\n".join(data.get("org-list", []))
XML.SubElement(ghprb, "orgslist").text = org_string
black_list_commit_author_string = " ".join(data.get("black-list-commit-author", ""))
XML.SubElement(
ghprb, "blackListCommitAuthor"
).text = black_list_commit_author_string
white_list_labels_string = "\n".join(data.get("white-list-labels", []))
XML.SubElement(ghprb, "whiteListLabels").text = white_list_labels_string
black_list_labels_string = "\n".join(data.get("black-list-labels", []))
XML.SubElement(ghprb, "blackListLabels").text = black_list_labels_string
excluded_regions_string = "\n".join(data.get("excluded-regions", []))
XML.SubElement(ghprb, "excludedRegions").text = excluded_regions_string
included_regions_string = "\n".join(data.get("included-regions", []))
XML.SubElement(ghprb, "includedRegions").text = included_regions_string
build_desc_template = data.get("build-desc-template", "")
if build_desc_template:
XML.SubElement(ghprb, "buildDescTemplate").text = str(build_desc_template)
else:
XML.SubElement(ghprb, "buildDescTemplate")
helpers.convert_mapping_to_xml(ghprb, data, mapping, fail_required=False)
white_list_target_branches = data.get("white-list-target-branches", [])
ghprb_wltb = XML.SubElement(ghprb, "whiteListTargetBranches")
if white_list_target_branches:
for branch in white_list_target_branches:
be = XML.SubElement(
ghprb_wltb, "org.jenkinsci.plugins." "ghprb.GhprbBranch"
)
XML.SubElement(be, "branch").text = str(branch)
black_list_target_branches = data.get("black-list-target-branches", [])
ghprb_bltb = XML.SubElement(ghprb, "blackListTargetBranches")
if black_list_target_branches:
for branch in black_list_target_branches:
be = XML.SubElement(
ghprb_bltb, "org.jenkinsci.plugins." "ghprb.GhprbBranch"
)
XML.SubElement(be, "branch").text = str(branch)
auth_id = data.get("auth-id", "")
if auth_id:
XML.SubElement(ghprb, "gitHubAuthId").text = str(auth_id)
# PR status update fields
status_context = data.get("status-context", "")
triggered_status = data.get("triggered-status", "")
started_status = data.get("started-status", "")
status_url = data.get("status-url", "")
status_add_test_results = data.get("status-add-test-results", False)
success_status = data.get("success-status", "")
failure_status = data.get("failure-status", "")
error_status = data.get("error-status", "")
# is status handling is required?
requires_status = (
status_context
or triggered_status
or started_status
or status_url
or status_add_test_results
or success_status
or failure_status
or error_status
)
# is status message handling required?
requires_status_message = success_status or failure_status or error_status
# is comment handling required?
success_comment = data.get("success-comment", "")
failure_comment = data.get("failure-comment", "")
error_comment = data.get("error-comment", "")
requires_job_comment = success_comment or failure_comment or error_comment
# When the value of cancel-builds-on-update comes from deep_formatter,
# the value is of type 'str', otherwise the value is of type 'bool'
cancel_builds_on_update = (
str(data.get("cancel-builds-on-update", False)).lower() == "true"
)
comment_file = data.get("comment-file", "")
no_commit_status = data.get("no-commit-status", False)
# We want to have only one 'extensions' subelement, even if status
# handling, comment handling and other extensions are enabled.
if (
requires_status
or requires_job_comment
or cancel_builds_on_update
or comment_file
or no_commit_status
):
extensions = XML.SubElement(ghprb, "extensions")
# Both comment and status elements have this same type. Using a const is
# much easier to read than repeating the tokens for this class each time
# it's used
comment_type = "org.jenkinsci.plugins.ghprb.extensions.comments."
comment_type = comment_type + "GhprbBuildResultMessage"
if requires_status:
simple_status = XML.SubElement(
extensions,
"org.jenkinsci.plugins" ".ghprb.extensions.status." "GhprbSimpleStatus",
)
commit_status_context_element = XML.SubElement(
simple_status, "commitStatusContext"
)
triggered_status_element = XML.SubElement(simple_status, "triggeredStatus")
started_status_element = XML.SubElement(simple_status, "startedStatus")
status_url_element = XML.SubElement(simple_status, "statusUrl")
if status_context:
commit_status_context_element.text = str(status_context)
if triggered_status:
triggered_status_element.text = str(triggered_status)
if started_status:
started_status_element.text = str(started_status)
if status_url:
status_url_element.text = str(status_url)
XML.SubElement(simple_status, "addTestResults").text = str(
status_add_test_results
).lower()
if requires_status_message:
completed_elem = XML.SubElement(simple_status, "completedStatus")
if success_status:
success_elem = XML.SubElement(completed_elem, comment_type)
XML.SubElement(success_elem, "message").text = str(success_status)
XML.SubElement(success_elem, "result").text = "SUCCESS"
if failure_status:
failure_elem = XML.SubElement(completed_elem, comment_type)
XML.SubElement(failure_elem, "message").text = str(failure_status)
XML.SubElement(failure_elem, "result").text = "FAILURE"
if error_status:
error_elem = XML.SubElement(completed_elem, comment_type)
XML.SubElement(error_elem, "message").text = str(error_status)
XML.SubElement(error_elem, "result").text = "ERROR"
# job comment handling
if requires_job_comment:
build_status = XML.SubElement(
extensions,
"org.jenkinsci.plugins.ghprb.extensions" ".comments." "GhprbBuildStatus",
)
messages_elem = XML.SubElement(build_status, "messages")
if success_comment:
success_comment_elem = XML.SubElement(messages_elem, comment_type)
XML.SubElement(success_comment_elem, "message").text = str(success_comment)
XML.SubElement(success_comment_elem, "result").text = "SUCCESS"
if failure_comment:
failure_comment_elem = XML.SubElement(messages_elem, comment_type)
XML.SubElement(failure_comment_elem, "message").text = str(failure_comment)
XML.SubElement(failure_comment_elem, "result").text = "FAILURE"
if error_comment:
error_comment_elem = XML.SubElement(messages_elem, comment_type)
XML.SubElement(error_comment_elem, "message").text = str(error_comment)
XML.SubElement(error_comment_elem, "result").text = "ERROR"
if cancel_builds_on_update:
XML.SubElement(
extensions,
"org.jenkinsci.plugins.ghprb.extensions." "build.GhprbCancelBuildsOnUpdate",
)
if comment_file:
comment_file_tag = XML.SubElement(
extensions,
"org.jenkinsci.plugins.ghprb.extensions." "comments.GhprbCommentFile",
)
comment_file_path_elem = XML.SubElement(comment_file_tag, "commentFilePath")
comment_file_path_elem.text = str(comment_file)
if no_commit_status:
XML.SubElement(
extensions,
"org.jenkinsci.plugins.ghprb.extensions." "status.GhprbNoCommitStatus",
)
def gitlab_merge_request(registry, xml_parent, data):
"""yaml: gitlab-merge-request
Build merge requests in gitlab and report results.
Requires the Jenkins :jenkins-plugins:`Gitlab MergeRequest Builder Plugin
<ghprb>`.
:arg str cron: Cron syntax of when to run (required)
:arg str project-path: Gitlab-relative path to project (required)
:arg str target-branch-regex: Allow execution of this job for certain
branches only (default ''). Requires Gitlab MergeRequest Builder
Plugin >= 2.0.0
:arg str use-http-url: Use the HTTP(S) URL to fetch/clone repository
(default false)
:arg str assignee-filter: Only MRs with this assigned user will
trigger the build automatically (default 'jenkins')
:arg str tag-filter: Only MRs with this label will trigger the build
automatically (default 'Build')
:arg str trigger-comment: Force build if this comment is the last
in merge reguest (default '')
:arg str publish-build-progress-messages: Publish build progress
messages (except build failed) (default true)
.. deprecated:: 2.0.0
:arg str auto-close-failed: On failure, auto close the request
(default false)
:arg str auto-merge-passed: On success, auto merge the request
(default false)
Example (version < 2.0.0):
.. literalinclude:: \
/../../tests/triggers/fixtures/gitlab-merge-request001.yaml
Example (version >= 2.0.0):
.. literalinclude:: \
/../../tests/triggers/fixtures/gitlab-merge-request002.yaml
"""
ghprb = XML.SubElement(
xml_parent, "org.jenkinsci.plugins.gitlab." "GitlabBuildTrigger"
)
plugin_info = registry.get_plugin_info("Gitlab Merge Request Builder")
# Note: Assume latest version of plugin is preferred config format
plugin_ver = pkg_resources.parse_version(
plugin_info.get("version", str(sys.maxsize))
)
if plugin_ver >= pkg_resources.parse_version("2.0.0"):
mapping = [
("cron", "spec", None),
("project-path", "projectPath", None),
("target-branch-regex", "targetBranchRegex", ""),
("use-http-url", "useHttpUrl", False),
("assignee-filter", "assigneeFilter", "jenkins"),
("tag-filter", "tagFilter", "Build"),
("trigger-comment", "triggerComment", ""),
("auto-close-failed", "autoCloseFailed", False),
("auto-merge-passed", "autoMergePassed", False),
]
else:
# The plugin version is < 2.0.0
# Because of a design limitation in the GitlabBuildTrigger Jenkins
# plugin both 'spec' and '__cron' have to be set to the same value to
# have them take effect. Also, cron and projectPath are prefixed with
# underscores in the plugin, but spec is not.
mapping = [
("cron", "spec", None),
("cron", "__cron", None),
("project-path", "__projectPath", None),
("use-http-url", "__useHttpUrl", False),
("assignee-filter", "__assigneeFilter", "jenkins"),
("tag-filter", "__tagFilter", "Build"),
("trigger-comment", "__triggerComment", ""),
("publish-build-progress-messages", "__publishBuildProgressMessages", True),
("auto-close-failed", "__autoCloseFailed", False),
("auto-merge-passed", "__autoMergePassed", False),
]
helpers.convert_mapping_to_xml(ghprb, data, mapping, True)
def gitlab(registry, xml_parent, data):
"""yaml: gitlab
Makes Jenkins act like a GitLab CI server.
Requires the Jenkins :jenkins-plugins:`GitLab Plugin <gitlab-plugin>`.
:arg bool trigger-push: Build on Push Events (default true)
:arg bool trigger-merge-request: Build on Merge Request Events (default
true)
:arg bool trigger-accepted-merge-request: Build on Accepted Merge Request
Events (>= 1.4.6) (default false)
:arg bool trigger-closed-merge-request: Build on Closed Merge Request
Events (>= 1.4.6) (default false)
:arg str trigger-open-merge-request-push: Rebuild open Merge Requests
on Push Events.
:trigger-open-merge-request-push values (< 1.1.26):
* **true** (default)
* **false**
:trigger-open-merge-request-push values (>= 1.1.26):
* **never** (default)
* **source**
* **both**
:arg bool trigger-note: Build when comment is added with defined phrase
(>= 1.2.4) (default true)
:arg str note-regex: Phrase that triggers the build (>= 1.2.4) (default
'Jenkins please retry a build')
:arg bool ci-skip: Enable skipping builds of commits that contain
[ci-skip] in the commit message (default true)
:arg bool wip-skip: Enable skipping builds of WIP Merge Requests (>= 1.2.4)
(default true)
:arg bool set-build-description: Set build description to build cause
(eg. Merge request or Git Push) (default true)
:arg bool cancel-pending-builds-on-update: Cancel pending merge request
builds on update (default false)
:arg str pending-build-name: Set the pending merge request build name (optional)
:arg bool add-note-merge-request: Add note with build status on
merge requests (default true)
:arg bool add-vote-merge-request: Vote added to note with build status
on merge requests (>= 1.1.27) (default true)
:arg bool accept-merge-request-on-success: Automatically accept the Merge
Request if the build is successful (>= 1.1.27) (default false)
:arg bool add-ci-message: Add CI build status (1.1.28 - 1.2.0) (default
false)
:arg bool allow-all-branches: Allow all branches (Ignoring Filtered
Branches) (< 1.1.29) (default false)
:arg str branch-filter-type: Filter branches that can trigger a build.
Valid values and their additional attributes are described in the
`branch filter type`_ table (>= 1.1.29) (default 'All').
:arg list include-branches: Defined list of branches to include
(default [])
:arg list exclude-branches: Defined list of branches to exclude
(default [])
:arg str target-branch-regex: Regular expression to select branches
:arg str secret-token: Secret token for build trigger
.. _`branch filter type`:
================== ====================================================
Branch filter type Description
================== ====================================================
All All branches are allowed to trigger this job.
NameBasedFilter Filter branches by name.
List source branches that are allowed to trigger a
build from a Push event or a Merge Request event. If
both fields are left empty, all branches are allowed
to trigger this job. For Merge Request events only
the target branch name is filtered out by the
**include-branches** and **exclude-branches** lists.
RegexBasedFilter Filter branches by regex
The target branch regex allows you to limit the
execution of this job to certain branches. Any
branch matching the specified pattern in
**target-branch-regex** triggers the job. No
filtering is performed if the field is left empty.
================== ====================================================
Example (version < 1.1.26):
.. literalinclude:: /../../tests/triggers/fixtures/gitlab001.yaml
:language: yaml
Minimal example (version >= 1.1.26):
.. literalinclude:: /../../tests/triggers/fixtures/gitlab005.yaml
:language: yaml
Full example (version >= 1.1.26):
.. literalinclude:: /../../tests/triggers/fixtures/gitlab004.yaml
:language: yaml
"""
def _add_xml(elem, name, value):
XML.SubElement(elem, name).text = value
gitlab = XML.SubElement(
xml_parent, "com.dabsquared.gitlabjenkins.GitLabPushTrigger"
)
plugin_info = registry.get_plugin_info("GitLab Plugin")
# Note: Assume latest version of plugin is preferred config format
plugin_ver = pkg_resources.parse_version(
plugin_info.get("version", str(sys.maxsize))
)
valid_merge_request = ["never", "source", "both"]
if plugin_ver >= pkg_resources.parse_version("1.1.26"):
mapping = [
(
"trigger-open-merge-request-push",
"triggerOpenMergeRequestOnPush",
"never",
valid_merge_request,
)
]
helpers.convert_mapping_to_xml(gitlab, data, mapping, fail_required=True)
else:
mapping = [
("trigger-open-merge-request-push", "triggerOpenMergeRequestOnPush", True)
]
helpers.convert_mapping_to_xml(gitlab, data, mapping, fail_required=True)
if plugin_ver < pkg_resources.parse_version("1.2.0"):
if data.get("branch-filter-type", "") == "All":
data["branch-filter-type"] = ""
valid_filters = ["", "NameBasedFilter", "RegexBasedFilter"]
mapping = [("branch-filter-type", "branchFilterName", "", valid_filters)]
helpers.convert_mapping_to_xml(gitlab, data, mapping, fail_required=True)
else:
valid_filters = ["All", "NameBasedFilter", "RegexBasedFilter"]
mapping = [("branch-filter-type", "branchFilterType", "All", valid_filters)]
helpers.convert_mapping_to_xml(gitlab, data, mapping, fail_required=True)
XML.SubElement(gitlab, "spec").text = ""
mapping = [
("trigger-push", "triggerOnPush", True),
("trigger-merge-request", "triggerOnMergeRequest", True),
("trigger-accepted-merge-request", "triggerOnAcceptedMergeRequest", False),
("trigger-closed-merge-request", "triggerOnClosedMergeRequest", False),
("trigger-note", "triggerOnNoteRequest", True),
("note-regex", "noteRegex", "Jenkins please retry a build"),
("ci-skip", "ciSkip", True),
("wip-skip", "skipWorkInProgressMergeRequest", True),
("set-build-description", "setBuildDescription", True),
("cancel-pending-builds-on-update", "cancelPendingBuildsOnUpdate", False),
("add-note-merge-request", "addNoteOnMergeRequest", True),
("add-vote-merge-request", "addVoteOnMergeRequest", True),
("accept-merge-request-on-success", "acceptMergeRequestOnSuccess", False),
("add-ci-message", "addCiMessage", False),
("allow-all-branches", "allowAllBranches", False),
("target-branch-regex", "targetBranchRegex", ""),
("secret-token", "secretToken", ""),
]
helpers.convert_mapping_to_xml(gitlab, data, mapping, fail_required=True)
list_mapping = (
("include-branches", "includeBranchesSpec", []),
("exclude-branches", "excludeBranchesSpec", []),
)
for yaml_name, xml_name, default_val in list_mapping:
value = ", ".join(data.get(yaml_name, default_val))
_add_xml(gitlab, xml_name, value)
optional_mapping = (("pending-build-name", "pendingBuildName", None),)
helpers.convert_mapping_to_xml(gitlab, data, optional_mapping, fail_required=False)
def gogs(registry, xml_parent, data):
"""yaml: gogs
Trigger a job when gogs repository is pushed to.
Requires the Jenkins :jenkins-plugins:`Gogs Plugin <gogs-webhook>`.
Example:
.. literalinclude::
/../../tests/triggers/fixtures/gogs.yaml
:language: yaml
"""
gogstrig = XML.SubElement(xml_parent, "org.jenkinsci.plugins.gogs.GogsTrigger")
XML.SubElement(gogstrig, "spec")
def build_result(registry, xml_parent, data):
"""yaml: build-result
Configure jobB to monitor jobA build result. A build is scheduled if there
is a new build result that matches your criteria (unstable, failure, ...).
Requires the Jenkins :jenkins-plugins:`BuildResultTrigger Plugin
<buildresult-trigger>`.
:arg list groups: List groups of jobs and results to monitor for
:arg list jobs: The jobs to monitor (required)
:arg list results: Build results to monitor for (default success)
:arg bool combine: Combine all job information. A build will be
scheduled only if all conditions are met (default false)
:arg str cron: The cron syntax with which to poll the jobs for the
supplied result (default '')
Full Example:
.. literalinclude::
/../../tests/triggers/fixtures/build-result-full.yaml
:language: yaml
Minimal Example:
.. literalinclude::
/../../tests/triggers/fixtures/build-result-minimal.yaml
:language: yaml
"""
brt = XML.SubElement(
xml_parent, "org.jenkinsci.plugins." "buildresulttrigger.BuildResultTrigger"
)
brt.set("plugin", "buildresult-trigger")
mapping = [("cron", "spec", ""), ("combine", "combinedJobs", False)]
helpers.convert_mapping_to_xml(brt, data, mapping, fail_required=True)
jobs_info = XML.SubElement(brt, "jobsInfo")
result_dict = {
"success": "SUCCESS",
"unstable": "UNSTABLE",
"failure": "FAILURE",
"not-built": "NOT_BUILT",
"aborted": "ABORTED",
}
for group in data["groups"]:
brti = XML.SubElement(
jobs_info,
"org.jenkinsci.plugins."
"buildresulttrigger.model."
"BuildResultTriggerInfo",
)
jobs_string = ",".join(group["jobs"])
mapping = [("", "jobNames", jobs_string, group)]
helpers.convert_mapping_to_xml(brti, group, mapping, fail_required=True)
checked_results = XML.SubElement(brti, "checkedResults")
for result in group.get("results", ["success"]):
model_checked = XML.SubElement(
checked_results,
"org.jenkinsci." "plugins.buildresulttrigger.model." "CheckedResult",
)
mapping = [("", "checked", result, result_dict)]
helpers.convert_mapping_to_xml(
model_checked, result_dict, mapping, fail_required=True
)
def reverse(registry, xml_parent, data):
"""yaml: reverse
This trigger can be configured in the UI using the checkbox with the
following text: 'Build after other projects are built'.
Set up a trigger so that when some other projects finish building, a new
build is scheduled for this project. This is convenient for running an
extensive test after a build is complete, for example.
This configuration complements the "Build other projects" section in the
"Post-build Actions" of an upstream project, but is preferable when you
want to configure the downstream project.
:arg str jobs: List of jobs to watch. Can be either a comma separated
list or a list.
:arg str result: Build results to monitor for between the following
options: success, unstable and failure. (default 'success').
Example:
.. literalinclude:: /../../tests/triggers/fixtures/reverse.yaml
Example List:
.. literalinclude:: /../../tests/triggers/fixtures/reverse-list.yaml
"""
reserveBuildTrigger = XML.SubElement(
xml_parent, "jenkins.triggers.ReverseBuildTrigger"
)
supported_thresholds = ["SUCCESS", "UNSTABLE", "FAILURE"]
XML.SubElement(reserveBuildTrigger, "spec").text = ""
jobs = data.get("jobs")
if isinstance(jobs, list):
jobs = ",".join(jobs)
XML.SubElement(reserveBuildTrigger, "upstreamProjects").text = jobs
threshold = XML.SubElement(reserveBuildTrigger, "threshold")
result = str(data.get("result", "success")).upper()
if result not in supported_thresholds:
raise jenkins_jobs.errors.JenkinsJobsException(
"Choice should be one of the following options: %s."
% ", ".join(supported_thresholds)
)
XML.SubElement(threshold, "name").text = hudson_model.THRESHOLDS[result]["name"]
XML.SubElement(threshold, "ordinal").text = hudson_model.THRESHOLDS[result][
"ordinal"
]
XML.SubElement(threshold, "color").text = hudson_model.THRESHOLDS[result]["color"]
XML.SubElement(threshold, "completeBuild").text = str(
hudson_model.THRESHOLDS[result]["complete"]
).lower()
def monitor_folders(registry, xml_parent, data):
"""yaml: monitor-folders
Configure Jenkins to monitor folders.
Requires the Jenkins :jenkins-plugins:`Filesystem Trigger Plugin
<fstrigger>`.
:arg str path: Folder path to poll. (default '')
:arg list includes: Fileset includes setting that specifies the list of
includes files. Basedir of the fileset is relative to the workspace
root. If no value is set, all files are used. (default '')
:arg str excludes: The 'excludes' pattern. A file that matches this mask
will not be polled even if it matches the mask specified in 'includes'
section. (default '')
:arg bool check-modification-date: Check last modification date.
(default true)
:arg bool check-content: Check content. (default true)
:arg bool check-fewer: Check fewer files (default true)
:arg str cron: cron syntax of when to run (default '')
Full Example:
.. literalinclude::
/../../tests/triggers/fixtures/monitor-folders-full.yaml
:language: yaml
Minimal Example:
.. literalinclude::
/../../tests/triggers/fixtures/monitor-folders-minimal.yaml
:language: yaml
"""
ft = XML.SubElement(
xml_parent, ("org.jenkinsci.plugins.fstrigger." "triggers.FolderContentTrigger")
)
ft.set("plugin", "fstrigger")
mappings = [("path", "path", ""), ("cron", "spec", "")]
helpers.convert_mapping_to_xml(ft, data, mappings, fail_required=True)
includes = data.get("includes", "")
XML.SubElement(ft, "includes").text = ",".join(includes)
XML.SubElement(ft, "excludes").text = data.get("excludes", "")
XML.SubElement(ft, "excludeCheckLastModificationDate").text = str(
not data.get("check-modification-date", True)
).lower()
XML.SubElement(ft, "excludeCheckContent").text = str(
not data.get("check-content", True)
).lower()
XML.SubElement(ft, "excludeCheckFewerOrMoreFiles").text = str(
not data.get("check-fewer", True)
).lower()
def monitor_files(registry, xml_parent, data):
"""yaml: monitor-files
Configure Jenkins to monitor files.
Requires the Jenkins :jenkins-plugins:`Filesystem Trigger Plugin
<fstrigger>`.
:arg list files: List of files to monitor
:File:
* **path** (`str`) -- File path to monitor. You can use a pattern
that specifies a set of files if you don't know the real file
path. (required)
* **strategy** (`str`) -- Choose your strategy if there is more
than one matching file. Can be one of Ignore file ('IGNORE') or
Use the most recent ('LATEST'). (default 'LATEST')
* **check-content** (`list`) -- List of content changes of the
file to monitor
:Content Nature:
* **simple** (`bool`) -- Trigger on change in content of
the specified file (whatever the type file).
(default false)
* **jar** (`bool`) -- Trigger on change in content of the
specified JAR file. (default false)
* **tar** (`bool`) -- Trigger on change in content of the
specified Tar file. (default false)
* **zip** (`bool`) -- Trigger on change in content of the
specified ZIP file. (default false)
* **source-manifest** (`list`) -- Trigger on change to
MANIFEST files.
:MANIFEST File:
* **keys** (`list`) -- List of keys to inspect.
(optional)
* **all-keys** (`bool`) -- If true, take into
account all keys. (default true)
* **jar-manifest** (`list`) -- Trigger on change to
MANIFEST files (contained in jar files).
:MANIFEST File:
* **keys** (`list`) -- List of keys to inspect.
(optional)
* **all-keys** (`bool`) -- If true, take into
account all keys. (default true)
* **properties** (`list`) -- Monitor the contents of the
properties file.
:Properties File:
* **keys** (`list`) -- List of keys to inspect.
(optional)
* **all-keys** (`bool`) -- If true, take into
account all keys. (default true)
* **xml** (`list str`) -- Trigger on change to the listed
XPath expressions.
* **text** (`list str`) -- Trigger on change to the listed
regular expressions.
* **ignore-modificaton-date** (`bool`) -- If true, ignore the file
modification date. Only valid when content changes of the file
are being monitored. (default true)
:arg str cron: cron syntax of when to run (default '')
Minimal Example:
.. literalinclude::
/../../tests/triggers/fixtures/monitor-files-minimal.yaml
:language: yaml
Full Example:
.. literalinclude::
/../../tests/triggers/fixtures/monitor-files-full.yaml
:language: yaml
"""
ft_prefix = "org.jenkinsci.plugins.fstrigger.triggers."
valid_strategies = ["LATEST", "IGNORE"]
valid_content_types = {
"simple": ["Simple", "", "", []],
"jar": ["JAR", "", "", []],
"tar": ["Tar", "", "", []],
"zip": ["ZIP", "", "", []],
"source-manifest": ["SourceManifest"],
"jar-manifest": ["JARManifest"],
"properties": ["Properties"],
"xml": ["XML", "expressions", "expression", None],
"text": ["Text", "regexElements", "regex", None],
}
ft = XML.SubElement(xml_parent, ft_prefix + "FileNameTrigger")
XML.SubElement(ft, "spec").text = str(data.get("cron", ""))
files = data.get("files", [])
if not files:
raise JenkinsJobsException("At least one file must be provided")
files_tag = XML.SubElement(ft, "fileInfo")
for file_info in files:
file_tag = XML.SubElement(files_tag, ft_prefix + "FileNameTriggerInfo")
check_content = file_info.get("check-content", [])
files_mapping = [
("path", "filePathPattern", None),
("strategy", "strategy", "LATEST", valid_strategies),
("", "inspectingContentFile", bool(check_content)),
]
helpers.convert_mapping_to_xml(
file_tag, file_info, files_mapping, fail_required=True
)
base_content_tag = XML.SubElement(file_tag, "contentFileTypes")
for content in check_content:
type_name = next(iter(content.keys()))
if type_name not in valid_content_types:
raise InvalidAttributeError(
"check-content", type_name, valid_content_types.keys()
)
content_type = valid_content_types.get(type_name)
if len(content_type) == 1:
class_name = "{0}filecontent.{1}FileContent".format(
ft_prefix, content_type[0]
)
content_data = content.get(type_name)
if not content_data:
raise JenkinsJobsException(
"Need to specify something " "under " + type_name
)
for entry in content_data:
content_tag = XML.SubElement(base_content_tag, class_name)
keys = entry.get("keys", [])
if keys:
XML.SubElement(content_tag, "keys2Inspect").text = ",".join(
keys
)
XML.SubElement(content_tag, "allKeys").text = str(
entry.get("all-keys", True)
).lower()
else:
if content[type_name]:
sub_entries = content_type[3]
if sub_entries is None:
sub_entries = content[type_name]
build_content_type(
base_content_tag,
sub_entries,
ft_prefix + "filecontent",
"FileContent",
"FileContentEntry",
*content_type[0:3]
)
if bool(check_content):
XML.SubElement(file_tag, "doNotCheckLastModificationDate").text = str(
file_info.get("ignore-modificaton-date", True)
).lower()
def ivy(registry, xml_parent, data):
"""yaml: ivy
Poll with an Ivy script.
Requires the Jenkins :jenkins-plugins:`IvyTrigger Plugin
<ivytrigger>`.
:arg str path: Path of the ivy file. (optional)
:arg str settings-path: Ivy Settings Path. (optional)
:arg list properties-file: List of properties file path. Properties
will be injected as variables in the ivy settings file. (optional)
:arg str properties-content: Properties content. Properties will be
injected as variables in the ivy settings file. (optional)
:arg bool debug: Active debug mode on artifacts resolution. (default false)
:arg download-artifacts: Download artifacts for dependencies to see if they
have changed. (default true)
:arg bool enable-concurrent: Enable Concurrent Build. (default false)
:arg str label: Restrict where the polling should run. (default '')
:arg str cron: cron syntax of when to run (default '')
Example:
.. literalinclude:: /../../tests/triggers/fixtures/ivy.yaml
"""
it = XML.SubElement(xml_parent, "org.jenkinsci.plugins.ivytrigger.IvyTrigger")
mapping = [
("path", "ivyPath", None),
("settings-path", "ivySettingsPath", None),
("properties-content", "propertiesContent", None),
("debug", "debug", False),
("download-artifacts", "downloadArtifacts", True),
("enable-concurrent", "enableConcurrentBuild", False),
("cron", "spec", ""),
]
helpers.convert_mapping_to_xml(it, data, mapping, fail_required=False)
properties_file_path = data.get("properties-file", [])
XML.SubElement(it, "propertiesFilePath").text = ";".join(properties_file_path)
label = data.get("label")
XML.SubElement(it, "labelRestriction").text = str(bool(label)).lower()
if label:
XML.SubElement(it, "triggerLabel").text = label
def script(registry, xml_parent, data):
"""yaml: script
Triggers the job using shell or batch script.
Requires the Jenkins :jenkins-plugins:`ScriptTrigger Plugin <scripttrigger>`.
:arg str label: Restrict where the polling should run. (default '')
:arg str script: A shell or batch script. (default '')
:arg str script-file-path: A shell or batch script path. (default '')
:arg str cron: cron syntax of when to run (default '')
:arg bool enable-concurrent: Enables triggering concurrent builds.
(default false)
:arg int exit-code: If the exit code of the script execution returns this
expected exit code, a build is scheduled. (default 0)
Full Example:
.. literalinclude:: /../../tests/triggers/fixtures/script-full.yaml
:language: yaml
Minimal Example:
.. literalinclude:: /../../tests/triggers/fixtures/script-minimal.yaml
:language: yaml
"""
st = XML.SubElement(xml_parent, "org.jenkinsci.plugins.scripttrigger.ScriptTrigger")
st.set("plugin", "scripttrigger")
label = data.get("label")
mappings = [
("script", "script", ""),
("script-file-path", "scriptFilePath", ""),
("cron", "spec", ""),
("enable-concurrent", "enableConcurrentBuild", False),
("exit-code", "exitCode", 0),
("", "labelRestriction", bool(label)),
("", "triggerLabel", label),
]
helpers.convert_mapping_to_xml(st, data, mappings, fail_required=False)
def groovy_script(registry, xml_parent, data):
"""yaml: groovy-script
Triggers the job using a groovy script.
Requires the Jenkins :jenkins-plugins:`ScriptTrigger Plugin
<scripttrigger>`.
:arg bool system-script: If true, run the groovy script as a system script,
the script will have access to the same variables as the Groovy Console.
If false, run the groovy script on the executor node, the script will not
have access to the hudson or job model. (default false)
:arg str script: Content of the groovy script. If the script result is
evaluated to true, a build is scheduled. (default '')
:arg str script-file-path: Groovy script path. (default '')
:arg str property-file-path: Property file path. All properties will be set
as parameters for the triggered build. (default '')
:arg bool enable-concurrent: Enable concurrent build. (default false)
:arg str label: Restrict where the polling should run. (default '')
:arg str cron: cron syntax of when to run (default '')
Full Example:
.. literalinclude:: /../../tests/triggers/fixtures/groovy-script-full.yaml
:language: yaml
Minimal Example:
.. literalinclude::
/../../tests/triggers/fixtures/groovy-script-minimal.yaml
:language: yaml
"""
gst = XML.SubElement(
xml_parent, "org.jenkinsci.plugins.scripttrigger.groovy.GroovyScriptTrigger"
)
gst.set("plugin", "scripttrigger")
label = data.get("label")
mappings = [
("system-script", "groovySystemScript", False),
("script", "groovyExpression", ""),
("script-file-path", "groovyFilePath", ""),
("property-file-path", "propertiesFilePath", ""),
("enable-concurrent", "enableConcurrentBuild", False),
("cron", "spec", ""),
("", "labelRestriction", bool(label)),
("", "triggerLabel", label),
]
helpers.convert_mapping_to_xml(gst, data, mappings, fail_required=False)
def rabbitmq(registry, xml_parent, data):
"""yaml: rabbitmq
This plugin triggers build using remote build message in RabbitMQ queue.
Requires the Jenkins :jenkins-plugins:`RabbitMQ Build Trigger Plugin
<rabbitmq-build-trigger>`.
:arg str token: the build token expected in the message queue (required)
:arg list filters: list of filters to apply (optional)
:Filter:
* **field** (`str`) - Some field in message (required)
* **value** (`str`) - value of specified field (required)
Example:
.. literalinclude:: /../../tests/triggers/fixtures/rabbitmq.yaml
:language: yaml
Example with filters:
.. literalinclude:: /../../tests/triggers/fixtures/rabbitmq-filters.yaml
:language: yaml
"""
rabbitmq_prefix = "org.jenkinsci.plugins.rabbitmqbuildtrigger."
rabbitmq = XML.SubElement(xml_parent, rabbitmq_prefix + "RemoteBuildTrigger")
filters = data.get("filters", [])
filter_mapping = [("field", "field", None), ("value", "value", None)]
if filters:
filters_tag = XML.SubElement(rabbitmq, "filters")
for filter_data in filters:
filter_tag = XML.SubElement(filters_tag, rabbitmq_prefix + "Filter")
helpers.convert_mapping_to_xml(
filter_tag, filter_data, filter_mapping, fail_required=True
)
mapping = [("", "spec", ""), ("token", "remoteBuildToken", None)]
helpers.convert_mapping_to_xml(rabbitmq, data, mapping, fail_required=True)
def parameterized_timer(parser, xml_parent, data):
"""yaml: parameterized-timer
Trigger builds with parameters at certain times.
Requires the Jenkins :jenkins-plugins:`Parameterized Scheduler Plugin
<parameterized-scheduler>`.
:arg str cron: cron syntax of when to run and with which parameters
(required)
Example:
.. literalinclude::
/../../tests/triggers/fixtures/parameterized-timer001.yaml
:language: yaml
"""
param_timer = XML.SubElement(
xml_parent,
"org.jenkinsci.plugins.parameterizedscheduler." "ParameterizedTimerTrigger",
)
mapping = [("", "spec", ""), ("cron", "parameterizedSpecification", None)]
helpers.convert_mapping_to_xml(param_timer, data, mapping, fail_required=True)
def jira_changelog(registry, xml_parent, data):
"""yaml: jira-changelog
Sets up a trigger that listens to JIRA issue changes.
Requires the Jenkins :jenkins-plugins:`JIRA Trigger Plugin
<jira-trigger>`.
:arg str jql-filter: Must match updated issues to trigger a build.
(default '')
:arg list changelog-matchers:
:Custom Field Matcher:
* **custom-field-name** (`str`) -- The custom field
name that has been changed during the issue update.
(default '')
* **compare-new-value** (`bool`) -- Compare the
new value of the updated field. (default false)
* **new-value** (`str`) -- The new value of the updated field.
(default '')
* **compare-old-value** (`bool`) -- Compare the
old value of the updated field. (default false)
* **old-value** (`str`) -- The value
before the field is updated. (default '')
:JIRA Field Matcher:
* **jira-field-ID** (`str`) -- The JIRA Field ID that
has been changed during the issue update. (default '')
* **compare-new-value** (`bool`) -- Compare the new value
of the updated field. (default false)
* **new-value** (`str`) -- The new value of the updated field.
(default '')
* **compare-old-value** (`bool`) -- Compare the old value
of the updated field. (default false)
* **old-value** (`str`) -- The value before
the field is updated. (default '')
:arg list parameter-mapping:
:Issue Attribute Path:
* **jenkins-parameter** (`str`) -- Jenkins parameter name
(default '')
* **issue-attribute-path** (`str`) -- Attribute path (default '')
Minimal Example:
.. literalinclude::
/../../tests/triggers/fixtures/jira-changelog-minimal.yaml
:language: yaml
Full Example:
.. literalinclude::
/../../tests/triggers/fixtures/jira-changelog-full.yaml
:language: yaml
"""
jcht = XML.SubElement(
xml_parent, "com.ceilfors.jenkins.plugins." "jiratrigger.JiraChangelogTrigger"
)
jcht.set("plugin", "jira-trigger")
mapping = [("jql-filter", "jqlFilter", "")]
helpers.convert_mapping_to_xml(jcht, data, mapping, fail_required=True)
changelog = XML.SubElement(jcht, "changelogMatchers")
mappings = [
("field", "field", ""),
("new-value", "newValue", ""),
("old-value", "oldValue", ""),
("compare-new-value", "comparingNewValue", False),
("compare-old-value", "comparingOldValue", False),
]
for matcher in data.get("changelog-matchers", []):
fieldtype = matcher.get("field-type")
if fieldtype == "CUSTOM":
parent_tag = XML.SubElement(
changelog,
"com.ceilfors.jenkins."
"plugins.jiratrigger.changelog."
"CustomFieldChangelogMatcher",
)
XML.SubElement(parent_tag, "fieldType").text = "CUSTOM"
elif fieldtype == "JIRA":
parent_tag = XML.SubElement(
changelog,
"com.ceilfors.jenkins."
"plugins.jiratrigger.changelog."
"JiraFieldChangelogMatcher",
)
XML.SubElement(parent_tag, "fieldType").text = "JIRA"
helpers.convert_mapping_to_xml(
parent_tag, matcher, mappings, fail_required=True
)
param = XML.SubElement(jcht, "parameterMappings")
parameter_mappings = [
("jenkins-parameter", "jenkinsParameter", ""),
("issue-attribute-path", "issueAttributePath", ""),
]
for parameter in data.get("parameter-mapping", []):
parent = XML.SubElement(
param,
"com.ceilfors.jenkins.plugins."
"jiratrigger.parameter."
"IssueAttributePathParameterMapping",
)
helpers.convert_mapping_to_xml(
parent, parameter, parameter_mappings, fail_required=True
)
def jira_comment_trigger(registry, xml_parent, data):
"""yaml: jira-comment-trigger
Trigger builds when a comment is added to JIRA.
Requires the Jenkins :jenkins-plugins:`JIRA Trigger Plugin
<jira-trigger>`.
:arg str jql-filter: Must match updated issues to trigger a build.
(default '')
:arg str comment-pattern: Triggers build only when the comment added to
JIRA matches pattern (default '(?i)build this please')
:arg list parameter-mapping:
:Issue Attribute Path:
* **jenkins-parameter** (`str`) -- Jenkins parameter name
(default '')
* **issue-attribute-path** (`str`) -- Attribute path (default '')
Minimal Example:
.. literalinclude::
/../../tests/triggers/fixtures/jira-comment-trigger-minimal.yaml
:language: yaml
Full Example:
.. literalinclude::
/../../tests/triggers/fixtures/jira-comment-trigger-full.yaml
:language: yaml
"""
jct = XML.SubElement(
xml_parent, "com.ceilfors.jenkins.plugins." "jiratrigger.JiraCommentTrigger"
)
jct.set("plugin", "jira-trigger")
mapping = [
("jql-filter", "jqlFilter", ""),
("comment-pattern", "commentPattern", "(?i)build this please"),
]
helpers.convert_mapping_to_xml(jct, data, mapping, fail_required=True)
param = XML.SubElement(jct, "parameterMappings")
for parameter in data.get("parameter-mapping", []):
parent = XML.SubElement(
param,
"com.ceilfors.jenkins.plugins."
"jiratrigger.parameter."
"IssueAttributePathParameterMapping",
)
parameter_mappings = [
("jenkins-parameter", "jenkinsParameter", ""),
("issue-attribute-path", "issueAttributePath", ""),
]
helpers.convert_mapping_to_xml(
parent, parameter, parameter_mappings, fail_required=True
)
def stash_pull_request(registry, xml_parent, data):
"""yaml: stash-pull-request
Trigger builds via Stash/Bitbucket Server Pull Requests.
Requires the Jenkins :jenkins-plugins:`Stash Pull Request Builder Plugin
<stash-pullrequest-builder>`.
: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).
e.g.: https://example.com (required)
:arg str credentials-id: Jenkins credential set to use. (required)
:arg str project: Abbreviated project code. e.g.: PRJ or ~user (required)
:arg str repository: Stash Repository Name. e.g.: Repo (required)
:arg str ci-skip-phrases: CI Skip Phrases. (default 'NO TEST')
:arg str ci-build-phrases: CI Build Phrases. (default 'test this please')
:arg str target-branches: Target branches to filter. (default '')
:arg bool ignore-ssl: Ignore SSL certificates for Stash host.
(default false)
:arg bool check-destination-commit: Rebuild if destination branch
changes. (default false)
:arg bool check-mergable: Build only if PR is mergeable. (default false)
:arg bool merge-on-success: Merge PR if build is successful.
(default false)
:arg bool check-not-conflicted: Build only if Stash reports no conflicts.
(default false)
:arg bool only-build-on-comment: Only build when asked (with test
phrase). (default false)
:arg bool delete-previous-build-finish-comments: Keep PR comment only for
most recent Build. (default false)
:arg bool cancel-outdated-jobs: Cancel outdated jobs. (default false)
Minimal Example:
.. literalinclude::
/../../tests/triggers/fixtures/stash-pull-request-minimal.yaml
:language: yaml
Full Example:
.. literalinclude::
/../../tests/triggers/fixtures/stash-pull-request-full.yaml
:language: yaml
"""
pr_trigger = XML.SubElement(
xml_parent, "stashpullrequestbuilder.stashpullrequestbuilder.StashBuildTrigger"
)
pr_trigger.set("plugin", "stash-pullrequest-builder")
mappings = [
("cron", "spec", None), # Spec needs to be set to the same as cron
("cron", "cron", None),
("stash-host", "stashHost", None),
("credentials-id", "credentialsId", None),
("project", "projectCode", None),
("repository", "repositoryName", None),
("ci-skip-phrases", "ciSkipPhrases", "NO TEST"),
("ci-build-phrases", "ciBuildPhrases", "test this please"),
("target-branches", "targetBranchesToBuild", ""),
("ignore-ssl", "ignoreSsl", False),
("check-destination-commit", "checkDestinationCommit", False),
("check-mergable", "checkMergeable", False),
("merge-on-success", "mergeOnSuccess", False),
("check-not-conflicted", "checkNotConflicted", True),
("only-build-on-comment", "onlyBuildOnComment", False),
(
"delete-previous-build-finish-comments",
"deletePreviousBuildFinishComments",
False,
),
("cancel-outdated-jobs", "cancelOutdatedJobsEnabled", False),
]
helpers.convert_mapping_to_xml(pr_trigger, data, mappings, fail_required=True)
def generic_webhook_trigger(registry, xml_parent, data):
"""yaml: generic-webhook-trigger
Generic webhook trigger. Trigger when a set of parameters are submitted.
Requires the Jenkins :jenkins-plugins:`Generic Webhook Trigger
<generic-webhook-trigger>`.
:arg str token: A token to use to trigger the job. (default '')
:arg bool print-post-content: Print post content in job log.
:arg bool print-contrib-var: Print contributed variables in job log.
:arg bool silent-response: Avoid responding with information about
triggered jobs.
:arg str cause: This will be displayed in any triggered job.
:arg str regex-filter-expression: Regular expression to test on the
evaluated text specified in regex-filter-text
:arg str regex-filter-text: Text to test for the given
regexp-filter-expression.
:arg list post-content-params: Parameters to use from posted JSON/XML
:post-content-params: * **type** (`str`) -- JSONPath or XPath
* **key** (`str`) -- Variable name
* **value** (`str`) -- Expression to evaluate in POST content.
Use JSONPath for JSON or XPath for XML.
* **regex-filter** (`str`) -- Anything in the evaluated value,
matching this regular expression, will be removed. (optional)
* **default-value** (`str`) -- This value will be used if
expression does not match anything. (optional)
:arg list request-params: Parameters to use passed in as request arguments
:request-params: * **key** (`str`) -- Name of request parameter
* **regex-filter** (`str`) -- Anything in the evaluated value,
matching this regular expression, will be removed. (optional)
:arg list header-params: Parameters to use passed in as headers
:header-params: * **key** (`str`) -- Name of request header in
lowercase. Resulting variable name has '_' instead of '-'
characters.
* **regex-filter** (`str`) -- Anything in the evaluated value,
matching this regular expression, will be removed. (optional)
Example:
.. literalinclude::
/../../tests/triggers/fixtures/generic-webhook-trigger-full.yaml
"""
namespace = "org.jenkinsci.plugins.gwt."
gwtrig = XML.SubElement(xml_parent, namespace + "GenericTrigger")
gwtrig.set("plugin", "generic-webhook-trigger")
XML.SubElement(gwtrig, "spec")
# Generic Varibles (Post content parameters in UI)
try:
if data.get("post-content-params"):
gen_vars = XML.SubElement(gwtrig, "genericVariables")
mappings = [
("type", "expressionType", "", ["JSONPath", "XPath"]),
("key", "key", ""),
("value", "value", ""),
("regex-filter", "regexpFilter", ""),
("default-value", "defaultValue", ""),
]
for gen_var_list in data.get("post-content-params"):
gen_var_tag = XML.SubElement(gen_vars, namespace + "GenericVariable")
helpers.convert_mapping_to_xml(
gen_var_tag, gen_var_list, mappings, fail_required=True
)
except AttributeError:
pass
# This is dropped here in the middle as that's how the jenkins config is
# done. It probably doesn't need to be, but since this is the first
# swing..
mapping = [
("regex-filter-text", "regexpFilterText", ""),
("regex-filter-expression", "regexpFilterExpression", ""),
]
helpers.convert_mapping_to_xml(gwtrig, data, mapping, fail_required=False)
# Generic Request Variables (Request parameters in UI)
try:
if data.get("request-params"):
gen_req_vars = XML.SubElement(gwtrig, "genericRequestVariables")
mappings = [("key", "key", ""), ("regex-filter", "regexpFilter", "")]
for gen_req_list in data.get("request-params"):
gen_req_tag = XML.SubElement(
gen_req_vars, namespace + "GenericRequestVariable"
)
helpers.convert_mapping_to_xml(
gen_req_tag, gen_req_list, mappings, fail_required=False
)
except AttributeError:
pass
try:
if data.get("header-params"):
gen_header_vars = XML.SubElement(gwtrig, "genericHeaderVariables")
mappings = [("key", "key", ""), ("regex-filter", "regexpFilter", "")]
for gen_header_list in data.get("header-params"):
gen_header_tag = XML.SubElement(
gen_header_vars, namespace + "GenericHeaderVariable"
)
helpers.convert_mapping_to_xml(
gen_header_tag, gen_header_list, mappings, fail_required=False
)
except AttributeError:
pass
mapping = [
("print-post-content", "printPostContent", False),
("print-contrib-var", "printContributedVariables", False),
("cause", "causeString", ""),
("token", "token", ""),
("silent-response", "silentResponse", False),
]
# This should cover all the top level
helpers.convert_mapping_to_xml(gwtrig, data, mapping, fail_required=False)
def artifactory(registry, xml_parent, data):
"""yaml: artifactory
Artifactory trigger. Trigger if files are added or modified in configured
path(s) to watch on chosen Artifactory server.
Requires the Jenkins :jenkins-plugins:`Artifactory Plugin <Artifactory>`.
:arg str artifactory-server: Artifactory server where the configured
path(s) are monitored from. Available Artifactory servers must be
configured on Jenkins Global Configuration in advance. (default '')
:arg str schedule: cron syntax of when to poll. (default '')
:arg str paths: Paths in Artifactory to poll for changes. Multiple
paths can be configured by the ';' separator. (default '')
Example with Single Path to Monitor:
.. literalinclude::
/../../tests/triggers/fixtures/artifactory-trigger-single-path.yaml
:language: yaml
Example with Multiple Paths to Monitor:
.. literalinclude::
/../../tests/triggers/fixtures/artifactory-trigger-multi-path.yaml
:language: yaml
"""
artifactory = XML.SubElement(
xml_parent, "org.jfrog.hudson.trigger.ArtifactoryTrigger"
)
artifactory.set("plugin", "artifactory")
mapping = [
("schedule", "spec", ""),
("paths", "paths", ""),
("", "branches", ""),
("", "lastModified", ""),
]
helpers.convert_mapping_to_xml(artifactory, data, mapping, fail_required=True)
details = XML.SubElement(artifactory, "details")
details_mapping = [
("artifactory-server", "artifactoryName", None),
("", "stagingPlugin", ""),
]
helpers.convert_mapping_to_xml(details, data, details_mapping, fail_required=True)
class Triggers(jenkins_jobs.modules.base.Base):
sequence = 50
component_type = "trigger"
component_list_type = "triggers"
def gen_xml(self, xml_parent, data):
triggers = data.get("triggers", [])
if not triggers:
return
if data.get("project-type", "freestyle") != "pipeline":
trig_e = XML.SubElement(xml_parent, "triggers", {"class": "vector"})
else:
properties = xml_parent.find("properties")
if properties is None:
properties = XML.SubElement(xml_parent, "properties")
pipeline_trig_prop = XML.SubElement(
properties,
"org.jenkinsci.plugins.workflow.job.properties.PipelineTriggersJobProperty",
)
trig_e = XML.SubElement(pipeline_trig_prop, "triggers")
for trigger in triggers:
self.registry.dispatch("trigger", trig_e, trigger)
View Git Blame Copy Permalink