Add option to dynamically update the baseline of the RJRInit plugin #780
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
if the version of Jenkins used by RealJenkinsRuleInit has detached plugins in the version of Jenknis used for the test then this can uncessescarily pull in detached plugins. In most cases this is harmless, but in some cases these plugins may be prevented from running under the test (e.g. testing FIPS and one of the detached plugins like eddsa is not FIPS complaint and blocks startup). The plugin itself has limited exposure to the Jenkins api (via hudson.plugin.Plugin and RealJenkinsRule$Init2). Code running from the plugin tests inside RealJenkinsRule use the uberClassloader and if the plugin was targetting a lower core (where the dependencies have been deteached, they should still be included as this change only affects the version of the RealJenkinsRuleInit plugin.
jtnord
commented
Jun 5, 2024
| @@ -199,6 +200,7 @@ public final class RealJenkinsRule implements TestRule { | |||
|
|
|||
| private boolean prepareHomeLazily; | |||
| private boolean provisioned; | |||
| private boolean updateRealJenkinsRuleInitPluginBaseline; | |||
There was a problem hiding this comment.
defaulting to false as
- it changes the current behaviour and
- if it does turn out to impact plugins I do not want to be on the hook for fixing them all
There was a problem hiding this comment.
is it worth just running this through bom with it enabled by default? this doesn't sound like something you want to have to try dig out when it should "just work".
There was a problem hiding this comment.
#781 I expect anything using a JNLP based agent and an updated baseline to fail...
| * The intended use case of this is to prevent any detached plugins being dragged in when they would not normally be. | ||
| * @param updateRealJenkinsRuleInitPluginBaseline {@code true} to update the plugin, false to use the plugin as is. | ||
| */ | ||
| public RealJenkinsRule updateRealJenkinsRuleInitPluginBaseline(boolean updateRealJenkinsRuleInitPluginBaseline) { |
jtnord
added a commit
to jtnord/jenkins
that referenced
this pull request
Jun 5, 2024
using an incremental from jenkinsci/jenkins-test-harness#780
This was referenced Jun 5, 2024
jglick
reviewed
Jun 5, 2024
| FileUtils.copyURLToFile(RealJenkinsRule.class.getResource("RealJenkinsRuleInit.jpi"), new File(plugins, "RealJenkinsRuleInit.jpi")); | ||
| if (updateRealJenkinsRuleInitPluginBaseline) { | ||
| try (JarFile jf = new JarFile(war); | ||
| InputStream resourceAsStream = RealJenkinsRule.class.getResourceAsStream("RealJenkinsRuleInit.jpi"); |
There was a problem hiding this comment.
Actually with #781 (comment) we could clean up some longstanding tech debt and get rid of the .jpi file in Git: just compile the one class from sources in this harness (include in src/main/java/) and pack the plugin on the fly.
6 tasks
|
closing in favor of #782 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
if the version of Jenkins used by
RealJenkinsRuleInithas detached plugins in the version of Jenkins used for the test then this can unnecessarily pull in detached plugins.In most cases this is harmless, but in some cases these plugins may be prevented from running under the test (e.g. testing FIPS and one of the detached plugins like
eddsais not FIPS complaint and blocks start-up).The plugin itself has limited exposure to the Jenkins api (via
hudson.plugin.PluginandRealJenkinsRule$Init2).Code running from the plugin tests inside
RealJenkinsRuleuses theuberClassloaderand if the plugin was targeting a lower core (where the dependencies have been detached, they should still be included as this change only affects the version of theRealJenkinsRuleInitplugin.this is a "future proof" (but potentially more risky) version of #779 (nb. the changes are not mutually exclusive)
consumed in jenkinsci/jenkins#9353
Testing done
Submitter checklist