Merge pull request #155 from dgarros/jsnapy_refactor

Jsnapy refactor proposal related to #154

Author: vnitinv

README.md

@@ -16,6 +16,37 @@ Juniper Networks provides support for using Ansible to deploy devices running th
 - junos_srx_cluster — Enable/Disable cluster mode for SRX devices
 - junos_zeroize — Remove all configuration information on the Routing Engines and reset all key values on a device.
 
+### OVERVIEW OF PLUGINS
+
+In addition to the modules listed above, a callback_plugin `jsnapy` is available for the module `junos_jsnapy`.
+
+The callback_plugin `jsnapy` helps to print on the screen additional information regarding
+ jsnapy failed tests.
+For each failed test, a log will be printed after the RECAP of the playbook.  
+
+> The plugin `jsnapy` is currently in **Experimental** stage, please provide feedback.
+
+```
+PLAY RECAP *********************************************************************
+qfx10002-01                : ok=3    changed=0    unreachable=0    failed=1
+qfx10002-02                : ok=3    changed=0    unreachable=0    failed=1
+qfx5100-01                 : ok=1    changed=0    unreachable=0    failed=1
+
+JSNAPy Results for: qfx10002-01 ************************************************
+Value of 'peer-state' not 'is-equal' at '//bgp-information/bgp-peer' with {"peer-as": "65200", "peer-state": "Active", "peer-address": "100.0.0.21"}
+Value of 'peer-state' not 'is-equal' at '//bgp-information/bgp-peer' with {"peer-as": "60021", "peer-state": "Idle", "peer-address": "192.168.0.1"}
+Value of 'oper-status' not 'is-equal' at '//interface-information/physical-interface[normalize-space(admin-status)='up' and logical-interface/address-family/address-family-name ]' with {"oper-status": "down", "name": "et-0/0/18"}
+
+JSNAPy Results for: qfx10002-02 ************************************************
+Value of 'peer-state' not 'is-equal' at '//bgp-information/bgp-peer' with {"peer-as": "65200", "peer-state": "Active", "peer-address": "100.0.0.21"}
+```
+
+Callback plugins are not activated by default and needs to be manually added to the
+configuration file under `[defaults]` with the variable `callback_whitelist`
+```
+[defaults]
+callback_whitelist = jsnapy
+```
 ## DOCUMENTATION
 
 [Official documentation](http://www.juniper.net/techpubs/en_US/release-independent/junos-ansible/information-products/pathway-pages/index.html) (detailed information, includes examples)
@@ -42,7 +73,7 @@ To download the junos role to the Ansible server, execute the ansible-galaxy ins
 For testing you can `git clone` this repo and run the `env-setup` script in the repo directory:
 
     user@ansible-junos-stdlib> source env-setup
-    
+
 This will set your `$ANSIBLE_LIBRARY` variable to the repo location and the installed Ansible library path.  For example:
 
 ````
@@ -100,7 +131,7 @@ Thes modules require the following to be installed on the Ansible server:
 ## LICENSE
 
 Apache 2.0
-  
+
 ## CONTRIBUTORS
 
 Juniper Networks is actively contributing to and maintaining this repo. Please contact [email protected] for any queries.

callback_plugins/jsnapy.py

@@ -0,0 +1,74 @@
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import collections
+import os
+import time
+import pprint
+import json
+
+from ansible.plugins.callback import CallbackBase
+from ansible import constants as C
+
+class CallbackModule(CallbackBase):
+  """
+  This callback add extra logging for the module junos_jsnapy .
+  """
+  CALLBACK_VERSION = 2.0
+  CALLBACK_TYPE = 'aggregate'
+  CALLBACK_NAME = 'jsnapy'
+
+## useful links regarding Callback
+## https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/callback/__init__.py
+
+  def __init__(self):
+    self._pp = pprint.PrettyPrinter(indent=4)
+    self._results = {}
+
+    super(CallbackModule, self).__init__()
+
+  def v2_runner_on_ok(self, result):
+    """
+    Collect test results for all tests executed if module is junos_jsnapy
+    """
+
+    ## Extract module name
+    module_name = ''
+    if 'invocation' in result._result:
+      if 'module_name' in result._result['invocation']:
+        module_name = result._result['invocation']['module_name']
+
+    if module_name == 'junos_jsnapy':
+      ## Check if dict entry already exist for this host
+      host = result._host.name
+      if not host in self._results.keys():
+        self._results[host] = []
+
+      self._results[host].append(result)
+
+  def v2_playbook_on_stats(self, stats):
+
+    ## Go over all results for all hosts
+    for host, results in self._results.iteritems():
+      has_printed_banner = False
+      for result in results:
+        # self._pp.pprint(result.__dict__)
+        res = result._result
+        if res['final_result'] == "Failed":
+          for test_name, test_results in res['test_results'].iteritems():
+            for testlet in test_results:
+              if testlet['count']['fail'] != 0:
+
+                if not has_printed_banner:
+                  self._display.banner("JSNAPy Results for: " + str(host))
+                  has_printed_banner = True
+
+                for test in testlet['failed']:
+                  self._display.display(
+                    "Value of '{0}' not '{1}' at '{2}' with {3}".format(
+                      str(testlet['node_name']),
+                      str(testlet['testoperation']),
+                      str(testlet['xpath']),
+                      json.dumps(test['post'])),
+                    color=C.COLOR_ERROR)

library/junos_jsnapy

@@ -36,14 +36,22 @@
 DOCUMENTATION = '''
 ---
 module: junos_jsnapy
-author: Roslan Zaki, Juniper Networks
-version_added: "1.0.0"
+author: Roslan Zaki & Damien Garros, Juniper Networks
+version_added: "1.4.0"
 version_control:
     13-Apr-2016     v1.0.0      - Basic working model
 
-Short_description: Integrate JSnapy to ansible
+Short_description: Integrate JSnapy to ansible.
 description:
-    - Execute JSnapy module from Ansible
+    - Execute JSnapy test from Ansible.
+      Attention, to not break Ansible behavior, this module only report "failed"
+      if the module itself fails, not if a test fails.
+      To check the test results you need to subscribe to the result and assert
+      the returned value.
+      An experimental Callback_Plugin for junos_jsnapy is available to provide
+      additional information about tests that failed.
+      To enable it, you need to add "callback_whitelist = jsnapy" in your ansible
+      configuration file.
 requirements:
     - junos-eznc >= 1.2.2
 options:
@@ -114,20 +122,41 @@ options:
 EXAMPLES = '''
    - name: JUNOS Post Checklist
      junos_jsnapy:
-     host: "{{ inventory_hostname}}"
-     passwd: "{{ tm1_password }}"
-     action: "snap_post"
-     config_file: "first_test.yml"
-     logfile: "migration_post.log"
-     register: jsnapy
+       host: "{{ inventory_hostname}}"
+       passwd: "{{ tm1_password }}"
+       action: "snap_post"
+       config_file: "first_test.yml"
+       logfile: "migration_post.log"
+     register: test1
+
+   - name: Check JSNAPy tests results
+     assert:
+     that:
+       - "test1.passPercentage == 100"
 
    - name: Debug jsnapy
-     debug: msg="{{jsnapy}}"
+     debug: msg=test1
+
+---------
+   - name: Test based on a test_file directly
+     junos_jsnapy:
+       host: "{{ junos_host }}"
+       port: "{{ netconf_port }}"
+       user: "{{ ansible_ssh_user }}"
+       passwd: "{{ ansible_ssh_pass }}"
+       test_files: tests/test_junos_interface.yaml
+       action: snapcheck
+     register: test1
 
+   - name: Check JSNAPy tests results
+     assert:
+     that:
+       - "test1.passPercentage == 100"
 '''
 from distutils.version import LooseVersion
 import logging
 from lxml.builder import E
+import os.path
 import os
 import time
 
@@ -153,6 +182,13 @@ def jsnap_selection(dev, module):
         config_data = os.path.join(config_dir, config_file)
     else:
         test_files = args.get('test_files')
+
+        for test_file in test_files:
+            if not os.path.isfile(test_file):
+                msg = 'unable to find the test file {0}'.format(test_file)
+                logging.error(msg)
+                module.fail_json(msg=msg)
+
         config_data = {'tests': test_files}
 
     results = {}
@@ -167,6 +203,7 @@ def jsnap_selection(dev, module):
     elif action == 'check':
         snapValue = js.check(data=config_data, dev=dev, pre_file='PRE', post_file='POST')
 
+    percentagePassed = 0
     if isinstance(snapValue, (list)):
         for snapCheck in snapValue:
             router = snapCheck.device
@@ -177,7 +214,10 @@ def jsnap_selection(dev, module):
             results['test_results'] = snapCheck.test_results
             total_test = int(snapCheck.no_passed) + int(snapCheck.no_failed)
             results['total_tests'] = total_test
-        percentagePassed = (int(results['total_passed']) * 100 ) / (results['total_tests'])
+
+        if total_test != 0:
+            percentagePassed = (int(results['total_passed']) * 100 ) / (results['total_tests'])
+
         results['passPercentage'] = percentagePassed
 
     return results
@@ -203,7 +243,7 @@ def main():
     args = module.params
     results = {}
 
-    if import_err_message is not None: 
+    if import_err_message is not None:
         module.fail_json(msg=import_err_message)
 
     if args['mode'] is not None and LooseVersion(VERSION) < LooseVersion('2.0.0'):
@@ -236,7 +276,7 @@ def main():
             )
             logging.error(msg)
             dev.close()
-            module.fail_json(msg=msg, **data)
+            module.exit_json(msg=msg, **data)
 
     except Exception as err:
         msg = 'Uncaught exception - please report: {0}'.format(str(err))