Add full controller test coverage

Author: Mark Robinson

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

@@ -156,6 +156,9 @@ public ModelAndView getWorkflowByGithubDetails(@Value("${applicationURL}") Strin
             if (!errors.hasErrors()) {
                 if (githubDetails.getPath().endsWith(".cwl")) {
                     workflowModel = workflowService.createWorkflow(githubDetails);
+                    if (workflowModel == null) {
+                        errors.rejectValue("githubURL", "githubURL.parsingError", "The workflow could not be parsed from the given URL");
+                    }
                 } else {
                     // If this is a directory, get a list of workflows and return the view for it
                     try {

src/test/java/org/commonwl/view/PageControllerTest.java

@@ -56,12 +56,12 @@ public void homePage() throws Exception {
      */
     @Test
     public void homePageWithURL() throws Exception {
-        mockMvc.perform(get("/").param("url", "https://github.com/test/repo"))
+        mockMvc.perform(get("/").param("url", "https://github.com/test/default/link"))
                 .andExpect(status().isOk())
                 .andExpect(view().name("index"))
                 .andExpect(model().attributeExists("workflowForm"))
                 .andExpect(model().attribute("workflowForm",
-                        hasProperty("githubURL", is("https://github.com/test/repo"))));
+                        hasProperty("githubURL", is("https://github.com/test/default/link"))));
     }
 
 }

src/test/java/org/commonwl/view/workflow/WorkflowControllerTest.java

@@ -25,17 +25,34 @@
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.TemporaryFolder;
+import org.junit.runner.RunWith;
+import org.mockito.Matchers;
 import org.mockito.Mockito;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.data.web.PageableHandlerMethodArgumentResolver;
+import org.springframework.test.context.junit4.SpringRunner;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+import org.springframework.web.servlet.view.InternalResourceViewResolver;
 
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+
+import static org.hamcrest.Matchers.*;
+import static org.hamcrest.core.Is.is;
 import static org.mockito.Matchers.anyObject;
 import static org.mockito.Matchers.anyString;
 import static org.mockito.Mockito.when;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
 
+/**
+ * Tests the controller for workflow related functionality
+ */
+@RunWith(SpringRunner.class)
+@SpringBootTest
 public class WorkflowControllerTest {
 
     /**
@@ -44,6 +61,38 @@ public class WorkflowControllerTest {
     @Rule
     public TemporaryFolder roBundleFolder = new TemporaryFolder();
 
+    /**
+     * Get the full list of workflows
+     * TODO: Mock the repository and test model attributes
+     */
+    @Test
+    public void getListOfWorkflows() throws Exception {
+
+        // Mock controller/MVC
+        WorkflowController workflowController = new WorkflowController(
+                Mockito.mock(WorkflowFormValidator.class),
+                Mockito.mock(WorkflowService.class),
+                Mockito.mock(GraphVizService.class));
+
+        // Lots of hassle to make Spring Data Pageable work
+        PageableHandlerMethodArgumentResolver pageableArgumentResolver =
+                new PageableHandlerMethodArgumentResolver();
+        InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
+        viewResolver.setPrefix("/src/main/resources/templates");
+        viewResolver.setSuffix(".html");
+        MockMvc mockMvc = MockMvcBuilders
+                .standaloneSetup(workflowController)
+                .setCustomArgumentResolvers(pageableArgumentResolver)
+                .setViewResolvers(viewResolver)
+                .build();
+
+        // Simple test to check the view
+        mockMvc.perform(get("/workflows"))
+                .andExpect(status().isOk())
+                .andExpect(view().name("workflows"));
+
+    }
+
     /**
      * Endpoint for main form submission
      */
@@ -104,14 +153,70 @@ public void newWorkflowFromGithubURL() throws Exception {
     }
 
     /**
-     * Endpoint for displaying workflows and directories of workflows
+     * Displaying workflows
      */
     @Test
-    public void getWorkflowByGithubDetails() throws Exception {
+    public void directWorkflowURL() throws Exception {
 
-        // Mock service to return a bundle file and then throw ROBundleNotFoundException
+        Workflow mockWorkflow = Mockito.mock(Workflow.class);
+        Workflow mockWorkflow2 = Mockito.mock(Workflow.class);
+
+        // Mock service
         WorkflowService mockWorkflowService = Mockito.mock(WorkflowService.class);
+        when(mockWorkflowService.getWorkflow(Matchers.<GithubDetails>anyObject()))
+                .thenReturn(mockWorkflow)
+                .thenReturn(null);
+        when(mockWorkflowService.createWorkflow(anyObject()))
+                .thenReturn(mockWorkflow2)
+                .thenReturn(null);
+
+        // Mock controller/MVC
+        WorkflowController workflowController = new WorkflowController(
+                Mockito.mock(WorkflowFormValidator.class),
+                mockWorkflowService,
+                Mockito.mock(GraphVizService.class));
+        MockMvc mockMvc = MockMvcBuilders
+                .standaloneSetup(workflowController)
+                .build();
 
+        // Workflow already exists in the database
+        mockMvc.perform(get("/workflows/github.com/owner/reponame/tree/branch/path/within/workflow.cwl"))
+                .andExpect(status().isOk())
+                .andExpect(view().name("workflow"))
+                .andExpect(model().attribute("workflow", is(mockWorkflow)));
+
+        // Workflow needs to be created
+        mockMvc.perform(get("/workflows/github.com/owner/reponame/tree/branch/path/within/workflow.cwl"))
+                .andExpect(status().isOk())
+                .andExpect(view().name("workflow"))
+                .andExpect(model().attribute("workflow", is(mockWorkflow2)));
+
+        // Error creating workflow
+        mockMvc.perform(get("/workflows/github.com/owner/reponame/tree/branch/path/within/badworkflow.cwl"))
+                .andExpect(status().isFound())
+                .andExpect(flash().attributeExists("errors"))
+                .andExpect(redirectedUrl("/?url=https://github.com/owner/reponame/tree/branch/path/within/badworkflow.cwl"));
+
+    }
+
+    /**
+     * Displaying directories of workflows
+     */
+    @Test
+    public void directDirectoryURL() throws Exception {
+
+        // Workflow overviews for testing
+        WorkflowOverview overview1 = new WorkflowOverview("workflow1.cwl", "label1", "doc1");
+        WorkflowOverview overview2 = new WorkflowOverview("workflow2.cwl", "label2", "doc2");
+
+        // Mock service to return these overviews
+        WorkflowService mockWorkflowService = Mockito.mock(WorkflowService.class);
+        when(mockWorkflowService.getWorkflowsFromDirectory(anyObject()))
+                .thenReturn(new ArrayList<>())
+                .thenReturn(new ArrayList<>(Arrays.asList(overview1)))
+                .thenReturn(new ArrayList<>(Arrays.asList(overview1, overview2)))
+                .thenReturn(new ArrayList<>(Arrays.asList(overview1, overview2)))
+                .thenThrow(new IOException("Error getting contents"));
 
         // Mock controller/MVC
         WorkflowController workflowController = new WorkflowController(
@@ -122,9 +227,41 @@ public void getWorkflowByGithubDetails() throws Exception {
                 .standaloneSetup(workflowController)
                 .build();
 
-        // Redirect with error
+        // No workflows in directory, redirect with errors
+        mockMvc.perform(get("/workflows/github.com/owner/reponame/tree/branch/path/within"))
+                .andExpect(status().isFound())
+                .andExpect(flash().attributeExists("errors"))
+                .andExpect(redirectedUrl("/?url=https://github.com/owner/reponame/tree/branch/path/within"));
+
+        // 1 workflow in directory, redirect to it
+        mockMvc.perform(get("/workflows/github.com/common-workflow-language/workflows/tree/master/workflows/lobSTR"))
+                .andExpect(status().isFound())
+                .andExpect(redirectedUrl("/workflows/github.com/common-workflow-language/workflows/tree/master/workflows/lobSTR/workflow1.cwl"));
+
+        // Multiple workflows in directory, show list
+        mockMvc.perform(get("/workflows/github.com/common-workflow-language/workflows/tree/visu/workflows/scidap"))
+                .andExpect(status().isOk())
+                .andExpect(view().name("selectworkflow"))
+                .andExpect(model().attribute("githubDetails", allOf(
+                        hasProperty("owner", is("common-workflow-language")),
+                        hasProperty("repoName", is("workflows")),
+                        hasProperty("branch", is("visu")),
+                        hasProperty("path", is("workflows/scidap"))
+                )))
+                .andExpect(model().attribute("workflowOverviews",
+                        containsInAnyOrder(overview1, overview2)));
+
+        // Workflows at the base of a repository
+        mockMvc.perform(get("/workflows/github.com/genome/arvados_trial/tree/master"))
+                .andExpect(status().isOk())
+                .andExpect(view().name("selectworkflow"))
+                .andExpect(model().attribute("githubDetails",
+                        hasProperty("path", is("/"))));
+
+        // Error getting contents of Github directory, redirect with errors
         mockMvc.perform(get("/workflows/github.com/owner/reponame/tree/branch/path/within"))
                 .andExpect(status().isFound())
+                .andExpect(flash().attributeExists("errors"))
                 .andExpect(redirectedUrl("/?url=https://github.com/owner/reponame/tree/branch/path/within"));
 
     }