all files / registrySettingsHandler/test/ testRegistrySettingsHandler.js

100% Statements 50/50
100% Branches 0/0
100% Functions 4/4
100% Lines 50/50
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
/*
 * Windows Registry Settings Handler
 *
 * 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");
 
var jqUnit = fluid.require("node-jqunit");
var gpii = fluid.registerNamespace("gpii");
 
require("../src/RegistrySettingsHandler.js");
 
fluid.registerNamespace("gpii.tests.windows.registrySettingsHandler");
 
jqUnit.module("RegistrySettingsHandler Module");
 
gpii.tests.windows.registrySettingsHandler.apiTest = {
    init: {
        "settings": {
            "FollowMouse": 1,
            "Invert": 0,
            "Magnification": 225
        },
        "options": {
            "hKey": "HKEY_CURRENT_USER",
            "path": "Software\\GPIIMagnifier",
            "dataTypes": {
                "FollowMouse": "REG_DWORD",
                "Invert":  "REG_DWORD",
                "Magnification":  "REG_DWORD"
            }
        }
    },
    set: {
        payload: {
            "com.windows.magnifier": [{
                "settings": {
                    "FollowMouse": 0,
                    "Invert": 1,
                    "Magnification": 235
                },
                "options": {
                    "hKey": "HKEY_CURRENT_USER",
                    "path": "Software\\GPIIMagnifier",
                    "dataTypes": {
                        "FollowMouse": "REG_DWORD",
                        "Invert":  "REG_DWORD",
                        "Magnification":  "REG_DWORD"
                    }
                }
            }]
        },
        expectedResult: {
            "com.windows.magnifier": [{
                "settings": {
                    "FollowMouse": {
                        "oldValue": 1,
                        "statusCode": 200,
                        "newValue": 0
                    },
                    "Invert": {
                        "oldValue": 0,
                        "statusCode": 200,
                        "newValue": 1
                    },
                    "Magnification": {
                        "oldValue": 225,
                        "statusCode": 200,
                        "newValue": 235
                    }
                }
            }]
        }
    },
    get: {
        payload: {
            "com.windows.magnifier": [{
                "settings": {
                    "FollowMouse": {
                        "dataType": "REG_DWORD"
                    },
                    "Invert": {
                        "dataType": "REG_DWORD"
                    },
                    "Magnification": {
                        "dataType": "REG_DWORD"
                    }
                },
                "options": {
                    "hKey": "HKEY_CURRENT_USER",
                    "path": "Software\\GPIIMagnifier",
                    "dataTypes": {
                        "FollowMouse": "REG_DWORD",
                        "Invert":  "REG_DWORD",
                        "Magnification":  "REG_DWORD"
                    }
                }
            }]
        },
        expectedResult: {
            "com.windows.magnifier": [{
                "settings": {
                    "FollowMouse": 1,
                    "Invert": 0,
                    "Magnification": 225
                }
            }]
        }
    }
};
 
gpii.tests.windows.registrySettingsHandler.handlerOneTest = {
    initPayload: {
        "settings": {
            "FollowMouse": 1,
            "Invert": 0,
            "Magnification": 255
        },
        "options": {
            "hKey": "HKEY_CURRENT_USER",
            "path": "Software\\GPIIMagnifier",
            "dataTypes": {
                "FollowMouse": "REG_DWORD",
                "Invert":  "REG_DWORD",
                "Magnification":  "REG_DWORD"
            }
        }
    },
    setPayload: {
        "settings": {
            "FollowMouse": 0,
            "Invert": 1
        },
        "options": {
            "hKey": "HKEY_CURRENT_USER",
            "path": "Software\\GPIIMagnifier",
            "dataTypes": {
                "FollowMouse": "REG_DWORD",
                "Invert":  "REG_DWORD",
                "Magnification":  "REG_DWORD"
            }
        }
    },
    expectedReturn: {
        "FollowMouse": {
            "oldValue": 1,
            "statusCode": 200,
            "newValue": 0
        },
        "Invert": {
            "oldValue": 0,
            "statusCode": 200,
            "newValue": 1
        }
    }
};
 
gpii.tests.windows.registrySettingsHandler.enumerationTest = {
    initPayload: {
        "settings": {
            "FollowMouse": 1,
            "Invert": 0,
            "Magnification": 255,
            "Description": "GPII Magnifier"
        },
        "options": {
            "hKey": "HKEY_CURRENT_USER",
            "path": "Software\\GPIIMagnifier",
            "dataTypes": {
                "FollowMouse": "REG_DWORD",
                "Invert":  "REG_DWORD",
                "Magnification":  "REG_DWORD",
                "Description": "REG_SZ"
            }
        },
        "count": 4
    },
    expectedReturn: {
        "FollowMouse": {
            "data": 1,
            "bytes": 4,
            "name": "FollowMouse",
            "type": "REG_DWORD"
        },
        "Invert": {
            "data": 0,
            "bytes": 4,
            "name": "Invert",
            "type": "REG_DWORD"
        },
        "Magnification": {
            "data": 255,
            "bytes": 4,
            "name": "Magnification",
            "type": "REG_DWORD"
        },
        "Description": {
            "data": "GPII Magnifier",
            "bytes": 30,
            "name": "Description",
            "type": "REG_SZ"
        }
    }
};
 
jqUnit.test("Testing registrySettingsHandler.setImpl incl undefined value.value", function () {
    jqUnit.expect(1);
 
    // set to initial values:
    gpii.windows.registrySettingsHandler.setImpl(gpii.tests.windows.registrySettingsHandler.handlerOneTest.initPayload);
    // now that we 'know' current values, set new ones:
    var actualReturn = gpii.windows.registrySettingsHandler.setImpl(gpii.tests.windows.registrySettingsHandler.handlerOneTest.setPayload);
    // check results
    jqUnit.assertDeepEq("Checking return payload", gpii.tests.windows.registrySettingsHandler.handlerOneTest.expectedReturn, gpii.resolveSync(actualReturn));
    // cleanup
    gpii.windows.deleteRegistryKey("HKEY_CURRENT_USER", "Software\\GPIIMagnifier");
});
 
jqUnit.test("Reading and writing single registry keys", function () {
    jqUnit.expect(5);
 
    var dwordValue = 100;
    gpii.windows.writeRegistryKey("HKEY_CURRENT_USER", "Software\\GPIIMagnifier", "Magnification", dwordValue, "REG_DWORD");
    var value = gpii.windows.readRegistryKey("HKEY_CURRENT_USER", "Software\\GPIIMagnifier", "Magnification", "REG_DWORD");
    jqUnit.assertEquals("Assert REG_DWORD", dwordValue, value.value);
 
    var unicodeString = "I am Agent Гюнтер";
    gpii.windows.writeRegistryKey("HKEY_CURRENT_USER", "Software\\GPIIMagnifier", "MagnificationAnnotation", unicodeString, "REG_SZ");
    var value2 = gpii.windows.readRegistryKey("HKEY_CURRENT_USER", "Software\\GPIIMagnifier", "MagnificationAnnotation", "REG_SZ");
    jqUnit.assertEquals("Assert REG_SZ", unicodeString, value2.value);
 
    gpii.windows.writeRegistryKey("HKEY_CURRENT_USER", "Software\\GPIIMagnifier", "MagnificationBinary", "0a, b0, cAfebAbe", "REG_BINARY");
    var value3 = gpii.windows.readRegistryKey("HKEY_CURRENT_USER", "Software\\GPIIMagnifier", "MagnificationBinary", "REG_BINARY");
    jqUnit.assertEquals("Assert REG_BINARY", "0a b0 ca fe ba be", value3.value);
 
    gpii.windows.writeRegistryKey("HKEY_CURRENT_USER", "Software\\GPIIMagnifier", "Magnification", undefined, "REG_DWORD");
    var value4 = gpii.windows.readRegistryKey("HKEY_CURRENT_USER", "Software\\GPIIMagnifier", "Magnification", "REG_DWORD");
    jqUnit.assertDeepEq("Assert value not found after deleted", {statusCode: 404}, value4);
 
    // clean up after ourselves
    gpii.windows.deleteRegistryKey("HKEY_CURRENT_USER", "Software\\GPIIMagnifier");
 
    // test for GPII-1108 - deletion of subkey of nonexistent parent should be permitted
    gpii.windows.writeRegistryKey("HKEY_CURRENT_USER", "Software\\GPIIMagnifier", "Magnification", undefined, "REG_DWORD");
    jqUnit.assert("Deletion of subkey of nonexistent parent should be valid noop");
 
});
 
 
jqUnit.test("Testing registrySettingsHandler API (get and set functions)", function () {
    jqUnit.expect(2);
 
    // set to initial values:
    gpii.windows.registrySettingsHandler.setImpl(gpii.tests.windows.registrySettingsHandler.apiTest.init);
    // First we test the get functionality
    var result = gpii.windows.registrySettingsHandler.get(gpii.tests.windows.registrySettingsHandler.apiTest.get.payload);
    // check results
    jqUnit.assertDeepEq("Checking return payload of get", gpii.tests.windows.registrySettingsHandler.apiTest.get.expectedResult, gpii.resolveSync(result));
 
    // Test set functionality
    var result2 = gpii.windows.registrySettingsHandler.set(gpii.tests.windows.registrySettingsHandler.apiTest.set.payload);
    // check results
    jqUnit.assertDeepEq("Checking return payload of set", gpii.tests.windows.registrySettingsHandler.apiTest.set.expectedResult, gpii.resolveSync(result2));
    // cleanup
    gpii.windows.deleteRegistryKey("HKEY_CURRENT_USER", "Software\\GPIIMagnifier");
});
 
jqUnit.test("Enumerating registry key values", function () {
 
    var testData = gpii.tests.windows.registrySettingsHandler.enumerationTest;
    var baseKey = testData.initPayload.options.hKey;
    var path = testData.initPayload.options.path;
 
    // Apply the data
    gpii.windows.registrySettingsHandler.setImpl(testData.initPayload);
 
    // Enumerate the key
    var result = gpii.windows.enumRegistryValues(baseKey, path);
 
    // Check the result
    jqUnit.assertDeepEq("Checking the return of enumRegistryValues", testData.expectedReturn, result);
 
    // Clean up
    gpii.windows.deleteRegistryKey("HKEY_CURRENT_USER", "Software\\GPIIMagnifier");
});