Use BuildWatcher instead of TailLog for simple

jenkinsci · Jan 2, 2025 · 35bd816 · 35bd816
1 parent 12658e1
commit 35bd816
Show file tree

Hide file tree

Showing 14 changed files with 92 additions and 86 deletions.
diff --git a/src/test/java/com/google/jenkins/plugins/computeengine/integration/ComputeClientIT.java b/src/test/java/com/google/jenkins/plugins/computeengine/integration/ComputeClientIT.java
@@ -38,7 +38,7 @@
 public class ComputeClientIT {
     private static final Logger log = Logger.getLogger(ComputeClientIT.class.getName());
 
-    private static Map<String, String> label = getLabel(ComputeClientIT.class);
+    private static final Map<String, String> label = getLabel(ComputeClientIT.class);
     private static ComputeClient client;
 
     @ClassRule

diff --git a/...ns/plugins/computeengine/integration/ComputeEngineCloud1WorkerCreatedFor2ExecutorsIT.java b/...ns/plugins/computeengine/integration/ComputeEngineCloud1WorkerCreatedFor2ExecutorsIT.java
@@ -20,7 +20,6 @@
 import static com.google.jenkins.plugins.computeengine.integration.ITUtil.NULL_TEMPLATE;
 import static com.google.jenkins.plugins.computeengine.integration.ITUtil.PROJECT_ID;
 import static com.google.jenkins.plugins.computeengine.integration.ITUtil.TEST_TIMEOUT_MULTIPLIER;
-import static com.google.jenkins.plugins.computeengine.integration.ITUtil.ZONE;
 import static com.google.jenkins.plugins.computeengine.integration.ITUtil.getLabel;
 import static com.google.jenkins.plugins.computeengine.integration.ITUtil.initClient;
 import static com.google.jenkins.plugins.computeengine.integration.ITUtil.initCloud;
@@ -31,7 +30,6 @@
 import static org.hamcrest.Matchers.is;
 import static org.junit.Assert.assertEquals;
 
-import com.google.api.services.compute.model.Instance;
 import com.google.cloud.graphite.platforms.plugin.client.ComputeClient;
 import com.google.common.collect.ImmutableList;
 import com.google.jenkins.plugins.computeengine.ComputeEngineCloud;
@@ -61,15 +59,13 @@ public class ComputeEngineCloud1WorkerCreatedFor2ExecutorsIT {
     private static final String MULTIPLE_NUM_EXECUTORS = "2";
 
     @ClassRule
-    public static Timeout timeout = new Timeout(5 * TEST_TIMEOUT_MULTIPLIER, TimeUnit.MINUTES);
+    public static Timeout timeout = new Timeout(5L * TEST_TIMEOUT_MULTIPLIER, TimeUnit.MINUTES);
 
     @ClassRule
     public static JenkinsRule jenkinsRule = new JenkinsRule();
 
     private static ComputeClient client;
-    private static Map<String, String> label = getLabel(ComputeEngineCloud1WorkerCreatedFor2ExecutorsIT.class);
-    private static Collection<PlannedNode> planned;
-    private static Instance instance;
+    private static final Map<String, String> label = getLabel(ComputeEngineCloud1WorkerCreatedFor2ExecutorsIT.class);
 
     @BeforeClass
     public static void init() throws Exception {
@@ -87,10 +83,8 @@ public static void init() throws Exception {
                 .googleLabels(label)
                 .build()));
 
-        planned = cloud.provision(new LabelAtom(LABEL), 2);
+        Collection<PlannedNode> planned = cloud.provision(new LabelAtom(LABEL), 2);
         planned.iterator().next().future.get();
-
-        instance = client.getInstance(PROJECT_ID, ZONE, planned.iterator().next().displayName);
     }
 
     @AfterClass

diff --git a/...com/google/jenkins/plugins/computeengine/integration/ComputeEngineCloudIgnoreProxyIT.java b/...com/google/jenkins/plugins/computeengine/integration/ComputeEngineCloudIgnoreProxyIT.java
@@ -37,6 +37,7 @@
 import hudson.ProxyConfiguration;
 import hudson.model.FreeStyleBuild;
 import hudson.model.FreeStyleProject;
+import hudson.model.Result;
 import hudson.model.labels.LabelAtom;
 import hudson.tasks.Builder;
 import java.io.IOException;
@@ -51,24 +52,27 @@
 import org.junit.ClassRule;
 import org.junit.Test;
 import org.junit.rules.Timeout;
+import org.jvnet.hudson.test.BuildWatcher;
 import org.jvnet.hudson.test.JenkinsRule;
-import org.jvnet.hudson.test.PrefixedOutputStream;
-import org.jvnet.hudson.test.TailLog;
 
 /**
  * Integration test suite for {@link ComputeEngineCloud}. Verifies that when the ignore proxy flag
  * is set to true, connections to GCE VMs bypass the proxy, and when set to false the proxy is used.
  */
 @Log
 public class ComputeEngineCloudIgnoreProxyIT {
+
     @ClassRule
-    public static Timeout timeout = new Timeout(10 * TEST_TIMEOUT_MULTIPLIER, TimeUnit.MINUTES);
+    public static Timeout timeout = new Timeout(10L * TEST_TIMEOUT_MULTIPLIER, TimeUnit.MINUTES);
 
     @ClassRule
     public static JenkinsRule jenkinsRule = new JenkinsRule();
 
+    @ClassRule
+    public static BuildWatcher bw = new BuildWatcher();
+
     private static ComputeClient client;
-    private static Map<String, String> label = getLabel(ComputeEngineCloudIgnoreProxyIT.class);
+    private static final Map<String, String> label = getLabel(ComputeEngineCloudIgnoreProxyIT.class);
     private static ComputeEngineCloud cloud;
 
     @BeforeClass
@@ -120,12 +124,10 @@ public void testWorkerIgnoringProxy() throws Exception {
                 .isIgnoreProxy());
 
         var project = createProject(identifier);
-        try (var tailLog = new TailLog(jenkinsRule, identifier, 1).withColor(PrefixedOutputStream.Color.MAGENTA)) {
-            Future<FreeStyleBuild> build = project.scheduleBuild2(0);
-            ComputeEngineInstance node = (ComputeEngineInstance) build.get().getBuiltOn();
-            assertTrue(node.isIgnoreProxy());
-            tailLog.waitForCompletion();
-        }
+        Future<FreeStyleBuild> build = project.scheduleBuild2(0);
+        ComputeEngineInstance node = (ComputeEngineInstance) build.get().getBuiltOn();
+        assertTrue(node.isIgnoreProxy());
+        jenkinsRule.assertBuildStatus(Result.SUCCESS, build.get());
     }
 
     // Due to the proxy configured for Jenkins, the build fails because it is not able to connect to
@@ -141,9 +143,7 @@ public void testWorkerNotIgnoringProxyFails() throws Exception {
                 .isIgnoreProxy());
 
         var project = createProject(identifier);
-        try (var tailLog = new TailLog(jenkinsRule, identifier, 1).withColor(PrefixedOutputStream.Color.YELLOW)) {
-            Future<FreeStyleBuild> build = project.scheduleBuild2(0);
-            build.get(300, TimeUnit.SECONDS);
-        }
+        Future<FreeStyleBuild> build = project.scheduleBuild2(0);
+        build.get(300, TimeUnit.SECONDS);
     }
 }
diff --git a/.../google/jenkins/plugins/computeengine/integration/ComputeEngineCloudMultipleLabelsIT.java b/.../google/jenkins/plugins/computeengine/integration/ComputeEngineCloudMultipleLabelsIT.java
@@ -54,18 +54,18 @@
  * with multiple Jenkins labels and that these labels are properly provisioned.
  */
 public class ComputeEngineCloudMultipleLabelsIT {
-    private static Logger log = Logger.getLogger(ComputeEngineCloudMultipleLabelsIT.class.getName());
+    private static final Logger log = Logger.getLogger(ComputeEngineCloudMultipleLabelsIT.class.getName());
 
     private static final String MULTIPLE_LABEL = "integration test";
 
     @ClassRule
-    public static Timeout timeout = new Timeout(5 * TEST_TIMEOUT_MULTIPLIER, TimeUnit.MINUTES);
+    public static Timeout timeout = new Timeout(5L * TEST_TIMEOUT_MULTIPLIER, TimeUnit.MINUTES);
 
     @ClassRule
     public static JenkinsRule jenkinsRule = new JenkinsRule();
 
     private static ComputeClient client;
-    private static Map<String, String> label = getLabel(ComputeEngineCloudMultipleLabelsIT.class);
+    private static final Map<String, String> label = getLabel(ComputeEngineCloudMultipleLabelsIT.class);
     private static String name;
 
     @BeforeClass

diff --git a/...plugins/computeengine/integration/ComputeEngineCloudMultipleMatchingConfigurationsIT.java b/...plugins/computeengine/integration/ComputeEngineCloudMultipleMatchingConfigurationsIT.java
@@ -57,7 +57,8 @@
  * with multiple matching {@link InstanceConfiguration} and that these instances are provisioned in round-robin fashion.
  */
 public class ComputeEngineCloudMultipleMatchingConfigurationsIT {
-    private static Logger log = Logger.getLogger(ComputeEngineCloudMultipleMatchingConfigurationsIT.class.getName());
+    private static final Logger log =
+            Logger.getLogger(ComputeEngineCloudMultipleMatchingConfigurationsIT.class.getName());
 
     private static final String DESC_1 = "type_1";
     private static final String DESC_2 = "type_2";
@@ -69,7 +70,7 @@ public class ComputeEngineCloudMultipleMatchingConfigurationsIT {
     public static JenkinsRule jenkinsRule = new JenkinsRule();
 
     private static ComputeClient client;
-    private static Map<String, String> label = getLabel(ComputeEngineCloudMultipleMatchingConfigurationsIT.class);
+    private static final Map<String, String> label = getLabel(ComputeEngineCloudMultipleMatchingConfigurationsIT.class);
     private static Collection<PlannedNode> planned;
 
     @BeforeClass

diff --git a/...ogle/jenkins/plugins/computeengine/integration/ComputeEngineCloudNoSnapshotCreatedIT.java b/...ogle/jenkins/plugins/computeengine/integration/ComputeEngineCloudNoSnapshotCreatedIT.java
@@ -51,6 +51,7 @@
 import org.junit.ClassRule;
 import org.junit.Test;
 import org.junit.rules.Timeout;
+import org.jvnet.hudson.test.BuildWatcher;
 import org.jvnet.hudson.test.JenkinsRule;
 
 /**
@@ -62,13 +63,16 @@ public class ComputeEngineCloudNoSnapshotCreatedIT {
     private static final Logger log = Logger.getLogger(ComputeEngineCloudNoSnapshotCreatedIT.class.getName());
 
     @ClassRule
-    public static Timeout timeout = new Timeout(7 * TEST_TIMEOUT_MULTIPLIER, TimeUnit.MINUTES);
+    public static Timeout timeout = new Timeout(7L * TEST_TIMEOUT_MULTIPLIER, TimeUnit.MINUTES);
 
     @ClassRule
     public static JenkinsRule jenkinsRule = new JenkinsRule();
 
+    @ClassRule
+    public static BuildWatcher bw = new BuildWatcher();
+
     private static ComputeClient client;
-    private static Map<String, String> label = getLabel(ComputeEngineCloudNoSnapshotCreatedIT.class);
+    private static final Map<String, String> label = getLabel(ComputeEngineCloudNoSnapshotCreatedIT.class);
     private static String name;
 
     @BeforeClass

diff --git a/...google/jenkins/plugins/computeengine/integration/ComputeEngineCloudNonStandardJavaIT.java b/...google/jenkins/plugins/computeengine/integration/ComputeEngineCloudNonStandardJavaIT.java
@@ -50,9 +50,8 @@
 import org.junit.ClassRule;
 import org.junit.Test;
 import org.junit.rules.Timeout;
+import org.jvnet.hudson.test.BuildWatcher;
 import org.jvnet.hudson.test.JenkinsRule;
-import org.jvnet.hudson.test.PrefixedOutputStream;
-import org.jvnet.hudson.test.TailLog;
 
 /**
  * Integration test suite for {@link ComputeEngineCloudNonStandardJavaIT}. Verifies that instances
@@ -70,6 +69,9 @@ public class ComputeEngineCloudNonStandardJavaIT {
     @ClassRule
     public static JenkinsRule jenkinsRule = new JenkinsRule();
 
+    @ClassRule
+    public static BuildWatcher bw = new BuildWatcher();
+
     private static ComputeClient client;
     private static final Map<String, String> label = getLabel(ComputeEngineCloudNonStandardJavaIT.class);
 
@@ -102,16 +104,14 @@ public static void teardown() throws IOException {
     public void testBuildOnNonStandardJavaAgent() throws Exception {
         var p = jenkinsRule.createProject(WorkflowJob.class, "p");
         p.setDefinition(new CpsFlowDefinition("node('" + LABEL + "') { sh 'date' }", true));
-        try (var tailLog = new TailLog(jenkinsRule, "p", 1).withColor(PrefixedOutputStream.Color.MAGENTA)) {
-            var r = jenkinsRule.buildAndAssertSuccess(p);
-            assertEquals(1, jenkinsRule.jenkins.getNodes().size());
-            var instance = client.getInstance(
-                    PROJECT_ID, ZONE, jenkinsRule.jenkins.getNodes().get(0).getNodeName());
-            tailLog.waitForCompletion();
-            assertThat(
-                    "Build did not run on GCP agent",
-                    JenkinsRule.getLog(r),
-                    is(containsString("Running on " + instance.getName())));
-        }
+        var r = jenkinsRule.buildAndAssertSuccess(p);
+        assertEquals(1, jenkinsRule.jenkins.getNodes().size());
+        var instance = client.getInstance(
+                PROJECT_ID, ZONE, jenkinsRule.jenkins.getNodes().get(0).getNodeName());
+        assertThat(
+                "Build did not run on GCP agent",
+                JenkinsRule.getLog(r),
+                is(containsString("Running on " + instance.getName())));
+        jenkinsRule.waitUntilNoActivity();
     }
 }
diff --git a/...google/jenkins/plugins/computeengine/integration/ComputeEngineCloudOneShotInstanceIT.java b/...google/jenkins/plugins/computeengine/integration/ComputeEngineCloudOneShotInstanceIT.java
@@ -53,6 +53,7 @@
 import org.junit.ClassRule;
 import org.junit.Test;
 import org.junit.rules.Timeout;
+import org.jvnet.hudson.test.BuildWatcher;
 import org.jvnet.hudson.test.JenkinsRule;
 
 /**
@@ -64,13 +65,16 @@ public class ComputeEngineCloudOneShotInstanceIT {
     private static final int QUIET_PERIOD_SECS = 30;
 
     @ClassRule
-    public static Timeout timeout = new Timeout(10 * TEST_TIMEOUT_MULTIPLIER, TimeUnit.MINUTES);
+    public static Timeout timeout = new Timeout(10L * TEST_TIMEOUT_MULTIPLIER, TimeUnit.MINUTES);
 
     @ClassRule
     public static JenkinsRule jenkinsRule = new JenkinsRule();
 
+    @ClassRule
+    public static BuildWatcher bw = new BuildWatcher();
+
     private static ComputeClient client;
-    private static Map<String, String> label = getLabel(ComputeEngineCloudOneShotInstanceIT.class);
+    private static final Map<String, String> label = getLabel(ComputeEngineCloudOneShotInstanceIT.class);
     private static FreeStyleBuild build;
     private static String nodeName;
     private static Future<FreeStyleBuild> otherBuildFuture;

diff --git a/...oogle/jenkins/plugins/computeengine/integration/ComputeEngineCloudRestartPreemptedIT.java b/...oogle/jenkins/plugins/computeengine/integration/ComputeEngineCloudRestartPreemptedIT.java
@@ -58,9 +58,8 @@
 import org.junit.ClassRule;
 import org.junit.Test;
 import org.junit.rules.Timeout;
+import org.jvnet.hudson.test.BuildWatcher;
 import org.jvnet.hudson.test.JenkinsRule;
-import org.jvnet.hudson.test.PrefixedOutputStream;
-import org.jvnet.hudson.test.TailLog;
 
 /**
  * Integration test suite for {@link ComputeEngineCloud}. Verifies that the build is rescheduled and
@@ -77,8 +76,11 @@ public class ComputeEngineCloudRestartPreemptedIT {
     @ClassRule
     public static JenkinsRule jenkinsRule = new JenkinsRule();
 
+    @ClassRule
+    public static BuildWatcher bw = new BuildWatcher();
+
     private static ComputeClient client;
-    private static Map<String, String> label = getLabel(ComputeEngineCloudRestartPreemptedIT.class);
+    private static final Map<String, String> label = getLabel(ComputeEngineCloudRestartPreemptedIT.class);
     private static ComputeEngineCloud cloud;
 
     @BeforeClass
@@ -138,28 +140,21 @@ public void testIfNodeWasPreempted() throws Exception {
         project.setAssignedLabel(new LabelAtom(LABEL));
         FreeStyleBuild freeStyleBuild;
         // build1 that gets failed due to preemption
-        try (var tailLog = new TailLog(jenkinsRule, "p", 1).withColor(PrefixedOutputStream.Color.MAGENTA)) {
-            QueueTaskFuture<FreeStyleBuild> taskFuture = project.scheduleBuild2(0);
-
-            Awaitility.await().timeout(7, TimeUnit.MINUTES).until(() -> computer.getLog()
-                    .contains("listening to metadata for preemption event"));
+        QueueTaskFuture<FreeStyleBuild> taskFuture = project.scheduleBuild2(0);
+        Awaitility.await().timeout(7, TimeUnit.MINUTES).until(() -> computer.getLog()
+                .contains("listening to metadata for preemption event"));
 
-            client.simulateMaintenanceEvent(PROJECT_ID, ZONE, name);
-            Awaitility.await().timeout(8, TimeUnit.MINUTES).until(computer::getPreempted);
+        client.simulateMaintenanceEvent(PROJECT_ID, ZONE, name);
+        Awaitility.await().timeout(8, TimeUnit.MINUTES).until(computer::getPreempted);
 
-            freeStyleBuild = taskFuture.get();
-            assertEquals(FAILURE, freeStyleBuild.getResult());
-            tailLog.waitForCompletion();
-        }
+        freeStyleBuild = taskFuture.get();
+        assertEquals(FAILURE, freeStyleBuild.getResult());
 
         Awaitility.await().timeout(5, TimeUnit.MINUTES).until(() -> freeStyleBuild.getNextBuild() != null);
 
         // build2 gets automatically scheduled and succeeds
-        try (var tailLog = new TailLog(jenkinsRule, "p", 2).withColor(PrefixedOutputStream.Color.YELLOW)) {
-            FreeStyleBuild nextBuild = freeStyleBuild.getNextBuild();
-            Awaitility.await().timeout(5, TimeUnit.MINUTES).until(() -> nextBuild.getResult() != null);
-            assertEquals(SUCCESS, nextBuild.getResult());
-            tailLog.waitForCompletion();
-        }
+        FreeStyleBuild nextBuild = freeStyleBuild.getNextBuild();
+        Awaitility.await().timeout(5, TimeUnit.MINUTES).until(() -> nextBuild.getResult() != null);
+        assertEquals(SUCCESS, nextBuild.getResult());
     }
 }
diff --git a/...google/jenkins/plugins/computeengine/integration/ComputeEngineCloudSnapshotCreatedIT.java b/...google/jenkins/plugins/computeengine/integration/ComputeEngineCloudSnapshotCreatedIT.java
@@ -54,6 +54,7 @@
 import org.junit.ClassRule;
 import org.junit.Test;
 import org.junit.rules.Timeout;
+import org.jvnet.hudson.test.BuildWatcher;
 import org.jvnet.hudson.test.JenkinsRule;
 
 /**
@@ -70,8 +71,11 @@ public class ComputeEngineCloudSnapshotCreatedIT {
     @ClassRule
     public static JenkinsRule jenkinsRule = new JenkinsRule();
 
+    @ClassRule
+    public static BuildWatcher bw = new BuildWatcher();
+
     private static ComputeClient client;
-    private static Map<String, String> label = getLabel(ComputeEngineCloudSnapshotCreatedIT.class);
+    private static final Map<String, String> label = getLabel(ComputeEngineCloudSnapshotCreatedIT.class);
     private static Snapshot createdSnapshot = null;
 
     @BeforeClass

diff --git a/...jenkins/plugins/computeengine/integration/ComputeEngineCloudTemplateNoGoogleLabelsIT.java b/...jenkins/plugins/computeengine/integration/ComputeEngineCloudTemplateNoGoogleLabelsIT.java
@@ -57,18 +57,18 @@
  * still present on the created instance.
  */
 public class ComputeEngineCloudTemplateNoGoogleLabelsIT {
-    private static Logger log = Logger.getLogger(ComputeEngineCloudTemplateNoGoogleLabelsIT.class.getName());
+    private static final Logger log = Logger.getLogger(ComputeEngineCloudTemplateNoGoogleLabelsIT.class.getName());
 
     private static final String TEMPLATE = format("projects/%s/global/instanceTemplates/test-template-no-labels");
 
     @ClassRule
-    public static Timeout timeout = new Timeout(5 * TEST_TIMEOUT_MULTIPLIER, TimeUnit.MINUTES);
+    public static Timeout timeout = new Timeout(5L * TEST_TIMEOUT_MULTIPLIER, TimeUnit.MINUTES);
 
     @ClassRule
     public static JenkinsRule jenkinsRule = new JenkinsRule();
 
     private static ComputeClient client;
-    private static Map<String, String> label = getLabel(ComputeEngineCloudTemplateNoGoogleLabelsIT.class);
+    private static final Map<String, String> label = getLabel(ComputeEngineCloudTemplateNoGoogleLabelsIT.class);
     private static ComputeEngineCloud cloud;
     private static Instance instance;