Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use UpdateSite implementation for connect and preValidate #10172

Merged
merged 1 commit into from
Feb 25, 2025

Conversation

slide
Copy link
Member

@slide slide commented Jan 17, 2025

Different UpdateSites may need to connect to URLs differently, (e.g., authentication, etc.), this adds a method to UpdateSite which creates the URLConnection that will be used for connecting. This allows such things as a password protected UpdateSite which can add the authorization information to the connection prior to returning it. In addition the preValidate method can be overridden in UpdateSite implementations to validate the URL before trying to download it.

Testing done

No direct tests were added, but the full set of tests were run locally on the change.

Proposed changelog entries

  • Developer: Allow UpdateSites to handle the connection for a URL for a download from that update site.

Proposed upgrade guidelines

N/A

Submitter checklist

  • The Jira issue, if it exists, is well-described.
  • The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples). Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
  • There is automated testing or an explanation as to why this change has no tests.
  • New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
  • New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
  • New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
  • For dependency updates, there are links to external changelogs and, if possible, full differentials.
  • For new APIs and extension points, there is a link to at least one consumer.

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

Maintainer checklist

  • There are at least two (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 is not blocking the change.
  • Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
  • Proper changelog labels are set so that the changelog can be generated automatically.
  • If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see 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).

Different UpdateSites may need to connect to URLs differently, this adds a method to UpdateSite which creates the URLConnection that will be used for connecting. This allows an implementation of a password protected UpdateSite which can add the authorization information to the connection prior to returning it.
@timja timja requested a review from a team January 22, 2025 16:42
@MarkEWaite MarkEWaite added the rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted label Feb 11, 2025
@timja timja requested a review from a team February 22, 2025 22:01
@timja
Copy link
Member

timja commented Feb 23, 2025

/label ready-for-merge


This PR is now ready for merge, after ~24 hours, we will merge it if there's no negative feedback.

Thanks!

@comment-ops-bot comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Feb 23, 2025
@krisstern krisstern merged commit 9a728a8 into jenkinsci:master Feb 25, 2025
16 checks passed
@@ -1273,6 +1273,9 @@ static URL toUpdateCenterCheckUrl(String updateCenterUrl) throws MalformedURLExc
* @throws IOException if the validation fails
*/
public void preValidate(DownloadJob job, URL src) throws IOException {
if(job.site != null) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is failing master because it lacked #10214.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@daniel-beck daniel-beck mentioned this pull request Feb 25, 2025
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants