GitHub workflow to test with Micro-Manager

.github/workflows/test_with_mm.yml

@@ -0,0 +1,60 @@
+# This workflow only works on a Windows instance
+# Installs Micro-Manager and tests pycromanager against it
+# Triggered when a PR is closed and merged into main
+
+name: Test with MM
+
+on: [pull_request]
+  # pull_request:
+    # branches: [ main ]
+    # types:
+    #   - closed
+
+env:
+  MM_NIGHTLY_BUILD: 2.0.1_20221121
+
+jobs:
+  test_with_mm:
+    # if: github.event.pull_request.merged == true
+
+    runs-on: windows-latest
+
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10']
+
+    steps: 
+    - name: Cache MM
+      id: cache-mm
+      uses: actions/cache@v3
+      with:
+        path: mmsetup.exe
+        key: ${{ runner.os }}-mm-${MM_NIGHTLY_BUILD}
+
+    - name: Download MM
+      if: steps.cache-mm.outputs.cache-hit != 'true'
+      run: |
+          $mmuri = "https://download.micro-manager.org/nightly/2.0/Windows/MMSetup_64bit_$Env:MM_NIGHTLY_BUILD.exe"
+          aria2c -o mmsetup.exe $mmuri
+
+    - name: Install MM
+      run: |
+        ls .\mmsetup.exe
+        $innoSetupArgs = "/SP /VERYSILENT /SUPRESSMSGBOXES /CURRENTUSER /LOG=mmsetup.log"
+        Start-Process .\mmsetup.exe -ArgumentList $innoSetupArgs -Wait
+        cat .\mmsetup.log
+
+    - uses: actions/checkout@v3
+
+    - uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+
+    - name: Install PM
+      run: |
+        pip install wheel
+        pip install ".[test]"
+
+    - name: Test
+      run: pytest

pycromanager/test/conftest.py

@@ -0,0 +1,21 @@
+from pytest import fixture
+import os
+import glob
+import json
+
+
+# @fixture(scope="session")
+# def enable_zmq():
+#     # FIXME: this enviroment variable only works on Windows
+#     profile_path = os.path.expandvars(r"%LOCALAPPDATA%\Micro-Manager\UserProfiles")
+#     print(os.listdir(profile_path))
+#     profile_file = glob.glob(os.path.join(profile_path, "Default_*.json"))[0]
+#     with open(profile_file, "r") as f:
+#         profile = json.load(f)
+#     profile["map"]["Preferences"]["scalar"]["org.micromanager.internal.MMStudio"][
+#         "scalar"
+#     ]["run ZQM server"][
+#         "scalar"
+#     ] = True  # TODO: "ZQM" is an upstream typo https://github.com/micro-manager/micro-manager/issues/1574
+#     with open(profile_file, "w") as f:
+#         json.dump(profile, f)

pycromanager/test/test_acq_util.py

@@ -0,0 +1,10 @@
+import os
+
+# tested code
+from pycromanager import start_headless
+
+
+def test_start_headless():
+    mm_app_path = r"C:\Program Files\Micro-Manager-2.0"
+    config_file = os.path.join(mm_app_path, "MMConfig_demo.cfg")
+    start_headless(mm_app_path, config_file, timeout=10000)