Merge "Support for CVS SCM using CVS plugin"

jenkins_jobs/modules/scm.py

@@ -40,7 +40,8 @@ import logging
 import xml.etree.ElementTree as XML
 import jenkins_jobs.modules.base
 from jenkins_jobs.errors import (InvalidAttributeError,
-                                 JenkinsJobsException)
+                                 JenkinsJobsException,
+                                 MissingAttributeError)
 
 
 def git(parser, xml_parent, data):
@@ -423,6 +424,136 @@ def git(parser, xml_parent, data):
                 data.get('repo-name', ''))
 
 
+def cvs(parser, xml_parent, data):
+    """yaml: cvs
+    Specifies the CVS SCM repository for this job.
+    Requires the Jenkins :jenkins-wiki:`CVS Plugin <CVS+Plugin>`.
+
+    :arg list repos: List of CVS repositories. (required)
+
+        :Repos:
+            * **root** (`str`) -- The CVS connection string Jenkins uses to
+              connect to the server. The format is :protocol:user@host:path
+              (required)
+            * **locations** (`list`) -- List of locations. (required)
+
+                :Locations:
+                    * **type** (`str`) -- Type of location.
+
+                        :supported values:
+                            * **HEAD** - (default)
+                            * **BRANCH**
+                            * **TAG**
+                    * **name** (`str`) -- Name of location. Only valid in case
+                      of 'BRANCH' or 'TAG' location type. (default '')
+                    * **use-head** (`bool`) -- Use Head if not found. Only
+                      valid in case of 'BRANCH' or 'TAG' location type.
+                      (default false)
+                    * **modules** (`list`) -- List of modules. (required)
+
+                        :Modules:
+                            * **remote** -- The name of the module in the
+                              repository at CVSROOT. (required)
+                            * **local-name** --  The name to be applied to
+                              this module in the local workspace. If blank,
+                              the remote module name will be used.
+                              (default '')
+            * **excluded-regions** (`list str`) -- Patterns for excluding
+              regions. (optional)
+            * **compression-level** (`int`) -- Compression level. Must be a
+              number between -1 and 9 inclusive. Choose -1 for System Default.
+              (default -1)
+    :arg bool use-update: If true, Jenkins will use 'cvs update' whenever
+      possible for builds. This makes a build faster. But this also causes the
+      artifacts from the previous build to remain in the file system when a
+      new build starts, making it not a true clean build. (default true)
+    :arg bool prune-empty: Remove empty directories after checkout using the
+      CVS '-P' option. (default true)
+    :arg bool skip-changelog: Prevent the changelog being generated after
+      checkout has completed. (default false)
+    :arg bool show-all-output: Instructs CVS to show all logging output. CVS
+      normally runs in quiet mode but this option disables that.
+      (default false)
+    :arg bool clean-checkout: Perform clean checkout on failed update.
+      (default false)
+    :arg bool clean-copy: Force clean copy for locally modified files.
+      (default false)
+
+    Example
+
+    .. literalinclude:: /../../tests/scm/fixtures/cvs001.yaml
+       :language: yaml
+    .. literalinclude:: /../../tests/scm/fixtures/cvs002.yaml
+       :language: yaml
+    """
+    prefix = 'hudson.scm.'
+    valid_loc_types = {'HEAD': 'Head', 'TAG': 'Tag', 'BRANCH': 'Branch'}
+    cvs = XML.SubElement(xml_parent, 'scm', {'class': prefix + 'CVSSCM'})
+    repos = data.get('repos')
+    if not repos:
+        raise JenkinsJobsException("'repos' empty or missing")
+    repos_tag = XML.SubElement(cvs, 'repositories')
+    for repo in repos:
+        repo_tag = XML.SubElement(repos_tag, prefix + 'CvsRepository')
+        try:
+            XML.SubElement(repo_tag, 'cvsRoot').text = repo['root']
+        except KeyError:
+            raise MissingAttributeError('root')
+        items_tag = XML.SubElement(repo_tag, 'repositoryItems')
+        locations = repo.get('locations')
+        if not locations:
+            raise JenkinsJobsException("'locations' empty or missing")
+        for location in locations:
+            item_tag = XML.SubElement(items_tag, prefix + 'CvsRepositoryItem')
+            loc_type = location.get('type', 'HEAD')
+            if loc_type not in valid_loc_types:
+                raise InvalidAttributeError('type', loc_type, valid_loc_types)
+            loc_class = ('{0}CvsRepositoryLocation${1}Repository'
+                         'Location').format(prefix, valid_loc_types[loc_type])
+            loc_tag = XML.SubElement(item_tag, 'location',
+                                     {'class': loc_class})
+            XML.SubElement(loc_tag, 'locationType').text = loc_type
+            if loc_type == 'TAG' or loc_type == 'BRANCH':
+                XML.SubElement(loc_tag, 'locationName').text = location.get(
+                    'name', '')
+                XML.SubElement(loc_tag, 'useHeadIfNotFound').text = str(
+                    location.get('use-head', False)).lower()
+            modules = location.get('modules')
+            if not modules:
+                raise JenkinsJobsException("'modules' empty or missing")
+            modules_tag = XML.SubElement(item_tag, 'modules')
+            for module in modules:
+                module_tag = XML.SubElement(modules_tag, prefix + 'CvsModule')
+                try:
+                    XML.SubElement(module_tag, 'remoteName'
+                                   ).text = module['remote']
+                except KeyError:
+                    raise MissingAttributeError('remote')
+                XML.SubElement(module_tag, 'localName').text = module.get(
+                    'local-name', '')
+        excluded = repo.get('excluded-regions', [])
+        excluded_tag = XML.SubElement(repo_tag, 'excludedRegions')
+        for pattern in excluded:
+            pattern_tag = XML.SubElement(excluded_tag,
+                                         prefix + 'ExcludedRegion')
+            XML.SubElement(pattern_tag, 'pattern').text = pattern
+        compression_level = repo.get('compression-level', '-1')
+        if int(compression_level) not in range(-1, 10):
+            raise InvalidAttributeError('compression-level',
+                                        compression_level, range(-1, 10))
+        XML.SubElement(repo_tag, 'compressionLevel').text = compression_level
+    mapping = [('use-update', 'canUseUpdate', True),
+               ('prune-empty', 'pruneEmptyDirectories', True),
+               ('skip-changelog', 'skipChangeLog', False),
+               ('show-all-output', 'disableCvsQuiet', False),
+               ('clean-checkout', 'cleanOnFailedUpdate', False),
+               ('clean-copy', 'forceCleanCopy', False)]
+    for elem in mapping:
+        opt, xml_tag, val = elem[:]
+        XML.SubElement(cvs, xml_tag).text = str(
+            data.get(opt, val)).lower()
+
+
 def repo(parser, xml_parent, data):
     """yaml: repo
     Specifies the repo SCM repository for this job.

setup.cfg

@@ -219,6 +219,7 @@ jenkins_jobs.publishers =
     xunit=jenkins_jobs.modules.publishers:xunit
     zulip=jenkins_jobs.modules.publishers:zulip
 jenkins_jobs.scm =
+    cvs=jenkins_jobs.modules.scm:cvs
     git=jenkins_jobs.modules.scm:git
     hg=jenkins_jobs.modules.scm:hg
     raw=jenkins_jobs.modules.general:raw

tests/scm/fixtures/cvs001.xml

@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project>
+  <scm class="hudson.scm.CVSSCM">
+    <repositories>
+      <hudson.scm.CvsRepository>
+        <cvsRoot>:protocol:user@host1:path</cvsRoot>
+        <repositoryItems>
+          <hudson.scm.CvsRepositoryItem>
+            <location class="hudson.scm.CvsRepositoryLocation$HeadRepositoryLocation">
+              <locationType>HEAD</locationType>
+            </location>
+            <modules>
+              <hudson.scm.CvsModule>
+                <remoteName>remote1</remoteName>
+                <localName/>
+              </hudson.scm.CvsModule>
+              <hudson.scm.CvsModule>
+                <remoteName>remote2</remoteName>
+                <localName/>
+              </hudson.scm.CvsModule>
+            </modules>
+          </hudson.scm.CvsRepositoryItem>
+        </repositoryItems>
+        <excludedRegions/>
+        <compressionLevel>-1</compressionLevel>
+      </hudson.scm.CvsRepository>
+      <hudson.scm.CvsRepository>
+        <cvsRoot>:protocol:user@host2:path</cvsRoot>
+        <repositoryItems>
+          <hudson.scm.CvsRepositoryItem>
+            <location class="hudson.scm.CvsRepositoryLocation$HeadRepositoryLocation">
+              <locationType>HEAD</locationType>
+            </location>
+            <modules>
+              <hudson.scm.CvsModule>
+                <remoteName>remote1</remoteName>
+                <localName/>
+              </hudson.scm.CvsModule>
+            </modules>
+          </hudson.scm.CvsRepositoryItem>
+        </repositoryItems>
+        <excludedRegions/>
+        <compressionLevel>-1</compressionLevel>
+      </hudson.scm.CvsRepository>
+    </repositories>
+    <canUseUpdate>true</canUseUpdate>
+    <pruneEmptyDirectories>true</pruneEmptyDirectories>
+    <skipChangeLog>false</skipChangeLog>
+    <disableCvsQuiet>false</disableCvsQuiet>
+    <cleanOnFailedUpdate>false</cleanOnFailedUpdate>
+    <forceCleanCopy>false</forceCleanCopy>
+  </scm>
+</project>

tests/scm/fixtures/cvs001.yaml

@@ -0,0 +1,12 @@
+scm:
+  - cvs:
+      repos:
+          - root: ":protocol:user@host1:path"
+            locations:
+                - modules:
+                    - remote: "remote1"
+                    - remote: "remote2"
+          - root: ":protocol:user@host2:path"
+            locations:
+                - modules:
+                    - remote: "remote1"

tests/scm/fixtures/cvs002.xml

@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project>
+  <scm class="hudson.scm.CVSSCM">
+    <repositories>
+      <hudson.scm.CvsRepository>
+        <cvsRoot>:protocol:user@host1:path</cvsRoot>
+        <repositoryItems>
+          <hudson.scm.CvsRepositoryItem>
+            <location class="hudson.scm.CvsRepositoryLocation$TagRepositoryLocation">
+              <locationType>TAG</locationType>
+              <locationName>tag name</locationName>
+              <useHeadIfNotFound>false</useHeadIfNotFound>
+            </location>
+            <modules>
+              <hudson.scm.CvsModule>
+                <remoteName>remote1</remoteName>
+                <localName>localName</localName>
+              </hudson.scm.CvsModule>
+              <hudson.scm.CvsModule>
+                <remoteName>remote2</remoteName>
+                <localName/>
+              </hudson.scm.CvsModule>
+            </modules>
+          </hudson.scm.CvsRepositoryItem>
+        </repositoryItems>
+        <excludedRegions>
+          <hudson.scm.ExcludedRegion>
+            <pattern>pattern1</pattern>
+          </hudson.scm.ExcludedRegion>
+          <hudson.scm.ExcludedRegion>
+            <pattern>pattern2</pattern>
+          </hudson.scm.ExcludedRegion>
+        </excludedRegions>
+        <compressionLevel>1</compressionLevel>
+      </hudson.scm.CvsRepository>
+      <hudson.scm.CvsRepository>
+        <cvsRoot>:protocol:user@host2:path</cvsRoot>
+        <repositoryItems>
+          <hudson.scm.CvsRepositoryItem>
+            <location class="hudson.scm.CvsRepositoryLocation$HeadRepositoryLocation">
+              <locationType>HEAD</locationType>
+            </location>
+            <modules>
+              <hudson.scm.CvsModule>
+                <remoteName>remote1</remoteName>
+                <localName/>
+              </hudson.scm.CvsModule>
+            </modules>
+          </hudson.scm.CvsRepositoryItem>
+        </repositoryItems>
+        <excludedRegions/>
+        <compressionLevel>-1</compressionLevel>
+      </hudson.scm.CvsRepository>
+    </repositories>
+    <canUseUpdate>false</canUseUpdate>
+    <pruneEmptyDirectories>false</pruneEmptyDirectories>
+    <skipChangeLog>true</skipChangeLog>
+    <disableCvsQuiet>true</disableCvsQuiet>
+    <cleanOnFailedUpdate>true</cleanOnFailedUpdate>
+    <forceCleanCopy>true</forceCleanCopy>
+  </scm>
+</project>

tests/scm/fixtures/cvs002.yaml

@@ -0,0 +1,26 @@
+scm:
+  - cvs:
+      repos:
+          - root: ":protocol:user@host1:path"
+            locations:
+                - type: TAG
+                  name: "tag name"
+                  use-head: false
+                  modules:
+                    - remote: "remote1"
+                      local-name: "localName"
+                    - remote: "remote2"
+            excluded-regions:
+                - "pattern1"
+                - "pattern2"
+            compression-level: "1"
+          - root: ":protocol:user@host2:path"
+            locations:
+                - modules:
+                    - remote: "remote1"
+      use-update: false
+      prune-empty: false
+      skip-changelog: true
+      show-all-output: true
+      clean-checkout: true
+      clean-copy: true