summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDarragh Bailey <dbailey@hp.com>2014-11-03 18:01:20 +0000
committerDarragh Bailey <dbailey@hp.com>2014-11-03 18:04:35 +0000
commitbcaa8927da12d6459b8747b8ac4b0b8d692f7b41 (patch)
tree7235fdae27b65135cac424a0557948dd004d598a
parentdccd939102efdb5fb4504283129e68c56867126d (diff)
downloadpython-jenkins-job-builder-bcaa8927da12d6459b8747b8ac4b0b8d692f7b41.tar.gz
python-jenkins-job-builder-bcaa8927da12d6459b8747b8ac4b0b8d692f7b41.tar.xz
python-jenkins-job-builder-bcaa8927da12d6459b8747b8ac4b0b8d692f7b41.zip
Emit deprecation warning on old format use with gerrit trigger
Inform end-users that the old yaml format for gerrit trigger has been deprecated and support will be removed sometime after the next release. Change-Id: Idd04aee949b2ea05ffadb766fe7222a65ffb8052
-rw-r--r--jenkins_jobs/modules/triggers.py10
-rw-r--r--tests/yamlparser/fixtures/complete001.yaml25
2 files changed, 21 insertions, 14 deletions
diff --git a/jenkins_jobs/modules/triggers.py b/jenkins_jobs/modules/triggers.py
index 65f74607..f51c4f26 100644
--- a/jenkins_jobs/modules/triggers.py
+++ b/jenkins_jobs/modules/triggers.py
@@ -41,6 +41,8 @@ import re
def gerrit_handle_legacy_configuration(data):
hyphenizer = re.compile("[A-Z]")
+ logger = logging.getLogger("%s:gerrit" % __name__)
+
def hyphenize(attr):
"""Convert strings like triggerOn to trigger-on.
"""
@@ -50,7 +52,10 @@ def gerrit_handle_legacy_configuration(data):
def convert_dict(d, old_keys):
for old_key in old_keys:
if old_key in d:
- d[hyphenize(old_key)] = d[old_key]
+ new_key = hyphenize(old_key)
+ logger.warn("'%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, [
@@ -221,7 +226,8 @@ def gerrit(parser, xml_parent, data):
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.
+ supported, camedCase keys are deprecated and should not be used. Support
+ for this will be removed after 1.0.0 is released.
Example:
diff --git a/tests/yamlparser/fixtures/complete001.yaml b/tests/yamlparser/fixtures/complete001.yaml
index db7cdc4e..ba21923f 100644
--- a/tests/yamlparser/fixtures/complete001.yaml
+++ b/tests/yamlparser/fixtures/complete001.yaml
@@ -38,19 +38,20 @@
name: gerrit-review
triggers:
- gerrit:
- triggerOnPatchsetUploadedEvent: true
- triggerOnChangeMergedEvent: false
- triggerOnRefUpdatedEvent: false
- triggerOnCommentAddedEvent: false
- overrideVotes: true
- gerritBuildSuccessfulVerifiedValue: 1
- gerritBuildFailedVerifiedValue: -1
+ trigger-on-patchset-uploaded-event: true
+ trigger-on-change-merged-event: false
+ trigger-on-ref-updated-event: false
+ trigger-on-comment-added-event: false
+ override-votes: true
+ gerrit-build-successful-verified-value: 1
+ gerrit-build-failed-verified-value: -1
projects:
- - projectCompareType: 'PLAIN'
- projectPattern: '{project_pattern}'
- branchCompareType: 'ANT'
- branchPattern: '**'
- failureMessage: 'This change was unable to be automatically merged with the current state of the repository. Please rebase your change and upload a new patchset.'
+ - project-compare-type: 'PLAIN'
+ project-pattern: '{project_pattern}'
+ branches:
+ - branch-compare-type: 'ANT'
+ branch-pattern: '**'
+ failure-message: 'This change was unable to be automatically merged with the current state of the repository. Please rebase your change and upload a new patchset.'
- scm:
name: gerrit-scm