Fix and test sdist builds; reduce sdist size

.github/workflows/build_upload_pypi_wheels.yml

@@ -6,7 +6,29 @@ on:
   workflow_dispatch:
 
 jobs:
-  build:
+  build-sdist:
+    name: Build sdist
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Ensure tags are fetched for versioning
+
+      - name: Create source distribution
+        shell: bash -l {0}
+        run: |
+          pipx run build --sdist .
+
+      - name: Upload source dist as build artifact
+        uses: actions/upload-artifact@v4
+        with:
+            name: python-source-distribution
+            path: dist/
+            if-no-files-found: error
+
+  build-wheels:
+    needs: build-sdist
     strategy:
       matrix:
         os: [windows-latest, macos-13, macos-latest, ubuntu-latest]
@@ -33,13 +55,29 @@ jobs:
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout project (for test files)
+        uses: actions/checkout@v4
+
+      - name: Delete source (to ensure we are using sdist only)
+        shell: bash -l {0}
+        run: rm -rf euphonic
+
+      - name: Download sdist
+        uses: actions/download-artifact@v4
         with:
-          fetch-depth: 0 # Ensure tags are fetched for versioning
+          name: python-source-distribution
+          path: dist/
+
+      - name: Get sdist filename
+        shell: bash -l {0}
+        run: |
+          echo EUPHONIC_SDIST="$(find dist/ -name 'euphonic*.tar.gz')" >> $GITHUB_ENV
+
       - name: Setup Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Install llvm on Macos
         if: startsWith(matrix.os, 'macos')
         shell: bash -l {0}
@@ -75,7 +113,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip build wheel twine
 
-      - name: Build wheels
+      - name: Build wheels from sdist
         uses: pypa/[email protected]
         env:
           CIBW_BUILD_FRONTEND: build
@@ -90,19 +128,7 @@ jobs:
 
         with:
           output-dir: wheelhouse
-
-      - name: Create source distribution
-        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11'
-        shell: bash -l {0}
-        run: |
-          python -m build --sdist .
-
-      - name: Upload source dist as build artifact
-        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11' && github.event_name == 'release'
-        uses: actions/upload-artifact@v4
-        with:
-            name: python-source-distribution
-            path: dist
+          package-dir: ${{ env.EUPHONIC_SDIST }}
 
       - name: Upload wheels as build artifacts
         uses: actions/upload-artifact@v4
@@ -111,9 +137,67 @@ jobs:
             path: wheelhouse/*-${{ matrix.wheelname }}*_${{ matrix.cibw_archs }}.whl
             if-no-files-found: error
 
+  test-sdist:
+    needs: build-sdist
+    name: Test build from sdist on Windows
+    runs-on: windows-latest
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Find MSVC and set environment variables
+        shell: bash -l {0}
+        env:
+          MSVC_PREFIX: 'C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Tools\MSVC'
+        run: |
+          echo "Available MSVC installations:"
+          ls "$MSVC_PREFIX"
+
+          MSVC_BIN=$(ls "$MSVC_PREFIX" | tail -n 1)\\bin\\HostX64\\x64
+          CC="$MSVC_PREFIX\\$MSVC_BIN\\cl.exe"
+          echo "CC: $CC"
+          echo "CC=$CC" >> $GITHUB_ENV
+
+          CC_LD="$MSVC_PREFIX\\$MSVC_BIN\\link.exe"
+          echo "CC_LD: $CC_LD"
+          echo "CC_LD=$CC_LD" >> $GITHUB_ENV
+
+      - name: Download sdist
+        uses: actions/download-artifact@v4
+        with:
+          path: dist/
+          merge-multiple: true
+
+      - name: List downloaded sdist
+        run: |
+          ls -R dist/
+
+      - name: Update pip
+        shell: bash -l {0}
+        run: |
+          python -m pip install --upgrade pip
+
+      - name: Install from sdist
+        shell: bash -l {0}
+        run: python -m pip install $(find dist -name 'euphonic-*.tar.gz')[matplotlib,phonopy_reader,brille,test]
+
+      - name: Checkout repository (for tests and test data)
+        uses: actions/checkout@v4
+
+      - name: Delete source (to ensure we are testing INSTALLED version)
+        shell: bash -l {0}
+        run: rm -rf euphonic
+
+      - name: run tests
+        shell: bash -l {0}
+        run: python tests_and_analysis/test/run_tests.py --report
+
+
   publish:
     if: github.event_name == 'release'
-    needs: build
+    needs: [build-wheels,test-sdist]
     name: Upload release to PyPI
     runs-on: ubuntu-latest
     environment:
@@ -134,7 +218,7 @@ jobs:
           merge-multiple: true
 
       - name: List Files
-        run: ls -R
+        run: ls -R dist/
 
       - name: Upload wheels to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

CHANGELOG.rst

@@ -1,6 +1,16 @@
 `Unreleased <https://github.com/pace-neutrons/Euphonic/compare/v1.4.0...HEAD>`_
 -------------------------------------------------------------------------------
 
+- Bug fixes
+
+  - Fixed a bug in the version numbering mechanism affecting source
+    builds on Windows and environments where Git is unavailable
+
+- Maintenance
+
+  - Source builds automatically tested on Windows as part of
+    build/deployment process
+
 `v1.4.0 <https://github.com/pace-neutrons/Euphonic/compare/v1.3.2...v1.4.0>`_
 -----------------------------------------------------------------------------
 

build_utils/version.py

@@ -39,12 +39,17 @@
 
 for gitcmd in gits:
     try:
+        print(f"Trying {gitcmd} ...", file=sys.stderr)
         proc = subprocess.run([gitcmd, "describe", "--tags", "--dirty"],
                               capture_output=True, check=True, text=True)
-    except subprocess.CalledProcessError as err:
+    except FileNotFoundError as err:
+        print(f"Tried {gitcmd}, File Not Found", file=sys.stderr)
+        continue
+
+    except (subprocess.CalledProcessError) as err:
         print(f"Tried {gitcmd}, returned: {err}", file=sys.stderr)
         print(f"Stdout: '{err.stdout.strip()}'", file=sys.stderr)
-        print(f"Stdout: '{err.stderr.strip()}'", file=sys.stderr)
+        print(f"Stderr: '{err.stderr.strip()}'", file=sys.stderr)
         continue
 
     version, *dirty = proc.stdout.strip().split("-")
@@ -53,6 +58,7 @@
     break
 
 else:  # Can't use git
+    print("All git implementations failed, reading version file", file=sys.stderr)
     version = version_file.read_text().split("=")[1].strip('"\n ')
 
 match COMMAND:

tests_and_analysis/tox_requirements.txt

@@ -1,10 +1,9 @@
 mock
-pytest~=7.0
+pytest==7.*
 coverage
 pytest-mock
 pytest-lazy-fixture
 pytest-xvfb
 python-slugify
-toolz
 wheel==0.43
 setuptools==71.1.0