demo/validator
1
0
Fork 0
mirror of https://github.com/itplr-kosit/validator.git synced 2026-05-25 16:55:39 +00:00
Code Issues Projects Releases Packages Wiki Activity

Resolve "Validator new feature: Pruefbericht Gesamtuebersicht bei Batch Verarbeitung"

Browse source
This commit is contained in:
Andreas Penski 2020-08-10 06:38:20 +00:00
parent c781316509
commit e265667f25
31 changed files with 791 additions and 110 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/main/java/de/kosit/validationtool/api/CheckConfiguration.java
View file

@ -36,7 +36,7 @@ import de.kosit.validationtool.impl.Scenario;
* Zentrale Konfigration einer Prüf-Instanz.
*
* @author Andreas Penski
* @deprecated since 2.0 use {@link Configuration} instead
* @deprecated since 1.3.0 use {@link Configuration} instead
*/
@Getter
@Setter

16
src/main/java/de/kosit/validationtool/cmd/CommandLineApplication.java
View file

@ -28,7 +28,10 @@ import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
@ -45,6 +48,7 @@ import lombok.extern.slf4j.Slf4j;
import de.kosit.validationtool.api.Configuration;
import de.kosit.validationtool.api.Input;
import de.kosit.validationtool.api.InputFactory;
import de.kosit.validationtool.api.Result;
import de.kosit.validationtool.cmd.assertions.Assertions;
import de.kosit.validationtool.config.ConfigurationLoader;
import de.kosit.validationtool.daemon.Daemon;
@ -58,6 +62,7 @@ import net.sf.saxon.s9api.Processor;
* @author Andreas Penski
*/
@Slf4j
@SuppressWarnings("squid:S3725") // performance is not a problem here
public class CommandLineApplication {
private static final Option HELP = Option.builder("?").longOpt("help").argName("Help").desc("Displays this help").build();
@ -247,16 +252,17 @@ public class CommandLineApplication {
final Collection<Path> targets = determineTestTargets(cmd);
start = System.currentTimeMillis();
final Map<Path, Result> results = new HashMap<>();
for (final Path p : targets) {
final Input input = InputFactory.read(p);
check.checkInput(input);
results.put(p, check.checkInput(input));
}
final boolean result = check.printAndEvaluate();
final boolean result = check.printAndEvaluate(results);
log.info("Processing {} object(s) completed in {}ms", targets.size(), System.currentTimeMillis() - start);
return result ? 0 : 1;
} catch (final Exception e) {
e.printStackTrace();
e.printStackTrace();// NOSONAR
if (cmd.hasOption(DEBUG.getOpt())) {
log.error(e.getMessage(), e);
} else {
@ -327,8 +333,8 @@ public class CommandLineApplication {
}
private static Collection<Path> listDirectoryTargets(final Path d) {
try {
return Files.list(d).filter(path -> path.toString().endsWith(".xml")).collect(Collectors.toList());
try ( final Stream<Path> stream = Files.list(d) ) {
return stream.filter(path -> path.toString().endsWith(".xml")).collect(Collectors.toList());
} catch (final IOException e) {
throw new IllegalStateException("IOException while list directory content. Can not determine test targets.", e);
}

2
src/main/java/de/kosit/validationtool/cmd/DefaultNamingStrategy.java
View file

@ -25,7 +25,7 @@ public class DefaultNamingStrategy implements NamingStrategy {
if (StringUtils.isEmpty(base)) {
throw new IllegalArgumentException("Can not generate name based on null input");
}
final int index = base.lastIndexOf(".");
final int index = base.lastIndexOf('.');
final StringBuilder result = new StringBuilder();
if (isNotEmpty(this.prefix)) {
result.append(this.prefix).append("-");

73
src/main/java/de/kosit/validationtool/cmd/InternalCheck.java
View file

@ -19,14 +19,28 @@
package de.kosit.validationtool.cmd;
import java.io.PrintWriter;
import java.nio.file.Path;
import java.util.Comparator;
import java.util.Map;
import java.util.stream.Collectors;
import org.fusesource.jansi.AnsiRenderer.Code;
import lombok.extern.slf4j.Slf4j;
import de.kosit.validationtool.api.Configuration;
import de.kosit.validationtool.api.Input;
import de.kosit.validationtool.api.Result;
import de.kosit.validationtool.api.XmlError;
import de.kosit.validationtool.cmd.report.Grid;
import de.kosit.validationtool.cmd.report.Grid.ColumnDefinition;
import de.kosit.validationtool.cmd.report.Justify;
import de.kosit.validationtool.cmd.report.Line;
import de.kosit.validationtool.impl.DefaultCheck;
import de.kosit.validationtool.impl.tasks.CheckAction;
/**
* Simple Erweiterung der Klasse {@link DefaultCheck} um das Ergebnis der Assertion-Prüfung auszwerten und auszugeben.
* Diese Klasse stellt keine fachlicher Erweiterung des eigentlichen Prüfvorganges dar!
@ -66,7 +80,11 @@ class InternalCheck extends DefaultCheck {
return result;
}
boolean printAndEvaluate() {
boolean printAndEvaluate(final Map<Path, Result> results) {
final PrintWriter writer = new PrintWriter(System.out);// NOSONAR
writer.write(createResultGrid(results).render());
writer.write(createStatusLine(results));
writer.flush();
if (this.failedAssertions > 0) {
log.error("Assertion check failed.\n\nAssertions run: {}, Assertions failed: {}\n", this.checkAssertions,
this.failedAssertions);
@ -74,7 +92,58 @@ class InternalCheck extends DefaultCheck {
log.info("Assertion check successful.\n\nAssertions run: {}, Assertions failed: {}\n", this.checkAssertions,
this.failedAssertions);
}
return this.failedAssertions == 0;
return this.failedAssertions == 0 && results.entrySet().stream().allMatch(e -> e.getValue().isAcceptable());
}
private static String createStatusLine(final Map<Path, Result> results) {
final long acceptable = results.entrySet().stream().filter(e -> e.getValue().isAcceptable()).count();
final long rejected = results.entrySet().stream().filter(e -> !e.getValue().isAcceptable()).count();
final long errors = results.entrySet().stream().filter(e -> !e.getValue().isProcessingSuccessful()).count();
final Line line = new Line();
line.add(String.format("Validation of %s objects finished. ", results.size()));
line.add("Acceptable: ").add(acceptable, Code.GREEN);
line.add(" Rejected: ").add(rejected, Code.RED);
if (errors > 0) {
line.add(" Processing errors: ").add(errors, Code.RED);
}
return line.render();
}
private static Grid createResultGrid(final Map<Path, Result> results) {
final Grid grid = new Grid(
//@formatter:off
new ColumnDefinition("filename", 60, 10, 1),
new ColumnDefinition("Schema", 7).justify(Justify.CENTER),
new ColumnDefinition("Schematron", 10).justify(Justify.CENTER),
new ColumnDefinition("Acceptance", 10, 5).justify(Justify.CENTER),
new ColumnDefinition("Error/Description", 60,20,3)
);
//@formatter:on
results.entrySet().stream().sorted(Comparator.comparing(e -> e.getKey().getFileName())).forEach(e -> {
final Result value = e.getValue();
final Code textcolor = value.isAcceptable() ? Code.GREEN : Code.RED;
grid.addCell(e.getKey().getFileName(), textcolor);
grid.addCell(value.isSchemaValid() ? "Y" : "N", textcolor);
grid.addCell(value.isSchematronValid() ? "Y" : "N", textcolor);
grid.addCell(value.getAcceptRecommendation(), textcolor);
grid.addCell(joinErrors(value));
});
return grid;
}
private static String joinErrors(final Result value) {
final StringBuilder b = new StringBuilder();
b.append(String.join(";", value.getProcessingErrors()));
if (value.getSchemaViolations() != null && !value.getSchemaViolations().isEmpty()) {
b.append(b.length() > 0 ? ";" : "");
b.append(value.getSchemaViolations().stream().map(XmlError::getMessage).collect(Collectors.joining(";")));
}
if (value.getSchematronResult() != null && !value.getSchematronResult().isEmpty()) {
b.append(b.length() > 0 ? ";" : "");
b.append(value.getSchematronResult().stream().flatMap(e -> e.getMessages().stream()).collect(Collectors.joining(";")));
}
return b.toString();
}
}

8
src/main/java/de/kosit/validationtool/cmd/PrintReportAction.java
View file

@ -42,13 +42,13 @@ class PrintReportAction implements CheckAction {
private final Processor processor;
@Override
public void check(Bag results) {
public void check(final Bag results) {
try {
final StringWriter writer = new StringWriter();
final Serializer serializer = processor.newSerializer(writer);
final Serializer serializer = this.processor.newSerializer(writer);
serializer.serializeNode(results.getReport());
System.out.print(writer.toString());
} catch (SaxonApiException e) {
System.out.print(writer.toString()); // NOSONAR
} catch (final SaxonApiException e) {
log.error("Error while printing result to stdout", e);
}
}

84
src/main/java/de/kosit/validationtool/cmd/report/Format.java Normal file
View file

@ -0,0 +1,84 @@
package de.kosit.validationtool.cmd.report;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;
import org.apache.commons.lang3.ArrayUtils;
import org.fusesource.jansi.AnsiRenderer.Code;
import lombok.Getter;
/**
* Simple value holder for ansi formatting codes.
*
* @author Andreas Penski
*/
@Getter
public class Format {
private Code textColor;
private Code background;
@Getter
private final Set<Code> codes = new HashSet<>();
public Code[] mergeCodes(final Collection<Code> newCodes) {
return mergeCodes(newCodes.toArray(new Code[newCodes.size()]));
}
public Code[] mergeCodes(final Code... newCodes) {
final Code[] allCodes = ArrayUtils.addAll(ArrayUtils.addAll(this.codes.toArray(new Code[0]), newCodes), this.textColor,
this.background);
final Optional<Code> color = Arrays.stream(allCodes).filter(Objects::nonNull).filter(Code::isColor).findFirst();
final Optional<Code> bg = Arrays.stream(allCodes).filter(Objects::nonNull).filter(Code::isBackground).findFirst();
final List<Code> attributes = Arrays.stream(allCodes).filter(Objects::nonNull).filter(Code::isBackground).filter(Code::isColor)
.collect(Collectors.toList());
attributes.add(color.orElse(this.textColor));
attributes.add(bg.orElse(this.background));
return attributes.stream().filter(Objects::nonNull).toArray(Code[]::new);
}
/**
* Sets explicit text color.
*
* @param textColor the color.
*
* @return this {@link Format}
*/
public Format color(final Code textColor) {
this.textColor = textColor;
return this;
}
/**
* Sets explicit background color.
*
* @param color the color.
*
* @return this {@link Format}
*/
public Format background(final Code color) {
this.background = color;
return this;
}
/**
* Fügt weitere Formatierungscodes hinzu.
*
* @param codes die Codes
*
* @return this {@link Format}
*/
public Format addCodes(final Code... codes) {
this.codes.addAll(Arrays.asList(codes));
return this;
}
}

320
src/main/java/de/kosit/validationtool/cmd/report/Grid.java Normal file
View file

@ -0,0 +1,320 @@
package de.kosit.validationtool.cmd.report;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.stream.Collectors;
import java.util.stream.IntStream;
import java.util.stream.Stream;
import org.apache.commons.lang3.StringUtils;
import org.fusesource.jansi.AnsiRenderer.Code;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
/**
* An text based grid for cli based programs.
*
* @author Andreas Penski
*/
public class Grid {
/**
* A definition / configuration for a column with a result table.
*/
@Getter
public static class ColumnDefinition {
private static final int MAX_LENGTH = 80;
private final String name;
private int length = 0;
private final int maxLength;
private final int minLength;
private final int maxLines;
private Justify justify = Justify.LEFT;
/**
* Constructor.
*
* @param name the name of the column
*/
public ColumnDefinition(final String name) {
this(name, -1, -1, 1);
}
/**
* Constructor.
*
* @param name the name of the column
* @param maxLength the max length of the column
*/
public ColumnDefinition(final String name, final int maxLength) {
this(name, maxLength, -1, 1);
}
/**
* Constructor.
*
* @param name the name of the column
* @param maxLength the max length of the column
*/
public ColumnDefinition(final String name, final int maxLength, final int minLength) {
this(name, maxLength, minLength, 1);
}
/**
* Constructor.
*
* @param name the name of the column
* @param minLength the max length of the column
* @param maxLines the max lines per cell
*/
public ColumnDefinition(final String name, final int maxLength, final int minLength, final int maxLines) {
this.name = name;
this.maxLength = maxLength;
this.minLength = minLength;
this.maxLines = maxLines;
}
/**
* Returns the actual max length of the column
*
* @return max length
*/
public int getLength() {
if (this.minLength > 0 && this.minLength > this.length) {
return this.minLength;
}
if (this.maxLength > 0 && this.length > this.maxLength) {
return this.maxLength;
}
return this.length;
}
/**
* Sets a calculated length for the column.
*
* @param length the length
*/
public void setLength(final int length) {
if (length > this.length) {
this.length = length;
}
if (length > MAX_LENGTH) {
this.length = MAX_LENGTH;
}
}
public ColumnDefinition justify(final Justify justify) {
this.justify = justify;
return this;
}
}
@RequiredArgsConstructor
@Getter
private static class Cell {
private final Format format = DEFAULT_FORMAT;
private final List<Text> text;
public Cell(final Text txt) {
this.text = new ArrayList<>();
this.text.add(txt);
}
public Cell(final Object object, final Code... codes) {
this(new Text(object, codes));
}
protected Line getFormattedLine(final int lineNumber, final ColumnDefinition def) {
final Line line = new Line();
int startSubstring = lineNumber * def.getLength();
int currentVisibleLength = 0;
for (final Text t : this.text) {
final String part = t.getVisibleText(startSubstring, def.getLength());
currentVisibleLength += part.length();
if (StringUtils.isNotBlank(part)) {
line.add(part, t.getFormat());
if (currentVisibleLength >= def.getLength()) {
break;
}
startSubstring = 0;
} else {
startSubstring = startSubstring - t.getLength();
}
}
return line;
}
protected List<Line> getFormattedLines(final ColumnDefinition def) {
int count = 0;
Line line;
final List<Line> lines = new ArrayList<>();
while ((line = getFormattedLine(count++, def)).isNotEmpty()) {
lines.add(line);
}
return lines;
}
public String render(final int row, final ColumnDefinition def) {
final List<Line> test = getFormattedLines(def);
final Line line = test.size() > row ? test.get(row) : null;
if (line != null) {
return def.getJustify().apply(line.render(false, row == def.getMaxLines() - 1 && test.size() > def.getMaxLines()),
def.getLength() + (line.getLength() - line.getVisibleLength()));
}
return def.getJustify().apply("", def.getLength());
}
public Cell add(final Object object, final Code... codes) {
this.text.add(new Text(object, codes));
return this;
}
}
private static final Format DEFAULT_FORMAT = new Format();
/**
* A grid / table for printing results.
*/
private final List<ColumnDefinition> definitions = new ArrayList<>();
private final List<Cell> values = new ArrayList<>();
/**
* Constructor.
*
* @param def {@link ColumnDefinition}s
*/
public Grid(final ColumnDefinition... def) {
Stream.of(def).forEach(this::addColumn);
}
private String generateGridStart() {
return IntStream.range(0, getLineLength() + this.definitions.size()).mapToObj(i -> "-").collect(Collectors.joining("")) + "\n";
}
private String generateGridEnd() {
return IntStream.range(0, getLineLength() + this.definitions.size()).mapToObj(i -> "-").collect(Collectors.joining("")) + "\n";
}
private String generateHeader() {
return "|" + this.definitions.stream().map(d -> StringUtils.rightPad(d.getName(), d.getLength())).collect(Collectors.joining("|"))
+ "|\n";
}
/**
* Adds new a column definition.
*
* @param def definitions
* @return this grid
*/
public Grid addColumn(final ColumnDefinition def) {
this.definitions.add(def);
return this;
}
private void calculateLength() {
IntStream.range(0, this.definitions.size()).forEach(i -> {
final ColumnDefinition def = this.definitions.get(i);
final List<Cell> column = getColumn(i);
final int maxLength = column.stream().mapToInt(cell -> cell.getText().stream().mapToInt(Text::getLength).sum()).max().orElse(0);
def.setLength(Math.max(maxLength, def.getName().length()));
});
}
public List<Cell> getColumn(final int index) {
return IntStream.range(0, this.values.size()).filter(n -> n % this.definitions.size() == index).mapToObj(this.values::get)
.collect(Collectors.toList());
}
public Grid addCell(final Cell cell) {
this.values.add(cell);
return this;
}
public Grid addCell(final Text... text) {
return addCell(new Cell(Arrays.asList(text)));
}
public Grid addCell(final Object cell, final Code... codes) {
final Format f = new Format();
f.addCodes(codes);
final Text t = new Text(cell, f);
return addCell(new Cell(t));
}
public Grid addCell(final Object cell) {
return addCell(cell, DEFAULT_FORMAT.getTextColor());
}
private Collection<List<Cell>> prepareLines() {
final AtomicInteger counter = new AtomicInteger();
final int chunkSize = this.definitions.size();
return this.values.stream().collect(Collectors.groupingBy(it -> counter.getAndIncrement() / chunkSize)).values();
}
public String render() {
final StringBuilder b = new StringBuilder();
calculateLength();
b.append(generateGridStart());
b.append(generateHeader());
prepareLines().forEach(line -> b.append(printLine(line)));
b.append(generateGridEnd());
return b.toString();
}
private String printLine(final List<Cell> line) {
final StringBuilder b = new StringBuilder();
int virtualLine = 0;
while (true) {
final StringBuilder current = new StringBuilder();
final int bound = this.definitions.size();
for (int i = 0; i < bound; i++) {
final ColumnDefinition def = this.definitions.get(i);
current.append("|");
current.append(line.get(i).render(virtualLine, def));
}
current.append("|");
if (isEmpty(current) || virtualLine >= getMaxVirtualLine()) {
break;
}
b.append(current.toString());
virtualLine++;
b.append("\n");
}
return b.toString();
}
private static boolean isEmpty(final StringBuilder current) {
return current.toString().replaceAll("\\|", "").trim().length() == 0;
}
private int getMaxVirtualLine() {
return this.definitions.stream().mapToInt(ColumnDefinition::getMaxLines).max().orElseThrow(IllegalAccessError::new);
}
private int getLineLength() {
return this.definitions.stream().map(ColumnDefinition::getLength).reduce(0, Integer::sum);
}
}

35
src/main/java/de/kosit/validationtool/cmd/report/Justify.java Normal file
View file

@ -0,0 +1,35 @@
package de.kosit.validationtool.cmd.report;
import org.apache.commons.lang3.StringUtils;
/**
* Justification modes for the text in grid columns.
*
* @author Andreas Penski
*/
public enum Justify {
LEFT {
@Override
public String apply(final String string, final int length) {
return StringUtils.rightPad(string, length);
}
},
CENTER {
@Override
public String apply(final String string, final int length) {
return StringUtils.center(string, length);
}
},
RIGHT {
@Override
public String apply(final String string, final int length) {
return StringUtils.leftPad(string, length);
}
};
public abstract String apply(String string, int length);
}

106
src/main/java/de/kosit/validationtool/cmd/report/Line.java Normal file
View file

@ -0,0 +1,106 @@
package de.kosit.validationtool.cmd.report;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import org.apache.commons.lang3.StringUtils;
import org.fusesource.jansi.AnsiRenderer.Code;
import lombok.NoArgsConstructor;
/**
* Helper for printing a colored lines (with newline at the end) to the console.
*/
@NoArgsConstructor
public class Line {
private final List<Text> texts = new ArrayList<>();
private Format baseFormat = new Format();
/**
* Constructor.
*
* @param format the configured base format
*/
public Line(final Format format) {
this.baseFormat = format;
}
/**
* Constructor.
*
* @param codes Ansi escape codes for formatting
*/
public Line(final Code... codes) {
this(new Format().addCodes(codes));
}
/**
* Add some text to the line.
*
* @param text the text
* @return this line
*/
public Line add(final Text text) {
this.texts.add(text);
return this;
}
public Line add(final Object t) {
return add(new Text(t));
}
public Line add(final Object text, final Code... codes) {
return add(new Text(text, codes));
}
public Line add(final Object text, final Format format) {
return add(new Text(text, format));
}
public String render() {
return render(true, false);
}
String render(final boolean newLine, final boolean dotted) {
final List<String> joins = new ArrayList<>();
final List<Text> reversed = new ArrayList<>(this.texts);
int replace = 0;
Collections.reverse(reversed);
if (dotted && getVisibleLength() > replace) {
replace = 3;
}
for (final Text t : reversed) {
if (replace > 0) {
final String render = t.render(t.getVisibleText(0, t.getVisibleLength() - replace), this.baseFormat);
if (StringUtils.isNotEmpty(render)) {
joins.add(render);
}
replace = replace - t.getVisibleLength();
} else {
joins.add(t.render(this.baseFormat));
}
}
Collections.reverse(joins);
return String.join(" ", joins) + (dotted ? "..." : "") + (newLine ? "\n" : "");
}
public int getLength() {
return this.texts.stream().mapToInt(Text::getLength).sum();
}
public static String render(final String text, final Code... codes) {
return new Line().add(text, codes).render();
}
public boolean isNotEmpty() {
return !this.texts.isEmpty();
}
public int getVisibleLength() {
return this.texts.stream().mapToInt(Text::getVisibleLength).sum();
}
}

63
src/main/java/de/kosit/validationtool/cmd/report/Text.java Normal file
View file

@ -0,0 +1,63 @@
package de.kosit.validationtool.cmd.report;
import java.util.Arrays;
import org.fusesource.jansi.AnsiRenderer;
import org.fusesource.jansi.AnsiRenderer.Code;
import lombok.Getter;
/**
* Ansi formatted text for outputting to the console.
*
* @author Andreas Penski
*/
@Getter
public class Text {
private final String value;
private Format format;
public Text(final Object value) {
this.value = value != null ? value.toString() : "";
this.format = new Format();
}
public Text(final Object value, final Format format) {
this(value);
this.format = format;
}
public Text(final Object value, final Code... codes) {
this(value, new Format().addCodes(codes));
}
public String getVisibleText(final int startIndex, final int length) {
if (startIndex < 0) {
return "Wrong cell text index";
}
if (startIndex > this.value.length()) {
return "";
}
final String substring = this.value.substring(startIndex);
return substring.length() > length ? substring.substring(0, length) : substring;
}
public String render(final String text, final Format baseformat) {
return AnsiRenderer.render(text,
Arrays.stream(this.format.mergeCodes(baseformat.getCodes())).map(Code::name).toArray(String[]::new));
}
public int getLength() {
return render(this.format).length();
}
public String render(final Format baseFormat) {
return render(getValue(), baseFormat);
}
public int getVisibleLength() {
return this.value.length();
}
}

1
src/main/java/de/kosit/validationtool/daemon/CheckHandler.java
View file

@ -44,6 +44,7 @@ class CheckHandler extends BaseHandler {
try {
log.debug("Incoming request");
final String requestMethod = httpExchange.getRequestMethod();
// check neccessary, since gui can be disabled
if (requestMethod.equals("POST")) {
final InputStream inputStream = httpExchange.getRequestBody();
if (inputStream.available() > 0) {

19
src/main/java/de/kosit/validationtool/daemon/GuiHandler.java
View file

@ -1,15 +1,17 @@
package de.kosit.validationtool.daemon;
import com.sun.net.httpserver.HttpExchange;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
import org.apache.commons.io.IOUtils;
import java.io.IOException;
import java.net.URL;
import java.nio.charset.Charset;
import java.util.Arrays;
import org.apache.commons.io.IOUtils;
import com.sun.net.httpserver.HttpExchange;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
public class GuiHandler extends BaseHandler {
private static final URL INDEX_HTML = GuiHandler.class.getClassLoader().getResource("gui/index.html");
@ -21,7 +23,7 @@ public class GuiHandler extends BaseHandler {
}
@Override
public void handle(HttpExchange exchange) throws IOException {
public void handle(final HttpExchange exchange) throws IOException {
assert INDEX_HTML != null;
final String path = exchange.getRequestURI().toASCIIString();
if (path.equals("/")) {
@ -29,7 +31,8 @@ public class GuiHandler extends BaseHandler {
} else{
final URL resource = GuiHandler.class.getClassLoader().getResource("gui" + path);
if (resource != null) {
write(exchange,IOUtils.toString(resource, Charset.defaultCharset()).getBytes(), Mediatype.resolveBySuffix(resource.getPath()).getMimeType());;
write(exchange, IOUtils.toString(resource, Charset.defaultCharset()).getBytes(),
Mediatype.resolveBySuffix(resource.getPath()).getMimeType());
}else {
error(exchange,404,"not found");
}
@ -45,7 +48,7 @@ public class GuiHandler extends BaseHandler {
CSS("text/css");
private final String mimeType;
static Mediatype resolveBySuffix(String path){
static Mediatype resolveBySuffix(final String path) {
return Arrays.stream(values()).filter(e->path.toUpperCase().endsWith("."+e.name())).findFirst().orElse(Mediatype.MD);
}
}

8
src/main/java/de/kosit/validationtool/daemon/HealthHandler.java
View file

@ -4,13 +4,13 @@ import java.io.IOException;
import com.sun.net.httpserver.HttpExchange;
import de.kosit.validationtool.impl.EngineInformation;
import de.kosit.validationtool.model.daemon.ApplicationType;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import de.kosit.validationtool.api.Configuration;
import de.kosit.validationtool.impl.ConversionService;
import de.kosit.validationtool.impl.EngineInformation;
import de.kosit.validationtool.model.daemon.ApplicationType;
import de.kosit.validationtool.model.daemon.HealthType;
import de.kosit.validationtool.model.daemon.MemoryType;
@ -39,7 +39,7 @@ class HealthHandler extends BaseHandler {
final HealthType h = new HealthType();
h.setMemory(createMemory());
h.setApplication(createApplication());
h.setStatus(scenarios.getScenarios().size() > 0 ? "UP" : "DOWN");
h.setStatus(!this.scenarios.getScenarios().isEmpty() ? "UP" : "DOWN");
return h;
}
@ -53,7 +53,7 @@ class HealthHandler extends BaseHandler {
}
private static ApplicationType createApplication() {
ApplicationType a = new ApplicationType();
final ApplicationType a = new ApplicationType();
a.setBuild(EngineInformation.getBuild());
a.setName(EngineInformation.getName());
a.setVersion(EngineInformation.getVersion());

14
src/main/java/de/kosit/validationtool/daemon/RoutingHandler.java
View file

@ -1,11 +1,11 @@
package de.kosit.validationtool.daemon;
import com.sun.net.httpserver.HttpExchange;
import com.sun.net.httpserver.HttpHandler;
import lombok.RequiredArgsConstructor;
import java.io.IOException;
import com.sun.net.httpserver.HttpExchange;
import lombok.RequiredArgsConstructor;
/**
* A simple handler which routes between the {@link CheckHandler} and the {@link GuiHandler} depending on the request.
*/
@ -17,12 +17,12 @@ class RoutingHandler extends BaseHandler {
private final GuiHandler guiHandler;
@Override
public void handle(HttpExchange exchange) throws IOException {
public void handle(final HttpExchange exchange) throws IOException {
final String requestMethod = exchange.getRequestMethod();
if (requestMethod.equals("POST")) {
checkHandler.handle(exchange);
this.checkHandler.handle(exchange);
} else if (requestMethod.equals("GET")) {
guiHandler.handle(exchange);
this.guiHandler.handle(exchange);
} else {
error(exchange, 405, String.format("Method % not supported", requestMethod));
}

3
src/main/java/de/kosit/validationtool/impl/ClassPathResourceResolver.java
View file

@ -114,8 +114,9 @@ class ClassPathResourceResolver implements LSResourceResolver {
try {
final URL resource = resolved.isAbsolute() ? resolved.toURL()
: ClassPathResourceResolver.class.getResource(resolved.toASCIIString());
final InputStream in = resource.openStream();
final LSInputImpl input = new LSInputImpl(publicId, systemId, resolved.toASCIIString());
// intentionally not closed, since xml stack wants it open upon return
final InputStream in = resource.openStream();
input.setByteStream(in);
return input;

11
src/main/java/de/kosit/validationtool/impl/CollectingErrorEventHandler.java
View file

@ -51,9 +51,9 @@ public class CollectingErrorEventHandler implements ValidationEventHandler, Erro
private static final int DEFAULT_ABORT_COUNT = 50;
private final Collection<XMLSyntaxError> errors = new ArrayList<>();
private static final int stopProcessCount = DEFAULT_ABORT_COUNT;
private final int stopProcessCount = DEFAULT_ABORT_COUNT;
private final Collection<XMLSyntaxError> errors = new ArrayList<>();
private static XMLSyntaxError createError(final XMLSyntaxErrorSeverity severity, final String message) {
final XMLSyntaxError e = new XMLSyntaxError();
@ -97,7 +97,7 @@ public class CollectingErrorEventHandler implements ValidationEventHandler, Erro
e.setColumnNumber(event.getLocator().getColumnNumber());
e.setRowNumber(event.getLocator().getLineNumber());
this.errors.add(e);
return this.stopProcessCount != this.errors.size();
return stopProcessCount != this.errors.size();
}
/**
@ -161,9 +161,8 @@ public class CollectingErrorEventHandler implements ValidationEventHandler, Erro
public String getErrorDescription() {
final StringJoiner joiner = new StringJoiner("\n");
this.errors.forEach(e -> joiner
.add(e.getSeverityCode().value() + " " + e.getMessage() + " At row " + e.getRowNumber() + " at pos "
+ e.getColumnNumber()));
this.errors.forEach(e -> joiner.add(
e.getSeverityCode().value() + " " + e.getMessage() + " At row " + e.getRowNumber() + " at pos " + e.getColumnNumber()));
return joiner.toString();
}
}

2
src/main/java/de/kosit/validationtool/impl/ContentRepository.java
View file

@ -101,7 +101,7 @@ public class ContentRepository {
this.schemaFactory = this.resolvingConfigurationStrategy.createSchemaFactory();
}
@SuppressWarnings("java:S2095")
@SuppressWarnings("squid:S2095")
private static Source resolve(final URL resource) {
try {
return new StreamSource(resource.openStream(), resource.toURI().getRawPath());

2
src/main/java/de/kosit/validationtool/impl/ConversionService.java
View file

@ -131,7 +131,7 @@ public class ConversionService {
public void initialize(final Collection<Package> context) {
final String[] packages = context != null ? context.stream().map(Package::getName).toArray(String[]::new) : new String[0];
final StringJoiner joiner = new StringJoiner(":");
Arrays.stream(packages).forEach(p -> joiner.add(p));
Arrays.stream(packages).forEach(joiner::add);
initialize(joiner.toString());
}

12
src/main/java/de/kosit/validationtool/impl/input/SourceInput.java
View file

@ -52,7 +52,7 @@ public class SourceInput extends AbstractInput {
}
private void validate() {
if (!isHashcodeComputed() && !isSupported()) {
if (!isHashcodeComputed() && isNotSupported()) {
throw new IllegalStateException("Unsupported source. Only StreamSource supported yet");
}
if (!isHashcodeComputed() && ((StreamSource) this.source).getInputStream() == null) {
@ -62,7 +62,7 @@ public class SourceInput extends AbstractInput {
@Override
public Source getSource() throws IOException {
if (!isHashcodeComputed() && !isSupported()) {
if (!isHashcodeComputed() && isNotSupported()) {
throw new IllegalStateException("Unsupported source. Only InputStream-based StreamSource supported yet");
}
if (isConsumed()) {
@ -71,8 +71,8 @@ public class SourceInput extends AbstractInput {
return isHashcodeComputed() ? this.source : wrappedSource();
}
private boolean isSupported() {
return isStreamSource();
private boolean isNotSupported() {
return !isStreamSource();
}
private boolean isConsumed() throws IOException {
@ -107,9 +107,7 @@ public class SourceInput extends AbstractInput {
return result;
}
private boolean isWrappingRequired() {
return !isHashcodeComputed();
}
@Override
public boolean supportsMultipleReads() {

4
src/main/java/de/kosit/validationtool/impl/input/StreamHelper.java
View file

@ -24,6 +24,7 @@ public class StreamHelper {
* Helper class, which generates the hashcode while reading the stream e.g. for parsing the document. This allows
* generating the hashcode without an aditional reading step.
*/
@SuppressWarnings("squid:S4929") // efficient read is done by internally used stream
private static class DigestingInputStream extends FilterInputStream {
private final MessageDigest digest;
@ -44,6 +45,7 @@ public class StreamHelper {
}
@SuppressWarnings("squid:S4929") // efficient read is done by internally used stream
private static class CountInputStream extends FilterInputStream {
private final LazyReadInput reference;
@ -123,10 +125,12 @@ public class StreamHelper {
* @param input the input
* @throws IOException on I/O errors
*/
@SuppressWarnings("squid:S1854")
public static void drain(final InputStream input) throws IOException {
final byte[] buffer = new byte[DEFAULT_BUFFER_SIZE];
int n;
while (EOF != (n = input.read(buffer))) {
// nothing
}

6
src/main/java/de/kosit/validationtool/impl/model/BaseOutput.java
View file

@ -43,7 +43,7 @@ public abstract class BaseOutput {
* @return true wenn mindestens ein {@link FailedAssert} vorhanden ist
*/
public boolean hasFailedAsserts() {
return getFailedAsserts().size() > 0;
return !getFailedAsserts().isEmpty();
}
/**
@ -69,4 +69,8 @@ public abstract class BaseOutput {
return getFailedAsserts().stream().filter(e -> e.getId().equals(name)).findAny();
}
public List<String> getMessages() {
return getFailedAsserts().stream().map(FailedAssert::getText).flatMap(e -> e.getContent().stream()).map(Object::toString)
.collect(Collectors.toList());
}
}

24
src/main/java/de/kosit/validationtool/impl/model/BaseXMLSyntaxError.java
View file

@ -53,30 +53,6 @@ public abstract class BaseXMLSyntaxError implements XmlError {
return String.format("%s At row %s at pos %s", getMessage(), getRowNumber(), getColumnNumber());
}
/**
* Getter aus dem schema
*
* @return Spalte des Fehlers
*/
@Override
public abstract Integer getColumnNumber();
/**
* Getter aus dem schema
*
* @return Zeile des Fehlers
*/
@Override
public abstract Integer getRowNumber();
/**
* Getter aus dem schema
*
* @return Fehlermeldung
*/
@Override
public abstract String getMessage();
/**
* Getter aus dem schema
*

2
src/main/java/de/kosit/validationtool/impl/tasks/SchemaValidationAction.java
View file

@ -191,9 +191,11 @@ public class SchemaValidationAction implements CheckAction {
}
@SuppressWarnings("squid:S2095") // intentionally return open stream/autoclosable here
private SerializedDocument serialize(final Input input, final XdmNode object) throws IOException, SaxonApiException {
final SerializedDocument doc;
if (input instanceof AbstractInput && ((AbstractInput) input).getLength() < getInMemoryLimit()) {
doc = new ByteArraySerializedDocument(this.processor);
} else {
doc = new FileSerializedDocument(this.processor);

11
src/main/java/de/kosit/validationtool/impl/xml/StrictRelativeResolvingStrategy.java
View file

@ -70,6 +70,7 @@ public class StrictRelativeResolvingStrategy extends BaseResolvingStrategy {
@Override
public SchemaFactory createSchemaFactory() {
forceOpenJdkXmlImplementation();
final SchemaFactory sf = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
disableExternalEntities(sf);
allowExternalSchema(sf, "file");
@ -82,7 +83,7 @@ public class StrictRelativeResolvingStrategy extends BaseResolvingStrategy {
// verhindere global im Prinzip alle resolving strategien
final SecureUriResolver resolver = new SecureUriResolver();
processor.getUnderlyingConfiguration().setCollectionFinder(resolver);
processor.getUnderlyingConfiguration().setOutputURIResolver(resolver);
processor.getUnderlyingConfiguration().setOutputURIResolver(resolver);// NOSONAR
processor.getUnderlyingConfiguration().setUnparsedTextURIResolver(resolver);
// grundsätzlich Feature-konfiguration:
@ -92,10 +93,10 @@ public class StrictRelativeResolvingStrategy extends BaseResolvingStrategy {
processor.setConfigurationProperty(Feature.ALLOW_EXTERNAL_FUNCTIONS, false);
// Konfiguration des zu verwendenden Parsers, wenn Saxon selbst einen erzeugen muss, bspw. beim XSL parsen
processor.setConfigurationProperty(FeatureKeys.XML_PARSER_FEATURE + encode(FEATURE_SECURE_PROCESSING), true);
processor.setConfigurationProperty(FeatureKeys.XML_PARSER_FEATURE + encode(DISSALLOW_DOCTYPE_DECL_FEATURE), true);
processor.setConfigurationProperty(FeatureKeys.XML_PARSER_FEATURE + encode(LOAD_EXTERNAL_DTD_FEATURE), false);
processor.setConfigurationProperty(FeatureKeys.XML_PARSER_FEATURE + encode(XMLConstants.ACCESS_EXTERNAL_DTD), false);
processor.setConfigurationProperty(FeatureKeys.XML_PARSER_FEATURE + encode(FEATURE_SECURE_PROCESSING), true); // NOSONAR
processor.setConfigurationProperty(FeatureKeys.XML_PARSER_FEATURE + encode(DISSALLOW_DOCTYPE_DECL_FEATURE), true);// NOSONAR
processor.setConfigurationProperty(FeatureKeys.XML_PARSER_FEATURE + encode(LOAD_EXTERNAL_DTD_FEATURE), false);// NOSONAR
processor.setConfigurationProperty(FeatureKeys.XML_PARSER_FEATURE + encode(XMLConstants.ACCESS_EXTERNAL_DTD), false);// NOSONAR
return processor;
}

34
src/test/java/de/kosit/validationtool/daemon/CheckHandlerIT.java
View file

@ -1,17 +1,20 @@
package de.kosit.validationtool.daemon;
import static io.restassured.RestAssured.given;
import static org.apache.http.HttpStatus.SC_OK;
import java.io.IOException;
import java.io.InputStream;
import org.apache.commons.io.IOUtils;
import org.junit.Ignore;
import org.apache.http.HttpStatus;
import org.junit.Test;
import de.kosit.validationtool.impl.Helper.Simple;
import io.restassured.builder.MultiPartSpecBuilder;
import io.restassured.http.ContentType;
import io.restassured.specification.MultiPartSpecification;
/**
* Testet the Daemon-Mode input , Methoden , Output Content-Type and the success case
@ -24,22 +27,21 @@ public class CheckHandlerIT extends BaseIT {
private static final String APPLICATION_XML = "application/xml";
@Test
public void makeSureThatSuccessTest() throws IOException {
public void simpleTest() throws IOException {
try ( final InputStream io = Simple.SIMPLE_VALID.toURL().openStream() ) {
given().contentType(ContentType.XML).body(toContent(io)).when().post("/").then().statusCode(200);
given().contentType(ContentType.XML).body(toContent(io)).when().post("/").then().statusCode(SC_OK);
}
}
@Test
public void NoInputTest() {
given().body("").contentType(APPLICATION_XML).when().post("/").then().statusCode(400);
public void noInputTest() {
given().body("").contentType(APPLICATION_XML).when().post("/").then().statusCode(HttpStatus.SC_BAD_REQUEST);
}
@Test
@Ignore // no default error report yet
public void internalServerErrorTest() throws IOException {
try ( final InputStream io = Simple.SCHEMA_INVALID.toURL().openStream() ) {
given().contentType(APPLICATION_XML).body(toContent(io)).when().post("/").then().statusCode(200);
public void testUnknown() throws IOException {
try ( final InputStream io = Simple.UNKNOWN.toURL().openStream() ) {
given().contentType(APPLICATION_XML).body(toContent(io)).when().post("/").then().statusCode(SC_OK);
}
}
@ -47,13 +49,19 @@ public class CheckHandlerIT extends BaseIT {
return IOUtils.toByteArray(io);
}
@Test
public void xmlResultTest() throws IOException {
try ( final InputStream io = Simple.SIMPLE_VALID.toURL().openStream() ) {
given().body(toContent(io)).when().post("/").then().contentType(APPLICATION_XML).and().statusCode(200);
given().body(toContent(io)).when().post("/").then().contentType(APPLICATION_XML).and().statusCode(SC_OK);
}
}
@Test
public void testMultipart() throws IOException {
try ( final InputStream io = Simple.SIMPLE_VALID.toURL().openStream() ) {
final MultiPartSpecification spec = new MultiPartSpecBuilder(io).fileName("file").controlName("file").build();
given().multiPart(spec).when().post("/").then().statusCode(HttpStatus.SC_BAD_REQUEST);
}
}
}

9
src/test/java/de/kosit/validationtool/impl/DefaultCheckTest.java
View file

@ -29,7 +29,6 @@ import static de.kosit.validationtool.impl.Helper.Simple.SIMPLE_VALID;
import static de.kosit.validationtool.impl.Helper.Simple.UNKNOWN;
import static org.assertj.core.api.Assertions.assertThat;
import java.io.File;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.IntStream;
@ -39,7 +38,7 @@ import org.junit.Test;
import org.w3c.dom.Document;
import de.kosit.validationtool.api.AcceptRecommendation;
import de.kosit.validationtool.api.CheckConfiguration;
import de.kosit.validationtool.api.Configuration;
import de.kosit.validationtool.api.Input;
import de.kosit.validationtool.api.Result;
import de.kosit.validationtool.impl.Helper.Simple;
@ -60,12 +59,10 @@ public class DefaultCheckTest {
@Before
public void setup() {
final CheckConfiguration validConfig = new CheckConfiguration(Simple.SCENARIOS);
validConfig.setScenarioRepository(new File(Simple.REPOSITORY_URI).toURI());
final Configuration validConfig = Configuration.load(Simple.SCENARIOS, Simple.REPOSITORY_URI).build();
this.validCheck = new DefaultCheck(validConfig);
final CheckConfiguration errorConfig = new CheckConfiguration(Simple.ERROR_SCENARIOS);
errorConfig.setScenarioRepository(new File(Simple.REPOSITORY_URI).toURI());
final Configuration errorConfig = Configuration.load(Simple.ERROR_SCENARIOS, Simple.REPOSITORY_URI).build();
this.errorCheck = new DefaultCheck(errorConfig);
}

5
src/test/java/de/kosit/validationtool/impl/SimpleScenarioCheckTest.java
View file

@ -8,7 +8,7 @@ import org.junit.Before;
import org.junit.Test;
import de.kosit.validationtool.api.AcceptRecommendation;
import de.kosit.validationtool.api.CheckConfiguration;
import de.kosit.validationtool.api.Configuration;
import de.kosit.validationtool.api.InputFactory;
import de.kosit.validationtool.api.Result;
import de.kosit.validationtool.impl.Helper.Simple;
@ -24,8 +24,7 @@ public class SimpleScenarioCheckTest {
@Before
public void setup() {
final CheckConfiguration d = new CheckConfiguration(Simple.SCENARIOS);
d.setScenarioRepository(Simple.REPOSITORY_URI);
final Configuration d = Configuration.load(Simple.SCENARIOS, Simple.REPOSITORY_URI).build();
this.implementation = new DefaultCheck(d);
}