Infer main class if it isn't configured anywhere (#278)

jib-core/src/main/java/com/google/cloud/tools/jib/frontend/HelpfulSuggestions.java

@@ -100,6 +100,10 @@ public String forDockerContextInsecureRecursiveDelete(String directory) {
     return suggest("clear " + directory + " manually before creating the Docker context");
   }
 
+  public String forMainClassNotFound(String pluginName) {
+    return suggest("add a `mainClass` configuration to " + pluginName);
+  }
+
   public String none() {
     return messagePrefix;
   }

jib-core/src/main/java/com/google/cloud/tools/jib/frontend/MainClassFinder.java

@@ -0,0 +1,96 @@
+/*
+ * Copyright 2018 Google LLC. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package com.google.cloud.tools.jib.frontend;
+
+import com.google.cloud.tools.jib.filesystem.DirectoryWalker;
+import java.io.IOException;
+import java.lang.reflect.Method;
+import java.lang.reflect.Modifier;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.List;
+import javax.annotation.Nullable;
+
+/** Infers the main class in an application. */
+public class MainClassFinder {
+
+  /** Helper for loading a .class file. */
+  private static class ClassFileLoader extends ClassLoader {
+
+    private final Path classFile;
+
+    private ClassFileLoader(Path classFile) {
+      this.classFile = classFile;
+    }
+
+    @Nullable
+    @Override
+    public Class findClass(@Nullable String name) {
+      try {
+        byte[] bytes = Files.readAllBytes(classFile);
+        return defineClass(name, bytes, 0, bytes.length);
+      } catch (IOException | ClassFormatError ignored) {
+        // Not a valid class file
+        return null;
+      }
+    }
+  }
+
+  /**
+   * Searches for a .class file containing a main method in a root directory.
+   *
+   * @return the name of the class if one is found, null if no class is found.
+   * @throws IOException if searching/reading files fails.
+   */
+  public static List<String> findMainClasses(Path rootDirectory) throws IOException {
+    List<String> classNames = new ArrayList<>();
+
+    // Make sure rootDirectory is valid
+    if (!Files.exists(rootDirectory) || !Files.isDirectory(rootDirectory)) {
+      return classNames;
+    }
+
+    // Get all .class files
+    new DirectoryWalker(rootDirectory)
+        .filter(Files::isRegularFile)
+        .filter(path -> path.toString().endsWith(".class"))
+        .walk(
+            classFile -> {
+              Class<?> fileClass = new ClassFileLoader(classFile).findClass(null);
+              if (fileClass == null) {
+                return;
+              }
+              try {
+                // Check if class contains {@code public static void main(String[] args)}
+                Method main = fileClass.getMethod("main", String[].class);
+                if (main != null
+                    && main.getReturnType() == void.class
+                    && Modifier.isStatic(main.getModifiers())
+                    && Modifier.isPublic(main.getModifiers())) {
+                  classNames.add(fileClass.getName());
+                }
+              } catch (NoSuchMethodException ignored) {
+                // main method not found
+              }
+            });
+
+    return classNames;
+  }
+
+  private MainClassFinder() {}
+}

jib-core/src/test/java/com/google/cloud/tools/jib/frontend/HelpfulSuggestionsTest.java

@@ -61,6 +61,9 @@ public void testSuggestions_smoke() {
     Assert.assertEquals(
         "messagePrefix, perhaps you should clear directory manually before creating the Docker context",
         TEST_HELPFUL_SUGGESTIONS.forDockerContextInsecureRecursiveDelete("directory"));
+    Assert.assertEquals(
+        "messagePrefix, perhaps you should add a `mainClass` configuration to plugin",
+        TEST_HELPFUL_SUGGESTIONS.forMainClassNotFound("plugin"));
     Assert.assertEquals("messagePrefix", TEST_HELPFUL_SUGGESTIONS.none());
   }
 }

jib-core/src/test/java/com/google/cloud/tools/jib/frontend/MainClassFinderTest.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright 2018 Google LLC. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package com.google.cloud.tools.jib.frontend;
+
+import com.google.common.io.Resources;
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.List;
+import org.junit.Assert;
+import org.junit.Test;
+
+/** Test for MainClassFinder. */
+public class MainClassFinderTest {
+
+  @Test
+  public void testFindMainClass_simple() throws URISyntaxException, IOException {
+    Path rootDirectory = Paths.get(Resources.getResource("class-finder-tests/simple").toURI());
+    List<String> mainClasses = MainClassFinder.findMainClasses(rootDirectory);
+    Assert.assertEquals(1, mainClasses.size());
+    Assert.assertTrue(mainClasses.contains("HelloWorld"));
+  }
+
+  @Test
+  public void testFindMainClass_subdirectories() throws URISyntaxException, IOException {
+    Path rootDirectory =
+        Paths.get(Resources.getResource("class-finder-tests/subdirectories").toURI());
+    List<String> mainClasses = MainClassFinder.findMainClasses(rootDirectory);
+    Assert.assertEquals(1, mainClasses.size());
+    Assert.assertTrue(mainClasses.contains("multi.layered.HelloWorld"));
+  }
+
+  @Test
+  public void testFindMainClass_noClass() throws URISyntaxException, IOException {
+    Path rootDirectory = Paths.get(Resources.getResource("class-finder-tests/no-main").toURI());
+    List<String> mainClasses = MainClassFinder.findMainClasses(rootDirectory);
+    Assert.assertTrue(mainClasses.isEmpty());
+  }
+
+  @Test
+  public void testFindMainClass_multiple() throws URISyntaxException, IOException {
+    Path rootDirectory = Paths.get(Resources.getResource("class-finder-tests/multiple").toURI());
+    List<String> mainClasses = MainClassFinder.findMainClasses(rootDirectory);
+    Assert.assertEquals(2, mainClasses.size());
+    Assert.assertTrue(mainClasses.contains("multi.layered.HelloMoon"));
+    Assert.assertTrue(mainClasses.contains("HelloWorld"));
+  }
+}

jib-core/src/test/resources/class-finder-tests/simple/NotEvenAClass.txt

@@ -0,0 +1 @@
+Hi there.

jib-gradle-plugin/src/integration-test/resources/projects/empty/build.gradle

@@ -15,7 +15,6 @@ jib {
         image = 'gcr.io/jib-integration-testing/emptyimage:gradle'
         credHelper = 'gcr'
     }
-    mainClass = 'com.test.Empty'
     // Does not have tests use user-level cache for base image layers.
     useOnlyProjectCache = true
 }

jib-gradle-plugin/src/integration-test/resources/projects/simple/build.gradle

@@ -19,7 +19,6 @@ jib {
         image = 'gcr.io/jib-integration-testing/simpleimage:gradle'
         credHelper = 'gcr'
     }
-    mainClass = 'com.test.HelloWorld'
     // Does not have tests use user-level cache for base image layers.
     useOnlyProjectCache = true
 }

jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/BuildDockerTask.java

@@ -89,7 +89,8 @@ public void buildDocker() throws InvalidImageReferenceException {
               + "' does not use a specific image digest - build may not be reproducible");
     }
 
-    ProjectProperties projectProperties = new ProjectProperties(getProject(), gradleBuildLogger);
+    ProjectProperties projectProperties =
+        ProjectProperties.getForProject(getProject(), gradleBuildLogger);
     String mainClass = projectProperties.getMainClass(jibExtension.getMainClass());
 
     RegistryCredentials knownBaseRegistryCredentials = null;

jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/BuildImageTask.java

@@ -95,7 +95,8 @@ public void buildImage() throws InvalidImageReferenceException {
               + "' does not use a specific image digest - build may not be reproducible");
     }
 
-    ProjectProperties projectProperties = new ProjectProperties(getProject(), gradleBuildLogger);
+    ProjectProperties projectProperties =
+        ProjectProperties.getForProject(getProject(), gradleBuildLogger);
     String mainClass = projectProperties.getMainClass(jibExtension.getMainClass());
 
     RegistryCredentials knownBaseRegistryCredentials = null;

jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/DockerContextTask.java

@@ -65,7 +65,8 @@ public void generateDockerContext() {
 
     GradleBuildLogger gradleBuildLogger = new GradleBuildLogger(getLogger());
 
-    ProjectProperties projectProperties = new ProjectProperties(getProject(), gradleBuildLogger);
+    ProjectProperties projectProperties =
+        ProjectProperties.getForProject(getProject(), gradleBuildLogger);
     String mainClass = projectProperties.getMainClass(jibExtension.getMainClass());
 
     String targetDir = getTargetDir();

jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/ProjectProperties.java

@@ -18,7 +18,10 @@
 
 import com.google.cloud.tools.jib.builder.BuildConfiguration;
 import com.google.cloud.tools.jib.builder.SourceFilesConfiguration;
+import com.google.cloud.tools.jib.frontend.MainClassFinder;
+import com.google.common.annotations.VisibleForTesting;
 import java.io.IOException;
+import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.List;
 import javax.annotation.Nullable;
@@ -30,45 +33,91 @@
 /** Obtains information about a Gradle {@link Project} that uses Jib. */
 class ProjectProperties {
 
+  private static final String PLUGIN_NAME = "jib";
+
   private final Project project;
   private final GradleBuildLogger gradleBuildLogger;
+  private final SourceFilesConfiguration sourceFilesConfiguration;
+
+  /** @return a ProjectProperties from the given project and logger. */
+  static ProjectProperties getForProject(Project project, GradleBuildLogger gradleBuildLogger) {
+    try {
+      return new ProjectProperties(
+          project, gradleBuildLogger, GradleSourceFilesConfiguration.getForProject(project));
+    } catch (IOException ex) {
+      throw new GradleException("Obtaining project build output files failed", ex);
+    }
+  }
 
-  ProjectProperties(Project project, GradleBuildLogger gradleBuildLogger) {
+  @VisibleForTesting
+  ProjectProperties(
+      Project project,
+      GradleBuildLogger gradleBuildLogger,
+      SourceFilesConfiguration sourceFilesConfiguration) {
     this.project = project;
     this.gradleBuildLogger = gradleBuildLogger;
+    this.sourceFilesConfiguration = sourceFilesConfiguration;
   }
 
   /**
-   * @param mainClass the configured main class
-   * @return the main class to use for the container entrypoint.
+   * If {@code mainClass} is {@code null}, tries to infer main class in this order:
+   *
+   * <ul>
+   *   <li>1. Looks in a {@code jar} task.
+   *   <li>2. Searches for a class defined with a main method.
+   * </ul>
+   *
+   * <p>Warns if main class is not valid.
+   *
+   * @throws GradleException if no valid main class is not found.
    */
   String getMainClass(@Nullable String mainClass) {
     if (mainClass == null) {
+      gradleBuildLogger.info(
+          "Searching for main class... Add a 'mainClass' configuration to '"
+              + PLUGIN_NAME
+              + "' to improve build speed.");
       mainClass = getMainClassFromJarTask();
       if (mainClass == null) {
-        throw new GradleException(
-            HelpfulSuggestionsProvider.get("Could not find main class specified in a 'jar' task")
-                .suggest("add a `mainClass` configuration to jib"));
+        gradleBuildLogger.debug(
+            "Could not find main class specified in a 'jar' task; attempting to "
+                + "infer main class.");
+        try {
+          // Adds each file in each classes output directory to the classes files list.
+          List<String> mainClasses = new ArrayList<>();
+          for (Path classPath : sourceFilesConfiguration.getClassesFiles()) {
+            mainClasses.addAll(MainClassFinder.findMainClasses(classPath));
+          }
+
+          if (mainClasses.size() == 1) {
+            mainClass = mainClasses.get(0);
+          } else if (mainClasses.size() == 0) {
+            throw new GradleException(
+                HelpfulSuggestionsProvider.get("Main class was not found")
+                    .forMainClassNotFound(PLUGIN_NAME));
+          } else {
+            throw new GradleException(
+                HelpfulSuggestionsProvider.get(
+                        "Multiple valid main classes were found: " + String.join(", ", mainClasses))
+                    .forMainClassNotFound(PLUGIN_NAME));
+          }
+        } catch (IOException ex) {
+          throw new GradleException(
+              HelpfulSuggestionsProvider.get("Failed to get main class")
+                  .forMainClassNotFound(PLUGIN_NAME),
+              ex);
+        }
       }
     }
     if (!BuildConfiguration.isValidJavaClass(mainClass)) {
-      getLogger().warn("'mainClass' is not a valid Java class : " + mainClass);
+      gradleBuildLogger.warn("'mainClass' is not a valid Java class : " + mainClass);
     }
     return mainClass;
   }
 
-  GradleBuildLogger getLogger() {
-    return gradleBuildLogger;
-  }
-
   /** @return the {@link SourceFilesConfiguration} based on the current project */
   SourceFilesConfiguration getSourceFilesConfiguration() {
-    try {
-      return GradleSourceFilesConfiguration.getForProject(project);
-
-    } catch (IOException ex) {
-      throw new GradleException("Obtaining project build output files failed", ex);
-    }
+    return sourceFilesConfiguration;
   }
 
   /** Extracts main class from 'jar' task, if available. */

jib-gradle-plugin/src/test/java/com/google/cloud/tools/jib/gradle/ProjectPropertiesTest.java

@@ -16,7 +16,11 @@
 
 package com.google.cloud.tools.jib.gradle;
 
+import com.google.cloud.tools.jib.builder.SourceFilesConfiguration;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.Collections;
+import java.util.List;
 import org.gradle.api.GradleException;
 import org.gradle.api.Project;
 import org.gradle.api.internal.file.FileResolver;
@@ -42,16 +46,20 @@ public class ProjectPropertiesTest {
   @Mock private Jar mockJar;
   @Mock private Project mockProject;
   @Mock private GradleBuildLogger mockGradleBuildLogger;
+  @Mock private SourceFilesConfiguration mockSourceFilesConfiguration;
 
+  private final List<Path> classesPath = Collections.singletonList(Paths.get("a/b/c"));
   private Manifest fakeManifest;
   private ProjectProperties testProjectProperties;
 
   @Before
   public void setUp() {
     fakeManifest = new DefaultManifest(mockFileResolver);
     Mockito.when(mockJar.getManifest()).thenReturn(fakeManifest);
+    Mockito.when(mockSourceFilesConfiguration.getClassesFiles()).thenReturn(classesPath);
 
-    testProjectProperties = new ProjectProperties(mockProject, mockGradleBuildLogger);
+    testProjectProperties =
+        new ProjectProperties(mockProject, mockGradleBuildLogger, mockSourceFilesConfiguration);
   }
 
   @Test
@@ -95,9 +103,9 @@ private void assertGetMainClassFails() {
       Assert.fail("Main class not expected");
 
     } catch (GradleException ex) {
-      Assert.assertThat(
-          ex.getMessage(),
-          CoreMatchers.containsString("Could not find main class specified in a 'jar' task"));
+      Mockito.verify(mockGradleBuildLogger)
+          .debug(
+              "Could not find main class specified in a 'jar' task; attempting to infer main class.");
       Assert.assertThat(
           ex.getMessage(), CoreMatchers.containsString("add a `mainClass` configuration to jib"));
     }