Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update policy generator #82

Merged
merged 1 commit into from
Aug 1, 2024
Merged

Update policy generator #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 52 additions & 27 deletions policy-generator/src/main/java/org/verapdf/tools/policy/generator/PolicyGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,26 +91,34 @@ public static void main(String[] args) {
}
generator.validate();
}
generator.generate();
generator.generate(options.hasOption("t"));
} catch (IOException e) {
e.printStackTrace();
}
}

private static Options defineOptions() {
Options options = new Options();

Option isLogsChecked = new Option("n", "nologs", false, "Disables logs check");
isLogsChecked.setRequired(false);
options.addOption(isLogsChecked);

Option profile = new Option("p", "profile", true, "Specifies path to custom profile");
profile.setRequired(false);
options.addOption(profile);

Option verapdfPath = new Option("v", "verapdf_path", true, "path to verapdf");
verapdfPath.setRequired(false);
options.addOption(verapdfPath);

Option issueNumber = new Option("num", "issue_number", true, "number of issue");
issueNumber.setRequired(false);
options.addOption(issueNumber);

Option tagged = new Option("t", "tagged", false, "Policy for tagged profile");
tagged.setRequired(false);
options.addOption(tagged);
return options;
}

Expand Down Expand Up @@ -180,7 +188,7 @@ private void validate() throws IOException {
}
}

public void generate() {
public void generate(boolean isTagged) {
try {
document = (DocumentBuilderFactory.newInstance().newDocumentBuilder()).parse(report);

Expand All @@ -195,7 +203,7 @@ public void generate() {
if ("true".equals(isCompliant)) {
generatePassPolicy();
} else {
generateFailPolicy();
generateFailPolicy(isTagged);
}
}

Expand All @@ -210,51 +218,68 @@ public void generate() {
}
}

private void generateFailPolicy() {
private void generateFailPolicy(boolean isTagged) {
NodeList nodeList = document.getElementsByTagName("details");
String failedRulesToBeReplaced = nodeList.item(0).getAttributes().getNamedItem("failedRules").getNodeValue();

content = new StringBuilder(PolicyHelper.FAIL
.replace("{fileNameToBeReplaced}", shortFileName)
.replace("ISSUE_NUMBER_PART", getIssueNumberPart())
.replace("{failedRulesToBeReplaced}", failedRulesToBeReplaced));

nodeList = document.getElementsByTagName("rule");
int size = nodeList.getLength();
StringBuilder messageToBeReplaced = new StringBuilder();
SortedSet<RuleInfo> ruleInfoSet = new TreeSet<>();
Map<String, SortedSet<RuleInfo>> ruleInfoMap = new TreeMap<>();
for (int i = 0; i < size; ++i) {
NamedNodeMap node = nodeList.item(i).getAttributes();
ruleInfoSet.add(new RuleInfo(node.getNamedItem("clause").getNodeValue(),
ruleInfoMap.computeIfAbsent(isTagged ? getObjectName(nodeList.item(i)) : null, r -> new TreeSet<>()).add(
new RuleInfo(node.getNamedItem("clause").getNodeValue(),
Integer.parseInt(node.getNamedItem("testNumber").getNodeValue()),
Integer.parseInt(node.getNamedItem("failedChecks").getNodeValue())));
}
Iterator<RuleInfo> iterator = ruleInfoSet.iterator();
while (iterator.hasNext()) {
RuleInfo ruleInfo = iterator.next();
content.append(PolicyHelper.RULE
.replace("{ruleToBeReplaced}", ruleInfo.getRuleId().getClause())
.replace("{testNumToBeReplaced}", String.valueOf(ruleInfo.getRuleId().getTestNumber()))
.replace("{failedChecksCountToBeReplaced}", String.valueOf(ruleInfo.getFailedChecks())));

messageToBeReplaced.append(PolicyHelper.RULE_MESSAGE
.replace("{ruleToBeReplaced}", ruleInfo.getRuleId().getClause())
.replace("{testNumToBeReplaced}", String.valueOf(ruleInfo.getRuleId().getTestNumber()))
.replace("{failedChecksCountToBeReplaced}", String.valueOf(ruleInfo.getFailedChecks())));
if (ruleInfo.getFailedChecks() > 1) {
messageToBeReplaced.append("s");
for (Map.Entry<String, SortedSet<RuleInfo>> map : ruleInfoMap.entrySet()) {
Iterator<RuleInfo> iterator = map.getValue().iterator();
content.append(PolicyHelper.FAIL_RULE);
if (isTagged) {
content.append("object != '").append(map.getKey()).append("' or\n ");
}
if (iterator.hasNext()) {
content.append(PolicyHelper.OR);
messageToBeReplaced.append(",").append(PolicyHelper.OR);
while (iterator.hasNext()) {
RuleInfo ruleInfo = iterator.next();
content.append(PolicyHelper.RULE
.replace("{ruleToBeReplaced}", ruleInfo.getRuleId().getClause())
.replace("{testNumToBeReplaced}", String.valueOf(ruleInfo.getRuleId().getTestNumber()))
.replace("{failedChecksCountToBeReplaced}", String.valueOf(ruleInfo.getFailedChecks())));

messageToBeReplaced.append(PolicyHelper.RULE_MESSAGE
.replace("{ruleToBeReplaced}", ruleInfo.getRuleId().getClause())
.replace("{testNumToBeReplaced}", String.valueOf(ruleInfo.getRuleId().getTestNumber()))
.replace("{failedChecksCountToBeReplaced}", String.valueOf(ruleInfo.getFailedChecks())));
if (ruleInfo.getFailedChecks() > 1) {
messageToBeReplaced.append("s");
}
if (iterator.hasNext()) {
content.append(PolicyHelper.OR);
messageToBeReplaced.append(",").append(PolicyHelper.OR);
}
}

content.append(PolicyHelper.RULE_END
.replace("{messageToBeReplaced}", messageToBeReplaced));
messageToBeReplaced = new StringBuilder();
}
content.append(PolicyHelper.RULE_END
.replace("{messageToBeReplaced}", messageToBeReplaced));
content.append(PolicyHelper.PATTERN_END);

System.out.println("Policy was created. PDF file is not compliant with Validation Profile requirements");
}

public String getObjectName(Node node) {
NodeList children = node.getChildNodes();
for (int i = 0; i < children.getLength(); i++) {
if ("object".equals(children.item(i).getNodeName())) {
return children.item(i).getFirstChild().getNodeValue();
}
}
return null;
}

private void generatePassPolicy() {
content = new StringBuilder(PolicyHelper.PASS
Expand Down
8 changes: 5 additions & 3 deletions policy-generator/src/main/java/org/verapdf/tools/policy/generator/PolicyHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ public class PolicyHelper {
" <sch:rule context=\"/report/jobs/job/validationReport/details\">\n" +
" <sch:assert test=\"(@failedRules = '{failedRulesToBeReplaced}')\">Failed check, Expected: {failedRulesToBeReplaced}</sch:assert>\t\n" +
" </sch:rule>\n" +
"\n" +
"\n";

public static final String FAIL_RULE =
" <sch:rule context=\"/report/jobs/job/validationReport/details/rule\">\n" +
" <sch:assert test=\"";
public static final String RULE = "(@clause = '{ruleToBeReplaced}' and @testNumber = '{testNumToBeReplaced}' and @failedChecks = '{failedChecksCountToBeReplaced}')";
Expand All @@ -38,8 +40,8 @@ public class PolicyHelper {
public static final String RULE_END = "\">Failed rules, Expected: \n" +
" {messageToBeReplaced}</sch:assert>\n" +
" </sch:rule>\n" +
"\n" +
" </sch:pattern>\n";
"\n";
public static final String PATTERN_END = " </sch:pattern>\n";
public static final String LOGS_REPORT = "\n" +
" <sch:pattern name = \"Checking the logs\">\n" +
" <sch:rule context=\"/report/jobs/job\">\n" +
Expand Down