Merge pull request #59 from mvorisek/unit_testing

Add Unit Testing

Author: markstory

.github/workflows/ci.yml

@@ -1,46 +1,78 @@
 name: CI
 
 on:
-  push:
-    branches:
-      - master
   pull_request:
-    branches:
-      - '*'
+  push:
+  schedule:
+    - cron: '0 0/2 * * *'
 
 jobs:
   build:
+    if: endsWith(github.head_ref || github.ref_name, '.changes') == false
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: ['3.7', '3.8', '3.9']
+        python: ['3.7', '3.8', '3.9', '3.10', '3.11']
       fail-fast: false
 
+    permissions:
+      contents: write
+
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
-    - uses: actions/setup-python@v2
+    - uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python }}
 
+    - name: Install tools
+      run: |
+        sudo apt -y install libxml2-utils
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install -r requirements.txt
+        pip install -r test/unit/requirements.txt
         pip install .
 
-    - name: Build test/
+    - name: Build Test
       run: |
-        cd test && make html SPHINXOPTS='-W'
+        cd test/must-build && make html SPHINXOPTS='-W'
 
     - name: Build Test with toc show_parents=hide
       run: |
-        cd test && make html SPHINXOPTS='-W -D toc_object_entries_show_parents=hide'
+        cd test/must-build && make html SPHINXOPTS='-W -D toc_object_entries_show_parents=hide'
 
     - name: Build Test with toc show_parents=domain
       run: |
-        cd test && make html SPHINXOPTS='-W -D toc_object_entries_show_parents=domain'
+        cd test/must-build && make html SPHINXOPTS='-W -D toc_object_entries_show_parents=domain'
 
     - name: Build Test with toc show_parents=all
       run: |
-        cd test && make html SPHINXOPTS='-W -D toc_object_entries_show_parents=all'
+        cd test/must-build && make html SPHINXOPTS='-W -D toc_object_entries_show_parents=all'
+
+    - name: Run Unit Testing
+      run: |
+        cd test/unit
+        find . -name '*.html' -exec rm {} \;
+        make html SPHINXOPTS='-W'
+        (cd _build/html && find . -name '*.html' -exec sh -c 'xmllint {} --xpath '"'"'//div[@role="main"]'"'"' | xmllint --format - > ../../{}' \;)
+        rm genindex.html index.html search.html php-modindex.html
+
+    - name: Diff Unit Outputs
+      run: |
+        cd test/unit
+        rm -r _build
+        git add . -N && git diff --exit-code
+
+    - name: Push Unit Changes
+      if: failure()
+      uses: stefanzweifel/git-auto-commit-action@v4
+      with:
+        branch: ${{ github.head_ref || github.ref_name }}.changes
+        push_options: '--force'
+        commit_message: Unit Changes
+        commit_user_name: Bot
+        commit_user_email: bot@example.com
+        commit_author: Bot <bot@example.com>

.github/workflows/doc.yml

@@ -21,8 +21,8 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
-  # Build job
   build:
+    if: github.repository_owner == 'markstory'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -35,15 +35,14 @@ jobs:
         id: pages
         uses: actions/configure-pages@v3
 
-      - name: Build doct
+      - name: Build doc
         run: make -C doc html
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v1
         with:
           path: doc/_build/html
 
-  # Deployment job
   deploy:
     environment:
       name: github-pages

.gitignore

@@ -1,7 +1,8 @@
 dist/
 build/
 doc/_build
-test/_build
+test/must-build/_build
+test/unit/_build
 *.pyc
 *.egg-info
 .DS_Store

doc/conf.py

@@ -120,7 +120,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+#html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

test/_static/.gitignore

@@ -120,7 +120,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+#html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.