Add changelog and readme entry. Remove old runner from github actions

Author: mielvds

.github/workflows/main.yaml

@@ -64,10 +64,6 @@ jobs:
       run: |
         pip install -r requirements-test.txt
     - name: Test with Python=${{ matrix.python-version }} Loader=${{ matrix.loader }}
-      # run: |
-      #   python tests/runtests.py ./_json-ld-api/tests -l ${{ matrix.loader }}
-      #   python tests/runtests.py ./_json-ld-framing/tests -l ${{ matrix.loader }}
-      #   python tests/runtests.py ./_normalization/tests -l ${{ matrix.loader }}
       run: |
         pytest --tests=./specifications/json-ld-api/tests --loader=${{ matrix.loader }}
         pytest --tests=./specifications/json-ld-framing/tests --loader=${{ matrix.loader }}

CHANGELOG.md

@@ -8,6 +8,7 @@
   - Minimize async related changes to library code in this release.
   - In sync environment use `asyncio.run`.
   - In async environment use background thread.
+- Add ability to run test suites using pytest and make pytest the default way for running (unit)tests.
 
 ## 2.0.4 - 2024-02-16
 

README.rst

@@ -220,10 +220,41 @@ Note that you can clone these repositories into any location you wish; however,
 if you do not clone them into the default ``specifications/`` folder, you will
 need to provide the paths to the test runner as arguments when running the tests, as explained below
 
-## Running the tests
+## Running the sample test suites and unittests using pytest
 
 If the suites repositories are available in the `specifications/` folder of the PyLD
-source directory, then all the tests can be run with the following:
+source directory, then all unittests, including the sample test suites, can be run with pytest_:
+
+.. code-block:: bash
+
+    pytest 
+
+If you wish to store the test suites in a different location than the default
+``specifications/`` folder, or you want to test individual manifest ``.jsonld`` files or directories
+containing a ``manifest.jsonld``, then you can supply these files or
+directories as arguments:
+
+.. code-block:: bash
+
+    # use: pytest --tests=TEST_PATH [--tests=TEST_PATH...]
+    pytest --tests=./specifications/json-ld-api/tests
+
+The test runner supports different document loaders by setting ``--loader requests``
+or ``--loader aiohttp``. The default document loader is set to Requests_.
+
+.. code-block:: bash
+    
+    pytest --loader=requests --tests=./specifications/json-ld-api/tests
+
+An EARL report can be generated using the ``--earl`` option.
+
+.. code-block:: bash
+
+    pytest --earl=./earl-report.json
+
+## Running the sample test suites using the original test runner
+
+You can also run the JSON-LD test suites using the original test runner script provided:
 
 .. code-block:: bash
 
@@ -241,8 +272,16 @@ directories as arguments:
 The test runner supports different document loaders by setting ``-l requests``
 or ``-l aiohttp``. The default document loader is set to Requests_.
 
+.. code-block:: bash
+
+    python tests/runtests.py -l requests ./specifications/json-ld-api/tests
+
 An EARL report can be generated using the ``-e`` or ``--earl`` option.
 
+.. code-block:: bash
+
+    python tests/runtests.py -e ./earl-report.json
+
 
 .. _Digital Bazaar: https://digitalbazaar.com/