Jenkinsfile Modification: Unexpected End-of-Comment Behavior

[gounthar]

When running the AddOrModernizeJenkinsFile recipe, the generated comment does not create a new line. As a result, the subsequent buildPlugin statement is appended to the comment, rather than starting on a new line.

You can see this issue in this pull request.

Reproduction Steps

1. Run the AddOrModernizeJenkinsFile recipe on a plugin with an outdated Jenkinsfile.

Expected Behavior

The recipe should add a new line and carriage return after the comment.

Actual Behavior

The comment does not create a new line, and the buildPlugin statement is appended to it.

[jonesbusy]

Is it and issue with plugin modernizer or rewrite-jenkins ? From wat I remember we don't modify and Jenkinsfile here but just use a recipe from rewrite-jenkins

[jonesbusy]

Or even with rewite-groovy that fail to parse a correct LST ?

[gounthar]

Yes, that's also what I think, but I prefer to have it logged here before forgetting about it.

[gounthar]

What is strange is that the newline is in the OpenRewrite recipe.

[jonesbusy]

This is an issue with the groovy parser.

Rewrite-jenkins do a wrong assertion

https://github.com/openrewrite/rewrite-jenkins/blob/a53f97d154aaf26b85cfb771bf80bc4fae767701/src/test/java/org/openrewrite/jenkins/ModernizeJenkinsfileTest.java#L109

We will need to fix it before doing other Jenkinsfile modification. For the moment we just need to add the file if missing

[jonesbusy]

Possible fix by openrewrite/rewrite-jenkins#85

I'v tested the use case on rewrite groovy. Was not able to reproduce the issue

At the end was only because the YAML block was trimming empty line when creating the text file

[jonesbusy]

That's why https://github.com/jenkins-infra/plugin-modernizer-tool/pull/524/files didn't show the issue

I would suggest we use exclusively this even if overwriteExisting: false I would prefer we are not harmless for the moment and don't override the file until we are able to parse it and perform modification to it

This is tracked by #531

Closing the issue then