jjb/jenkins-job-builder
Code Issues Proposed changes

gerrit: Use hyphenated key names.

Browse Source 
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 2013-03-19 01:31:14 +01:00 committed by Jenkins
parent 4ba9ebe4d3
commit 2da55cf552
2 changed files with 108 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

137
jenkins_jobs/modules/triggers.py
View File

@ -32,16 +32,57 @@ Example::
import xml.etree.ElementTree as XML import xml.etree.ElementTree as XML
import jenkins_jobs.modules.base 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): def build_gerrit_triggers(xml_parent, data):
available_simple_triggers = { available_simple_triggers = {
'triggerOnChangeAbandonedEvent': 'PluginChangeAbandonedEvent', 'trigger-on-change-abandoned-event': 'PluginChangeAbandonedEvent',
'triggerOnChangeMergedEvent': 'PluginChangeMergedEvent', 'trigger-on-change-merged-event': 'PluginChangeMergedEvent',
'triggerOnChangeRestoredEvent': 'PluginChangeRestoredEvent', 'trigger-on-change-restored-event': 'PluginChangeRestoredEvent',
'triggerOnDraftPublishedEvent': 'PluginDraftPublishedEvent', 'trigger-on-draft-published-event': 'PluginDraftPublishedEvent',
'triggerOnPatchsetUploadedEvent': 'PluginPatchsetCreatedEvent', 'trigger-on-patchset-uploaded-event': 'PluginPatchsetCreatedEvent',
'triggerOnRefUpdatedEvent': 'PluginRefUpdatedEvent', 'trigger-on-ref-updated-event': 'PluginRefUpdatedEvent',
} }
tag_namespace = 'com.sonyericsson.hudson.plugins.gerrit.trigger.' \ tag_namespace = 'com.sonyericsson.hudson.plugins.gerrit.trigger.' \
'hudsontrigger.events' 'hudsontrigger.events'
@ -52,14 +93,14 @@ def build_gerrit_triggers(xml_parent, data):
XML.SubElement(trigger_on_events, XML.SubElement(trigger_on_events,
'%s.%s' % (tag_namespace, tag_name)) '%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, cadded = XML.SubElement(trigger_on_events,
'%s.%s' % (tag_namespace, '%s.%s' % (tag_namespace,
'PluginCommentAddedEvent')) 'PluginCommentAddedEvent'))
XML.SubElement(cadded, 'verdictCategory').text = \ XML.SubElement(cadded, 'verdictCategory').text = \
data['triggerApprovalCategory'] data['trigger-approval-category']
XML.SubElement(cadded, 'commentAddedTriggerApprovalValue').text = \ XML.SubElement(cadded, 'commentAddedTriggerApprovalValue').text = \
str(data['triggerApprovalValue']) str(data['trigger-approval-value'])
def build_gerrit_skip_votes(xml_parent, data): def build_gerrit_skip_votes(xml_parent, data):
@ -69,7 +110,7 @@ def build_gerrit_skip_votes(xml_parent, data):
'notbuilt': 'onNotBuilt'} 'notbuilt': 'onNotBuilt'}
skip_vote_node = XML.SubElement(xml_parent, 'skipVote') 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(): for result_kind, tag_name in outcomes.iteritems():
if skip_vote.get(result_kind, False): if skip_vote.get(result_kind, False):
XML.SubElement(skip_vote_node, tag_name).text = 'true' 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 Requires the Jenkins `Gerrit Trigger Plugin
<wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger>`_ version >= 2.6.0. <wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger>`_ version >= 2.6.0.
:arg bool triggerOnPatchsetUploadedEvent: Trigger on patchset upload :arg bool trigger-on-patchset-uploaded-event: Trigger on patchset upload
:arg bool triggerOnChangeAbandonedEvent: Trigger on change abandoned. :arg bool trigger-on-change-abandoned-event: Trigger on change abandoned.
Requires Gerrit Trigger Plugin version >= 2.8.0 Requires Gerrit Trigger Plugin version >= 2.8.0
:arg bool triggerOnChangeMergedEvent: Trigger on change merged :arg bool trigger-on-change-merged-event: Trigger on change merged
:arg bool triggerOnChangeRestoredEvent: Trigger on change restored. :arg bool trigger-on-change-restored-event: Trigger on change restored.
Requires Gerrit Trigger Plugin version >= 2.8.0 Requires Gerrit Trigger Plugin version >= 2.8.0
:arg bool triggerOnCommentAddedEvent: Trigger on comment added :arg bool trigger-on-comment-added-event: Trigger on comment added
:arg bool triggerOnDraftPublishedEvent: Trigger on draft published event. :arg bool trigger-on-draft-published-event: Trigger on draft published
:arg bool triggerOnRefUpdatedEvent: Trigger on ref-updated event
:arg str triggerApprovalCategory: Approval category for comment added :arg bool trigger-on-ref-updated-event: Trigger on ref-updated
:arg int triggerApprovalValue: Approval value for comment added :arg str trigger-approval-category: Approval category for comment added
:arg bool overrideVotes: Override default vote values :arg int trigger-approval-value: Approval value for comment added
:arg int gerritBuildSuccessfulVerifiedValue: Successful ''Verified'' value :arg bool override-votes: Override default vote values
:arg int gerritBuildFailedVerifiedValue: Failed ''Verified'' value :arg int gerrit-build-successful-verified-value: Successful ''Verified''
:arg str failureMessage: Message to leave on failure 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 :arg list projects: list of projects to match
:Project: * **projectCompareType** (`str`) -- ''PLAIN'' or ''ANT'' :Project: * **project-compare-type** (`str`) -- ''PLAIN'' or ''ANT''
* **projectPattern** (`str`) -- Project name pattern to match * **project-pattern** (`str`) -- Project name pattern to match
* **branchComprareType** (`str`) -- ''PLAIN'' or ''ANT'' * **branch-compare-type** (`str`) -- ''PLAIN'' or ''ANT''
* **branchPattern** ('str') -- Branch name pattern to match * **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 vote. Requires Gerrit Trigger Plugin version >= 2.7.0
:Outcome: * **successful** (`bool`) :Outcome: * **successful** (`bool`)
@ -119,25 +162,31 @@ def gerrit(parser, xml_parent, data):
indicate which approval category and value you want to trigger the indicate which approval category and value you want to trigger the
job. 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:: Example::
triggers: triggers:
- gerrit: - gerrit:
triggerOnCommentAddedEvent: true trigger-on-comment-added-event: true
triggerApprovalCategory: 'APRV' trigger-approval-category: 'APRV'
triggerApprovalValue: 1 trigger-approval-value: 1
projects: projects:
- projectCompareType: 'PLAIN' - project-compare-type: 'PLAIN'
projectPattern: 'test-project' project-pattern: 'test-project'
branchCompareType: 'ANT' branch-compare-type: 'ANT'
branchPattern: '**' branch-pattern: '**'
skipVote: skip-vote:
successful: true successful: true
failed: true failed: true
unstable: true unstable: true
notbuilt: true notbuilt: true
""" """
gerrit_handle_legacy_configuration(data)
projects = data['projects'] projects = data['projects']
gtrig = XML.SubElement(xml_parent, gtrig = XML.SubElement(xml_parent,
'com.sonyericsson.hudson.plugins.gerrit.trigger.' 'com.sonyericsson.hudson.plugins.gerrit.trigger.'
@ -149,25 +198,25 @@ def gerrit(parser, xml_parent, data):
'com.sonyericsson.hudson.plugins.gerrit.' 'com.sonyericsson.hudson.plugins.gerrit.'
'trigger.hudsontrigger.data.GerritProject') 'trigger.hudsontrigger.data.GerritProject')
XML.SubElement(gproj, 'compareType').text = \ XML.SubElement(gproj, 'compareType').text = \
project['projectCompareType'] project['project-compare-type']
XML.SubElement(gproj, 'pattern').text = project['projectPattern'] XML.SubElement(gproj, 'pattern').text = project['project-pattern']
branches = XML.SubElement(gproj, 'branches') branches = XML.SubElement(gproj, 'branches')
gbranch = XML.SubElement(branches, 'com.sonyericsson.hudson.plugins.' gbranch = XML.SubElement(branches, 'com.sonyericsson.hudson.plugins.'
'gerrit.trigger.hudsontrigger.data.Branch') 'gerrit.trigger.hudsontrigger.data.Branch')
XML.SubElement(gbranch, 'compareType').text = \ XML.SubElement(gbranch, 'compareType').text = \
project['branchCompareType'] project['branch-compare-type']
XML.SubElement(gbranch, 'pattern').text = project['branchPattern'] XML.SubElement(gbranch, 'pattern').text = project['branch-pattern']
build_gerrit_skip_votes(gtrig, data) build_gerrit_skip_votes(gtrig, data)
XML.SubElement(gtrig, 'silentMode').text = 'false' XML.SubElement(gtrig, 'silentMode').text = 'false'
XML.SubElement(gtrig, 'escapeQuotes').text = 'true' XML.SubElement(gtrig, 'escapeQuotes').text = 'true'
build_gerrit_triggers(gtrig, data) 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 = \ XML.SubElement(gtrig, 'gerritBuildSuccessfulVerifiedValue').text = \
str(data['gerritBuildSuccessfulVerifiedValue']) str(data['gerrit-build-successful-verified-value'])
XML.SubElement(gtrig, 'gerritBuildFailedVerifiedValue').text = \ XML.SubElement(gtrig, 'gerritBuildFailedVerifiedValue').text = \
str(data['gerritBuildFailedVerifiedValue']) str(data['gerrit-build-failed-verified-value'])
XML.SubElement(gtrig, 'buildStartMessage') 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, 'buildSuccessfulMessage')
XML.SubElement(gtrig, 'buildUnstableMessage') XML.SubElement(gtrig, 'buildUnstableMessage')
XML.SubElement(gtrig, 'customUrl') XML.SubElement(gtrig, 'customUrl')

30
samples/gerrit-trigger.yaml
View File

@ -2,24 +2,24 @@
name: test-gerrit-trigger name: test-gerrit-trigger
triggers: triggers:
- gerrit: - gerrit:
triggerOnChangeAbandonedEvent: true trigger-on-change-abandoned-event: true
triggerOnChangeMergedEvent: true trigger-on-change-merged-event: true
triggerOnChangeRestoredEvent: true trigger-on-change-restored-event: true
triggerOnCommentAddedEvent: true trigger-on-comment-added-event: true
triggerOnDraftPublishedEvent: true trigger-on-draft-published-event: true
triggerOnPatchsetUploadedEvent: true trigger-on-patchset-uploaded-event: true
triggerOnRefUpdatedEvent: false trigger-on-ref-updated-event: false
triggerApprovalCategory: CRVW trigger-approval-category: CRVW
triggerApprovalValue: 2 trigger-approval-value: 2
failureMessage: failure-message:
skipVote: skip-vote:
successful: true successful: true
failed: false failed: false
# Missing outcome should default to false. # Missing outcome should default to false.
# unstable: false # unstable: false
notbuilt: true notbuilt: true
projects: projects:
- projectCompareType: 'PLAIN' - project-compare-type: 'PLAIN'
projectPattern: 'myproject' project-pattern: 'myproject'
branchCompareType: 'PLAIN' branch-compare-type: 'PLAIN'
branchPattern: 'master' branch-pattern: 'master'