Skip to content

Commit 5f1103c

Browse files
MarkEWaiteMarkEWaite
authored
Merge pull request #802 from MarkEWaite/fix-GitStatus-test-failures
Avoid cleanup failures in GitStatusTest & GitSCMTest
2 parents f25db72 + f92e0a3 commit 5f1103c

File tree

5 files changed

+44
-23
lines changed

5 files changed

+44
-23
lines changed

‎src/test/java/hudson/plugins/git/AbstractGitTestCase.java‎

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,6 @@ protected FreeStyleProject setupSimpleProject(String branchString) throws Except
247247

248248
protected FreeStyleBuild build(final FreeStyleProject project, final Result expectedResult, final String...expectedNewlyCommittedFiles) throws Exception {
249249
final FreeStyleBuild build = project.scheduleBuild2(0).get();
250-
System.out.println(build.getLog());
251250
for(final String expectedNewlyCommittedFile : expectedNewlyCommittedFiles) {
252251
assertTrue(expectedNewlyCommittedFile + " file not found in workspace", build.getWorkspace().child(expectedNewlyCommittedFile).exists());
253252
}
@@ -259,7 +258,6 @@ protected FreeStyleBuild build(final FreeStyleProject project, final Result expe
259258

260259
protected FreeStyleBuild build(final FreeStyleProject project, final String parentDir, final Result expectedResult, final String...expectedNewlyCommittedFiles) throws Exception {
261260
final FreeStyleBuild build = project.scheduleBuild2(0).get();
262-
System.out.println(build.getLog());
263261
for(final String expectedNewlyCommittedFile : expectedNewlyCommittedFiles) {
264262
assertTrue(build.getWorkspace().child(parentDir).child(expectedNewlyCommittedFile).exists());
265263
}
@@ -271,7 +269,6 @@ protected FreeStyleBuild build(final FreeStyleProject project, final String pare
271269

272270
protected MatrixBuild build(final MatrixProject project, final Result expectedResult, final String...expectedNewlyCommittedFiles) throws Exception {
273271
final MatrixBuild build = project.scheduleBuild2(0).get();
274-
System.out.println(build.getLog());
275272
for(final String expectedNewlyCommittedFile : expectedNewlyCommittedFiles) {
276273
assertTrue(expectedNewlyCommittedFile + " file not found in workspace", build.getWorkspace().child(expectedNewlyCommittedFile).exists());
277274
}
@@ -312,15 +309,6 @@ public String invoke(File f, VirtualChannel channel) throws IOException, Interru
312309
});
313310
}
314311

315-
/* A utility method that displays a git repo. Useful to visualise merges. */
316-
public void showRepo(TestGitRepo repo, String msg) throws Exception {
317-
System.out.println("*********** "+msg+" ***********");
318-
try (ByteArrayOutputStream out = new ByteArrayOutputStream()) {
319-
int returnCode = new Launcher.LocalLauncher(listener).launch().cmds("git", "log","--all","--graph","--decorate","--oneline").pwd(repo.gitDir.getCanonicalPath()).stdout(out).join();
320-
System.out.println(out.toString());
321-
}
322-
}
323-
324312
public static class HasCredentialBuilder extends Builder {
325313

326314
private final String id;

‎src/test/java/hudson/plugins/git/CredentialsUserRemoteConfigTest.java‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@ public void checkoutWithDifferentCredentials() throws Exception {
7878
+ " )"
7979
+ "}"));
8080
WorkflowRun b = r.assertBuildStatusSuccess(p.scheduleBuild2(0));
81-
System.out.println(JenkinsRule.getLog(b));
8281
r.assertLogContains("Warning: CredentialId \"github\" could not be found", b);
8382
}
8483

@@ -115,7 +114,6 @@ public void checkoutWithNoCredentialsStoredButUsed() throws Exception {
115114
+ " )"
116115
+ "}"));
117116
WorkflowRun b = r.assertBuildStatusSuccess(p.scheduleBuild2(0));
118-
System.out.println(JenkinsRule.getLog(b));
119117
r.assertLogContains("Warning: CredentialId \"github\" could not be found", b);
120118
}
121119

@@ -133,7 +131,6 @@ public void checkoutWithNoCredentialsSpecified() throws Exception {
133131
+ " )"
134132
+ "}"));
135133
WorkflowRun b = r.assertBuildStatusSuccess(p.scheduleBuild2(0));
136-
System.out.println(JenkinsRule.getLog(b));
137134
r.assertLogContains("No credentials specified", b);
138135
}
139136

‎src/test/java/hudson/plugins/git/GitSCMTest.java‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@
7878
import org.jvnet.hudson.test.JenkinsRule;
7979

8080
import static org.junit.Assert.*;
81+
import org.junit.After;
8182
import org.junit.Before;
8283
import org.junit.BeforeClass;
8384

@@ -122,6 +123,13 @@ public void enableSystemCredentialsProvider() throws Exception {
122123
assertThat("The system credentials provider is enabled", store, notNullValue());
123124
}
124125

126+
@After
127+
public void waitForJenkinsIdle() throws Exception {
128+
if (cleanupIsUnreliable()) {
129+
rule.waitUntilNoActivityUpTo(5001);
130+
}
131+
}
132+
125133
private StandardCredentials getInvalidCredential() {
126134
String username = "bad-user";
127135
String password = "bad-password";
@@ -1274,7 +1282,6 @@ public void testSubmoduleFixup() throws Exception {
12741282

12751283

12761284
FreeStyleBuild ub = rule.assertBuildStatusSuccess(u.scheduleBuild2(0));
1277-
System.out.println(ub.getLog());
12781285
for (int i=0; (d.getLastBuild()==null || d.getLastBuild().isBuilding()) && i<100; i++) // wait only up to 10 sec to avoid infinite loop
12791286
Thread.sleep(100);
12801287

@@ -2771,4 +2778,15 @@ public void buildEnvironmentFor(Run run, EnvVars envs, TaskListener listener) {
27712778
}
27722779
}
27732780

2781+
/** Returns true if test cleanup is not reliable */
2782+
private boolean cleanupIsUnreliable() {
2783+
// Windows cleanup is unreliable on ci.jenkins.io
2784+
String jobUrl = System.getenv("JOB_URL");
2785+
return isWindows() && jobUrl != null && jobUrl.contains("ci.jenkins.io");
2786+
}
2787+
2788+
/** inline ${@link hudson.Functions#isWindows()} to prevent a transient remote classloader issue */
2789+
private boolean isWindows() {
2790+
return java.io.File.pathSeparatorChar==';';
2791+
}
27742792
}

‎src/test/java/hudson/plugins/git/GitStatusTest.java‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
import static org.mockito.Mockito.when;
2424

2525
import static org.junit.Assert.*;
26+
import static org.junit.Assume.*;
2627
import org.junit.After;
2728
import org.junit.Before;
2829
import org.junit.Test;
@@ -533,6 +534,7 @@ public void testDoNotifyCommitWithDefaultUnsafeParameterExtra() throws Exception
533534
}
534535

535536
private void doNotifyCommitWithDefaultParameter(final boolean allowed, String safeParameters) throws Exception {
537+
assumeTrue(runUnreliableTests()); // Test cleanup is unreliable in some cases
536538
if (allowed) {
537539
GitStatus.setAllowNotifyCommitParameters(true);
538540
}
@@ -576,6 +578,18 @@ private void doNotifyCommitWithDefaultParameter(final boolean allowed, String sa
576578
assertEquals(expected, this.gitStatus.toString());
577579
}
578580

581+
/** Returns true if unreliable tests should be run */
582+
private boolean runUnreliableTests() {
583+
if (!isWindows()) {
584+
return true; // Always run tests on non-Windows platforms
585+
}
586+
String jobUrl = System.getenv("JOB_URL");
587+
if (jobUrl == null) {
588+
return true; // Always run tests when not inside a CI environment
589+
}
590+
return !jobUrl.contains("ci.jenkins.io"); // Skip some tests on ci.jenkins.io, windows cleanup is unreliable on those machines
591+
}
592+
579593
/**
580594
* inline ${@link hudson.Functions#isWindows()} to prevent a transient
581595
* remote classloader issue

‎src/test/java/jenkins/plugins/git/GitSampleRepoRule.java‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@
3232
import java.io.ByteArrayOutputStream;
3333
import java.io.File;
3434
import java.io.IOException;
35+
import java.util.logging.Level;
36+
import java.util.logging.Logger;
3537
import jenkins.scm.impl.mock.AbstractSampleDVCSRepoRule;
3638
import org.eclipse.jgit.lib.Constants;
3739
import org.eclipse.jgit.lib.RepositoryBuilder;
@@ -44,6 +46,8 @@ public final class GitSampleRepoRule extends AbstractSampleDVCSRepoRule {
4446

4547
private static boolean initialized = false;
4648

49+
private static final Logger LOGGER = Logger.getLogger(GitSampleRepoRule.class.getName());
50+
4751
public void git(String... cmds) throws Exception {
4852
run("git", cmds);
4953
}
@@ -74,10 +78,10 @@ public final boolean mkdirs(String rel) throws IOException {
7478
public void notifyCommit(JenkinsRule r) throws Exception {
7579
synchronousPolling(r);
7680
WebResponse webResponse = r.createWebClient().goTo("git/notifyCommit?url=" + bareUrl(), "text/plain").getWebResponse();
77-
System.out.println(webResponse.getContentAsString());
81+
LOGGER.log(Level.FINE, webResponse.getContentAsString());
7882
for (NameValuePair pair : webResponse.getResponseHeaders()) {
7983
if (pair.getName().equals("Triggered")) {
80-
System.out.println("Triggered: " + pair.getValue());
84+
LOGGER.log(Level.FINE, "Triggered: " + pair.getValue());
8185
}
8286
}
8387
r.waitUntilNoActivity();
@@ -101,24 +105,24 @@ public boolean gitVersionAtLeast(int neededMajor, int neededMinor, int neededPat
101105
try {
102106
int returnCode = new Launcher.LocalLauncher(procListener).launch().cmds("git", "--version").stdout(out).join();
103107
if (returnCode != 0) {
104-
System.out.println("Command 'git --version' returned " + returnCode);
108+
LOGGER.log(Level.WARNING, "Command 'git --version' returned " + returnCode);
105109
}
106110
} catch (IOException | InterruptedException ex) {
107-
System.out.println("Error checking git version " + ex);
111+
LOGGER.log(Level.WARNING, "Exception checking git version " + ex);
108112
}
109113
final String versionOutput = out.toString().trim();
110114
final String[] fields = versionOutput.split(" ")[2].replaceAll("msysgit.", "").replaceAll("windows.", "").split("\\.");
111115
final int gitMajor = Integer.parseInt(fields[0]);
112116
final int gitMinor = Integer.parseInt(fields[1]);
113117
final int gitPatch = Integer.parseInt(fields[2]);
114118
if (gitMajor < 1 || gitMajor > 3) {
115-
System.out.println("WARNING: Unexpected git major version " + gitMajor + " parsed from '" + versionOutput + "', field:'" + fields[0] + "'");
119+
LOGGER.log(Level.WARNING, "Unexpected git major version " + gitMajor + " parsed from '" + versionOutput + "', field:'" + fields[0] + "'");
116120
}
117121
if (gitMinor < 0 || gitMinor > 50) {
118-
System.out.println("WARNING: Unexpected git minor version " + gitMinor + " parsed from '" + versionOutput + "', field:'" + fields[1] + "'");
122+
LOGGER.log(Level.WARNING, "Unexpected git minor version " + gitMinor + " parsed from '" + versionOutput + "', field:'" + fields[1] + "'");
119123
}
120124
if (gitPatch < 0 || gitPatch > 20) {
121-
System.out.println("WARNING: Unexpected git patch version " + gitPatch + " parsed from '" + versionOutput + "', field:'" + fields[2] + "'");
125+
LOGGER.log(Level.WARNING, "Unexpected git patch version " + gitPatch + " parsed from '" + versionOutput + "', field:'" + fields[2] + "'");
122126
}
123127

124128
return gitMajor > neededMajor ||

0 commit comments

Comments
 (0)