Skip to content

Enhance recog verify to report an untested parameter as a failure #19

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

Merged
mkienow-r7 merged 2 commits into from
Feb 16, 2022
Merged

Enhance recog verify to report an untested parameter as a failure #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a0dbc6
Report untested parameter as a failure
mkienow-r7 Jan 31, 2022
412adc4
Modify test for example with an untested parameter
mkienow-r7 Jan 31, 2022
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
18 changes: 9 additions & 9 deletions recog-verify/src/test/java/com/rapid7/recog/verify/RecogVerifierTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,13 @@ public void verifyNoExampleNonZeroPositionParamsWarnCount() throws ParseExceptio
}

@Test
public void verifySuccessfulExampleNonZeroPositionParamsWarnCount() throws ParseException {
public void verifySuccessfulExample() throws ParseException {
// given
String xml = "<?xml version=\"1.0\"?>\n"
+ "<fingerprints matches=\"recog-verifier-test\">\n"
+ " <fingerprint pattern=\"^(\\w+) Server ([0-9.]+) - ([0-9]+)$\">\n"
+ " <description>Service Server - no examples or params</description>\n"
+ " <example>Media Server 7.9.3 - 1631723269</example>\n"
+ " <example service.name=\"Media\" service.version=\"7.9.3\" service.version-date=\"1631723269\">Media Server 7.9.3 - 1631723269</example>\n"
+ " <param pos=\"0\" name=\"service.vendor\" value=\"VendorName\"/>\n"
+ " <param pos=\"0\" name=\"service.product\" value=\"ProductName\"/>\n"
+ " <param pos=\"1\" name=\"service.name\"/>\n"
Expand All @@ -112,16 +112,17 @@ public void verifySuccessfulExampleNonZeroPositionParamsWarnCount() throws Parse
// then
assertEquals(1, verifier.getReporter().getSuccessCount());
assertEquals(0, verifier.getReporter().getFailureCount());
assertEquals(3, verifier.getReporter().getWarningCount());
assertEquals(0, verifier.getReporter().getWarningCount());
}

@Test
public void verifySuccessfulExample() throws ParseException {
public void verify1FailureAnd1SuccessfulExamples() throws ParseException {
// given
String xml = "<?xml version=\"1.0\"?>\n"
+ "<fingerprints matches=\"recog-verifier-test\">\n"
+ " <fingerprint pattern=\"^(\\w+) Server ([0-9.]+) - ([0-9]+)$\">\n"
+ " <description>Service Server - no examples or params</description>\n"
+ " <example>Media Server 1.2.3.4</example>\n"
+ " <example service.name=\"Media\" service.version=\"7.9.3\" service.version-date=\"1631723269\">Media Server 7.9.3 - 1631723269</example>\n"
+ " <param pos=\"0\" name=\"service.vendor\" value=\"VendorName\"/>\n"
+ " <param pos=\"0\" name=\"service.product\" value=\"ProductName\"/>\n"
Expand All @@ -140,19 +141,18 @@ public void verifySuccessfulExample() throws ParseException {

// then
assertEquals(1, verifier.getReporter().getSuccessCount());
assertEquals(0, verifier.getReporter().getFailureCount());
assertEquals(1, verifier.getReporter().getFailureCount());
assertEquals(0, verifier.getReporter().getWarningCount());
}

@Test
public void verify1FailureAnd1SuccessfulExamples() throws ParseException {
public void verifySuccessfulExampleUntestedParamsFailCount() throws ParseException {
// given
String xml = "<?xml version=\"1.0\"?>\n"
+ "<fingerprints matches=\"recog-verifier-test\">\n"
+ " <fingerprint pattern=\"^(\\w+) Server ([0-9.]+) - ([0-9]+)$\">\n"
+ " <description>Service Server - no examples or params</description>\n"
+ " <example>Media Server 1.2.3.4</example>\n"
+ " <example service.name=\"Media\" service.version=\"7.9.3\" service.version-date=\"1631723269\">Media Server 7.9.3 - 1631723269</example>\n"
+ " <example>Media Server 7.9.3 - 1631723269</example>\n"
+ " <param pos=\"0\" name=\"service.vendor\" value=\"VendorName\"/>\n"
+ " <param pos=\"0\" name=\"service.product\" value=\"ProductName\"/>\n"
+ " <param pos=\"1\" name=\"service.name\"/>\n"
Expand All @@ -170,7 +170,7 @@ public void verify1FailureAnd1SuccessfulExamples() throws ParseException {

// then
assertEquals(1, verifier.getReporter().getSuccessCount());
assertEquals(1, verifier.getReporter().getFailureCount());
assertEquals(3, verifier.getReporter().getFailureCount());
assertEquals(0, verifier.getReporter().getWarningCount());
}

Expand Down
2 changes: 1 addition & 1 deletion recog/src/main/java/com/rapid7/recog/RecogMatcher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ private void verifyExamplesHaveCaptureGroups(BiConsumer<VerifyStatus, String> co
Boolean paramUsed = entry.getValue();
if (!paramUsed) {
String message = String.format("'%s' is missing an example that checks for parameter '%s' which is derived from a capture group", description, paramName);
consumer.accept(VerifyStatus.Warn, message);
consumer.accept(VerifyStatus.Fail, message);
}
}
}
Expand Down