Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2026-01-17 21:12:09 +01:00
Code Issues Packages Projects Releases Activity

Merge pull request #1305 from scm-manager/feature/tag-dates

Browse Source 
Feature/tag dates
This commit is contained in:
Sebastian Sdorra
2020-09-02 10:43:17 +02:00
committed by GitHub
parent 421066a093 d12572f765
commit d3a8623794
19 changed files with 422 additions and 155 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@@ -6,6 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## Unreleased
### Added
- Tags now have date information attached ([#1305](https://github.com/scm-manager/scm-manager/pull/1305))
- Add support for scroll anchors in url hash of diff page ([#1304](https://github.com/scm-manager/scm-manager/pull/1304))
### Fixed

2
pom.xml
View File

@@ -903,7 +903,7 @@
<properties>
<!-- test libraries -->
<mockito.version>2.28.2</mockito.version>
<mockito.version>3.5.6</mockito.version>
<hamcrest.version>2.1</hamcrest.version>
<junit.version>5.6.2</junit.version>

37
scm-core/src/main/java/sonia/scm/repository/Tag.java
View File

@@ -28,6 +28,8 @@ import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.ToString;
import java.util.Optional;
/**
* Represents a tag in a repository.
*
@@ -41,6 +43,7 @@ public final class Tag {
private final String name;
private final String revision;
private final Long date;
/**
* Constructs a new tag.
@@ -49,7 +52,41 @@ public final class Tag {
* @param revision tagged revision
*/
public Tag(String name, String revision) {
this(name, revision, null);
}
/**
* Constructs a new tag.
*
* @param name name of the tag
* @param revision tagged revision
* @param date the creation timestamp (milliseconds) of the tag
*
* @since 2.5.0
*/
public Tag(String name, String revision, Long date) {
this.name = name;
this.revision = revision;
this.date = date;
}
/**
* Depending on the underlying source code management system
* (like git or hg) and depending on the type of this tag
* (for example git has <i>lightweight</i> and <i>annotated</i>
* tags), this date has different meaning. For annotated tags
* in git, this is the date the tag was created. In other cases
* (for lightweight tags in git or all tags in hg) this is the
* date of the referenced changeset.
* <p>
* Please note, that the date is retrieved in a best-effort fashion.
* In certain situations (for example if this tag is announced in
* a pre or post receive hook), it might not be available.
* In these cases, this method returns an empty {@link Optional}.
*
* @since 2.5.0
*/
public Optional<Long> getDate() {
return Optional.ofNullable(date);
}
}

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

@@ -42,6 +42,8 @@ import org.eclipse.jgit.lib.Constants;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.lib.Ref;
import org.eclipse.jgit.revwalk.RevCommit;
import org.eclipse.jgit.revwalk.RevObject;
import org.eclipse.jgit.revwalk.RevTag;
import org.eclipse.jgit.revwalk.RevWalk;
import org.eclipse.jgit.revwalk.filter.RevFilter;
import org.eclipse.jgit.storage.file.FileRepositoryBuilder;
@@ -387,6 +389,31 @@ public final class GitUtil
return ref;
}
/**
* @since 2.5.0
*/
public static Long getTagTime(org.eclipse.jgit.lib.Repository repository, ObjectId objectId) throws IOException {
try (RevWalk walk = new RevWalk(repository)) {
return GitUtil.getTagTime(walk, objectId);
}
}
/**
* @since 2.5.0
*/
public static Long getTagTime(RevWalk revWalk, ObjectId objectId) throws IOException {
if (objectId != null) {
final RevObject revObject = revWalk.parseAny(objectId);
if (revObject instanceof RevTag) {
return ((RevTag) revObject).getTaggerIdent().getWhen().getTime();
} else if (revObject instanceof RevCommit) {
return getCommitTime((RevCommit) revObject);
}
}
return null;
}
/**
* Method description
*

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

@@ -21,66 +21,75 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
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.lib.Repository;
import org.eclipse.jgit.transport.ReceiveCommand;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import sonia.scm.repository.GitUtil;
import sonia.scm.repository.Tag;
import java.io.IOException;
import java.util.List;
/**
* Git provider implementation of {@link HookTagProvider}.
*
* @since 1.50
*
* @author Sebastian Sdorra
* @since 1.50
*/
public class GitHookTagProvider implements HookTagProvider {
private static final Logger logger = LoggerFactory.getLogger(GitHookTagProvider.class);
private static final Logger LOG = 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) {
public GitHookTagProvider(List<ReceiveCommand> commands, Repository repository) {
ImmutableList.Builder<Tag> createdTagBuilder = ImmutableList.builder();
ImmutableList.Builder<Tag> deletedTagBuilder = ImmutableList.builder();
for ( ReceiveCommand rc : commands ){
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 (isCreate(rc)) {
createdTagBuilder.add(createTagFromNewId(rc, tag));
} else if (isDelete(rc)){
deletedTagBuilder.add(createTagFromOldId(rc, tag));
} else if (isUpdate(rc)) {
createdTagBuilder.add(createTagFromNewId(rc, tag));
deletedTagBuilder.add(createTagFromOldId(rc, tag));
if (Strings.isNullOrEmpty(tag)) {
LOG.debug("received ref name {} is not a tag", refName);
} else {
try {
if (isCreate(rc)) {
createdTagBuilder.add(createTagFromNewId(rc, tag, GitUtil.getTagTime(repository, rc.getNewId())));
} else if (isDelete(rc)) {
deletedTagBuilder.add(createTagFromOldId(rc, tag, GitUtil.getTagTime(repository, rc.getOldId())));
} else if (isUpdate(rc)) {
createdTagBuilder.add(createTagFromNewId(rc, tag, GitUtil.getTagTime(repository, rc.getNewId())));
deletedTagBuilder.add(createTagFromOldId(rc, tag, GitUtil.getTagTime(repository, rc.getOldId())));
}
} catch (IOException e) {
LOG.error("Could not read tag time", e);
}
}
}
createdTags = createdTagBuilder.build();
deletedTags = deletedTagBuilder.build();
}
private Tag createTagFromNewId(ReceiveCommand rc, String tag) {
return new Tag(tag, GitUtil.getId(rc.getNewId()));
private Tag createTagFromNewId(ReceiveCommand rc, String tag, Long tagTime) {
return new Tag(tag, GitUtil.getId(rc.getNewId()), tagTime);
}
private Tag createTagFromOldId(ReceiveCommand rc, String tag) {
return new Tag(tag, GitUtil.getId(rc.getOldId()));
private Tag createTagFromOldId(ReceiveCommand rc, String tag, Long tagTime) {
return new Tag(tag, GitUtil.getId(rc.getOldId()), tagTime);
}
private boolean isUpdate(ReceiveCommand rc) {

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

@@ -103,7 +103,7 @@ public class GitHookContextProvider extends HookContextProvider
@Override
public HookTagProvider getTagProvider() {
return new GitHookTagProvider(receiveCommands);
return new GitHookTagProvider(receiveCommands, repository);
}
@Override

65
scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitTagsCommand.java
View File

@@ -31,7 +31,7 @@ import com.google.common.collect.Lists;
import org.eclipse.jgit.api.Git;
import org.eclipse.jgit.api.errors.GitAPIException;
import org.eclipse.jgit.lib.Ref;
import org.eclipse.jgit.revwalk.RevCommit;
import org.eclipse.jgit.revwalk.RevObject;
import org.eclipse.jgit.revwalk.RevWalk;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -45,34 +45,28 @@ import java.util.List;
//~--- JDK imports ------------------------------------------------------------
/**
*
* @author Sebastian Sdorra
*/
public class GitTagsCommand extends AbstractGitCommand implements TagsCommand
{
public class GitTagsCommand extends AbstractGitCommand implements TagsCommand {
/**
* Constructs ...
*
* @param context
*
* @param context
*/
public GitTagsCommand(GitContext context)
{
public GitTagsCommand(GitContext context) {
super(context);
}
//~--- get methods ----------------------------------------------------------
@Override
public List<Tag> getTags() throws IOException
{
public List<Tag> getTags() throws IOException {
List<Tag> tags = null;
RevWalk revWalk = null;
try
{
try {
final Git git = new Git(open());
revWalk = new RevWalk(git.getRepository());
@@ -81,13 +75,9 @@ public class GitTagsCommand extends AbstractGitCommand implements TagsCommand
tags = Lists.transform(tagList,
new TransformFuntion(git.getRepository(), revWalk));
}
catch (GitAPIException ex)
{
} catch (GitAPIException ex) {
throw new InternalRepositoryException(repository, "could not read tags from repository", ex);
}
finally
{
} finally {
GitUtil.release(revWalk);
}
@@ -99,12 +89,10 @@ public class GitTagsCommand extends AbstractGitCommand implements TagsCommand
/**
* Class description
*
*
* @version Enter version here..., 12/07/06
* @author Enter your name here...
* @author Enter your name here...
* @version Enter version here..., 12/07/06
*/
private static class TransformFuntion implements Function<Ref, Tag>
{
private static class TransformFuntion implements Function<Ref, Tag> {
/**
* the logger for TransformFuntion
@@ -117,13 +105,11 @@ public class GitTagsCommand extends AbstractGitCommand implements TagsCommand
/**
* Constructs ...
*
*
* @param repository
* @param revWalk
*/
public TransformFuntion(org.eclipse.jgit.lib.Repository repository,
RevWalk revWalk)
{
RevWalk revWalk) {
this.repository = repository;
this.revWalk = revWalk;
}
@@ -133,30 +119,23 @@ public class GitTagsCommand extends AbstractGitCommand implements TagsCommand
/**
* Method description
*
*
* @param ref
*
* @return
*/
@Override
public Tag apply(Ref ref)
{
public Tag apply(Ref ref) {
Tag tag = null;
try
{
RevCommit commit = GitUtil.getCommit(repository, revWalk, ref);
try {
RevObject revObject = GitUtil.getCommit(repository, revWalk, ref);
if (commit != null)
{
if (revObject != null) {
String name = GitUtil.getTagName(ref);
tag = new Tag(name, commit.getId().name());
tag = new Tag(name, revObject.getId().name(), GitUtil.getTagTime(revWalk, ref.getObjectId()));
}
}
catch (IOException ex)
{
} catch (IOException ex) {
logger.error("could not get commit for tag", ex);
}
@@ -165,10 +144,14 @@ public class GitTagsCommand extends AbstractGitCommand implements TagsCommand
//~--- fields -------------------------------------------------------------
/** Field description */
/**
* Field description
*/
private org.eclipse.jgit.lib.Repository repository;
/** Field description */
/**
* Field description
*/
private RevWalk revWalk;
}
}

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

@@ -21,30 +21,35 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package sonia.scm.repository.api;
import com.google.common.collect.Lists;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.transport.ReceiveCommand;
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.MockedStatic;
import org.mockito.Mockito;
import org.mockito.junit.MockitoJUnitRunner;
import sonia.scm.repository.GitUtil;
import sonia.scm.repository.Tag;
import java.util.List;
import static org.hamcrest.Matchers.empty;
import static org.junit.Assert.*;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertThat;
import static org.mockito.Mockito.when;
/**
* Unit tests for {@link GitHookTagProvider}.
*
*
* @author Sebastian Sdorra
*/
@RunWith(MockitoJUnitRunner.class)
@@ -52,19 +57,19 @@ public class GitHookTagProviderTest {
private static final String ZERO = ObjectId.zeroId().getName();
@Rule
public TemporaryFolder temporaryFolder = new TemporaryFolder();
@Mock
private ReceiveCommand command;
@Mock
private Repository repository;
private List<ReceiveCommand> commands;
/**
* Set up mocks for upcoming tests.
*/
@Before
public void setUpMocks(){
public void setUpMocks() {
commands = Lists.newArrayList(command);
}
@@ -73,65 +78,125 @@ public class GitHookTagProviderTest {
*/
@Test
public void testGetCreatedTags() {
String revision = "b2002b64013e54b78eac251df0672bd5d6a83aa7";
GitHookTagProvider provider = createProvider(ReceiveCommand.Type.CREATE, "refs/tags/1.0.0", revision, ZERO);
assertTag("1.0.0", revision, provider.getCreatedTags());
assertThat(provider.getDeletedTags(), empty());
try (MockedStatic<GitUtil> dummy = Mockito.mockStatic(GitUtil.class)) {
String revision = "86a6645eceefe8b9a247db5eb16e3d89a7e6e6d1";
Long timestamp = 1339416344000L;
String tagName = "1.0.0";
String ref = "refs/tags/" + tagName;
dummy.when(() -> GitUtil.getTagTime(repository, ObjectId.fromString(revision))).thenReturn(timestamp);
dummy.when(() -> GitUtil.getTagName(ref)).thenReturn(tagName);
dummy.when(() -> GitUtil.getId(ObjectId.fromString(revision))).thenReturn(revision);
GitHookTagProvider provider = createProvider(ReceiveCommand.Type.CREATE, ref, revision, ZERO);
assertTag(tagName, revision, timestamp, 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", ZERO, revision);
assertThat(provider.getCreatedTags(), empty());
assertTag("1.0.0", revision, provider.getDeletedTags());
try (MockedStatic<GitUtil> dummy = Mockito.mockStatic(GitUtil.class)) {
String revision = "b2002b64013e54b78eac251df0672bd5d6a83aa7";
Long timestamp = 1339416344000L;
String tagName = "1.0.0";
String ref = "refs/tags/" + tagName;
dummy.when(() -> GitUtil.getTagTime(repository, ObjectId.fromString(revision))).thenReturn(timestamp);
dummy.when(() -> GitUtil.getTagName(ref)).thenReturn(tagName);
dummy.when(() -> GitUtil.getId(ObjectId.fromString(revision))).thenReturn(revision);
GitHookTagProvider provider = createProvider(ReceiveCommand.Type.DELETE, ref, ZERO, revision);
assertThat(provider.getCreatedTags(), empty());
assertTag("1.0.0", revision, 1339416344000L, provider.getDeletedTags());
}
}
/**
* Tests {@link GitHookTagProvider} with a branch ref instead of a tag.
*/
@Test
public void testWithBranch(){
public void testWithBranch() {
String revision = "b2002b64013e54b78eac251df0672bd5d6a83aa7";
GitHookTagProvider provider = createProvider(ReceiveCommand.Type.CREATE, "refs/heads/1.0.0", revision, revision);
assertThat(provider.getCreatedTags(), empty());
assertThat(provider.getDeletedTags(), empty());
}
/**
* Tests {@link GitHookTagProvider} with update command.
* Tests {@link GitHookTagProvider} with update command pre receive.
*/
@Test
public void testUpdateTags() {
String newId = "b2002b64013e54b78eac251df0672bd5d6a83aa7";
String oldId = "e0f2be968b147ff7043684a7715d2fe852553db4";
public void testUpdateTagsPreReceive() {
try (MockedStatic<GitUtil> dummy = Mockito.mockStatic(GitUtil.class)) {
String oldRevision = "e0f2be968b147ff7043684a7715d2fe852553db4";
String newRevision = "b2002b64013e54b78eac251df0672bd5d6a83aa7";
GitHookTagProvider provider = createProvider(ReceiveCommand.Type.UPDATE, "refs/tags/1.0.0", newId, oldId);
assertTag("1.0.0", newId, provider.getCreatedTags());
assertTag("1.0.0", oldId, provider.getDeletedTags());
Long timestamp = 1339416344000L;
String tagName = "1.0.0";
String ref = "refs/tags/" + tagName;
dummy.when(() -> GitUtil.getTagTime(repository, ObjectId.fromString(oldRevision))).thenReturn(timestamp);
dummy.when(() -> GitUtil.getTagTime(repository, ObjectId.fromString(newRevision))).thenReturn(null);
dummy.when(() -> GitUtil.getTagName(ref)).thenReturn(tagName);
dummy.when(() -> GitUtil.getId(ObjectId.fromString(oldRevision))).thenReturn(oldRevision);
dummy.when(() -> GitUtil.getId(ObjectId.fromString(newRevision))).thenReturn(newRevision);
GitHookTagProvider provider = createProvider(ReceiveCommand.Type.UPDATE, ref, newRevision, oldRevision);
assertTag(tagName, newRevision, null, provider.getCreatedTags());
assertTag(tagName, oldRevision, timestamp, provider.getDeletedTags());
}
}
private void assertTag(String name, String revision, List<Tag> tags){
/**
* Tests {@link GitHookTagProvider} with update command post receive.
*/
@Test
public void testUpdateTagsPostReceive() {
try (MockedStatic<GitUtil> dummy = Mockito.mockStatic(GitUtil.class)) {
String oldRevision = "e0f2be968b147ff7043684a7715d2fe852553db4";
String newRevision = "b2002b64013e54b78eac251df0672bd5d6a83aa7";
Long timestamp = 1339416344000L;
String tagName = "1.0.0";
String ref = "refs/tags/" + tagName;
dummy.when(() -> GitUtil.getTagTime(repository, ObjectId.fromString(newRevision))).thenReturn(timestamp);
dummy.when(() -> GitUtil.getTagTime(repository, ObjectId.fromString(oldRevision))).thenReturn(null);
dummy.when(() -> GitUtil.getTagName(ref)).thenReturn(tagName);
dummy.when(() -> GitUtil.getId(ObjectId.fromString(oldRevision))).thenReturn(oldRevision);
dummy.when(() -> GitUtil.getId(ObjectId.fromString(newRevision))).thenReturn(newRevision);
GitHookTagProvider provider = createProvider(ReceiveCommand.Type.UPDATE, ref, newRevision, oldRevision);
assertTag(tagName, newRevision, timestamp, provider.getCreatedTags());
assertTag(tagName, oldRevision, null, provider.getDeletedTags());
}
}
private void assertTag(String name, String revision, Long date, 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());
assertEquals(date, tag.getDate().orElse(null));
}
private GitHookTagProvider createProvider(ReceiveCommand.Type type, String ref, String newId, String oldId){
private GitHookTagProvider createProvider(ReceiveCommand.Type type, String ref, String newId, String oldId) {
when(command.getNewId()).thenReturn(ObjectId.fromString(newId));
when(command.getOldId()).thenReturn(ObjectId.fromString(oldId));
when(command.getType()).thenReturn(type);
when(command.getRefName()).thenReturn(ref);
return new GitHookTagProvider(commands);
return new GitHookTagProvider(commands, repository);
}
}

8
scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/client/spi/GitTagCommand.java
View File

@@ -21,7 +21,7 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package sonia.scm.repository.client.spi;
//~--- non-JDK imports --------------------------------------------------------
@@ -78,6 +78,7 @@ public class GitTagCommand implements TagCommand
String revision = request.getRevision();
RevObject revObject = null;
Long tagTime = null;
if (!Strings.isNullOrEmpty(revision))
{
@@ -88,6 +89,7 @@ public class GitTagCommand implements TagCommand
{
walk = new RevWalk(git.getRepository());
revObject = walk.parseAny(id);
tagTime = GitUtil.getTagTime(walk, id);
}
finally
{
@@ -110,9 +112,9 @@ public class GitTagCommand implements TagCommand
}
if (ref.isPeeled()) {
tag = new Tag(request.getName(), ref.getPeeledObjectId().toString());
tag = new Tag(request.getName(), ref.getPeeledObjectId().toString(), tagTime);
} else {
tag = new Tag(request.getName(), ref.getObjectId().toString());
tag = new Tag(request.getName(), ref.getObjectId().toString(), tagTime);
}
}

73
scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitTagsCommandTest.java Normal file
View File

@@ -0,0 +1,73 @@
/*
* MIT License
*
* Copyright (c) 2020-present Cloudogu GmbH and Contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package sonia.scm.repository.spi;
import com.github.sdorra.shiro.ShiroRule;
import com.github.sdorra.shiro.SubjectAware;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import sonia.scm.repository.Tag;
import java.io.IOException;
import java.util.List;
import static org.assertj.core.api.Assertions.assertThat;
@SubjectAware(configuration = "classpath:sonia/scm/configuration/shiro.ini", username = "admin", password = "secret")
public class GitTagsCommandTest extends AbstractGitCommandTestBase {
@Rule
public TemporaryFolder temporaryFolder = new TemporaryFolder();
@Rule
public BindTransportProtocolRule transportProtocolRule = new BindTransportProtocolRule();
@Rule
public ShiroRule shiro = new ShiroRule();
@Test
public void shouldGetDatesCorrectly() throws IOException {
final GitContext gitContext = createContext();
final GitTagsCommand tagsCommand = new GitTagsCommand(gitContext);
final List<Tag> tags = tagsCommand.getTags();
assertThat(tags).hasSize(2);
Tag annotatedTag = tags.get(0);
assertThat(annotatedTag.getName()).isEqualTo("1.0.0");
assertThat(annotatedTag.getDate()).contains(1598348105000L); // Annotated - Take tag date
assertThat(annotatedTag.getRevision()).isEqualTo("fcd0ef1831e4002ac43ea539f4094334c79ea9ec");
Tag lightweightTag = tags.get(1);
assertThat(lightweightTag.getName()).isEqualTo("test-tag");
assertThat(lightweightTag.getDate()).contains(1339416344000L); // Lightweight - Take commit date
assertThat(lightweightTag.getRevision()).isEqualTo("86a6645eceefe8b9a247db5eb16e3d89a7e6e6d1");
}
@Override
protected String getZippedRepositoryResource() {
return "sonia/scm/repository/spi/scm-git-spi-test-tags.zip";
}
}

BIN
scm-plugins/scm-git-plugin/src/test/resources/sonia/scm/repository/spi/scm-git-spi-test-tags.zip Normal file
View File

Binary file not shown.

2
scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookTagProvider.java
View File

@@ -92,7 +92,7 @@ public class HgHookTagProvider implements HookTagProvider {
if (tagNames != null){
for ( String tagName : tagNames ){
logger.trace("found tag {} at changeset {}", tagName, c.getId());
tags.add(new Tag(tagName, c.getId()));
tags.add(new Tag(tagName, c.getId(), c.getDate()));
}
}
}

43
scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgTagsCommand.java
View File

@@ -29,29 +29,22 @@ package sonia.scm.repository.spi;
import com.google.common.base.Function;
import com.google.common.base.Strings;
import com.google.common.collect.Lists;
import sonia.scm.repository.Tag;
import sonia.scm.util.Util;
//~--- JDK imports ------------------------------------------------------------
import java.util.List;
/**
*
* @author Sebastian Sdorra
*/
public class HgTagsCommand extends AbstractCommand implements TagsCommand
{
public class HgTagsCommand extends AbstractCommand implements TagsCommand {
/**
* Constructs ...
*
* @param context
*
* @param context
*/
public HgTagsCommand(HgCommandContext context)
{
public HgTagsCommand(HgCommandContext context) {
super(context);
}
@@ -60,12 +53,10 @@ public class HgTagsCommand extends AbstractCommand implements TagsCommand
/**
* Method description
*
*
* @return
*/
@Override
public List<Tag> getTags()
{
public List<Tag> getTags() {
com.aragost.javahg.commands.TagsCommand cmd =
com.aragost.javahg.commands.TagsCommand.on(open());
@@ -74,13 +65,11 @@ public class HgTagsCommand extends AbstractCommand implements TagsCommand
List<Tag> tags = null;
// check for empty repository
if (Util.isNotEmpty(tagList) && tagList.get(0).getChangeset() != null)
{
if (Util.isNotEmpty(tagList) && tagList.get(0).getChangeset() != null) {
tags = Lists.transform(tagList, new TagTransformer());
}
if (tags == null)
{
if (tags == null) {
tags = Lists.newArrayList();
}
@@ -92,31 +81,25 @@ public class HgTagsCommand extends AbstractCommand implements TagsCommand
/**
* Class description
*
*
* @version Enter version here..., 12/08/03
* @author Enter your name here...
* @author Enter your name here...
* @version Enter version here..., 12/08/03
*/
private static class TagTransformer
implements Function<com.aragost.javahg.Tag, Tag>
{
implements Function<com.aragost.javahg.Tag, Tag> {
/**
* Method description
*
*
* @param f
*
* @return
*/
@Override
public Tag apply(com.aragost.javahg.Tag f)
{
public Tag apply(com.aragost.javahg.Tag f) {
Tag t = null;
if ((f != null) &&!Strings.isNullOrEmpty(f.getName())
&& (f.getChangeset() != null))
{
t = new Tag(f.getName(), f.getChangeset().getNode());
if ((f != null) && !Strings.isNullOrEmpty(f.getName())
&& (f.getChangeset() != null)) {
t = new Tag(f.getName(), f.getChangeset().getNode(), f.getChangeset().getTimestamp().getDate().getTime());
}
return t;

31
scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/api/HgHookTagProviderTest.java
View File

@@ -21,15 +21,11 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package sonia.scm.repository.api;
import com.google.common.collect.Lists;
import java.util.List;
import org.junit.Test;
import static org.junit.Assert.*;
import static org.mockito.Mockito.*;
import static org.hamcrest.Matchers.*;
import org.junit.runner.RunWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
@@ -41,9 +37,16 @@ import sonia.scm.repository.spi.HookChangesetProvider;
import sonia.scm.repository.spi.HookChangesetRequest;
import sonia.scm.repository.spi.HookChangesetResponse;
import java.util.List;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.mockito.Mockito.when;
/**
* Unit tests for {@link HgHookTagProvider}.
*
*
* @author Sebastian Sdorra
*/
@RunWith(MockitoJUnitRunner.class)
@@ -51,7 +54,7 @@ public class HgHookTagProviderTest {
@Mock
private HookChangesetProvider changesetProvider;
@InjectMocks
private HgHookTagProvider tagProvider;
@@ -61,9 +64,9 @@ public class HgHookTagProviderTest {
@Test
public void testGetDeletedTags() {
prepareChangesets(new Changeset("1", Long.MIN_VALUE, null));
assertThat(tagProvider.getDeletedTags(), empty());
assertThat(tagProvider.getDeletedTags()).isEmpty();
}
/**
* Tests {@link HgHookTagProvider#getCreatedTags()}.
*/
@@ -71,22 +74,24 @@ public class HgHookTagProviderTest {
public void testGetCreatedTags(){
Changeset c1 = new Changeset("1", Long.MIN_VALUE, null);
c1.getTags().add("1.0.0");
Changeset c2 = new Changeset("2", Long.MIN_VALUE, null);
Changeset c2 = new Changeset("2", Long.MAX_VALUE, null);
c2.getTags().add("2.0.0");
Changeset c3 = new Changeset("3", Long.MIN_VALUE, null);
prepareChangesets(c1, c2, c3);
List<Tag> tags = tagProvider.getCreatedTags();
assertNotNull(tags);
assertEquals(2, tags.size());
Tag t1 = tags.get(0);
assertEquals("1", t1.getRevision());
assertEquals("1.0.0", t1.getName());
assertThat(t1.getDate()).contains(Long.MIN_VALUE);
Tag t2 = tags.get(1);
assertEquals("2", t2.getRevision());
assertEquals("2.0.0", t2.getName());
assertThat(t2.getDate()).contains(Long.MAX_VALUE);
}
private void prepareChangesets(Changeset... changesets){

45
scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgTagsCommandTest.java Normal file
View File

@@ -0,0 +1,45 @@
/*
* MIT License
*
* Copyright (c) 2020-present Cloudogu GmbH and Contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package sonia.scm.repository.spi;
import org.junit.Test;
import sonia.scm.repository.Tag;
import java.util.List;
import static org.assertj.core.api.Assertions.assertThat;
public class HgTagsCommandTest extends AbstractHgCommandTestBase {
@Test
public void shouldGetTagDatesCorrectly() {
HgTagsCommand hgTagsCommand = new HgTagsCommand(cmdContext);
final List<Tag> tags = hgTagsCommand.getTags();
assertThat(tags).hasSize(1);
assertThat(tags.get(0).getName()).isEqualTo("tip");
assertThat(tags.get(0).getDate()).contains(1339586381000L);
}
}

19
scm-webapp/src/main/java/sonia/scm/api/v2/resources/DefaultChangesetToChangesetDtoMapper.java
View File

@@ -29,13 +29,15 @@ import de.otto.edison.hal.Links;
import org.mapstruct.Context;
import org.mapstruct.Mapper;
import org.mapstruct.ObjectFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import sonia.scm.repository.Branch;
import sonia.scm.repository.Changeset;
import sonia.scm.repository.Contributor;
import sonia.scm.repository.Person;
import sonia.scm.repository.Repository;
import sonia.scm.repository.Signature;
import sonia.scm.repository.Tag;
import sonia.scm.repository.Tags;
import sonia.scm.repository.api.Command;
import sonia.scm.repository.api.RepositoryService;
import sonia.scm.repository.api.RepositoryServiceFactory;
@@ -45,6 +47,7 @@ import sonia.scm.security.gpg.RawGpgKey;
import sonia.scm.web.EdisonHalAppender;
import javax.inject.Inject;
import java.io.IOException;
import java.util.List;
import java.util.Optional;
import java.util.function.Function;
@@ -57,6 +60,8 @@ import static de.otto.edison.hal.Links.linkingTo;
@Mapper
public abstract class DefaultChangesetToChangesetDtoMapper extends HalAppenderMapper implements InstantAttributeMapper, ChangesetToChangesetDtoMapper {
private static Logger LOG = LoggerFactory.getLogger(DefaultChangesetToChangesetDtoMapper.class);
@Inject
private RepositoryServiceFactory serviceFactory;
@@ -115,8 +120,16 @@ public abstract class DefaultChangesetToChangesetDtoMapper extends HalAppenderMa
try (RepositoryService repositoryService = serviceFactory.create(repository)) {
if (repositoryService.isSupported(Command.TAGS)) {
embeddedBuilder.with("tags", tagCollectionToDtoMapper.getTagDtoList(namespace, name,
getListOfObjects(source.getTags(), tagName -> new Tag(tagName, source.getId()))));
Tags tags = null;
try {
tags = repositoryService.getTagsCommand().getTags();
} catch (IOException e) {
LOG.error("Error while retrieving tags from repository", e);
}
if (tags != null) {
embeddedBuilder.with("tags", tagCollectionToDtoMapper.getTagDtoList(namespace, name,
getListOfObjects(source.getTags(), tags::getTagByName)));
}
}
if (repositoryService.isSupported(Command.BRANCHES)) {
embeddedBuilder.with("branches", branchCollectionToDtoMapper.getBranchDtoList(namespace, name,

8
scm-webapp/src/main/java/sonia/scm/api/v2/resources/TagDto.java
View File

@@ -21,9 +21,10 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package sonia.scm.api.v2.resources;
import com.fasterxml.jackson.annotation.JsonInclude;
import de.otto.edison.hal.Embedded;
import de.otto.edison.hal.HalRepresentation;
import de.otto.edison.hal.Links;
@@ -31,6 +32,8 @@ import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import java.time.Instant;
@Getter
@Setter
@NoArgsConstructor
@@ -40,6 +43,9 @@ public class TagDto extends HalRepresentation {
private String revision;
@JsonInclude(JsonInclude.Include.NON_NULL)
private Instant date;
TagDto(Links links, Embedded embedded) {
super(links, embedded);
}

10
scm-webapp/src/main/java/sonia/scm/api/v2/resources/TagToTagDtoMapper.java
View File

@@ -29,6 +29,7 @@ import de.otto.edison.hal.Links;
import org.mapstruct.Context;
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Named;
import org.mapstruct.ObjectFactory;
import sonia.scm.repository.NamespaceAndName;
import sonia.scm.repository.Tag;
@@ -36,6 +37,9 @@ import sonia.scm.web.EdisonHalAppender;
import javax.inject.Inject;
import java.time.Instant;
import java.util.Optional;
import static de.otto.edison.hal.Embedded.embeddedBuilder;
import static de.otto.edison.hal.Link.link;
import static de.otto.edison.hal.Links.linkingTo;
@@ -46,6 +50,7 @@ public abstract class TagToTagDtoMapper extends HalAppenderMapper {
@Inject
private ResourceLinks resourceLinks;
@Mapping(target = "date", source = "date", qualifiedByName = "mapDate")
@Mapping(target = "attributes", ignore = true) // We do not map HAL attributes
public abstract TagDto map(Tag tag, @Context NamespaceAndName namespaceAndName);
@@ -61,4 +66,9 @@ public abstract class TagToTagDtoMapper extends HalAppenderMapper {
return new TagDto(linksBuilder.build(), embeddedBuilder.build());
}
@Named("mapDate")
Instant map(Optional<Long> value) {
return value.map(Instant::ofEpochMilli).orElse(null);
}
}

8
scm-webapp/src/test/java/sonia/scm/api/v2/resources/TagToTagDtoMapperTest.java
View File

@@ -32,6 +32,7 @@ import sonia.scm.repository.NamespaceAndName;
import sonia.scm.repository.Tag;
import java.net.URI;
import java.time.Instant;
import static org.assertj.core.api.Assertions.assertThat;
@@ -58,4 +59,11 @@ class TagToTagDtoMapperTest {
assertThat(dto.getLinks().getLinkBy("yo").get().getHref()).isEqualTo("http://hitchhiker/hog/1.0.0");
}
@Test
void shouldMapDate() {
final long now = Instant.now().getEpochSecond() * 1000;
TagDto dto = mapper.map(new Tag("1.0.0", "42", now), new NamespaceAndName("hitchhiker", "hog"));
assertThat(dto.getDate()).isEqualTo(Instant.ofEpochMilli(now));
}
}