Recipe for Jenkinsfile updates

[jonesbusy]

What feature do you want to see added?

Right now the recipes doesn't override the Jenkinsfile in order to not alternate exotic configuration.

We need more logic here when we modernize a plugin. For example

• Add a java version with platform
• remove totally a java version
• add first level args, like useContainerAgent

Etc.

See already groovy visitor that extract such information

Upstream changes

None

Are you interested in contributing this feature?

None

[jonesbusy]

jenkins-infra/pipeline-library#897

As information related to implicit settings

[basil]

add first level args, like useContainerAgent

But only if the plugin is not running Docker-based tests. A few previous modernization PRs incorrectly added useContainerAgent and accidentally disabled Docker-based tests.

[jonesbusy]

@basil Thanks, do you have any example of such recent PR ?

The current state is to not overwrite anything if a Jenkinsfile is present until we have logic :

plugin-modernizer-tool/plugin-modernizer-core/src/main/resources/META-INF/rewrite/recipes.yml

Line 26 in a5c2da3

overwriteExisting: false

I think we should be able to detect such types (pom, import) to know detect if we are using docker tests or not

The idea behind openrewrite is not not do any destructive changes (For example a Jenkinsfile adding configuration like https://github.com/jenkinsci/warnings-ng-plugin/blob/main/Jenkinsfile#L9-L11 should not lost it's information

[basil]

@basil Thanks, do you have any example of such recent PR ?

An example is jenkinsci/saml-plugin#157, which (incorrectly) set useContainerAgent: true, thereby disabling Docker-based testing. I set useContainerAgent: false in jenkinsci/saml-plugin#446 and confirmed that LiveTest was again running in CI builds. Fortunately, the test had not regressed during that time!

To be clear, it is always* OK to add an explicit useContainerAgent: false (*except if enforcing Spotless on Windows, pending jenkins-infra/helpdesk#3865), but it is only OK to add an explicit useContainerAgent: true if there are no Docker-based tests.

[jonesbusy]

Thanks. I almost forget about the spotless issue (that I was facing 1-2 times).

I did a small PR to detect such test : https://github.com/jenkins-infra/plugin-modernizer-tool/pull/604/files#diff-bb3dc0c26bd6ab3a8127376a14a65c96c2d5711b783a53a587baa4ae0fc6e690R22-R25

This would help setting the useContainerAgent attribute if missing (typically the buildPlugin() that use VM even if not running container test)

if (_import.getPackageName().startsWith("org.testcontainers.containers")) {

By experience to you know other framework/library that execute docker test (that are not testcontainer)

[basil]

By experience to you know other framework/library that execute docker test (that are not testcontainer)

The only other one I have seen is https://github.com/jenkinsci/docker-fixtures which is our homegrown (but less well maintained these days) predecessor to Testcontainers.

[jglick]

And https://github.com/jenkinsci/kubernetes-plugin/blob/c91e951eaebd823be6ad34478eba9fd50e6a631d/Jenkinsfile#L23-L29 is clearly a snowflake.