Porting example for the documentation

.github/workflows/ci.yml

@@ -143,6 +143,46 @@ jobs:
  shell: bash
 
 
+ porting_example_tests:
+ name: Porting example tests
+ runs-on: ${{ matrix.os }}
+ continue-on-error: true
+ strategy:
+ matrix:
+ os: [ubuntu-latest, macos-latest, windows-latest]
+ python-version: ['3.9']
+
+ steps:
+ - uses: actions/checkout@v2
+
+ - name: Set up Python
+ uses: actions/setup-python@v2
+ with:
+ python-version: ${{ matrix.python-version }}
+
+ - name: Install/Upgrade Python dependencies
+ run: python -m pip install --upgrade pip wheel
+ shell: bash
+
+ - name: Install HPy
+ run: python -m pip install .
+
+ - name: Install pytest
+ run: |
+ python -m pip install pytest
+
+ - name: Run tests
+ run: make porting-example-tests
+ shell: bash
+
+ - name: Run tests of completed port in debug mode
+ env:
+ HPY_DEBUG: "1"
+ TEST_ARGS: "-s -k hpy_final"
+ run: make porting-example-tests
+ shell: bash
+
+
  valgrind_tests:
  name: Valgrind tests
  runs-on: 'ubuntu-latest'
@@ -205,7 +245,7 @@ jobs:
  # - template: azure-templates/python.yml
 
  - name: Install / Upgrade system requirements
- run: sudo apt update && sudo apt install -y libclang-10-dev
+ run: sudo apt update && sudo apt install -y libclang-11-dev
 
  - name: Install / Upgrade Python requirements
  run: |

Makefile

@@ -50,10 +50,17 @@ infer:
  @infer --fail-on-issue --compilation-database compile_commands.json --report-blacklist-path-regex "hpy/debug/src/debug_ctx.c"
 
 valgrind:
- PYTHONMALLOC=malloc valgrind --suppressions=hpy/tools/valgrind/python.supp --suppressions=hpy/tools/valgrind/hpy.supp --leak-check=full --show-leak-kinds=definite,indirect --log-file=/tmp/valgrind-output python -m pytest --valgrind --valgrind-log=/tmp/valgrind-output test/
+ PYTHONMALLOC=malloc valgrind --suppressions=hpy/tools/valgrind/python.supp --suppressions=hpy/tools/valgrind/hpy.supp --leak-check=full --show-leak-kinds=definite,indirect --log-file=/tmp/valgrind-output python3 -m pytest --valgrind --valgrind-log=/tmp/valgrind-output test/
+
+porting-example-tests:
+ cd docs/porting-example/steps && python3 setup00.py build_ext -i
+ cd docs/porting-example/steps && python3 setup01.py build_ext -i
+ cd docs/porting-example/steps && python3 setup02.py build_ext -i
+ cd docs/porting-example/steps && python3 setup03.py --hpy-abi=universal build_ext -i
+ python3 -m pytest docs/porting-example/steps/ ${TEST_ARGS}
 
 docs-examples-tests:
- cd docs/examples/simple-example && python setup.py --hpy-abi=universal install
- cd docs/examples/mixed-example && python setup.py install
- cd docs/examples/snippets && python setup.py --hpy-abi=universal install
- python -m pytest docs/examples/tests.py
+ cd docs/examples/simple-example && python3 setup.py --hpy-abi=universal install
+ cd docs/examples/mixed-example && python3 setup.py install
+ cd docs/examples/snippets && python3 setup.py --hpy-abi=universal install
+ python3 -m pytest docs/examples/tests.py ${TEST_ARGS}

docs/index.rst

@@ -40,6 +40,7 @@ There are several advantages to write your C extension in HPy:
  overview
  api
  porting-guide
+ porting-example/index
  debug-mode
  api-reference/index
  misc/index