From 58035845cea9e26a32444fac0eee899eea9475b8 Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Tue, 6 Jun 2017 10:43:29 +0200 Subject: [PATCH] improve GitRepositoryResolver to allow requests to repositories which ends with .git, the resolver will automatically remove the .git extension and resolves the repository --- .../sonia/scm/web/GitRepositoryResolver.java | 55 +++++---- .../scm/web/GitRepositoryResolverTest.java | 109 ++++++++++++++++++ 2 files changed, 144 insertions(+), 20 deletions(-) create mode 100644 scm-plugins/scm-git-plugin/src/test/java/sonia/scm/web/GitRepositoryResolverTest.java diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitRepositoryResolver.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitRepositoryResolver.java index 5ddd000490..2ddf4b3de9 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitRepositoryResolver.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitRepositoryResolver.java @@ -35,6 +35,7 @@ package sonia.scm.web; //~--- non-JDK imports -------------------------------------------------------- +import com.google.common.annotations.VisibleForTesting; import com.google.inject.Inject; import org.eclipse.jgit.errors.RepositoryNotFoundException; @@ -63,13 +64,11 @@ import javax.servlet.http.HttpServletRequest; * * @author Sebastian Sdorra */ -public class GitRepositoryResolver - implements RepositoryResolver +public class GitRepositoryResolver implements RepositoryResolver { /** the logger for GitRepositoryResolver */ - private static final Logger logger = - LoggerFactory.getLogger(GitRepositoryResolver.class); + private static final Logger logger = LoggerFactory.getLogger(GitRepositoryResolver.class); //~--- constructors --------------------------------------------------------- @@ -114,20 +113,14 @@ public class GitRepositoryResolver if (config.isValid()) { - File gitdir = new File(config.getRepositoryDirectory(), repositoryName); - - if (logger.isDebugEnabled()) - { - logger.debug("try to open git repository at {}", gitdir); - } - - if (!gitdir.exists()) - { + File gitdir = findRepository(config.getRepositoryDirectory(), repositoryName); + if (gitdir == null) { throw new RepositoryNotFoundException(repositoryName); } + + logger.debug("try to open git repository at {}", gitdir); - repository = RepositoryCache.open(FileKey.lenient(gitdir, FS.DETECTED), - true); + repository = RepositoryCache.open(FileKey.lenient(gitdir, FS.DETECTED), true); } else { @@ -139,17 +132,39 @@ public class GitRepositoryResolver throw new ServiceNotEnabledException(); } } - catch (RuntimeException e) - { - throw new RepositoryNotFoundException(repositoryName, e); - } - catch (IOException e) + catch (RuntimeException | IOException e) { throw new RepositoryNotFoundException(repositoryName, e); } return repository; } + + @VisibleForTesting + File findRepository(File parentDirectory, String repositoryName) { + File repositoryDirectory = new File(parentDirectory, repositoryName); + if (repositoryDirectory.exists()) { + return repositoryDirectory; + } + + if (endsWithDotGit(repositoryName)) { + String repositoryNameWithoutDotGit = repositoryNameWithoutDotGit(repositoryName); + repositoryDirectory = new File(parentDirectory, repositoryNameWithoutDotGit); + if (repositoryDirectory.exists()) { + return repositoryDirectory; + } + } + + return null; + } + + private boolean endsWithDotGit(String repositoryName) { + return repositoryName.endsWith(GitRepositoryHandler.DOT_GIT); + } + + private String repositoryNameWithoutDotGit(String repositoryName) { + return repositoryName.substring(0, repositoryName.length() - GitRepositoryHandler.DOT_GIT.length()); + } //~--- fields --------------------------------------------------------------- diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/web/GitRepositoryResolverTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/web/GitRepositoryResolverTest.java new file mode 100644 index 0000000000..d41e0acafc --- /dev/null +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/web/GitRepositoryResolverTest.java @@ -0,0 +1,109 @@ +/** + * Copyright (c) 2010, Sebastian Sdorra + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * 3. Neither the name of SCM-Manager; nor the names of its + * contributors may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * http://bitbucket.org/sdorra/scm-manager + * + */ +package sonia.scm.web; + +import java.io.File; +import java.io.IOException; +import org.junit.Test; +import static org.junit.Assert.*; +import org.junit.Before; +import org.junit.Rule; +import org.junit.rules.TemporaryFolder; +import org.junit.runner.RunWith; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import static org.mockito.Mockito.*; +import org.mockito.runners.MockitoJUnitRunner; +import sonia.scm.repository.GitConfig; +import sonia.scm.repository.GitRepositoryHandler; + +/** + * Unit tests for {@link GitRepositoryResolver}. + * + * @author Sebastian Sdorra + */ +@RunWith(MockitoJUnitRunner.class) +public class GitRepositoryResolverTest { + + @Rule + public TemporaryFolder temporaryFolder = new TemporaryFolder(); + + private File parentDirectory; + + @Mock + private GitRepositoryHandler handler; + + @InjectMocks + private GitRepositoryResolver resolver; + + @Before + public void setUp() throws IOException { + parentDirectory = temporaryFolder.newFolder(); + + GitConfig config = new GitConfig(); + config.setRepositoryDirectory(parentDirectory); + + when(handler.getConfig()).thenReturn(config); + } + + @Test + public void testFindRepositoryWithoutDotGit() { + createRepositories("a", "ab"); + + File directory = resolver.findRepository(parentDirectory, "a"); + assertNotNull(directory); + assertEquals("a", directory.getName()); + + directory = resolver.findRepository(parentDirectory, "ab"); + assertNotNull(directory); + assertEquals("ab", directory.getName()); + } + + @Test + public void testFindRepositoryWithDotGit() { + createRepositories("a", "ab"); + + File directory = resolver.findRepository(parentDirectory, "a.git"); + assertNotNull(directory); + assertEquals("a", directory.getName()); + + directory = resolver.findRepository(parentDirectory, "ab.git"); + assertNotNull(directory); + assertEquals("ab", directory.getName()); + } + + private void createRepositories(String... names) { + for (String name : names) { + assertTrue(new File(parentDirectory, name).mkdirs()); + } + } + +}