Skip to content

Commit a0c8204

Browse files
author
Dennis Labordus
authored
Merge pull request #58 from com-pas/develop
Develop -> Main
2 parents 2a28756 + 20c64f4 commit a0c8204

File tree

8 files changed

+177
-22
lines changed

8 files changed

+177
-22
lines changed

‎app/src/main/java/org/lfenergy/compas/scl/data/rest/exception/CompasNoDataFoundExceptionHandler.java‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// SPDX-FileCopyrightText: 2021 Alliander N.V.
2+
//
3+
// SPDX-License-Identifier: Apache-2.0
4+
package org.lfenergy.compas.scl.data.rest.exception;
5+
6+
import org.lfenergy.compas.core.rest.model.ErrorResponse;
7+
import org.lfenergy.compas.scl.data.exception.CompasNoDataFoundException;
8+
9+
import javax.ws.rs.core.Response;
10+
import javax.ws.rs.ext.ExceptionMapper;
11+
import javax.ws.rs.ext.Provider;
12+
13+
@Provider
14+
public class CompasNoDataFoundExceptionHandler implements ExceptionMapper<CompasNoDataFoundException> {
15+
@Override
16+
public Response toResponse(CompasNoDataFoundException exception) {
17+
var response = new ErrorResponse();
18+
response.addErrorMessage(exception.getErrorCode(), exception.getMessage());
19+
return Response.status(Response.Status.NOT_FOUND).entity(response).build();
20+
}
21+
}

‎app/src/main/resources/application.properties‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,14 @@ quarkus.log.level = INFO
1010
quarkus.log.category."org.lfenergy.compas.scl.data".level = INFO
1111

1212
# BaseX configuration
13-
basex.host = basex
14-
basex.port = 1984
15-
basex.username = admin
16-
basex.password = admin
13+
basex.host = ${BASEX_HOST:localhost}
14+
basex.port = ${BASEX_PORT:1984}
15+
basex.username = ${BASEX_USERNAME:admin}
16+
basex.password = ${BASEX_PASSWORD:admin}
1717

1818
# Dev Profile overrides.
1919
%dev.quarkus.http.port = 9090
2020
%dev.quarkus.http.cors = true
2121

22-
%dev.basex.host = localhost
23-
2422
%dev.quarkus.log.level = DEBUG
2523
%dev.quarkus.log.category."org.lfenergy.compas.scl.data".level = DEBUG

‎app/src/test/java/org/lfenergy/compas/scl/data/rest/exception/CompasNoDataFoundExceptionHandlerTest.java‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// SPDX-FileCopyrightText: 2021 Alliander N.V.
2+
//
3+
// SPDX-License-Identifier: Apache-2.0
4+
package org.lfenergy.compas.scl.data.rest.exception;
5+
6+
import org.junit.jupiter.api.Test;
7+
import org.lfenergy.compas.core.rest.model.ErrorResponse;
8+
import org.lfenergy.compas.scl.data.exception.CompasNoDataFoundException;
9+
10+
import static javax.ws.rs.core.Response.Status.NOT_FOUND;
11+
import static org.junit.jupiter.api.Assertions.assertEquals;
12+
import static org.junit.jupiter.api.Assertions.assertNull;
13+
14+
class CompasNoDataFoundExceptionHandlerTest {
15+
@Test
16+
void toResponse_WhenCalledWithException_ThenNotFoundReturnedWithBody() {
17+
var exception = new CompasNoDataFoundException("Some message that will only be logged");
18+
var handler = new CompasNoDataFoundExceptionHandler();
19+
20+
var result = handler.toResponse(exception);
21+
assertEquals(NOT_FOUND.getStatusCode(), result.getStatus());
22+
var errorMessage = ((ErrorResponse) result.getEntity()).getErrorMessages().get(0);
23+
assertEquals(exception.getErrorCode(), errorMessage.getCode());
24+
assertEquals(exception.getMessage(), errorMessage.getMessage());
25+
assertNull(errorMessage.getProperty());
26+
}
27+
}

‎repository-basex/src/main/java/org/lfenergy/compas/scl/data/repository/CompasSclDataBaseXRepository.java‎

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
import org.lfenergy.compas.core.commons.ElementConverter;
77
import org.lfenergy.compas.scl.data.basex.BaseXClient;
88
import org.lfenergy.compas.scl.data.basex.BaseXClientFactory;
9+
import org.lfenergy.compas.scl.data.exception.CompasNoDataFoundException;
910
import org.lfenergy.compas.scl.data.exception.CompasSclDataServiceException;
1011
import org.lfenergy.compas.scl.data.model.Item;
1112
import org.lfenergy.compas.scl.data.model.SclType;
@@ -46,7 +47,7 @@ public class CompasSclDataBaseXRepository implements CompasSclDataRepository {
4647
private static final String DECLARE_COMPAS_NAMESPACE = "declare namespace compas=\"" + COMPAS_EXTENSION_NS_URI + "\";\n";
4748
private static final String DECLARE_LATEST_VERSION_FUNC =
4849
"declare function local:latest-version($db as xs:string, $id as xs:string)\n" +
49-
" as document-node() { \n" +
50+
" as document-node()? { \n" +
5051
" let $doc :=\n" +
5152
" (for $resource in db:open($db, $id)\n" +
5253
" let $parts := tokenize($resource/scl:SCL/scl:Header/@version, '\\.')\n" +
@@ -60,6 +61,7 @@ public class CompasSclDataBaseXRepository implements CompasSclDataRepository {
6061
"};\n";
6162
private static final String DECLARE_DB_VARIABLE = "declare variable $db := '%s';\n";
6263
private static final String DECLARE_ID_VARIABLE = "declare variable $id := '%s';\n";
64+
private static final String DECLARE_PATH_VARIABLE = "declare variable $path := '%s';\n";
6365

6466
private final BaseXClientFactory baseXClientFactory;
6567
private final SclDataModelMarshaller sclDataMarshaller;
@@ -97,13 +99,12 @@ public List<Item> list(SclType type) {
9799
" let $version := $latestScl//scl:SCL/scl:Header/@version\n" +
98100
" let $name := $latestScl//scl:SCL/scl:Private[@type='" + COMPAS_SCL_EXTENSION_TYPE + "']/compas:" + COMPAS_SCL_NAME_EXTENSION + "\n" +
99101
" return '<Item xmlns=\"" + SCL_DATA_SERVICE_V1_NS_URI + "\"><Id>' || $id || '</Id><Name>' || $name || '</Name><Version>' || $version || '</Version></Item>'",
100-
sclDataMarshaller::unmarshal
101-
);
102+
sclDataMarshaller::unmarshal);
102103
}
103104

104105
@Override
105106
public List<Item> listVersionsByUUID(SclType type, UUID id) {
106-
return executeQuery(type, DECLARE_SCL_NS_URI +
107+
var items = executeQuery(type, DECLARE_SCL_NS_URI +
107108
DECLARE_COMPAS_NAMESPACE +
108109
format(DECLARE_DB_VARIABLE, type) +
109110
format(DECLARE_ID_VARIABLE, id) +
@@ -117,8 +118,13 @@ public List<Item> listVersionsByUUID(SclType type, UUID id) {
117118
" let $patchVersion := xs:int($parts[3])\n" +
118119
" order by $majorVersion, $minorVersion, $patchVersion\n" +
119120
" return '<Item xmlns=\"" + SCL_DATA_SERVICE_V1_NS_URI + "\"><Id>' || $id || '</Id><Name>' || $name || '</Name><Version>' || $version || '</Version></Item>' ",
120-
sclDataMarshaller::unmarshal
121-
);
121+
sclDataMarshaller::unmarshal);
122+
123+
if (items.isEmpty()) {
124+
var message = String.format("No versions found for type '%s' with ID '%s'", type, id);
125+
throw new CompasNoDataFoundException(message);
126+
}
127+
return items;
122128
}
123129

124130
@Override
@@ -133,15 +139,26 @@ public Element findByUUID(SclType type, UUID id) {
133139
format(DECLARE_ID_VARIABLE, id) +
134140
"local:latest-version($db, $id)",
135141
xmlString -> elementConverter.convertToElement(xmlString, SCL_ELEMENT_NAME, SCL_NS_URI));
142+
143+
if (result.isEmpty()) {
144+
var message = String.format("No record found for type '%s' with ID '%s'", type, id);
145+
throw new CompasNoDataFoundException(message);
146+
}
136147
return result.get(0);
137148
}
138149

139150
@Override
140151
public Element findByUUID(SclType type, UUID id, Version version) {
141152
// This find method searches for a specific version.
142-
var result = executeQuery(type,
143-
"doc('" + type + "/" + createDocumentPath(id, version) + "')",
153+
var result = executeQuery(type, format(DECLARE_DB_VARIABLE, type) +
154+
format(DECLARE_PATH_VARIABLE, createDocumentPath(id, version)) +
155+
"db:open($db, $path)",
144156
xmlString -> elementConverter.convertToElement(xmlString, SCL_ELEMENT_NAME, SCL_NS_URI));
157+
158+
if (result.isEmpty()) {
159+
var message = String.format("No record found for type '%s' with ID '%s' and version '%s'", type, id, version);
160+
throw new CompasNoDataFoundException(message);
161+
}
145162
return result.get(0);
146163
}
147164

‎repository-basex/src/test/java/org/lfenergy/compas/scl/data/repository/CompasSclDataBaseXRepositoryTest.java‎

Lines changed: 67 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
import org.lfenergy.compas.core.commons.ElementConverter;
1111
import org.lfenergy.compas.scl.data.basex.BaseXClientFactory;
1212
import org.lfenergy.compas.scl.data.basex.BaseXServerJUnitExtension;
13+
import org.lfenergy.compas.scl.data.exception.CompasNoDataFoundException;
1314
import org.lfenergy.compas.scl.data.exception.CompasSclDataServiceException;
1415
import org.lfenergy.compas.scl.data.model.ChangeSetType;
1516
import org.lfenergy.compas.scl.data.model.SclType;
@@ -24,8 +25,8 @@
2425
import static org.junit.jupiter.api.Assertions.*;
2526
import static org.lfenergy.compas.scl.data.SclDataServiceConstants.*;
2627
import static org.lfenergy.compas.scl.data.basex.BaseXServerUtil.createClientFactory;
27-
import static org.lfenergy.compas.scl.data.exception.CompasSclDataServiceErrorCode.BASEX_QUERY_ERROR_CODE;
2828
import static org.lfenergy.compas.scl.data.exception.CompasSclDataServiceErrorCode.HEADER_NOT_FOUND_ERROR_CODE;
29+
import static org.lfenergy.compas.scl.data.exception.CompasSclDataServiceErrorCode.NO_DATA_FOUND_ERROR_CODE;
2930

3031
@ExtendWith({MockitoExtension.class, BaseXServerJUnitExtension.class})
3132
class CompasSclDataBaseXRepositoryTest {
@@ -106,6 +107,16 @@ void list_WhenTwoVersionsOfARecordAdded_ThenLatestRecordFound() {
106107
assertEquals(version.toString(), items.get(0).getVersion());
107108
}
108109

110+
@Test
111+
void listVersionsByUUID_WhenCalledWithUnknownID_ThenExceptionIsThrown() {
112+
var uuid = UUID.randomUUID();
113+
114+
var exception = assertThrows(CompasNoDataFoundException.class, () -> {
115+
repository.listVersionsByUUID(TYPE, uuid);
116+
});
117+
assertEquals(NO_DATA_FOUND_ERROR_CODE, exception.getErrorCode());
118+
}
119+
109120
@Test
110121
void listVersionsByUUID_WhenTwoVersionsOfARecordAdded_ThenAllRecordAreFound() {
111122
var version = new Version(1, 0, 0);
@@ -125,13 +136,61 @@ void listVersionsByUUID_WhenTwoVersionsOfARecordAdded_ThenAllRecordAreFound() {
125136
}
126137

127138
@Test
128-
void find_WhenCalledWithUnknownUUID_ThenExceptionIsThrown() {
139+
void findByUUID_WhenCalledWithUnknownUUID_ThenExceptionIsThrown() {
129140
var uuid = UUID.randomUUID();
130141

131-
var exception = assertThrows(CompasSclDataServiceException.class, () -> {
142+
var exception = assertThrows(CompasNoDataFoundException.class, () -> {
132143
repository.findByUUID(TYPE, uuid);
133144
});
134-
assertEquals(BASEX_QUERY_ERROR_CODE, exception.getErrorCode());
145+
assertEquals(NO_DATA_FOUND_ERROR_CODE, exception.getErrorCode());
146+
}
147+
148+
@Test
149+
void findByUUID_WhenTwoVersionsOfARecordAdded_ThenLastRecordIsFound() {
150+
var version = new Version(1, 0, 0);
151+
var uuid = UUID.randomUUID();
152+
var scl = readSCL(uuid, version);
153+
repository.create(TYPE, uuid, scl, version);
154+
version = new Version(1, 1, 0);
155+
scl = readSCL(uuid, version);
156+
repository.create(TYPE, uuid, scl, version);
157+
158+
var foundScl = repository.findByUUID(TYPE, uuid);
159+
160+
assertNotNull(foundScl);
161+
assertEquals(uuid.toString(), getIdFromHeader(foundScl));
162+
assertEquals(version.toString(), getVersionFromHeader(foundScl));
163+
}
164+
165+
@Test
166+
void findByUUIDWithVersion_WhenCalledWithUnknownVersion_ThenExceptionIsThrown() {
167+
var version = new Version(1, 0, 0);
168+
var uuid = UUID.randomUUID();
169+
var scl = readSCL(uuid, version);
170+
repository.create(TYPE, uuid, scl, version);
171+
172+
var unknownVersion = new Version(1, 1, 1);
173+
var exception = assertThrows(CompasNoDataFoundException.class, () -> {
174+
repository.findByUUID(TYPE, uuid, unknownVersion);
175+
});
176+
assertEquals(NO_DATA_FOUND_ERROR_CODE, exception.getErrorCode());
177+
}
178+
179+
@Test
180+
void findByUUIDWithVersion_WhenTwoVersionsOfARecordAdded_ThenCorrectRecordIsFound() {
181+
var expectedVersion = new Version(1, 0, 0);
182+
var uuid = UUID.randomUUID();
183+
var scl = readSCL(uuid, expectedVersion);
184+
repository.create(TYPE, uuid, scl, expectedVersion);
185+
var version = new Version(1, 1, 0);
186+
scl = readSCL(uuid, version);
187+
repository.create(TYPE, uuid, scl, version);
188+
189+
var foundScl = repository.findByUUID(TYPE, uuid, expectedVersion);
190+
191+
assertNotNull(foundScl);
192+
assertEquals(uuid.toString(), getIdFromHeader(foundScl));
193+
assertEquals(expectedVersion.toString(), getVersionFromHeader(foundScl));
135194
}
136195

137196
@Test
@@ -196,10 +255,10 @@ void createAndDelete_WhenSclAddedAndDelete_ThenScLStoredAndRemoved() {
196255
assertEquals(getIdFromHeader(scl), getIdFromHeader(foundScl));
197256

198257
repository.delete(TYPE, uuid, version);
199-
var exception = assertThrows(CompasSclDataServiceException.class, () -> {
258+
var exception = assertThrows(CompasNoDataFoundException.class, () -> {
200259
repository.findByUUID(TYPE, uuid);
201260
});
202-
assertEquals(BASEX_QUERY_ERROR_CODE, exception.getErrorCode());
261+
assertEquals(NO_DATA_FOUND_ERROR_CODE, exception.getErrorCode());
203262
}
204263

205264
@Test
@@ -222,10 +281,10 @@ void createAndDeleteAll_WhenSclAddedAndDelete_ThenScLStoredAndRemoved() {
222281
assertEquals(getVersionFromHeader(scl), getVersionFromHeader(foundScl));
223282

224283
repository.delete(TYPE, uuid);
225-
var exception = assertThrows(CompasSclDataServiceException.class, () -> {
284+
var exception = assertThrows(CompasNoDataFoundException.class, () -> {
226285
repository.findByUUID(TYPE, uuid);
227286
});
228-
assertEquals(BASEX_QUERY_ERROR_CODE, exception.getErrorCode());
287+
assertEquals(NO_DATA_FOUND_ERROR_CODE, exception.getErrorCode());
229288
}
230289

231290
private String getIdFromHeader(Element scl) {

‎repository/src/main/java/org/lfenergy/compas/scl/data/exception/CompasNoDataFoundException.java‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// SPDX-FileCopyrightText: 2021 Alliander N.V.
2+
//
3+
// SPDX-License-Identifier: Apache-2.0
4+
package org.lfenergy.compas.scl.data.exception;
5+
6+
import org.lfenergy.compas.core.commons.exception.CompasException;
7+
8+
import static org.lfenergy.compas.scl.data.exception.CompasSclDataServiceErrorCode.NO_DATA_FOUND_ERROR_CODE;
9+
10+
public class CompasNoDataFoundException extends CompasException {
11+
public CompasNoDataFoundException(String message) {
12+
super(NO_DATA_FOUND_ERROR_CODE, message);
13+
}
14+
}

‎repository/src/main/java/org/lfenergy/compas/scl/data/exception/CompasSclDataServiceErrorCode.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,5 @@ public class CompasSclDataServiceErrorCode {
1616
public static final String BASEX_CLIENT_CREATION_ERROR_CODE = "SDS-1000";
1717
public static final String BASEX_QUERY_ERROR_CODE = "SDS-1001";
1818
public static final String BASEX_COMMAND_ERROR_CODE = "SDS-1002";
19+
public static final String NO_DATA_FOUND_ERROR_CODE = "SDS-1003";
1920
}

‎repository/src/test/java/org/lfenergy/compas/scl/data/exception/CompasNoDataFoundExceptionTest.java‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// SPDX-FileCopyrightText: 2021 Alliander N.V.
2+
//
3+
// SPDX-License-Identifier: Apache-2.0
4+
package org.lfenergy.compas.scl.data.exception;
5+
6+
import org.junit.jupiter.api.Test;
7+
8+
import static org.junit.jupiter.api.Assertions.assertEquals;
9+
10+
class CompasNoDataFoundExceptionTest {
11+
@Test
12+
void constructor_WhenCalledWithOnlyMessage_ThenMessageCanBeRetrieved() {
13+
String expectedMessage = "The message";
14+
var exception = new CompasNoDataFoundException(expectedMessage);
15+
16+
assertEquals(expectedMessage, exception.getMessage());
17+
}
18+
}

0 commit comments

Comments
 (0)