-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #29 from knaw-huc/TT-825_import_task_concordion
Import task concordion test
- Loading branch information
Showing
12 changed files
with
424 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
150 changes: 150 additions & 0 deletions
150
concordion/src/test/java/nl/knaw/huc/textrepo/task/TestImportDocument.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| package nl.knaw.huc.textrepo.task; | ||
|
|
||
| import com.jayway.jsonpath.DocumentContext; | ||
| import nl.knaw.huc.textrepo.AbstractConcordionTest; | ||
| import org.glassfish.jersey.media.multipart.FormDataBodyPart; | ||
| import org.glassfish.jersey.media.multipart.FormDataContentDisposition; | ||
| import org.glassfish.jersey.media.multipart.FormDataMultiPart; | ||
| import org.glassfish.jersey.media.multipart.MultiPartFeature; | ||
|
|
||
| import javax.ws.rs.core.Response; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Optional; | ||
| import java.util.UUID; | ||
|
|
||
| import static java.nio.charset.StandardCharsets.UTF_8; | ||
| import static java.util.Map.of; | ||
| import static javax.ws.rs.client.Entity.entity; | ||
| import static javax.ws.rs.core.MediaType.APPLICATION_OCTET_STREAM_TYPE; | ||
| import static nl.knaw.huc.textrepo.util.TestUtils.asCodeBlock; | ||
| import static nl.knaw.huc.textrepo.util.TestUtils.asHeaderLink; | ||
| import static nl.knaw.huc.textrepo.util.TestUtils.asPrettyJson; | ||
| import static nl.knaw.huc.textrepo.util.TestUtils.replaceInUrlAndQueryParams; | ||
|
|
||
| public class TestImportDocument extends AbstractConcordionTest { | ||
| public static class ImportResult { | ||
| public int status; | ||
|
|
||
| public String headers; | ||
| public String versionLink; | ||
| public String fileLink; | ||
| public String documentLink; | ||
| public String contentsLink; | ||
|
|
||
| public String body; | ||
| public String fileId; | ||
| public String documentId; | ||
| public String versionId; | ||
| public String contentsSha; | ||
|
|
||
| public String isNewVersion; | ||
| } | ||
|
|
||
| public ImportResult retrieve(String endpoint, | ||
| String externalId, | ||
| String typeName, | ||
| String content | ||
| ) { | ||
| final var response = importDocument(endpoint, externalId, content.getBytes(), typeName); | ||
|
|
||
| final var result = new ImportResult(); | ||
| result.status = response.getStatus(); | ||
|
|
||
| final var body = response.readEntity(String.class); | ||
| result.body = asPrettyJson(body.equals("") ? " " : body); | ||
|
|
||
| result.headers = ""; | ||
| final var links = Optional.ofNullable(response.getHeaders().get("Link")) | ||
| .orElse(Collections.emptyList()); | ||
| links.forEach(l -> result.headers += asHeaderLink(l.toString())); | ||
| result.headers = asCodeBlock(result.headers); | ||
|
|
||
| result.versionLink = findLink(links, "version"); | ||
| result.fileLink = findLink(links, "file"); | ||
| result.documentLink = findLink(links, "document"); | ||
| result.contentsLink = findLink(links, "contents"); | ||
|
|
||
| final var json = jsonPath.parse(body); | ||
| result.fileId = findValidUUID(json, "fileId"); | ||
| result.documentId = findValidUUID(json, "documentId"); | ||
| result.versionId = findValidUUID(json, "versionId"); | ||
| result.contentsSha = findValidSha(json, "contentsSha"); | ||
| result.isNewVersion = findNewVersionInfo(json, "newVersion"); | ||
|
|
||
| return result; | ||
| } | ||
|
|
||
| private String findValidUUID(DocumentContext json, String field) { | ||
| final String str = json.read("$." + field); | ||
| try { | ||
| final var uuid = UUID.fromString(str); | ||
| return "valid " + field; | ||
| } catch (Exception e) { | ||
| return "invalid " + field + " (not a UUID)"; | ||
| } | ||
| } | ||
|
|
||
| private String findValidSha(DocumentContext json, String field) { | ||
| final String str = json.read("$." + field); | ||
| if (str == null) { | ||
| return "missing " + field; | ||
| } | ||
| if (str.matches("[0-9a-f]{56}")) { | ||
| return "valid " + field; | ||
| } | ||
| return "invalid " + field + " (not a SHA224)"; | ||
| } | ||
|
|
||
| private String findNewVersionInfo(DocumentContext json, String field) { | ||
| final Boolean isNewVersion = json.read("$." + field); | ||
| if (isNewVersion == null) { | ||
| return "missing " + field; | ||
| } | ||
| if (isNewVersion) { | ||
| return "a new version was created"; | ||
| } | ||
| return "no new version was created"; | ||
| } | ||
|
|
||
| private String findLink(List<Object> links, String type) { | ||
| return links.stream() | ||
| .map(Object::toString) | ||
| .filter(l -> isRelationshipLinkTo(l, type)) | ||
| .findFirst() | ||
| .map(l -> "restful relationship link to " + type) | ||
| .orElse("header link to " + type + " missing"); | ||
| } | ||
|
|
||
| private boolean isRelationshipLinkTo(String suspect, String type) { | ||
| return suspect.contains("/rest/" + type) | ||
| && suspect.endsWith("rel=\"" + type + "\""); | ||
| } | ||
|
|
||
| private Response importDocument(String endpoint, String externalId, byte[] content, String typeName) { | ||
| var contentDisposition = FormDataContentDisposition | ||
| .name("contents") | ||
| .fileName(externalId + ".txt") | ||
| .size(content.length) | ||
| .build(); | ||
|
|
||
| final var multiPart = new FormDataMultiPart() | ||
| .bodyPart(new FormDataBodyPart( | ||
| contentDisposition, | ||
| new String(content, UTF_8), | ||
| APPLICATION_OCTET_STREAM_TYPE) | ||
| ); | ||
|
|
||
| var importUri = replaceInUrlAndQueryParams(endpoint, of( | ||
| "{externalId}", externalId, | ||
| "{typeName}", typeName)); | ||
| var request = client | ||
| .register(MultiPartFeature.class) | ||
| .target(importUri) | ||
| .request(); | ||
|
|
||
| var entity = entity(multiPart, multiPart.getMediaType()); | ||
| return request.post(entity); | ||
|
|
||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
45 changes: 23 additions & 22 deletions
45
concordion/src/test/resources/nl/knaw/huc/textrepo/TextRepo.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,42 @@ | ||
| # Text Repository Acceptance Tests | ||
|
|
||
| - [Health checks](TestHealthChecks.md "c:run") | ||
| - [Health checks](TestHealthChecks.md "c:run") | ||
|
|
||
| ## Rest API | ||
|
|
||
| A user of the Text Repository can retrieve, create, update and delete resources using a REST-ful API: | ||
|
|
||
| - [Document collection](rest/TestRestDocumentCollection.md "c:run") | ||
| - [Documents](rest/TestRestDocuments.md "c:run") | ||
| - [Document metadata](rest/TestRestDocumentMetadata.md "c:run") | ||
| - [Document files](rest/TestRestDocumentFiles.md "c:run") | ||
| - [Types](rest/TestRestTypes.md "c:run") | ||
| - [Files](rest/TestRestFiles.md "c:run") | ||
| - [File metadata](rest/TestRestFileMetadata.md "c:run") | ||
| - [File versions](rest/TestRestFileVersions.md "c:run") | ||
| - [Versions](rest/TestRestVersions.md "c:run") | ||
| - [Version metadata](rest/TestRestVersionMetadata.md "c:run") | ||
| - [Version contents](rest/TestRestVersionContents.md "c:run") | ||
| - [Contents](rest/TestRestContents.md "c:run") | ||
| - [Document collection](rest/TestRestDocumentCollection.md "c:run") | ||
| - [Documents](rest/TestRestDocuments.md "c:run") | ||
| - [Document metadata](rest/TestRestDocumentMetadata.md "c:run") | ||
| - [Document files](rest/TestRestDocumentFiles.md "c:run") | ||
| - [Types](rest/TestRestTypes.md "c:run") | ||
| - [Files](rest/TestRestFiles.md "c:run") | ||
| - [File metadata](rest/TestRestFileMetadata.md "c:run") | ||
| - [File versions](rest/TestRestFileVersions.md "c:run") | ||
| - [Versions](rest/TestRestVersions.md "c:run") | ||
| - [Version metadata](rest/TestRestVersionMetadata.md "c:run") | ||
| - [Version contents](rest/TestRestVersionContents.md "c:run") | ||
| - [Contents](rest/TestRestContents.md "c:run") | ||
|
|
||
| ## Task API | ||
|
|
||
| The Text Repository offers `task`-endpoints to perform a single, complex task within a single request: | ||
|
|
||
| - [Get document metadata by external ID](task/TestFindDocumentMetadataByExternalId.md "c:run") | ||
| - [Get file metadata by external ID and file type](task/TestFindFileMetadataByExternalId.md "c:run") | ||
| - [Get latest file contents by external ID and file type](task/TestFindFileContentsByExternalId.md "c:run") | ||
| - [Index files by type](task/TestIndexFilesByType.md "c:run") | ||
| - [Index files by index name](task/TestIndexFilesByIndexName.md "c:run") | ||
|
|
||
| - [Get document metadata by external ID](task/TestFindDocumentMetadataByExternalId.md "c:run") | ||
| - [Get file metadata by external ID and file type](task/TestFindFileMetadataByExternalId.md "c:run") | ||
| - [Get latest file contents by external ID and file type](task/TestFindFileContentsByExternalId.md "c:run") | ||
| - [Import document](task/TestImportDocument.md "c:run") | ||
| - [Index files by type](task/TestIndexFilesByType.md "c:run") | ||
| - [Index files by index name](task/TestIndexFilesByIndexName.md "c:run") | ||
|
|
||
| ## Dashboard | ||
|
|
||
| The Text Repository offers various diagnostics about the state of documents: | ||
|
|
||
| - [Show count of documents lacking files and / or metadata](dashboard/TestDashboard.md "c:run") | ||
| - [Show count of documents lacking files and / or metadata](dashboard/TestDashboard.md "c:run") | ||
|
|
||
| ## Indexers | ||
|
|
||
| - [File indexer](index/TestFileIndexer.md "c:run") | ||
| - [Autocomplete indexer](index/TestAutocompleteIndexer.md "c:run") | ||
| - [File indexer](index/TestFileIndexer.md "c:run") | ||
| - [Autocomplete indexer](index/TestAutocompleteIndexer.md "c:run") |
Oops, something went wrong.