Fix for ReadMe (#653)

* Fix for ReadMe

* Fix for ReadMe

* Fix for ReadMe

* Fix for ReadMe

Author: chidanandpujar

README.md

@@ -1,43 +1,30 @@
 [![Documentation Status](https://readthedocs.org/projects/junos-ansible-modules/badge/?version=stable)](https://junos-ansible-modules.readthedocs.io/en/2.3.0/)
 
-NOTE : The collection for Ansible is under development and changes are expected in the namespace/module implementation.  
-One may use it but it is recommended to currently use juniper.junos roles for professional implementation. 
-Refer - https://github.com/Juniper/ansible-junos-stdlib/tree/roles for more info. 
-
 # Juniper Ansible collection for Junos
 
-The repo is under active development.  If you take a clone, you are getting the latest, and perhaps not entirely stable code. 
-
 ## About
 
-Juniper Networks supports Ansible for managing devices running the Junos operating system (Junos OS). 
+Juniper Networks supports Ansible for managing devices running the Junos operating system (Junos OS and Junos Evolved). 
 This collection is hosted on the Ansible Galaxy website under the collection 
-[juniper.device](https://galaxy.ansible.com/Juniper/junos/). The juniper.device collection includes 
-a set of Ansible modules that perform specific operational and configuration tasks on devices running Junos OS. 
-These tasks include:
-installing and upgrading Junos OS, provisioning new Junos devices in the network, loading configuration changes,
+[juniper.device](https://galaxy.ansible.com/ui/repo/published/juniper/device/). 
+
+The `juniper.device` collection includes a set of Ansible modules that perform specific operational and configuration tasks on devices running Junos OS. 
+These tasks include: installing and upgrading Junos OS, provisioning new Junos devices in the network, loading configuration changes,
 retrieving information, and resetting, rebooting, or shutting down managed devices.  Please refer to the
 [INSTALLATION](#installation) section for instructions on installing this collection.
 
-## juniper.junos roles by Juniper Networks
-
-Ansible galaxy is upgrading to collections and plans to deprecate roles in future. The master branch will now have 
-juniper.device collection support. Juniper.junos roles have been moved to roles branch. 
-For more information for roles, check: 
-https://github.com/Juniper/ansible-junos-stdlib/tree/roles
-
 ## Two Sets of Ansible Modules for Junos devices
 
 Since Ansible version >= 2.1, Ansible also natively includes
-[core modules for Junos](http://docs.ansible.com/ansible/list_of_network_modules.html#junos). The Junos modules included
-in Ansible core have names which begin with the prefix `junos_`. The Junos modules included in this Juniper.device
+[core modules for Junos](https://docs.ansible.com/ansible/latest/collections/junipernetworks/junos/index.html#plugins-in-junipernetworks-junos). The Junos modules included
+in Ansible core have names which begin with the prefix `junos_`. The Junos modules included in this `Juniper.device`
 collection have names starting with module types. These two sets of Junos modules can coexist on the same
-Ansible control machine, and an Ansible play may invoke a module from either (or both) sets. Juniper Networks recommends
-using the modules in this collection when writing new playbooks that manage Junos devices.
+Ansible control machine, and an Ansible playbook may invoke a module from either (or both) sets. Juniper Networks recommends
+using the modules in `juniper.device` collection when writing new playbooks that manage Junos devices.
 
 ## Overview of Modules
 
-This juniper.device collection includes the following modules:
+This `juniper.device` collection includes the following modules:
 
 - **command** — Execute one or more CLI commands on a Junos device.
 - **config** — Manipulate the configuration of a Junos device.
@@ -53,11 +40,11 @@ This juniper.device collection includes the following modules:
 
 ### PyEZ Version Requirement
 
-For ansible collection juniper.device we will need to install junos-eznc(PyEZ) version 2.6.0 or higher. 
+For ansible collection `juniper.device` we will need to install [junos-eznc](https://github.com/Juniper/py-junos-eznc) version 2.6.0 or higher. 
 
 ### Overview of Plugins
 
-In addition to the modules listed above, a callback_plugin `jsnapy` is available for the module `jsnapy`.
+In addition to the modules listed above, a callback_plugin `jsnapy` is available for the module [jsnapy](https://github.com/Juniper/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 as shown in this example:
@@ -75,8 +62,6 @@ For each failed test, a log will be printed after the RECAP of the playbook as s
     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"}
 
-The `jsnapy` plugin is currently in **Experimental** stage, please provide feedback.
-
 Callback plugins are not activated by default. They must be manually added to the Ansible
 configuration file under the `[defaults]` section using the variable `callback_whitelist`. Specifically, these lines
 should be added to the Ansible configuration file in order to allow the jsnapy callback plugin:
@@ -88,7 +73,7 @@ should be added to the Ansible configuration file in order to allow the jsnapy c
 
 [Official Juniper documentation](http://www.juniper.net/techpubs/en_US/release-independent/junos-ansible/information-products/pathway-pages/index.html) (detailed information, including examples)
 
-[Ansible style documentation](http://junos-ansible-modules.readthedocs.org)
+[Ansible style documentation](https://ansible-juniper-collection.readthedocs.io/en/latest/)
 
 ## INSTALLATION
 
@@ -108,13 +93,13 @@ In MacOS Mojave and newer (>=10.14), ssh keys created with the system `ssh-keyge
 ### Ansible Galaxy collection
 
 You can use the ansible-galaxy install command to install the latest
-version of the juniper.device collection.
+version of the `juniper.device` collection.
 
 ```bash
 sudo ansible-galaxy collection install juniper.device
 ```
 
-You can also use the ansible-galaxy install command to install the latest development version of the junos role directly from GitHub.
+You can also use the ansible-galaxy install command to install the latest development version of the junos collections directly from GitHub.
 
 ```bash
 sudo ansible-galaxy collection install git+https://github.com/Juniper/ansible-junos-stdlib.git#/ansible_collections/juniper/device
@@ -167,7 +152,7 @@ You may have noticed that the base command is almost always the same. We can als
 
 ### Extending the container with additional packages
 
-It's possible to install additional OS (Alpine) packages, Python packages (via pip), and Ansible roles or collections at container instantiation. This can be done by passing in environment variables or bind mounting files.
+It's possible to install additional OS (Alpine) packages, Python packages (via pip), and Ansible collections at container instantiation. This can be done by passing in environment variables or binding mount files.
 
 #### OS Packages
 
@@ -188,7 +173,7 @@ As a bind mount.
 
 Environment Variable: `$REQ`
 Bind Mount: `/extras/requirements.txt`
-File Format: pip [requirements](https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format) file
+File Format: pip [requirements](https://pip.pypa.io/en/stable/reference/requirements-file-format/) file
 
 Examples:
 
@@ -256,19 +241,21 @@ This example outlines how to use Ansible to install or upgrade the software imag
 
 This modules requires the following to be installed on the Ansible control machine:
 
-- Python >= 3.7
+- Python >= 3.8
 - [Ansible](http://www.ansible.com) 2.9 or later
 - Junos [py-junos-eznc](https://github.com/Juniper/py-junos-eznc) 2.6.0 or later
 - [jxmlease](https://github.com/Juniper/jxmlease) 1.0.1 or later
+- [xmltodict](https://pypi.org/project/xmltodict/) 0.13.0 or later
+- [jsnapy](https://github.com/Juniper/jsnapy) 1.3.7 or later
 
 ## LICENSE
 
 Apache 2.0
 
 ## SUPPORT
 
-Support for this juniper.device collection is provided by the community and Juniper Networks. If you have an
-issue with a module in the juniper.device collection, you may:
+Support for this `juniper.device` collection is provided by the community and Juniper Networks. If you have an
+issue with a module in the `juniper.device` collection, you may:
 
 - Open a [GitHub issue](https://github.com/Juniper/ansible-junos-stdlib/issues).
 - Post a question on our [Google Group](https://groups.google.com/forum/#!forum/junos-python-ez)
@@ -284,8 +271,8 @@ Juniper Networks is actively contributing to and maintaining this repo. Please c
 [[email protected]]([email protected]) for any queries.
 
 *Contributors:*
-[Nitin Kumar](https://github.com/vnitinv), [Rahul Kumar](https://github.com/rahkumar651991), [Stephen Steiner](https://github.com/ntwrkguru)
+[Stephen Steiner](https://github.com/ntwrkguru), [Dinesh Babu](https://github.com/dineshbaburam91), [Chidanand Pujar](https://github.com/chidanandpujar)
 
 *Former Contributors:*
 
-[Stacy W Smith](https://github.com/stacywsmith), [Jeremy Schulman](https://github.com/jeremyschulman), [Rick Sherman](https://github.com/shermdog), [Damien Garros](https://github.com/dgarros), [David Gethings](https://github.com/dgjnpr)
+[Stacy W Smith](https://github.com/stacywsmith), [Jeremy Schulman](https://github.com/jeremyschulman), [Rick Sherman](https://github.com/shermdog), [Damien Garros](https://github.com/dgarros), [David Gethings](https://github.com/dgjnpr), [Nitin Kumar](https://github.com/vnitinv), [Rahul Kumar](https://github.com/rahkumar651991)

tests/README.md

@@ -0,0 +1,61 @@
+# Functional Tests for Juniper Ansible collection for Junos
+
+Following are the steps to execute Ansible Functional test playbooks
+
+## Steps to execute Ansible Functional test playbooks
+
+1. Git clone the functional tests 
+```
+git clone https://github.com/Juniper/ansible-junos-stdlib.git
+```
+2. Change directory to ansible-junos-stdlib/tests
+```
+cd ansible-junos-stdlib/tests/
+```
+3. Update the ansible.cfg under tests directory 
+```
+[defaults]
+hash_behaviour=merge
+inventory = inventory
+host_key_checking = False
+log_path = ./ansible.log
+
+[persistent_connection]
+command_timeout = 300
+```
+4. To execute test playbook with Local connection, you need to update the inventory file for local connection test cases by setting ansible_connection=local
+```
+[junos]
+local_connection_testcases  ansible_host=xx.xx.xx.xx  ansible_user=xyz  ansible_pass=xyz ansible_port=22 ansible_connection=local ansible_command_timeout=300
+
+[all:vars]
+ansible_python_interpreter=<Python interpreter path>
+```
+5. To execute test playbook with PyEZ persistent connection, you need to update the inventory file for persistent connection test cases by setting ansible_connection=juniper.device.pyez
+``` 
+[junos]
+pyez_connection_testcases  ansible_host=xx.xx.xx.xx  ansible_user=xyz  ansible_ssh_pass=xyz ansible_port=22 ansible_connection=juniper.device.pyez ansible_command_timeout=300
+
+[all:vars]
+ansible_python_interpreter=<Python interpreter path>
+```
+6. To execute Functional test playbooks
+ansible-playbook <playbook name>
+```
+ansible-playbook pb.juniper_junos_system.yml
+```
+### NOTE: 
+
+To execute pb.juniper_junos_software_member.yml playbook, you have to use the following devices
+
+Virtual Chassis - EX-VC, MX-VC 
+
+To execute pb.juniper_junos_srx_cluster.yml playbook, you have to use the following devices
+
+SRX HA Cluster enabled devices
+
+### Ansible Fixes :
+For the PyEZ persistent connection support, you need to apply the following fix for Ansible issue 
+```
+https://github.com/Juniper/ansible-junos-stdlib/issues/606
+```