Merge pull request #234 from tszmytka/66684-generate-snippet

[JENKINS-66684] Provide colorMapName to allow generating example snippet

CHANGELOG.md

@@ -1,6 +1,7 @@
 1.0.1 (Next)
 ============
 
+* [JENKINS-66684](https://issues.jenkins.io/browse/JENKINS-66684) Pipeline syntax snippet generator fails with ansicolor plugin 1.0.0 - [@tszmytka](https://github.com/tszmytka).
 * Your contribution here.
 
 

README.md

@@ -76,7 +76,7 @@ ansiColor('xterm') {
 
 ## In a traditional job
 
-Traditional, Jenkins UI defined jobs can also take advantage of `ansicolor` by enabling under "Build Environment" settings.
+Traditional, Jenkins UI defined jobs, can also take advantage of `ansicolor` by enabling it under "Build Environment" settings.
 
 ![enable](images/ansicolor-enable.png "Enable AnsiColor")
 

src/main/java/hudson/plugins/ansicolor/AnsiColorStep.java

@@ -35,6 +35,10 @@ public AnsiColorStep(final String colorMapName) {
             Optional.ofNullable(Jenkins.get().getDescriptorByType(AnsiColorBuildWrapper.DescriptorImpl.class).getGlobalColorMapName()).orElse(AnsiColorMap.DefaultName));
     }
 
+    public String getColorMapName() {
+        return colorMapName;
+    }
+
     private static DescriptorImpl getWrapperDescriptor() {
         return Jenkins.get().getDescriptorByType(DescriptorImpl.class);
     }

src/test/java/hudson/plugins/ansicolor/AnsiColorStepTest.java

@@ -228,6 +228,14 @@ public void canUseAndReportDefaultColorMapName() {
         );
     }
 
+    @Issue("JENKINS-66684")
+    @Test
+    public void canGetConstructorParametersForSnippetGenerator() {
+        final String colorMapName = AnsiColorMap.VGA.getName();
+        final AnsiColorStep step = new AnsiColorStep(colorMapName);
+        assertThat(step.getColorMapName()).isEqualTo(colorMapName);
+    }
+
     private void assertOutputOnRunningPipeline(Collection<String> expectedOutput, Collection<String> notExpectedOutput, String pipelineScript) {
         jenkinsRule.then(r -> {
             final WorkflowJob project = jenkinsRule.j.jenkins.createProject(WorkflowJob.class, "p");