Prepare exec projects (#1686)

* use getByName() in prepareExec()
fixes #1680

Author: Vladimir Kotal

src/org/opensolaris/opengrok/web/PageConfig.java

@@ -757,7 +757,7 @@ public String getRequestedProjectsAsString() {
      * NOTE: This method assumes, that project names do <b>not</b> contain a
      * comma (','), since this character is used as name separator!
      *
-     * @return a possible empty set of project names aka descriptions but never
+     * @return a possible empty set of project names but never
      * {@code null}. It is determined as follows: <ol> <li>If there is no
      * project in the runtime environment (RTE) an empty set is returned.
      * Otherwise:</li> <li>If there is only one project in the RTE, this one
@@ -844,7 +844,7 @@ private List<String> getParamVals(String paramName) {
      * contains the project list in question.
      * @param cookieName name of the cookie which possible contains project
      * lists used as fallback
-     * @return a possible empty set but never {@code null}.
+     * @return set of project names. Possibly empty set but never {@code null}.
      */
     protected SortedSet<String> getRequestedProjects(String paramName,
             String cookieName) {

src/org/opensolaris/opengrok/web/SearchHelper.java

@@ -232,9 +232,11 @@ public static Set<Map.Entry<String, String>> getFileTypeDescriptions() {
      * <li>{@link #projects}</li> <li>{@link #errorMsg} if an error occurs</li>
      * </ul>
      *
-     * @param projects project paths. If empty, a no-project setup
+     * @param projects project names. If empty, a no-project setup
      * is assumed (i.e. DATA_ROOT/index will be used instead of possible
-     * multiple DATA_ROOT/$project/index).
+     * multiple DATA_ROOT/$project/index). If the set contains projects
+     * not known in the configuration or projects not yet indexed,
+     * an error will be returned in {@link #errorMsg}.
      * @return this instance
      */
     public SearchHelper prepareExec(SortedSet<String> projects) {
@@ -261,7 +263,7 @@ public SearchHelper prepareExec(SortedSet<String> projects) {
                 // are valid and indexed.
                 closeOnDestroy = false;
                 Set <Project> projectSet = projects.stream().
-                    map(x -> Project.getProject(x)).collect(Collectors.toSet());
+                    map(x -> Project.getByName(x)).collect(Collectors.toSet());
                 if (projectSet.contains(null)) {
                     errorMsg = "Project list contains invalid projects";
                     return this;

test/org/opensolaris/opengrok/web/SearchHelperTest.java

@@ -103,7 +103,7 @@ private SearchHelper getSearchHelper(String searchTerm) {
 
     @Test
     public void testSearchAfterReindex() {
-        SortedSet<String> projects = new TreeSet<>();
+        SortedSet<String> projectNames = new TreeSet<>();
         SearchHelper searchHelper;
 
         env.setProjectsEnabled(true);
@@ -121,19 +121,19 @@ public void testSearchAfterReindex() {
         }
 
         // Search for existing term in single project.
-        projects.add("/c");
+        projectNames.add("c");
         searchHelper = this.getSearchHelper("foobar")
-            .prepareExec(projects).executeQuery().prepareSummary();
+            .prepareExec(projectNames).executeQuery().prepareSummary();
         Assert.assertNull(searchHelper.errorMsg);
         System.out.println("single project search returned " +
             Integer.toString(searchHelper.totalHits) + " hits");
         Assert.assertEquals(4, searchHelper.totalHits);
         searchHelper.destroy();
 
         // Search for existing term in multiple projects.
-        projects.add("/document");
+        projectNames.add("document");
         searchHelper = this.getSearchHelper("foobar")
-            .prepareExec(projects).executeQuery().prepareSummary();
+            .prepareExec(projectNames).executeQuery().prepareSummary();
         Assert.assertNull(searchHelper.errorMsg);
         System.out.println("multi-project search returned " +
             Integer.toString(searchHelper.totalHits) + " hits");
@@ -142,7 +142,7 @@ public void testSearchAfterReindex() {
 
         // Search for non-existing term.
         searchHelper = this.getSearchHelper("CannotExistAnywhereForSure")
-            .prepareExec(projects).executeQuery().prepareSummary();
+            .prepareExec(projectNames).executeQuery().prepareSummary();
         Assert.assertNull(searchHelper.errorMsg);
         System.out.println("multi-project search for non-existing term returned " +
             Integer.toString(searchHelper.totalHits) + " hits");
@@ -163,7 +163,7 @@ public void testSearchAfterReindex() {
         }
         env.maybeRefreshIndexSearchers();
         searchHelper = this.getSearchHelper("foobar")
-            .prepareExec(projects).executeQuery().prepareSummary();
+            .prepareExec(projectNames).executeQuery().prepareSummary();
         Assert.assertNull(searchHelper.errorMsg);
         System.out.println("multi-project search after reindex returned " +
             Integer.toString(searchHelper.totalHits) + " hits");
@@ -174,7 +174,7 @@ public void testSearchAfterReindex() {
 
     @Test
     public void testPrepareExecInvalidInput() {
-        SortedSet<String> projects = new TreeSet<>();
+        SortedSet<String> projectNames = new TreeSet<>();
         SearchHelper searchHelper;
 
         env.setProjectsEnabled(true);
@@ -183,12 +183,19 @@ public void testPrepareExecInvalidInput() {
         Project project = new Project("c", "/c");
         env.getProjects().put("c", project);
 
+        // Try to prepare search for project that is not yet indexed.
+        projectNames.add("c");
+        searchHelper = this.getSearchHelper("foobar")
+            .prepareExec(projectNames);
+        Assert.assertNotNull(searchHelper.errorMsg);
+        Assert.assertTrue(searchHelper.errorMsg.contains("not indexed"));
+
         // Try to prepare search for list that contains non-existing project.
-        projects.add("/c");
-        projects.add("/foobar");
+        projectNames.add("totally_nonexistent_project");
         searchHelper = this.getSearchHelper("foobar")
-            .prepareExec(projects);
-        Assert.assertTrue(searchHelper.errorMsg != null);
+            .prepareExec(projectNames);
+        Assert.assertNotNull(searchHelper.errorMsg);
+        Assert.assertTrue(searchHelper.errorMsg.contains("invalid projects"));
     }
 
     /**