Skip to content

Clarify documentation on runing Earl reports #157

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

Closed
wants to merge 2 commits into from
Closed

Clarify documentation on runing Earl reports #157

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03f2893
Clarify documentation on runing Earl reports
hsolbrig May 26, 2021
08490e7
Update CONTRIBUTING.rst
hsolbrig May 26, 2021
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
13 changes: 11 additions & 2 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,23 @@ Implementation Report Process
As of early 2020, the process to generate an EARL report for the official
`JSON-LD Processor Conformance`_ page is:

* Check out a local copy of the test suites::
Copy link
Member

@davidlehn davidlehn May 26, 2021

Choose a reason for hiding this comment

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

I think it might be better to align with the main README test section for this: https://github.com/digitalbazaar/pyld#tests. The opinionated setup there and in runtests.py is to checkout the test dirs as siblings of pyld. runtests.py defaults to looking for those dirs so you don't have to list them on command line. In the case of EARL report generation, the test dirs are explicit to avoid also running the normalization tests. As is here you'd be instructed to check out dirs in different locations than when running regular tests. Thoughts?

Copy link
Member

@davidlehn davidlehn May 26, 2021

Choose a reason for hiding this comment

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

Maybe this could just refer to the readme test section for setup?


> mkdir ../w3c
> cd ../w3c
> git clone https://github.com/w3c/json-ld-api.git
> git clone https://github.com/w3c/json-ld-framing.git
> cd ../pyld


* Run the tests on the ``json-ld-api`` and ``json-ld-framing`` test repos to
generate a ``.jsonld`` test report:

* ``python tests/runtests.py ../json-ld-api/tests/ ../json-ld-framing/tests/ -e pyld-earl.jsonld``
> ``python tests/runtests.py ..w3c/json-ld-api/tests/ ../w3c/json-ld-framing/tests/ -e pyld-earl.jsonld``
Copy link
Member

@davidlehn davidlehn May 26, 2021

Choose a reason for hiding this comment

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

As stated above, I'm not sure this w3c subdir idea is the best approach. But if so, first path is missing a /.

Copy link
Author

@hsolbrig hsolbrig May 26, 2021

Choose a reason for hiding this comment

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

I'll leave it up to you how it should be resolved -- mostly it is just that I went directly to CONTRIBUTING and there wasn't anything that prevented me from interpreting it as asking for the tests to be run against the digitalbazaar tests instead of the W3C.


* Use the rdf_ tool to generate a ``.ttl``:

* ``rdf serialize pyld-earl.jsonld --output-format turtle -o pyld-earl.ttl``
> ``rdf serialize pyld-earl.jsonld --output-format turtle -o pyld-earl.ttl``

* Optionally follow the `report instructions`_ to generate the HTML report for
inspection.
Expand Down