From ee86bc318c53013a1fc9dafabc1cdeb9f97ff216 Mon Sep 17 00:00:00 2001
From: tanhengyeow <E0032242@u.nus.edu>
Date: Sat, 21 Jul 2018 17:07:23 +0800
Subject: [PATCH] Add support for "Invoke Nexus Policy Evaluation"
Change-Id: I363e468cdb4b50a0c6cf924d00618fb0ec568588
Signed-off-by: Tan Heng Yeow <E0032242@u.nus.edu>
---
jenkins_jobs/modules/builders.py | 89 +++++++++++++++++++
.../nexus-iq-policy-evaluator-full.xml | 20 +++++
.../nexus-iq-policy-evaluator-full.yaml | 9 ++
.../nexus-iq-policy-evaluator-minimal.xml | 13 +++
.../nexus-iq-policy-evaluator-minimal.yaml | 4 +
5 files changed, 135 insertions(+)
create mode 100644 tests/builders/fixtures/nexus-iq-policy-evaluator-full.xml
create mode 100644 tests/builders/fixtures/nexus-iq-policy-evaluator-full.yaml
create mode 100644 tests/builders/fixtures/nexus-iq-policy-evaluator-minimal.xml
create mode 100644 tests/builders/fixtures/nexus-iq-policy-evaluator-minimal.yaml
diff --git a/jenkins_jobs/modules/builders.py b/jenkins_jobs/modules/builders.py
index 959345d6f..77ca9e4fd 100644
--- a/jenkins_jobs/modules/builders.py
+++ b/jenkins_jobs/modules/builders.py
@@ -4083,6 +4083,95 @@ def nexus_artifact_uploader(registry, xml_parent, data):
nexus_artifact_uploader, data, mapping, fail_required=True)
+def nexus_iq_policy_evaluator(registry, xml_parent, data):
+ """yaml: nexus-iq-policy-evaluator
+ Integrates the Nexus Lifecycle into a Jenkins job.
+ This function triggers 'Invokes Nexus Policy Evaluation'.
+ Requires the Jenkins :jenkins-wiki:`Nexus
+ Platform Plugin <Nexus+Platform+Plugin>`.
+
+ :arg str stage: Controls the stage the policy evaluation will be
+ run against on the Nexus IQ Server (required)
+
+ :stage values:
+ * **build**
+ * **stage-release**
+ * **operate**
+ :arg dict application-type: Specifies an IQ Application (default manual)
+
+ :application-type values:
+ * **manual**
+ * **selected**
+ :arg str application-id: Specify the IQ Application ID (required)
+ :arg list scan-patterns: List of Ant-style patterns relative to the
+ workspace root that denote files/archives to be scanned (default [])
+ :arg bool fail-build-network-error: Controls the build outcome if there
+ is a failure in communicating with the Nexus IQ Server (default false)
+
+ Minimal Example:
+
+ .. literalinclude::
+ /../../tests/builders/fixtures/nexus-iq-policy-evaluator-minimal.yaml
+ :language: yaml
+
+ Full Example:
+
+ .. literalinclude::
+ /../../tests/builders/fixtures/nexus-iq-policy-evaluator-full.yaml
+ :language: yaml
+ """
+ nexus_iq_policy_evaluator = XML.SubElement(
+ xml_parent,
+ 'org.sonatype.nexus.ci.iq.IqPolicyEvaluatorBuildStep')
+
+ format_dict = {
+ 'stage': 'com__sonatype__nexus__ci__iq__IqPolicyEvaluator____iqStage',
+ 'fone': 'com__sonatype__nexus__ci__iq__IqPolicyEvaluator'
+ '____failBuildOnNetworkError',
+ }
+
+ valid_stages = ['build', 'stage-release', 'operate']
+ mapping = [
+ ('stage', format_dict.get('stage'), None, valid_stages),
+ ('fail-build-network-error', format_dict.get('fone'), False),
+ ]
+ helpers.convert_mapping_to_xml(
+ nexus_iq_policy_evaluator, data, mapping, fail_required=True)
+
+ application_type_label = data.get('application-type', 'manual').lower()
+ application_type_label_dict = {
+ 'manual': 'org.sonatype.nexus.ci.iq.ManualApplication',
+ 'selected': 'org.sonatype.nexus.ci.iq.SelectedApplication',
+ }
+ if application_type_label not in application_type_label_dict:
+ raise InvalidAttributeError(application_type_label,
+ application_type_label,
+ application_type_label_dict.keys())
+
+ application_type_tag = XML.SubElement(
+ nexus_iq_policy_evaluator,
+ 'com__sonatype__nexus__ci__iq__IqPolicyEvaluator____iqApplication')
+ application_type_tag.set(
+ "class", application_type_label_dict[application_type_label]
+ )
+
+ mapping = [
+ ('application-id', 'applicationId', None),
+ ]
+ helpers.convert_mapping_to_xml(application_type_tag, data,
+ mapping, fail_required=True)
+
+ scan_pattern_list = data.get('scan-patterns', [])
+ iq_scan_pattern_tag = XML.SubElement(nexus_iq_policy_evaluator,
+ 'com__sonatype__nexus__ci__iq'
+ '__IqPolicyEvaluator____iqScanPatterns')
+
+ for scan_pattern in scan_pattern_list:
+ scan_pattern_tag = XML.SubElement(
+ iq_scan_pattern_tag, 'org.sonatype.nexus.ci.iq.ScanPattern')
+ XML.SubElement(scan_pattern_tag, 'scanPattern').text = scan_pattern
+
+
def ansible_playbook(parser, xml_parent, data):
"""yaml: ansible-playbook
This plugin allows you to execute Ansible tasks as a job build step.
diff --git a/tests/builders/fixtures/nexus-iq-policy-evaluator-full.xml b/tests/builders/fixtures/nexus-iq-policy-evaluator-full.xml
new file mode 100644
index 000000000..eb5928c4a
--- /dev/null
+++ b/tests/builders/fixtures/nexus-iq-policy-evaluator-full.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project>
+ <builders>
+ <org.sonatype.nexus.ci.iq.IqPolicyEvaluatorBuildStep>
+ <com__sonatype__nexus__ci__iq__IqPolicyEvaluator____iqStage>stage-release</com__sonatype__nexus__ci__iq__IqPolicyEvaluator____iqStage>
+ <com__sonatype__nexus__ci__iq__IqPolicyEvaluator____failBuildOnNetworkError>true</com__sonatype__nexus__ci__iq__IqPolicyEvaluator____failBuildOnNetworkError>
+ <com__sonatype__nexus__ci__iq__IqPolicyEvaluator____iqApplication class="org.sonatype.nexus.ci.iq.SelectedApplication">
+ <applicationId>nexus-iq-application-id002</applicationId>
+ </com__sonatype__nexus__ci__iq__IqPolicyEvaluator____iqApplication>
+ <com__sonatype__nexus__ci__iq__IqPolicyEvaluator____iqScanPatterns>
+ <org.sonatype.nexus.ci.iq.ScanPattern>
+ <scanPattern>**/target/*.war</scanPattern>
+ </org.sonatype.nexus.ci.iq.ScanPattern>
+ <org.sonatype.nexus.ci.iq.ScanPattern>
+ <scanPattern>**/target/*.ear</scanPattern>
+ </org.sonatype.nexus.ci.iq.ScanPattern>
+ </com__sonatype__nexus__ci__iq__IqPolicyEvaluator____iqScanPatterns>
+ </org.sonatype.nexus.ci.iq.IqPolicyEvaluatorBuildStep>
+ </builders>
+</project>
diff --git a/tests/builders/fixtures/nexus-iq-policy-evaluator-full.yaml b/tests/builders/fixtures/nexus-iq-policy-evaluator-full.yaml
new file mode 100644
index 000000000..c5b79bfb1
--- /dev/null
+++ b/tests/builders/fixtures/nexus-iq-policy-evaluator-full.yaml
@@ -0,0 +1,9 @@
+builders:
+ - nexus-iq-policy-evaluator:
+ stage: 'stage-release'
+ application-type: 'selected'
+ application-id: 'nexus-iq-application-id002'
+ scan-patterns:
+ - '**/target/*.war'
+ - '**/target/*.ear'
+ fail-build-network-error: true
diff --git a/tests/builders/fixtures/nexus-iq-policy-evaluator-minimal.xml b/tests/builders/fixtures/nexus-iq-policy-evaluator-minimal.xml
new file mode 100644
index 000000000..5515b1f59
--- /dev/null
+++ b/tests/builders/fixtures/nexus-iq-policy-evaluator-minimal.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project>
+ <builders>
+ <org.sonatype.nexus.ci.iq.IqPolicyEvaluatorBuildStep>
+ <com__sonatype__nexus__ci__iq__IqPolicyEvaluator____iqStage>build</com__sonatype__nexus__ci__iq__IqPolicyEvaluator____iqStage>
+ <com__sonatype__nexus__ci__iq__IqPolicyEvaluator____failBuildOnNetworkError>false</com__sonatype__nexus__ci__iq__IqPolicyEvaluator____failBuildOnNetworkError>
+ <com__sonatype__nexus__ci__iq__IqPolicyEvaluator____iqApplication class="org.sonatype.nexus.ci.iq.ManualApplication">
+ <applicationId>nexus-iq-application-id001</applicationId>
+ </com__sonatype__nexus__ci__iq__IqPolicyEvaluator____iqApplication>
+ <com__sonatype__nexus__ci__iq__IqPolicyEvaluator____iqScanPatterns/>
+ </org.sonatype.nexus.ci.iq.IqPolicyEvaluatorBuildStep>
+ </builders>
+</project>
diff --git a/tests/builders/fixtures/nexus-iq-policy-evaluator-minimal.yaml b/tests/builders/fixtures/nexus-iq-policy-evaluator-minimal.yaml
new file mode 100644
index 000000000..b8bd009c1
--- /dev/null
+++ b/tests/builders/fixtures/nexus-iq-policy-evaluator-minimal.yaml
@@ -0,0 +1,4 @@
+builders:
+ - nexus-iq-policy-evaluator:
+ stage: 'build'
+ application-id: 'nexus-iq-application-id001'