gerrit: Use hyphenated key names.
Hyphenated strings are now standard in Jenkins Job Builder. Gerrit Trigger Plugin support used camelCase keys for its configuration, and is updated to use hyphenated strings. Old configuration style is still supported: if old key names are found, they are converted to new style key names. Change-Id: I3b1968f14029b69497ee543b44070db7d9c3448c Reviewed-on: https://review.openstack.org/24730 Reviewed-by: James E. Blair <corvus@inaugust.com> Reviewed-by: Jeremy Stanley <fungi@yuggoth.org> Reviewed-by: Anita Kuno <akuno@lavabit.com> Approved: Jeremy Stanley <fungi@yuggoth.org> Tested-by: Jenkins
This commit is contained in:
Arnaud Fabre
Jenkins
parent
4ba9ebe4d3
commit
2da55cf552
|
|
@ -32,16 +32,57 @@ Example::
|
|||
|
||||
import xml.etree.ElementTree as XML
|
||||
import jenkins_jobs.modules.base
|
||||
import re
|
||||
|
||||
|
||||
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:
|
||||
d[hyphenize(old_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['projects']:
|
||||
convert_dict(project, [
|
||||
'projectCompareType',
|
||||
'projectPattern',
|
||||
'branchCompareType',
|
||||
'branchPattern',
|
||||
])
|
||||
|
||||
|
||||
def build_gerrit_triggers(xml_parent, data):
|
||||
available_simple_triggers = {
|
||||
'triggerOnChangeAbandonedEvent': 'PluginChangeAbandonedEvent',
|
||||
'triggerOnChangeMergedEvent': 'PluginChangeMergedEvent',
|
||||
'triggerOnChangeRestoredEvent': 'PluginChangeRestoredEvent',
|
||||
'triggerOnDraftPublishedEvent': 'PluginDraftPublishedEvent',
|
||||
'triggerOnPatchsetUploadedEvent': 'PluginPatchsetCreatedEvent',
|
||||
'triggerOnRefUpdatedEvent': 'PluginRefUpdatedEvent',
|
||||
'trigger-on-change-abandoned-event': 'PluginChangeAbandonedEvent',
|
||||
'trigger-on-change-merged-event': 'PluginChangeMergedEvent',
|
||||
'trigger-on-change-restored-event': 'PluginChangeRestoredEvent',
|
||||
'trigger-on-draft-published-event': 'PluginDraftPublishedEvent',
|
||||
'trigger-on-patchset-uploaded-event': 'PluginPatchsetCreatedEvent',
|
||||
'trigger-on-ref-updated-event': 'PluginRefUpdatedEvent',
|
||||
}
|
||||
tag_namespace = 'com.sonyericsson.hudson.plugins.gerrit.trigger.' \
|
||||
'hudsontrigger.events'
|
||||
|
|
@ -52,14 +93,14 @@ def build_gerrit_triggers(xml_parent, data):
|
|||
XML.SubElement(trigger_on_events,
|
||||
'%s.%s' % (tag_namespace, tag_name))
|
||||
|
||||
if data.get('triggerOnCommentAddedEvent', False):
|
||||
if data.get('trigger-on-comment-added-event', False):
|
||||
cadded = XML.SubElement(trigger_on_events,
|
||||
'%s.%s' % (tag_namespace,
|
||||
'PluginCommentAddedEvent'))
|
||||
XML.SubElement(cadded, 'verdictCategory').text = \
|
||||
data['triggerApprovalCategory']
|
||||
data['trigger-approval-category']
|
||||
XML.SubElement(cadded, 'commentAddedTriggerApprovalValue').text = \
|
||||
str(data['triggerApprovalValue'])
|
||||
str(data['trigger-approval-value'])
|
||||
|
||||
|
||||
def build_gerrit_skip_votes(xml_parent, data):
|
||||
|
|
@ -69,7 +110,7 @@ def build_gerrit_skip_votes(xml_parent, data):
|
|||
'notbuilt': 'onNotBuilt'}
|
||||
|
||||
skip_vote_node = XML.SubElement(xml_parent, 'skipVote')
|
||||
skip_vote = data.get('skipVote', {})
|
||||
skip_vote = data.get('skip-vote', {})
|
||||
for result_kind, tag_name in outcomes.iteritems():
|
||||
if skip_vote.get(result_kind, False):
|
||||
XML.SubElement(skip_vote_node, tag_name).text = 'true'
|
||||
|
|
@ -83,29 +124,31 @@ def gerrit(parser, xml_parent, data):
|
|||
Requires the Jenkins `Gerrit Trigger Plugin
|
||||
<wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger>`_ version >= 2.6.0.
|
||||
|
||||
:arg bool triggerOnPatchsetUploadedEvent: Trigger on patchset upload
|
||||
:arg bool triggerOnChangeAbandonedEvent: Trigger on change abandoned.
|
||||
:arg bool trigger-on-patchset-uploaded-event: Trigger on patchset upload
|
||||
:arg bool trigger-on-change-abandoned-event: Trigger on change abandoned.
|
||||
Requires Gerrit Trigger Plugin version >= 2.8.0
|
||||
:arg bool triggerOnChangeMergedEvent: Trigger on change merged
|
||||
:arg bool triggerOnChangeRestoredEvent: Trigger on change restored.
|
||||
:arg bool trigger-on-change-merged-event: Trigger on change merged
|
||||
:arg bool trigger-on-change-restored-event: Trigger on change restored.
|
||||
Requires Gerrit Trigger Plugin version >= 2.8.0
|
||||
:arg bool triggerOnCommentAddedEvent: Trigger on comment added
|
||||
:arg bool triggerOnDraftPublishedEvent: Trigger on draft published event.
|
||||
:arg bool triggerOnRefUpdatedEvent: Trigger on ref-updated
|
||||
:arg str triggerApprovalCategory: Approval category for comment added
|
||||
:arg int triggerApprovalValue: Approval value for comment added
|
||||
:arg bool overrideVotes: Override default vote values
|
||||
:arg int gerritBuildSuccessfulVerifiedValue: Successful ''Verified'' value
|
||||
:arg int gerritBuildFailedVerifiedValue: Failed ''Verified'' value
|
||||
:arg str failureMessage: Message to leave on failure
|
||||
:arg bool trigger-on-comment-added-event: Trigger on comment added
|
||||
:arg bool trigger-on-draft-published-event: Trigger on draft published
|
||||
event
|
||||
:arg bool trigger-on-ref-updated-event: Trigger on ref-updated
|
||||
:arg str trigger-approval-category: Approval category for comment added
|
||||
:arg int trigger-approval-value: Approval value for comment added
|
||||
:arg bool override-votes: Override default vote values
|
||||
:arg int gerrit-build-successful-verified-value: Successful ''Verified''
|
||||
value
|
||||
:arg int gerrit-build-failed-verified-value: Failed ''Verified'' value
|
||||
:arg str failure-message: Message to leave on failure
|
||||
:arg list projects: list of projects to match
|
||||
|
||||
:Project: * **projectCompareType** (`str`) -- ''PLAIN'' or ''ANT''
|
||||
* **projectPattern** (`str`) -- Project name pattern to match
|
||||
* **branchComprareType** (`str`) -- ''PLAIN'' or ''ANT''
|
||||
* **branchPattern** ('str') -- Branch name pattern to match
|
||||
:Project: * **project-compare-type** (`str`) -- ''PLAIN'' or ''ANT''
|
||||
* **project-pattern** (`str`) -- Project name pattern to match
|
||||
* **branch-compare-type** (`str`) -- ''PLAIN'' or ''ANT''
|
||||
* **branch-pattern** ('str') -- Branch name pattern to match
|
||||
|
||||
:arg dict skipVote: map of build outcomes for which Jenkins must skip
|
||||
: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`)
|
||||
|
|
@ -119,25 +162,31 @@ def gerrit(parser, xml_parent, data):
|
|||
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.
|
||||
|
||||
Example::
|
||||
|
||||
triggers:
|
||||
- gerrit:
|
||||
triggerOnCommentAddedEvent: true
|
||||
triggerApprovalCategory: 'APRV'
|
||||
triggerApprovalValue: 1
|
||||
trigger-on-comment-added-event: true
|
||||
trigger-approval-category: 'APRV'
|
||||
trigger-approval-value: 1
|
||||
projects:
|
||||
- projectCompareType: 'PLAIN'
|
||||
projectPattern: 'test-project'
|
||||
branchCompareType: 'ANT'
|
||||
branchPattern: '**'
|
||||
skipVote:
|
||||
- project-compare-type: 'PLAIN'
|
||||
project-pattern: 'test-project'
|
||||
branch-compare-type: 'ANT'
|
||||
branch-pattern: '**'
|
||||
skip-vote:
|
||||
successful: true
|
||||
failed: true
|
||||
unstable: true
|
||||
notbuilt: true
|
||||
"""
|
||||
|
||||
gerrit_handle_legacy_configuration(data)
|
||||
|
||||
projects = data['projects']
|
||||
gtrig = XML.SubElement(xml_parent,
|
||||
'com.sonyericsson.hudson.plugins.gerrit.trigger.'
|
||||
|
|
@ -149,25 +198,25 @@ def gerrit(parser, xml_parent, data):
|
|||
'com.sonyericsson.hudson.plugins.gerrit.'
|
||||
'trigger.hudsontrigger.data.GerritProject')
|
||||
XML.SubElement(gproj, 'compareType').text = \
|
||||
project['projectCompareType']
|
||||
XML.SubElement(gproj, 'pattern').text = project['projectPattern']
|
||||
project['project-compare-type']
|
||||
XML.SubElement(gproj, 'pattern').text = project['project-pattern']
|
||||
branches = XML.SubElement(gproj, 'branches')
|
||||
gbranch = XML.SubElement(branches, 'com.sonyericsson.hudson.plugins.'
|
||||
'gerrit.trigger.hudsontrigger.data.Branch')
|
||||
XML.SubElement(gbranch, 'compareType').text = \
|
||||
project['branchCompareType']
|
||||
XML.SubElement(gbranch, 'pattern').text = project['branchPattern']
|
||||
project['branch-compare-type']
|
||||
XML.SubElement(gbranch, 'pattern').text = project['branch-pattern']
|
||||
build_gerrit_skip_votes(gtrig, data)
|
||||
XML.SubElement(gtrig, 'silentMode').text = 'false'
|
||||
XML.SubElement(gtrig, 'escapeQuotes').text = 'true'
|
||||
build_gerrit_triggers(gtrig, data)
|
||||
if 'overrideVotes' in data and data['overrideVotes'] == 'true':
|
||||
if 'override-votes' in data and data['override-votes'] == 'true':
|
||||
XML.SubElement(gtrig, 'gerritBuildSuccessfulVerifiedValue').text = \
|
||||
str(data['gerritBuildSuccessfulVerifiedValue'])
|
||||
str(data['gerrit-build-successful-verified-value'])
|
||||
XML.SubElement(gtrig, 'gerritBuildFailedVerifiedValue').text = \
|
||||
str(data['gerritBuildFailedVerifiedValue'])
|
||||
str(data['gerrit-build-failed-verified-value'])
|
||||
XML.SubElement(gtrig, 'buildStartMessage')
|
||||
XML.SubElement(gtrig, 'buildFailureMessage').text = data['failureMessage']
|
||||
XML.SubElement(gtrig, 'buildFailureMessage').text = data['failure-message']
|
||||
XML.SubElement(gtrig, 'buildSuccessfulMessage')
|
||||
XML.SubElement(gtrig, 'buildUnstableMessage')
|
||||
XML.SubElement(gtrig, 'customUrl')
|
||||
|
|
|
|||
|
|
@ -2,24 +2,24 @@
|
|||
name: test-gerrit-trigger
|
||||
triggers:
|
||||
- gerrit:
|
||||
triggerOnChangeAbandonedEvent: true
|
||||
triggerOnChangeMergedEvent: true
|
||||
triggerOnChangeRestoredEvent: true
|
||||
triggerOnCommentAddedEvent: true
|
||||
triggerOnDraftPublishedEvent: true
|
||||
triggerOnPatchsetUploadedEvent: true
|
||||
triggerOnRefUpdatedEvent: false
|
||||
triggerApprovalCategory: CRVW
|
||||
triggerApprovalValue: 2
|
||||
failureMessage:
|
||||
skipVote:
|
||||
trigger-on-change-abandoned-event: true
|
||||
trigger-on-change-merged-event: true
|
||||
trigger-on-change-restored-event: true
|
||||
trigger-on-comment-added-event: true
|
||||
trigger-on-draft-published-event: true
|
||||
trigger-on-patchset-uploaded-event: true
|
||||
trigger-on-ref-updated-event: false
|
||||
trigger-approval-category: CRVW
|
||||
trigger-approval-value: 2
|
||||
failure-message:
|
||||
skip-vote:
|
||||
successful: true
|
||||
failed: false
|
||||
# Missing outcome should default to false.
|
||||
# unstable: false
|
||||
notbuilt: true
|
||||
projects:
|
||||
- projectCompareType: 'PLAIN'
|
||||
projectPattern: 'myproject'
|
||||
branchCompareType: 'PLAIN'
|
||||
branchPattern: 'master'
|
||||
- project-compare-type: 'PLAIN'
|
||||
project-pattern: 'myproject'
|
||||
branch-compare-type: 'PLAIN'
|
||||
branch-pattern: 'master'
|
||||
|
|
|
|||
Loading…
Reference in New Issue