Added testing (#11)

Author: themarpe

.github/workflows/ci.yml

@@ -33,11 +33,14 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
 
+    - name: Install dependencies
+      run: python -m pip install pytest-xdist
+
     - name: Install package
       run: python -m pip install .[test]
 
     - name: Test package
-      run: python -m pytest
+      run: python -m pytest --forked
 
 
 

README.md

@@ -78,3 +78,21 @@ py::class_<MyClass>(m, "MyClass", DOC(MyClass))
 
 This tool supports Linux and macOS and requires Clang/LLVM to be installed. It
 has never been used on Windows and will likely require adaptations.
+
+
+## Testing
+
+Install package `pytest-xdist`:
+```
+python3 -m pip install pytest-xdist
+```
+
+Install the library:
+```
+python3 -m pip install .
+```
+
+And execute the tests (forked)
+```
+python3 -m pip pytest --forked
+```

tests/long_parameter_docs/long_parameter.h

@@ -0,0 +1,5 @@
+/**
+ * Senectus et netus et malesuada fames ac. Tincidunt lobortis feugiat vivamus at augue eget arcu dictum varius.
+ * @param x - Begin first parameter description. Senectus et netus et malesuada fames ac. End first parameter description.
+ */
+void longParameterDescription(int x);

tests/long_parameter_test.py

@@ -0,0 +1,26 @@
+import collections
+import os
+import time
+import sysconfig
+import sys
+
+import pytest
+
+import pybind11_mkdoc
+
+DIR = os.path.abspath(os.path.dirname(__file__))
+
+def test_long_parameter(capsys):
+    comments = pybind11_mkdoc.mkdoc_lib.extract_all([os.path.join(DIR, "long_parameter_docs", "long_parameter.h")])
+    pybind11_mkdoc.mkdoc_lib.write_header(comments, sys.stdout)
+
+    res = capsys.readouterr()
+    expected = """\
+Parameter ``x``:
+    - Begin first parameter description. Senectus et netus et
+    malesuada fames ac. End first parameter description.)doc";
+"""
+
+    print(res.out)
+    assert expected in res.out
+

tests/sample_header_test.py

@@ -66,4 +66,4 @@ def test_generate_headers(capsys):
 #endif
 
 """
-    
+