Skip to content

Commit 9943caf

Browse files
authored
Merge pull request #143 from pyscript/add-test-details
Add test related details.
2 parents 5c53242 + 5ca780f commit 9943caf

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/developers.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,28 @@ is through this environment that you contribute to PyScript.
230230
```sh
231231
make test
232232
```
233+
234+
(This essentially runs the `npm run test:integration` command in the right
235+
place. This is defined in PyScript's `package.json` file.)
236+
237+
Tests are found in the `core/tests` directory. These are organised into
238+
three locations:
239+
240+
1. `python` - the Python based test suite to exercise Python code
241+
**within** PyScript.
242+
2. `javascript` - JavaScript tests to exercise PyScript itself, in the
243+
browser.
244+
3. `manual` - containing tests to run manually in a browser, due to the
245+
complex nature of the tests.
246+
247+
We use [Playwright](https://playwright.dev/) to automate the running of the
248+
Python and JavaScript test suites. We use
249+
[uPyTest](https://github.com/ntoll/upytest) as a test framework for the
250+
Python test suite. uPyTest is a "PyTest inspired" framework for running
251+
tests in the browser on both MicroPython and Pyodide.
252+
253+
The automated (Playwright) tests are specified in the
254+
`tests/integration.spec.js` file.
233255

234256
## Documentation
235257

0 commit comments

Comments
 (0)