MALIO-DEV/PlantUmlServer
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add metadata Servlet

Browse Source 
- add new servlet to get meta data from PlantUML diagram
- meta data get not only be requested as text but also as json if you set the `Accept`-header to json
- add `metadata` servlet tests
- GET: like the Proxy where you can pass a URL which the servlet will use to fetch the diagram image
- POST: file upload
This commit is contained in:
Florian
2023-05-11 20:58:36 +02:00
committed by PlantUML
parent 09517cca92
commit ec7b9f9b1a
13 changed files with 594 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

146
src/test/java/net/sourceforge/plantuml/servlet/TestMetadata.java Normal file
View File

@@ -0,0 +1,146 @@
package net.sourceforge.plantuml.servlet;
import java.io.IOException;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import org.apache.hc.client5.http.entity.mime.ByteArrayBody;
import org.apache.hc.client5.http.entity.mime.ContentBody;
import org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder;
import org.apache.hc.core5.http.HttpEntity;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;
import net.sourceforge.plantuml.json.Json;
import net.sourceforge.plantuml.json.JsonObject;
import net.sourceforge.plantuml.servlet.utils.TestUtils;
import net.sourceforge.plantuml.servlet.utils.WebappTestCase;
public class TestMetadata extends WebappTestCase {
@ParameterizedTest
@CsvSource({
"png, false, true",
"png, true, true",
"svg, false, false", // Note: PlantUML SVG diagram images do not include version information
"svg, true, false",
})
public void testBobAliceSampleMetadataProxy(
String format,
boolean isJsonResponse,
boolean hasVersion
) throws IOException {
final String resourceFilename = "bob." + format;
final URL url = new URL(getServerUrl() + "/metadata?src=" + getTestResourceUrl(resourceFilename));
checkMetadataResponse(url, isJsonResponse, hasVersion);
}
@ParameterizedTest
@CsvSource({
"png, false, true",
"png, true, true",
"svg, false, false", // Note: PlantUML SVG diagram images do not include version information
"svg, true, false",
})
public void testBobAliceSampleMetadataFileUpload(
String format,
boolean isJsonResponse,
boolean hasVersion
) throws IOException {
// build file upload request entity
final String resourceFilename = "bob." + format;
final URL resourceUrl = new URL(getTestResourceUrl(resourceFilename));
final byte[] resource = getContentAsBytes(resourceUrl);
final ContentBody contentPart = new ByteArrayBody(resource, resourceFilename);
final MultipartEntityBuilder requestBuilder = MultipartEntityBuilder.create();
requestBuilder.addPart("diagram", contentPart);
HttpEntity requestEntity = requestBuilder.build();
// send request including file
final URL url = new URL(getServerUrl() + "/metadata");
final HttpURLConnection conn = (HttpURLConnection)url.openConnection();
conn.setUseCaches(false);
conn.setDoInput(true);
conn.setDoOutput(true);
conn.setRequestMethod("POST");
if (isJsonResponse) {
conn.setRequestProperty("Accept", "application/json");
}
conn.setRequestProperty("Cache-Control", "no-cache");
conn.setRequestProperty("Connection", "Keep-Alive");
conn.addRequestProperty("Content-length", Long.toString(requestEntity.getContentLength()));
conn.setRequestProperty("Content-Type", requestEntity.getContentType());
try (OutputStream out = conn.getOutputStream()) {
requestEntity.writeTo(out);
}
// check response
checkMetadataResponse(conn, isJsonResponse, hasVersion);
}
private void checkMetadataResponse(
URL url,
boolean isJsonResponse,
boolean hasVersion
) throws IOException {
final HttpURLConnection conn = (HttpURLConnection)url.openConnection();
if (isJsonResponse) {
conn.setRequestProperty("Accept", "application/json");
}
checkMetadataResponse(conn, isJsonResponse, hasVersion);
}
private void checkMetadataResponse(
HttpURLConnection conn,
boolean isJsonResponse,
boolean hasVersion
) throws IOException {
// Verifies HTTP status code and the Content-Type
Assertions.assertEquals(200, conn.getResponseCode(), "Bad HTTP status received");
if (isJsonResponse) {
Assertions.assertEquals(
"application/json;charset=utf-8",
conn.getContentType().toLowerCase(),
"Response content type is not JSON or UTF-8"
);
} else {
Assertions.assertEquals(
"text/plain;charset=utf-8",
conn.getContentType().toLowerCase(),
"Response content type is not plain text or UTF-8"
);
}
// Get and verify the content
final String content = getContentText(conn);
if (isJsonResponse) {
checkMetadataContent(Json.parse(content).asObject(), hasVersion);
} else {
checkMetadataContent(content, hasVersion);
}
}
private void checkMetadataContent(String metadata, boolean hasVersion) {
Assertions.assertTrue(
metadata.contains(TestUtils.SEQBOB),
"Meta data does not contain encoded PlantUML diagram code"
);
Assertions.assertTrue(
metadata.contains(TestUtils.SEQBOBCODE),
"Meta data does not contain decoded PlantUML diagram code"
);
if (hasVersion) {
Assertions.assertTrue(
metadata.contains("PlantUML version"),
"Meta data does not contain PlantUML version"
);
}
}
private void checkMetadataContent(JsonObject metadata, boolean hasVersion) {
Assertions.assertEquals(TestUtils.SEQBOB, metadata.get("encoded").asString());
Assertions.assertEquals(TestUtils.SEQBOBCODE, metadata.get("decoded").asString());
if (hasVersion) {
Assertions.assertNotNull(metadata.get("version").asString());
}
}
}

6
src/test/java/net/sourceforge/plantuml/servlet/TestOldProxy.java
View File

@@ -12,12 +12,14 @@ import net.sourceforge.plantuml.servlet.utils.WebappTestCase;
public class TestOldProxy extends WebappTestCase {
private static final String TEST_RESOURCE = "test2diagrams.txt";
/**
* Verifies the proxified reception of the default Bob and Alice diagram
*/
@Test
public void testDefaultProxy() throws IOException {
final URL url = new URL(getServerUrl() + "/proxy/" + getTestDiagramUrl());
final URL url = new URL(getServerUrl() + "/proxy/" + getTestResourceUrl(TEST_RESOURCE));
final HttpURLConnection conn = (HttpURLConnection)url.openConnection();
// Analyze response
// Verifies HTTP status code and the Content-Type
@@ -39,7 +41,7 @@ public class TestOldProxy extends WebappTestCase {
*/
@Test
public void testProxyWithFormat() throws IOException {
final URL url = new URL(getServerUrl() + "/proxy/svg/" + getTestDiagramUrl());
final URL url = new URL(getServerUrl() + "/proxy/svg/" + getTestResourceUrl(TEST_RESOURCE));
final HttpURLConnection conn = (HttpURLConnection)url.openConnection();
// Analyze response
// Verifies HTTP status code and the Content-Type

10
src/test/java/net/sourceforge/plantuml/servlet/TestProxy.java
View File

@@ -12,12 +12,14 @@ import net.sourceforge.plantuml.servlet.utils.WebappTestCase;
public class TestProxy extends WebappTestCase {
private static final String TEST_RESOURCE = "test2diagrams.txt";
/**
* Verifies the proxified reception of the default Bob and Alice diagram
*/
@Test
public void testDefaultProxy() throws IOException {
final URL url = new URL(getServerUrl() + "/proxy?src=" + getTestDiagramUrl());
final URL url = new URL(getServerUrl() + "/proxy?src=" + getTestResourceUrl(TEST_RESOURCE));
final HttpURLConnection conn = (HttpURLConnection)url.openConnection();
// Analyze response
// Verifies HTTP status code and the Content-Type
@@ -39,7 +41,7 @@ public class TestProxy extends WebappTestCase {
*/
@Test
public void testProxyWithFormat() throws IOException {
final URL url = new URL(getServerUrl() + "/proxy?fmt=svg&src=" + getTestDiagramUrl());
final URL url = new URL(getServerUrl() + "/proxy?fmt=svg&src=" + getTestResourceUrl(TEST_RESOURCE));
final HttpURLConnection conn = (HttpURLConnection)url.openConnection();
// Analyze response
// Verifies HTTP status code and the Content-Type
@@ -61,7 +63,7 @@ public class TestProxy extends WebappTestCase {
*/
@Test
public void testProxyWithFormatIdx0() throws IOException {
final URL url = new URL(getServerUrl() + "/proxy?fmt=svg&idx=0&src=" + getTestDiagramUrl());
final URL url = new URL(getServerUrl() + "/proxy?fmt=svg&idx=0&src=" + getTestResourceUrl(TEST_RESOURCE));
final HttpURLConnection conn = (HttpURLConnection)url.openConnection();
// Analyze response
// Verifies HTTP status code and the Content-Type
@@ -83,7 +85,7 @@ public class TestProxy extends WebappTestCase {
*/
@Test
public void testProxyWithFormatIdx1() throws IOException {
final URL url = new URL(getServerUrl() + "/proxy?fmt=svg&idx=1&src=" + getTestDiagramUrl());
final URL url = new URL(getServerUrl() + "/proxy?fmt=svg&idx=1&src=" + getTestResourceUrl(TEST_RESOURCE));
final HttpURLConnection conn = (HttpURLConnection)url.openConnection();
// Analyze response
// Verifies HTTP status code and the Content-Type

4
src/test/java/net/sourceforge/plantuml/servlet/utils/WebappTestCase.java
View File

@@ -50,10 +50,10 @@ public abstract class WebappTestCase {
return serverUtils.getServerUrl();
}
public String getTestDiagramUrl() {
public String getTestResourceUrl(String resource) {
// NOTE: [Old]ProxyServlet.forbiddenURL do not allow URL with IP-Addresses or localhost.
String serverUrl = getServerUrl().replace("/localhost", "/test.localhost");
return serverUrl + "/resource/test2diagrams.txt";
return serverUrl + "/resource/test/" + resource;
}
public String getContentText(final URL url) throws IOException {