feat: implement AxeResult.ToString based on JsonConvert #75
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Details
This PR adds in a basic ToString implementation for
AxeResultandAxeResultItemthat just usesJsonConvert.SerializeObject.The motivation for this is that these types are likely to be used in users' test assertions; when an assertion related to them fails, we want the test output to be actionable.
I wanted to reuse the same
JsonSerializerSettingsas everywhere else in the Selenium package, so I extracted it out ofAxeBuilder(and several tests that repeated bits of it) into aAxeJsonSerializerSettingsstatic class in the commons package. I think this is a better home for the serializer settings anyway, since they're tightly coupled to the implementation of the types.The test addition will have a merge conflict to resolve with #74, which adds overlapping unit tests that share the same sample input JSON.
Example output of
AxeResult.ToString()using the pinned sample input from the new unit test:{ "violations": [ { "id": "document-title", "description": "Ensures each HTML document contains a non-empty <title> element", "help": "Documents must have <title> element to aid in navigation", "helpUrl": "https://dequeuniversity.com/rules/axe/4.4/document-title?application=axe-puppeteer", "impact": "serious", "tags": [ "cat.text-alternatives", "wcag2a", "wcag242", "ACT" ], "nodes": [ { "target": "html", "xPath": "/html", "ancestry": null, "html": "<html><head></head><body>\n</body></html>", "impact": "serious", "any": [ { "data": null, "id": "doc-has-title", "impact": "serious", "message": "Document does not have a non-empty <title> element", "relatedNodes": [] } ], "all": [], "none": [] } ] } ], "passes": [], "inapplicable": [], "incomplete": [], "timestamp": "2000-01-02T03:04:05.006+00:00", "testEnvironment": { "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/100.0.4889.0 Safari/537.36", "windowWidth": 800, "windowHeight": 600, "orientationType": "portrait-primary", "orientationAngle": 0.0 }, "testRunner": { "name": "axe" }, "url": "http://localhost/", "error": null, "testEngineName": "axe-core", "testEngineVersion": "4.4.1", "toolOptions": { "xpath": true, "runOnly": { "type": "rule", "values": [ "document-title" ] }, "reporter": "v1" } }