[autotest] Add a script to generate dut-rpm-outlet-hydra mapping

Add a script which generates a csv file containing the mapping of
(device_hostname, rpm_hostname, outlet, hydra_hostname) for each
host in our lab. The csv file is in the following format.

chromeos2-row2-rack2-host1,chromeos2-row2-rack2-rpm1,.A1,chromeos-197-hydra1.mtv
chromeos2-row2-rack2-host2,chromeos2-row2-rack2-rpm1,.A2,chromeos-197-hydra1.mtv
...

The mapping information will be uploaded to afe database.

Workflow:
<Generate the csv file>
python generate_rpm_mapping.py --csv rpminfo.csv --server cautotest

<Upload mapping information in csv file to AFE>
python add_host_powerunit_info.py --csv rpminfo.csv

Also add --server option to add_host_powerunit_info.py

BUG=chromium:408177
TEST=run the script and manually examine its content.

Change-Id: I85f2e012d54666489869090d16019e88bf7831d2
Reviewed-on: https://chromium-review.googlesource.com/214550
Reviewed-by: Fang Deng <[email protected]>
Commit-Queue: Fang Deng <[email protected]>
Tested-by: Fang Deng <[email protected]>
diff --git a/contrib/generate_rpm_mapping.py b/contrib/generate_rpm_mapping.py
new file mode 100755
index 0000000..c2a2c70
--- /dev/null
+++ b/contrib/generate_rpm_mapping.py
@@ -0,0 +1,409 @@
+#! /usr/bin/python
+
+# Copyright (c) 2014 The Chromium OS Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+"""
+This script generates a csv file containing the mapping of
+(device_hostname, rpm_hostname, outlet, hydra_hostname) for each
+host in our lab. The csv file is in the following format.
+
+chromeos-rack2-host1,chromeos-rack2-rpm1,.A1,chromeos-197-hydra1.mtv
+chromeos-rack2-host2,chromeos-rack2-rpm1,.A2,chromeos-197-hydra1.mtv
+...
+
+The generated csv file can be used as input to add_host_powerunit_info.py
+
+Workflow:
+    <Generate the csv file>
+    python generate_rpm_mapping.py --csv mapping_file.csv --server cautotest
+
+    <Upload mapping information in csv file to AFE>
+    python add_host_powerunit_info.py --csv mapping_file.csv
+
+"""
+import argparse
+import collections
+import logging
+import re
+import sys
+
+import common
+
+from autotest_lib.client.common_lib import enum
+from autotest_lib.server.cros.dynamic_suite import frontend_wrappers
+
+CHROMEOS_LABS = enum.Enum('OysterBay', 'Atlantis', 'Chaos', 'Destiny', start_value=1)
+HOST_REGX = 'chromeos(\d+)(-row(\d+))*-rack(\d+)-host(\d+)'
+DeviceHostname = collections.namedtuple(
+        'DeviceHostname', ['lab', 'row', 'rack', 'host'])
+
+
+class BaseLabConfig(object):
+    """Base class for a lab configuration."""
+    RPM_OUTLET_MAP = {}
+    LAB_NUMBER = -1
+
+    @classmethod
+    def get_rpm_hostname(cls, device_hostname):
+        """Get rpm hostname given a device.
+
+        @param device_hostname: A DeviceHostname namedtuple.
+
+        @returns: the rpm hostname, default to empty string.
+
+        """
+        return ''
+
+
+    @classmethod
+    def get_rpm_outlet(cls, device_hostname):
+        """Get rpm outlet given a device.
+
+        @param device_hostname: A DeviceHostname namedtuple.
+
+        @returns: the rpm outlet, default to empty string.
+
+        """
+        return ''
+
+
+    @classmethod
+    def get_hydra_hostname(cls, device_hostname):
+        """Get hydra hostname given a device.
+
+        @param device_hostname: A DeviceHostname namedtuple.
+
+        @returns: the hydra hostname, default to empty string.
+
+        """
+        return ''
+
+
+    @classmethod
+    def is_device_in_the_lab(cls, device_hostname):
+        """Check whether a dut belongs to the lab.
+
+        @param device_hostname: A DeviceHostname namedtuple.
+
+        @returns: True if the dut belongs to the lab,
+                  False otherwise.
+
+        """
+        return device_hostname.lab == cls.LAB_NUMBER
+
+
+class OysterBayConfig(BaseLabConfig):
+    """Configuration for OysterBay"""
+
+    LAB_NUMBER = CHROMEOS_LABS.OYSTERBAY
+
+
+    @classmethod
+    def get_rpm_hostname(cls, device_hostname):
+        """Get rpm hostname.
+
+        @param device_hostname: A DeviceHostname namedtuple.
+
+        @returns: hostname of the rpm that has the device.
+
+        """
+        return 'chromeos%d-row%d-rack%d-rpm1' % (
+                device_hostname.lab, device_hostname.row,
+                device_hostname.rack)
+
+
+    @classmethod
+    def get_rpm_outlet(cls, device_hostname):
+        """Get rpm outlet.
+
+        @param device_hostname: A DeviceHostname namedtuple.
+
+        @returns: rpm outlet, e.g. '.A1'
+
+        """
+        return '.A%d' % device_hostname.host
+
+
+class AtlantisConfig(BaseLabConfig):
+    """Configuration for Atlantis lab."""
+
+    LAB_NUMBER = CHROMEOS_LABS.ATLANTIS
+    # chromeos2, hostX -> outlet
+    RPM_OUTLET_MAP = {
+            1: 1,
+            7: 2,
+            2: 4,
+            8: 5,
+            3: 7,
+            9: 8,
+            4: 9,
+            10: 10,
+            5: 12,
+            11: 13,
+            6: 15,
+            12: 16}
+
+    @classmethod
+    def get_rpm_hostname(cls, device_hostname):
+        """Get rpm hostname.
+
+        @param device_hostname: A DeviceHostname namedtuple.
+
+        @returns: hostname of the rpm that has the device.
+
+        """
+        return 'chromeos%d-row%d-rack%d-rpm1' % (
+                device_hostname.lab, device_hostname.row,
+                device_hostname.rack)
+
+
+    @classmethod
+    def get_rpm_outlet(cls, device_hostname):
+        """Get rpm outlet.
+
+        @param device_hostname: A DeviceHostname namedtuple.
+
+        @returns: rpm outlet, e.g. '.A1'
+
+        """
+        return '.A%d' % cls.RPM_OUTLET_MAP[device_hostname.host]
+
+
+    @classmethod
+    def get_hydra_hostname(cls, device_hostname):
+        """Get hydra hostname.
+
+        @param device_hostname: A DeviceHostname namedtuple.
+
+        @returns: hydra hostname
+
+        """
+        row = device_hostname.row
+        rack = device_hostname.rack
+        if row >= 1 and row <= 5 and rack >= 1 and rack <= 7:
+            return 'chromeos-197-hydra1.cros'
+        elif row >= 1 and row <= 5 and rack >= 8 and rack <= 11:
+            return 'chromeos-197-hydra2.cros'
+        else:
+            logging.error('Could not determine hydra for %s',
+                          device_hostname)
+            return ''
+
+
+class ChaosConfig(BaseLabConfig):
+    """Configuration for Chaos lab."""
+
+    LAB_NUMBER = CHROMEOS_LABS.CHAOS
+
+
+    @classmethod
+    def get_rpm_hostname(cls, device_hostname):
+        """Get rpm hostname.
+
+        @param device_hostname: A DeviceHostname namedtuple.
+
+        @returns: hostname of the rpm that has the device.
+
+        """
+        return 'chromeos%d-row%d-rack%d-rpm1' % (
+                device_hostname.lab, device_hostname.row,
+                device_hostname.rack)
+
+
+    @classmethod
+    def get_rpm_outlet(cls, device_hostname):
+        """Get rpm outlet.
+
+        @param device_hostname: A DeviceHostname namedtuple.
+
+        @returns: rpm outlet, e.g. '.A1'
+
+        """
+        return '.A%d' % device_hostname.host
+
+
+class DestinyConfig(BaseLabConfig):
+    """Configuration for Desitny lab."""
+
+    LAB_NUMBER = CHROMEOS_LABS.DESTINY
+    # chromeos4 # (rowX % 2, hostY) -> outlet
+    RPM_OUTLET_MAP = {
+            (1, 1): 1,
+            (0, 1): 2,
+            (1, 2): 4,
+            (0, 2): 5,
+            (1, 3): 7,
+            (0, 3): 8,
+            (1, 4): 9,
+            (0, 4): 10,
+            (1, 5): 12,
+            (0, 5): 13,
+            (1, 6): 15,
+            (0, 6): 16}
+
+
+    @classmethod
+    def get_rpm_hostname(cls, device_hostname):
+        """Get rpm hostname.
+
+        @param device_hostname: A DeviceHostname namedtuple.
+
+        @returns: hostname of the rpm that has the device.
+
+        """
+        row = device_hostname.row
+        if row % 2 == 0:
+            # Even # row
+            rpm_row = '%d_%d' % (row - 1, row)
+        else:
+            # Odd # row
+            rpm_row = '%d_%d' % (row, row + 1)
+        return 'chromeos%d-row%s-rack%d-rpm1' % (
+                device_hostname.lab,
+                rpm_row, device_hostname.rack)
+
+
+    @classmethod
+    def get_rpm_outlet(cls, device_hostname):
+        """Get rpm outlet.
+
+        @param device_hostname: A DeviceHostname namedtuple.
+
+        @returns: rpm outlet, e.g. '.A1'
+
+        """
+        try:
+            outlet_number = cls.RPM_OUTLET_MAP[
+                    (device_hostname.row % 2, device_hostname.host)]
+            return '.A%d' % outlet_number
+        except KeyError:
+            logging.error('Could not determine outlet for device %s',
+                          device_hostname)
+            return ''
+
+
+    @classmethod
+    def get_hydra_hostname(cls, device_hostname):
+        """Get hydra hostname.
+
+        @param device_hostname: A DeviceHostname namedtuple.
+
+        @returns: hydra hostname
+
+        """
+        row = device_hostname.row
+        rack = device_hostname.rack
+        if row >= 1 and row <= 6 and rack >=1 and rack <= 11:
+            return 'chromeos-destiny-hydra1.cros'
+        elif row >= 7 and row <= 12 and rack >=1 and rack <= 11:
+            return 'chromeos-destiny-hydra2.cros'
+        elif row >= 1 and row <= 10 and rack >=12 and rack <= 13:
+            return 'chromeos-destiny-hydra3.cros'
+        elif row in [3, 4, 5, 6, 9, 10] and rack == 0:
+            return 'chromeos-destiny-hydra3.cros'
+        elif row == 13 and rack >= 0 and rack <= 11:
+            return 'chromeos-destiny-hydra3.cros'
+        else:
+            logging.error('Could not determine hydra hostname for %s',
+                          device_hostname)
+            return ''
+
+
+def parse_device_hostname(device_hostname):
+    """Parse device_hostname to DeviceHostname object.
+
+    @param device_hostname: A string, e.g. 'chromeos2-row2-rack4-host3'
+
+    @returns: A DeviceHostname namedtuple or None if the
+              the hostname doesn't follow the pattern
+              defined in HOST_REGX.
+
+    """
+    m = re.match(HOST_REGX, device_hostname.strip())
+    if m:
+        return DeviceHostname(
+                lab=int(m.group(1)),
+                row=int(m.group(3)) if m.group(3) else None,
+                rack=int(m.group(4)),
+                host=int(m.group(5)))
+    else:
+        logging.error('Could not parse %s', device_hostname)
+        return None
+
+
+def generate_mapping(hosts, lab_configs):
+    """Generate device_hostname-rpm-outlet-hydra mapping.
+
+    @param hosts: hosts objects get from AFE.
+    @param lab_configs: A list of configuration classes,
+                        each one for a lab.
+
+    @returns: A dictionary that maps device_hostname to
+              (rpm_hostname, outlet, hydra_hostname)
+
+    """
+    # device hostname -> (rpm_hostname, outlet, hydra_hostname)
+    rpm_mapping = {}
+    for host in hosts:
+        device_hostname = parse_device_hostname(host.hostname)
+        if not device_hostname:
+            continue
+        for lab in lab_configs:
+            if lab.is_device_in_the_lab(device_hostname):
+                rpm_hostname = lab.get_rpm_hostname(device_hostname)
+                rpm_outlet = lab.get_rpm_outlet(device_hostname)
+                hydra_hostname = lab.get_hydra_hostname(device_hostname)
+                if not rpm_hostname or not rpm_outlet:
+                    logging.error(
+                            'Skipping device %s: could not determine '
+                            'rpm hostname or outlet.', host.hostname)
+                    break
+                rpm_mapping[host.hostname] = (
+                        rpm_hostname, rpm_outlet, hydra_hostname)
+                break
+        else:
+            logging.info(
+                    '%s is not in a know lab '
+                    '(oyster bay, atlantis, chaos, destiny)',
+                    host.hostname)
+    return rpm_mapping
+
+
+def output_csv(rpm_mapping, csv_file):
+    """Dump the rpm mapping dictionary to csv file.
+
+    @param rpm_mapping: A dictionary that maps device_hostname to
+                        (rpm_hostname, outlet, hydra_hostname)
+    @param csv_file: The name of the file to write to.
+
+    """
+    with open(csv_file, 'w') as f:
+        for hostname, rpm_info in rpm_mapping.iteritems():
+            line = ','.join(rpm_info)
+            line = ','.join([hostname, line])
+            f.write(line + '\n')
+
+
+if __name__ == '__main__':
+    logging.basicConfig(level=logging.DEBUG)
+    parser = argparse.ArgumentParser(
+            description='Generate device_hostname-rpm-outlet-hydra mapping '
+                        'file needed by add_host_powerunit_info.py')
+    parser.add_argument('--csv', type=str, dest='csv_file', required=True,
+                        help='The path to the csv file where we are going to '
+                             'write the mapping information to.')
+    parser.add_argument('--server', type=str, dest='server', default=None,
+                        help='AFE server that the script will be talking to. '
+                             'If not specified, will default to using the '
+                             'server in global_config.ini')
+    options = parser.parse_args()
+
+    AFE = frontend_wrappers.RetryingAFE(timeout_min=5, delay_sec=10,
+                                        server=options.server)
+    logging.info('Connected to %s', AFE.server)
+    rpm_mapping = generate_mapping(
+            AFE.get_hosts(),
+            [OysterBayConfig, AtlantisConfig, ChaosConfig, DestinyConfig])
+    output_csv(rpm_mapping, options.csv_file)