Add documentation on automated testing for extensions#480
Conversation
✅ Deploy Preview for openrefine-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
tfmorris
left a comment
tfmorris
left a comment
There was a problem hiding this comment.
A couple of small suggestions, but approved with those made.
The improved docs are great, but I suspect we probably also need to add more scaffolding for testing to the sample extension to really nudge developers in the right direction.
|
|
||
| Cypress can also be run in headless mode, enabling end-to-end tests in CI/CD pipelines. The documentation for this feature can be found [on the Cypress website](https://docs.cypress.io/app/continuous-integration/overview) and an example script for running end-to-end tests can be found in [the `refine` shell script](https://github.com/OpenRefine/OpenRefine/blob/master/refine#L364-L443). | ||
|
|
||
| #### Testing OpenRefine with your extension installed |
There was a problem hiding this comment.
@SoryRawyer do you want to add here more details following your recent work?
There was a problem hiding this comment.
I think it would make more sense to update the sample extension directly. I'll open a few issues on that repo to add more detail for testing.
|
Everything looks good to me at a high level. I added a suggestion that can be addressed separately. I believe it is more beneficial to publish the documentation sooner and then refine it based on feedback from extension developers, rather than keeping it hidden in a pull request. |
Co-authored-by: Tom Morris <tfmorris@gmail.com>
Co-authored-by: Tom Morris <tfmorris@gmail.com>
3 participants
This pull request adds a section at the end of "writing extensions" to add some references to unit and integration tests. It's a small section of notes I kept while exploring this part of the codebase.