added option to disallow non fast-forward git pushes

This commit is contained in:
Sebastian Sdorra
2017-07-06 10:13:11 +02:00
parent 73cfbe8993
commit b17a23ddc8
5 changed files with 390 additions and 49 deletions

View File

@@ -51,9 +51,18 @@ public class GitConfig extends SimpleRepositoryConfig {
@XmlElement(name = "gc-expression")
private String gcExpression;
public String getGcExpression()
{
@XmlElement(name = "disallow-non-fast-forward")
private boolean nonFastForwardDisallowed;
public String getGcExpression() {
return gcExpression;
}
public boolean isNonFastForwardDisallowed() {
return nonFastForwardDisallowed;
}
public void setNonFastForwardDisallowed(boolean nonFastForwardDisallowed) {
this.nonFastForwardDisallowed = nonFastForwardDisallowed;
}
}

View File

@@ -35,79 +35,63 @@ package sonia.scm.web;
//~--- non-JDK imports --------------------------------------------------------
import com.google.common.annotations.VisibleForTesting;
import com.google.inject.Inject;
import org.eclipse.jgit.http.server.resolver.DefaultReceivePackFactory;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.transport.ReceivePack;
import org.eclipse.jgit.transport.resolver.ReceivePackFactory;
import org.eclipse.jgit.transport.resolver.ServiceNotAuthorizedException;
import org.eclipse.jgit.transport.resolver.ServiceNotEnabledException;
import sonia.scm.repository.GitRepositoryHandler;
import sonia.scm.repository.spi.HookEventFacade;
//~--- JDK imports ------------------------------------------------------------
import javax.servlet.http.HttpServletRequest;
//~--- JDK imports ------------------------------------------------------------
/**
* GitReceivePackFactory creates {@link ReceivePack} objects and assigns the required
* Hook components.
*
* @author Sebastian Sdorra
*/
public class GitReceivePackFactory
implements ReceivePackFactory<HttpServletRequest>
public class GitReceivePackFactory implements ReceivePackFactory<HttpServletRequest>
{
/**
* Constructs ...
*
*
*
* @param hookEventFacade
* @param handler
*/
private final GitRepositoryHandler handler;
private ReceivePackFactory wrapped;
private final GitReceiveHook hook;
@Inject
public GitReceivePackFactory(HookEventFacade hookEventFacade,
GitRepositoryHandler handler)
{
hook = new GitReceiveHook(hookEventFacade, handler);
public GitReceivePackFactory(GitRepositoryHandler handler, HookEventFacade hookEventFacade) {
this.handler = handler;
this.hook = new GitReceiveHook(hookEventFacade, handler);
this.wrapped = new DefaultReceivePackFactory();
}
//~--- methods --------------------------------------------------------------
/**
* Method description
*
*
* @param request
* @param repository
*
* @return
*
* @throws ServiceNotAuthorizedException
* @throws ServiceNotEnabledException
*/
@Override
public ReceivePack create(HttpServletRequest request, Repository repository)
throws ServiceNotEnabledException, ServiceNotAuthorizedException
{
ReceivePack rpack = defaultFactory.create(request, repository);
throws ServiceNotEnabledException, ServiceNotAuthorizedException {
ReceivePack receivePack = wrapped.create(request, repository);
receivePack.setAllowNonFastForwards(isNonFastForwardAllowed());
rpack.setPreReceiveHook(hook);
rpack.setPostReceiveHook(hook);
receivePack.setPreReceiveHook(hook);
receivePack.setPostReceiveHook(hook);
// apply collecting listener, to be able to check which commits are new
CollectingPackParserListener.set(rpack);
CollectingPackParserListener.set(receivePack);
return rpack;
return receivePack;
}
//~--- fields ---------------------------------------------------------------
private boolean isNonFastForwardAllowed() {
return ! handler.getConfig().isNonFastForwardDisallowed();
}
/** Field description */
private DefaultReceivePackFactory defaultFactory =
new DefaultReceivePackFactory();
/** Field description */
private GitReceiveHook hook;
@VisibleForTesting
void setWrapped(ReceivePackFactory wrapped) {
this.wrapped = wrapped;
}
}

View File

@@ -37,6 +37,7 @@ Sonia.git.ConfigPanel = Ext.extend(Sonia.config.SimpleConfigForm, {
titleText: 'Git Settings',
repositoryDirectoryText: 'Repository directory',
gcExpressionText: 'Git GC Cron Expression',
disallowNonFastForwardText: 'Disallow Non Fast-Forward',
disabledText: 'Disabled',
// helpTexts
@@ -53,6 +54,8 @@ Sonia.git.ConfigPanel = Ext.extend(Sonia.config.SimpleConfigForm, {
</table>\n\
<p>E.g.: To run the task on every sunday at two o\'clock in the morning: 0 0 2 ? * SUN</p>\n\
<p>For more informations please have a look at <a href="http://www.quartz-scheduler.org/documentation/quartz-2.2.x/tutorials/crontrigger.html">Quartz CronTrigger</a></p>',
// TODO i18n
disallowNonFastForwardHelpText: 'Reject git pushes which are non fast-forward such as --force.',
disabledHelpText: 'Enable or disable the Git plugin.\n\
Note you have to reload the page, after changing this value.',
@@ -73,6 +76,12 @@ Sonia.git.ConfigPanel = Ext.extend(Sonia.config.SimpleConfigForm, {
fieldLabel: this.gcExpressionText,
helpText: this.gcExpressionHelpText,
allowBlank : true
},{
xtype: 'checkbox',
name: 'disallow-non-fast-forward',
fieldLabel: this.disallowNonFastForwardText,
inputValue: 'true',
helpText: this.disallowNonFastForwardHelpText
},{
xtype: 'checkbox',
name: 'disabled',

View File

@@ -0,0 +1,117 @@
/**
* 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 org.eclipse.jgit.api.Git;
import org.eclipse.jgit.api.errors.GitAPIException;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.transport.ReceivePack;
import org.eclipse.jgit.transport.resolver.ReceivePackFactory;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.runners.MockitoJUnitRunner;
import sonia.scm.repository.GitConfig;
import sonia.scm.repository.GitRepositoryHandler;
import javax.servlet.http.HttpServletRequest;
import java.io.File;
import java.io.IOException;
import static org.hamcrest.Matchers.instanceOf;
import static org.junit.Assert.*;
import static org.mockito.Mockito.when;
/**
* Unit tests for {@link GitReceivePackFactory}.
*/
@RunWith(MockitoJUnitRunner.class)
public class GitReceivePackFactoryTest {
@Mock
private GitRepositoryHandler handler;
private GitConfig config;
@Mock
private ReceivePackFactory wrappedReceivePackFactory;
private GitReceivePackFactory factory;
@Mock
private HttpServletRequest request;
private Repository repository;
@Rule
public TemporaryFolder temporaryFolder = new TemporaryFolder();
@Before
public void setUpObjectUnderTest() throws Exception {
this.repository = createRepositoryForTesting();
config = new GitConfig();
when(handler.getConfig()).thenReturn(config);
ReceivePack receivePack = new ReceivePack(repository);
when(wrappedReceivePackFactory.create(request, repository)).thenReturn(receivePack);
factory = new GitReceivePackFactory(handler, null);
factory.setWrapped(wrappedReceivePackFactory);
}
private Repository createRepositoryForTesting() throws GitAPIException, IOException {
File directory = temporaryFolder.newFolder();
return Git.init().setDirectory(directory).call().getRepository();
}
@Test
public void testCreate() throws Exception {
ReceivePack receivePack = factory.create(request, repository);
assertThat(receivePack.getPackParserListener(), instanceOf(CollectingPackParserListener.class));
assertThat(receivePack.getPreReceiveHook(), instanceOf(GitReceiveHook.class));
assertThat(receivePack.getPostReceiveHook(), instanceOf(GitReceiveHook.class));
assertTrue(receivePack.isAllowNonFastForwards());
}
@Test
public void testCreateWithDisabledNonFastForward() throws Exception {
config.setNonFastForwardDisallowed(true);
ReceivePack receivePack = factory.create(request, repository);
assertFalse(receivePack.isAllowNonFastForwards());
}
}