Ci (compile and test in a GitHub action)

.github/actions/run_regression_tests/action.yml

@@ -0,0 +1,90 @@
+name: 
+  Run the regression tests.
+
+description:
+  Diff the output from the test steps, against correctout*.txt
+
+inputs:
+  python_version:
+    required: false
+    default: "3.12"
+    description: 'The tests pass on Python 2.7 and Python 3.5, ..., 3.12'
+
+  shell:
+    required: false
+    default: cmd
+    description: The shell to run the test commands in, e.g. cmd, powershell, bash.
+
+  DONT_TEST_N_LINK_SUBSYSTEMS_ORDER:
+    required: true
+    description: "Non-empty string: In correctout_prep.txt, allow output lines of the form: -link subsystem contains link with id = , to be in any order.  Empty string ('') : require the orders of the lines to match."
+
+  ALLOW_NEGATIVE_FORMULA_ERROR_ON_ANY_LINK_PRESENT:
+    required: true
+    description: "The negative formula is on all links, but the tests strictly require the first error to raised to be for the same link as in the original run. "
+
+  sdnadll:
+    description: 'The path to the sdna_vs2008.dll of the installation to be tested.'
+    required: true
+
+
+  sdna_bin_dir:
+    description: 'The path to the python entry point files (sdnaintegral.py) to be tested.  Default: (dirname $sdnadll)/../bin/'
+    required: false
+    default: ''
+
+  sdna_debug:
+    description: "'' (empty string): filter out the lines in correctout*.txt that are only output by debug builds. Non-empty string: don't. "
+
+runs:
+  using: "composite"
+  steps:
+    - uses: LizardByte/setup-python-action@master
+      with:
+        python-version: ${{ inputs.python_version }}
+
+    - name: Install Pytest, and Numpy (the latter for sDNA Learn & Predict).
+      shell: ${{ inputs.shell }}
+      working-directory: .\sDNA\sdna_vs2008\tests\pytest
+      run: pip install pytest numpy
+
+    - name: Show versions.
+      shell: ${{ inputs.shell }}
+      working-directory: '.\sDNA\sdna_vs2008\tests\pytest'
+      run: |
+        python --version
+        python -c "import numpy; print(numpy.__version__)"
+        python -m pytest --version
+
+
+    # - name: Run debug_test.py directly.
+    #   shell: cmd
+    #   working-directory: '.\sDNA\sdna_vs2008\tests'
+    #   # run: python -u debug_test.py
+    #   run: set "sdnadll=c:\Program Files (x86)\sDNA\x64\sdna_vs2008.dll" & python -u debug_test.py
+
+    # - name: Run diff test number 0 directly via
+    #   test_gathering_windows_command_line_tests.py, by test index
+    #   working-directory: '.\sDNA\sdna_vs2008\tests\pytest'
+    #   run: python test_gathering_windows_command_line_tests.py 0
+
+    - name: Run all the diff tests with Pytest.
+      shell: ${{ inputs.shell }}
+      working-directory: .\sDNA\sdna_vs2008\tests\pytest
+      env:
+        DONT_TEST_N_LINK_SUBSYSTEMS_ORDER: ${{ inputs.DONT_TEST_N_LINK_SUBSYSTEMS_ORDER }}
+        ALLOW_NEGATIVE_FORMULA_ERROR_ON_ANY_LINK_PRESENT: ${{ inputs.ALLOW_NEGATIVE_FORMULA_ERROR_ON_ANY_LINK_PRESENT }}
+        sdnadll: ${{ inputs.sdnadll }}
+        sdna_bin_dir: ${{ inputs.sdna_bin_dir }}
+        sdna_debug: ${{ inputs.sdna_debug }}
+      run: pytest -rA
+      # -rA shows summary of tests, one per line, even when they all pass.
+      #
+      # To run the same tests locally, the command is something like:
+      # run: >
+      #   set "sdnadll=c:\Program Files (x86)\sDNA\x64\sdna_vs2008.dll" &
+      #   set "sdna_bin_dir=c:\Program Files (x86)\sDNA\bin" &
+      #   set sdna_debug=False &
+      #   set DONT_TEST_N_LINK_SUBSYSTEMS_ORDER=1 &
+      #   set ALLOW_NEGATIVE_FORMULA_ERROR_ON_ANY_LINK_PRESENT=1 &
+      #   pytest -rA

.github/workflows/compile_and_test.yml

@@ -0,0 +1,167 @@
+name: "Compile with MSBuild and VS 2022 for Windows, and test"
+
+on:
+  workflow_dispatch:
+
+  push:
+    branches: [ "main" ]
+
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  CONFIGURATION: Release
+  PLATFORM: x64
+  BOOST_VERSION: '1.8.3'
+
+
+jobs:
+  build_and_upload_installer:
+    name: Try to compile on windows
+    runs-on: windows-2022
+    outputs:
+      installer_file_name: ${{ steps.output_installer_file_name.outputs.name }}
+    steps:
+    - uses: actions/checkout@v4
+
+
+
+
+    - name: 'Add "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\bin" to path'
+      shell: bash
+      run: echo "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\bin" >> $GITHUB_PATH
+
+    - name: Deploy Advinst
+      uses: caphyon/[email protected]
+      with:
+        advinst-version: '21.3'
+
+        # advinst-license: ${{ secrets.ADVINST_LICENSE_KEY }}
+        # " advinst-license
+        # Advanced Installer license ID. This parameter is optional if you are using a simple project type.
+        # "
+
+    - name: Add msbuild to PATH
+      uses: microsoft/setup-msbuild@v2
+
+    - name: Integrate vcpkg with Visual Studio
+      run: vcpkg integrate install
+
+
+
+
+    - name: Restore vcpkg Deps
+      id: cache-vcpkg-deps-restore
+      uses: actions/cache/restore@v4
+      with:
+        path: |
+          C:\vcpkg\packages\
+          D:\a\sdna_plus\sdna_plus\vcpkg_installed\
+        key: ${{ runner.os }}-${{ hashFiles('vcpkg.json') }}
+
+    # Let vcpkg do its thing with the cache and don't skip this step
+    # if there is a cache hit. Vcpkg will detect pre existing files.
+    # that it previously installed.
+    - name: Install Boost from vcpkg.json
+      run: vcpkg install
+
+
+    - name: Cache vcpkg Deps
+      if: steps.cache-vcpkg-deps-restore.outputs.cache-hit != 'true'
+      id: cache-deps-save
+      uses: actions/cache/save@v4
+      with:
+        path: |
+          C:\vcpkg\packages\
+          D:\a\sdna_plus\sdna_plus\vcpkg_installed\
+        key: ${{ steps.cache-vcpkg-deps-restore.outputs.cache-primary-key }}
+
+
+    - name: Build sDNA
+      working-directory: ${{ github.workspace }}
+      run: > 
+        msbuild build_installer.proj 
+        /t:rebuild 
+        /p:Platform=${{ env.PLATFORM }}  
+        /p:Configuration=${{ env.CONFIGURATION }} 
+        /p:VcpkgEnableManifest=true
+
+    - name: Output the name of the .msi installer file
+      id: output_installer_file_name
+      shell: bash
+      run: echo "name=$(ls sDNA_setup_win_v*.msi)" >> "$GITHUB_OUTPUT"  
+
+    - name: upload output dir
+      id: installer-upload-step
+      uses: actions/upload-artifact@v4
+      with:
+        name: installer_file
+        # this file name pattern is defined in installerbits\rename_version.py
+        # outfilename = os.path.join(outputdir, "sDNA_setup_win_v%s.msi" % filename_friendly_version)
+        path: sDNA_setup_win_v*.msi
+
+
+
+  test_installer:
+
+    needs: build_and_upload_installer
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python_version: ['2.7', '3.5', '3.6', '3.7', '3.8', '3.9', '3.10', '3.11', '3.12']
+
+    name: "Download and run sDNA installer, and run diff tests on it. "
+
+    runs-on: windows-2022
+    # Note:  The Windows server 2022 Github runner image already includes  
+    # Python (currently 6 versions from 3.7 to 3.12) and a couple of 
+    # VC++ redistributables.  Desktop users may need to install these 
+    # themselves, in addition to sDNA.      
+    #
+    # https://github.com/actions/runner-images/blob/main/images/windows/Windows2022-Readme.md
+    #
+
+    env:
+      installer_file_name: ${{ needs.build_and_upload_installer.outputs.installer_file_name }}
+
+    steps:
+
+
+    - uses: actions/checkout@v4
+
+    - name: Download installer built in previous job
+      uses: actions/download-artifact@v4
+      with:
+        name: installer_file
+
+    - shell: cmd
+      run: dir .
+
+
+    - name: Allow the .msi to be executed
+      run: Set-ItemProperty -Path ${{ env.installer_file_name }} -Name IsReadOnly -Value $false
+
+
+    - name: Run sDNA installer using powershell script. 
+      # This is based on @Simran-B's powershell script (from Github Community forum),
+      # according to GuiFalourd on Stack Overflow
+      # https://stackoverflow.com/a/72291019/20785734
+      run: |
+        $file = "${{ env.installer_file_name }}"
+        $log = "install.log" 
+        $procMain = Start-Process "msiexec" "/i `"$file`" /qn /l*! `"$log`"" -NoNewWindow -PassThru
+        $procLog = Start-Process "powershell" "Get-Content -Path `"$log`" -Wait" -NoNewWindow -PassThru 
+        $procMain.WaitForExit() 
+        $procLog.Kill()
+        Remove-Item $file
+
+
+    - name: Run regression tests
+      uses: ./.github/actions/run_regression_tests
+      with:
+        python_version: ${{ matrix.python_version }}
+        DONT_TEST_N_LINK_SUBSYSTEMS_ORDER: 1
+        ALLOW_NEGATIVE_FORMULA_ERROR_ON_ANY_LINK_PRESENT: 1
+        sdnadll: 'c:\Program Files (x86)\sDNA\x64\sdna_vs2008.dll'
+        sdna_debug: ""

.github/workflows/test_sDNA_release.yml

@@ -0,0 +1,79 @@
+name: test_a_released_sDNA_installer_(.msi)
+
+on:  
+  workflow_dispatch:
+
+
+
+env:
+  VERSION: 4_1_1
+
+  DOWNLOAD_URL_PREFIX: https://sdna.cardiff.ac.uk/sdna/wp-content/downloads/sDNA_setup_win_v
+#                e.g.: https://sdna.cardiff.ac.uk/sdna/wp-content/downloads/sDNA_setup_win_v4_1_1.msi
+#                  or: https://sdna.cardiff.ac.uk/sdna/wp-content/downloads/old%20versions/sDNA_setup_win_v3_4_5.msi
+
+
+
+jobs:
+
+  download_install_and_test_sDNA_msi:    
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python_version: ['2.7', '3.5', '3.6', '3.7', '3.8', '3.9', '3.10', '3.11', '3.12']
+
+        # cannot install numpy on: ['3.13.0-alpha.4']
+        # https://github.com/JamesParrott/sdna_plus/issues/14
+
+    name: "Download and install a release of sDNA, and run diff tests on it. "
+
+    runs-on: windows-2022
+    # Note:  The Windows server 2022 Github runner image already includes  
+    # Python (currently 6 versions from 3.7 to 3.12) and a couple of 
+    # VC++ redistributables.  Desktop users may need to install these 
+    # themselves, in addition to sDNA.      
+    #
+    # https://github.com/actions/runner-images/blob/main/images/windows/Windows2022-Readme.md
+    #
+    steps:
+
+
+    - uses: actions/checkout@v4
+
+
+    # - name: Download and install release of sDNA, then delete installer file.
+
+    #   run: |
+    #     Invoke-WebRequest ${{ env.DOWNLOAD_URL_PREFIX }}${{ env.VERSION }}.msi -OutFile sDNA_setup_win_v${{ env.VERSION }}.msi
+    #
+    #     # This command is all that is required to successfully run the sDNA installer
+    #     # on desktop Windows 11, silently.  Sadly it is not also sufficient on 
+    #     # the Github Actions Windows runner image (I know not why): 
+    #     .\sDNA_setup_win_v${{ env.VERSION }}.msi /passive
+    #
+    #     Remove-Item .\sDNA_setup_win_v${{ env.VERSION }}.msi
+
+    - name: Install sDNA using powershell script. 
+      # This is @Simran-B's powershell script (from Github Community forum),
+      # according to GuiFalourd on Stack Overflow
+      # https://stackoverflow.com/a/72291019/20785734
+      run: |
+        $file = "sDNA_setup_win_v${{ env.VERSION }}.msi"
+        Invoke-WebRequest ${{ env.DOWNLOAD_URL_PREFIX }}${{ env.VERSION }}.msi -OutFile $file
+        $log = "install.log" 
+        $procMain = Start-Process "msiexec" "/i `"$file`" /qn /l*! `"$log`"" -NoNewWindow -PassThru
+        $procLog = Start-Process "powershell" "Get-Content -Path `"$log`" -Wait" -NoNewWindow -PassThru 
+        $procMain.WaitForExit() 
+        $procLog.Kill()
+        Remove-Item $file
+
+    - name: Run regression tests
+      uses: ./.github/actions/run_regression_tests
+      with:
+        python_version: ${{ matrix.python_version }}
+        DONT_TEST_N_LINK_SUBSYSTEMS_ORDER: 1
+        ALLOW_NEGATIVE_FORMULA_ERROR_ON_ANY_LINK_PRESENT: 1
+        sdnadll: 'c:\Program Files (x86)\sDNA\x64\sdna_vs2008.dll'
+        sdna_debug: ""
+

.gitignore

@@ -11,9 +11,10 @@ UpgradeLog*.htm
 .vs
 .vscode
 vcpkg_installed
-output/
 *testout*
 sDNA/sdna_vs2008/tests/**/odtest.*
-sDNA/sdna_vs2008/tests/**/regtestresids_py3.*
-sDNA/sdna_vs2008/tests/**/tinypred_py3.*
-sDNA/sdna_vs2008/tests/**/geom_test_py3.txt
+sDNA/sdna_vs2008/tests/**/regtestresids_py?.*
+sDNA/sdna_vs2008/tests/**/tinypred_py?.*
+sDNA/sdna_vs2008/tests/**/geom_test_py?.txt
+sDNA/sdna_vs2008/tests/**/out_py?.*
+sDNA/sdna_vs2008/tests/**/tinyout_*

arcscripts/sdnapy.py

@@ -27,7 +27,7 @@ class my_void_p(c_void_p):
 __send_message_callback = None # for global issues only - there are other callbacks in constructor for Calculation()
 
 def set_dll_path(path):
-        if path is not "":
+        if path != "":
                 global __sdna_dll_path
                 __sdna_dll_path = path
 

sDNA/sdna_vs2008/tests/3d_test.py

@@ -1,3 +1,5 @@
+from __future__ import print_function
+
 import sys,arcscriptsdir
 from sdnapy import *
 

sDNA/sdna_vs2008/tests/benchmark_dll.py

@@ -1,3 +1,5 @@
+from __future__ import print_function
+
 import ctypes
 import sys
 import numpy