From 7c8980a7d1862f2dd0eec8b2f765f02d29bbdf06 Mon Sep 17 00:00:00 2001
From: Jakub Andrysek <jakub.andrysek03@gmail.com>
Date: Wed, 3 Apr 2024 01:19:59 +0200
Subject: [PATCH] Lint + update tests

---
 .github/workflows/mkdoxy-pytest-repo.yaml | 28 +++++++++++++++++++++++
 .github/workflows/mkdoxy-test-demos.yaml  |  2 +-
 .github/workflows/mkdoxy-test-repo.yaml   |  2 +-
 .idea/misc.xml                            |  2 +-
 .idea/workspace.xml                       | 17 ++++----------
 demo-projects/animal/Doxyfile             |  2 +-
 docs/usage/advanced.md                    |  2 +-
 mkdoxy/doxyrun.py                         |  4 +++-
 setup.py                                  |  3 ++-
 tests/data/Doxyfile                       |  2 +-
 tests/test_doxyrun.py                     |  5 +++-
 11 files changed, 47 insertions(+), 22 deletions(-)
 create mode 100644 .github/workflows/mkdoxy-pytest-repo.yaml

diff --git a/.github/workflows/mkdoxy-pytest-repo.yaml b/.github/workflows/mkdoxy-pytest-repo.yaml
new file mode 100644
index 00000000..9086fe82
--- /dev/null
+++ b/.github/workflows/mkdoxy-pytest-repo.yaml
@@ -0,0 +1,28 @@
+name: MkDoxy build all supported Python versions
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest] # windows-latest, macos-latest requires doxygen to be installed manually
+        python-version: ["3.9", "3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+          sudo apt-get install doxygen
+      - name: Run Pytest
+        run: |
+          pytest tests/
diff --git a/.github/workflows/mkdoxy-test-demos.yaml b/.github/workflows/mkdoxy-test-demos.yaml
index e7df08ad..8d09ba83 100644
--- a/.github/workflows/mkdoxy-test-demos.yaml
+++ b/.github/workflows/mkdoxy-test-demos.yaml
@@ -8,7 +8,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest] # windows-latest, macos-latest requires doxygen to be installed manually
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
       - uses: actions/checkout@v3
diff --git a/.github/workflows/mkdoxy-test-repo.yaml b/.github/workflows/mkdoxy-test-repo.yaml
index 81a93d27..c008dce6 100644
--- a/.github/workflows/mkdoxy-test-repo.yaml
+++ b/.github/workflows/mkdoxy-test-repo.yaml
@@ -8,7 +8,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest] # windows-latest, macos-latest requires doxygen to be installed manually
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
       - uses: actions/checkout@v3
diff --git a/.idea/misc.xml b/.idea/misc.xml
index a6218fed..a0641c7e 100644
--- a/.idea/misc.xml
+++ b/.idea/misc.xml
@@ -4,4 +4,4 @@
     <option name="sdkName" value="Python 3.11" />
   </component>
   <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.11" project-jdk-type="Python SDK" />
-</project>
\ No newline at end of file
+</project>
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index c759aebb..bd58b38f 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -5,16 +5,7 @@
   </component>
   <component name="ChangeListManager">
     <list default="true" id="5a348fe7-ee21-4e06-b8fc-ced5d548a610" name="Changes" comment="Upgrade version">
-      <change afterPath="$PROJECT_DIR$/demo-projects/animal/Doxyfile" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/tests/data/Doxyfile" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/tests/test_doxyrun.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/misc.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/misc.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/docs/usage/advanced.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/usage/advanced.md" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/mkdocs.yml" beforeDir="false" afterPath="$PROJECT_DIR$/mkdocs.yml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/mkdoxy/doxyrun.py" beforeDir="false" afterPath="$PROJECT_DIR$/mkdoxy/doxyrun.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/mkdoxy/generatorBase.py" beforeDir="false" afterPath="$PROJECT_DIR$/mkdoxy/generatorBase.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/mkdoxy/plugin.py" beforeDir="false" afterPath="$PROJECT_DIR$/mkdoxy/plugin.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/setup.py" beforeDir="false" afterPath="$PROJECT_DIR$/setup.py" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -69,7 +60,7 @@
     "RunOnceActivity.ShowReadmeOnStart": "true",
     "SHARE_PROJECT_CONFIGURATION_FILES": "true",
     "WebServerToolWindowFactoryState": "false",
-    "git-widget-placeholder": "main",
+    "git-widget-placeholder": "doxygen-config-file",
     "last_opened_file_path": "/Users/kuba/Documents/git/kuba/mkdoxy/mkdoxy-base/mkdoxy-main/tests/data",
     "node.js.detected.package.eslint": "true",
     "node.js.detected.package.tslint": "true",
@@ -324,7 +315,7 @@
       <workItem from="1689697868617" duration="13000" />
       <workItem from="1689777262215" duration="704000" />
       <workItem from="1689947020589" duration="1060000" />
-      <workItem from="1712098386110" duration="1058000" />
+      <workItem from="1712098386110" duration="1331000" />
     </task>
     <task id="LOCAL-00001" summary="Optimise code by sourcery.ai">
       <created>1674630349699</created>
@@ -640,4 +631,4 @@
     <SUITE FILE_PATH="coverage/mkdoxy_main$pytest_in__.coverage" NAME="pytest in / Coverage Results" MODIFIED="1712098709702" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/" />
     <SUITE FILE_PATH="coverage/mkdoxy_main$mkdocs_serve_vPy3_11.coverage" NAME="mkdocs-serve-vPy3.11 Coverage Results" MODIFIED="1712099288194" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/" />
   </component>
-</project>
\ No newline at end of file
+</project>
diff --git a/demo-projects/animal/Doxyfile b/demo-projects/animal/Doxyfile
index 20dc954b..f8cc2640 100644
--- a/demo-projects/animal/Doxyfile
+++ b/demo-projects/animal/Doxyfile
@@ -4,4 +4,4 @@ RECURSIVE = YES
 EXAMPLE_PATH = examples
 SHOW_NAMESPACES = YES
 GENERATE_HTML = NO
-GENERATE_LATEX = YES
\ No newline at end of file
+GENERATE_LATEX = YES
diff --git a/docs/usage/advanced.md b/docs/usage/advanced.md
index a5dd5cb6..d4ec5a71 100644
--- a/docs/usage/advanced.md
+++ b/docs/usage/advanced.md
@@ -48,4 +48,4 @@ plugins:
           doxy-cfg-file: path/to/Doxyfile  # relative path to the Doxygen configuration file (relative to the mkdocs.yml file)
           doxy-cfg:       # standard doxygen configuration (key: value)
             FILE_PATTERNS: ... # other configuration options - merge (this will override the configuration from the Doxyfile)
-```
\ No newline at end of file
+```
diff --git a/mkdoxy/doxyrun.py b/mkdoxy/doxyrun.py
index ef901857..428a1919 100644
--- a/mkdoxy/doxyrun.py
+++ b/mkdoxy/doxyrun.py
@@ -252,8 +252,10 @@ def getOutputFolder(self) -> PurePath:
 class DoxygenBinPathNotValid(Exception):
     pass
 
+
 class DoxygenCustomConfigNotFound(Exception):
     pass
 
+
 class DoxygenCustomConfigNotValid(Exception):
-    pass
\ No newline at end of file
+    pass
diff --git a/setup.py b/setup.py
index 945e8a06..d8b3353b 100755
--- a/setup.py
+++ b/setup.py
@@ -33,12 +33,13 @@ def requirements():
     install_requires=["mkdocs"],
     extras_require={
         "dev": [
-            "mkdocs-material==9.1.18",
+            "mkdocs-material~=9.1.18",
             "Jinja2~=3.1.2",
             "mkdocs-open-in-new-tab~=1.0.2",
             "pathlib~=1.0.1",
             "path~=16.7.1",
             "isort~=5.12.0",
+            "pytest~=6.2.5",
         ],
     },
     classifiers=[
diff --git a/tests/data/Doxyfile b/tests/data/Doxyfile
index 1fb9542e..ac135f69 100644
--- a/tests/data/Doxyfile
+++ b/tests/data/Doxyfile
@@ -4,4 +4,4 @@ RECURSIVE = YES
 EXAMPLE_PATH = examples
 SHOW_NAMESPACES = YES
 GENERATE_HTML = NO
-GENERATE_LATEX = NO
\ No newline at end of file
+GENERATE_LATEX = NO
diff --git a/tests/test_doxyrun.py b/tests/test_doxyrun.py
index e86f9d8e..3a88c5be 100644
--- a/tests/test_doxyrun.py
+++ b/tests/test_doxyrun.py
@@ -1,4 +1,6 @@
 from mkdoxy.doxyrun import DoxygenRun
+
+
 def test_dox_dict2str():
     dox_dict = {
         "DOXYFILE_ENCODING": "UTF-8",
@@ -23,6 +25,7 @@ def test_dox_dict2str():
 
     assert result == expected_result
 
+
 #  Sets the Doxygen configuration using a custom config file
 def test_set_doxy_cfg_custom_file():
     dox_dict = {}
@@ -74,4 +77,4 @@ def test_str2dox_dict():
         "GENERATE_LATEX": False,
     }
 
-    assert result == expected_result
\ No newline at end of file
+    assert result == expected_result