mbed-os/tools/python/python_tests/mbed_lstools/os_win7.py

231 lines
10 KiB
Python

# coding: utf-8
"""
mbed SDK
Copyright (c) 2011-2018 ARM Limited
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""
import unittest
import sys
import os
from mock import MagicMock, patch, call
# Mock the winreg and _winreg module for non-windows python
_winreg = MagicMock()
sys.modules['_winreg'] = _winreg
sys.modules['winreg'] = _winreg
from mbed_lstools.windows import MbedLsToolsWin7, CompatibleIDsNotFoundException
class Win7TestCase(unittest.TestCase):
""" Basic test cases checking trivial asserts
"""
def setUp(self):
self.lstool = MbedLsToolsWin7()
import logging
logging.basicConfig()
root_logger = logging.getLogger("mbedls")
root_logger.setLevel(logging.DEBUG)
del logging
_winreg.HKEY_LOCAL_MACHINE = None
_winreg.OpenKey.reset_mock()
_winreg.OpenKey.side_effect = None
_winreg.EnumValue.reset_mock()
_winreg.EnumValue.side_effect = None
_winreg.EnumKey.reset_mock()
_winreg.EnumKey.side_effect = None
_winreg.QueryValue.reset_mock()
_winreg.QueryValue.side_effect = None
_winreg.QueryInfoKey.reset_mock()
_winreg.QueryInfoKey.side_effect = None
_winreg.CreateKey.reset_mock()
_winreg.CreateKeyEx.reset_mock()
_winreg.DeleteKey.reset_mock()
_winreg.DeleteKeyEx.reset_mock()
_winreg.DeleteValue.reset_mock()
_winreg.SetValue.reset_mock()
_winreg.SetValueEx.reset_mock()
_winreg.SaveKey.reset_mock()
def test_os_supported(self):
pass
def test_empty_reg(self):
value_dict = {
(None, 'SYSTEM\\MountedDevices'): [
('\\DosDevices\\F:',
u'_??_USBSTOR#Disk&Ven_MBED&Prod_VFS&Rev_0.1#9&215b8c47&0&0240000032044e4500257009997b00386781000097969900&0#{53f56307-b6bf-11d0-94f2-00a0c91efb8b}'.encode('utf-16le')),
],
(None, 'SYSTEM\\CurrentControlSet\\Services\\volume\\Enum'): [],
(None, 'SYSTEM\\CurrentControlSet\\Services\\USBSTOR\\Enum'): []
}
self.setUpRegistry(value_dict, {})
candidates = self.lstool.find_candidates()
self.assertEqual(_winreg.OpenKey.mock_calls, [
call(_winreg.HKEY_LOCAL_MACHINE, 'SYSTEM\\MountedDevices'),
call(_winreg.HKEY_LOCAL_MACHINE, 'SYSTEM\\CurrentControlSet\\Services\\Disk\\Enum'),
call(_winreg.HKEY_LOCAL_MACHINE, 'SYSTEM\\CurrentControlSet\\Services\\USBSTOR\\Enum')
])
self.assertEqual(candidates, [])
def assertNoRegMut(self):
"""Assert that the registry was not mutated in this test"""
_winreg.CreateKey.assert_not_called()
_winreg.CreateKeyEx.assert_not_called()
_winreg.DeleteKey.assert_not_called()
_winreg.DeleteKeyEx.assert_not_called()
_winreg.DeleteValue.assert_not_called()
_winreg.SetValue.assert_not_called()
_winreg.SetValueEx.assert_not_called()
_winreg.SaveKey.assert_not_called()
def setUpRegistry(self, value_dict, key_dict):
all_keys = set(value_dict.keys()) | set(key_dict.keys())
def open_key_effect(key, subkey):
if ((key, subkey) in all_keys or key in all_keys):
return key, subkey
else:
raise OSError((key, subkey))
_winreg.OpenKey.side_effect = open_key_effect
def enum_value(key, index):
try:
a, b = value_dict[key][index]
return a, b, None
except KeyError:
raise OSError
_winreg.EnumValue.side_effect = enum_value
def enum_key(key, index):
try:
return key_dict[key][index]
except KeyError:
raise OSError
_winreg.EnumKey.side_effect = enum_key
def query_value(key, subkey):
try:
return value_dict[(key, subkey)]
except KeyError:
raise OSError
_winreg.QueryValueEx.side_effect = query_value
def query_info_key(key):
return (len(key_dict.get(key, [])),
len(value_dict.get(key, [])))
_winreg.QueryInfoKey.side_effect = query_info_key
def test_one_composite_dev(self):
value_dict = {
(None, 'SYSTEM\\MountedDevices'): [
('\\DosDevices\\C:', u'NOT A VALID MBED DRIVE'.encode('utf-16le')),
('\\DosDevices\\F:',
u'_??_USBSTOR#Disk&Ven_MBED&Prod_VFS&Rev_0.1#9&215b8c47&0&0240000032044e4500257009997b00386781000097969900&0#{53f56307-b6bf-11d0-94f2-00a0c91efb8b}'.encode('utf-16le'))
],
(None, 'SYSTEM\\CurrentControlSet\\Services\\Disk\\Enum'): [
('0', 'USBSTOR\\Disk&Ven_MBED&Prod_VFS&Rev_0.1\\9&215b8c47&0&0240000032044e4500257009997b00386781000097969900&0')
],
(None, 'SYSTEM\\CurrentControlSet\\Services\\USBSTOR\\Enum'): [
('0', 'USB\\VID_0D28&PID_0204&MI_00\\8&26b12a60&0&0000')
],
(None, 'SYSTEM\\CurrentControlSet\\Enum\\USB\\VID_0D28&PID_0204'): [],
(((None, 'SYSTEM\\CurrentControlSet\\Enum\\USB\\VID_0D28&PID_0204'),
'0240000032044e4500257009997b00386781000097969900'),
'ParentIdPrefix'): ('8&26b12a60&0', None),
(((None, 'SYSTEM\\CurrentControlSet\\Enum\\USB\\VID_0D28&PID_0204'),
'0240000032044e4500257009997b00386781000097969900'),
'CompatibleIDs'): ([u'USB\\DevClass_00&SubClass_00&Prot_00', u'USB\\DevClass_00&SubClass_00', u'USB\\DevClass_00', u'USB\\COMPOSITE'], 7),
(((None, 'SYSTEM\\CurrentControlSet\\Enum\\USB\\VID_0D28&PID_0204&MI_00'), '8&26b12a60&0&0000'), 'CompatibleIDs'): ([u'USB\\Class_08&SubClass_06&Prot_50', u'USB\\Class_08&SubClass_06', u'USB\\Class_08'], 7),
(((None, 'SYSTEM\\CurrentControlSet\\Enum\\USB\\VID_0D28&PID_0204&MI_01'),
'8&26b12a60&0&0001'),
'CompatibleIDs'): ([u'USB\\CLASS_02&SUBCLASS_02&PROT_01', u'USB\\CLASS_02&SUBCLASS_02', u'USB\\CLASS_02'], 7),
((((None, 'SYSTEM\\CurrentControlSet\\Enum\\USB\\VID_0D28&PID_0204&MI_01'),
'8&26b12a60&0&0001'),
'Device Parameters'),
'PortName'): ('COM7', None)
}
key_dict = {
(None, 'SYSTEM\\CurrentControlSet\\Enum\\USB\\VID_0D28&PID_0204'):
['0240000032044e4500257009997b00386781000097969900'],
(None, 'SYSTEM\\CurrentControlSet\\Enum\\USB\\VID_0D28&PID_0204&MI_00'): [],
(None, 'SYSTEM\\CurrentControlSet\\Enum\\USB\\VID_0D28&PID_0204&MI_01'): [],
(((None, 'SYSTEM\\CurrentControlSet\\Enum\\USB\\VID_0D28&PID_0204&MI_01'),
'8&26b12a60&0&0001'),
'Device Parameters'): []
}
self.setUpRegistry(value_dict, key_dict)
with patch('mbed_lstools.windows.MbedLsToolsWin7._run_cli_process') as _cliproc:
_cliproc.return_value = ("", "", 0)
expected_info = {
'mount_point': 'F:',
'serial_port': 'COM7',
'target_id_usb_id': u'0240000032044e4500257009997b00386781000097969900',
'vendor_id': '0d28',
'product_id': '0204'
}
devices = self.lstool.find_candidates()
self.assertIn(expected_info, devices)
self.assertNoRegMut()
def test_one_non_composite_dev(self):
value_dict = {
(None, 'SYSTEM\\MountedDevices'): [
('\\DosDevices\\C:', u'NOT A VALID MBED DRIVE'.encode('utf-16le')),
('\\DosDevices\\F:',
u'_??_USBSTOR#Disk&Ven_MBED&Prod_VFS&Rev_0.1#0000000032044e4500257009997b00386781000097969900&0#{53f56307-b6bf-11d0-94f2-00a0c91efb8b}'.encode('utf-16le'))
],
(None, 'SYSTEM\\CurrentControlSet\\Services\\Disk\\Enum'): [
('0', 'USBSTOR\Disk&Ven_MBED&Prod_VFS&Rev_0.1\\0000000032044e4500257009997b00386781000097969900&0')
],
(None, 'SYSTEM\\CurrentControlSet\\Services\\USBSTOR\\Enum'): [
('0', 'USB\\VID_0D28&PID_0204\\0000000032044e4500257009997b00386781000097969900')
],
(None, 'SYSTEM\\CurrentControlSet\\Enum\\USB\\VID_0D28&PID_0204'): [],
((None, 'SYSTEM\\CurrentControlSet\\Enum\\USB\\VID_0D28&PID_0204\\0000000032044e4500257009997b00386781000097969900'),
'CompatibleIDs'): ([u'USB\\Class_08&SubClass_06&Prot_50', u'USB\\Class_08&SubClass_06', u'USB\\Class_08'], 7)
}
key_dict = {
(None, 'SYSTEM\\CurrentControlSet\\Enum\\USB\\VID_0D28&PID_0204'):
['0000000032044e4500257009997b00386781000097969900'],
(None, 'SYSTEM\\CurrentControlSet\\Enum\\USB\\VID_0D28&PID_0204\\0000000032044e4500257009997b00386781000097969900'): []
}
self.setUpRegistry(value_dict, key_dict)
with patch('mbed_lstools.windows.MbedLsToolsWin7._run_cli_process') as _cliproc:
_cliproc.return_value = ("", "", 0)
expected_info = {
'mount_point': 'F:',
'serial_port': None,
'target_id_usb_id': u'0000000032044e4500257009997b00386781000097969900',
'vendor_id': '0d28',
'product_id': '0204'
}
devices = self.lstool.find_candidates()
self.assertIn(expected_info, devices)
self.assertNoRegMut()
def test_mount_point_ready(self):
with patch('mbed_lstools.windows.MbedLsToolsWin7._run_cli_process') as _cliproc:
_cliproc.return_value = ("dummy", "", 0)
self.assertTrue(self.lstool.mount_point_ready("dummy"))
_cliproc.reset_mock()
_cliproc.return_value = ("", "dummy", 1)
self.assertFalse(self.lstool.mount_point_ready("dummy"))
if __name__ == '__main__':
unittest.main()