Merge pull request #144 from common-workflow-language/nosupport-ssh

Clarify lack of support for SSH

Author: stain

src/main/java/org/commonwl/view/workflow/WorkflowController.java

@@ -24,6 +24,7 @@
 import org.commonwl.view.git.GitDetails;
 import org.commonwl.view.graphviz.GraphVizService;
 import org.eclipse.jgit.api.errors.GitAPIException;
+import org.eclipse.jgit.api.errors.TransportException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -120,6 +121,9 @@ public ModelAndView createWorkflow(@Valid WorkflowForm workflowForm, BindingResu
             if (workflow == null) {
                 try {
                     workflow = workflowService.createQueuedWorkflow(gitInfo).getTempRepresentation();
+                } catch (TransportException ex) {
+                    bindingResult.rejectValue("url", "git.sshError");
+                    return new ModelAndView("index");
                 } catch (GitAPIException ex) {
                     bindingResult.rejectValue("url", "git.retrievalError");
                     logger.error("Git API Error", ex);
@@ -450,9 +454,10 @@ private ModelAndView getWorkflow(GitDetails gitDetails, RedirectAttributes redir
                 if (!errors.hasErrors()) {
                     try {
                         queued = workflowService.createQueuedWorkflow(gitDetails);
+                    } catch (TransportException ex) {
+                        errors.rejectValue("url", "git.sshError", "SSH URLs are not supported, please provide a HTTPS URL for the repository or submodules");
                     } catch (GitAPIException ex) {
                         errors.rejectValue("url", "git.retrievalError", "The workflow could not be retrieved from the Git repository using the details given");
-                        logger.error("Git API Error", ex);
                     } catch (WorkflowNotFoundException ex) {
                         errors.rejectValue("url", "git.pathTraversal", "The path given did not resolve to a location within the repository");
                     } catch (IOException ex) {

src/main/resources/messages.properties

@@ -4,5 +4,6 @@ path.emptyOrWhitespace = You must provide a path to the workflow within the repo
 
 git.retrievalError = The workflow could not be retrieved from the Git repository using the details given
 git.pathTraversal = The path given did not resolve to a location within the repository
+git.sshError = SSH URLs are not supported, please provide a HTTPS URL for the repository or submodules
 
 url.parsingError = An unexpected error occurred when parsing the workflow

src/main/resources/static/js/main.js

@@ -79,17 +79,22 @@ require(['jquery'],
             var pathPattern = new RegExp("^\\/?([^\\/]*\\/)*[^\\/]+\\.cwl$");
             var input = $("#url").val();
             if (gitPattern.test(input)) {
-                var success = true;
-                if (!$("#branch").val()) {
-                    addWarning("branch", "You must provide a branch name for the workflow");
-                    success = false;
-                }
-                if (!$("#path").val()) {
-                    addWarning("path", "You must provide a path to the workflow");
-                    success = false;
-                } else if (!pathPattern.test($("#path").val())) {
-                    addWarning("path", "Must be a valid path from the root to a .cwl workflow");
-                    success = false;
+                var success = false;
+                if (input.startsWith("ssh") || input.startsWith("git@")) {
+                    addWarning("url", "SSH is not supported as a protocol, please provide a HTTPS URL to clone");
+                } else {
+                    success = true;
+                    if (!$("#branch").val()) {
+                        addWarning("branch", "You must provide a branch name for the workflow");
+                        success = false;
+                    }
+                    if (!$("#path").val()) {
+                        addWarning("path", "You must provide a path to the workflow");
+                        success = false;
+                    } else if (!pathPattern.test($("#path").val())) {
+                        addWarning("path", "Must be a valid path from the root to a .cwl workflow");
+                        success = false;
+                    }
                 }
                 return success;
             } else if (!githubPattern.test(input) && !gitlabPattern.test(input)) {

src/main/resources/templates/about.html

@@ -187,6 +187,11 @@ <h2>Research Objects</h2>
                 (<a href="https://github.com/common-workflow-language/cwlviewer/issues/103">see Github issue</a>)</p>
             <p>We recommend that you keep all files in the containing folder for current use of CWL Viewer</p>
 
+            <h2>SSH Cloning</h2>
+            <p>SSH URLs are not able to be cloned or used as submodules due to the need for SSH keys to be set up.</p>
+            <p>We do not plan SSH support due to the impact on reproducibility from this being made a required
+            step to download the workflow.</p>
+
             <h2>Others</h2>
             <p>Other limitations or unimplemented features can be viewed
                 <a href="https://github.com/common-workflow-language/cwlviewer">on the Github issues page</a></p>