+++ /dev/null
-# Test the windows specific win32reg module.\r
-# Only win32reg functions not hit here: FlushKey, LoadKey and SaveKey\r
-\r
-import os, sys\r
-import unittest\r
-from test import test_support\r
-threading = test_support.import_module("threading")\r
-from platform import machine\r
-\r
-# Do this first so test will be skipped if module doesn't exist\r
-test_support.import_module('_winreg')\r
-# Now import everything\r
-from _winreg import *\r
-\r
-try:\r
- REMOTE_NAME = sys.argv[sys.argv.index("--remote")+1]\r
-except (IndexError, ValueError):\r
- REMOTE_NAME = None\r
-\r
-# tuple of (major, minor)\r
-WIN_VER = sys.getwindowsversion()[:2]\r
-# Some tests should only run on 64-bit architectures where WOW64 will be.\r
-WIN64_MACHINE = True if machine() == "AMD64" else False\r
-\r
-# Starting with Windows 7 and Windows Server 2008 R2, WOW64 no longer uses\r
-# registry reflection and formerly reflected keys are shared instead.\r
-# Windows 7 and Windows Server 2008 R2 are version 6.1. Due to this, some\r
-# tests are only valid up until 6.1\r
-HAS_REFLECTION = True if WIN_VER < (6, 1) else False\r
-\r
-test_key_name = "SOFTWARE\\Python Registry Test Key - Delete Me"\r
-# On OS'es that support reflection we should test with a reflected key\r
-test_reflect_key_name = "SOFTWARE\\Classes\\Python Test Key - Delete Me"\r
-\r
-test_data = [\r
- ("Int Value", 45, REG_DWORD),\r
- ("String Val", "A string value", REG_SZ),\r
- ("StringExpand", "The path is %path%", REG_EXPAND_SZ),\r
- ("Multi-string", ["Lots", "of", "string", "values"], REG_MULTI_SZ),\r
- ("Raw Data", ("binary"+chr(0)+"data"), REG_BINARY),\r
- ("Big String", "x"*(2**14-1), REG_SZ),\r
- ("Big Binary", "x"*(2**14), REG_BINARY),\r
-]\r
-\r
-if test_support.have_unicode:\r
- test_data += [\r
- (unicode("Unicode Val"), unicode("A Unicode value"), REG_SZ,),\r
- ("UnicodeExpand", unicode("The path is %path%"), REG_EXPAND_SZ),\r
- ("Multi-unicode", [unicode("Lots"), unicode("of"), unicode("unicode"),\r
- unicode("values")], REG_MULTI_SZ),\r
- ("Multi-mixed", [unicode("Unicode"), unicode("and"), "string",\r
- "values"], REG_MULTI_SZ),\r
- ]\r
-\r
-class BaseWinregTests(unittest.TestCase):\r
-\r
- def setUp(self):\r
- # Make sure that the test key is absent when the test\r
- # starts.\r
- self.delete_tree(HKEY_CURRENT_USER, test_key_name)\r
-\r
- def delete_tree(self, root, subkey):\r
- try:\r
- hkey = OpenKey(root, subkey, KEY_ALL_ACCESS)\r
- except WindowsError:\r
- # subkey does not exist\r
- return\r
- while True:\r
- try:\r
- subsubkey = EnumKey(hkey, 0)\r
- except WindowsError:\r
- # no more subkeys\r
- break\r
- self.delete_tree(hkey, subsubkey)\r
- CloseKey(hkey)\r
- DeleteKey(root, subkey)\r
-\r
- def _write_test_data(self, root_key, CreateKey=CreateKey):\r
- # Set the default value for this key.\r
- SetValue(root_key, test_key_name, REG_SZ, "Default value")\r
- key = CreateKey(root_key, test_key_name)\r
- # Create a sub-key\r
- sub_key = CreateKey(key, "sub_key")\r
- # Give the sub-key some named values\r
-\r
- for value_name, value_data, value_type in test_data:\r
- SetValueEx(sub_key, value_name, 0, value_type, value_data)\r
-\r
- # Check we wrote as many items as we thought.\r
- nkeys, nvalues, since_mod = QueryInfoKey(key)\r
- self.assertEqual(nkeys, 1, "Not the correct number of sub keys")\r
- self.assertEqual(nvalues, 1, "Not the correct number of values")\r
- nkeys, nvalues, since_mod = QueryInfoKey(sub_key)\r
- self.assertEqual(nkeys, 0, "Not the correct number of sub keys")\r
- self.assertEqual(nvalues, len(test_data),\r
- "Not the correct number of values")\r
- # Close this key this way...\r
- # (but before we do, copy the key as an integer - this allows\r
- # us to test that the key really gets closed).\r
- int_sub_key = int(sub_key)\r
- CloseKey(sub_key)\r
- try:\r
- QueryInfoKey(int_sub_key)\r
- self.fail("It appears the CloseKey() function does "\r
- "not close the actual key!")\r
- except EnvironmentError:\r
- pass\r
- # ... and close that key that way :-)\r
- int_key = int(key)\r
- key.Close()\r
- try:\r
- QueryInfoKey(int_key)\r
- self.fail("It appears the key.Close() function "\r
- "does not close the actual key!")\r
- except EnvironmentError:\r
- pass\r
-\r
- def _read_test_data(self, root_key, OpenKey=OpenKey):\r
- # Check we can get default value for this key.\r
- val = QueryValue(root_key, test_key_name)\r
- self.assertEqual(val, "Default value",\r
- "Registry didn't give back the correct value")\r
-\r
- key = OpenKey(root_key, test_key_name)\r
- # Read the sub-keys\r
- with OpenKey(key, "sub_key") as sub_key:\r
- # Check I can enumerate over the values.\r
- index = 0\r
- while 1:\r
- try:\r
- data = EnumValue(sub_key, index)\r
- except EnvironmentError:\r
- break\r
- self.assertIn(data, test_data,\r
- "Didn't read back the correct test data")\r
- index = index + 1\r
- self.assertEqual(index, len(test_data),\r
- "Didn't read the correct number of items")\r
- # Check I can directly access each item\r
- for value_name, value_data, value_type in test_data:\r
- read_val, read_typ = QueryValueEx(sub_key, value_name)\r
- self.assertEqual(read_val, value_data,\r
- "Could not directly read the value")\r
- self.assertEqual(read_typ, value_type,\r
- "Could not directly read the value")\r
- sub_key.Close()\r
- # Enumerate our main key.\r
- read_val = EnumKey(key, 0)\r
- self.assertEqual(read_val, "sub_key", "Read subkey value wrong")\r
- try:\r
- EnumKey(key, 1)\r
- self.fail("Was able to get a second key when I only have one!")\r
- except EnvironmentError:\r
- pass\r
-\r
- key.Close()\r
-\r
- def _delete_test_data(self, root_key):\r
- key = OpenKey(root_key, test_key_name, 0, KEY_ALL_ACCESS)\r
- sub_key = OpenKey(key, "sub_key", 0, KEY_ALL_ACCESS)\r
- # It is not necessary to delete the values before deleting\r
- # the key (although subkeys must not exist). We delete them\r
- # manually just to prove we can :-)\r
- for value_name, value_data, value_type in test_data:\r
- DeleteValue(sub_key, value_name)\r
-\r
- nkeys, nvalues, since_mod = QueryInfoKey(sub_key)\r
- self.assertEqual(nkeys, 0, "subkey not empty before delete")\r
- self.assertEqual(nvalues, 0, "subkey not empty before delete")\r
- sub_key.Close()\r
- DeleteKey(key, "sub_key")\r
-\r
- try:\r
- # Shouldnt be able to delete it twice!\r
- DeleteKey(key, "sub_key")\r
- self.fail("Deleting the key twice succeeded")\r
- except EnvironmentError:\r
- pass\r
- key.Close()\r
- DeleteKey(root_key, test_key_name)\r
- # Opening should now fail!\r
- try:\r
- key = OpenKey(root_key, test_key_name)\r
- self.fail("Could open the non-existent key")\r
- except WindowsError: # Use this error name this time\r
- pass\r
-\r
- def _test_all(self, root_key):\r
- self._write_test_data(root_key)\r
- self._read_test_data(root_key)\r
- self._delete_test_data(root_key)\r
-\r
-class LocalWinregTests(BaseWinregTests):\r
-\r
- def test_registry_works(self):\r
- self._test_all(HKEY_CURRENT_USER)\r
-\r
- def test_registry_works_extended_functions(self):\r
- # Substitute the regular CreateKey and OpenKey calls with their\r
- # extended counterparts.\r
- # Note: DeleteKeyEx is not used here because it is platform dependent\r
- cke = lambda key, sub_key: CreateKeyEx(key, sub_key, 0, KEY_ALL_ACCESS)\r
- self._write_test_data(HKEY_CURRENT_USER, cke)\r
-\r
- oke = lambda key, sub_key: OpenKeyEx(key, sub_key, 0, KEY_READ)\r
- self._read_test_data(HKEY_CURRENT_USER, oke)\r
-\r
- self._delete_test_data(HKEY_CURRENT_USER)\r
-\r
- def test_connect_registry_to_local_machine_works(self):\r
- # perform minimal ConnectRegistry test which just invokes it\r
- h = ConnectRegistry(None, HKEY_LOCAL_MACHINE)\r
- self.assertNotEqual(h.handle, 0)\r
- h.Close()\r
- self.assertEqual(h.handle, 0)\r
-\r
- def test_inexistant_remote_registry(self):\r
- connect = lambda: ConnectRegistry("abcdefghijkl", HKEY_CURRENT_USER)\r
- self.assertRaises(WindowsError, connect)\r
-\r
- def test_expand_environment_strings(self):\r
- r = ExpandEnvironmentStrings(u"%windir%\\test")\r
- self.assertEqual(type(r), unicode)\r
- self.assertEqual(r, os.environ["windir"] + "\\test")\r
-\r
- def test_context_manager(self):\r
- # ensure that the handle is closed if an exception occurs\r
- try:\r
- with ConnectRegistry(None, HKEY_LOCAL_MACHINE) as h:\r
- self.assertNotEqual(h.handle, 0)\r
- raise WindowsError\r
- except WindowsError:\r
- self.assertEqual(h.handle, 0)\r
-\r
- def test_changing_value(self):\r
- # Issue2810: A race condition in 2.6 and 3.1 may cause\r
- # EnumValue or QueryValue to throw "WindowsError: More data is\r
- # available"\r
- done = False\r
-\r
- class VeryActiveThread(threading.Thread):\r
- def run(self):\r
- with CreateKey(HKEY_CURRENT_USER, test_key_name) as key:\r
- use_short = True\r
- long_string = 'x'*2000\r
- while not done:\r
- s = 'x' if use_short else long_string\r
- use_short = not use_short\r
- SetValue(key, 'changing_value', REG_SZ, s)\r
-\r
- thread = VeryActiveThread()\r
- thread.start()\r
- try:\r
- with CreateKey(HKEY_CURRENT_USER,\r
- test_key_name+'\\changing_value') as key:\r
- for _ in range(1000):\r
- num_subkeys, num_values, t = QueryInfoKey(key)\r
- for i in range(num_values):\r
- name = EnumValue(key, i)\r
- QueryValue(key, name[0])\r
- finally:\r
- done = True\r
- thread.join()\r
- with OpenKey(HKEY_CURRENT_USER, test_key_name, 0, KEY_ALL_ACCESS) as key:\r
- DeleteKey(key, 'changing_value')\r
- DeleteKey(HKEY_CURRENT_USER, test_key_name)\r
-\r
- def test_long_key(self):\r
- # Issue2810, in 2.6 and 3.1 when the key name was exactly 256\r
- # characters, EnumKey threw "WindowsError: More data is\r
- # available"\r
- name = 'x'*256\r
- try:\r
- with CreateKey(HKEY_CURRENT_USER, test_key_name) as key:\r
- SetValue(key, name, REG_SZ, 'x')\r
- num_subkeys, num_values, t = QueryInfoKey(key)\r
- EnumKey(key, 0)\r
- finally:\r
- with OpenKey(HKEY_CURRENT_USER, test_key_name, 0, KEY_ALL_ACCESS) as key:\r
- DeleteKey(key, name)\r
- DeleteKey(HKEY_CURRENT_USER, test_key_name)\r
-\r
- def test_dynamic_key(self):\r
- # Issue2810, when the value is dynamically generated, these\r
- # throw "WindowsError: More data is available" in 2.6 and 3.1\r
- EnumValue(HKEY_PERFORMANCE_DATA, 0)\r
- QueryValueEx(HKEY_PERFORMANCE_DATA, None)\r
-\r
- # Reflection requires XP x64/Vista at a minimum. XP doesn't have this stuff\r
- # or DeleteKeyEx so make sure their use raises NotImplementedError\r
- @unittest.skipUnless(WIN_VER < (5, 2), "Requires Windows XP")\r
- def test_reflection_unsupported(self):\r
- try:\r
- with CreateKey(HKEY_CURRENT_USER, test_key_name) as ck:\r
- self.assertNotEqual(ck.handle, 0)\r
-\r
- key = OpenKey(HKEY_CURRENT_USER, test_key_name)\r
- self.assertNotEqual(key.handle, 0)\r
-\r
- with self.assertRaises(NotImplementedError):\r
- DisableReflectionKey(key)\r
- with self.assertRaises(NotImplementedError):\r
- EnableReflectionKey(key)\r
- with self.assertRaises(NotImplementedError):\r
- QueryReflectionKey(key)\r
- with self.assertRaises(NotImplementedError):\r
- DeleteKeyEx(HKEY_CURRENT_USER, test_key_name)\r
- finally:\r
- DeleteKey(HKEY_CURRENT_USER, test_key_name)\r
-\r
-\r
-@unittest.skipUnless(REMOTE_NAME, "Skipping remote registry tests")\r
-class RemoteWinregTests(BaseWinregTests):\r
-\r
- def test_remote_registry_works(self):\r
- remote_key = ConnectRegistry(REMOTE_NAME, HKEY_CURRENT_USER)\r
- self._test_all(remote_key)\r
-\r
-\r
-@unittest.skipUnless(WIN64_MACHINE, "x64 specific registry tests")\r
-class Win64WinregTests(BaseWinregTests):\r
-\r
- def test_reflection_functions(self):\r
- # Test that we can call the query, enable, and disable functions\r
- # on a key which isn't on the reflection list with no consequences.\r
- with OpenKey(HKEY_LOCAL_MACHINE, "Software") as key:\r
- # HKLM\Software is redirected but not reflected in all OSes\r
- self.assertTrue(QueryReflectionKey(key))\r
- self.assertEqual(None, EnableReflectionKey(key))\r
- self.assertEqual(None, DisableReflectionKey(key))\r
- self.assertTrue(QueryReflectionKey(key))\r
-\r
- @unittest.skipUnless(HAS_REFLECTION, "OS doesn't support reflection")\r
- def test_reflection(self):\r
- # Test that we can create, open, and delete keys in the 32-bit\r
- # area. Because we are doing this in a key which gets reflected,\r
- # test the differences of 32 and 64-bit keys before and after the\r
- # reflection occurs (ie. when the created key is closed).\r
- try:\r
- with CreateKeyEx(HKEY_CURRENT_USER, test_reflect_key_name, 0,\r
- KEY_ALL_ACCESS | KEY_WOW64_32KEY) as created_key:\r
- self.assertNotEqual(created_key.handle, 0)\r
-\r
- # The key should now be available in the 32-bit area\r
- with OpenKey(HKEY_CURRENT_USER, test_reflect_key_name, 0,\r
- KEY_ALL_ACCESS | KEY_WOW64_32KEY) as key:\r
- self.assertNotEqual(key.handle, 0)\r
-\r
- # Write a value to what currently is only in the 32-bit area\r
- SetValueEx(created_key, "", 0, REG_SZ, "32KEY")\r
-\r
- # The key is not reflected until created_key is closed.\r
- # The 64-bit version of the key should not be available yet.\r
- open_fail = lambda: OpenKey(HKEY_CURRENT_USER,\r
- test_reflect_key_name, 0,\r
- KEY_READ | KEY_WOW64_64KEY)\r
- self.assertRaises(WindowsError, open_fail)\r
-\r
- # Now explicitly open the 64-bit version of the key\r
- with OpenKey(HKEY_CURRENT_USER, test_reflect_key_name, 0,\r
- KEY_ALL_ACCESS | KEY_WOW64_64KEY) as key:\r
- self.assertNotEqual(key.handle, 0)\r
- # Make sure the original value we set is there\r
- self.assertEqual("32KEY", QueryValue(key, ""))\r
- # Set a new value, which will get reflected to 32-bit\r
- SetValueEx(key, "", 0, REG_SZ, "64KEY")\r
-\r
- # Reflection uses a "last-writer wins policy, so the value we set\r
- # on the 64-bit key should be the same on 32-bit\r
- with OpenKey(HKEY_CURRENT_USER, test_reflect_key_name, 0,\r
- KEY_READ | KEY_WOW64_32KEY) as key:\r
- self.assertEqual("64KEY", QueryValue(key, ""))\r
- finally:\r
- DeleteKeyEx(HKEY_CURRENT_USER, test_reflect_key_name,\r
- KEY_WOW64_32KEY, 0)\r
-\r
- @unittest.skipUnless(HAS_REFLECTION, "OS doesn't support reflection")\r
- def test_disable_reflection(self):\r
- # Make use of a key which gets redirected and reflected\r
- try:\r
- with CreateKeyEx(HKEY_CURRENT_USER, test_reflect_key_name, 0,\r
- KEY_ALL_ACCESS | KEY_WOW64_32KEY) as created_key:\r
- # QueryReflectionKey returns whether or not the key is disabled\r
- disabled = QueryReflectionKey(created_key)\r
- self.assertEqual(type(disabled), bool)\r
- # HKCU\Software\Classes is reflected by default\r
- self.assertFalse(disabled)\r
-\r
- DisableReflectionKey(created_key)\r
- self.assertTrue(QueryReflectionKey(created_key))\r
-\r
- # The key is now closed and would normally be reflected to the\r
- # 64-bit area, but let's make sure that didn't happen.\r
- open_fail = lambda: OpenKeyEx(HKEY_CURRENT_USER,\r
- test_reflect_key_name, 0,\r
- KEY_READ | KEY_WOW64_64KEY)\r
- self.assertRaises(WindowsError, open_fail)\r
-\r
- # Make sure the 32-bit key is actually there\r
- with OpenKeyEx(HKEY_CURRENT_USER, test_reflect_key_name, 0,\r
- KEY_READ | KEY_WOW64_32KEY) as key:\r
- self.assertNotEqual(key.handle, 0)\r
- finally:\r
- DeleteKeyEx(HKEY_CURRENT_USER, test_reflect_key_name,\r
- KEY_WOW64_32KEY, 0)\r
-\r
-\r
-def test_main():\r
- test_support.run_unittest(LocalWinregTests, RemoteWinregTests,\r
- Win64WinregTests)\r
-\r
-if __name__ == "__main__":\r
- if not REMOTE_NAME:\r
- print "Remote registry calls can be tested using",\r
- print "'test_winreg.py --remote \\\\machine_name'"\r
- test_main()\r
projects / mirror_edk2.git / blobdiff