[JENKINS-39284] Set build description to failure cause

[TreverW]

JENKINS-39284
Add an option to the BFA configuration that, when enabled, sets the build description to the failure cause.

[TWestling]

Good idea!
One small inline comment + please tests for this.
Should be easy to add some tests for this to BuildFailureScannerHudsonTest

[TreverW]

Thanks for the suggestions (this is my first OSS pull request so I'm learning how this works).

I've appended to the build description instead of overwriting it. I've also added some tests. The tests are not as complete as I'd like because I'm not sure how to manipulate the build description before BFA scans the build. I'd like to test functionality with a build description already set such as might happen from another plugin. If you have some suggestion on how I might do that in the tests, I'd be happy to improve the tests.

[rsandell]

You can either add a custom TestBuilder to a FreestyleProject or in a pipeline just do currentBuild.description = "Hello World"

You do something like the following to add the test builder:

project.getBuildersList().add(new TestBuilder() {
    @Override
    boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListener listener) throws InterruptedException, IOException {
        build.setDescription("Hello World")
        return true;
    }
});

[rsennewald]

Hello, is there any chance this can be re-reviewed and integrated with the project? I'm looking for the exact same functionality to solve my use case and would love it if the plugin supported it out of the box and I didn't have to do a post build script in groovy to achieve this.

[rsandell]

Sorry for the review delay, I thought someone else was actively reviewing it.

[ssbarnea]

I like the idea but I would prefer to append-to-description option instead of overriding current value.

[guidograzioli]

Also, this functionality should only be offered after enabling a global config checkbox. Changing the default behaviour without action is never a good idea.

[TreverW]

Thank you for your time reviewing this PR. I've tried to address the suggestions given. Thank you. I am still learning how to do plugin development for Jenkins so I appreciate the feedback.

[stronk7]

Was looking to release notes and other random stuff when I arrived here.

Just in case it helps to anybody... we are using here since some good months ago this script, launched every X minutes via job... that exactly addresses this (set build description to the BFA causes found).

https://git.in.moodle.com/integration/nightlyjobs/-/blob/master/src/org/moodle/ci/maintenance/SetBuildDescriptionToIndications.groovy

We launch it via library, although I imagine that it can be embed without problem in a pipeline script. This s how we launch it:

@Library('ci') _

import org.moodle.ci.maintenance.SetBuildDescriptionToIndications

node("jenkins-maintenance") {
    stage("Run") {
        task = new SetBuildDescriptionToIndications(
            view: "${params.VIEW}",
        )
        if (task.run(this) != 0) {
            currentBuild.result = 'FAILURE'
        }
    }
}

You can see it in action @ https://ci.moodle.org/job/W.03.05%20-%20Behat%20-%20Chrome%20+%20Oracle/ (for example, because with Oracle, heh, is where we get more random/failures detected by BFA).

Hope it helps, ciao :-)