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 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""Tests for the Virtual Windows Registry key implementation."""
from __future__ import unicode_literals
import unittest
from dfwinreg import registry
from dfwinreg import virtual
from tests import registry as test_registry
from tests import test_lib
class TestWinRegistry(object):
"""Windows Registry for testing."""
# pylint: disable=redundant-returns-doc,unused-argument
def GetKeyByPath(self, key_path):
"""Retrieves the key for a specific path.
Args:
key_path (str): Windows Registry key path.
Returns:
WinRegistryKey: Windows Registry key or None if not available.
Raises:
RuntimeError: if the root key is not supported.
"""
return None
class ErrorWinRegistry(object):
"""Windows Registry for testing that fails."""
# pylint: disable=redundant-returns-doc,unused-argument
def GetKeyByPath(self, key_path):
"""Retrieves the key for a specific path.
Args:
key_path (str): Windows Registry key path.
Returns:
WinRegistryKey: Windows Registry key or None if not available.
Raises:
RuntimeError: if the root key is not supported.
"""
raise RuntimeError('Not supported for testing')
class VirtualWinRegistryKeyTest(test_lib.BaseTestCase):
"""Tests for a virtual Windows Registry key."""
# pylint: disable=protected-access
def _CreateTestKey(self):
"""Creates a virtual Windows Registry key.
Returns:
VirtualWinRegistryKey: virtual Windows Registry key.
"""
registry_key = virtual.VirtualWinRegistryKey(
'HKEY_LOCAL_MACHINE', key_path='HKEY_LOCAL_MACHINE')
sub_registry_key = virtual.VirtualWinRegistryKey('System')
registry_key.AddSubkey(sub_registry_key)
sub_registry_key = virtual.VirtualWinRegistryKey('Software')
registry_key.AddSubkey(sub_registry_key)
test_registry_key = virtual.VirtualWinRegistryKey('Classes')
sub_registry_key.AddSubkey(test_registry_key)
return registry_key
def _CreateTestKeyWithMappedRegistry(self):
"""Creates a virtual Windows Registry key with a mapped registry.
Returns:
VirtualWinRegistryKey: virtual Windows Registry key.
"""
registry_key = virtual.VirtualWinRegistryKey(
'HKEY_LOCAL_MACHINE', key_path='HKEY_LOCAL_MACHINE')
win_registry = registry.WinRegistry(
registry_file_reader=test_registry.TestWinRegistryFileReader())
test_path = self._GetTestFilePath(['SYSTEM'])
registry_file = win_registry._OpenFile(test_path)
key_path_prefix = win_registry.GetRegistryFileMapping(registry_file)
win_registry.MapFile(key_path_prefix, registry_file)
sub_registry_key = virtual.VirtualWinRegistryKey(
'System', registry=win_registry)
registry_key.AddSubkey(sub_registry_key)
return registry_key
@test_lib.skipUnlessHasTestFile(['SYSTEM'])
def testLastWrittenTime(self):
"""Tests the last_written_time property."""
registry_key = self._CreateTestKeyWithMappedRegistry()
mapped_key = registry_key.GetSubkeyByName('System')
self.assertIsNotNone(mapped_key)
self.assertIsNotNone(mapped_key.last_written_time)
@test_lib.skipUnlessHasTestFile(['SYSTEM'])
def testNumberOfSubkeys(self):
"""Tests the number_of_subkeys property."""
registry_key = self._CreateTestKeyWithMappedRegistry()
mapped_key = registry_key.GetSubkeyByName('System')
self.assertIsNotNone(mapped_key)
self.assertEqual(mapped_key.number_of_subkeys, 8)
@test_lib.skipUnlessHasTestFile(['SYSTEM'])
def testNumberOfValues(self):
"""Tests the number_of_values property."""
registry_key = self._CreateTestKeyWithMappedRegistry()
mapped_key = registry_key.GetSubkeyByName('System')
self.assertIsNotNone(mapped_key)
self.assertEqual(mapped_key.number_of_values, 0)
# Test virtual key fallback.
registry_key = self._CreateTestKey()
self.assertIsNotNone(registry_key)
self.assertEqual(registry_key.number_of_values, 0)
@test_lib.skipUnlessHasTestFile(['SYSTEM'])
def testOffset(self):
"""Tests the offset property."""
registry_key = self._CreateTestKeyWithMappedRegistry()
mapped_key = registry_key.GetSubkeyByName('System')
self.assertIsNotNone(mapped_key)
self.assertEqual(mapped_key.offset, 4132)
@test_lib.skipUnlessHasTestFile(['SYSTEM'])
def testPropertiesWithMappedRegistry(self):
"""Tests the properties with a mapped registry."""
registry_key = self._CreateTestKeyWithMappedRegistry()
mapped_key = registry_key.GetSubkeyByName('System')
self.assertIsNotNone(mapped_key)
self.assertIsNotNone(mapped_key.last_written_time)
timestamp = mapped_key.last_written_time.timestamp
self.assertEqual(timestamp, 129955760615200288)
self.assertEqual(mapped_key.number_of_subkeys, 8)
self.assertEqual(mapped_key.number_of_values, 0)
self.assertEqual(mapped_key.offset, 4132)
@test_lib.skipUnlessHasTestFile(['SYSTEM'])
def testGetKeyFromRegistry(self):
"""Tests the _GetKeyFromRegistry function."""
registry_key = self._CreateTestKeyWithMappedRegistry()
mapped_key = registry_key.GetSubkeyByName('System')
self.assertIsNotNone(mapped_key)
self.assertEqual(len(mapped_key._subkeys), 0)
mapped_key._GetKeyFromRegistry()
self.assertEqual(len(mapped_key._subkeys), 8)
registry_key = virtual.VirtualWinRegistryKey(
'HKEY_LOCAL_MACHINE', key_path='')
registry_key._GetKeyFromRegistry()
test_win_registry = TestWinRegistry()
registry_key = virtual.VirtualWinRegistryKey(
'HKEY_LOCAL_MACHINE', key_path='', registry=test_win_registry)
registry_key._GetKeyFromRegistry()
test_win_registry = ErrorWinRegistry()
registry_key = virtual.VirtualWinRegistryKey(
'HKEY_LOCAL_MACHINE', key_path='', registry=test_win_registry)
registry_key._GetKeyFromRegistry()
def testJoinKeyPath(self):
"""Tests the _JoinKeyPath function."""
registry_key = virtual.VirtualWinRegistryKey(
'HKEY_LOCAL_MACHINE', key_path='')
expected_path = 'HKEY_LOCAL_MACHINE\\Software'
path = registry_key._JoinKeyPath(['HKEY_LOCAL_MACHINE', 'Software'])
self.assertEqual(path, expected_path)
def testAddSubkey(self):
"""Tests the AddSubkey function."""
registry_key = virtual.VirtualWinRegistryKey(
'HKEY_LOCAL_MACHINE', key_path='')
sub_registry_key = virtual.VirtualWinRegistryKey(
'System', key_path='HKEY_LOCAL_MACHINE')
registry_key.AddSubkey(sub_registry_key)
with self.assertRaises(KeyError):
registry_key.AddSubkey(sub_registry_key)
def testGetSubkeyByIndex(self):
"""Tests the GetSubkeyByIndex function."""
registry_key = self._CreateTestKey()
sub_registry_key = registry_key.GetSubkeyByIndex(0)
self.assertIsNotNone(sub_registry_key)
expected_key_path = 'HKEY_LOCAL_MACHINE\\System'
self.assertEqual(sub_registry_key.path, expected_key_path)
with self.assertRaises(IndexError):
registry_key.GetSubkeyByIndex(-1)
@test_lib.skipUnlessHasTestFile(['SYSTEM'])
def testGetSubkeyByIndexWithMappedRegistry(self):
"""Tests the GetSubkeyByIndex function with a mapped registry."""
registry_key = self._CreateTestKeyWithMappedRegistry()
mapped_key = registry_key.GetSubkeyByName('System')
self.assertIsNotNone(mapped_key)
sub_registry_key = mapped_key.GetSubkeyByIndex(0)
self.assertIsNotNone(sub_registry_key)
def testGetSubkeyByName(self):
"""Tests the GetSubkeyByName function."""
registry_key = self._CreateTestKey()
sub_registry_key = registry_key.GetSubkeyByName('Software')
self.assertIsNotNone(sub_registry_key)
expected_key_path = 'HKEY_LOCAL_MACHINE\\Software'
self.assertEqual(sub_registry_key.path, expected_key_path)
sub_registry_key = registry_key.GetSubkeyByName('Bogus')
self.assertIsNone(sub_registry_key)
@test_lib.skipUnlessHasTestFile(['SYSTEM'])
def testGetSubkeyByNameWithMappedRegistry(self):
"""Tests the GetSubkeyByName function with a mapped registry."""
registry_key = self._CreateTestKeyWithMappedRegistry()
mapped_key = registry_key.GetSubkeyByName('System')
self.assertIsNotNone(mapped_key)
sub_registry_key = mapped_key.GetSubkeyByName('ControlSet001')
self.assertIsNotNone(sub_registry_key)
def testGetSubkeyByPath(self):
"""Tests the GetSubkeyByPath function."""
registry_key = self._CreateTestKey()
key_path = 'Software\\Classes'
sub_registry_key = registry_key.GetSubkeyByPath(key_path)
self.assertIsNotNone(sub_registry_key)
self.assertEqual(sub_registry_key.name, 'Classes')
expected_key_path = (
'HKEY_LOCAL_MACHINE\\Software\\Classes')
self.assertEqual(sub_registry_key.path, expected_key_path)
key_path = 'Software\\Bogus'
sub_registry_key = registry_key.GetSubkeyByPath(key_path)
self.assertIsNone(sub_registry_key)
@test_lib.skipUnlessHasTestFile(['SYSTEM'])
def testGetSubkeyByPathWithMappedRegistry(self):
"""Tests the GetSubkeyByPath function with a mapped registry."""
registry_key = self._CreateTestKeyWithMappedRegistry()
mapped_key = registry_key.GetSubkeyByName('System')
self.assertIsNotNone(mapped_key)
sub_registry_key = mapped_key.GetSubkeyByPath('ControlSet001\\Control')
self.assertIsNotNone(sub_registry_key)
def testGetSubkeys(self):
"""Tests the GetSubkeys function."""
registry_key = self._CreateTestKey()
sub_registry_keys = list(registry_key.GetSubkeys())
self.assertEqual(len(sub_registry_keys), 2)
@test_lib.skipUnlessHasTestFile(['SYSTEM'])
def testGetSubkeysWithMappedRegistry(self):
"""Tests the GetSubkeys function with a mapped registry."""
registry_key = self._CreateTestKeyWithMappedRegistry()
mapped_key = registry_key.GetSubkeyByName('System')
self.assertIsNotNone(mapped_key)
sub_registry_keys = list(mapped_key.GetSubkeys())
self.assertEqual(len(sub_registry_keys), 8)
def testGetValueByName(self):
"""Tests the GetValueByName function."""
registry_key = self._CreateTestKey()
registry_value = registry_key.GetValueByName('')
self.assertIsNone(registry_value)
@test_lib.skipUnlessHasTestFile(['SYSTEM'])
def testGetValueByNameWithMappedRegistry(self):
"""Tests the GetValueByName function with a mapped registry."""
registry_key = self._CreateTestKeyWithMappedRegistry()
mapped_key = registry_key.GetSubkeyByName('System')
self.assertIsNotNone(mapped_key)
registry_value = mapped_key.GetValueByName('')
self.assertIsNone(registry_value)
def testGetValues(self):
"""Tests the GetValues function."""
registry_key = self._CreateTestKey()
values = list(registry_key.GetValues())
self.assertEqual(len(values), 0)
@test_lib.skipUnlessHasTestFile(['SYSTEM'])
def testGetValuesWithMappedRegistry(self):
"""Tests the GetValues function with a mapped registry."""
registry_key = self._CreateTestKeyWithMappedRegistry()
mapped_key = registry_key.GetSubkeyByName('System')
self.assertIsNotNone(mapped_key)
values = list(mapped_key.GetValues())
self.assertEqual(len(values), 0)
if __name__ == '__main__':
unittest.main()
|