Skip to content

[JENKINS-48431] Support both lightweight checkout AND build parameters #78

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.

Sign up for GitHub

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

Closed
wants to merge 4 commits into from
Closed

[JENKINS-48431] Support both lightweight checkout AND build parameters #78

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
acbaed5
JENKINS-48431 Support both lightweight checkout AND build parameters
Oct 14, 2019
b73b3fc
Take into account @jetersen remarks
May 27, 2020
3b8bfb7
Bug fix abstract
May 27, 2020
8003fbd
Merge remote-tracking branch 'upstream/master' into JENKINS-48431
bitwiseman Aug 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 88 additions & 0 deletions src/main/java/jenkins/scm/api/SCMFileSystem.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,75 @@ public boolean changesSince(@CheckForNull SCMRevision revision, @NonNull OutputS
throw new UnsupportedOperationException();
}

/**
* Given a {@link SCM} this method will try to retrieve a corresponding {@link SCMFileSystem} instance.
*
* @param build the build of the {@link SCM}
* @param scm the {@link SCM}.
* @return the corresponding {@link SCMFileSystem} or {@code null} if there is none.
* @throws IOException if the attempt to create a {@link SCMFileSystem} failed due to an IO error
* (such as the remote system being unavailable)
* @throws InterruptedException if the attempt to create a {@link SCMFileSystem} was interrupted.
*/
@CheckForNull
public static SCMFileSystem of(@NonNull Run build, @NonNull SCM scm) throws IOException, InterruptedException {
return of(build, scm, null);
}

/**
* Given a {@link SCM} this method will try to retrieve a corresponding {@link SCMFileSystem} instance that
* reflects the content at the specified {@link SCMRevision}.
*
* @param build the build of the {@link SCM}
* @param scm the {@link SCM}.
* @param rev the specified {@link SCMRevision}.
* @return the corresponding {@link SCMFileSystem} or {@code null} if there is none.
* @throws IOException if the attempt to create a {@link SCMFileSystem} failed due to an IO error
* (such as the remote system being unavailable)
* @throws InterruptedException if the attempt to create a {@link SCMFileSystem} was interrupted.
*/
@CheckForNull
public static SCMFileSystem of(@NonNull Run build, @NonNull SCM scm, @CheckForNull SCMRevision rev)
Copy link
Contributor

@bitwiseman bitwiseman Nov 8, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

Ah, so there's an Item owner version of this and Run build version.
It looks like most of this method is identical to Run build version. Would it make sense to have a common private method that they call into that calls the appropriate b.build() depending on type?

Copy link
Member

@jetersen jetersen May 25, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

I tried to think of a good way to try and deduplicate this code without much success as both supports and builder.build has multiple implementations.

Yes Run does implement Item however I am unsure how to the write method to deduplicate.
as supports has several more implementations and of also includes SCMSource.class, SCMHead.class

throws IOException, InterruptedException {
Objects.requireNonNull(scm);
SCMFileSystem fallBack = null;
Throwable failure = null;
for (Builder b : ExtensionList.lookup(Builder.class)) {
if (b.supports(scm)) {
try {
SCMFileSystem inspector = b.build(build, scm, rev);
if (inspector != null) {
if (inspector.isFixedRevision()) {
return inspector;
}
if (fallBack == null) {
fallBack = inspector;
}
}
} catch (IOException | InterruptedException | RuntimeException e) {
if (failure == null) {
failure = e;
} else {
failure.addSuppressed(e);
}
}
}
}
if (fallBack == null) {
if (failure instanceof IOException) {
throw (IOException) failure;
}
if (failure instanceof InterruptedException) {
throw (InterruptedException) failure;
}
//noinspection ConstantConditions
if (failure instanceof RuntimeException) {
throw (RuntimeException) failure;
}
}
return fallBack;
}

/**
* Given a {@link SCM} this method will try to retrieve a corresponding {@link SCMFileSystem} instance.
*
Expand Down Expand Up @@ -483,6 +552,25 @@ public final boolean supports(SCMSourceDescriptor descriptor) {
*/
protected abstract boolean supportsDescriptor(SCMSourceDescriptor descriptor);

/**
* Given a {@link SCM} this should try to build a corresponding {@link SCMFileSystem} instance that
* reflects the content at the specified {@link SCMRevision}. If the {@link SCM} is supported but not
* for a fixed revision, best effort is acceptable as the most capable {@link SCMFileSystem} will be returned
* to the caller.
*
* @param build the build of the {@link SCM}
* @param scm the {@link SCM}.
* @param rev the specified {@link SCMRevision}.
* @return the corresponding {@link SCMFileSystem} or {@code null} if this builder cannot create a {@link
* SCMFileSystem} for the specified {@link SCM}.
* @throws IOException if the attempt to create a {@link SCMFileSystem} failed due to an IO error
* (such as the remote system being unavailable)
* @throws InterruptedException if the attempt to create a {@link SCMFileSystem} was interrupted.
*/
@CheckForNull
public abstract SCMFileSystem build(@NonNull Run build, @NonNull SCM scm, @CheckForNull SCMRevision rev)
throws IOException, InterruptedException;

/**
* Given a {@link SCM} this should try to build a corresponding {@link SCMFileSystem} instance that
* reflects the content at the specified {@link SCMRevision}. If the {@link SCM} is supported but not
Expand Down
15 changes: 15 additions & 0 deletions src/test/java/jenkins/scm/impl/SCMFileSystemTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import edu.umd.cs.findbugs.annotations.CheckForNull;
import edu.umd.cs.findbugs.annotations.NonNull;
import hudson.model.Item;
import hudson.model.Run;
import hudson.scm.SCM;
import hudson.scm.SCMDescriptor;
import jenkins.scm.api.SCMFileSystem;
Expand Down Expand Up @@ -117,6 +118,13 @@ public SCMFileSystem build(@NonNull Item owner, @NonNull SCM scm, @CheckForNull
return null;
}

@Override
@CheckForNull
public SCMFileSystem build(@NonNull Run build, @NonNull SCM scm, @CheckForNull SCMRevision rev)
throws IOException, InterruptedException {
return null;
}

}

@TestExtension("filesystem_supports_false_implementation_for_descriptor")
Expand Down Expand Up @@ -148,5 +156,12 @@ public SCMFileSystem build(@NonNull Item owner, @NonNull SCM scm, @CheckForNull
return null;
}

@Override
@CheckForNull
public SCMFileSystem build(@NonNull Run build, @NonNull SCM scm, @CheckForNull SCMRevision rev)
throws IOException, InterruptedException {
return null;
}

}
}