Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Based on comments from Jesse, revising the fix. I'm now putting permlinks inside the builds/ directory to avoid the computing hassle involved in the split $JENKINS_HOME. What we historically had in $JENKINS_HOME/jobs/JOB/lastSuccessfulBuild is also now subsumed by this feature. I initially attempted to create these permalinks in the buidl root directory, but turns out those symlinks aren't the same name as the ID of permalinks, so it doesn't mesh well. And finally, a test!
- Loading branch information
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,19 @@ | ||
| package jenkins.model; | ||
|
|
||
| import com.google.common.base.Predicate; | ||
| import hudson.Extension; | ||
| import hudson.Util; | ||
| import hudson.model.Job; | ||
| import hudson.model.PermalinkProjectAction.Permalink; | ||
| import hudson.model.Run; | ||
| import hudson.model.TaskListener; | ||
| import hudson.model.listeners.RunListener; | ||
| import hudson.util.AtomicFileWriter; | ||
| import hudson.util.StreamTaskListener; | ||
| import org.apache.commons.io.FileUtils; | ||
|
|
||
| import javax.annotation.Nonnull; | ||
| import javax.annotation.Nullable; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.io.StringWriter; | ||
|
|
@@ -48,14 +52,14 @@ | |
| * (it simply scans the history till find the new matching build.) To tolerate G(B) | ||
| * that goes from false to true, you need to be able to intercept whenever G(B) changes | ||
| * from false to true, then call {@link #resolve(Job)} to check the current permalink target | ||
| * is up to date, then call {@link #updateCache(Job, Run)} if it needs updating. | ||
| * | ||
| * @author Kohsuke Kawaguchi | ||
| * @since 1.507 | ||
| */ | ||
| public abstract class PeepholePermalink extends Permalink implements Predicate<Run<?,?>> { | ||
| /** | ||
| * Checks if the given build satisfies the peep-hole criteria. | ||
| * | ||
| * This is the "G(B)" as described in the class javadoc. | ||
| */ | ||
|
|
@@ -65,7 +69,7 @@ public abstract class PeepholePermalink extends Permalink implements Predicate<R | |
| * The file in which the permalink target gets recorded. | ||
| */ | ||
| protected File getPermalinkFile(Job<?,?> job) { | ||
| return new File(job.getBuildDir(),getId()); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -77,18 +81,10 @@ protected File getPermalinkFile(Job<?,?> job) { | |
| Run<?,?> b=null; | ||
|
|
||
| try { | ||
| String target = Util.resolveSymlink(f); | ||
| if (target==null && f.exists()) { | ||
| // if this file isn't a symlink, it must be a regular file | ||
| target = FileUtils.readFileToString(f,"UTF-8").trim(); | ||
| } | ||
|
|
||
| if (target!=null) { | ||
|
|
@@ -107,78 +103,104 @@ protected File getPermalinkFile(Job<?,?> job) { | |
| LOGGER.log(Level.WARNING, "Failed to read permalink cache:" + f, e); | ||
| // if we fail to read the cache, fall back to the re-computation | ||
| } catch (IOException e) { | ||
| // this happens when the symlink doesn't exist | ||
| // (and it cannot be distinguished from the case when the actual I/O error happened | ||
| } | ||
|
|
||
| if (b==null) { | ||
| // no cache | ||
| b = job.getLastBuild(); | ||
| } | ||
|
|
||
| // start from the build 'b' and locate the build that matches the criteria going back in time | ||
| b = find(b); | ||
|
|
||
| updateCache(job,b); | ||
| return b; | ||
| } | ||
|
|
||
| /** | ||
| * Start from the build 'b' and locate the build that matches the criteria going back in time | ||
| */ | ||
| private Run<?,?> find(Run<?,?> b) { | ||
| for ( ; b!=null && !apply(b); b=b.getPreviousBuild()) | ||
| ; | ||
| return b; | ||
| } | ||
|
|
||
| /** | ||
| * Remembers the value 'n' in the cache for future {@link #resolve(Job)}. | ||
| */ | ||
| protected void updateCache(@Nonnull Job<?,?> job, @Nullable Run<?,?> b) { | ||
| final int n = b==null ? RESOLVES_TO_NONE : b.getNumber(); | ||
|
|
||
| File cache = getPermalinkFile(job); | ||
| File tmp = new File(cache.getPath()+".tmp"); | ||
| cache.getParentFile().mkdirs(); | ||
|
|
||
| try { | ||
| StringWriter w = new StringWriter(); | ||
| StreamTaskListener listener = new StreamTaskListener(w); | ||
|
|
||
| Util.createSymlink(tmp.getParentFile(),String.valueOf(n),tmp.getName(),listener); | ||
| if (Util.resolveSymlink(tmp)==null) { | ||
| // symlink not supported. use a regular file | ||
| AtomicFileWriter cw = new AtomicFileWriter(cache); | ||
| try { | ||
| cw.write(String.valueOf(n)); | ||
| cw.commit(); | ||
| } finally { | ||
| cw.abort(); | ||
| } | ||
| } else { | ||
| cache.delete(); | ||
| tmp.renameTo(cache); | ||
| } | ||
| } catch (IOException e) { | ||
| LOGGER.log(Level.WARNING, "Failed to update "+job+" "+getId()+" permalink for " + b, e); | ||
| cache.delete(); | ||
| } catch (InterruptedException e) { | ||
| LOGGER.log(Level.WARNING, "Failed to update "+job+" "+getId()+" permalink for " + b, e); | ||
| cache.delete(); | ||
| } finally { | ||
| tmp.delete(); | ||
| } | ||
| } | ||
|
|
||
| @Extension | ||
| public static class RunListenerImpl extends RunListener<Run<?,?>> { | ||
This comment has been minimized.
Sorry, something went wrong. 
jglick
Member
|
||
| /** | ||
| * If any of the peephole permalink points to the build to be deleted, update it to point to the new location. | ||
| */ | ||
| @Override | ||
| public void onDeleted(Run run) { | ||
| Job<?, ?> j = run.getParent(); | ||
| for (PeepholePermalink pp : Util.filter(j.getPermalinks(), PeepholePermalink.class)) { | ||
| if (pp.apply(run)) { | ||
| if (pp.resolve(j)==run) { | ||
| pp.updateCache(j,pp.find(run.getPreviousBuild())); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * See if the new build matches any of the peephole permalink. | ||
| */ | ||
| @Override | ||
| public void onCompleted(Run<?,?> run, @Nonnull TaskListener listener) { | ||
| Job<?, ?> j = run.getParent(); | ||
| for (PeepholePermalink pp : Util.filter(j.getPermalinks(), PeepholePermalink.class)) { | ||
| if (pp.apply(run)) { | ||
| Run<?, ?> cur = pp.resolve(j); | ||
| if (cur==null || cur.getNumber()<run.getNumber()) | ||
| pp.updateCache(j,run); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private static final int RESOLVES_TO_NONE = -1; | ||
|
|
||
| private static final Logger LOGGER = Logger.getLogger(PeepholePermalink.class.getName()); | ||
| } | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| package jenkins.model | ||
|
|
||
| import hudson.Functions | ||
| import hudson.Util | ||
| import hudson.model.Run | ||
| import org.jvnet.hudson.test.FailureBuilder | ||
| import org.jvnet.hudson.test.HudsonTestCase | ||
|
|
||
| /** | ||
| * | ||
| * | ||
| * @author Kohsuke Kawaguchi | ||
| */ | ||
| class PeepholePermalinkTest extends HudsonTestCase { | ||
| /** | ||
| * Basic operation of the permalink generation. | ||
| */ | ||
| void testBasics() { | ||
| if (Functions.isWindows()) return; // can't run on windows because we rely on symlinks | ||
This comment has been minimized.
Sorry, something went wrong.
jglick
Member
|
||
|
|
||
| def p = createFreeStyleProject() | ||
| def b1 = assertBuildStatusSuccess(p.scheduleBuild2(0)) | ||
|
|
||
| def lsb = new File(p.buildDir, "lastSuccessfulBuild") | ||
| def lfb = new File(p.buildDir, "lastFailedBuild") | ||
|
|
||
| assertLink(lsb,b1) | ||
|
|
||
| // now another build that fails | ||
| p.buildersList.add(new FailureBuilder()) | ||
| def b2 = p.scheduleBuild2(0).get() | ||
|
|
||
| assertLink(lsb,b1) | ||
| assertLink(lfb,b2) | ||
|
|
||
| // one more build and this time it succeeds | ||
| p.buildersList.clear() | ||
| def b3 = assertBuildStatusSuccess(p.scheduleBuild2(0)) | ||
|
|
||
| assertLink(lsb,b3) | ||
| assertLink(lfb,b2) | ||
|
|
||
| // delete b3 and symlinks should update properly | ||
| b3.delete() | ||
| assertLink(lsb,b1) | ||
| assertLink(lfb,b2) | ||
|
|
||
| b1.delete() | ||
| assertLink(lsb,null) | ||
| assertLink(lfb,b2) | ||
|
|
||
| b2.delete() | ||
| assertLink(lsb,null) | ||
| assertLink(lfb,null) | ||
| } | ||
|
|
||
| def assertLink(File symlink, Run build) { | ||
| assert Util.resolveSymlink(symlink)==(build==null ? "-1" : build.number as String); | ||
| } | ||
|
|
||
| /** | ||
| * job/JOBNAME/lastStable and job/JOBNAME/lastSuccessful symlinks that we used to generate should still work | ||
| */ | ||
| void testLegacyCompatibility() { | ||
| if (Functions.isWindows()) return; // can't run on windows because we rely on symlinks | ||
|
|
||
| def p = createFreeStyleProject() | ||
| def b1 = assertBuildStatusSuccess(p.scheduleBuild2(0)) | ||
|
|
||
| ["lastStable","lastSuccessful"].each { n -> | ||
| // test if they both point to b1 | ||
| assert new File(p.rootDir,"$n/build.xml").length() == new File(b1.rootDir,"build.xml").length() | ||
This comment has been minimized.
Sorry, something went wrong. |
||
| } | ||
| } | ||
| } | ||
AbstractProjectTest.testExternalBuildDirectorySymlinksfailure