Merge "ansicolor: Enforce valid types"

jenkins_jobs/modules/wrappers.py

@@ -463,23 +463,25 @@ def ansicolor(registry, xml_parent, data):
     Translate ANSI color codes to HTML in the console log.
     Requires the Jenkins :jenkins-wiki:`Ansi Color Plugin <AnsiColor+Plugin>`.
 
-    :arg string colormap: (optional) color mapping to use
+    :arg string colormap: Color mapping to use (default xterm)
 
-    Examples::
+    Minimal Example:
 
-      wrappers:
-        - ansicolor
+    .. literalinclude:: /../../tests/wrappers/fixtures/ansicolor-minimal.yaml
+       :language: yaml
 
-      # Explicitly setting the colormap
-      wrappers:
-        - ansicolor:
-            colormap: vga
+    Full Example:
+
+    .. literalinclude:: /../../tests/wrappers/fixtures/ansicolor-full.yaml
+       :language: yaml
     """
     cwrapper = XML.SubElement(
         xml_parent,
         'hudson.plugins.ansicolor.AnsiColorBuildWrapper')
+
+    valid_types = ['xterm', 'vga', 'css', 'gnome-terminal']
     mapping = [
-        ('colormap', 'colorMapName', None),
+        ('colormap', 'colorMapName', 'xterm', valid_types),
     ]
     helpers.convert_mapping_to_xml(
         cwrapper, data, mapping, fail_required=False)

tests/wrappers/fixtures/ansicolor-full.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project>
+  <buildWrappers>
+    <hudson.plugins.ansicolor.AnsiColorBuildWrapper>
+      <colorMapName>gnome-terminal</colorMapName>
+    </hudson.plugins.ansicolor.AnsiColorBuildWrapper>
+  </buildWrappers>
+</project>

tests/wrappers/fixtures/ansicolor-full.yaml

@@ -0,0 +1,3 @@
+wrappers:
+  - ansicolor:
+      colormap: "gnome-terminal"

tests/wrappers/fixtures/ansicolor-minimal.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project>
+  <buildWrappers>
+    <hudson.plugins.ansicolor.AnsiColorBuildWrapper>
+      <colorMapName>xterm</colorMapName>
+    </hudson.plugins.ansicolor.AnsiColorBuildWrapper>
+  </buildWrappers>
+</project>

tests/wrappers/fixtures/ansicolor-minimal.yaml

@@ -0,0 +1,2 @@
+wrappers:
+  - ansicolor