[pdu manager] introduce pdu manager

ansible/devutils

@@ -17,6 +17,7 @@ import sys
 sys.path.append("..")
 from tests.common.connections import ConsoleHost
 from tests.common.plugins.pdu_controller.snmp_pdu_controllers import get_pdu_controller
+from tests.common.plugins.pdu_controller.pdu_manager import pdu_manager_factory
 
 g_inv_mgr = None
 g_task_runner = None
@@ -53,12 +54,12 @@ def get_pdu_info(pdu_host):
         return g_pdu_dict[pdu_host]
 
     hosts = retrieve_hosts('all', pdu_host)
-    pdus=[]
+    pdus={}
     g_pdu_dict[pdu_host] = pdus
     for ph in pdu_host.split(','):
         if ph in hosts:
             pdu = hosts[ph]
-            pdus.append(pdu)
+            pdus[ph] = pdu
 
     return pdus
 
@@ -79,7 +80,7 @@ def action_list(parameters):
             data.append(dict(zip(header, (name, vars['ansible_host']))))
     else:
         for name, vars in hosts.items():
-            data.append((name, vars['ansible_host']))
+            data.append((name, vars['ansible_host'] if 'ansible_host' in vars else 'not_available'))
     show_data_output(header, data, parameters['json'])
 
 
@@ -146,35 +147,27 @@ def pdu_action_on_dut(host, attrs, action):
         ret['Summary'].append('PDU not found in inventory')
         return ret
 
-    for pdu_info in pdu_list:
-        pdu_host = pdu_info['ansible_host'] if pdu_info and 'ansible_host' in pdu_info else None
-        p_name = pdu_info['inventory_hostname'] if pdu_info and 'inventory_hostname' in pdu_info else None
-        if not pdu_host or not p_name:
-            ret['Summary'].append('No PDU IP or name')
-            continue
-
-        controller = get_pdu_controller(pdu_host, host, pdu_info)
-
-        if not controller:
-            ret['Summary'].append('Failed to communicate with controller {}'.format(p_name))
-            continue
-
-        status = controller.get_outlet_status()
-        if action == 'off':
-            for outlet in status:
-                controller.turn_off_outlet(outlet['outlet_id'])
-            status = controller.get_outlet_status()
-        elif action == 'on':
-            for outlet in status:
-                controller.turn_on_outlet(outlet['outlet_id'])
-            status = controller.get_outlet_status()
-        elif action != 'status':
-            ret['Summary'].append('Unsupported action {}.'.format(action))
-            continue
-
-        for outlet in status:
-            outlet.update({ 'PDU' : p_name, 'PDU_IP' : pdu_host })
-            ret['PDU status'].append(outlet)
+    # TODO: fake graph data to force building pdu manager from inventory until
+    #       we add code to read and construct the conn_graph_facts
+    fake_graph = { 'device_pdu_info' : {}, 'device_pdu_links' : {} }
+
+    pduman = pdu_manager_factory(host, pdu_list, fake_graph, pdu_list.values()[0])
+
+    if not pduman:
+        ret['Summary'].append('Failed to communicate with controller {}'.format(pdu_name))
+        return ret
+
+    if action == 'off':
+        pduman.turn_off_outlet()
+    elif action == 'on':
+        pduman.turn_on_outlet()
+    elif action != 'status':
+        ret['Summary'].append('Unsupported action {}.'.format(action))
+        return ret
+
+    status = pduman.get_outlet_status()
+    for outlet in status:
+        ret['PDU status'].append(outlet)
 
     return ret
 

tests/common/plugins/pdu_controller/__init__.py

@@ -1,63 +1,33 @@
 import logging
 
 import pytest
+from pdu_manager import pdu_manager_factory
 
 
-def pdu_controller_factory(controller_ip, controller_protocol, dut_hostname, pdu):
-    """
-    @summary: Factory function for creating PDU controller according to different management protocol.
-    @param controller_ip: IP address of the PDU controller host.
-    @param controller_protocol: Management protocol supported by the PDU controller host.
-    @param dut_hostname: Hostname of the DUT to be controlled by the PDU controller.
-    """
-    logging.info("Creating pdu controller object")
-    if controller_protocol == "snmp":
-        import snmp_pdu_controllers
-        return snmp_pdu_controllers.get_pdu_controller(controller_ip, dut_hostname, pdu)
+logger = logging.getLogger(__name__)
 
 
 @pytest.fixture(scope="module")
-def pdu_controller(duthosts, rand_one_dut_hostname, pdu):
+def pdu_controller(duthosts, rand_one_dut_hostname, conn_graph_facts, pdu):
     """
     @summary: Fixture for controlling power supply to PSUs of DUT
     @param duthost: Fixture duthost defined in sonic-mgmt/tests/conftest.py
     @returns: Returns a pdu controller object implementing the BasePduController interface defined in
               controller_base.py.
     """
     duthost = duthosts[rand_one_dut_hostname]
-
-    logging.info("Creating pdu_controller fixture")
     inv_mgr = duthost.host.options["inventory_manager"]
-    pdu_host = inv_mgr.get_host(duthost.hostname).get_vars().get("pdu_host")
-    if not pdu_host:
-        logging.info("No 'pdu_host' is defined in inventory file for '%s'. Unable to create pdu_controller" %
-                     duthost.hostname)
-        yield None
-        return
-
-    controller_vars = inv_mgr.get_host(pdu_host).get_vars()
-
-    controller_ip = controller_vars.get("ansible_host")
-    if not controller_ip:
-        logging.info("No 'ansible_host' is defined in inventory file for '%s'" % pdu_host)
-        logging.info("Unable to create pdu_controller for %s" % duthost.hostname)
-        yield None
-        return
-
-    controller_protocol = controller_vars.get("protocol")
-    if not controller_protocol:
-        logging.info("No protocol is defined in inventory file for '%s'. Try to use default 'snmp'" % pdu_host)
-        controller_protocol = "snmp"
+    pdu_host_list = inv_mgr.get_host(duthost.hostname).get_vars().get("pdu_host")
+    pdu_hosts = {}
+    for ph in pdu_host_list.split(','):
+        var_list = inv_mgr.get_host(ph).get_vars()
+        pdu_hosts[ph] = var_list
 
-    controller = pdu_controller_factory(controller_ip, controller_protocol, duthost.hostname, pdu)
+    controller = pdu_manager_factory(duthost.hostname, pdu_hosts, conn_graph_facts, pdu)
 
     yield controller
 
-    logging.info("pdu_controller fixture teardown, ensure that all PDU outlets are turned on after test")
+    logger.info("pdu_controller fixture teardown, ensure that all PDU outlets are turned on after test")
     if controller:
-        outlet_status = controller.get_outlet_status()
-        if outlet_status:
-            for outlet in outlet_status:
-                if not outlet["outlet_on"]:
-                    controller.turn_on_outlet(outlet["outlet_id"])
+        controller.turn_on_outlet()
         controller.close()