Deprecate ansible_host.py (#1658)

* Deprecate ansible_host.py

The functionalities in ansible_host.py , including the
AnsibleHost class and some exceptions, have been
implemented in the common library. This file can
be deprecated in case people new to sonic-mgmt
waste time on old libraries.

Changes:
1. Remove ansible_host.py
2. Replace all the AnsibleHost related calls with
    more appropriate fixtures or functions.
3. Remove duplicated localhost fixture definition

Signed-off-by: Xin Wang <[email protected]>

Author: wangxin

tests/ansible_host.py

@@ -1,4 +1,3 @@
-from ansible_host import AnsibleHost
 
 def test_bgp_facts(duthost):
     """compare the bgp facts between observed states and target state"""

tests/bgp/test_bgp_fact.py

@@ -60,7 +60,7 @@ def run_module(module_args, complex_args):
 
         res = self.module(*module_args, **complex_args)[self.hostname]
         if res.is_failed and not module_ignore_errors:
-            raise RunAnsibleModuleFail("run module {} failed, errmsg {}".format(self.module_name, res))
+            raise RunAnsibleModuleFail("run module {} failed".format(self.module_name), res)
 
         return res
 

tests/common/devices.py

@@ -1,8 +1,26 @@
 """
 Customize exceptions
 """
+from ansible.plugins.loader import callback_loader
+from ansible.errors import AnsibleError
+
+
 class UnsupportedAnsibleModule(Exception):
     pass
 
-class RunAnsibleModuleFail(Exception):
-    pass
+
+def dump_ansible_results(results, stdout_callback='yaml'):
+    cb = callback_loader.get(stdout_callback)
+    return cb._dump_results(results) if cb else results
+
+
+class RunAnsibleModuleFail(AnsibleError):
+
+    """Sub-class AnsibleError when module exceptions occur."""
+
+    def __init__(self, msg, results=None):
+        super(RunAnsibleModuleFail, self).__init__(msg)
+        self.results = results
+
+    def __str__(self):
+        return "{}\nAnsible Results => {}".format(self.message, dump_ansible_results(self.results))

tests/common/errors.py

@@ -15,17 +15,3 @@ def ansible_adhoc(request):
     def init_host_mgr(**kwargs):
         return plugin.initialize(request.config, request, **kwargs)
     return init_host_mgr
-
-
-# Same as for ansible_adhoc, let's have localhost fixture with session scope
-# as it feels that during session run the localhost object should persist unchanged.
-# Also, we have autouse=True here to force pytest to evaluate localhost fixture to overcome
-# some hidden dependency between localhost and ansible_adhoc (even with default scope) (FIXME)
-@pytest.fixture(scope='session', autouse=True)
-def localhost(request):
-    """Return a host manager representing localhost."""
-    # NOTE: Do not use ansible_adhoc as a dependent fixture since that will assert specific command-line parameters have
-    # been supplied.  In the case of localhost, the parameters are provided as kwargs below.
-    plugin = request.config.pluginmanager.getplugin("ansible")
-    return plugin.initialize(request.config, request, inventory='localhost,', connection='local',
-                             host_pattern='localhost').localhost

tests/common/plugins/ansible_fixtures.py

@@ -3,7 +3,6 @@
 import pytest
 
 from ptfadapter import PtfTestAdapter
-from ansible_host import AnsibleHost
 
 DEFAULT_PTF_NN_PORT = 10900
 DEFAULT_DEVICE_NUM = 0

tests/common/plugins/ptfadapter/__init__.py

@@ -1,7 +1,7 @@
 import time
 import logging
 from multiprocessing.pool import ThreadPool, TimeoutError
-from ansible_host import AnsibleModuleException
+from errors import RunAnsibleModuleFail
 
 logger = logging.getLogger(__name__)
 
@@ -148,8 +148,8 @@ def execute_reboot_helper():
         while finalizer_state == 'activating':
             try:
                 res = duthost.command('systemctl is-active warmboot-finalizer.service',module_ignore_errors=True)
-            except AnsibleModuleException as err:
-                res = err.module_result
+            except RunAnsibleModuleFail as err:
+                res = err.results
 
             finalizer_state = res['stdout'].strip()
             logger.info('warmboot finalizer service state {}'.format(finalizer_state))

tests/common/reboot.py

@@ -11,13 +11,14 @@
 import tarfile
 import logging
 import time
+import string
+import re
 
 import pytest
 import csv
 import yaml
 import ipaddr as ipaddress
 
-from ansible_host import AnsibleHost
 from collections import defaultdict
 from common.fixtures.conn_graph_facts import conn_graph_facts
 from common.devices import SonicHost, Localhost, PTFHost, EosHost, FanoutHost
@@ -173,6 +174,7 @@ def testbed_devices(ansible_adhoc, testbed, duthost):
 
     return devices
 
+
 def disable_ssh_timout(dut):
     '''
     @summary disable ssh session on target dut
@@ -225,12 +227,20 @@ def duthost(ansible_adhoc, testbed, request):
 
 
 @pytest.fixture(scope="module")
-def ptfhost(testbed_devices):
-    """
-    Shortcut fixture for getting PTF host
-    """
+def localhost(ansible_adhoc):
+    return Localhost(ansible_adhoc)
+
+
+@pytest.fixture(scope="module")
+def ptfhost(ansible_adhoc, testbed):
+    if "ptf" in testbed:
+        return PTFHost(ansible_adhoc, testbed["ptf"])
+    else:
+        # when no ptf defined in testbed.csv
+        # try to parse it from inventory
+        ptf_host = duthost.host.options["inventory_manager"].get_host(duthost.hostname).get_vars()["ptf_host"]
+        return PTFHost(ansible_adhoc, ptf_host)
 
-    return testbed_devices["ptf"]
 
 @pytest.fixture(scope="module")
 def nbrhosts(ansible_adhoc, testbed, creds):

tests/conftest.py

@@ -1,4 +1,3 @@
-from ansible_host import AnsibleHost
 
 import pytest
 import ptf.testutils as testutils
@@ -168,7 +167,7 @@ def test_fdb(ansible_adhoc, testbed, ptfadapter, duthost, ptfhost, pkt_type):
     host_facts  = duthost.setup()['ansible_facts']
     conf_facts = duthost.config_facts(host=duthost.hostname, source="persistent")['ansible_facts']
 
-    # remove existing IPs from PTF host 
+    # remove existing IPs from PTF host
     ptfhost.script('scripts/remove_ip.sh')
     # set unique MACs to PTF interfaces
     ptfhost.script('scripts/change_mac.sh')

tests/fdb/test_fdb.py

@@ -1,4 +1,3 @@
-from ansible_host import AnsibleHost
 import logging
 import pytest
 
@@ -32,15 +31,14 @@ def test_lldp(duthost, localhost, collect_techsupport):
         assert v['port']['ifname'] == mg_facts['minigraph_neighbors'][k]['port']
 
 
-def test_lldp_neighbor(duthost, localhost, ansible_adhoc, eos, collect_techsupport):
+def test_lldp_neighbor(duthost, localhost, eos, collect_techsupport):
     """ verify LLDP information on neighbors """
 
     mg_facts  = duthost.minigraph_facts(host=duthost.hostname)['ansible_facts']
     res = duthost.shell("docker exec -i lldp lldpcli show chassis | grep \"SysDescr:\" | sed -e 's/^\\s*SysDescr:\\s*//g'")
     dut_system_description = res['stdout']
     lldp_facts = duthost.lldp()['ansible_facts']
     host_facts  = duthost.setup()['ansible_facts']
-    lhost = AnsibleHost(ansible_adhoc, 'localhost', True)
 
     config_facts  = duthost.config_facts(host=duthost.hostname, source="running")['ansible_facts']
     nei_meta = config_facts.get('DEVICE_NEIGHBOR_METADATA', {})
@@ -56,7 +54,7 @@ def test_lldp_neighbor(duthost, localhost, ansible_adhoc, eos, collect_techsuppo
             logger.info("Neighbor device {} does not sent management IP via lldp".format(v['chassis']['name']))
             hostip = nei_meta[v['chassis']['name']]['mgmt_addr']
 
-        nei_lldp_facts = lhost.lldp_facts(host=hostip, version='v2c', community=eos['snmp_rocommunity'])['ansible_facts']
+        nei_lldp_facts = localhost.lldp_facts(host=hostip, version='v2c', community=eos['snmp_rocommunity'])['ansible_facts']
         print nei_lldp_facts
         neighbor_interface = v['port']['ifname']
         # Verify the published DUT system name field is correct