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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
|
#!/usr/bin/env python
# Copyright 2016 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
# pylint: disable=protected-access
"""
Unit tests for the contents of find_usb_devices.py.
Device tree for these tests is as follows:
Bus 001:
1: Device 011 "foo"
2: Device 012 "bar"
3: Device 013 "baz"
Bus 002:
1: Device 011 "quux"
2: Device 020 "My Test HUB" #hub 1
2:1: Device 021 "battor_p7_h1_t0" #physical port 7 on hub 1, on ttyUSB0
2:3: Device 022 "battor_p5_h1_t1" #physical port 5 on hub 1, on ttyUSB1
2:4: Device 023 "My Test Internal HUB" #internal section of hub 1
2:4:2: Device 024 "battor_p3_h1_t2" #physical port 3 on hub 1, on ttyUSB2
2:4:3: Device 026 "Not a Battery Monitor" #physical port 1 on hub 1, on ttyUSB3
2:4:4: Device 025 "battor_p1_h1_t3" #physical port 1 on hub 1, on ttyUSB3
3: Device 100 "My Test HUB" #hub 2
3:4: Device 101 "My Test Internal HUB" #internal section of hub 2
3:4:4: Device 102 "battor_p1_h2_t4" #physical port 1 on hub 2, on ttyusb4
"""
import logging
import os
import unittest
from devil import devil_env
from devil.utils import battor_device_mapping
from devil.utils import find_usb_devices
from devil.utils import lsusb
from devil.utils import usb_hubs
with devil_env.SysPath(devil_env.PYMOCK_PATH):
import mock # pylint: disable=import-error
# Output of lsusb.lsusb().
# We just test that the dictionary is working by creating an
# "ID number" equal to (bus_num*1000)+device_num and seeing if
# it is picked up correctly. Also we test the description
DEVLIST = [(1, 11, 'foo'),
(1, 12, 'bar'),
(1, 13, 'baz'),
(2, 11, 'quux'),
(2, 20, 'My Test HUB'),
(2, 21, 'ID 0403:6001 battor_p7_h1_t0'),
(2, 22, 'ID 0403:6001 battor_p5_h1_t1'),
(2, 23, 'My Test Internal HUB'),
(2, 24, 'ID 0403:6001 battor_p3_h1_t2'),
(2, 25, 'ID 0403:6001 battor_p1_h1_t3'),
(2, 26, 'Not a Battery Monitor'),
(2, 100, 'My Test HUB'),
(2, 101, 'My Test Internal HUB'),
(2, 102, 'ID 0403:6001 battor_p1_h1_t4')]
LSUSB_OUTPUT = [
{'bus': b, 'device': d, 'desc': t, 'id': (1000*b)+d}
for (b, d, t) in DEVLIST]
# Note: "Lev", "Cnt", "Spd", and "MxCh" are not used by parser,
# so we just leave them as zeros here. Also note that the port
# numbers reported here start at 0, so they're 1 less than the
# port numbers reported elsewhere.
USB_DEVICES_OUTPUT = '''
T: Bus=01 Lev=00 Prnt=00 Port=00 Cnt=00 Dev#= 11 Spd=000 MxCh=00
S: SerialNumber=FooSerial
T: Bus=01 Lev=00 Prnt=00 Port=01 Cnt=00 Dev#= 12 Spd=000 MxCh=00
S: SerialNumber=BarSerial
T: Bus=01 Lev=00 Prnt=00 Port=02 Cnt=00 Dev#= 13 Spd=000 MxCh=00
S: SerialNumber=BazSerial
T: Bus=02 Lev=00 Prnt=00 Port=00 Cnt=00 Dev#= 11 Spd=000 MxCh=00
T: Bus=02 Lev=00 Prnt=00 Port=01 Cnt=00 Dev#= 20 Spd=000 MxCh=00
T: Bus=02 Lev=00 Prnt=20 Port=00 Cnt=00 Dev#= 21 Spd=000 MxCh=00
S: SerialNumber=Battor0
T: Bus=02 Lev=00 Prnt=20 Port=02 Cnt=00 Dev#= 22 Spd=000 MxCh=00
S: SerialNumber=Battor1
T: Bus=02 Lev=00 Prnt=20 Port=03 Cnt=00 Dev#= 23 Spd=000 MxCh=00
T: Bus=02 Lev=00 Prnt=23 Port=01 Cnt=00 Dev#= 24 Spd=000 MxCh=00
S: SerialNumber=Battor2
T: Bus=02 Lev=00 Prnt=23 Port=03 Cnt=00 Dev#= 25 Spd=000 MxCh=00
S: SerialNumber=Battor3
T: Bus=02 Lev=00 Prnt=23 Port=02 Cnt=00 Dev#= 26 Spd=000 MxCh=00
T: Bus=02 Lev=00 Prnt=00 Port=02 Cnt=00 Dev#=100 Spd=000 MxCh=00
T: Bus=02 Lev=00 Prnt=100 Port=03 Cnt=00 Dev#=101 Spd=000 MxCh=00
T: Bus=02 Lev=00 Prnt=101 Port=03 Cnt=00 Dev#=102 Spd=000 MxCh=00
'''
RAW_LSUSB_OUTPUT = '''
Bus 001 Device 011: FAST foo
Bus 001 Device 012: FAST bar
Bus 001 Device 013: baz
Bus 002 Device 011: quux
Bus 002 Device 020: My Test HUB
Bus 002 Device 021: ID 0403:6001 battor_p7_h1_t0
Bus 002 Device 022: ID 0403:6001 battor_p5_h1_t1
Bus 002 Device 023: My Test Internal HUB
Bus 002 Device 024: ID 0403:6001 battor_p3_h1_t2
Bus 002 Device 025: ID 0403:6001 battor_p1_h1_t3
Bus 002 Device 026: Not a Battery Monitor
Bus 002 Device 100: My Test HUB
Bus 002 Device 101: My Test Internal HUB
Bus 002 Device 102: ID 0403:6001 battor_p1_h1_t4
'''
LIST_TTY_OUTPUT = '''
ttyUSB0
Something-else-0
ttyUSB1
ttyUSB2
Something-else-1
ttyUSB3
ttyUSB4
Something-else-2
ttyUSB5
'''
# Note: The real output will have multiple lines with
# ATTRS{busnum} and ATTRS{devnum}, but only the first
# one counts. Thus the test output duplicates this.
UDEVADM_USBTTY0_OUTPUT = '''
ATTRS{busnum}=="2"
ATTRS{devnum}=="21"
ATTRS{busnum}=="0"
ATTRS{devnum}=="0"
'''
UDEVADM_USBTTY1_OUTPUT = '''
ATTRS{busnum}=="2"
ATTRS{devnum}=="22"
ATTRS{busnum}=="0"
ATTRS{devnum}=="0"
'''
UDEVADM_USBTTY2_OUTPUT = '''
ATTRS{busnum}=="2"
ATTRS{devnum}=="24"
ATTRS{busnum}=="0"
ATTRS{devnum}=="0"
'''
UDEVADM_USBTTY3_OUTPUT = '''
ATTRS{busnum}=="2"
ATTRS{devnum}=="25"
ATTRS{busnum}=="0"
ATTRS{devnum}=="0"
'''
UDEVADM_USBTTY4_OUTPUT = '''
ATTRS{busnum}=="2"
ATTRS{devnum}=="102"
ATTRS{busnum}=="0"
ATTRS{devnum}=="0"
'''
UDEVADM_USBTTY5_OUTPUT = '''
ATTRS{busnum}=="2"
ATTRS{devnum}=="26"
ATTRS{busnum}=="0"
ATTRS{devnum}=="0"
'''
UDEVADM_OUTPUT_DICT = {
'ttyUSB0': UDEVADM_USBTTY0_OUTPUT,
'ttyUSB1': UDEVADM_USBTTY1_OUTPUT,
'ttyUSB2': UDEVADM_USBTTY2_OUTPUT,
'ttyUSB3': UDEVADM_USBTTY3_OUTPUT,
'ttyUSB4': UDEVADM_USBTTY4_OUTPUT,
'ttyUSB5': UDEVADM_USBTTY5_OUTPUT}
# Identification criteria for Plugable 7-Port Hub
def isTestHub(node):
"""Check if a node is a Plugable 7-Port Hub
(Model USB2-HUB7BC)
The topology of this device is a 4-port hub,
with another 4-port hub connected on port 4.
"""
if not isinstance(node, find_usb_devices.USBDeviceNode):
return False
if 'Test HUB' not in node.desc:
return False
if not node.HasPort(4):
return False
return 'Test Internal HUB' in node.PortToDevice(4).desc
TEST_HUB = usb_hubs.HubType(isTestHub,
{1:7,
2:6,
3:5,
4:{1:4, 2:3, 3:2, 4:1}})
class USBScriptTest(unittest.TestCase):
def setUp(self):
find_usb_devices._GetTtyUSBInfo = mock.Mock(
side_effect=lambda x: UDEVADM_OUTPUT_DICT[x])
find_usb_devices._GetParsedLSUSBOutput = mock.Mock(
return_value=LSUSB_OUTPUT)
find_usb_devices._GetUSBDevicesOutput = mock.Mock(
return_value=USB_DEVICES_OUTPUT)
find_usb_devices._GetCommList = mock.Mock(
return_value=LIST_TTY_OUTPUT)
lsusb.raw_lsusb = mock.Mock(
return_value=RAW_LSUSB_OUTPUT)
def testIsBattor(self):
bd = find_usb_devices.GetBusNumberToDeviceTreeMap()
self.assertTrue(battor_device_mapping.IsBattor('ttyUSB3', bd))
self.assertFalse(battor_device_mapping.IsBattor('ttyUSB5', bd))
def testGetBattors(self):
bd = find_usb_devices.GetBusNumberToDeviceTreeMap()
self.assertEquals(battor_device_mapping.GetBattorList(bd),
['ttyUSB0', 'ttyUSB1', 'ttyUSB2',
'ttyUSB3', 'ttyUSB4'])
def testGetTTYDevices(self):
pp = find_usb_devices.GetAllPhysicalPortToTTYMaps([TEST_HUB])
result = list(pp)
self.assertEquals(result[0], {7:'ttyUSB0',
5:'ttyUSB1',
3:'ttyUSB2',
2:'ttyUSB5',
1:'ttyUSB3'})
self.assertEquals(result[1], {1:'ttyUSB4'})
def testGetPortDeviceMapping(self):
pp = find_usb_devices.GetAllPhysicalPortToBusDeviceMaps([TEST_HUB])
result = list(pp)
self.assertEquals(result[0], {7:(2, 21),
5:(2, 22),
3:(2, 24),
2:(2, 26),
1:(2, 25)})
self.assertEquals(result[1], {1:(2, 102)})
def testGetSerialMapping(self):
pp = find_usb_devices.GetAllPhysicalPortToSerialMaps([TEST_HUB])
result = list(pp)
self.assertEquals(result[0], {7:'Battor0',
5:'Battor1',
3:'Battor2',
1:'Battor3'})
self.assertEquals(result[1], {})
def testFastDeviceDescriptions(self):
bd = find_usb_devices.GetBusNumberToDeviceTreeMap()
dev_foo = bd[1].FindDeviceNumber(11)
dev_bar = bd[1].FindDeviceNumber(12)
dev_battor_p7_h1_t0 = bd[2].FindDeviceNumber(21)
self.assertEquals(dev_foo.desc, 'FAST foo')
self.assertEquals(dev_bar.desc, 'FAST bar')
self.assertEquals(dev_battor_p7_h1_t0.desc,
'ID 0403:6001 battor_p7_h1_t0')
def testDeviceDescriptions(self):
bd = find_usb_devices.GetBusNumberToDeviceTreeMap(fast=False)
dev_foo = bd[1].FindDeviceNumber(11)
dev_bar = bd[1].FindDeviceNumber(12)
dev_battor_p7_h1_t0 = bd[2].FindDeviceNumber(21)
self.assertEquals(dev_foo.desc, 'foo')
self.assertEquals(dev_bar.desc, 'bar')
self.assertEquals(dev_battor_p7_h1_t0.desc,
'ID 0403:6001 battor_p7_h1_t0')
def testDeviceInformation(self):
bd = find_usb_devices.GetBusNumberToDeviceTreeMap(fast=False)
dev_foo = bd[1].FindDeviceNumber(11)
dev_bar = bd[1].FindDeviceNumber(12)
dev_battor_p7_h1_t0 = bd[2].FindDeviceNumber(21)
self.assertEquals(dev_foo.info['id'], 1011)
self.assertEquals(dev_bar.info['id'], 1012)
self.assertEquals(dev_battor_p7_h1_t0.info['id'], 2021)
def testSerialNumber(self):
bd = find_usb_devices.GetBusNumberToDeviceTreeMap(fast=False)
dev_foo = bd[1].FindDeviceNumber(11)
dev_bar = bd[1].FindDeviceNumber(12)
dev_battor_p7_h1_t0 = bd[2].FindDeviceNumber(21)
self.assertEquals(dev_foo.serial, 'FooSerial')
self.assertEquals(dev_bar.serial, 'BarSerial')
self.assertEquals(dev_battor_p7_h1_t0.serial, 'Battor0')
def testBattorDictMapping(self):
map_dict = {'Phone1':'Battor1', 'Phone2':'Battor2', 'Phone3':'Battor3'}
a1 = battor_device_mapping.GetBattorPathFromPhoneSerial(
'Phone1', serial_map=map_dict)
a2 = battor_device_mapping.GetBattorPathFromPhoneSerial(
'Phone2', serial_map=map_dict)
a3 = battor_device_mapping.GetBattorPathFromPhoneSerial(
'Phone3', serial_map=map_dict)
self.assertEquals(a1, '/dev/ttyUSB1')
self.assertEquals(a2, '/dev/ttyUSB2')
self.assertEquals(a3, '/dev/ttyUSB3')
def testBattorDictFromFileMapping(self):
try:
map_dict = {'Phone1':'Battor1', 'Phone2':'Battor2', 'Phone3':'Battor3'}
curr_dir = os.path.dirname(os.path.realpath(__file__))
filename = os.path.join(curr_dir, 'test', 'data', 'test_write_map.json')
battor_device_mapping.WriteSerialMapFile(filename, map_dict)
a1 = battor_device_mapping.GetBattorPathFromPhoneSerial(
'Phone1', serial_map_file=filename)
a2 = battor_device_mapping.GetBattorPathFromPhoneSerial(
'Phone2', serial_map_file=filename)
a3 = battor_device_mapping.GetBattorPathFromPhoneSerial(
'Phone3', serial_map_file=filename)
finally:
os.remove(filename)
self.assertEquals(a1, '/dev/ttyUSB1')
self.assertEquals(a2, '/dev/ttyUSB2')
self.assertEquals(a3, '/dev/ttyUSB3')
def testReadSerialMapFile(self):
curr_dir = os.path.dirname(os.path.realpath(__file__))
map_dict = battor_device_mapping.ReadSerialMapFile(
os.path.join(curr_dir, 'test', 'data', 'test_serial_map.json'))
self.assertEquals(len(map_dict.keys()), 3)
self.assertEquals(map_dict['Phone1'], 'Battor1')
self.assertEquals(map_dict['Phone2'], 'Battor2')
self.assertEquals(map_dict['Phone3'], 'Battor3')
original_PPTSM = find_usb_devices.GetAllPhysicalPortToSerialMaps
original_PPTTM = find_usb_devices.GetAllPhysicalPortToTTYMaps
original_GBL = battor_device_mapping.GetBattorList
original_GBNDM = find_usb_devices.GetBusNumberToDeviceTreeMap
original_IB = battor_device_mapping.IsBattor
original_GBSM = battor_device_mapping.GetBattorSerialNumbers
def setup_battor_test(serial, tty, battor, bser=None):
serial_mapper = mock.Mock(return_value=serial)
tty_mapper = mock.Mock(return_value=tty)
battor_lister = mock.Mock(return_value=battor)
devtree = mock.Mock(return_value=None)
is_battor = mock.Mock(side_effect=lambda x, y: x in battor)
battor_serials = mock.Mock(return_value=bser)
find_usb_devices.GetAllPhysicalPortToSerialMaps = serial_mapper
find_usb_devices.GetAllPhysicalPortToTTYMaps = tty_mapper
battor_device_mapping.GetBattorList = battor_lister
find_usb_devices.GetBusNumberToDeviceTreeMap = devtree
battor_device_mapping.IsBattor = is_battor
battor_device_mapping.GetBattorSerialNumbers = battor_serials
class BattorMappingTest(unittest.TestCase):
def tearDown(self):
find_usb_devices.GetAllPhysicalPortToSerialMaps = original_PPTSM
find_usb_devices.GetAllPhysicalPortToTTYMaps = original_PPTTM
battor_device_mapping.GetBattorList = original_GBL
find_usb_devices.GetBusNumberToDeviceTreeMap = original_GBNDM
battor_device_mapping.IsBattor = original_IB
battor_device_mapping.GetBattorSerialNumbers = original_GBSM
def test_generate_serial_map(self):
setup_battor_test([{1:'Phn1', 2:'Phn2', 3:'Phn3'},
{1:'Bat1', 2:'Bat2', 3:'Bat3'}],
[{},
{1:'ttyUSB0', 2:'ttyUSB1', 3:'ttyUSB2'}],
['ttyUSB0', 'ttyUSB1', 'ttyUSB2'],
['Bat1', 'Bat2', 'Bat3'])
result = battor_device_mapping.GenerateSerialMap()
self.assertEqual(len(result), 3)
self.assertEqual(result['Phn1'], 'Bat1')
self.assertEqual(result['Phn2'], 'Bat2')
self.assertEqual(result['Phn3'], 'Bat3')
if __name__ == "__main__":
logging.getLogger().setLevel(logging.DEBUG)
unittest.main(verbosity=2)
|
