🧪 TESTS: Improve benchmark testing (#33)

Also added tox testing configuration

Author: chrisjsewell

.github/workflows/benchmark.yml

@@ -0,0 +1,90 @@
+name: benchmark
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  benchmark-packages:
+
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+
+    - name: install pandoc
+      uses: r-lib/actions/setup-pandoc@v1
+      with:
+        pandoc-version: '2.6'
+
+    - name: Install tox
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox
+
+    - name: Run package benchmarks
+      run: tox -e py38-bench-packages -- --benchmark-min-rounds 20 --benchmark-json bench-packages.json
+
+    # - name: Upload package data
+    #   uses: actions/upload-artifact@v2
+    #   with:
+    #     name: bench-packages
+    #     path: bench-packages.json
+    #     if-no-files-found: error
+
+    - name: Store benchmark result
+      uses: chrisjsewell/github-action-benchmark@v2
+      with:
+        name: Parsing Benchmarks
+        output-file-path: bench-packages.json
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        auto-push: true
+        commit-msg-append: "[ci skip]"
+        one-chart-groups: packages,plugins
+        fail-on-alert: false
+
+  benchmark-plugins:
+
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+
+    - name: Install tox
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox
+
+    - name: Run plugin benchmarks
+      run: tox -e py38-bench-plugins -- --benchmark-min-rounds 20 --benchmark-json bench-plugins.json
+
+    # - name: Upload plugin data
+    #   uses: actions/upload-artifact@v2
+    #   with:
+    #     name: bench-plugins
+    #     path: bench-plugins.json
+    #     if-no-files-found: error
+
+    - name: Store benchmark result
+      uses: chrisjsewell/github-action-benchmark@v2
+      with:
+        name: Parsing Benchmarks
+        output-file-path: bench-plugins.json
+        # Use personal access token instead of GITHUB_TOKEN due to https://github.community/t5/GitHub-Actions/Github-action-not-triggering-gh-pages-upon-push/td-p/26869/highlight/false
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        auto-push: true
+        commit-msg-append: "[ci skip]"
+        one-chart-groups: packages,plugins
+        # Show alert with commit comment on detecting possible performance regression
+        alert-threshold: '200%'
+        comment-on-alert: true
+        fail-on-alert: false
+        alert-comment-cc-users: '@chrisjsewell'

.github/workflows/tests.yml

@@ -53,6 +53,32 @@ jobs:
         file: ./coverage.xml
         fail_ci_if_error: true
 
+  benchmark:
+
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+
+    - name: Install tox
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox
+
+    - name: Run benchmark
+      run: tox -e py38-bench-core -- --benchmark-json bench-core.json
+
+    - name: Upload data
+      uses: actions/upload-artifact@v2
+      with:
+        name: bench-core
+        path: bench-core.json
+        if-no-files-found: error
+
   publish:
 
     name: Publish to PyPi

.pre-commit-config.yaml

@@ -9,7 +9,7 @@ exclude: >
       test.*\.html|
       .*commonmark\.json|
       benchmark/.*\.md|
-      markdown\_it/cli/spec\.md
+      .*/spec\.md
     )$
 
 repos:

MANIFEST.in

@@ -1,2 +1 @@
 include LICENSE
-include markdown_it/cli/spec.md

README.md

@@ -101,6 +101,6 @@ Also [John MacFarlane](https://github.com/jgm) for his work on the CommonMark sp
 [CommonMark spec]: http://spec.commonmark.org/
 [markdown-it]: https://github.com/markdown-it/markdown-it
 [markdown-it-readme]: https://github.com/markdown-it/markdown-it/blob/master/README.md
-[md-security]: https://github.com/ExecutableBookProject/markdown-it-py/tree/master/docs/security.md
-[md-performance]: https://markdown-it-py.readthedocs.io/en/latest/security.html
+[md-security]: https://markdown-it-py.readthedocs.io/en/latest/other.html
+[md-performance]: https://markdown-it-py.readthedocs.io/en/latest/other.html
 [md-plugins]: https://markdown-it-py.readthedocs.io/en/latest/plugins.html