Catch runtime exceptions from extension execution (#2474)

* Catch runtime exception from extensions
GoogleContainerTools · May 20, 2020 · 2220c26 · 2220c26
1 parent 27cde26
commit 2220c26
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 14 deletions.
diff --git a/...radle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/GradleProjectProperties.java b/...radle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/GradleProjectProperties.java
@@ -474,13 +474,18 @@ private <T> ContainerBuildPlan runPluginExtension(
       }
     }
 
-    return ((JibGradlePluginExtension<T>) extension)
-        .extendContainerBuildPlan(
-            buildPlan,
-            config.getProperties(),
-            Optional.ofNullable(extraConfig),
-            () -> project,
-            new PluginExtensionLogger(this::log));
+    try {
+      return ((JibGradlePluginExtension<T>) extension)
+          .extendContainerBuildPlan(
+              buildPlan,
+              config.getProperties(),
+              Optional.ofNullable(extraConfig),
+              () -> project,
+              new PluginExtensionLogger(this::log));
+    } catch (RuntimeException ex) {
+      throw new JibPluginExtensionException(
+          extension.getClass(), "extension crashed: " + ex.getMessage(), ex);
+    }
   }
 
   private JibGradlePluginExtension<?> findConfiguredExtension(

diff --git a/...src/test/java/com/google/cloud/tools/jib/gradle/GradleProjectPropertiesExtensionTest.java b/...src/test/java/com/google/cloud/tools/jib/gradle/GradleProjectPropertiesExtensionTest.java
@@ -426,4 +426,23 @@ public void testRunPluginExtensions_ignoreUnexpectedExtraConfig()
           ex.getMessage());
     }
   }
+
+  @Test
+  public void testRunPluginExtensions_runtimeExceptionFromExtension() {
+    FooExtension extension =
+        new FooExtension(
+            (buildPlan, properties, extraConfig, mavenData, logger) -> {
+              throw new IndexOutOfBoundsException("buggy extension");
+            });
+    loadedExtensions = Arrays.asList(extension);
+
+    try {
+      gradleProjectProperties.runPluginExtensions(
+          Arrays.asList(new FooExtensionConfig()), containerBuilder);
+      Assert.fail();
+    } catch (JibPluginExtensionException ex) {
+      Assert.assertEquals(FooExtension.class, ex.getExtensionClass());
+      Assert.assertEquals("extension crashed: buggy extension", ex.getMessage());
+    }
+  }
 }
diff --git a/jib-maven-plugin/src/main/java/com/google/cloud/tools/jib/maven/MavenProjectProperties.java b/jib-maven-plugin/src/main/java/com/google/cloud/tools/jib/maven/MavenProjectProperties.java
@@ -615,13 +615,18 @@ private <T> ContainerBuildPlan runPluginExtension(
       }
     }
 
-    return ((JibMavenPluginExtension<T>) extension)
-        .extendContainerBuildPlan(
-            buildPlan,
-            config.getProperties(),
-            extraConfig,
-            new MavenExtensionData(project, session),
-            new PluginExtensionLogger(this::log));
+    try {
+      return ((JibMavenPluginExtension<T>) extension)
+          .extendContainerBuildPlan(
+              buildPlan,
+              config.getProperties(),
+              extraConfig,
+              new MavenExtensionData(project, session),
+              new PluginExtensionLogger(this::log));
+    } catch (RuntimeException ex) {
+      throw new JibPluginExtensionException(
+          extension.getClass(), "extension crashed: " + ex.getMessage(), ex);
+    }
   }
 
   private JibMavenPluginExtension<?> findConfiguredExtension(

diff --git a/...n/src/test/java/com/google/cloud/tools/jib/maven/MavenProjectPropertiesExtensionTest.java b/...n/src/test/java/com/google/cloud/tools/jib/maven/MavenProjectPropertiesExtensionTest.java
@@ -430,4 +430,23 @@ public void testRunPluginExtensions_ignoreUnexpectedExtraConfig()
           ex.getMessage());
     }
   }
+
+  @Test
+  public void testRunPluginExtensions_runtimeExceptionFromExtension() {
+    FooExtension extension =
+        new FooExtension(
+            (buildPlan, properties, extraConfig, mavenData, logger) -> {
+              throw new IndexOutOfBoundsException("buggy extension");
+            });
+    loadedExtensions = Arrays.asList(extension);
+
+    try {
+      mavenProjectProperties.runPluginExtensions(
+          Arrays.asList(new FooExtensionConfig()), containerBuilder);
+      Assert.fail();
+    } catch (JibPluginExtensionException ex) {
+      Assert.assertEquals(FooExtension.class, ex.getExtensionClass());
+      Assert.assertEquals("extension crashed: buggy extension", ex.getMessage());
+    }
+  }
 }