make username/password configurable on project/repository level

fixes #1946

Author: vladak

opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/Project.java

@@ -73,8 +73,7 @@ public class Project implements Comparable<Project>, Nameable, Serializable {
     private int tabSize;
 
     /**
-     * A flag if the navigate window should be opened by default when browsing
-     * the source code of this project.
+     * If navigate window should be opened by default when browsing the source code of this project.
      */
     private Boolean navigateWindowEnabled = null;
 
@@ -93,6 +92,9 @@ public class Project implements Comparable<Project>, Nameable, Serializable {
      */
     private Boolean mergeCommitsEnabled = null;
 
+    private String username = null;
+    private String password = null;
+
     /**
      * This marks the project as (not)ready before initial index is done. this
      * is to avoid all/multi-project searches referencing this project from
@@ -309,6 +311,22 @@ public void setHistoryBasedReindex(boolean flag) {
         this.historyBasedReindex = flag;
     }
 
+    public void setUsername(String username) {
+        this.username = username;
+    }
+
+    public String getUsername() {
+        return username;
+    }
+
+    public void setPassword(String password) {
+        this.password = password;
+    }
+
+    public String getPassword() {
+        return password;
+    }
+
     @VisibleForTesting
     public void clearProperties() {
         historyBasedReindex = null;

opengrok-indexer/src/main/java/org/opengrok/indexer/history/RepositoryInfo.java

@@ -81,6 +81,10 @@ public class RepositoryInfo implements Serializable {
     private boolean mergeCommitsEnabled;
     @DTOElement
     private boolean historyBasedReindex;
+    @DTOElement
+    private String username;
+    @DTOElement
+    private String password;
 
     /**
      * Empty constructor to support serialization.
@@ -102,6 +106,8 @@ public RepositoryInfo(RepositoryInfo orig) {
         this.handleRenamedFiles = orig.handleRenamedFiles;
         this.mergeCommitsEnabled = orig.mergeCommitsEnabled;
         this.historyBasedReindex = orig.historyBasedReindex;
+        this.username = orig.username;
+        this.password = orig.password;
     }
 
     /**
@@ -157,6 +163,14 @@ public void setHistoryEnabled(boolean flag) {
         this.historyEnabled = flag;
     }
 
+    public String getUsername() { return username; }
+
+    public void setUsername(String username) { this.username = username; }
+
+    public String getPassword() { return password; }
+
+    public void setPassword(String password) { this.password = password; }
+
     /**
      * @return relative path to source root
      */
@@ -331,6 +345,8 @@ public void fillFromProject() {
             setHandleRenamedFiles(proj.isHandleRenamedFiles());
             setMergeCommitsEnabled(proj.isMergeCommitsEnabled());
             setHistoryBasedReindex(proj.isHistoryBasedReindex());
+            setUsername(proj.getUsername());
+            setPassword(proj.getPassword());
         } else {
             RuntimeEnvironment env = RuntimeEnvironment.getInstance();
 
@@ -385,6 +401,17 @@ public String toString() {
             stringBuilder.append("merge=");
             stringBuilder.append(this.isMergeCommitsEnabled());
         }
+
+        stringBuilder.append(",");
+        if (getUsername() != null) {
+            stringBuilder.append("username:set");
+            stringBuilder.append(",");
+        }
+        if (getPassword() != null) {
+            stringBuilder.append("password:set");
+            stringBuilder.append(",");
+        }
+
         stringBuilder.append("}");
         return stringBuilder.toString();
     }

opengrok-indexer/src/main/java/org/opengrok/indexer/history/SubversionRepository.java

@@ -35,6 +35,7 @@
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
 
+import org.jetbrains.annotations.VisibleForTesting;
 import org.opengrok.indexer.configuration.CommandTimeoutType;
 import org.opengrok.indexer.configuration.RuntimeEnvironment;
 import org.opengrok.indexer.logger.LoggerFactory;
@@ -57,9 +58,6 @@ public class SubversionRepository extends Repository {
 
     private static final long serialVersionUID = 1L;
 
-    private static final String ENV_SVN_USERNAME = "OPENGROK_SUBVERSION_USERNAME";
-    private static final String ENV_SVN_PASSWORD = "OPENGROK_SUBVERSION_PASSWORD";
-
     /**
      * The property name used to obtain the client command for this repository.
      */
@@ -365,12 +363,12 @@ public boolean isWorking() {
         return working;
     }
 
-    private List<String> getAuthCommandLineParams() {
+    @VisibleForTesting
+    List<String> getAuthCommandLineParams() {
         List<String> result = new ArrayList<>();
-        String userName = System.getenv(ENV_SVN_USERNAME);
-        String password = System.getenv(ENV_SVN_PASSWORD);
-        if (userName != null && !userName.isEmpty() && password != null
-                && !password.isEmpty()) {
+        String userName = getUsername();
+        String password = getPassword();
+        if (userName != null && !userName.isEmpty() && password != null && !password.isEmpty()) {
             result.add("--username");
             result.add(userName);
             result.add("--password");

opengrok-indexer/src/test/java/org/opengrok/indexer/configuration/ProjectTest.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2008, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2008, 2022, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opengrok.indexer.configuration;
 
@@ -40,14 +40,14 @@
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
-public class ProjectTest {
+class ProjectTest {
 
     /**
      * Test that a {@code Project} instance can be encoded and decoded without
      * errors. Bug #3077.
      */
     @Test
-    public void testEncodeDecode() {
+    void testEncodeDecode() {
         // Create an exception listener to detect errors while encoding and
         // decoding
         final LinkedList<Exception> exceptions = new LinkedList<>();
@@ -83,7 +83,7 @@ public void testEncodeDecode() {
      * Test project matching.
      */
     @Test
-    public void testGetProject() {
+    void testGetProject() {
         // Create 2 projects, one being prefix of the other.
         Project foo = new Project("Project foo", "/foo");
         Project bar = new Project("Project foo-bar", "/foo-bar");
@@ -111,7 +111,7 @@ public void testGetProject() {
      * Test getProjectDescriptions().
      */
     @Test
-    public void testGetProjectDescriptions() {
+    void testGetProjectDescriptions() {
         // Create 2 projects.
         Project foo = new Project("foo", "/foo");
         Project bar = new Project("bar", "/bar");
@@ -136,7 +136,7 @@ public void testGetProjectDescriptions() {
      * Insert the value from configuration.
      */
     @Test
-    public void testMergeProjects1() {
+    void testMergeProjects1() {
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
         env.setTabSize(new Configuration().getTabSize() + 3731);
         env.setNavigateWindowEnabled(!new Configuration().isNavigateWindowEnabled());
@@ -164,7 +164,7 @@ public void testMergeProjects1() {
      * Do not overwrite customized project property.
      */
     @Test
-    public void testMergeProjects2() {
+    void testMergeProjects2() {
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
         env.setTabSize(new Configuration().getTabSize() + 3731);
 
@@ -199,7 +199,7 @@ public void testMergeProjects2() {
      * Create a project fill with defaults from the configuration.
      */
     @Test
-    public void testCreateProjectWithConfiguration() {
+    void testCreateProjectWithConfiguration() {
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
         env.setTabSize(4);
 
@@ -209,7 +209,7 @@ public void testCreateProjectWithConfiguration() {
     }
 
     @Test
-    public void testEquality() {
+    void testEquality() {
         Project g1 = new Project();
         Project g2 = new Project();
         assertEquals(g1, g2, "null == null");
@@ -224,4 +224,20 @@ public void testEquality() {
         assertEquals(g1, g1, "\"name\" == \"name\"");
         assertEquals(g2, g2, "\"NAME\" == \"NAME\"");
     }
+
+    @Test
+    void testUsername() {
+        Project project = new Project();
+        final String username = "foo";
+        project.setUsername(username);
+        assertEquals(username, project.getUsername());
+    }
+
+    @Test
+    void testPassword() {
+        Project project = new Project();
+        final String password = "foo";
+        project.setPassword(password);
+        assertEquals(password, project.getPassword());
+    }
 }

opengrok-indexer/src/test/java/org/opengrok/indexer/history/RepositoryInfoTest.java

@@ -18,14 +18,18 @@
  */
 
 /*
- * Copyright (c) 2017, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2022, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017, Chris Fraire <cfraire@me.com>.
  */
 package org.opengrok.indexer.history;
 
 import java.io.File;
+import java.nio.file.Paths;
+import java.util.Map;
+
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.opengrok.indexer.configuration.Project;
 import org.opengrok.indexer.configuration.RuntimeEnvironment;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -35,14 +39,14 @@
  *
  * @author Vladimir Kotal
  */
-public class RepositoryInfoTest {
+class RepositoryInfoTest {
     @BeforeEach
     public void setUp() {
         RuntimeEnvironment.getInstance().setSourceRoot("/src");
     }
 
     @Test
-    public void testEquals() {
+    void testEquals() {
         String repoDirectory = "/src/foo";
 
         RepositoryInfo ri1 = new RepositoryInfo();
@@ -55,4 +59,43 @@ public void testEquals() {
         ri2.setDirectoryName(new File(repoDirectory));
         assertEquals(ri1, ri2);
     }
+
+    @Test
+    void testUsername() {
+        RepositoryInfo repositoryInfo = new RepositoryInfo();
+        final String username = "foo";
+        repositoryInfo.setUsername(username);
+        assertEquals(username, repositoryInfo.getUsername());
+    }
+
+    @Test
+    void testPassword() {
+        RepositoryInfo repositoryInfo = new RepositoryInfo();
+        final String password = "foo";
+        repositoryInfo.setPassword(password);
+        assertEquals(password, repositoryInfo.getPassword());
+    }
+
+    @Test
+    void testFillFromProjectUsernamePassword() {
+        RuntimeEnvironment env = RuntimeEnvironment.getInstance();
+
+        env.setProjectsEnabled(true);
+
+        final String projectName = "proj";
+        Project project = new Project(projectName);
+        final String dirName = "/proj";
+        project.setPath(dirName);
+        final String username = "foo";
+        final String password = "bar";
+        project.setUsername(username);
+        project.setPassword(password);
+        env.setProjects(Map.of(projectName, project));
+
+        RepositoryInfo repositoryInfo = new RepositoryInfo();
+        repositoryInfo.setDirectoryNameRelative(dirName);
+        repositoryInfo.fillFromProject();
+        assertEquals(username, repositoryInfo.getUsername());
+        assertEquals(password, repositoryInfo.getPassword());
+    }
 }

opengrok-indexer/src/test/java/org/opengrok/indexer/history/SubversionRepositoryTest.java

@@ -18,22 +18,25 @@
  */
 
 /*
- * Copyright (c) 2017, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2022, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2020, Ric Harris <harrisric@users.noreply.github.com>.
  */
 package org.opengrok.indexer.history;
 
 import org.junit.jupiter.api.Test;
 
 import java.text.ParseException;
+import java.util.List;
 
+import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
-public class SubversionRepositoryTest {
+class SubversionRepositoryTest {
 
     @Test
-    public void testDateFormats() {
+    void testDateFormats() {
         String[][] tests = new String[][]{
             {"abcd", "expected exception"},
             {"2016-01-01 10:00:00", "expected exception"},
@@ -66,4 +69,40 @@ public void testDateFormats() {
             }
         }
     }
+
+    @Test
+    void testUsernamePassword() {
+        final SubversionRepository repository = new SubversionRepository();
+        final String username = "foo";
+        final String password= "bar";
+        repository.setUsername(username);
+        repository.setPassword(password);
+        assertEquals(List.of("--username", username, "--password", password), repository.getAuthCommandLineParams());
+    }
+
+    @Test
+    void testNullUsernameNullPassword() {
+        final SubversionRepository repository = new SubversionRepository();
+        assertNull(repository.getUsername());
+        assertNull(repository.getPassword());
+        assertTrue(repository.getAuthCommandLineParams().isEmpty());
+    }
+
+    @Test
+    void testNullUsernameNonNullPassword() {
+        final SubversionRepository repository = new SubversionRepository();
+        final String password= "bar";
+        assertNull(repository.getUsername());
+        repository.setPassword(password);
+        assertTrue(repository.getAuthCommandLineParams().isEmpty());
+    }
+
+    @Test
+    void testNonNullUsernameNullPassword() {
+        final SubversionRepository repository = new SubversionRepository();
+        final String username = "foo";
+        assertNull(repository.getPassword());
+        repository.setUsername(username);
+        assertTrue(repository.getAuthCommandLineParams().isEmpty());
+    }
 }