Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2025-11-06 21:45:43 +01:00
Code Issues Packages Projects Releases Activity

implemented new HookTagProvider api for git

Browse Source
This commit is contained in:
Sebastian Sdorra
2016-09-28 14:28:38 +02:00
parent 11c81a4994
commit 8591ced68d
5 changed files with 268 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitUtil.java
View File

@@ -633,6 +633,26 @@ public final class GitUtil
return String.format(REMOTE_REF, repository.getId(), branch);
}
/**
* Returns the name of the tag or {@code null} if the the ref is not a tag.
*
* @param refName ref name
*
* @return name of tag or {@link null}
*
* @since 1.50
*/
public static String getTagName(String refName)
{
String tagName = null;
if (refName.startsWith(PREFIX_TAG))
{
tagName = refName.substring(PREFIX_TAG.length());
}
return tagName;
}
/**
* Method description
*

92
scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/api/GitHookTagProvider.java Normal file
View File

@@ -0,0 +1,92 @@
/***
* Copyright (c) 2015, 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.
*
* https://bitbucket.org/sdorra/scm-manager
*
*/
package sonia.scm.repository.api;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableList;
import java.util.List;
import org.eclipse.jgit.transport.ReceiveCommand;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import sonia.scm.repository.GitUtil;
import sonia.scm.repository.Tag;
/**
* Git provider implementation of {@link HookTagProvider}.
*
* @since 1.50
* @author Sebastian Sdorra
*/
public class GitHookTagProvider implements HookTagProvider {
private static final Logger logger = LoggerFactory.getLogger(GitHookTagProvider.class);
private final List<Tag> createdTags;
private final List<Tag> deletedTags;
/**
* Constructs new instance.
*
* @param commands received commands
*/
public GitHookTagProvider(List<ReceiveCommand> commands) {
ImmutableList.Builder<Tag> createdTagBuilder = ImmutableList.builder();
ImmutableList.Builder<Tag> deletedTagBuilder = ImmutableList.builder();
for ( ReceiveCommand rc : commands ){
String refName = rc.getRefName();
String tag = GitUtil.getTagName(refName);
if (Strings.isNullOrEmpty(tag)){
logger.debug("received ref name {} is not a tag", refName);
} else if (rc.getType() == ReceiveCommand.Type.CREATE) {
createdTagBuilder.add(new Tag(tag, GitUtil.getId(rc.getNewId())));
} else if (rc.getType() == ReceiveCommand.Type.DELETE){
deletedTagBuilder.add(new Tag(tag, GitUtil.getId(rc.getOldId())));
}
}
createdTags = createdTagBuilder.build();
deletedTags = deletedTagBuilder.build();
}
@Override
public List<Tag> getCreatedTags() {
return createdTags;
}
@Override
public List<Tag> getDeletedTags() {
return deletedTags;
}
}

40
scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitHookContextProvider.java
View File

@@ -47,6 +47,8 @@ import sonia.scm.repository.api.HookMessageProvider;
import java.util.EnumSet;
import java.util.List;
import java.util.Set;
import sonia.scm.repository.api.GitHookTagProvider;
import sonia.scm.repository.api.HookTagProvider;
/**
*
@@ -58,16 +60,15 @@ public class GitHookContextProvider extends HookContextProvider
/** Field description */
private static final Set<HookFeature> SUPPORTED_FEATURES =
EnumSet.of(HookFeature.MESSAGE_PROVIDER, HookFeature.CHANGESET_PROVIDER,
HookFeature.BRANCH_PROVIDER);
HookFeature.BRANCH_PROVIDER, HookFeature.TAG_PROVIDER);
//~--- constructors ---------------------------------------------------------
/**
* Constructs ...
* Constructs a new instance
*
*
* @param receivePack
* @param receiveCommands
* @param receivePack git receive pack
* @param receiveCommands received commands
*/
public GitHookContextProvider(ReceivePack receivePack,
List<ReceiveCommand> receiveCommands)
@@ -80,12 +81,6 @@ public class GitHookContextProvider extends HookContextProvider
//~--- methods --------------------------------------------------------------
/**
* Method description
*
*
* @return
*/
@Override
public HookMessageProvider createMessageProvider()
{
@@ -94,36 +89,23 @@ public class GitHookContextProvider extends HookContextProvider
//~--- get methods ----------------------------------------------------------
/**
* Method description
*
*
* @return
*/
@Override
public HookBranchProvider getBranchProvider()
{
return new GitHookBranchProvider(receiveCommands);
}
/**
* Method description
*
*
* @return
*/
@Override
public HookTagProvider getTagProvider() {
return new GitHookTagProvider(receiveCommands);
}
@Override
public HookChangesetProvider getChangesetProvider()
{
return changesetProvider;
}
/**
* Method description
*
*
* @return
*/
@Override
public Set<HookFeature> getSupportedFeatures()
{

27
scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitUtilTest.java
View File

@@ -43,16 +43,18 @@ import static org.mockito.Mockito.*;
import java.io.File;
import java.io.IOException;
import static org.junit.Assert.*;
/**
*
* Unit tests for {@link GitUtil}.
*
* @author Sebastian Sdorra
*/
public class GitUtilTest
{
/**
* Method description
*
* Tests {@link GitUtil#checkBranchName(org.eclipse.jgit.lib.Repository, java.lang.String)} with invalid name.
*
* @throws IOException
*/
@@ -66,8 +68,7 @@ public class GitUtilTest
}
/**
* Method description
*
* Tests {@link GitUtil#checkBranchName(org.eclipse.jgit.lib.Repository, java.lang.String)}.
*
* @throws IOException
*/
@@ -80,15 +81,17 @@ public class GitUtilTest
GitUtil.checkBranchName(repo, GitUtil.REF_HEAD_PREFIX.concat("dev"));
GitUtil.checkBranchName(repo, GitUtil.REF_HEAD_PREFIX.concat("develop"));
}
/**
* Method description
*
*
* @param directory
*
* @return
* Tests {@link GitUtil#getTagName(java.lang.String)}.
*/
@Test
public void testGetTagName(){
assertNull(GitUtil.getTagName("refs/head/master"));
assertEquals("1.0.0", GitUtil.getTagName("refs/tags/1.0.0"));
assertEquals("super/1.0.0", GitUtil.getTagName("refs/tags/super/1.0.0"));
}
private org.eclipse.jgit.lib.Repository mockRepo(File directory)
{
org.eclipse.jgit.lib.Repository repo =

130
scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/api/GitHookTagProviderTest.java Normal file
View File

@@ -0,0 +1,130 @@
/***
* Copyright (c) 2015, 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.
*
* https://bitbucket.org/sdorra/scm-manager
*
*/
package sonia.scm.repository.api;
import com.google.common.collect.Lists;
import java.util.List;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.transport.ReceiveCommand;
import org.junit.Test;
import static org.junit.Assert.*;
import static org.mockito.Mockito.*;
import static org.hamcrest.Matchers.*;
import org.junit.Before;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.runners.MockitoJUnitRunner;
import org.mockito.stubbing.OngoingStubbing;
import sonia.scm.repository.Tag;
/**
* Unit tests for {@link GitHookTagProvider}.
*
* @author Sebastian Sdorra
*/
@RunWith(MockitoJUnitRunner.class)
public class GitHookTagProviderTest {
@Mock
private ReceiveCommand command;
private List<ReceiveCommand> commands;
/**
* Set up mocks for upcoming tests.
*/
@Before
public void setUpMocks(){
commands = Lists.newArrayList(command);
}
/**
* Tests {@link GitHookTagProvider#getCreatedTags()}.
*/
@Test
public void testGetCreatedTags() {
String revision = "b2002b64013e54b78eac251df0672bd5d6a83aa7";
GitHookTagProvider provider = createProvider(ReceiveCommand.Type.CREATE, "refs/tags/1.0.0", revision);
assertTag("1.0.0", revision, provider.getCreatedTags());
assertThat(provider.getDeletedTags(), empty());
}
/**
* Tests {@link GitHookTagProvider#getDeletedTags()}.
*/
@Test
public void testGetDeletedTags() {
String revision = "b2002b64013e54b78eac251df0672bd5d6a83aa7";
GitHookTagProvider provider = createProvider(ReceiveCommand.Type.DELETE, "refs/tags/1.0.0", revision);
assertThat(provider.getCreatedTags(), empty());
assertTag("1.0.0", revision, provider.getDeletedTags());
}
/**
* Tests {@link GitHookTagProvider} with a branch ref instead of a tag.
*/
@Test
public void testWithBranch(){
String revision = "b2002b64013e54b78eac251df0672bd5d6a83aa7";
GitHookTagProvider provider = createProvider(ReceiveCommand.Type.CREATE, "refs/heads/1.0.0", revision);
assertThat(provider.getCreatedTags(), empty());
assertThat(provider.getDeletedTags(), empty());
}
private void assertTag(String name, String revision, List<Tag> tags){
assertNotNull(tags);
assertFalse(tags.isEmpty());
assertEquals(1, tags.size());
Tag tag = tags.get(0);
assertEquals(name, tag.getName());
assertEquals(revision, tag.getRevision());
}
private GitHookTagProvider createProvider(ReceiveCommand.Type type, String ref, String id){
OngoingStubbing<ObjectId> ongoing;
if (type == ReceiveCommand.Type.CREATE){
ongoing = when(command.getNewId());
} else {
ongoing = when(command.getOldId());
}
ongoing.thenReturn(ObjectId.fromString(id));
when(command.getType()).thenReturn(type);
when(command.getRefName()).thenReturn(ref);
return new GitHookTagProvider(commands);
}
}