CHE-1113: Add ability to clone project with submodules

Igor Vinokur · Igor Vinokur · commit ffef620a82b8 · 2016-06-29T21:17:03.000+03:00
diff --git a/plugins/plugin-git/che-plugin-git-ext-git/src/main/java/org/eclipse/che/ide/ext/git/client/GitLocalizationConstant.java b/plugins/plugin-git/che-plugin-git-ext-git/src/main/java/org/eclipse/che/ide/ext/git/client/GitLocalizationConstant.java
@@ -260,6 +260,9 @@ public interface GitLocalizationConstant extends Messages {
     @Key("view.import.gitImporterPage.projectUrl")
     String gitImporterPageProjectUrl();
 
+    @Key("view.import.gitImporterPage.recursive")
+    String gitImporterPageRecursive();
+
     @Key("view.import.gitImporterPage.projectInfo")
     String gitImporterPageProjectInfo();
 
@@ -692,4 +695,4 @@ public interface GitLocalizationConstant extends Messages {
 
     @Key("console.project.name")
     String consoleProjectName(String projectName);
-}
+}
diff --git a/plugins/plugin-git/che-plugin-git-ext-git/src/main/java/org/eclipse/che/ide/ext/git/client/importer/page/GitImporterPagePresenter.java b/plugins/plugin-git/che-plugin-git-ext-git/src/main/java/org/eclipse/che/ide/ext/git/client/importer/page/GitImporterPagePresenter.java
@@ -101,6 +101,15 @@ public void projectUrlChanged(@NotNull String url) {
         updateDelegate.updateControls();
     }
 
+    @Override
+    public void onRecursiveSelected(boolean recursiveSelected) {
+        if (recursiveSelected) {
+            projectParameters().put("recursive", null);
+        } else {
+            projectParameters().remove("recursive");
+        }
+    }
+
     @Override
     public void projectDescriptionChanged(@NotNull String projectDescription) {
         dataObject.setDescription(projectDescription);
diff --git a/plugins/plugin-git/che-plugin-git-ext-git/src/main/java/org/eclipse/che/ide/ext/git/client/importer/page/GitImporterPageView.java b/plugins/plugin-git/che-plugin-git-ext-git/src/main/java/org/eclipse/che/ide/ext/git/client/importer/page/GitImporterPageView.java
@@ -28,6 +28,9 @@ interface ActionDelegate {
         /** Performs any actions appropriate in response to the user having changed the project's URL. */
         void projectUrlChanged(@NotNull String url);
 
+        /** Performs any actions appropriate in response to the user has selected recursive checkbox. */
+        void onRecursiveSelected(boolean recursiveSelected);
+
         /** Performs any actions appropriate in response to the user having changed the project's description. */
         void projectDescriptionChanged(@NotNull String projectDescriptionValue);
 
diff --git a/plugins/plugin-git/che-plugin-git-ext-git/src/main/java/org/eclipse/che/ide/ext/git/client/importer/page/GitImporterPageViewImpl.java b/plugins/plugin-git/che-plugin-git-ext-git/src/main/java/org/eclipse/che/ide/ext/git/client/importer/page/GitImporterPageViewImpl.java
@@ -51,6 +51,9 @@ public class GitImporterPageViewImpl extends Composite implements GitImporterPag
     @UiField
     TextBox     projectUrl;
 
+    @UiField
+    CheckBox    recursive;
+
     @UiField
     FlowPanel   importerPanel;
 
@@ -100,6 +103,11 @@ void onProjectUrlChanged(KeyUpEvent event) {
         delegate.projectUrlChanged(projectUrl.getValue());
     }
 
+    @UiHandler("recursive")
+    void recursiveHandler(ValueChangeEvent<Boolean> event) {
+        delegate.onRecursiveSelected(event.getValue());
+    }
+
     @UiHandler("projectDescription")
     void onProjectDescriptionChanged(KeyUpEvent event) {
         if (event.getNativeKeyCode() == KeyCodes.KEY_ENTER) {
diff --git a/plugins/plugin-git/che-plugin-git-ext-git/src/main/java/org/eclipse/che/ide/ext/git/client/importer/page/GitImporterPageViewImpl.ui.xml b/plugins/plugin-git/che-plugin-git-ext-git/src/main/java/org/eclipse/che/ide/ext/git/client/importer/page/GitImporterPageViewImpl.ui.xml
@@ -25,6 +25,10 @@
                                debugId="file-importProject-projectUrl"/>
                     <g:Label ui:field="labelUrlError" width="100%" wordWrap="true" addStyleNames="{style.labelErrorPosition}"/>
                 </g:FlowPanel>
+                <g:FlowPanel height="20px" addStyleNames="{style.namePanel}">
+                    <g:CheckBox ui:field="recursive" text="{locale.gitImporterPageRecursive}"
+                                debugId="file-importProject-recursive" addStyleNames="{style.alignLeft}" />
+                </g:FlowPanel>
                 <g:FlowPanel height="0" addStyleNames="{style.horizontalLine}"/>
                 <g:FlowPanel height="35px" addStyleNames="{style.namePanel}">
                     <g:Label text="{locale.gitImporterPageProjectInfo}" addStyleNames="{style.label}"/>
@@ -45,7 +49,7 @@
                                 tabIndex="5"/>
                 </g:FlowPanel>
 
-                <g:FlowPanel height="25px" addStyleNames="{style.namePanel}">
+                <g:FlowPanel height="20px" addStyleNames="{style.namePanel}">
                         <g:CheckBox ui:field="keepDirectory" text="{locale.gitImporterPageKeepDirectory}"
                                     debugId="file-importProject-keepDirectory" addStyleNames="{style.alignLeft}" />
                 </g:FlowPanel>
@@ -56,7 +60,7 @@
                                tabIndex="9" debugId="file-importProject-keepDirectoryName" title="{locale.gitImporterPageBranchField}"/>
                 </g:FlowPanel>
 
-                <g:FlowPanel height="25px" addStyleNames="{style.namePanel}">
+                <g:FlowPanel height="20px" addStyleNames="{style.namePanel}">
                     <g:CheckBox ui:field="branchSelection" text="{locale.gitImporterPageBranch}"
                                 debugId="file-importProject-branch" addStyleNames="{style.alignLeft}" />
                 </g:FlowPanel>
diff --git a/plugins/plugin-git/che-plugin-git-ext-git/src/main/resources/org/eclipse/che/ide/ext/git/client/GitLocalizationConstant.properties b/plugins/plugin-git/che-plugin-git-ext-git/src/main/resources/org/eclipse/che/ide/ext/git/client/GitLocalizationConstant.properties
@@ -96,6 +96,7 @@ importProject.messageStartWithWhiteSpace = The url can not start with a whitespa
 #GitImporterPage
 view.import.gitImporterPage.projectUrl = URL:
 view.import.gitImporterPage.projectInfo = Project Information
+view.import.gitImporterPage.recursive = Import recursively (for multi-module projects)
 view.import.gitImporterPage.projectName = Name:
 view.import.gitImporterPageProjectNamePrompt = Define the name of your project...
 view.import.gitImporterPage.projectDescription = Description:
diff --git a/plugins/plugin-git/che-plugin-git-ext-git/src/test/java/org/eclipse/che/ide/ext/git/client/importer/page/GitImporterPagePresenterTest.java b/plugins/plugin-git/che-plugin-git-ext-git/src/test/java/org/eclipse/che/ide/ext/git/client/importer/page/GitImporterPagePresenterTest.java
@@ -342,6 +342,28 @@ public void directoryNameEnteredTest() {
         verify(view).highlightDirectoryNameField(false);
     }
 
+    @Test
+    public void recursiveCloneSelectedTest() {
+        Map<String, String> parameters = new HashMap<>();
+        when(source.getParameters()).thenReturn(parameters);
+        when(view.getDirectoryName()).thenReturn("recursive");
+
+        presenter.onRecursiveSelected(true);
+
+        assertTrue(parameters.containsKey("recursive"));
+    }
+
+    @Test
+    public void recursiveCloneUnSelectedTest() {
+        Map<String, String> parameters = new HashMap<>();
+        parameters.put("recursive", null);
+        when(source.getParameters()).thenReturn(parameters);
+
+        presenter.onRecursiveSelected(false);
+
+        assertTrue(parameters.isEmpty());
+    }
+
     private void verifyInvocationsForCorrectUrl(String correctUrl) {
         verify(view, never()).markURLInvalid();
         verify(source).setLocation(eq(correctUrl));
diff --git a/plugins/plugin-github/che-plugin-github-ide/src/main/java/org/eclipse/che/plugin/github/ide/GitHubLocalizationConstant.java b/plugins/plugin-github/che-plugin-github-ide/src/main/java/org/eclipse/che/plugin/github/ide/GitHubLocalizationConstant.java
@@ -70,6 +70,9 @@ public interface GitHubLocalizationConstant extends Messages {
     @Key("view.import.githubImporterPage.projectUrl")
     String githubImporterPageProjectUrl();
 
+    @Key("view.import.githubImporterPage.recursive")
+    String githubImporterPageRecursive();
+
     @Key("view.import.githubImporterPage.projectInfo")
     String githubImporterPageProjectInfo();
 
diff --git a/plugins/plugin-github/che-plugin-github-ide/src/main/java/org/eclipse/che/plugin/github/ide/importer/page/GithubImporterPagePresenter.java b/plugins/plugin-github/che-plugin-github-ide/src/main/java/org/eclipse/che/plugin/github/ide/importer/page/GithubImporterPagePresenter.java
@@ -144,6 +144,15 @@ public void projectUrlChanged(@NotNull String url) {
         updateDelegate.updateControls();
     }
 
+    @Override
+    public void onRecursiveSelected(boolean recursiveSelected) {
+        if (recursiveSelected) {
+            projectParameters().put("recursive", null);
+        } else {
+            projectParameters().remove("recursive");
+        }
+    }
+
     @Override
     public void projectDescriptionChanged(@NotNull String projectDescription) {
         dataObject.setDescription(projectDescription);
diff --git a/plugins/plugin-github/che-plugin-github-ide/src/main/java/org/eclipse/che/plugin/github/ide/importer/page/GithubImporterPageView.java b/plugins/plugin-github/che-plugin-github-ide/src/main/java/org/eclipse/che/plugin/github/ide/importer/page/GithubImporterPageView.java
@@ -36,6 +36,9 @@ interface ActionDelegate {
          */
         void projectUrlChanged(@NotNull String url);
 
+        /** Performs any actions appropriate in response to the user has selected recursive checkbox. */
+        void onRecursiveSelected(boolean recursiveSelected);
+
         /**
          * Performs any actions appropriate in response to the user having changed the project's description.
          */
diff --git a/plugins/plugin-github/che-plugin-github-ide/src/main/java/org/eclipse/che/plugin/github/ide/importer/page/GithubImporterPageViewImpl.java b/plugins/plugin-github/che-plugin-github-ide/src/main/java/org/eclipse/che/plugin/github/ide/importer/page/GithubImporterPageViewImpl.java
@@ -77,6 +77,9 @@ interface GithubImporterPageViewImplUiBinder extends UiBinder<DockLayoutPanel, G
     @UiField
     TextBox projectUrl;
 
+    @UiField
+    CheckBox recursive;
+
     @UiField
     FlowPanel bottomPanel;
 
@@ -200,6 +203,11 @@ void onProjectUrlChanged(KeyUpEvent event) {
         delegate.projectUrlChanged(projectUrl.getValue());
     }
 
+    @UiHandler("recursive")
+    void recursiveHandler(ValueChangeEvent<Boolean> event) {
+        delegate.onRecursiveSelected(event.getValue());
+    }
+
     @UiHandler("projectDescription")
     void onProjectDescriptionChanged(KeyUpEvent event) {
         if (event.getNativeKeyCode() == KeyCodes.KEY_ENTER) {
diff --git a/plugins/plugin-github/che-plugin-github-ide/src/main/java/org/eclipse/che/plugin/github/ide/importer/page/GithubImporterPageViewImpl.ui.xml b/plugins/plugin-github/che-plugin-github-ide/src/main/java/org/eclipse/che/plugin/github/ide/importer/page/GithubImporterPageViewImpl.ui.xml
@@ -28,6 +28,10 @@
                                debugId="file-importProject-projectUrl"/>
                     <g:Label ui:field="labelUrlError" width="100%" wordWrap="true" addStyleNames="{style.labelErrorPosition}"/>
                 </g:FlowPanel>
+                <g:FlowPanel height="20px" addStyleNames="{style.namePanel}">
+                    <g:CheckBox ui:field="recursive" text="{locale.githubImporterPageRecursive}"
+                                debugId="file-importProject-recursive" addStyleNames="{style.alignLeft}" />
+                </g:FlowPanel>
                 <g:FlowPanel height="0" addStyleNames="{style.horizontalLine}"/>
                 <g:FlowPanel height="35px" addStyleNames="{style.namePanel}">
                     <g:Label text="{locale.githubImporterPageProjectInfo}" addStyleNames="{style.label}"/>
@@ -47,7 +51,7 @@
                                 debugId="file-importProject-projectDescription" title="{locale.githubImporterPageProjectDescriptionPrompt}"
                                 tabIndex="5"/>
                 </g:FlowPanel>
-                <g:FlowPanel height="25px" addStyleNames="{style.namePanel}">
+                <g:FlowPanel height="20px" addStyleNames="{style.namePanel}">
                     <g:CheckBox ui:field="keepDirectory" text="{locale.githubImporterPageKeepDirectory}"
                                 debugId="file-importProject-keepDirectory" addStyleNames="{style.alignLeft}" />
                 </g:FlowPanel>
diff --git a/plugins/plugin-github/che-plugin-github-ide/src/main/resources/org/eclipse/che/plugin/github/ide/GitHubLocalizationConstant.properties b/plugins/plugin-github/che-plugin-github-ide/src/main/resources/org/eclipse/che/plugin/github/ide/GitHubLocalizationConstant.properties
@@ -31,6 +31,7 @@ importProject.message.protocolIncorrect = The transport protocol or url syntax i
 importProject.message.startWithWhiteSpace = The url can not start with a whitespace.
 #GithubImporterPage
 view.import.githubImporterPage.projectUrl = URL:
+view.import.githubImporterPage.recursive = Import recursively (for multi-module projects)
 view.import.githubImporterPage.projectInfo = Project Information
 view.import.githubImporterPage.projectName = Name:
 view.import.githubImporterPageProjectNamePrompt = Define the name of your project...
diff --git a/plugins/plugin-github/che-plugin-github-ide/src/test/java/org/eclipse/che/plugin/github/ide/importer/page/GithubImporterPagePresenterTest.java b/plugins/plugin-github/che-plugin-github-ide/src/test/java/org/eclipse/che/plugin/github/ide/importer/page/GithubImporterPagePresenterTest.java
@@ -423,6 +423,28 @@ public void keepDirectoryUnSelectedTest() {
         verify(view).highlightDirectoryNameField(eq(false));
     }
 
+    @Test
+    public void recursiveCloneSelectedTest() {
+        Map<String, String> parameters = new HashMap<>();
+        when(source.getParameters()).thenReturn(parameters);
+        when(view.getDirectoryName()).thenReturn("recursive");
+
+        presenter.onRecursiveSelected(true);
+
+        assertTrue(parameters.containsKey("recursive"));
+    }
+
+    @Test
+    public void recursiveCloneUnSelectedTest() {
+        Map<String, String> parameters = new HashMap<>();
+        parameters.put("recursive", null);
+        when(source.getParameters()).thenReturn(parameters);
+
+        presenter.onRecursiveSelected(false);
+
+        assertTrue(parameters.isEmpty());
+    }
+
     @Test
     public void keepDirectoryNameChangedAndKeepDirectorySelectedTest() {
         Map<String, String> parameters = new HashMap<>();
diff --git a/wsagent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/CloneRequest.java b/wsagent/che-core-api-git-shared/src/main/java/org/eclipse/che/api/git/shared/CloneRequest.java
@@ -49,6 +49,13 @@ public interface CloneRequest extends GitRequest {
     
     CloneRequest withRemoteName(String remoteName);
 
+    /** @return true if 'Recursive' parameter enabled */
+    boolean isRecursive();
+
+    void setRecursive(boolean recursive);
+
+    CloneRequest withRecursive(boolean recursive);
+
     /**
      * @return time (in seconds) to wait without data transfer occurring before aborting fetching data from remote repository. If 0 then
      *         default timeout may be used. This is implementation specific
@@ -58,4 +65,4 @@ public interface CloneRequest extends GitRequest {
     void setTimeout(int timeout);
     
     CloneRequest withTimeout(int timeout);
-}
+}
diff --git a/wsagent/che-core-api-git/src/main/java/org/eclipse/che/api/git/GitProjectImporter.java b/wsagent/che-core-api-git/src/main/java/org/eclipse/che/api/git/GitProjectImporter.java
@@ -19,7 +19,6 @@
 import org.eclipse.che.api.core.UnauthorizedException;
 import org.eclipse.che.api.core.model.project.SourceStorage;
 import org.eclipse.che.api.core.notification.EventService;
-import org.eclipse.che.api.core.util.FileCleaner;
 import org.eclipse.che.api.core.util.LineConsumerFactory;
 import org.eclipse.che.api.git.shared.Branch;
 import org.eclipse.che.api.git.shared.BranchListRequest;
@@ -36,12 +35,9 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.io.BufferedWriter;
 import java.io.File;
 import java.io.IOException;
 import java.net.URISyntaxException;
-import java.nio.charset.Charset;
-import java.nio.file.Files;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
@@ -123,6 +119,7 @@ public void importSources(FolderEntry baseFolder,
             // Delete vcs info if false.
             String branchMerge = null;
             boolean keepVcs = true;
+            boolean recursiveEnabled = false;
 
             Map<String, String> parameters = storage.getParameters();
             if (parameters != null) {
@@ -134,6 +131,9 @@ public void importSources(FolderEntry baseFolder,
                 if (parameters.containsKey("keepVcs")) {
                     keepVcs = Boolean.parseBoolean(parameters.get("keepVcs"));
                 }
+                if (parameters.containsKey("recursive")) {
+                    recursiveEnabled = true;
+                }
                 branchMerge = parameters.get("branchMerge");
             }
             // Get path to local file. Git works with local filesystem only.
@@ -146,7 +146,7 @@ public void importSources(FolderEntry baseFolder,
                 git.cloneWithSparseCheckout(keepDir, location, branch == null ? "master" : branch);
             } else {
                 if (baseFolder.getChildren().size() == 0) {
-                    cloneRepository(git, "origin", location, dtoFactory);
+                    cloneRepository(git, "origin", location, dtoFactory, recursiveEnabled);
                     if (commitId != null) {
                         checkoutCommit(git, commitId, dtoFactory);
                     } else if (fetch != null) {
@@ -198,9 +198,12 @@ public void importSources(FolderEntry baseFolder,
         }
     }
 
-    private void cloneRepository(GitConnection git, String remoteName, String url, DtoFactory dtoFactory)
+    private void cloneRepository(GitConnection git, String remoteName, String url, DtoFactory dtoFactory, boolean recursiveEnabled)
             throws ServerException, UnauthorizedException, URISyntaxException {
-        final CloneRequest request = dtoFactory.createDto(CloneRequest.class).withRemoteName(remoteName).withRemoteUri(url);
+        final CloneRequest request = dtoFactory.createDto(CloneRequest.class)
+                                               .withRemoteName(remoteName)
+                                               .withRemoteUri(url)
+                                               .withRecursive(recursiveEnabled);
         git.clone(request);
     }
 
diff --git a/wsagent/che-core-git-impl-jgit/src/main/java/org/eclipse/che/git/impl/jgit/JGitConnection.java b/wsagent/che-core-git-impl-jgit/src/main/java/org/eclipse/che/git/impl/jgit/JGitConnection.java
@@ -454,6 +454,7 @@ public void clone(CloneRequest request) throws GitException, UnauthorizedExcepti
             CloneCommand cloneCommand = Git.cloneRepository()
                                            .setDirectory(new File(request.getWorkingDir()))
                                            .setRemote(request.getRemoteName())
+                                           .setCloneSubmodules(request.isRecursive())
                                            .setURI(remoteUri);
             if (request.getBranchesToFetch().isEmpty()) {
                 cloneCommand.setCloneAllBranches(true);
diff --git a/wsagent/che-core-git-impl-native/src/main/java/org/eclipse/che/git/impl/nativegit/NativeGitConnection.java b/wsagent/che-core-git-impl-native/src/main/java/org/eclipse/che/git/impl/nativegit/NativeGitConnection.java
@@ -314,6 +314,7 @@ public void clone(CloneRequest request) throws URISyntaxException, UnauthorizedE
         CloneCommand clone = nativeGit.createCloneCommand();
         clone.setRemoteUri(remoteUri);
         clone.setRemoteName(request.getRemoteName());
+        clone.setRecursiveEnabled(request.isRecursive());
         if (clone.getTimeout() > 0) {
             clone.setTimeout(request.getTimeout());
         }
diff --git a/wsagent/che-core-git-impl-native/src/main/java/org/eclipse/che/git/impl/nativegit/commands/CloneCommand.java b/wsagent/che-core-git-impl-native/src/main/java/org/eclipse/che/git/impl/nativegit/commands/CloneCommand.java
@@ -25,6 +25,7 @@
 public class CloneCommand extends RemoteOperationCommand<Void> {
 
     private String remoteName;
+    private boolean recursiveEnabled;
 
     public CloneCommand(File repository, SshScriptProvider sshScriptProvider, CredentialsLoader credentialsLoader, GitAskPassScript gitAskPassScript) {
         super(repository, sshScriptProvider, credentialsLoader, gitAskPassScript);
@@ -38,6 +39,9 @@ public Void execute() throws GitException {
         if (remoteName != null) {
             commandLine.add("--origin", remoteName);
         } //else default origin name
+        if (recursiveEnabled) {
+            commandLine.add("--recursive");
+        }
         commandLine.add(getRemoteUri(), getRepository().getAbsolutePath());
         // Progress not shown if not a terminal. Activating progress output. See git clone man page.
         commandLine.add("--progress");
@@ -54,4 +58,14 @@ public CloneCommand setRemoteName(String remoteName) {
         this.remoteName = remoteName;
         return this;
     }
+
+    /**
+     * @param recursiveEnabled
+     *         returnes true if 'recursive' parameter enabled
+     * @return CloneCommand with established 'recursive' parameter
+     */
+    public CloneCommand setRecursiveEnabled(boolean recursiveEnabled) {
+        this.recursiveEnabled = recursiveEnabled;
+        return this;
+    }
 }
