TT-12: Make WindowEyes Work with GPII

examples/deviceReporter/win32_installedSolutions.json

@@ -4,6 +4,10 @@
         "version": "5.0.0"
     },
     "solutions": [
+        {
+            "id": "com.gwmicro.windoweyes"
+        },
+
         {
             "id": "com.microsoft.windows.magnifier"
         },

testData/deviceReporter/acceptanceTests/windoweyes.JSON

@@ -0,0 +1,3 @@
+[
+    {   "id": "com.gwmicro.windoweyes" }
+]

testData/deviceReporter/installedSolutions.json

@@ -1,4 +1,8 @@
 [
+    {
+        "id": "com.gwmicro.windoweyes"
+    },
+
     {
         "id": "org.gnome.desktop.interface"
     },

testData/preferences/acceptanceTests/windoweyes_application.json

@@ -0,0 +1,16 @@
+{
+    "flat": {
+        "contexts": {
+            "gpii-default": {
+                "name": "Default preferences",
+                "preferences": {
+                    "http://registry.gpii.net/applications/com.gwmicro.windoweyes": {
+                        "we_settings.screen.voice.rate": 4,
+                        "we_settings.screen.voice.pitch": 3,
+                        "we_settings.hot_keys.cursor.key": {"hkid": "10","$t": "Control-Alt-Delete"}
+                    }
+                }
+            }
+        }
+    }
+}

testData/preferences/acceptanceTests/windoweyes_common.JSON

@@ -0,0 +1,14 @@
+{
+    "flat": {
+        "contexts": {
+            "gpii-default": {
+                "name": "Default preferences",
+                "preferences": {
+                    "http://registry.gpii.net/common/speechRate": 4,
+                    "http://registry.gpii.net/common/pitch": "high",
+                    "http://registry.gpii.net/common/hotKey.10": {"hkid": "10","$t": "Control-Alt-Delete"}
+                }
+            }
+        }
+    }
+}

testData/preferences/windoweyes_application.json

@@ -0,0 +1,16 @@
+{
+    "flat": {
+        "contexts": {
+            "gpii-default": {
+                "name": "Default preferences",
+                "preferences": {
+                    "http://registry.gpii.net/applications/com.gwmicro.windoweyes": {
+                        "we_settings.screen.voice.rate": 4,
+                        "we_settings.screen.voice.pitch": 3,
+                        "we_settings.hot_keys.cursor.key": {"hkid": "10","$t": "Control-Alt-Delete"}
+                    }
+                }
+            }
+        }
+    }
+}

testData/preferences/windoweyes_common.JSON

@@ -0,0 +1,14 @@
+{
+    "flat": {
+        "contexts": {
+            "gpii-default": {
+                "name": "Default preferences",
+                "preferences": {
+                    "http://registry.gpii.net/common/speechRate": 4,
+                    "http://registry.gpii.net/common/pitch": "high",
+                    "http://registry.gpii.net/common/hotKey.10": {"hkid": "10","$t": "Control-Alt-Delete"}
+                }
+            }
+        }
+    }
+}

testData/solutions/win32.json

@@ -1,4 +1,77 @@
 {
+    "com.gwmicro.windoweyes": {
+        "name": "Window-Eyes",
+        "contexts": {
+            "OS": [
+                {
+                    "id": "win32"
+                }
+            ]
+        },
+        "settingsHandlers": {
+            "configuration1": {
+                "type": "gpii.settingsHandlers.XMLHandler",
+                "options": {
+                    "filename": "${{environment}.APPDATA}\\GW Micro\\Window-Eyes\\users\\default\\sets.dat"
+                },
+                "capabilities": [
+                    "applications.com\\.gwmicro\\.windoweyes.id",
+                    "display.screenReader.speechRate",
+                    "display.textReadingHighlight.pitch"
+                ],
+
+                "capabilitiesTransformations": {
+                    "we_settings\\.screen\\.voice\\.rate": "http://registry\\.gpii\\.net/common/speechRate",
+                    "we_settings\\.hot_keys\\.cursor.key": "http://registry\\.gpii\\.net/common/hotKey.10",
+                    "we_settings\\.screen\\.voice\\.pitch": {
+                        "transform": {
+                            "type": "fluid.transforms.valueMapper",
+                            "inputPath": "http://registry\\.gpii\\.net/common/pitch",
+                            "options": {
+                                "low": {
+                                    "outputValue": 1
+                                },
+                                "medium": {
+                                    "outputValue": 3
+                                },
+                                "high": {
+                                    "outputValue": 5
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "configure": [
+            "settings.configuration1"
+        ],
+        "restore": [
+            "settings.configuration1"
+        ],
+        "start": [
+            {
+                "type": "gpii.launch.exec",
+                "command": "\"${{registry}.HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\wineyes.exe\\}\""
+            }
+        ],
+        "stop": [
+            {
+                "type": "gpii.windows.killProcessByName",
+                "filename": "wineyes.exe"
+            }
+        ],
+        "isInstalled": [
+            {
+                "type": "gpii.deviceReporter.registryKeyExists",
+                "hKey": "HKEY_LOCAL_MACHINE",
+                "path": "Software\\Microsoft\\Windows\\CurrentVersion\\App Paths\\wineyes.exe",
+                "subPath": "",
+                "dataType": "REG_SZ"
+            }
+        ]
+    },
+
     "com.freedomscientific.jaws": {
         "name": "JAWS",
         "contexts": {

testData/solutions/windoweyes.json

@@ -0,0 +1,63 @@
+{
+    "com.gwmicro.windoweyes": {
+        "name": "Window-Eyes",
+        "contexts": {
+            "OS": [
+                {
+                    "id": "win32"
+                }
+            ]
+        },
+        "settingsHandlers": [
+            {
+                "type": "gpii.settingsHandlers.XMLHandler",
+                "options": {
+                    "filename": "${{environment}.APPDATA}\\GW Micro\\Window-Eyes\\users\\default\\sets.dat"
+                },
+                "capabilities": [
+                    "applications.com\\.gwmicro\\.windoweyes.id",
+                    "display.screenReader.speechRate",
+                    "display.textReadingHighlight.pitch"
+                ],
+
+                "capabilitiesTransformations": {
+                    "we_settings\\.screen\\.voice\\.rate": "http://registry\\.gpii\\.net/common/speechRate",
+                    "we_settings\\.hot_keys\\.cursor.key": "http://registry\\.gpii\\.net/common/hotKey.10",
+                    "we_settings\\.screen\\.voice\\.pitch": {
+                        "transform": {
+                            "type": "fluid.transforms.valueMapper",
+                            "inputPath": "http://registry\\.gpii\\.net/common/pitch",
+                            "options": {
+                                "low": {
+                                    "outputValue": 1
+                                },
+                                "medium": {
+                                    "outputValue": 3
+                                },
+                                "high": {
+                                    "outputValue": 5
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        ],
+        "lifecycleManager": {
+            "start": [
+                "setSettings",
+                {
+                    "type": "gpii.launch.exec",
+                    "command": "\"${{registry}.HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\wineyes.exe\\}\""
+                }
+            ],
+            "stop": [
+                {
+                    "type": "gpii.launch.exec",
+                    "command": "${{environment}.SystemRoot}\\System32\\taskkill.exe /f /im wineyes.exe"
+                },
+                "restoreSettings"
+            ]
+        }
+    }
+}

tests/platform/index-windows.js

@@ -20,10 +20,11 @@ https://github.com/GPII/universal/blob/master/LICENSE.txt
 // This is a useful site for manipulating which test fixtures will run during the development process
 
 module.exports = [
-    "windows/windows-builtIn-testSpec.js",
-    "windows/windows-jaws-testSpec.js",
-    "windows/windows-nvda-testSpec.js",
-    "windows/windows-maavis-testSpec.js",
+	"windows/windows-builtIn-testSpec.js",
+	"windows/windows-jaws-testSpec.js",
+	"windows/windows-nvda-testSpec.js",
+	"windows/windows-maavis-testSpec.js",
     "windows/windows-chrome-testSpec.js",
-    "windows/windows-dynamicDeviceReporter-testSpec.js"
+    "windows/windows-dynamicDeviceReporter-testSpec.js",
+    "windows/windows-windoweyes-testSpec.js"
 ];

tests/platform/windows/configs/windows-windoweyes-config.JSON

@@ -0,0 +1,21 @@
+{
+    "typeName": "acceptanceTests.windows.windoweyes",
+    "options": {
+        "components": {
+            "server": {
+                "options": {
+                    "components": {
+                        "deviceReporter": {
+                            "options": {
+                                "installedSolutionsUrl": "file://%root/../../../testData/deviceReporter/acceptanceTests/windoweyes.json"
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    },
+    "includes": [
+        "${universal}/tests/configs/localInstall.json"
+    ]
+}

tests/platform/windows/windows-windoweyes-testSpec.js

@@ -0,0 +1,89 @@
+/*
+
+GPII Acceptance Testing
+
+Copyright 2014 Raising the Floor International
+
+Licensed under the New BSD license. You may not use this file except in
+compliance with this License.
+
+The research leading to these results has received funding from the European Union's
+Seventh Framework Programme (FP7/2007-2013) under grant agreement no. 289016.
+
+You may obtain a copy of the License at
+https://github.com/GPII/universal/blob/master/LICENSE.txt
+*/
+
+
+"use strict";
+var fluid = require("universal"),
+    gpii = fluid.registerNamespace("gpii");
+
+gpii.loadTestingSupport();
+
+fluid.registerNamespace("gpii.tests.windows");
+
+gpii.tests.windows.windoweyes = [
+    {
+        name: "Testing NP set \"windoweyes_application\" using Flat matchmaker",
+        userToken: "windoweyes_application",
+        settingsHandlers: {
+            "gpii.settingsHandlers.XMLHandler": {
+                "some.app.id": [
+                    {
+                        "settings": {
+                            "we_settings.screen.voice.rate": "4",
+                            "we_settings.screen.voice.pitch": "3",
+                            "we_settings.hot_keys.cursor.key": {"hkid": "10","$t": "Control-Alt-Delete"}
+                        },
+                        "options": {
+                            "filename": "${{environment}.APPDATA}\\GW Micro\\Window-Eyes\\users\\default\\sets.dat"
+                        }
+                    }
+                ]
+            }
+        },
+        processes: [
+            {
+                "command": "tasklist /fi \"STATUS eq RUNNING\" /FI \"IMAGENAME eq wineyes.exe\" | find /I \"wineyes.exe\" /C",
+                "expectConfigured": "1",
+                "expectRestored": "0"
+            }
+        ]
+    }, 
+
+    {
+        name: "Testing NP set \"windoweyes_common\" using Flat matchmaker",
+        userToken: "windoweyes_common",
+        settingsHandlers: {
+            "gpii.settingsHandlers.XMLHandler": {
+                "some.app.id": [
+                    {
+                        "settings": {
+                            "we_settings.screen.voice.rate": "4",
+                            "we_settings.screen.voice.pitch": "5",
+                            "we_settings.hot_keys.cursor.key": {"hkid": "10","$t": "Control-Alt-Delete"}
+                        },
+                        "options": {
+                            "filename": "${{environment}.APPDATA}\\GW Micro\\Window-Eyes\\users\\default\\sets.dat"
+                        }
+                    }
+                ]
+            }
+        },
+        processes: [
+            {
+                "command": "tasklist /fi \"STATUS eq RUNNING\" /FI \"IMAGENAME eq wineyes.exe\" | find /I \"wineyes.exe\" /C",
+                "expectConfigured": "1",
+                "expectRestored": "0"
+            }
+        ]
+    }
+];
+
+module.exports = gpii.test.bootstrap({
+    testDefs:  "gpii.tests.windows.windoweyes",
+    configName: "windows-windoweyes-config",
+    configPath: "configs"
+}, ["gpii.test.integration.testCaseHolder.windows"],
+    module, require, __dirname);

tests/platform/windows/windows-windoweyes-testSpec.txt

@@ -0,0 +1,8 @@
+windows-windoweyes-testSpec.js
+
+Descriptions:
+This will run the acceptance tests for the Window-Eyes (GW Micro). It uses 2 NP sets: windoweyes_common.json and windoweyes_application.json
+
+Prerequisites:
+* Window-Eyes needs to be installed
+