Upgrade to badge-plugin 2.x #81

strangelookingnerd · 2024-09-18T11:45:19Z

Restores compatibility with latest badge-plugin version. See discussion in jenkinsci/badge-plugin#189

This also updates the baseline to 2.440.x

Testing done

Ran existing tests without issue. I did only try a limited set of manual UI tests, a second pair of eyes would be appreciated.

Submitter checklist

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests - that demonstrates feature works or fixes the issue

* new baseline 2.440.x

Match with Jenkins plugin archetype https://www.jenkins.io/doc/developer/publishing/new-plugin/

The dependee plugin binary causes lots of noise when the JenkinsRule test is starting. The noise includes many reports of plugins that cannot be loaded because they require newer dependencies, even though the newest dependencies are already included as test scoped dependencies in the pom file. I assume that is due to the ancient Jenkins version that is referenced in the dependee plugin binary. The dependee plugin was built in 2013 and is not part of the Jenkins update center. Use the script security plugin instead because it is already a dependency and does not require separate script approval. Detected the test noise while evaluating pull request: * jenkinsci#81 The test was passing but was generating many failure messages because badge plugin 1.13 could not be loaded. Those messages no longer happen with this test change. Adds more assertions on the BadgeAction object for good measure.

The dependee plugin binary causes lots of noise when the JenkinsRule test is starting. The noise includes many reports of plugins that cannot be loaded because they require newer dependencies, even though the newest dependencies are already included as test scoped dependencies in the pom file. I assume that is due to the ancient Jenkins version that is referenced in the dependee plugin binary. The dependee plugin was built in 2013 and is not part of the Jenkins update center. Use the script security plugin instead because it is already a dependency and does not require separate script approval. Detected the test noise while evaluating pull request: * #81 The test was passing but was generating many failure messages because badge plugin 1.13 could not be loaded. Those messages no longer happen with this test change. Adds more assertions on the BadgeAction object for good measure.

MarkEWaite · 2024-09-22T12:09:49Z

Thanks for the pull request. I've successfully compared the results of the badge methods:

addBadge
addBadge-3 (single test case)
addErrorBadge
addInfoBadge
addShortText
addShortText-5 (single test case)
addShortText-notBuilt
addWarningBadge

I've successfully compared the results of the build method steps:

buildUnstable
buildAborted
buildFailure
buildSuccess

The createSummary method showed some significant differences between the badge 1.13 version and the badge 2.1 version

Badge 1.13

Pipeline:

pipeline {
    agent any
    stages {
        stage('createSummary and hyperlink') {
            steps {
                script {
                    icon = 'warning.gif'
                    text = 'My text'
                    escapeHtml = false
                    text = text + ' <a href="https://github.com">github.com</a>'
                    def summary = manager.createSummary(icon)
                    summary.appendText(text)
                    // summary.appendText(text, escapeHtml)
                        // summary.appendText(text, escapeHtml, bold, italic, color)
                }
            }
        }
    }
}

Build page containing the summary:

Badge 2.1

Same Pipeline script:

pipeline {
    agent any
    stages {
        stage('createSummary and hyperlink') {
            steps {
                script {
                    icon = 'warning.gif'
                    text = 'My text'
                    escapeHtml = false
                    text = text + ' <a href="https://github.com">github.com</a>'
                    def summary = manager.createSummary(icon)
                    summary.appendText(text)
                    // summary.appendText(text, escapeHtml)
                        // summary.appendText(text, escapeHtml, bold, italic, color)
                }
            }
        }
    }
}

Build page containing the summary:

The hyperlink is not rendered as a hyperlink in the new code and the image is rendered as a gif instead of being converted to an SVG.

If I switch the markup formatter in the new code from "Plain text" to "Safe HTML", then the hyperlink is shown the same in 2.1 as it was in 1.13.

MarkEWaite · 2024-09-22T12:20:39Z

The use of the Jenkins markup formatter in the new code allows me to install the Markdown formatter plugin and use Markdown in my summaries instead of using HTML. I'm not sure what fraction of users are already using the safe HTML markup formatter on the Jenkins controller where they use createSummary.

Is it feasible to have a compatibility mode that renders HTML in summaries as HTML rather than breaking user summaries on controllers that are using the plain text markup formatter?

MarkEWaite · 2024-09-22T13:34:22Z

Another minor difference that I've detected is visible when hovering over the badge in the build history. The hover text from badge 1.13 fits the text while the hover text for badge 2.1 has an additional empty line inside it.

Badge 1.13

Badge 2.1

The difference seems to be purely cosmetic, but since I detected it, I thought that I should note it here.

strangelookingnerd · 2024-09-22T17:27:51Z

Is it feasible to have a compatibility mode that renders HTML in summaries as HTML rather than breaking user summaries on controllers that are using the plain text markup formatter?

To me the behavior of the 1.x version is highly questionable in terms of security as it would allow to completely bypass HTML sanitation. Which was the main reason why I wanted to remove it.

I could imagine something like „if plaintext formatter is configured but safe html formatter is available use it if a configuration is set“ - but that would involve manual tasks (setting a environment flag, configuration, and the likes) which by the end would be similar to changing Jenkins global markup formatter.

So I guess what I’m trying to say that it would definitely not be impossible but it goes against so many principles of software security that I can not bring myself to like the idea 😅 Maybe there is another approach?

strangelookingnerd · 2024-09-22T17:28:52Z

Another minor difference that I've detected is visible when hovering over the badge in the build history. The hover text from badge 1.13 fits the text while the hover text for badge 2.1 has an additional empty line inside it.

That’s odd, I will look into it.

Compatible with badge plugin 2.1 as part of * jenkinsci/groovy-postbuild-plugin#81 Needs more testing.

strangelookingnerd · 2024-09-23T08:17:11Z

Another minor difference that I've detected is visible when hovering over the badge in the build history. The hover text from badge 1.13 fits the text while the hover text for badge 2.1 has an additional empty line inside it.

That’s odd, I will look into it.

I can not reproduce this on my end using Jenkins 2.440.3 and 2.462.2 with neither Firefox, Chrome or Edge.

MarkEWaite · 2024-09-23T15:53:58Z

I can not reproduce this on my end using Jenkins 2.440.3 and 2.462.2 with neither Firefox, Chrome or Edge.

Thanks for trying. I cannot duplicate it either. I recreated my installation from the git repository where I'm tracking its details and the problem is no longer visible to me. The screenshots are real, but I don't have the steps that will duplicate the issue. Let's ignore that cosmetic issue until I find a way to duplicate it.

MarkEWaite · 2024-09-23T16:10:27Z

To me the behavior of the 1.x version is highly questionable in terms of security as it would allow to completely bypass HTML sanitation. Which was the main reason why I wanted to remove it.

I'm not aware of any security issue with the 1.x version, but I understand the desire to use an existing, standard component to process the HTML markup instead of using something that is specific to the Badge plugin.

So I guess what I’m trying to say that it would definitely not be impossible but it goes against so many principles of software security that I can not bring myself to like the idea 😅 Maybe there is another approach?

Would it be enough if we added documentation to the README that describes the alternatives that are now available thanks to this change?

I think there are multiple scenarios that we need to describe:

Existing installation of badge 1.13 and matching Groovy post-build plugin release with default markup formatter
Existing installation of badge 1.13 and matching Groovy post-build plugin release with safe HTML markup formatter
Existing installation of badge 1.13 and matching Groovy post-build plugin release with Markdown markup formatter
Upgraded from badge 1.13 to badge 2.1 with default markup formatter
Upgraded from badge 1.13 to badge 2.1 with safe HTML markup formatter
Upgraded from badge 1.13 to badge 2.1 with Markdown markup formatter
New installation of badge 2.1 and this pull request of Groovy post-build plugin release with default markup formatter
New installation of badge 2.1 and this pull request of Groovy post-build plugin release with safe HTML markup formatter
New installation of badge 2.1 and this pull request of Groovy post-build plugin release with Markdown markup formatter

strangelookingnerd · 2024-09-23T17:28:50Z

Would it be enough if we added documentation to the README that describes the alternatives that are now available thanks to this change?

Sounds reasonable to me, I will write something up for the Release Notes / Readme.

xmapst · 2024-09-24T00:24:23Z

该插件什么时候可以正常工作

MarkEWaite · 2024-09-24T00:43:23Z

该插件什么时候可以正常工作

When will the plugin work properly?

The plugin will work properly if you install badge plugin 1.13 instead of badge plugin 2.1. Use the Jenkins plugin manager "Advanced Settings" to upload badge plugin 1.13 from the URL:

https://updates.jenkins.io/download/plugins/badge/1.13/badge.hpi

If you must have badge plugin 2.1, then you'll need to use the pre-release build that is available from the "Incrementals Publisher" section of the GitHub checks. That is also a great way for you to help test the pre-release of the plugin. If you'd rather wait for others to test the pre-release of the plugin, then you'll need to downgrade the badge plugin to 1.13.

splitt3r · 2024-09-24T06:38:08Z

该插件什么时候可以正常工作
When will the plugin work properly?

The plugin will work properly if you install badge plugin 1.13 instead of badge plugin 2.1. Use the Jenkins plugin manager "Advanced Settings" to upload badge plugin 1.13 from the URL:
* https://updates.jenkins.io/download/plugins/badge/1.13/badge.hpi
If you must have badge plugin 2.1, then you'll need to use the pre-release build that is available from the "Incrementals Publisher" section of the GitHub checks. That is also a great way for you to help test the pre-release of the plugin. If you'd rather wait for others to test the pre-release of the plugin, then you'll need to downgrade the badge plugin to 1.13.

Thank you for the great work 👍🏻 i installed the pre release version and it works great so far

strangelookingnerd · 2024-09-25T08:30:31Z

Sounds reasonable to me, I will write something up for the Release Notes / Readme.

I updated the release notes( linked in the README), adding a section for troubleshooting: https://github.com/jenkinsci/badge-plugin/releases/tag/badge-2.0

Once this PR is merged and released I'd also add the version compatibility information.

jimklimov · 2024-09-26T13:49:05Z

Just wanted to p0st about a broken addShortText() following an upgrade, but you've beat me to it witha fix brewing. Kudos! :)

Also:   org.jenkinsci.plugins.workflow.actions.ErrorAction$ErrorId: 52bf183a-d532-4446-9fb0-0c20b46680d8
13:43:36  java.lang.NoSuchMethodError: 'com.jenkinsci.plugins.badge.action.BadgeAction com.jenkinsci.plugins.badge.action.BadgeAction.createShortText(java.lang.String)'
13:43:36  	at PluginClassLoader for groovy-postbuild//org.jvnet.hudson.plugins.groovypostbuild.GroovyPostbuildRecorder$BadgeManager.addShortText(GroovyPostbuildRecorder.java:150)
...

MarkEWaite · 2024-09-26T13:56:59Z

Just wanted to p0st about a broken addShortText() following an upgrade, but you've beat me to it with a fix brewing.

Can you confirm that the pull request build addresses the issue and does not cause unexpected harm?

pom.xml

Co-authored-by: Basil Crow <me@basilcrow.com>

MarkEWaite · 2024-10-08T01:54:21Z

While comparing previous behavior and new behavior, I found a case where a Pipeline job previously included an icon and with the new code the icon is unavailable / broken.

Pipeline

pipeline {
    agent any
    stages {
        stage('createSummary and hyperlink') {
            steps {
                script {
                    icon = 'warning.gif'
                    text = 'My text'
                    escapeHtml = false
                    bold = true
                    italic = true
                    color = 'blue'
                    text = text + ' [GitHub](github.com) <a href="https://github.com">github.com</a>'
                    def summary = manager.createSummary(icon)
                    summary.appendText("1 - " + text + " - 1")
                    summary.appendText(" 2(escapeHtml=" + escapeHtml + ") - " + text + " - 2", escapeHtml)
                    summary.appendText(" 3 - " + text + " - 3", escapeHtml, bold, italic, color)
                    manager.createSummary("gear2.gif").appendText("<h2>Successfully deployed</h2>", false)
                }
            }
        }
    }
}

Badge 1.13 and postbuild 228.vcdb_cf7265066

Badge 2.2 and postbuild from this pull request

MarkEWaite · 2024-10-08T02:20:23Z

@strangelookingnerd I'm at the point where I've found inconsistencies but not major incompatibilities. I think it is time to release the groovy postbuild plugin with the updated documentation that is included in this pull request and accept that users will likely report additional issues that need further changes.

Do you agree?

MarkEWaite · 2024-10-08T02:39:13Z

I may have found a workaround for some of the cases of gif image quality. Several of the images from the original list of gif images have a matching SVG image in the /images/svgs/ directory.

delete - edit-delete.svg
error - error.svg
folder - folder.svg
save - save.svg
warning - warning.svg

The following gif images do not have an obvious replacement from the svgs directory:

completed
db_in
db_out
info
success

I think that the groovy-postbuild plugin could detect references to those known gif images and replace them with SVG references. Does that seem reasonable?

strangelookingnerd · 2024-10-10T12:46:58Z

@strangelookingnerd I'm at the point where I've found inconsistencies but not major incompatibilities. I think it is time to release the groovy postbuild plugin with the updated documentation that is included in this pull request and accept that users will likely report additional issues that need further changes.

Do you agree?

Sorry for the late response. Yes I think it would be best to ship the changes now and wait for feedback in case there is more to fix.

strangelookingnerd · 2024-10-10T12:48:46Z

I may have found a workaround for some of the cases of gif image quality. Several of the images from the original list of gif images have a matching SVG image in the /images/svgs/ directory.
* delete - edit-delete.svg

* error - error.svg

* folder - folder.svg

* save - save.svg

* warning - warning.svg
The following gif images do not have an obvious replacement from the svgs directory:
* completed

* db_in

* db_out

* info

* success
I think that the groovy-postbuild plugin could detect references to those known gif images and replace them with SVG references. Does that seem reasonable?

I was already thinking of doing that for the badge-plugin itself. Usage of SVG / symbols should be preferred in any case.
I could provide a PR once I find a solution that works.

Include details of the markup formatters that have been tested and a warning to existing users that they may need to enable the safe HTML formatter.

MarkEWaite · 2024-10-12T21:48:35Z

I've added documentation for markup formatters and have enabled auto-merge. It should merge and release once the CI job passes.

Upgrade to badge-plugin 2.x

d348a5b

* new baseline 2.440.x

strangelookingnerd requested a review from a team as a code owner September 18, 2024 11:45

MarkEWaite mentioned this pull request Sep 21, 2024

Bump org.jenkins-ci.plugins:badge from 1.13 to 2.1 #82

Closed

Set Jenkins version with jenkins.baseline

33aedc8

Match with Jenkins plugin archetype https://www.jenkins.io/doc/developer/publishing/new-plugin/

MarkEWaite mentioned this pull request Sep 21, 2024

Replace dependee plugin binary with script security call #83

Merged

6 tasks

MarkEWaite added 2 commits September 21, 2024 11:33

Merge branch 'master' into upgrade_badge-plugin

212e5f9

Remove API calls to deleted methods

90fb618

MarkEWaite added the bug Incorrect or flawed behavior label Sep 21, 2024

MarkEWaite added a commit to MarkEWaite/docker-lfs that referenced this pull request Sep 22, 2024

Use groovy postbuild plugin 252.v90fb_61823a_a_7 (badge 2.1 compat)

55fac17

Compatible with badge plugin 2.1 as part of * jenkinsci/groovy-postbuild-plugin#81 Needs more testing.

Merge branch 'master' into upgrade_badge-plugin

3ab6da5

basil mentioned this pull request Sep 25, 2024

Add Groovy Postbuild to the managed set jenkinsci/bom#3635

Closed

steelhead31 mentioned this pull request Oct 2, 2024

2024/10/01: Jenkins regular patching cycle - update to 2.462.2 adoptium/infrastructure#3749

Closed

Depend on badge plugin 2.2

c8805fd

Use plugin BOM 3435.x

17de495

basil reviewed Oct 7, 2024

View reviewed changes

pom.xml Outdated Show resolved Hide resolved

strangelookingnerd and others added 5 commits October 7, 2024 22:22

Update pom.xml

6b959e7

Co-authored-by: Basil Crow <me@basilcrow.com>

Use https link to javadoc

c575053

Update screenshots and examples

ef5babc

Update example 2

682e3e0

Update example to match picture

e238fc5

MarkEWaite added breaking Breaks compatibility with previous releases and removed bug Incorrect or flawed behavior labels Oct 12, 2024

MarkEWaite added 2 commits October 12, 2024 15:30

Reduce pom differences to archetype

6d18ca8

Add markup formatter description to README

27dace3

Include details of the markup formatters that have been tested and a warning to existing users that they may need to enable the safe HTML formatter.

MarkEWaite approved these changes Oct 12, 2024

View reviewed changes

MarkEWaite enabled auto-merge (rebase) October 12, 2024 21:47

MarkEWaite merged commit f6e02a7 into jenkinsci:master Oct 12, 2024
15 of 16 checks passed

strangelookingnerd deleted the upgrade_badge-plugin branch October 12, 2024 21:52

strangelookingnerd mentioned this pull request Nov 5, 2024

Replace old GIFs with symbols jenkinsci/badge-plugin#208

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade to badge-plugin 2.x #81

Upgrade to badge-plugin 2.x #81

strangelookingnerd commented Sep 18, 2024 •

edited by MarkEWaite

Loading

MarkEWaite commented Sep 22, 2024 •

edited

Loading

MarkEWaite commented Sep 22, 2024

MarkEWaite commented Sep 22, 2024

strangelookingnerd commented Sep 22, 2024

strangelookingnerd commented Sep 22, 2024

strangelookingnerd commented Sep 23, 2024

MarkEWaite commented Sep 23, 2024

MarkEWaite commented Sep 23, 2024 •

edited

Loading

strangelookingnerd commented Sep 23, 2024

xmapst commented Sep 24, 2024

MarkEWaite commented Sep 24, 2024 •

edited

Loading

splitt3r commented Sep 24, 2024

strangelookingnerd commented Sep 25, 2024

jimklimov commented Sep 26, 2024

MarkEWaite commented Sep 26, 2024

MarkEWaite commented Oct 8, 2024 •

edited

Loading

MarkEWaite commented Oct 8, 2024

MarkEWaite commented Oct 8, 2024

strangelookingnerd commented Oct 10, 2024

strangelookingnerd commented Oct 10, 2024

MarkEWaite commented Oct 12, 2024

Upgrade to badge-plugin 2.x #81

Upgrade to badge-plugin 2.x #81

Conversation

strangelookingnerd commented Sep 18, 2024 • edited by MarkEWaite Loading

Testing done

Submitter checklist

MarkEWaite commented Sep 22, 2024 • edited Loading

Badge 1.13

Badge 2.1

MarkEWaite commented Sep 22, 2024

MarkEWaite commented Sep 22, 2024

Badge 1.13

Badge 2.1

strangelookingnerd commented Sep 22, 2024

strangelookingnerd commented Sep 22, 2024

strangelookingnerd commented Sep 23, 2024

MarkEWaite commented Sep 23, 2024

MarkEWaite commented Sep 23, 2024 • edited Loading

strangelookingnerd commented Sep 23, 2024

xmapst commented Sep 24, 2024

MarkEWaite commented Sep 24, 2024 • edited Loading

splitt3r commented Sep 24, 2024

strangelookingnerd commented Sep 25, 2024

jimklimov commented Sep 26, 2024

MarkEWaite commented Sep 26, 2024

MarkEWaite commented Oct 8, 2024 • edited Loading

Pipeline

Badge 1.13 and postbuild 228.vcdb_cf7265066

Badge 2.2 and postbuild from this pull request

MarkEWaite commented Oct 8, 2024

MarkEWaite commented Oct 8, 2024

strangelookingnerd commented Oct 10, 2024

strangelookingnerd commented Oct 10, 2024

MarkEWaite commented Oct 12, 2024

strangelookingnerd commented Sep 18, 2024 •

edited by MarkEWaite

Loading

MarkEWaite commented Sep 22, 2024 •

edited

Loading

MarkEWaite commented Sep 23, 2024 •

edited

Loading

MarkEWaite commented Sep 24, 2024 •

edited

Loading

MarkEWaite commented Oct 8, 2024 •

edited

Loading