Support publishing with submodules (#984)

* Fix LocalAppEngineServerBehaviour to handle module paths
* Leverage Tomcat's PublishOperation
* Make all publish methods protected to allow overriding

Author: briandealwis

features/com.google.cloud.tools.eclipse.suite.e45.feature/feature.xml

@@ -155,4 +155,11 @@
          fragment="true"
          unpack="false"/>
 
+   <plugin
+         id="com.google.cloud.tools.eclipse.jst.server.core"
+         download-size="0"
+         install-size="0"
+         version="0.0.0"
+         unpack="false"/>
+
 </feature>

plugins/com.google.cloud.tools.eclipse.appengine.facets.test/META-INF/MANIFEST.MF

@@ -10,7 +10,8 @@ Fragment-Host: com.google.cloud.tools.eclipse.appengine.facets
 Require-Bundle: org.hamcrest;bundle-version="1.1.0",
  org.junit;bundle-version="4.12.0",
  org.eclipse.wst.common.project.facet.core
-Import-Package: org.eclipse.core.resources,
+Import-Package: com.google.cloud.tools.eclipse.test.util.project,
+ org.eclipse.core.resources,
  org.eclipse.wst.common.project.facet.core,
  org.mockito;provider=google;version="1.10.19",
  org.mockito.runners;provider=google;version="1.10.19",

plugins/com.google.cloud.tools.eclipse.appengine.facets.test/src/com/google/cloud/tools/eclipse/appengine/facets/StandardFacetsInstallationTests.java

@@ -16,39 +16,31 @@
 
 package com.google.cloud.tools.eclipse.appengine.facets;
 
+import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertTrue;
 
+import com.google.cloud.tools.eclipse.test.util.project.ProjectUtils;
 import com.google.cloud.tools.eclipse.util.FacetedProjectHelper;
-import java.io.File;
 import java.io.IOException;
-import java.net.URL;
-import java.util.zip.ZipFile;
+import java.util.List;
 import org.eclipse.core.resources.IFile;
 import org.eclipse.core.resources.IProject;
-import org.eclipse.core.resources.IProjectDescription;
 import org.eclipse.core.resources.IWorkspaceRoot;
 import org.eclipse.core.resources.ResourcesPlugin;
 import org.eclipse.core.runtime.CoreException;
-import org.eclipse.core.runtime.FileLocator;
-import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.Path;
-import org.eclipse.core.runtime.SubMonitor;
 import org.eclipse.wst.common.project.facet.core.IFacetedProject;
-import org.eclipse.wst.common.project.facet.core.util.internal.ZipUtil;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
-import org.osgi.framework.Bundle;
-import org.osgi.framework.FrameworkUtil;
 
 /**
  * Tests some cases of installing the App Engine Standard facet on existing projects.
  */
 public class StandardFacetsInstallationTests {
   private IWorkspaceRoot root;
-  private IProject project;
+  private List<IProject> projects;
 
   @Before
   public void setUp() {
@@ -57,14 +49,19 @@ public void setUp() {
 
   @After
   public void tearDown() throws CoreException {
-    if (project != null) {
-      project.delete(true, null);
+    if (projects != null) {
+      for (IProject project : projects) {
+        project.delete(true, null);
+      }
     }
   }
 
   @Test
   public void testStandardFacetInstallationOnGwtWar() throws IOException, CoreException {
-    project = importProject("projects/test-dynamic-web-project.zip");
+    projects =
+        ProjectUtils.importProjects(getClass(), "projects/test-dynamic-web-project.zip", null);
+    assertEquals(1, projects.size());
+    IProject project = projects.get(0);
     IFacetedProject facetedProject = new FacetedProjectHelper().getFacetedProject(project);
     // verify that the appengine-web.xml is installed in the dynamic web root folder
     AppEngineStandardFacet.installAppEngineFacet(facetedProject, true, null);
@@ -74,37 +71,4 @@ public void testStandardFacetInstallationOnGwtWar() throws IOException, CoreExce
     assertTrue(correctAppEngineWebXml.exists());
     assertFalse(wrongAppEngineWebXml.exists());
   }
-
-  private IProject importProject(String relativeLocation) throws IOException, CoreException {
-    SubMonitor progress = SubMonitor.convert(null, 13);
-    // Resolve the zip'd project within this bundle
-    Bundle bundle = FrameworkUtil.getBundle(getClass());
-    URL bundleLocation = bundle.getResource(relativeLocation);
-    assertNotNull(bundleLocation);
-    URL zipLocation = FileLocator.toFileURL(bundleLocation);
-    if (!zipLocation.getProtocol().equals("file")) {
-      throw new IOException("could not resolve location to a file");
-    }
-    File zippedFile = new File(zipLocation.getPath());
-    assertTrue(zippedFile.exists());
-    progress.worked(1);
-
-    // extract project into our workspace using WTP internal utility class
-    ZipUtil.unzip(zippedFile, root.getLocation().toFile(), progress.newChild(2));
-
-    // determine the project location; a bit of a hack as we assume the
-    // first entry is the directory, but which seems to hold for all zips
-    String dirRoot;
-    try (ZipFile zip = new ZipFile(zippedFile)) {
-      dirRoot = zip.entries().nextElement().getName();
-    }
-    // import the project
-    IPath projectFileLocation = root.getLocation().append(new Path(dirRoot + ".project"));
-    IProjectDescription descriptor =
-        root.getWorkspace().loadProjectDescription(projectFileLocation);
-    IProject project = root.getProject(descriptor.getName());
-    project.create(descriptor, progress.newChild(5)); // adds the project to the workspace
-    project.open(progress.newChild(5)); // opens the project
-    return project;
-  }
 }

plugins/com.google.cloud.tools.eclipse.appengine.localserver.test/build.properties

@@ -1,6 +1,7 @@
 source.. = src/
 output.. = target/classes/
 bin.includes = META-INF/,\
-               .
+               .,\
+               projects/
 javacSource=1.7
 javacTarget=1.7

plugins/com.google.cloud.tools.eclipse.appengine.localserver.test/projects/test-submodules.zip

@@ -0,0 +1,118 @@
+/*
+ * Copyright 2016 Google Inc.
+ *
+ * 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.eclipse.appengine.localserver.server;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+
+import com.google.cloud.tools.eclipse.test.util.project.ProjectUtils;
+import java.io.File;
+import java.io.IOException;
+import java.util.List;
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IPath;
+import org.eclipse.wst.server.core.IModule;
+import org.eclipse.wst.server.core.IServer;
+import org.eclipse.wst.server.core.IServerType;
+import org.eclipse.wst.server.core.IServerWorkingCopy;
+import org.eclipse.wst.server.core.ServerCore;
+import org.eclipse.wst.server.core.ServerUtil;
+import org.junit.After;
+import org.junit.Assume;
+import org.junit.Before;
+import org.junit.Test;
+
+/** Verify that the server properly published submodule projects */
+public class LocalAppEnginePublishOperationTest {
+  private List<IProject> projects;
+  private IProject serverProject;
+  private IProject sharedProject;
+  private IModule serverModule;
+  private IModule sharedModule;
+  private IServer server;
+
+  @Before
+  public void setUp() throws IOException, CoreException {
+    Assume.assumeFalse("This test is flakey on travis and needs to be de-flaked",
+        Boolean.parseBoolean(System.getenv("TRAVIS")));
+
+    projects = ProjectUtils.importProjects(getClass(), "projects/test-submodules.zip", null);
+    assertEquals(2, projects.size());
+    assertTrue("sox-server".equals(projects.get(0).getName())
+        || "sox-server".equals(projects.get(1).getName()));
+    assertTrue("sox-shared".equals(projects.get(1).getName())
+        || "sox-shared".equals(projects.get(0).getName()));
+    serverProject = projects.get("sox-server".equals(projects.get(0).getName()) ? 0 : 1);
+    assertNotNull(serverProject);
+    sharedProject = projects.get("sox-shared".equals(projects.get(0).getName()) ? 0 : 1);
+    assertNotNull(sharedProject);
+
+    assertTrue(serverProject.getFile("bin/sox/server/GreetingServiceImpl.class").exists());
+    assertTrue(sharedProject.getFile("bin/sox/shared/GreetingService.class").exists());
+
+    serverModule = ServerUtil.getModule(serverProject);
+    assertNotNull(serverModule);
+    sharedModule = ServerUtil.getModule(sharedProject);
+    assertNotNull(sharedModule);
+  }
+
+  @After
+  public void tearDown() throws CoreException {
+    if (projects != null) {
+      for (IProject project : projects) {
+        project.delete(true, null);
+      }
+    }
+    if (server != null) {
+      server.delete();
+    }
+  }
+
+  /**
+   * Verify that multi-web-module works.
+   */
+  @Test
+  public void testPublishingSubmodules() throws IOException, CoreException {
+    IServerType serverType =
+        ServerCore.findServerType("com.google.cloud.tools.eclipse.appengine.standard.server");
+    IServerWorkingCopy serverWorkingCopy =
+        serverType.createServer(getClass().getName(), null, null);
+    serverWorkingCopy.modifyModules(new IModule[] {serverModule}, null, null);
+    server = serverWorkingCopy.saveAll(true, null);
+    assertTrue(server.canPublish().isOK());
+    assertTrue("publish failed", server.publish(IServer.PUBLISH_CLEAN, null).isOK());
+
+    LocalAppEngineServerBehaviour serverBehaviour =
+        server.getAdapter(LocalAppEngineServerBehaviour.class);
+    assertNotNull(serverBehaviour);
+
+    // now verify the result
+    IPath deployDirectory = serverBehaviour.getModuleDeployDirectory(serverModule);
+    File publishedModule = deployDirectory.toFile();
+    assertTrue(publishedModule.isDirectory());
+    File webInf = new File(publishedModule, "WEB-INF");
+    assertTrue(webInf.isDirectory());
+
+    assertTrue(new File(webInf, "appengine-web.xml").isFile());
+    assertTrue(new File(webInf, "web.xml").isFile());
+    assertTrue(new File(webInf, "classes/sox/server/GreetingServiceImpl.class").isFile());
+    assertTrue(new File(webInf, "lib/servlet-2.5.jar").isFile());
+    assertTrue(new File(webInf, "lib/sox-shared.jar").isFile());
+  }
+}

plugins/com.google.cloud.tools.eclipse.appengine.localserver.test/src/com/google/cloud/tools/eclipse/appengine/localserver/server/LocalAppEnginePublishOperationTest.java

@@ -38,6 +38,7 @@ Export-Package: com.google.cloud.tools.eclipse.appengine.localserver.server
 Import-Package: com.google.cloud.tools.eclipse.appengine.facets,
  com.google.cloud.tools.eclipse.appengine.libraries.model,
  com.google.cloud.tools.eclipse.appengine.libraries.repository,
+ com.google.cloud.tools.eclipse.jst.server.core,
  com.google.cloud.tools.eclipse.preferences,
  com.google.cloud.tools.eclipse.preferences.areas,
  com.google.cloud.tools.eclipse.sdk.ui,