From 2742273a26fd28137a447799768dd184b0f68e1d Mon Sep 17 00:00:00 2001
From: Jakub Andrysek <jakub.andrysek03@gmail.com>
Date: Wed, 3 Apr 2024 01:25:15 +0200
Subject: [PATCH] Add MkDoxy build workflow for all supported Python versions

---
 .github/workflows/mkdoxy-pytest-repo.yaml | 28 +++++++++++
 .idea/workspace.xml                       | 58 ++++++++++++-----------
 mkdoxy/doxyrun.py                         |  3 +-
 tests/test_doxyrun.py                     | 13 ++++-
 4 files changed, 71 insertions(+), 31 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..50b1bf42
--- /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", "3.12"]
+
+    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/.idea/workspace.xml b/.idea/workspace.xml
index bd58b38f..7036b79d 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -5,7 +5,9 @@
   </component>
   <component name="ChangeListManager">
     <list default="true" id="5a348fe7-ee21-4e06-b8fc-ced5d548a610" name="Changes" comment="Upgrade version">
-      <change beforePath="$PROJECT_DIR$/setup.py" beforeDir="false" afterPath="$PROJECT_DIR$/setup.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/mkdoxy/doxyrun.py" beforeDir="false" afterPath="$PROJECT_DIR$/mkdoxy/doxyrun.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/tests/test_doxyrun.py" beforeDir="false" afterPath="$PROJECT_DIR$/tests/test_doxyrun.py" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -41,9 +43,9 @@
   <component name="MarkdownSettingsMigration">
     <option name="stateVersion" value="1" />
   </component>
-  <component name="ProjectColorInfo"><![CDATA[{
-  "associatedIndex": 3
-}]]></component>
+  <component name="ProjectColorInfo">{
+  &quot;associatedIndex&quot;: 3
+}</component>
   <component name="ProjectId" id="20sSF9RtRyYPthPvI9bA0t9QgTh" />
   <component name="ProjectLevelVcsManager" settingsEditedManually="true" />
   <component name="ProjectViewState">
@@ -51,26 +53,26 @@
     <option name="hideEmptyMiddlePackages" value="true" />
     <option name="showLibraryContents" value="true" />
   </component>
-  <component name="PropertiesComponent"><![CDATA[{
-  "keyToString": {
-    "Python tests.pytest in /.executor": "Run",
-    "Python.mkdocs-serve-vPy3.11.executor": "Run",
-    "Python.mkdoxy-demo-vPy3.11.executor": "Debug",
-    "RunOnceActivity.OpenProjectViewOnStart": "true",
-    "RunOnceActivity.ShowReadmeOnStart": "true",
-    "SHARE_PROJECT_CONFIGURATION_FILES": "true",
-    "WebServerToolWindowFactoryState": "false",
-    "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",
-    "node.js.selected.package.eslint": "(autodetect)",
-    "node.js.selected.package.tslint": "(autodetect)",
-    "nodejs_package_manager_path": "npm",
-    "settings.editor.selected.configurable": "reference.settings.ide.settings.new.ui",
-    "vue.rearranger.settings.migration": "true"
+  <component name="PropertiesComponent">{
+  &quot;keyToString&quot;: {
+    &quot;Python tests.pytest in /.executor&quot;: &quot;Run&quot;,
+    &quot;Python.mkdocs-serve-vPy3.11.executor&quot;: &quot;Run&quot;,
+    &quot;Python.mkdoxy-demo-vPy3.11.executor&quot;: &quot;Debug&quot;,
+    &quot;RunOnceActivity.OpenProjectViewOnStart&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
+    &quot;SHARE_PROJECT_CONFIGURATION_FILES&quot;: &quot;true&quot;,
+    &quot;WebServerToolWindowFactoryState&quot;: &quot;false&quot;,
+    &quot;git-widget-placeholder&quot;: &quot;doxygen-config-file&quot;,
+    &quot;last_opened_file_path&quot;: &quot;/Users/kuba/Documents/git/kuba/mkdoxy/mkdoxy-base/mkdoxy-main/tests/data&quot;,
+    &quot;node.js.detected.package.eslint&quot;: &quot;true&quot;,
+    &quot;node.js.detected.package.tslint&quot;: &quot;true&quot;,
+    &quot;node.js.selected.package.eslint&quot;: &quot;(autodetect)&quot;,
+    &quot;node.js.selected.package.tslint&quot;: &quot;(autodetect)&quot;,
+    &quot;nodejs_package_manager_path&quot;: &quot;npm&quot;,
+    &quot;settings.editor.selected.configurable&quot;: &quot;reference.settings.ide.settings.new.ui&quot;,
+    &quot;vue.rearranger.settings.migration&quot;: &quot;true&quot;
   }
-}]]></component>
+}</component>
   <component name="RecentsManager">
     <key name="CopyFile.RECENT_KEYS">
       <recent name="$PROJECT_DIR$/tests/data" />
@@ -315,7 +317,7 @@
       <workItem from="1689697868617" duration="13000" />
       <workItem from="1689777262215" duration="704000" />
       <workItem from="1689947020589" duration="1060000" />
-      <workItem from="1712098386110" duration="1331000" />
+      <workItem from="1712098386110" duration="1897000" />
     </task>
     <task id="LOCAL-00001" summary="Optimise code by sourcery.ai">
       <created>1674630349699</created>
@@ -589,17 +591,17 @@
         </line-breakpoint>
         <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
           <url>file://$PROJECT_DIR$/mkdoxy/doxyrun.py</url>
-          <line>93</line>
+          <line>94</line>
           <option name="timeStamp" value="101" />
         </line-breakpoint>
         <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
           <url>file://$PROJECT_DIR$/mkdoxy/doxyrun.py</url>
-          <line>110</line>
+          <line>111</line>
           <option name="timeStamp" value="102" />
         </line-breakpoint>
         <line-breakpoint enabled="true" suspend="THREAD" type="python-line">
           <url>file://$PROJECT_DIR$/tests/test_doxyrun.py</url>
-          <line>12</line>
+          <line>14</line>
           <option name="timeStamp" value="103" />
         </line-breakpoint>
         <line-breakpoint enabled="true" type="jinja2-line">
@@ -631,4 +633,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>
+</project>
\ No newline at end of file
diff --git a/mkdoxy/doxyrun.py b/mkdoxy/doxyrun.py
index 428a1919..b8e6f9ef 100644
--- a/mkdoxy/doxyrun.py
+++ b/mkdoxy/doxyrun.py
@@ -82,7 +82,8 @@ def setDoxyCfg(self, doxyCfgNew: dict) -> dict:
         @details - SHOW_NAMESPACES: YES
         @details - GENERATE_HTML: NO
         @details - GENERATE_LATEX: NO
-        @param doxyCfgNew: (dict) New Doxygen config options that will be added to the default config (new options will overwrite default options)
+        @param doxyCfgNew: (dict) New Doxygen config options that will be
+         added to the default config (new options will overwrite default options)
         @return: (dict) Doxygen configuration.
         """
         doxyCfg = {}
diff --git a/tests/test_doxyrun.py b/tests/test_doxyrun.py
index 3a88c5be..2c8cbff9 100644
--- a/tests/test_doxyrun.py
+++ b/tests/test_doxyrun.py
@@ -21,7 +21,12 @@ def test_dox_dict2str():
 
     result = doxygen_run.dox_dict2str(dox_dict)
 
-    expected_result = "DOXYFILE_ENCODING = UTF-8\nGENERATE_XML = YES\nRECURSIVE = YES\nEXAMPLE_PATH = examples\nSHOW_NAMESPACES = YES\nGENERATE_HTML = NO\nGENERATE_LATEX = NO"
+    expected_result = (
+        "DOXYFILE_ENCODING = UTF-8\nGENERATE_XML = YES"
+        "\nRECURSIVE = YES\nEXAMPLE_PATH = examples"
+        "\nSHOW_NAMESPACES = YES\nGENERATE_HTML = NO"
+        "\nGENERATE_LATEX = NO"
+    )
 
     assert result == expected_result
 
@@ -56,7 +61,11 @@ def test_set_doxy_cfg_custom_file():
 
 
 def test_str2dox_dict():
-    dox_str = "DOXYFILE_ENCODING = UTF-8\nGENERATE_XML = YES\nRECURSIVE = YES\nEXAMPLE_PATH = examples\nSHOW_NAMESPACES = YES\nGENERATE_HTML = NO\nGENERATE_LATEX = NO"
+    dox_str = (
+        "DOXYFILE_ENCODING = UTF-8\nGENERATE_XML = YES\n"
+        "RECURSIVE = YES\nEXAMPLE_PATH = examples\n"
+        "SHOW_NAMESPACES = YES\nGENERATE_HTML = NO\nGENERATE_LATEX = NO"
+    )
 
     doxygen_run = DoxygenRun(
         doxygenBinPath="doxygen",