.github: Test with onsdriver

Author: norihiro

.github/workflows/main.yml

@@ -75,6 +75,27 @@ jobs:
           fi
           ls /usr/share/obs/obs-plugins/${PLUGIN_NAME}/
 
+      - name: 'Setup with onsdriver'
+        uses: noris-plugins-for-obs/onsdriver@v0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          first-time-log: ./logs/
+
+      - name: 'Test with onsdriver'
+        run: |
+          python -m pip install Pillow
+          xvfb-run -s '-screen 0 1080x768x24' python -m unittest discover test-onsdriver/
+
+      - name: 'Upload logs of onsdriver'
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-${{ env.artifactName }}-linux-obs${{ matrix.obs }}-${{ matrix.ubuntu }}
+          path: |
+            logs/*
+            screenshots/*
+
   macos_build:
     runs-on: macos-14
     strategy:
@@ -215,6 +236,28 @@ jobs:
           name: ${{ env.artifactName }}-macos-obs${{ matrix.obs }}-${{ matrix.arch }}
           path: package/*
 
+      - name: 'Setup with onsdriver'
+        uses: noris-plugins-for-obs/onsdriver@v0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          obs-plugins: package/*.zip
+          first-time-log: ./logs/
+
+      - name: 'Test with onsdriver'
+        run: |
+          python -m pip install Pillow
+          python -m unittest discover test-onsdriver/
+
+      - name: 'Upload logs of onsdriver'
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-${{ env.artifactName }}-macos-obs${{ matrix.obs }}-${{ matrix.arch }}
+          path: |
+            logs/*
+            screenshots/*
+
   windows_build:
     runs-on: windows-2022
     strategy:
@@ -254,3 +297,25 @@ jobs:
         with:
           name: ${{ env.artifactName }}-windows-obs${{ matrix.obs }}-${{ matrix.arch }}
           path: package/*
+
+      - name: 'Setup with onsdriver'
+        uses: noris-plugins-for-obs/onsdriver@v0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          obs-plugins: package/*.zip
+          first-time-log: ./logs/
+
+      - name: 'Test with onsdriver'
+        run: |
+          python -m pip install Pillow
+          python -m unittest discover test-onsdriver/
+
+      - name: 'Upload logs of onsdriver'
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-${{ env.artifactName }}-windows-obs${{ matrix.obs }}-${{ matrix.arch }}
+          path: |
+            logs/*
+            screenshots/*

.gitignore

@@ -5,3 +5,4 @@
 
 .vscode
 .idea
+__pycache__

test-onsdriver/test_color_monitor.py

@@ -0,0 +1,70 @@
+'''
+Test Color Monitor plugin
+'''
+
+import time
+import unittest
+from onsdriver import obstest, obsui
+
+
+class ColorMonitorTest(obstest.OBSTest):
+    'Test plain features of OBS Studio'
+
+    def setUp(self, config_name='saved-config', run=True):
+        super().setUp(run=False, config_name=config_name)
+
+        if run:
+            self.obs.run()
+
+    def test_dock(self):
+        'Create the dock'
+        cl = self.obs.get_obsws()
+        ui = obsui.OBSUI(cl)
+
+        scene = 'Scene'
+        name = 'Color Source'
+        cl.send('CreateInput', {
+            'inputName': name,
+            'sceneName': scene,
+            'inputKind': 'color_source_v3',
+            'inputSettings': {
+                'color': 0xFFD7CCC6,
+                'width': 640,
+                'height': 360,
+            },
+        })
+
+        ui.request('menu-trigger', {
+            'path': [
+                {"text": "&Tools"},
+                {"text": "New Scope Dock...", "objectName": "actionScopeDockNew"},
+            ]
+        })
+
+        ui.request('widget-invoke', {
+            'path': [
+                {"className": "ScopeDockNewDialog"},
+                {"className": "QDialogButtonBox"},
+                {"className": "QPushButton", "default": True},
+            ],
+            'method': 'click',
+        })
+
+        time.sleep(1)
+
+        dock_path = [
+            {"className": "OBSDock"},
+            {"className": "ScopeWidget"},
+        ]
+
+        ui.grab(path=dock_path, filename=f'screenshots/{self.name}-window.png', window=True)
+
+        try:
+            ui.grab(path=dock_path, filename=f'screenshots/{self.name}-pillow.png', pillow=True)
+        except (ImportError, OSError) as e:
+            # OSError: X connection failed on Linux if DISPLAY is not set.
+            print(e)
+
+
+if __name__ == '__main__':
+    unittest.main()