blob: 9caf1aafab0a5520e3c41f8d4ab674a49b6ec1a9 [file] [log] [blame]
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -07001# Copyright 2015 The Chromium OS Authors. All rights reserved.
2# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4#
5# Expects to be run in an environment with sudo and no interactive password
6# prompt, such as within the Chromium OS development chroot.
7
8
9"""This file provides core logic for pdtester verify/repair process."""
10
11from autotest_lib.server.hosts import servo_host
12
13
14# Names of the host attributes in the database that represent the values for
15# the pdtester_host and pdtester_port for a PD tester connected to the DUT.
16PDTESTER_HOST_ATTR = 'pdtester_host'
17PDTESTER_PORT_ATTR = 'pdtester_port'
18
19
20def make_pdtester_hostname(dut_hostname):
21 """Given a DUT's hostname, return the hostname of its PD tester.
22
23 @param dut_hostname: hostname of a DUT.
24
25 @return hostname of the DUT's PD tester.
26
27 """
28 host_parts = dut_hostname.split('.')
29 host_parts[0] = host_parts[0] + '-pdtester'
30 return '.'.join(host_parts)
31
32
33class PDTesterHost(servo_host.ServoHost):
34 """Host class for a host that controls a PDTester object."""
35
36
Wai-Hong Tam16e5edb2019-09-17 16:10:07 -070037 def _initialize(self, pdtester_host='localhost', pdtester_port=9999,
38 *args, **dargs):
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -070039 """Initialize a PDTesterHost instance.
40
41 A PDTesterHost instance represents a host that controls a PD tester.
42
43 @param pdtester_host: Name of the host where the servod process
44 is running.
45 @param pdtester_port: Port the servod process is listening on.
46
47 """
48 super(PDTesterHost, self)._initialize(pdtester_host, pdtester_port,
Wai-Hong Tam16e5edb2019-09-17 16:10:07 -070049 *args, **dargs)
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -070050 self.connect_servo()
51
52
Wai-Hong Tam90b164d2019-10-25 13:15:39 -070053def create_pdtester_host(pdtester_args, servo_host):
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -070054 """Create a PDTesterHost object used to access pdtester servo
55
56 The `pdtester_args` parameter is a dictionary specifying optional
57 PDTester client parameter overrides (i.e. a specific host or port).
58 When specified, the caller requires that an exception be raised
59 unless both the PDTesterHost and the PDTester are successfully
60 created.
61
62 @param pdtester_args: A dictionary that contains args for creating
63 a PDTesterHost object,
Wai-Hong Tam16e5edb2019-09-17 16:10:07 -070064 e.g. {'pdtester_host': '172.11.11.111',
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -070065 'pdtester_port': 9999}.
Wai-Hong Tam90b164d2019-10-25 13:15:39 -070066 @param servo_host: If PDTester and Servo are the same, this
67 servo_host object will be returned.
Wai-Hong Tam16e5edb2019-09-17 16:10:07 -070068 @returns: A PDTesterHost object or None.
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -070069
70 """
Wai-Hong Tam16e5edb2019-09-17 16:10:07 -070071 # None means PDTester is not required to run a test.
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -070072 if pdtester_args is None:
73 return None
Wai-Hong Tam16e5edb2019-09-17 16:10:07 -070074
75 # If an user doesn't pass the PDTester info, fall back to use the servo
76 # info. Usually we use Servo v4 as PDTester, so make it default.
Wai-Hong Tam90b164d2019-10-25 13:15:39 -070077 if PDTESTER_HOST_ATTR not in pdtester_args:
78 pdtester_args[PDTESTER_HOST_ATTR] = servo_host.hostname
Wai-Hong Tam16e5edb2019-09-17 16:10:07 -070079
Wai-Hong Tam90b164d2019-10-25 13:15:39 -070080 if PDTESTER_PORT_ATTR not in pdtester_args:
81 pdtester_args[PDTESTER_PORT_ATTR] = servo_host.servo_port
82
83 # Just return the servo_host object, if the hostname and the port are the
84 # same as servo_host.
85 if (pdtester_args[PDTESTER_HOST_ATTR] == servo_host.hostname and
86 pdtester_args[PDTESTER_PORT_ATTR] == servo_host.servo_port):
87 return servo_host
Wai-Hong Tam16e5edb2019-09-17 16:10:07 -070088
89 return PDTesterHost(**pdtester_args)