[JENKINS-64746] public API hudson.model.UpdateCenter.HudsonUpgradeJob constructor signature change #5216

escoem · 2021-01-29T12:08:09Z

See JENKINS-64746.

The breaking change was introduced by #4848

Proposed changelog entries

Restore, as deprecated, the old constructor based on acegisecurity Authentication parameter in order to keep backward compatibility.

Proposed upgrade guidelines

N/A

Submitter checklist

(If applicable) Jira issue is well described
Changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developer, depending on the change). Examples
- Fill-in the Proposed changelog entries section only if there are breaking changes or other changes which may require extra steps from users during the upgrade
Appropriate autotests or explanation to why this change has no tests
For dependency updates: links to external changelogs and, if possible, full diffs

Desired reviewers

@jglick

Maintainer checklist

Before the changes are marked as ready-for-merge:

There are at least 2 approvals for the pull request and no outstanding requests for change
Conversations in the pull request are over OR it is explicit that a reviewer does not block the change
Changelog entries in the PR title and/or Proposed changelog entries are correct
Proper changelog labels are set so that the changelog can be generated automatically
If the change needs additional upgrade steps from users, upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the PR title. (example)
If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).

oleg-nenashev

Looks good

core/src/main/java/hudson/model/UpdateCenter.java

jglick · 2021-01-29T15:36:31Z

core/src/main/java/hudson/model/UpdateCenter.java

@@ -2111,6 +2111,15 @@ public InstallationJob(Plugin plugin, UpdateSite site, Authentication auth) {
            this(plugin,site,auth,false);
        }

+        /**
+         * @deprecated use {@code InstallationJob(Plugin, UpdateSite, Authentication, boolean)}


Suggested change

* @deprecated use {@code InstallationJob(Plugin, UpdateSite, Authentication, boolean)}

* @deprecated use {@link #InstallationJob(Plugin, UpdateSite, Authentication, boolean)}

jglick · 2021-01-29T15:36:40Z

core/src/main/java/hudson/model/UpdateCenter.java

@@ -2111,6 +2111,15 @@ public InstallationJob(Plugin plugin, UpdateSite site, Authentication auth) {
            this(plugin,site,auth,false);
        }

+        /**
+         * @deprecated use {@code InstallationJob(Plugin, UpdateSite, Authentication, boolean)}
+         * @see #InstallationJob(Plugin, UpdateSite, Authentication, boolean)


Suggested change

* @see #InstallationJob(Plugin, UpdateSite, Authentication, boolean)

jglick · 2021-01-29T15:36:52Z

core/src/main/java/hudson/model/UpdateCenter.java

+         * @deprecated use {@code PluginDowngradeJob(Plugin, UpdateSite, Authentication)}
+         * @see #PluginDowngradeJob(Plugin, UpdateSite, Authentication)


jglick · 2021-01-29T15:37:21Z

core/src/main/java/hudson/model/UpdateCenter.java

+          * @deprecated use {@code HudsonUpgradeJob(UpdateSite site, Authentication auth)}
+          * @see #HudsonUpgradeJob(UpdateSite, Authentication)


jglick · 2021-01-29T15:37:38Z

core/src/main/java/hudson/model/UpdateCenter.java

+         * @deprecated use {@code HudsonDowngradeJob(UpdateSite site, Authentication auth)}
+         * @see #HudsonDowngradeJob(UpdateSite, Authentication)


test/src/test/java/jenkins/install/InstallUtilTest.java

Co-authored-by: Jesse Glick <[email protected]>

oleg-nenashev · 2021-01-30T12:08:01Z

We may merge it in 24 hours if there is no negative feedback. Please see the merge process documentation for more information about the merge process

jglick · 2021-01-30T13:51:00Z

core/src/main/java/hudson/model/UpdateCenter.java

+        public InstallationJob(Plugin plugin, UpdateSite site, org.acegisecurity.Authentication auth, boolean dynamicLoad) {
+            this(plugin, site, auth.toSpring(), dynamicLoad);
+        }
+
        public InstallationJob(Plugin plugin, UpdateSite site, Authentication auth, boolean dynamicLoad) {


Would also be polite to add @since 2.266 for the Spring overloads.

jglick · 2021-01-30T13:51:58Z

core/src/main/java/hudson/model/UpdateCenter.java

@@ -2410,6 +2427,15 @@ public String toString() {
     * Represents the state of the upgrade activity of Jenkins core.
     */
    public final class HudsonUpgradeJob extends DownloadJob {
+
+        /**
+          * @deprecated use {@link HudsonUpgradeJob(UpdateSite site, Authentication auth)}


Suggested change

* @deprecated use {@link HudsonUpgradeJob(UpdateSite site, Authentication auth)}

* @deprecated use {@link HudsonUpgradeJob(UpdateSite, Authentication)}

How is this not a build failure? Hmm…

jglick · 2021-01-30T13:52:14Z

core/src/main/java/hudson/model/UpdateCenter.java

@@ -2444,6 +2470,15 @@ protected void replace(File dst, File src) throws IOException {
    }

    public final class HudsonDowngradeJob extends DownloadJob {
+
+        /**
+         * @deprecated use {@link HudsonDowngradeJob(UpdateSite site, Authentication auth)}


Suggested change

* @deprecated use {@link HudsonDowngradeJob(UpdateSite site, Authentication auth)}

* @deprecated use {@link HudsonDowngradeJob(UpdateSite, Authentication)}

jglick · 2021-01-30T13:52:26Z

test/src/test/java/jenkins/install/InstallUtilTest.java

@@ -30,6 +30,7 @@
 import java.util.Map;
 import java.util.UUID;

+import hudson.security.ACL;


Suggested change

import hudson.security.ACL;

… constructor signature change (jenkinsci#5216) Co-authored-by: Jesse Glick <[email protected]> (cherry picked from commit 2c1e839)

[JENKINS-64746] restore a deprecated constructor with acegisecurity

f08a336

oleg-nenashev added the bug For changelog: Minor bug. Will be listed after features label Jan 29, 2021

oleg-nenashev approved these changes Jan 29, 2021

View reviewed changes

jtnord mentioned this pull request Jan 29, 2021

[JEP-227] Replace Acegi Security with Spring Security & upgrade Spring Framework #4848

Merged

6 tasks

jtnord reviewed Jan 29, 2021

View reviewed changes

core/src/main/java/hudson/model/UpdateCenter.java Show resolved Hide resolved

core/src/main/java/hudson/model/UpdateCenter.java Show resolved Hide resolved

timja requested a review from jglick January 29, 2021 14:01

rsandell approved these changes Jan 29, 2021

View reviewed changes

[JENKINS-64746] restore deprecated constructors with acegisecurity

6db0fd1

jtnord approved these changes Jan 29, 2021

View reviewed changes

jtnord added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Jan 29, 2021

jglick approved these changes Jan 29, 2021

View reviewed changes

[JENKINS-64746] avoid ambiguous reference

5626cbd

jtnord approved these changes Jan 29, 2021

View reviewed changes

[JENKINS-64746] javadoc

e869e3c

jtnord approved these changes Jan 29, 2021

View reviewed changes

jglick reviewed Jan 29, 2021

View reviewed changes

test/src/test/java/jenkins/install/InstallUtilTest.java Outdated Show resolved Hide resolved

escoem and others added 2 commits January 29, 2021 17:09

still using null with cast

a015546

Co-authored-by: Jesse Glick <[email protected]>

[JENKINS-64746] missing import

5293a6f

jglick reviewed Jan 30, 2021

View reviewed changes

timja merged commit 2c1e839 into jenkinsci:master Feb 1, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JENKINS-64746] public API hudson.model.UpdateCenter.HudsonUpgradeJob constructor signature change #5216

[JENKINS-64746] public API hudson.model.UpdateCenter.HudsonUpgradeJob constructor signature change #5216

escoem commented Jan 29, 2021

oleg-nenashev left a comment

jglick Jan 29, 2021

jglick Jan 29, 2021

jglick Jan 29, 2021

jglick Jan 29, 2021

jglick Jan 29, 2021

oleg-nenashev commented Jan 30, 2021

jglick Jan 30, 2021

jglick Jan 30, 2021

jglick Jan 30, 2021

jglick Jan 30, 2021

	* @deprecated use {@code InstallationJob(Plugin, UpdateSite, Authentication, boolean)}
	* @deprecated use {@link #InstallationJob(Plugin, UpdateSite, Authentication, boolean)}

		* @deprecated use {@code PluginDowngradeJob(Plugin, UpdateSite, Authentication)}
		* @see #PluginDowngradeJob(Plugin, UpdateSite, Authentication)

		* @deprecated use {@code HudsonUpgradeJob(UpdateSite site, Authentication auth)}
		* @see #HudsonUpgradeJob(UpdateSite, Authentication)

		* @deprecated use {@code HudsonDowngradeJob(UpdateSite site, Authentication auth)}
		* @see #HudsonDowngradeJob(UpdateSite, Authentication)

	* @deprecated use {@link HudsonUpgradeJob(UpdateSite site, Authentication auth)}
	* @deprecated use {@link HudsonUpgradeJob(UpdateSite, Authentication)}

	* @deprecated use {@link HudsonDowngradeJob(UpdateSite site, Authentication auth)}
	* @deprecated use {@link HudsonDowngradeJob(UpdateSite, Authentication)}

[JENKINS-64746] public API hudson.model.UpdateCenter.HudsonUpgradeJob constructor signature change #5216

[JENKINS-64746] public API hudson.model.UpdateCenter.HudsonUpgradeJob constructor signature change #5216

Conversation

escoem commented Jan 29, 2021

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

oleg-nenashev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oleg-nenashev commented Jan 30, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment