Add ConfigurationAdapterBase and extension points for trash bin

Adds the new abstract class ConfigurationAdapterBase to simplify the creation of global configuration views. In addition there is some cleanup, interfaces and extension points for the repository trash bin plugin.

Committed-by: Eduard Heimbuch <eduard.heimbuch@cloudogu.com>
Co-authored-by: Eduard Heimbuch <eduard.heimbuch@cloudogu.com>
Co-authored-by: René Pfeuffer <rene.pfeuffer@cloudogu.com>
Co-authored-by: Konstantin Schaper <konstantin.schaper@cloudogu.com>

scm-webapp/src/test/java/sonia/scm/api/v2/resources/ConfigurationAdapterBaseTest.java

@@ -0,0 +1,213 @@
+/*
+ * 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.api.v2.resources;
+
+import de.otto.edison.hal.Embedded;
+import de.otto.edison.hal.HalRepresentation;
+import de.otto.edison.hal.Links;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import org.github.sdorra.jse.ShiroExtension;
+import org.github.sdorra.jse.SubjectAware;
+import org.jboss.resteasy.mock.MockHttpRequest;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Answers;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import sonia.scm.store.ConfigurationStore;
+import sonia.scm.store.ConfigurationStoreFactory;
+import sonia.scm.web.JsonMockHttpRequest;
+import sonia.scm.web.JsonMockHttpResponse;
+import sonia.scm.web.RestDispatcher;
+
+import javax.inject.Inject;
+import javax.inject.Provider;
+import javax.validation.constraints.Max;
+import javax.validation.constraints.Min;
+import javax.validation.constraints.NotBlank;
+import javax.ws.rs.Path;
+import javax.ws.rs.core.MediaType;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.Optional;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.lenient;
+import static org.mockito.Mockito.when;
+
+@ExtendWith({MockitoExtension.class, ShiroExtension.class})
+@SubjectAware(value = "trillian")
+class ConfigurationAdapterBaseTest {
+
+  @Mock
+  private ConfigurationStore<TestConfiguration> configStore;
+
+  @Mock(answer = Answers.RETURNS_DEEP_STUBS)
+  private ConfigurationStoreFactory configurationStoreFactory;
+
+  @Mock
+  private Provider<ScmPathInfoStore> scmPathInfoStore;
+
+  private RestDispatcher dispatcher;
+  private final JsonMockHttpResponse response = new JsonMockHttpResponse();
+
+  @BeforeEach
+  void initResource() {
+    when(configurationStoreFactory.withType(TestConfiguration.class).withName("test-config").build()).thenReturn(configStore);
+    ScmPathInfoStore pathInfoStore = new ScmPathInfoStore();
+    pathInfoStore.set(() -> URI.create("v2/test"));
+    lenient().when(scmPathInfoStore.get()).thenReturn(pathInfoStore);
+    TestConfigurationAdapter resource = new TestConfigurationAdapter(configurationStoreFactory, scmPathInfoStore);
+
+    dispatcher = new RestDispatcher();
+    dispatcher.addSingletonResource(resource);
+  }
+
+  @Test
+  void shouldThrowBadRequestErrorWhenUpdatingWithNullPayload() throws URISyntaxException {
+    MockHttpRequest request = MockHttpRequest.put("/v2/test")
+      .contentType(MediaType.APPLICATION_JSON);
+
+    dispatcher.invoke(request, response);
+
+    assertThat(response.getStatus()).isEqualTo(400);
+  }
+
+  @Test
+  void shouldThrowAuthorizationExceptionWithoutPermissionOnRead() throws URISyntaxException {
+    MockHttpRequest request = MockHttpRequest.get("/v2/test");
+
+    dispatcher.invoke(request, response);
+
+    assertThat(response.getStatus()).isEqualTo(403);
+  }
+
+  @Test
+  void shouldThrowAuthorizationExceptionWithoutPermissionOnUpdate() throws URISyntaxException {
+    JsonMockHttpRequest request = JsonMockHttpRequest.put("/v2/test")
+      .contentType(MediaType.APPLICATION_JSON)
+      .json("{\"number\": 3, \"text\" : \"https://scm-manager.org/\"}");
+
+    dispatcher.invoke(request, response);
+
+    assertThat(response.getStatus()).isEqualTo(403);
+  }
+
+  @Nested
+  @SubjectAware(permissions = "configuration:read,write:testConfig")
+  class WithPermission {
+
+    @Test
+    void shouldGetDefaultDao() throws URISyntaxException {
+      when(configStore.getOptional()).thenReturn(Optional.empty());
+      MockHttpRequest request = MockHttpRequest.get("/v2/test");
+
+      dispatcher.invoke(request, response);
+
+      assertThat(response.getStatus()).isEqualTo(200);
+      assertThat(response.getContentAsJson().get("number").asInt()).isEqualTo(4);
+      assertThat(response.getContentAsJson().get("text").textValue()).isEqualTo("myTest");
+    }
+
+    @Test
+    void shouldGetStoredDao() throws URISyntaxException {
+      when(configStore.getOptional()).thenReturn(Optional.of(new TestConfiguration(3, "secret")));
+
+      MockHttpRequest request = MockHttpRequest.get("/v2/test");
+
+      dispatcher.invoke(request, response);
+
+      assertThat(response.getStatus()).isEqualTo(200);
+      assertThat(response.getContentAsJson().get("number").asInt()).isEqualTo(3);
+      assertThat(response.getContentAsJson().get("text").textValue()).isEqualTo("secret");
+    }
+
+    @Test
+    void shouldThrowBadRequestErrorWhenUpdatingWithInvalidPayload() throws URISyntaxException {
+      JsonMockHttpRequest request = JsonMockHttpRequest.put("/v2/test")
+        .contentType(MediaType.APPLICATION_JSON)
+        .json("{\"number\": 42, \"text\" : \"https://scm-manager.org/\"}");
+
+      dispatcher.invoke(request, response);
+
+      assertThat(response.getStatus()).isEqualTo(400);
+    }
+  }
+
+  @AllArgsConstructor
+  @NoArgsConstructor
+  @Getter
+  @Setter
+  static class TestConfiguration {
+    private int number = 4;
+    private String text = "myTest";
+  }
+
+  @NoArgsConstructor
+  @Getter
+  @Setter
+  static class TestConfigurationDto extends HalRepresentation {
+
+    @Min(2)
+    @Max(6)
+    private int number;
+
+    @NotBlank
+    private String text;
+
+    public TestConfigurationDto(int number, String text) {
+      super(Links.emptyLinks(), Embedded.emptyEmbedded());
+      this.number = number;
+      this.text = text;
+    }
+
+    public static TestConfigurationDto from(TestConfiguration configuration, Links links) {
+      return new TestConfigurationDto(configuration.number, configuration.text);
+    }
+
+    public TestConfiguration toEntity() {
+      return new TestConfiguration(number, text);
+    }
+  }
+
+  @Path("/v2/test")
+  private static class TestConfigurationAdapter extends ConfigurationAdapterBase<TestConfiguration, TestConfigurationDto> {
+
+    @Inject
+    public TestConfigurationAdapter(ConfigurationStoreFactory configurationStoreFactory, Provider<ScmPathInfoStore> scmPathInfoStoreProvider) {
+      super(configurationStoreFactory, scmPathInfoStoreProvider, TestConfiguration.class, TestConfigurationDto.class);
+    }
+
+    @Override
+    protected String getName() {
+      return "testConfig";
+    }
+  }
+}

scm-webapp/src/test/java/sonia/scm/importexport/FullScmRepositoryExporterTest.java

@@ -39,6 +39,8 @@ import sonia.scm.repository.api.BundleCommandBuilder;
 import sonia.scm.repository.api.RepositoryService;
 import sonia.scm.repository.api.RepositoryServiceFactory;
 import sonia.scm.repository.work.WorkdirProvider;
+import sonia.scm.web.security.AdministrationContext;
+import sonia.scm.web.security.PrivilegedAction;
 
 import java.io.ByteArrayOutputStream;
 import java.io.File;
@@ -79,6 +81,8 @@ class FullScmRepositoryExporterTest {
   @Mock
   private RepositoryExportingCheck repositoryExportingCheck;
   @Mock
+  private AdministrationContext administrationContext;
+  @Mock
   private RepositoryImportExportEncryption repositoryImportExportEncryption;
 
   @InjectMocks
@@ -89,14 +93,13 @@ class FullScmRepositoryExporterTest {
   @BeforeEach
   void initRepoService() throws IOException {
     when(serviceFactory.create(REPOSITORY)).thenReturn(repositoryService);
-    when(environmentGenerator.generate()).thenReturn(new byte[0]);
     when(metadataGenerator.generate(REPOSITORY)).thenReturn(new byte[0]);
     when(repositoryExportingCheck.withExportingLock(any(), any())).thenAnswer(invocation -> invocation.getArgument(1, Supplier.class).get());
     when(repositoryImportExportEncryption.optionallyEncrypt(any(), any())).thenAnswer(invocation -> invocation.getArgument(0));
   }
 
   @Test
-  void shouldExportEverythingAsTarArchive(@TempDir Path temp) throws IOException {
+  void shouldExportEverythingAsTarArchive(@TempDir Path temp) {
     BundleCommandBuilder bundleCommandBuilder = mock(BundleCommandBuilder.class);
     when(repositoryService.getBundleCommand()).thenReturn(bundleCommandBuilder);
     when(repositoryService.getRepository()).thenReturn(REPOSITORY);
@@ -105,7 +108,7 @@ class FullScmRepositoryExporterTest {
     exporter.export(REPOSITORY, baos, "");
 
     verify(storeExporter, times(1)).export(eq(REPOSITORY), any(OutputStream.class));
-    verify(environmentGenerator, times(1)).generate();
+    verify(administrationContext, times(1)).runAsAdmin(any(PrivilegedAction.class));
     verify(metadataGenerator, times(1)).generate(REPOSITORY);
     verify(bundleCommandBuilder, times(1)).bundle(any(OutputStream.class));
     verify(repositoryExportingCheck).withExportingLock(eq(REPOSITORY), any());