Support coloring of labels of pipeline's "parallel" command

[DenizThatMenace]

I tried to colorize the label-output of Pipeline's parallel command.

def taskName = "\u001B[31mLabel in red\u001B[0m";
def task = { echo "\u001B[34mBody in blue\u001B[0m"; }
parallel( "${taskName}", task );

However, it seems the label is just printed verbatim. Only the body is printed in color.
The output looks like this (with Body in blue in blue color).

[[31mLabel in red[0m] Body in blue

Please forgive me, if this issue should be raised against Pipeline and its parallel command. However, maybe it is enough to adjust your plugin so that it supports that feature.

[dblock]

Seems like a legit feature request.

[dblock]

Does #83 help with this?

[cpoenisch]

Sorry, #83 will not solve this request, because label output of parallel is interpreted as plain text here.

[DenizThatMenace]

Sadly, I can confirm that even with #83 the label output of parallel is interpreted as plain text.
I guess, the internals of parallel must be changed to support coloring?

[JoeMerten]

Tried out the above mentioned example on Jenkins 2.32.3:

def taskName = "\u001B[31mLabel in red\u001B[0m";
def task = { echo "\u001B[34mBody in blue\u001B[0m"; }
parallel( "${taskName}", task );

but got an exception:

java.lang.IllegalArgumentException: Expected named arguments but got [�[31mLabel in red�[0m, org.jenkinsci.plugins.workflow.cps.CpsClosure2@efe9b4e]

@Bagira80, could you please make your example complete and running?
I also miss something like a ansiColor('xterm') { … }.

[JoeMerten]

I'd never worked with parallel until now, but tried to create an example based on https://github.com/jenkinsci/pipeline-examples/blob/master/pipeline-examples/parallel-from-list/parallelFromList.groovy.
Unfortunetely, my example is definitively not minimal and I'm not sure if I'd applied the ansiColor('xterm') { … } in a right way:

ansiColor('xterm') {
    // Our initial list of strings we want to echo in parallel
    def stringsToEcho = ["a", "b", "c", "d"]
    // The map we'll store the parallel steps in before executing them.
    def stepsForParallel = [:]
    for (int i = 0; i < stringsToEcho.size(); i++) {
        // Get the actual string here.
        def s = stringsToEcho.get(i)
        def color = "${i+31}"
        // Transform that into a step and add the step to the map as the value, with a name for the parallel step as the key. Here, we'll just use something like "echoing (string)"
        def stepName = "echoing \u001B[${color}mCOLOR\u001B[m ${s}"
        stepsForParallel[stepName] = transformIntoStep(s + "\u001B[${color}mCOLOR\u001B[m")
    }
    // Actually run the steps in parallel - parallel takes a map as an argument, hence the above.
    parallel stepsForParallel
} // ansiColor

// Take the string and echo it.
def transformIntoStep(inputString) {
    // We need to wrap what we return in a Groovy closure, or else it's invoked when this method is called, not when we pass it to parallel.
    // To do this, you need to wrap the code below in { }, and either return that explicitly, or use { -> } syntax.
    return {
        node {
            echo inputString
        }
    }
}

And the result is:

Finally the same conclusion as found out by Bygira80: "… the label is just printed verbatim. Only the body is printed in color."

It might be related to #104.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[herter4171]

Hello, I would like this feature. Color renders properly during the initial run, but color often doesn't persist when the page is reopened. In my pipeline, I have ansiColor set to xterm in the options block and around steps that will print in color, but color is still dropped in parallel stages after a reload.

Original page showing colors like it should:

Portion of the exact same log after loading in a new tab:

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.