Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2026-06-19 20:19:33 +02:00
Code Issues Packages Projects Releases Activity

Add queryable store with SQLite implementation

Browse Source 
This adds the new "queryable store" API, that allows complex
queries and is backed by SQLite. This new API can be used
for entities annotated with the new QueryableType annotation.
This commit is contained in:
Rene Pfeuffer
2025-04-01 16:18:04 +02:00
parent d5362d634b
commit ada575d871
235 changed files with 10154 additions and 252 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
scm-it/src/test/java/sonia/scm/it/ExportITCase.java Normal file
View File

@@ -0,0 +1,68 @@
/*
* Copyright (c) 2020 - present Cloudogu GmbH
*
* This program is free software: you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License as published by the Free
* Software Foundation, version 3.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
package sonia.scm.it;
import org.junit.Before;
import org.junit.Test;
import sonia.scm.it.utils.ScmRequests;
import sonia.scm.it.utils.TestData;
import java.nio.file.Path;
import java.util.List;
import static org.assertj.core.api.Assertions.assertThat;
import static sonia.scm.it.utils.RestUtil.ADMIN_PASSWORD;
import static sonia.scm.it.utils.RestUtil.ADMIN_USERNAME;
public class ExportITCase {
@Before
public void init() {
TestData.cleanup();
}
@Test
public void shouldExportAndImportRepository() {
String namespace = ADMIN_USERNAME;
TestData.createDefault();
String repo = TestData.getDefaultRepoName("git");
ScmRequests.start()
.requestIndexResource(ADMIN_USERNAME, ADMIN_PASSWORD)
.requestRepository(namespace, repo)
.writeTestData("value");
Path exportFile = ScmRequests.start()
.requestIndexResource(ADMIN_USERNAME, ADMIN_PASSWORD)
.requestRepository(namespace, repo)
.requestFullExport()
.exportFile();
ScmRequests.start()
.requestIndexResource(ADMIN_USERNAME, ADMIN_PASSWORD)
.requestRepositoryType("git")
.requestImport("fullImport", exportFile, "imported");
List<String> importedTestData = ScmRequests.start()
.requestIndexResource(ADMIN_USERNAME, ADMIN_PASSWORD)
.requestRepository(namespace, "imported")
.requestTestData()
.getTestData();
assertThat(importedTestData).containsExactly("value");
}
}

141
scm-it/src/test/java/sonia/scm/it/utils/ScmRequests.java
View File

@@ -18,15 +18,23 @@ package sonia.scm.it.utils;
import io.restassured.RestAssured;
import io.restassured.response.Response;
import io.restassured.specification.RequestSpecification;
import org.junit.Assert;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import sonia.scm.api.v2.resources.RepositoryDto;
import sonia.scm.web.VndMediaType;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import static jakarta.ws.rs.core.MediaType.APPLICATION_JSON;
import static java.nio.file.StandardCopyOption.REPLACE_EXISTING;
import static org.hamcrest.Matchers.is;
import static sonia.scm.it.utils.TestData.createPasswordChangeJson;
@@ -41,6 +49,7 @@ import static sonia.scm.it.utils.TestData.createPasswordChangeJson;
* that return the *Response class containing specific operations related to the specific response
* the *Response class contains also the request*() method to apply the next GET request from a link in the response.
*/
@SuppressWarnings("rawtypes")
public class ScmRequests {
private static final Logger LOG = LoggerFactory.getLogger(ScmRequests.class);
@@ -65,13 +74,13 @@ public class ScmRequests {
public UserResponse<UserResponse> requestUser(String username, String password, String pathParam) {
setUsername(username);
setPassword(password);
return new UserResponse<>(applyGETRequest(RestUtil.REST_BASE_URL.resolve("users/"+pathParam).toString()), null);
return new UserResponse<>(applyGETRequest(RestUtil.REST_BASE_URL.resolve("users/" + pathParam).toString()), null);
}
public ChangePasswordResponse<ChangePasswordResponse> requestUserChangePassword(String username, String password, String userPathParam, String newPassword) {
setUsername(username);
setPassword(password);
return new ChangePasswordResponse<>(applyPUTRequest(RestUtil.REST_BASE_URL.resolve("users/"+userPathParam+"/password").toString(), VndMediaType.PASSWORD_OVERWRITE, TestData.createPasswordChangeJson(password,newPassword)), null);
return new ChangePasswordResponse<>(applyPUTRequest(RestUtil.REST_BASE_URL.resolve("users/" + userPathParam + "/password").toString(), VndMediaType.PASSWORD_OVERWRITE, TestData.createPasswordChangeJson(password, newPassword)), null);
}
@SuppressWarnings("unchecked")
@@ -80,6 +89,11 @@ public class ScmRequests {
return new ModelResponse(response, null);
}
public RequestSpecification withBasicAuth() {
return RestAssured.given()
.auth().preemptive().basic(username, password);
}
/**
* Apply a GET Request to the extracted url from the given link
*
@@ -117,13 +131,12 @@ public class ScmRequests {
*/
private Response applyGETRequestWithQueryParams(String url, String params) {
LOG.info("GET {}", url);
if (username == null || password == null){
if (username == null || password == null) {
return RestAssured.given()
.when()
.get(url + params);
}
return RestAssured.given()
.auth().preemptive().basic(username, password)
return withBasicAuth()
.when()
.get(url + params);
}
@@ -138,13 +151,11 @@ public class ScmRequests {
return applyGETRequestWithQueryParams(url, "");
}
/**
* Apply a PUT Request to the extracted url from the given link
*
* @param response the response containing the link
* @param linkPropertyName the property name of link
* @param body
* @return the response of the PUT request using the given link
*/
private Response applyPUTRequestFromLink(Response response, String linkPropertyName, String content, String body) {
@@ -158,15 +169,12 @@ public class ScmRequests {
/**
* Apply a PUT Request to the given <code>url</code> and return the response.
*
* @param url the url of the PUT request
* @param mediaType
* @param body
* @param url the url of the PUT request
* @return the response of the PUT request using the given <code>url</code>
*/
private Response applyPUTRequest(String url, String mediaType, String body) {
LOG.info("PUT {}", url);
return RestAssured.given()
.auth().preemptive().basic(username, password)
return withBasicAuth()
.when()
.contentType(mediaType)
.accept(mediaType)
@@ -174,6 +182,37 @@ public class ScmRequests {
.put(url);
}
/**
* Apply a PUT Request to the extracted url from the given link
*
* @param response the response containing the link
* @param linkPropertyName the property name of link
* @return the response of the PUT request using the given link
*/
private Response applyPOSTRequestFromLink(Response response, String linkPropertyName, String content, String body) {
return applyPOSTRequest(response
.then()
.extract()
.path(linkPropertyName), content, body);
}
/**
* Apply a POST Request to the given <code>url</code> and return the response.
*
* @param url the url of the PUT request
* @return the response of the PUT request using the given <code>url</code>
*/
private Response applyPOSTRequest(String url, String mediaType, String body) {
LOG.info("POST {}", url);
return withBasicAuth()
.when()
.contentType(mediaType)
.accept(mediaType)
.body(body)
.post(url);
}
private void setUsername(String username) {
this.username = username;
}
@@ -186,6 +225,7 @@ public class ScmRequests {
public static final String LINK_AUTOCOMPLETE_USERS = "_links.autocomplete.find{it.name=='users'}.href";
public static final String LINK_AUTOCOMPLETE_GROUPS = "_links.autocomplete.find{it.name=='groups'}.href";
public static final String LINK_REPOSITORIES = "_links.repositories.href";
public static final String LINK_REPOSITORY_TYPES = "_links.repositoryTypes.href";
private static final String LINK_ME = "_links.me.href";
private static final String LINK_USERS = "_links.users.href";
@@ -201,6 +241,10 @@ public class ScmRequests {
return new AutoCompleteResponse<>(applyGETRequestFromLinkWithParams(response, LINK_AUTOCOMPLETE_GROUPS, "?q=" + q), this);
}
public RepositoryTypeResponse<IndexResponse> requestRepositoryType(String type) {
return new RepositoryTypeResponse<>(applyGETRequestFromLinkWithParams(response, LINK_REPOSITORY_TYPES, type), this);
}
public RepositoryResponse<IndexResponse> requestRepository(String namespace, String name) {
return new RepositoryResponse<>(applyGETRequestFromLinkWithParams(response, LINK_REPOSITORIES, namespace + "/" + name), this);
}
@@ -221,13 +265,12 @@ public class ScmRequests {
return response
.then()
.extract()
.path("_links." + linkName + ".href");
.path("_links." + linkName + ".href");
}
}
public class RepositoryResponse<PREV extends ModelResponse> extends ModelResponse<RepositoryResponse<PREV>, PREV> {
public static final String LINKS_SOURCES = "_links.sources.href";
public static final String LINKS_CHANGESETS = "_links.changesets.href";
@@ -243,6 +286,45 @@ public class ScmRequests {
return new ChangesetsResponse<>(applyGETRequestFromLink(response, LINKS_CHANGESETS), this);
}
public FullExportResponse<RepositoryResponse> requestFullExport() {
return new FullExportResponse<>(applyGETRequestFromLinkWithParams(response, "_links.fullExport.href", "?compressed=true"), this);
}
public void writeTestData(String value) {
applyPOSTRequestFromLink(response, "_links.test-data.href", APPLICATION_JSON, "{\"value\":\"" + value + "\"}");
}
public TestDataResponse<RepositoryResponse> requestTestData() {
return new TestDataResponse<>(applyGETRequestFromLink(response, "_links.test-data.href"), this);
}
}
public class RepositoryTypeResponse<PREV extends ModelResponse> extends ModelResponse<RepositoryResponse<PREV>, PREV> {
public RepositoryTypeResponse(Response response, PREV previousResponse) {
super(response, previousResponse);
}
public void requestImport(String type, Path file, String repositoryName) {
String url = response
.then()
.extract()
.path("_links.import.find{it.name=='" + type + "'}.href");
Assert.assertNotNull("no url found for link " + "_links.import.find{it.name=='" + type + "'}.href", url);
LOG.info("POST for import to {}", url);
RepositoryDto repository = new RepositoryDto();
repository.setType("git");
repository.setName(repositoryName);
withBasicAuth()
.multiPart("bundle", file.toFile())
.multiPart("repository", repository)
.when()
.post(url + "?compressed=true")
.then()
.statusCode(201);
System.out.println("done");
}
}
public class ChangesetsResponse<PREV extends ModelResponse> extends ModelResponse<ChangesetsResponse<PREV>, PREV> {
@@ -294,6 +376,35 @@ public class ScmRequests {
}
}
public class FullExportResponse<PREV extends ModelResponse> extends ModelResponse<FullExportResponse<PREV>, PREV> {
public FullExportResponse(Response response, PREV previousResponse) {
super(response, previousResponse);
}
public Path exportFile() {
InputStream exportStream = response.asInputStream();
try {
Path tempFile = Files.createTempFile("scm-export", ".tgz");
Files.copy(exportStream, tempFile, REPLACE_EXISTING);
return tempFile;
} catch (IOException e) {
throw new RuntimeException(e);
}
}
}
public class TestDataResponse<PREV extends ModelResponse> extends ModelResponse<FullExportResponse<PREV>, PREV> {
public TestDataResponse(Response response, PREV previousResponse) {
super(response, previousResponse);
}
public List<String> getTestData() {
return response.then().contentType(APPLICATION_JSON).extract().path("value");
}
}
public class ModificationsResponse<PREV extends ModelResponse> extends ModelResponse<ModificationsResponse<PREV>, PREV> {
public ModificationsResponse(Response response, PREV previousResponse) {
@@ -382,7 +493,7 @@ public class ScmRequests {
this.previousResponse = previousResponse;
}
public Response getResponse(){
public Response getResponse() {
return response;
}