Implement git config v2 endpoint

pom.xml

@@ -492,6 +492,7 @@
     <jersey-client.version>1.19.4</jersey-client.version>
     <jackson.version>2.8.6</jackson.version>
     <guice.version>4.0</guice.version>
+    <resteasy.version>3.1.3.Final</resteasy.version>
     
     <!-- event bus -->
     <legman.version>1.2.0</legman.version>

scm-core/src/main/java/sonia/scm/web/VndMediaType.java

@@ -9,8 +9,8 @@ public class VndMediaType {
   private static final String VERSION = "2";
   private static final String TYPE = "application";
   private static final String SUBTYPE_PREFIX = "vnd.scmm-";
-  private static final String PREFIX = TYPE + "/" + SUBTYPE_PREFIX;
-  private static final String SUFFIX = "+json;v=" + VERSION;
+  public static final String PREFIX = TYPE + "/" + SUBTYPE_PREFIX;
+  public static final String SUFFIX = "+json;v=" + VERSION;
 
   public static final String USER = PREFIX + "user" + SUFFIX;
   public static final String GROUP = PREFIX + "group" + SUFFIX;

scm-plugins/pom.xml

@@ -56,6 +56,79 @@
       <scope>test</scope>
     </dependency>
 
+    <!-- rest documentation -->
+
+    <dependency>
+      <groupId>com.webcohesion.enunciate</groupId>
+      <artifactId>enunciate-core-annotations</artifactId>
+      <version>${enunciate.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>org.mapstruct</groupId>
+      <artifactId>mapstruct-jdk8</artifactId>
+      <version>${org.mapstruct.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>org.mapstruct</groupId>
+      <artifactId>mapstruct-processor</artifactId>
+      <version>${org.mapstruct.version}</version>
+      <scope>provided</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>de.otto.edison</groupId>
+      <artifactId>edison-hal</artifactId>
+      <version>2.0.1</version>
+      <scope>compile</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.projectlombok</groupId>
+      <artifactId>lombok</artifactId>
+      <version>1.16.18</version>
+      <scope>provided</scope>
+    </dependency>
+
+    <!-- rest api -->
+
+    <dependency>
+      <groupId>org.jboss.resteasy</groupId>
+      <artifactId>resteasy-jaxrs</artifactId>
+      <version>${resteasy.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>org.jboss.resteasy</groupId>
+      <artifactId>resteasy-jaxb-provider</artifactId>
+      <version>${resteasy.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>org.jboss.resteasy</groupId>
+      <artifactId>resteasy-jackson2-provider</artifactId>
+      <version>${resteasy.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>org.jboss.resteasy</groupId>
+      <artifactId>resteasy-multipart-provider</artifactId>
+      <version>${resteasy.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>org.jboss.resteasy</groupId>
+      <artifactId>resteasy-guice</artifactId>
+      <version>${resteasy.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>org.jboss.resteasy</groupId>
+      <artifactId>resteasy-servlet-initializer</artifactId>
+      <version>${resteasy.version}</version>
+    </dependency>
+
   </dependencies>
 
   <build>
@@ -112,6 +185,10 @@
     </plugins>
   </build>
 
+  <properties>
+    <enunciate.version>2.9.1</enunciate.version>
+  </properties>
+
   <profiles>
     <profile>
       <id>release</id>

scm-plugins/scm-git-plugin/pom.xml

@@ -59,6 +59,20 @@
       <scope>test</scope>
     </dependency>
 
+    <dependency>
+      <groupId>com.sun.jersey</groupId>
+      <artifactId>jersey-client</artifactId>
+      <version>${jersey-client.version}</version>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>com.sun.jersey.contribs</groupId>
+      <artifactId>jersey-apache-client</artifactId>
+      <version>${jersey-client.version}</version>
+      <scope>test</scope>
+    </dependency>
+
   </dependencies>
   
   <!-- create test jar -->

scm-plugins/scm-git-plugin/src/main/java/sonia/scm/api/v2/resources/GitConfigDto.java

@@ -0,0 +1,23 @@
+package sonia.scm.api.v2.resources;
+
+import de.otto.edison.hal.HalRepresentation;
+import de.otto.edison.hal.Links;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+
+import javax.xml.bind.annotation.XmlElement;
+
+@NoArgsConstructor
+@Getter
+@Setter
+public class GitConfigDto extends SimpleRepositoryConfigDto {
+
+  @XmlElement(name = "gc-expression")
+  private String gcExpression;
+
+  @Override
+  protected HalRepresentation add(Links links) {
+    return super.add(links);
+  }
+}

scm-plugins/scm-git-plugin/src/main/java/sonia/scm/api/v2/resources/GitConfigDtoToGitConfigMapper.java

@@ -0,0 +1,11 @@
+package sonia.scm.api.v2.resources;
+
+import org.mapstruct.Mapper;
+import sonia.scm.repository.GitConfig;
+
+// Mapstruct does not support parameterized (i.e. non-default) constructors. Thus, we need to use field injection.
+@SuppressWarnings("squid:S3306")
+@Mapper
+public abstract class GitConfigDtoToGitConfigMapper {
+  public abstract GitConfig map(GitConfigDto dto);
+}

scm-plugins/scm-git-plugin/src/main/java/sonia/scm/api/v2/resources/GitConfigResource.java

@@ -0,0 +1,93 @@
+package sonia.scm.api.v2.resources;
+
+import com.webcohesion.enunciate.metadata.rs.ResponseCode;
+import com.webcohesion.enunciate.metadata.rs.StatusCodes;
+import com.webcohesion.enunciate.metadata.rs.TypeHint;
+import org.apache.shiro.SecurityUtils;
+import sonia.scm.repository.GitConfig;
+import sonia.scm.repository.GitRepositoryHandler;
+import sonia.scm.security.Role;
+import sonia.scm.web.GitVndMediaType;
+
+import javax.inject.Inject;
+import javax.ws.rs.*;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.UriInfo;
+
+@Path(GitConfigResource.GIT_CONFIG_PATH_V2)
+public class GitConfigResource {
+
+  static final String GIT_CONFIG_PATH_V2 = "v2/config/repository/git";
+  private final GitConfigDtoToGitConfigMapper dtoToConfigMapper;
+  private final GitConfigToGitConfigDtoMapper configToDtoMapper;
+  private final GitRepositoryHandler repositoryHandler;
+
+  @Inject
+  public GitConfigResource(GitConfigDtoToGitConfigMapper dtoToConfigMapper, GitConfigToGitConfigDtoMapper configToDtoMapper, GitRepositoryHandler repositoryHandler) {
+    this.dtoToConfigMapper = dtoToConfigMapper;
+    this.configToDtoMapper = configToDtoMapper;
+    this.repositoryHandler = repositoryHandler;
+  }
+
+  /**
+   * Returns the git config.
+   */
+  @GET
+  @Path("")
+  @Produces(GitVndMediaType.GIT_CONFIG)
+  @TypeHint(GitConfigDto.class)
+  @StatusCodes({
+    @ResponseCode(code = 200, condition = "success"),
+    @ResponseCode(code = 401, condition = "not authenticated / invalid credentials"),
+    @ResponseCode(code = 403, condition = "not authorized, the current user has no privileges to read the git config"),
+    @ResponseCode(code = 500, condition = "internal server error")
+  })
+  public Response get() {
+    Response response;
+
+    if (SecurityUtils.getSubject().hasRole(Role.ADMIN)) {
+      GitConfig config = repositoryHandler.getConfig();
+
+      if (config == null) {
+        config = new GitConfig();
+        repositoryHandler.setConfig(config);
+      }
+
+      response = Response.ok(configToDtoMapper.map(config)).build();
+    } else {
+      response = Response.status(Response.Status.FORBIDDEN).build();
+    }
+
+    return response;
+  }
+
+  /**
+   * Modifies the git config.
+   *
+   * @param configDto new git configuration as DTO
+   */
+  @PUT
+  @Path("")
+  @Consumes(GitVndMediaType.GIT_CONFIG)
+  @StatusCodes({
+    @ResponseCode(code = 201, condition = "update success"),
+    @ResponseCode(code = 401, condition = "not authenticated / invalid credentials"),
+    @ResponseCode(code = 403, condition = "not authorized, the current user has no privileges to update the git config"),
+    @ResponseCode(code = 500, condition = "internal server error")
+  })
+  @TypeHint(TypeHint.NO_CONTENT.class)
+  public Response update(@Context UriInfo uriInfo, GitConfigDto configDto) {
+    Response response;
+
+    if (SecurityUtils.getSubject().hasRole(Role.ADMIN)) {
+      repositoryHandler.setConfig(dtoToConfigMapper.map(configDto));
+      repositoryHandler.storeConfig();
+      response = Response.created(uriInfo.getRequestUri()).build();
+    } else {
+      response = Response.status(Response.Status.FORBIDDEN).build();
+    }
+
+    return response;
+  }
+}

scm-plugins/scm-git-plugin/src/main/java/sonia/scm/api/v2/resources/GitConfigToGitConfigDtoMapper.java

@@ -0,0 +1,45 @@
+package sonia.scm.api.v2.resources;
+
+import de.otto.edison.hal.Links;
+import org.apache.shiro.SecurityUtils;
+import org.mapstruct.AfterMapping;
+import org.mapstruct.Mapper;
+import org.mapstruct.MappingTarget;
+import sonia.scm.repository.GitConfig;
+import sonia.scm.security.Role;
+
+import javax.inject.Inject;
+
+import static de.otto.edison.hal.Link.link;
+import static de.otto.edison.hal.Links.linkingTo;
+
+// Mapstruct does not support parameterized (i.e. non-default) constructors. Thus, we need to use field injection.
+@SuppressWarnings("squid:S3306")
+@Mapper
+public abstract class GitConfigToGitConfigDtoMapper {
+
+  @Inject
+  private UriInfoStore uriInfoStore;
+
+  public abstract GitConfigDto map(GitConfig config);
+
+  @AfterMapping
+  void appendLinks(GitConfig config, @MappingTarget GitConfigDto target) {
+    Links.Builder linksBuilder = linkingTo().self(self());
+    // TODO: ConfigPermissions?
+    if (SecurityUtils.getSubject().hasRole(Role.ADMIN)) {
+      linksBuilder.single(link("update", update()));
+    }
+    target.add(linksBuilder.build());
+  }
+
+  private String self() {
+    LinkBuilder linkBuilder = new LinkBuilder(uriInfoStore.get(), GitConfigResource.class);
+    return linkBuilder.method("get").parameters().href();
+  }
+
+  private String update() {
+    LinkBuilder linkBuilder = new LinkBuilder(uriInfoStore.get(), GitConfigResource.class);
+    return linkBuilder.method("update").parameters().href();
+  }
+}

scm-plugins/scm-git-plugin/src/main/java/sonia/scm/api/v2/resources/MapperModule.java

@@ -0,0 +1,16 @@
+package sonia.scm.api.v2.resources;
+
+import com.google.inject.AbstractModule;
+import com.google.inject.servlet.ServletScopes;
+import org.mapstruct.factory.Mappers;
+
+public class MapperModule extends AbstractModule {
+  @Override
+  protected void configure() {
+
+    bind(GitConfigDtoToGitConfigMapper.class).to(Mappers.getMapper(GitConfigDtoToGitConfigMapper.class).getClass());
+    bind(GitConfigToGitConfigDtoMapper.class).to(Mappers.getMapper(GitConfigToGitConfigDtoMapper.class).getClass());
+
+    bind(UriInfoStore.class).in(ServletScopes.REQUEST);
+  }
+}

scm-plugins/scm-git-plugin/src/main/java/sonia/scm/api/v2/resources/SimpleRepositoryConfigDto.java

@@ -0,0 +1,17 @@
+package sonia.scm.api.v2.resources;
+
+import de.otto.edison.hal.HalRepresentation;
+import lombok.Getter;
+import lombok.Setter;
+
+import javax.xml.bind.annotation.XmlElement;
+import java.io.File;
+
+@Getter
+@Setter
+public abstract class SimpleRepositoryConfigDto extends HalRepresentation {
+
+  private boolean disabled = false;
+  @XmlElement(name = "repository-directory")
+  private File repositoryDirectory;
+}

scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitConfig.java

@@ -56,4 +56,7 @@ public class GitConfig extends SimpleRepositoryConfig {
     return gcExpression;
   }
 
+  public void setGcExpression(String gcExpression) {
+    this.gcExpression = gcExpression;
+  }
 }

scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitVndMediaType.java

@@ -0,0 +1,5 @@
+package sonia.scm.web;
+
+public class GitVndMediaType {
+  public static final String GIT_CONFIG = VndMediaType.PREFIX + "gitConfig" + VndMediaType.SUFFIX;
+}

scm-plugins/scm-git-plugin/src/test/java/sonia/scm/api/v2/resources/GitConfigDtoToGitConfigMapperTest.java

@@ -0,0 +1,35 @@
+package sonia.scm.api.v2.resources;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.InjectMocks;
+import org.mockito.runners.MockitoJUnitRunner;
+import sonia.scm.repository.GitConfig;
+
+import java.io.File;
+
+import static org.junit.Assert.assertEquals;
+
+@RunWith(MockitoJUnitRunner.class)
+public class GitConfigDtoToGitConfigMapperTest {
+
+  @InjectMocks
+  private GitConfigDtoToGitConfigMapperImpl mapper;
+
+  @Test
+  public void shouldMapFields() {
+    GitConfigDto dto = createDefaultDto();
+    GitConfig config = mapper.map(dto);
+    assertEquals("express", config.getGcExpression());
+    assertEquals("repository/directory", config.getRepositoryDirectory().getPath());
+    assertEquals(false, config.isDisabled());
+  }
+
+  private GitConfigDto createDefaultDto() {
+    GitConfigDto gitConfigDto = new GitConfigDto();
+    gitConfigDto.setGcExpression("express");
+    gitConfigDto.setDisabled(false);
+    gitConfigDto.setRepositoryDirectory(new File("repository/directory"));
+    return gitConfigDto;
+  }
+}

scm-plugins/scm-git-plugin/src/test/java/sonia/scm/api/v2/resources/GitConfigToGitConfigDtoMapperTest.java

@@ -0,0 +1,77 @@
+package sonia.scm.api.v2.resources;
+
+import org.apache.shiro.subject.Subject;
+import org.apache.shiro.subject.support.SubjectThreadState;
+import org.apache.shiro.util.ThreadContext;
+import org.apache.shiro.util.ThreadState;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Answers;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
+import sonia.scm.repository.GitConfig;
+import sonia.scm.security.Role;
+
+import java.io.File;
+import java.net.URI;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+@RunWith(MockitoJUnitRunner.class)
+public class GitConfigToGitConfigDtoMapperTest {
+
+  private URI baseUri = URI.create("http://example.com/base/");
+
+  @Mock(answer = Answers.RETURNS_DEEP_STUBS)
+  private UriInfoStore uriInfoStore;
+
+  @InjectMocks
+  private GitConfigToGitConfigDtoMapperImpl mapper;
+
+  private final Subject subject = mock(Subject.class);
+  private final ThreadState subjectThreadState = new SubjectThreadState(subject);
+
+  private URI expectedBaseUri;
+
+  @Before
+  public void init() {
+    when(uriInfoStore.get().getBaseUri()).thenReturn(baseUri);
+    expectedBaseUri = baseUri.resolve(GitConfigResource.GIT_CONFIG_PATH_V2);
+    subjectThreadState.bind();
+    ThreadContext.bind(subject);
+  }
+
+  @After
+  public void unbindSubject() {
+    ThreadContext.unbindSubject();
+  }
+
+  @Test
+  public void shouldMapFields() {
+    GitConfig config = createConfiguration();
+
+    when(subject.hasRole(Role.ADMIN)).thenReturn(true);
+    GitConfigDto dto = mapper.map(config);
+
+    assertEquals("express", dto.getGcExpression());
+    assertFalse(dto.isDisabled());
+    assertEquals("repository/directory", dto.getRepositoryDirectory().getPath());
+    assertEquals(expectedBaseUri.toString(), dto.getLinks().getLinkBy("self").get().getHref());
+    assertEquals(expectedBaseUri.toString(), dto.getLinks().getLinkBy("update").get().getHref());
+  }
+
+  private GitConfig createConfiguration() {
+    GitConfig config = new GitConfig();
+    config.setDisabled(false);
+    config.setRepositoryDirectory(new File("repository/directory"));
+    config.setGcExpression("express");
+    return config;
+  }
+
+}

scm-webapp/pom.xml

@@ -561,7 +561,6 @@
     <enunciate.version>2.9.1</enunciate.version>
     <wagon.version>1.0</wagon.version>
     <mustache.version>0.8.17</mustache.version>
-    <resteasy.version>3.1.3.Final</resteasy.version>
     <netbeans.hint.deploy.server>Tomcat</netbeans.hint.deploy.server>
     <sonar.issue.ignore.multicriteria>e1</sonar.issue.ignore.multicriteria>
     <sonar.issue.ignore.multicriteria.e1.ruleKey>javascript:S3827</sonar.issue.ignore.multicriteria.e1.ruleKey>