Merge pull request #2514 from berryzplus/feature/add_pytest

Pythonスクリプトのテストを追加する

Author: berryzplus

.github/workflows/build-on-msys2.yml

@@ -28,8 +28,22 @@ jobs:
         with:
           submodules: true
 
+      - name: Install OpenCppCoverage (winget)
+        if: ${{ matrix.config == 'Debug' }}
+        run: |
+          winget install `
+            --id OpenCppCoverage.OpenCppCoverage `
+            --exact `
+            --accept-package-agreements `
+            --accept-source-agreements
+        shell: pwsh
+
       - name: Set up Python
         uses: actions/setup-python@v6
+        with:
+          python-version: ${{ vars.PYTHON_VERSION || '3.14.3' }}
+          cache: 'pip'
+      - run: pip install -r requirements.txt
 
       - name: Set up MSYS2
         uses: msys2/setup-msys2@v2
@@ -41,6 +55,7 @@ jobs:
             mingw-w64-x86_64-gcc
             mingw-w64-x86_64-cmake
             mingw-w64-x86_64-make
+            mingw-w64-x86_64-python
             mingw-w64-x86_64-7zip
             mingw-w64-x86_64-gdb
 

.github/workflows/build-sakura.yml

@@ -104,9 +104,71 @@ jobs:
     - name: Add msbuild to PATH
       uses: microsoft/setup-msbuild@v3
 
+    # SonarQubeのBuild Wrapperをインストールする
+    - name: Install Build Wrapper
+      if: ${{ matrix.platform == 'x64' && matrix.config == 'Debug' }}
+      uses: SonarSource/sonarqube-scan-action/install-build-wrapper@713881670b6b3676cda39549040e2d88c70d582e # v8.2.0
+
+    # OpenCppCoverageをインストールする
+    - name: Install OpenCppCoverage (winget)
+      id: install_opencppcoverage_winget
+      if: ${{ matrix.config == 'Debug' }}
+      continue-on-error: true
+      run: |
+        winget install `
+          --id OpenCppCoverage.OpenCppCoverage `
+          --exact `
+          --accept-package-agreements `
+          --accept-source-agreements
+      shell: pwsh
+
+    # wingetは失敗することがあるので、インストーラー方式も残しておく。
+    - name: Install OpenCppCoverage (installer)
+      if: ${{ matrix.config == 'Debug' && steps.install_opencppcoverage_winget.outcome == 'failure' }}
+      working-directory: ${{ runner.temp }}
+      run: |
+        $installer = '.\OpenCppCoverageSetup.exe'
+        Invoke-WebRequest `
+          -Uri "https://github.com/OpenCppCoverage/OpenCppCoverage/releases/download/release-0.9.9.0/OpenCppCoverageSetup-x64-0.9.9.0.exe" `
+          -OutFile $installer
+        $expectedSha256 = '2295a733da39412c61e4f478677519dd0bb1893d88313ce56b468c9e50517888'
+        $actualSha256 = (Get-FileHash $installer -Algorithm SHA256).Hash.ToLowerInvariant()
+        if ($actualSha256 -ne $expectedSha256.ToLowerInvariant()) {
+          throw "SHA256 mismatch: expected=$expectedSha256 actual=$actualSha256"
+        }
+        Start-Process `
+          -FilePath $installer `
+          -ArgumentList "/VERYSILENT", "/SUPPRESSMSGBOXES" `
+          -Wait
+        echo "C:\Program Files\OpenCppCoverage" >> $env:GITHUB_PATH
+      shell: pwsh
+
     - name: Set up Python
-      if: ${{ matrix.platform == 'x64' }}
       uses: actions/setup-python@v6
+      with:
+        python-version: ${{ vars.PYTHON_VERSION || '3.14.3' }}
+        cache: 'pip'
+    - run: pip install -r requirements.txt
+
+    - name: Copy github-event.json
+      run: |
+        Copy-Item "$env:GITHUB_EVENT_PATH" github-event.json
+      shell: pwsh
+
+    - name: Generate sonar metadata
+      if: ${{ matrix.platform == 'x64' && matrix.config == 'Debug' }}
+      env:
+        PR_HEAD_REF: ${{ github.event.pull_request.head.ref }}
+        PR_BASE_REF: ${{ github.event.pull_request.base.ref }}
+      run: |
+        [ordered]@{
+          event_name  = '${{ github.event_name }}'
+          ref_name    = '${{ github.ref_name }}'
+          pr_number   = '${{ github.event.pull_request.number }}'
+          pr_head_ref = $env:PR_HEAD_REF
+          pr_base_ref = $env:PR_BASE_REF
+        } | ConvertTo-Json | Set-Content sonar-metadata.json
+      shell: pwsh
 
     - name: Setup PR environment variables
       if: github.event_name == 'pull_request'
@@ -117,7 +179,13 @@ jobs:
         echo "GITHUB_PR_HEAD_SHORT_COMMIT=$('${{ github.event.pull_request.head.sha }}'.SubString(0, 8))" >> $env:GITHUB_ENV
       shell: pwsh
 
+    - name: Build with Build-Wrapper
+      if: ${{ matrix.platform == 'x64' && matrix.config == 'Debug' }}
+      run: build-wrapper-win-x86-64.exe --out-dir bw-output MsBuild.exe /p:Platform=${{ matrix.platform }} /p:Configuration=${{ matrix.config }}
+      shell: cmd
+
     - name: MSBuild
+      if: ${{ matrix.platform != 'x64' || matrix.config != 'Debug' }}
       run: build-sln.bat ${{ matrix.platform }} ${{ matrix.config }}
       shell: cmd
 
@@ -128,10 +196,30 @@ jobs:
         path: help
 
     - name: Run unit tests
-      run: .\tests1.exe --gtest_output=xml:${{github.workspace}}\tests1.exe-googletest-${{matrix.platform}}-${{matrix.config}}.xml
-      working-directory: ${{github.workspace}}\${{matrix.platform}}\${{matrix.config}}
+      run: ctest
+        --test-dir build/${{ matrix.platform }}/CMakeTools
+        -C ${{ matrix.config }}
+        --output-on-failure
       shell: pwsh
 
+    - name: Upload test result
+      uses: EnricoMi/publish-unit-test-result-action/windows@v2
+      with:
+        files: |
+          *-googletest.xml
+
+    - name: Upload sonar-input artifact
+      if: ${{ matrix.platform == 'x64' && matrix.config == 'Debug' }}
+      uses: actions/upload-artifact@v7
+      with:
+        name: sonar-input
+        path: |
+          bw-output/
+          tests*-coverage.xml
+          tests*-googletest.xml
+          sonar-metadata.json
+          github-event.json
+
       # Toolbar Bitmap Split/Mux
     - run: build-bmp-tools.bat ${{matrix.config}}
       name: Bitmap Split/Mux
@@ -181,98 +269,3 @@ jobs:
       with:
         name: Dev ${{ matrix.platform }} ${{ matrix.config }}
         path: 'sakura-*-Dev.zip'
-
-  sonar-build:
-    name: MSBuild for SonarCloud (x64/Debug)
-    runs-on: windows-latest
-
-    env:
-      BUILD_PLATFORM: x64
-      BUILD_CONFIGURATION: Debug
-
-    steps:
-    - uses: actions/checkout@v7
-      with:
-        fetch-depth: 0
-        submodules: true
-
-    - name: Add msbuild to PATH
-      uses: microsoft/setup-msbuild@30375c66a4eea26614e0d39710365f22f8b0af57 # v3
-
-    - name: Set up Python
-      uses: actions/setup-python@v6
-
-    - name: Install AutoHotKey
-      run: |
-        $AutohotkeyDir = "$HOME\autohotkey"
-        if (!(Test-Path $AutohotkeyDir)) { New-Item -ItemType Directory -Path $AutohotkeyDir }
-        $ProgressPreference = 'SilentlyContinue'
-        Invoke-WebRequest -Uri https://github.com/AutoHotkey/AutoHotkey/releases/download/v2.0.19/AutoHotkey_2.0.19.zip -OutFile "AutoHotkey.zip"
-        Expand-Archive -Path "AutoHotkey.zip" -DestinationPath $AutohotkeyDir -Force
-        echo "AutoHotKey=$HOME\autohotkey\AutoHotkey32.exe" >> $env:GITHUB_ENV
-
-    - name: Install Locale Emulator
-      run: |
-        $LEExpandDir = "${{ github.workspace }}\tools\LocaleEmulator"
-        $LEInitScript = "${{ github.workspace }}\tools\LocaleEmulator\init-locale-emulator.ahk"
-        Expand-Archive "${{ github.workspace }}\externals\LocaleEmulator\locale-emulator.zip" "${LEExpandDir}"
-        Start-Process $env:AutoHotKey "${LEInitScript}"
-        Start-Process "${LEExpandDir}\LEInstaller.exe"
-        echo "${LEExpandDir}" >> $env:GITHUB_PATH
-      shell: pwsh
-
-    - name: Install Build Wrapper
-      uses: SonarSource/sonarqube-scan-action/install-build-wrapper@713881670b6b3676cda39549040e2d88c70d582e # v8.2.0
-
-    - name: Build with Build-Wrapper
-      run: build-wrapper-win-x86-64.exe --out-dir bw-output MsBuild.exe /p:Platform=%BUILD_PLATFORM% /p:Configuration=%BUILD_CONFIGURATION% /t:ReBuild
-      shell: cmd
-
-    - name: Install OpenCppCoverage
-      working-directory: ${{ runner.temp }}
-      run: |
-        $ProgressPreference = 'SilentlyContinue'
-        Invoke-WebRequest -Uri "https://github.com/OpenCppCoverage/OpenCppCoverage/releases/download/release-0.9.9.0/OpenCppCoverageSetup-x64-0.9.9.0.exe" -OutFile OpenCppCoverageSetup.exe
-        Start-Process -FilePath .\OpenCppCoverageSetup.exe -ArgumentList "/VERYSILENT", "/SUPPRESSMSGBOXES" -Wait
-        echo "C:\Program Files\OpenCppCoverage" >> $env:GITHUB_PATH
-      shell: pwsh
-
-    - name: Run Tests with coverage
-      run: |
-        $env:CMD_TESTS1 = $(Get-ChildItem -Recurse tests1.exe)[0].FullName
-        OpenCppCoverage.exe `
-          --export_type cobertura:tests1-coverage.xml `
-          --modules $env:CMD_TESTS1 `
-          --sources ${{ github.workspace }} `
-          --working_dir ${{ github.workspace }}\${{ env.BUILD_PLATFORM }}\${{ env.BUILD_CONFIGURATION }} `
-          --cover_children `
-          -- `
-          $env:CMD_TESTS1 `
-          --gtest_output=xml:${{ github.workspace }}\tests1-googletest.xml
-      shell: pwsh
-
-    - name: Save sonar metadata
-      env:
-        PR_HEAD_REF: ${{ github.event.pull_request.head.ref }}
-        PR_BASE_REF: ${{ github.event.pull_request.base.ref }}
-      run: |
-        [ordered]@{
-          event_name  = '${{ github.event_name }}'
-          ref_name    = '${{ github.ref_name }}'
-          pr_number   = '${{ github.event.pull_request.number }}'
-          pr_head_ref = $env:PR_HEAD_REF
-          pr_base_ref = $env:PR_BASE_REF
-        } | ConvertTo-Json | Set-Content sonar-metadata.json
-        Copy-Item "$env:GITHUB_EVENT_PATH" github-event.json
-      shell: pwsh
-
-    - name: Upload sonar-input artifact
-      uses: actions/upload-artifact@v7
-      with:
-        name: sonar-input
-        path: |
-          bw-output/
-          tests1-coverage.xml
-          tests1-googletest.xml
-          sonar-metadata.json
-          github-event.json

.github/workflows/check-encoding.yml

@@ -1,4 +1,4 @@
-name: Check Encoding
+name: Check Encoding
 
 on:
   push:
@@ -26,23 +26,17 @@ jobs:
         run: set
         shell: cmd
 
-      - name: Set up Python ${{ matrix.python-version }}
+      - name: Set up Python
         uses: actions/setup-python@v6
         with:
-          python-version: '3.x'
+          python-version: ${{ vars.PYTHON_VERSION || '3.14.3' }}
+          cache: 'pip'
+      - run: pip install -r requirements.txt
 
       - name: Python version check
         run: python --version
         shell: cmd
 
-      - name: Upgrade pip
-        run: python -m pip install --upgrade pip
-        shell: cmd
-
-      - name: Install chardet
-        run: python -m pip install chardet==6.0.0
-        shell: cmd
-
       - name: Check encoding
         run: python checkEncoding.py
         shell: cmd

.github/workflows/python-check.yml

@@ -1,4 +1,4 @@
-name: Python Compile Check
+name: Python Compile Check
 
 on:
   push:
@@ -16,17 +16,20 @@ on:
 jobs:
   python-compile-check:
     runs-on: windows-latest
-    strategy:
-      matrix:
-        python-version: ['3.x']
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v7
+        with:
+          fetch-depth: 1
+          submodules: false
 
-      - name: Set up Python ${{ matrix.python-version }}
+      - name: Set up Python
         uses: actions/setup-python@v6
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: ${{ vars.PYTHON_VERSION || '3.14.3' }}
+          cache: 'pip'
+      - run: pip install -r requirements.txt
 
       - name: Python version check
         run: python --version

.github/workflows/sonarscan.yml

@@ -71,6 +71,7 @@ jobs:
           "-Dsonar.cfamily.compile-commands=bw-output/compile_commands.json"
           "-Dsonar.cfamily.cppunit.reportPath=*-googletest.xml"
           "-Dsonar.cfamily.cobertura.reportPaths=tests1-coverage.xml"
+          "-Dsonar.python.coverage.reportPaths=pytest-coverage.xml"
           "-Dsonar.verbose=true"
 
     - name: Upload Sonar CFamily failure reproducer (if present)

.gitignore

@@ -28,6 +28,10 @@ tags
 testData_*.txt
 UpgradeLog.htm
 
+# PyTest出力ファイルは除外する
+.coverage
+pytest-coverage.xml
+
 # SonarScanローカル実行用(解析ツールをダウンロードするフォルダ)
 .sonar
 
@@ -38,7 +42,9 @@ UpgradeLog.htm
 SONAR_TOKEN
 
 # SonarScanローカル実行用したときに生成されるテスト結果ファイル
-tests1-googletest.xml
+tests*-googletest.xml
+tests*-coverage.xml
+LastCoverageResults.log
 
 # SonarScanローカル実行の失敗再現用アーカイブ
 sonar-cfamily-reproducer.tar.xz

CMakeLists.txt

@@ -46,10 +46,42 @@ add_subdirectory("${CMAKE_SOURCE_DIR}/tools/ppa_stub"
 add_subdirectory("${CMAKE_SOURCE_DIR}/tools/dll_plugin1"
                  "${CMAKE_BINARY_DIR}/dll_plugin1")
 
+# Convert paths to native Windows format (backslashes) for OpenCppCoverage
+file(TO_NATIVE_PATH "${CMAKE_SOURCE_DIR}" CMAKE_SOURCE_DIR_NATIVE)
+file(TO_NATIVE_PATH "${OUTPUT_DIRECTORY}" OUTPUT_DIRECTORY_NATIVE)
+
 # Include tests1 definition
 include(${CMAKE_SOURCE_DIR}/src/test/cmake/tests1.cmake)
 
+if(OpenCppCoverage_EXECUTABLE)
+  add_test(NAME CoverageTest
+    COMMAND ${OpenCppCoverage_EXECUTABLE}
+      --export_type cobertura:${CMAKE_SOURCE_DIR_NATIVE}\\tests1-coverage.xml
+      --modules ${OUTPUT_DIRECTORY_NATIVE}\\tests1.exe
+      --sources ${CMAKE_SOURCE_DIR_NATIVE}
+      --excluded_sources ${CMAKE_SOURCE_DIR_NATIVE}\\build
+      --working_dir ${OUTPUT_DIRECTORY_NATIVE}
+      --cover_children
+      --
+      $<TARGET_FILE:tests1>
+      --gtest_output=xml:${CMAKE_SOURCE_DIR}/tests1-googletest.xml
+    CONFIGURATIONS Debug
+  )
+endif()
+
 add_test(NAME UnitTest
   COMMAND $<TARGET_FILE:tests1>
-    --gtest_output=xml:${OUTPUT_DIRECTORY}/tests1-googletest.xml
+    --gtest_output=xml:${CMAKE_SOURCE_DIR}/tests1-googletest.xml
+  WORKING_DIRECTORY ${OUTPUT_DIRECTORY}
+  CONFIGURATIONS Release
+)
+
+add_test(NAME pytest
+  COMMAND ${Python3_EXECUTABLE} -m pytest
+    --ignore=externals
+    --cov
+    --cov-config=src/test/py/.coveragerc
+    --cov-report=xml:pytest-coverage.xml
+    --cov-fail-under=80
+  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
 )

requirements.txt

@@ -0,0 +1,4 @@
+chardet>=6
+pytest>=8,<9
+pytest-cov>=5,<6
+pytest-mock>=3,<4