From 84ce3b4f560680afca54d31ef7f8fa51d2ae9f34 Mon Sep 17 00:00:00 2001
From: tanhengyeow <E0032242@u.nus.edu>
Date: Mon, 18 Jun 2018 01:03:39 +0800
Subject: [PATCH] Add support for AccuRev as SCM Provider

The AccuRev plugin is supported in this patch.

Change-Id: I4a9d58367afdf06913213bdc8c0fdd8de5126d3e
Story: #2001118
Task: #4809
---
 jenkins_jobs/modules/scm.py        | 59 ++++++++++++++++++++++++++++++
 tests/scm/fixtures/accurev001.xml  | 18 +++++++++
 tests/scm/fixtures/accurev001.yaml | 15 ++++++++
 3 files changed, 92 insertions(+)
 create mode 100644 tests/scm/fixtures/accurev001.xml
 create mode 100644 tests/scm/fixtures/accurev001.yaml

diff --git a/jenkins_jobs/modules/scm.py b/jenkins_jobs/modules/scm.py
index 904d3c3fe..54b597c67 100644
--- a/jenkins_jobs/modules/scm.py
+++ b/jenkins_jobs/modules/scm.py
@@ -1375,6 +1375,65 @@ def dimensions(registry, xml_parent, data):
     convert_mapping_to_xml(scm, data, optional_mapping, fail_required=False)
 
 
+def accurev(registry, xml_parent, data):
+    """yaml: accurev
+    Specifies the AccuRev SCM repository for this job.
+    Requires the Jenkins :jenkins-wiki:`AccuRev Plugin <AccuRev+Plugin>`.
+
+    :arg str depot: Depot you want to use for the current job (optional)
+    :arg str stream: Stream where the build will be generated from (optional)
+    :arg str server-name: AccuRev server you are using
+        for your builds (required)
+    :arg bool ignore-parent-changes: Ignore possibility
+        of changes in the parent stream (default false)
+    :arg bool clean-reference-tree: Deletes any external files
+        in reference tree (default false)
+    :arg bool build-from-snapshot: Creates snapshot
+        of the target stream, then populates and
+        builds from that snapshot (default false)
+    :arg bool do-not-pop-content: If checkbox is on, elements
+        are not populating vice versa (default false)
+    :arg str workspace: Name of existing workspace (optional)
+    :arg str reference-tree: Name of the reference tree (optional)
+    :arg str directory-offset: Relative directory path from
+        the default Jenkins workspace location
+        where the files from the stream, workspace,
+        or reference tree should be retrieved from. (optional)
+    :arg str sub-path: Makes a "best effort" to ensure
+        that only the sub-path is populated (optional)
+    :arg str filter-poll-scm: Specify directories or
+        files you want Jenkins to check before starting a build (optional)
+    :arg str snapshot-name-format: Naming conventions
+        for the snapshot in this field (optional)
+
+    Example:
+
+    .. literalinclude:: /../../tests/scm/fixtures/accurev001.yaml
+    """
+    scm = XML.SubElement(xml_parent,
+                         'scm', {'class': 'hudson.plugins.accurev.AccurevSCM'})
+    mapping = [
+        ('depot', 'depot', None),
+        ('stream', 'stream', None),
+        ('server-name', 'serverName', None),
+        ('ignore-parent-changes', 'ignoreStreamParent', False),
+        ('clean-reference-tree', 'cleanreftree', False),
+        ('build-from-snapshot', 'useSnapshot', False),
+        ('do-not-pop-content', 'dontPopContent', False),
+    ]
+    convert_mapping_to_xml(scm, data, mapping, fail_required=True)
+
+    additional_mapping = [
+        ('workspace', 'workspace', None),
+        ('reference-tree', 'reftree', None),
+        ('directory-offset', 'directoryOffset', None),
+        ('sub-path', 'subPath', None),
+        ('filter-poll-scm', 'filterForPollSCM', None),
+        ('snapshot-name-format', 'snapshotNameFormat', None),
+    ]
+    convert_mapping_to_xml(scm, data, additional_mapping, fail_required=False)
+
+
 class SCM(jenkins_jobs.modules.base.Base):
     sequence = 30
 
diff --git a/tests/scm/fixtures/accurev001.xml b/tests/scm/fixtures/accurev001.xml
new file mode 100644
index 000000000..296b73078
--- /dev/null
+++ b/tests/scm/fixtures/accurev001.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project>
+  <scm class="hudson.plugins.accurev.AccurevSCM">
+    <depot>Test depot</depot>
+    <stream>Test stream</stream>
+    <serverName>Test server name</serverName>
+    <ignoreStreamParent>true</ignoreStreamParent>
+    <cleanreftree>true</cleanreftree>
+    <useSnapshot>true</useSnapshot>
+    <dontPopContent>true</dontPopContent>
+    <workspace>Test workspace</workspace>
+    <reftree>Test reference tree</reftree>
+    <directoryOffset>Test directory offset</directoryOffset>
+    <subPath>Test sub path</subPath>
+    <filterForPollSCM>Test filter</filterForPollSCM>
+    <snapshotNameFormat>Test snapshot name format</snapshotNameFormat>
+  </scm>
+</project>
diff --git a/tests/scm/fixtures/accurev001.yaml b/tests/scm/fixtures/accurev001.yaml
new file mode 100644
index 000000000..254139333
--- /dev/null
+++ b/tests/scm/fixtures/accurev001.yaml
@@ -0,0 +1,15 @@
+scm:
+  - accurev:
+      depot: Test depot
+      stream: Test stream
+      server-name: Test server name
+      ignore-parent-changes: true
+      clean-reference-tree: true
+      build-from-snapshot: true
+      do-not-pop-content: true
+      workspace: Test workspace
+      reference-tree: Test reference tree
+      directory-offset: Test directory offset
+      sub-path: Test sub path
+      filter-poll-scm: Test filter
+      snapshot-name-format: Test snapshot name format