mirror of
https://github.com/octoleo/plantuml.git
synced 2024-12-31 14:02:00 +00:00
Add tests for Pipe
This commit is contained in:
Josep Mones Teixidor
parent
b3677c66f2
commit
6849c96144
@ -150,7 +150,7 @@ public class Pipe {
|
||||
return s == null || s.startsWith("@end");
|
||||
}
|
||||
|
||||
private String readOneDiagram() throws IOException {
|
||||
String readOneDiagram() throws IOException {
|
||||
final StringBuilder sb = new StringBuilder();
|
||||
while (true) {
|
||||
final String s = readOneLine();
|
||||
@ -176,7 +176,7 @@ public class Pipe {
|
||||
return source;
|
||||
}
|
||||
|
||||
private void manageFormat(String s) {
|
||||
void manageFormat(String s) {
|
||||
if (s.contains("png")) {
|
||||
option.setFileFormatOption(new FileFormatOption(FileFormat.PNG));
|
||||
} else if (s.contains("svg")) {
|
||||
@ -184,7 +184,7 @@ public class Pipe {
|
||||
}
|
||||
}
|
||||
|
||||
private String readOneLine() throws IOException {
|
||||
String readOneLine() throws IOException {
|
||||
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
|
||||
while (true) {
|
||||
final int read = is.read();
|
||||
|
||||
353
test/net/sourceforge/plantuml/PipeTest.java
Normal file
353
test/net/sourceforge/plantuml/PipeTest.java
Normal file
@ -0,0 +1,353 @@
|
||||
package net.sourceforge.plantuml;
|
||||
|
||||
|
||||
import static java.nio.charset.StandardCharsets.UTF_8;
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
import java.io.ByteArrayInputStream;
|
||||
import java.io.ByteArrayOutputStream;
|
||||
import java.io.IOException;
|
||||
import java.io.PrintStream;
|
||||
import java.nio.charset.Charset;
|
||||
import java.util.LinkedList;
|
||||
import java.util.List;
|
||||
|
||||
import org.assertj.core.api.AutoCloseableSoftAssertions;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.params.ParameterizedTest;
|
||||
import org.junit.jupiter.params.provider.MethodSource;
|
||||
import org.junit.jupiter.params.provider.ValueSource;
|
||||
|
||||
|
||||
class PipeTest {
|
||||
|
||||
ByteArrayOutputStream baos;
|
||||
ErrorStatus errorStatus;
|
||||
Option option;
|
||||
Pipe pipe;
|
||||
PrintStream ps;
|
||||
|
||||
@BeforeEach
|
||||
void setup() {
|
||||
errorStatus = ErrorStatus.init();
|
||||
|
||||
baos = new ByteArrayOutputStream();
|
||||
option = new Option();
|
||||
ps = new PrintStream(baos);
|
||||
|
||||
pipe = new Pipe(option, ps, new ByteArrayInputStream(new byte[0]), UTF_8.toString());
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_managePipe_set_as_no_error_for_empty_input() throws IOException {
|
||||
pipe = new Pipe(option, ps, new ByteArrayInputStream(new byte[0]), UTF_8.name());
|
||||
|
||||
pipe.managePipe(errorStatus);
|
||||
|
||||
try (AutoCloseableSoftAssertions softly = new AutoCloseableSoftAssertions()) {
|
||||
softly.assertThat(errorStatus.hasError()).isFalse();
|
||||
softly.assertThat(errorStatus.isNoData()).isTrue();
|
||||
softly.assertThat(baos.toByteArray()).isEmpty();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
static List<TestCase> managePipeTestCases() {
|
||||
LinkedList<TestCase> l = new LinkedList<>();
|
||||
|
||||
l.add(TestCase.of("", "", "", Verification.EXACT, false, true));
|
||||
|
||||
// ok render
|
||||
l.add(TestCase.of("", "a->b", "(?s).*PNG.*Generated by http://plantuml.com.*", Verification.REGEX, false, false));
|
||||
l.add(TestCase.of("", "@startuml\na->b\n@enduml", "(?s).*PNG.*Generated by http://plantuml.com.*", Verification.REGEX, false, false));
|
||||
l.add(TestCase.of("", "@startuml\na->b\n@enduml\n@startuml\na->b\nb->c\n@enduml\n", "(?s).*(PNG.*Generated by http://plantuml.com.*){2}", Verification.REGEX, false, false));
|
||||
|
||||
// bad data
|
||||
l.add(TestCase.of("", "a", "(?s).*PNG.*Generated by http://plantuml.com.*", Verification.REGEX, true, false));
|
||||
l.add(TestCase.of("", "@startuml\na\n@enduml\n", "(?s).*PNG.*Generated by http://plantuml.com.*", Verification.REGEX, true, false));
|
||||
l.add(TestCase.of("", "@startuml\na\n@enduml\n@startuml\na\n@enduml\n", "(?s).*PNG.*Generated by http://plantuml.com.*", Verification.REGEX, true, false));
|
||||
|
||||
// ignore garbage before; after; before&between&after diagrams
|
||||
l.add(TestCase.of("", "this-is-garbage\n@startuml\na->b\n@enduml", "(?s).*(PNG.*Generated by http://plantuml.com.*){1}", Verification.REGEX, false, false));
|
||||
l.add(TestCase.of("", "@startuml\na->b\n@enduml\nthis-is-garbage", "(?s).*(PNG.*Generated by http://plantuml.com.*){1}", Verification.REGEX, false, false));
|
||||
l.add(TestCase.of("", "this-is-garbage\n@startuml\na->b\n@enduml\nthis-is-garbage\n@startuml\na->b\n@enduml\nthis-is-garbage", "(?s).*(PNG.*Generated by http://plantuml.com.*){2}", Verification.REGEX, false, false));
|
||||
|
||||
// ignore other diagram start tags when still not closed (but fails to generate)
|
||||
l.add(TestCase.of("", "@startuml\na->b\n@startgantt\n@enduml\n", "(?s).*(PNG.*Generated by http://plantuml.com.*){1}", Verification.REGEX, true, false));
|
||||
|
||||
// manage @@@format svg
|
||||
l.add(TestCase.of("", "@startuml\n@@@format svg\na->b\n@enduml", "(?s).*<\\?xml.*<svg.*</svg>", Verification.REGEX, false, false));
|
||||
l.add(TestCase.of("", "@startuml\n@@@format svg\na->b\n@enduml\n@startuml\n@@@format svg\na->b\n@enduml", "(?s).*(<\\?xml.*<svg.*</svg>.*){2}", Verification.REGEX, false, false));
|
||||
|
||||
// mixed formats
|
||||
l.add(TestCase.of("", "@startuml\n@@@format png\na->b\n@enduml\n@startuml\n@@@format svg\na->b\n@enduml", "(?s).*PNG.*Generated by http://plantuml.com.*<\\?xml.*<svg.*</svg>", Verification.REGEX, false, false));
|
||||
l.add(TestCase.of("", "@startuml\n@@@format svg\na->b\n@enduml\n@startuml\n@@@format png\na->b\n@enduml", "(?s).*<\\?xml.*<svg.*</svg>.*PNG.*Generated by http://plantuml.com.*", Verification.REGEX, false, false));
|
||||
|
||||
// pipe delimitor
|
||||
l.add(TestCase.of("-pipedelimitor PIPE-DELIMITOR", "@startuml\na->b\n@enduml\n@startuml\na->b\nb->c\n@enduml\n", "(?s).*(PNG.*Generated by http://plantuml.com.*PIPE-DELIMITOR.*){2}", Verification.REGEX, false, false));
|
||||
|
||||
// if format is set in first diagram and not in the second, it will be used in both (Possibly incorrect: preseved from old behaviour)
|
||||
l.add(TestCase.of("", "@startuml\n@@@format svg\na->b\n@enduml\n@startuml\na->b\n@enduml", "(?s).*(<\\?xml.*<svg.*</svg>.*){2}", Verification.REGEX, false, false));
|
||||
|
||||
// ok computeurl
|
||||
l.add(TestCase.of("-computeurl", "@startuml\na->b\n@enduml", "IzIrIm80\n", Verification.EXACT, false, true));
|
||||
l.add(TestCase.of("-computeurl", "@startuml\na->b\n@enduml\n@startuml\na->b\nb->c\n@enduml\n", "IzIrIm80\nIzIrI-9AqhLB1W00\n", Verification.EXACT,false, true));
|
||||
|
||||
// ok encodeurl
|
||||
l.add(TestCase.of("-encodeurl", "@startuml\na->b\n@enduml", "IzIrIm80\n", Verification.EXACT,false, true));
|
||||
l.add(TestCase.of("-encodeurl", "@startuml\na->b\n@enduml\n@startuml\na->b\nb->c\n@enduml\n", "IzIrIm80\nIzIrI-9AqhLB1W00\n", Verification.EXACT, false, true));
|
||||
|
||||
// valid syntax
|
||||
l.add(TestCase.of("-syntax", "@startuml\na->b\n@enduml", "SEQUENCE\n(2 participants)\n", Verification.EXACT, false, false));
|
||||
l.add(TestCase.of("-syntax", "@startuml\na->b\n@enduml\n@startuml\na->b\nb->c\n@enduml\n", "SEQUENCE\n(2 participants)\nSEQUENCE\n(3 participants)\n", Verification.EXACT, false, false));
|
||||
l.add(TestCase.of("-syntax", "@startgantt\n[a] lasts 1 day\n@endgantt", "OTHER\n(Project)\n", Verification.EXACT, false, false));
|
||||
|
||||
// invalid syntax
|
||||
l.add(TestCase.of("-syntax", "@startuml\na\n@enduml", "ERROR\n1\nSyntax Error?\n", Verification.EXACT, true, false));
|
||||
l.add(TestCase.of("-syntax", "@startuml\na\n@enduml\n@startuml\na\n@enduml", "ERROR\n1\nSyntax Error?\nERROR\n1\nSyntax Error?\n", Verification.EXACT, true, false));
|
||||
l.add(TestCase.of("-syntax", "@startuml\na->b\n@enduml\n@startuml\na\n@enduml", "SEQUENCE\n(2 participants)\nERROR\n1\nSyntax Error?\n", Verification.EXACT, true, false));
|
||||
l.add(TestCase.of("-syntax", "@startuml\na\n@enduml\n@startuml\na->b\n@enduml", "ERROR\n1\nSyntax Error?\nSEQUENCE\n(2 participants)\n", Verification.EXACT, true, false));
|
||||
|
||||
// pipemap (using regexp to allow any coords so that it doesn't fail on different systems)
|
||||
l.add(TestCase.of("-pipemap", "@startuml\na->b: [[http://a.com]] c\n@enduml",
|
||||
"<map id=\"plantuml_map\" name=\"plantuml_map\">\n" +
|
||||
"<area shape=\"rect\" id=\"id1\" href=\"http://a.com\" title=\"http://a.com\" alt=\"\" coords=\"[0-9]+,[0-9]+,[0-9]+,[0-9]+\"/>\n" +
|
||||
"</map>\n\n",
|
||||
Verification.REGEX, false, false));
|
||||
l.add(TestCase.of("-pipemap", "@startuml\na->b: [[http://a.com]] c\n@enduml\n@startuml\nc->d: [[http://c.com]] e\n@enduml",
|
||||
"<map id=\"plantuml_map\" name=\"plantuml_map\">\n" +
|
||||
"<area shape=\"rect\" id=\"id1\" href=\"http://a.com\" title=\"http://a.com\" alt=\"\" coords=\"[0-9]+,[0-9]+,[0-9]+,[0-9]+\"/>\n" +
|
||||
"</map>\n\n" +
|
||||
"<map id=\"plantuml_map\" name=\"plantuml_map\">\n" +
|
||||
"<area shape=\"rect\" id=\"id1\" href=\"http://c.com\" title=\"http://c.com\" alt=\"\" coords=\"[0-9]+,[0-9]+,[0-9]+,[0-9]+\"/>\n" +
|
||||
"</map>\n\n",
|
||||
Verification.REGEX, false, false));
|
||||
|
||||
// no links/invalid input => no pipemap to output (no error as of https://forum.plantuml.net/10049/2019-pipemap-diagrams-containing-links-give-zero-exit-code )
|
||||
l.add(TestCase.of("-pipemap", "@startuml\na->b\n@enduml", "\n", Verification.EXACT, false, false));
|
||||
l.add(TestCase.of("-pipemap", "@startuml\na\n@enduml", "\n", Verification.EXACT, false, false));
|
||||
|
||||
return l;
|
||||
}
|
||||
@ParameterizedTest
|
||||
@MethodSource("managePipeTestCases")
|
||||
void should_managePipe_manage_success_cases_correctly(TestCase testCase) throws IOException, InterruptedException {
|
||||
option = new Option(testCase.getOptions().split(" "));
|
||||
pipe = new Pipe(option, ps, new ByteArrayInputStream(testCase.getInput().getBytes(UTF_8)), UTF_8.name());
|
||||
|
||||
pipe.managePipe(errorStatus);
|
||||
|
||||
try (AutoCloseableSoftAssertions softly = new AutoCloseableSoftAssertions()) {
|
||||
softly.assertThat(errorStatus.hasError()).isEqualTo(testCase.isExpectedHasErrors());
|
||||
softly.assertThat(errorStatus.isNoData()).isEqualTo(testCase.isExpectedIsNoData());
|
||||
switch(testCase.getExpectedOutVerification()) {
|
||||
case EXACT:
|
||||
softly.assertThat(new String(baos.toByteArray(), UTF_8)).isEqualTo(testCase.getExpectedOut());
|
||||
break;
|
||||
|
||||
case REGEX:
|
||||
softly.assertThat(new String(baos.toByteArray(), UTF_8)).matches(testCase.getExpectedOut());
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_readOneDiagram_return_null_for_empty_input() throws IOException {
|
||||
pipe = new Pipe(option, null, new ByteArrayInputStream(new byte[0]), UTF_8.name());
|
||||
|
||||
String actual = pipe.readOneDiagram();
|
||||
|
||||
assertThat(actual).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_readOneDiagram_remove_carriage_returns() throws IOException {
|
||||
pipe = new Pipe(option, null, new ByteArrayInputStream("@startuml\na\rb\r\nc\rd\re\n@enduml".getBytes(UTF_8)), UTF_8.name());
|
||||
|
||||
String actual = pipe.readOneDiagram();
|
||||
|
||||
assertThat(actual).isEqualTo("@startuml\nab\ncde\n@enduml");
|
||||
}
|
||||
|
||||
static List<InputExpected> startAndEndMarks() {
|
||||
LinkedList<InputExpected> linkedList = new LinkedList<>();
|
||||
linkedList.add(InputExpected.of("\na\rb\r\nc\rd\re\n@enduml", "@startuml\nab\ncde\n@enduml\n@enduml"));
|
||||
linkedList.add(InputExpected.of("\na\rb\r\nc\rd\re\n@endwhatever", "@startuml\nab\ncde\n@endwhatever\n@enduml"));
|
||||
linkedList.add(InputExpected.of("\na\rb\r\nc\rd\re\n@enduml\n", "@startuml\nab\ncde\n@enduml\n@enduml"));
|
||||
linkedList.add(InputExpected.of("@startuml\na\rb\r\nc\rd\re\n@enduml", "@startuml\nab\ncde\n@enduml"));
|
||||
linkedList.add(InputExpected.of("@startuml\na\rb\r\nc\rd\re\n@enduml\n", "@startuml\nab\ncde\n@enduml"));
|
||||
linkedList.add(InputExpected.of("@startuml\na\rb\r\nc\rd\re\n@enduml\n\n", "@startuml\nab\ncde\n@enduml"));
|
||||
linkedList.add(InputExpected.of("@startuml\na\rb\r\nc\rd\re\n@enduml\r\n\r\n", "@startuml\nab\ncde\n@enduml"));
|
||||
linkedList.add(InputExpected.of("this-is-garbage\n@startuml\na\rb\r\nc\rd\re\n@enduml\nthis-is-garbage\n", "@startuml\nab\ncde\n@enduml"));
|
||||
linkedList.add(InputExpected.of("@startwhatever\na\rb\r\nc\rd\re\n@endwhatever", "@startwhatever\nab\ncde\n@endwhatever"));
|
||||
return linkedList;
|
||||
}
|
||||
|
||||
@ParameterizedTest
|
||||
@MethodSource("startAndEndMarks")
|
||||
void should_readOneDiagram_handle_correctly_start_and_end_marks(InputExpected inputExpected) throws IOException {
|
||||
pipe = new Pipe(option, null, new ByteArrayInputStream(inputExpected.getInput().getBytes(UTF_8)), UTF_8.name());
|
||||
|
||||
String actual = pipe.readOneDiagram();
|
||||
|
||||
assertThat(actual).isEqualTo(inputExpected.getExpected());
|
||||
}
|
||||
|
||||
@ParameterizedTest
|
||||
@ValueSource(strings = {"@@@format png", "png", "@@@format png <deadbeef>"})
|
||||
void should_manageFormat_handle_png(String valid) {
|
||||
pipe.manageFormat(valid);
|
||||
|
||||
assertThat(option.getFileFormatOption().getFileFormat()).isEqualTo(FileFormat.PNG);
|
||||
}
|
||||
|
||||
@ParameterizedTest
|
||||
@ValueSource(strings = {"@@@format svg", "svg", "@@@format svg <deadbeef>"})
|
||||
void should_manageFormat_handle_svg(String valid) {
|
||||
pipe.manageFormat(valid);
|
||||
|
||||
assertThat(option.getFileFormatOption().getFileFormat()).isEqualTo(FileFormat.SVG);
|
||||
}
|
||||
|
||||
@ParameterizedTest
|
||||
@ValueSource(strings = {"@@@format invalid", "invalid", "@@@format invalid <deadbeef>"})
|
||||
void should_manageFormat_ignore_any_other_value_and_keep_default_value_as_file_format_option(String valid) {
|
||||
pipe.manageFormat(valid);
|
||||
|
||||
assertThat(option.getFileFormatOption().getFileFormat()).isEqualTo(FileFormat.PNG);
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_readOneLine_returns_null_if_no_input() throws IOException {
|
||||
pipe = new Pipe(option, null, new ByteArrayInputStream(new byte[0]), UTF_8.toString());
|
||||
|
||||
String result = pipe.readOneLine();
|
||||
|
||||
assertThat(result).isNull();
|
||||
}
|
||||
|
||||
@ParameterizedTest
|
||||
@ValueSource(strings = {"\rab\nc\n", "\ra\rb\r\nc\n", "ab\n\rc"})
|
||||
void should_readOneLine_ignore_carriage_return_and_stop_at_line_feed(String input) throws IOException {
|
||||
pipe = new Pipe(option, null, new ByteArrayInputStream(input.getBytes(UTF_8)), UTF_8.name());
|
||||
|
||||
String actual = pipe.readOneLine();
|
||||
|
||||
assertThat(actual).isEqualTo("ab");
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_readOneLine_return_empty_string_if_line_feed_is_the_first_character() throws IOException {
|
||||
pipe = new Pipe(option, null, new ByteArrayInputStream("\n".getBytes(UTF_8)), UTF_8.name());
|
||||
|
||||
String actual = pipe.readOneLine();
|
||||
|
||||
assertThat(actual).isEqualTo("");
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_readOneLine_use_the_default_charset_if_not_provided() throws IOException {
|
||||
pipe = new Pipe(option, null, new ByteArrayInputStream("ab\n".getBytes(Charset.defaultCharset())), null);
|
||||
|
||||
String actual = pipe.readOneLine();
|
||||
|
||||
assertThat(actual).isEqualTo("ab");
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_readOneLine_use_provided_charset() throws IOException {
|
||||
pipe = new Pipe(option, null, new ByteArrayInputStream("\u2620\n".getBytes(UTF_8)), UTF_8.name());
|
||||
|
||||
String actual = pipe.readOneLine();
|
||||
|
||||
assertThat(actual).isEqualTo("\u2620");
|
||||
}
|
||||
|
||||
static class InputExpected {
|
||||
private final String input;
|
||||
private final String expected;
|
||||
|
||||
|
||||
public InputExpected(String input, String expected) {
|
||||
this.input = input;
|
||||
this.expected = expected;
|
||||
}
|
||||
|
||||
public static InputExpected of(String input, String expected) {
|
||||
return new InputExpected(input, expected);
|
||||
}
|
||||
|
||||
public String getInput() {
|
||||
return input;
|
||||
}
|
||||
|
||||
public String getExpected() {
|
||||
return expected;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "i:'" + input + "', e='" + expected + "'";
|
||||
}
|
||||
}
|
||||
|
||||
static class TestCase {
|
||||
private final String options;
|
||||
private final String input;
|
||||
private final String expectedOut;
|
||||
private final Verification expectedOutVerification;
|
||||
private final boolean expectedHasErrors;
|
||||
private final boolean expectedIsNoData;
|
||||
|
||||
|
||||
public TestCase(String options, String input, String expectedOut, Verification expectedOutVerification, boolean expectedHasErrors, boolean expectedIsNoData) {
|
||||
this.options = options;
|
||||
this.input = input;
|
||||
this.expectedOut = expectedOut;
|
||||
this.expectedOutVerification = expectedOutVerification;
|
||||
this.expectedHasErrors = expectedHasErrors;
|
||||
this.expectedIsNoData = expectedIsNoData;
|
||||
}
|
||||
|
||||
public static TestCase of(String option, String input, String expectedOut, Verification expectedOutVerification, boolean expectedHasErrors, boolean expectedIsNoData) {
|
||||
return new TestCase(option, input, expectedOut, expectedOutVerification, expectedHasErrors, expectedIsNoData);
|
||||
}
|
||||
|
||||
public String getOptions() {
|
||||
return options;
|
||||
}
|
||||
|
||||
public String getInput() {
|
||||
return input;
|
||||
}
|
||||
|
||||
public String getExpectedOut() {
|
||||
return expectedOut;
|
||||
}
|
||||
|
||||
public Verification getExpectedOutVerification() {
|
||||
return expectedOutVerification;
|
||||
}
|
||||
|
||||
public boolean isExpectedHasErrors() {
|
||||
return expectedHasErrors;
|
||||
}
|
||||
|
||||
public boolean isExpectedIsNoData() {
|
||||
return expectedIsNoData;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "o:'" + options + "', i:'" + input + "', e-out='" + expectedOut + "', e-err='" + expectedHasErrors + "', e-nodata='" + expectedIsNoData + "'";
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
enum Verification {
|
||||
EXACT,
|
||||
REGEX
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user