8000 Add ReportQuery objects to Report by beckyjackson · Pull Request #879 · ontodev/robot · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add ReportQuery objects to Report #879

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

Jump to bottom
Merged
merged 9 commits into from
Jun 11, 2021
Merged

Add ReportQuery objects to Report #879

merged 9 commits into from
Jun 11, 2021

Conversation

beckyjackson
Copy link
Contributor
@beckyjackson beckyjackson commented Jun 3, 2021 •
edited
Loading

This is an alternative to #875 that allows us more flexibility in the future. Resolves #871.

  • docs/ have been added/updated
  • tests have been added/updated
  • mvn verify says all tests pass
  • mvn site says all JavaDocs correct
  • CHANGELOG.md has been updated

This adds a new ReportQuery object that carries the details of the "rules" including rule name, query contents, violation level, a list of the found violations, and an optional URL for documentation. If you are generating an HTML report, the default report queries will have links to their documentation.

@beckyjackson
Copy link
Contributor Author

This fails with:

Integration test file '../docs/examples/results/report.tsv' is different from example file '../docs/examples/report.tsv'

... but it passes locally.

I'm wondering if there's some sort of ordering difference in each report query? I sorted the report queries by name, but maybe the actual violations within each report query are getting sorted different. Any ideas?

We could sort these, but the Violation objects are kind of complex and we couldn't sort until rendering, which might get messy...

@beckyjackson
Copy link
Contributor Author

Without using Collections.sort and a custom comparator to make sure the report ends up the same across systems, the tests kept failing. I tried using sets instead hoping that that would maintain order, but it still failed.

To resolve this, I changed the diffing of TSV files in CommandLineIT so that we compare the set of lines, in no particular order. I can't think of a case here where we always expect TSVs to be in the same order...

@beckyjackson beckyjackson mentioned this pull request Jun 3, 2021
Closed
5 tasks
@jamesaoverton
Copy link
Member

I think changing CommandLineIT is a good solution. I'll take one more look at the code tomorrow. Thanks!

jamesaoverton
jamesaoverton approved these changes Jun 11, 2021
View reviewed changes
Copy link
Member
@jamesaoverton jamesaoverton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All right, let's just do this.

@beckyjackson beckyjackson merged commit b4e5214 into master Jun 11, 2021
@beckyjackson beckyjackson deleted the report-update branch June 11, 2021 15:02
This was referenced Dec 14, 2021
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jamesaoverton jamesaoverton jamesaoverton approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

HTML report should render link to implemented check
2 participants
@beckyjackson @jamesaoverton
0