Introduce abstraction for repository location

scm-dao-xml/src/main/java/sonia/scm/repository/xml/PathBasedRepositoryLocationResolver.java

@@ -0,0 +1,53 @@
+package sonia.scm.repository.xml;
+
+import sonia.scm.SCMContextProvider;
+import sonia.scm.repository.BasicRepositoryLocationResolver;
+import sonia.scm.repository.InitialRepositoryLocationResolver;
+import sonia.scm.repository.PathBasedRepositoryDAO;
+import sonia.scm.repository.RepositoryDAO;
+import sonia.scm.repository.RepositoryLocationResolver;
+
+import javax.inject.Inject;
+import java.nio.file.Path;
+
+/**
+ * A Location Resolver for File based Repository Storage.
+ * <p>
+ * <b>WARNING:</b> The Locations provided with this class may not be used from the plugins to store any plugin specific files.
+ * <p>
+ * Please use the {@link sonia.scm.store.DataStoreFactory } and the {@link sonia.scm.store.DataStore} classes to store data<br>
+ * Please use the {@link sonia.scm.store.BlobStoreFactory } and the {@link sonia.scm.store.BlobStore} classes to store binary files<br>
+ * Please use the {@link sonia.scm.store.ConfigurationStoreFactory} and the {@link sonia.scm.store.ConfigurationStore} classes  to store configurations
+ *
+ * @author Mohamed Karray
+ * @since 2.0.0
+ */
+public class PathBasedRepositoryLocationResolver extends BasicRepositoryLocationResolver<Path> {
+
+  private final SCMContextProvider contextProvider;
+  private final InitialRepositoryLocationResolver initialRepositoryLocationResolver;
+  private final RepositoryDAO repositoryDAO;
+
+  @Inject
+  public PathBasedRepositoryLocationResolver(SCMContextProvider contextProvider, RepositoryDAO repositoryDAO, InitialRepositoryLocationResolver initialRepositoryLocationResolver) {
+    super(Path.class);
+    this.contextProvider = contextProvider;
+    this.initialRepositoryLocationResolver = initialRepositoryLocationResolver;
+    this.repositoryDAO = repositoryDAO;
+  }
+
+  @Override
+  protected <T> RepositoryLocationResolverInstance<T> create(Class<T> type) {
+    return repositoryId -> {
+      Path path;
+
+      if (repositoryDAO instanceof PathBasedRepositoryDAO) {
+        path = ((PathBasedRepositoryDAO) repositoryDAO).getPath(repositoryId);
+      } else {
+        path = initialRepositoryLocationResolver.getPath(repositoryId);
+      }
+
+      return (T) contextProvider.resolve(path);
+    };
+  }
+}

scm-dao-xml/src/main/java/sonia/scm/store/FileBasedStoreFactory.java

@@ -40,6 +40,7 @@ import sonia.scm.repository.RepositoryLocationResolver;
 import sonia.scm.util.IOUtil;
 
 import java.io.File;
+import java.nio.file.Path;
 
 //~--- JDK imports ------------------------------------------------------------
 
@@ -58,7 +59,7 @@ public abstract class FileBasedStoreFactory {
   private RepositoryLocationResolver repositoryLocationResolver;
   private Store store;
 
-  protected FileBasedStoreFactory(SCMContextProvider contextProvider , RepositoryLocationResolver repositoryLocationResolver, Store store) {
+  protected FileBasedStoreFactory(SCMContextProvider contextProvider, RepositoryLocationResolver repositoryLocationResolver, Store store) {
     this.contextProvider = contextProvider;
     this.repositoryLocationResolver = repositoryLocationResolver;
     this.store = store;
@@ -92,7 +93,7 @@ public abstract class FileBasedStoreFactory {
    * @return the store directory of a specific repository
    */
   private File getStoreDirectory(Store store, Repository repository) {
-    return new File(repositoryLocationResolver.getPath(repository.getId()).toFile(), store.getRepositoryStoreDirectory());
+    return new File(repositoryLocationResolver.forClass(Path.class).getLocation(repository.getId()).toFile(), store.getRepositoryStoreDirectory());
   }
 
   /**

scm-dao-xml/src/main/java/sonia/scm/store/FileBlobStoreFactory.java

@@ -65,7 +65,7 @@ public class FileBlobStoreFactory extends FileBasedStoreFactory implements BlobS
    * @param keyGenerator key generator
    */
   @Inject
-  public FileBlobStoreFactory(SCMContextProvider contextProvider ,RepositoryLocationResolver repositoryLocationResolver, KeyGenerator keyGenerator) {
+  public FileBlobStoreFactory(SCMContextProvider contextProvider , RepositoryLocationResolver repositoryLocationResolver, KeyGenerator keyGenerator) {
     super(contextProvider, repositoryLocationResolver, Store.BLOB);
     this.keyGenerator = keyGenerator;
   }

scm-dao-xml/src/test/java/sonia/scm/repository/xml/PathBasedRepositoryLocationResolverTest.java

@@ -0,0 +1,67 @@
+package sonia.scm.repository.xml;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.mockito.stubbing.Answer;
+import sonia.scm.SCMContextProvider;
+import sonia.scm.repository.InitialRepositoryLocationResolver;
+import sonia.scm.repository.PathBasedRepositoryDAO;
+import sonia.scm.repository.RepositoryDAO;
+
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.when;
+
+@ExtendWith({MockitoExtension.class})
+class PathBasedRepositoryLocationResolverTest {
+
+  @Mock
+  private SCMContextProvider contextProvider;
+
+  @Mock
+  private PathBasedRepositoryDAO pathBasedRepositoryDAO;
+
+  @Mock
+  private RepositoryDAO repositoryDAO;
+
+  @Mock
+  private InitialRepositoryLocationResolver initialRepositoryLocationResolver;
+
+  @BeforeEach
+  void beforeEach() {
+    when(contextProvider.resolve(any(Path.class))).then((Answer<Path>) invocationOnMock -> invocationOnMock.getArgument(0));
+  }
+
+  private PathBasedRepositoryLocationResolver createResolver(RepositoryDAO pathBasedRepositoryDAO) {
+    return new PathBasedRepositoryLocationResolver(contextProvider, pathBasedRepositoryDAO, initialRepositoryLocationResolver);
+  }
+
+  @Test
+  void shouldReturnPathFromDao() {
+    Path repositoryPath = Paths.get("repos", "42");
+    when(pathBasedRepositoryDAO.getPath("42")).thenReturn(repositoryPath);
+
+    PathBasedRepositoryLocationResolver resolver = createResolver(pathBasedRepositoryDAO);
+    Path path = resolver.forClass(Path.class).getLocation("42");
+
+    assertThat(path).isSameAs(repositoryPath);
+  }
+
+  @Test
+  void shouldReturnInitialPathIfDaoIsNotPathBased() {
+    Path repositoryPath = Paths.get("r", "42");
+    when(initialRepositoryLocationResolver.getPath("42")).thenReturn(repositoryPath);
+
+    PathBasedRepositoryLocationResolver resolver = createResolver(repositoryDAO);
+    Path path = resolver.forClass(Path.class).getLocation("42");
+
+    assertThat(path).isSameAs(repositoryPath);
+  }
+
+}