New Module: vyos_ping (#50193)

* New module for vyos ping functionality

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>

* Add some new parameters

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>

* Need spaces

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>

* Fix pylint errors

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>

* Fix pylint errors

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>

* Fix docs

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>

* Fix docs

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>

* Fix docs

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>

test/units/modules/network/vyos/fixtures/vyos_ping_ping_10.10.10.10_count_2

@@ -0,0 +1,7 @@
+PING 10.10.10.10 (10.10.10.10) 56(84) bytes of data.
+64 bytes from 10.10.10.10: icmp_req=1 ttl=255 time=1.27 ms
+64 bytes from 10.10.10.10: icmp_req=2 ttl=255 time=2.28 ms
+
+--- 10.8.38.66 ping statistics ---
+2 packets transmitted, 2 received, 0% packet loss, time 1001ms
+rtt min/avg/max/mdev = 12.1222/17.124/22.225/10.143 ms

test/units/modules/network/vyos/fixtures/vyos_ping_ping_10.10.10.11_count_10_ttl_128_size_512

@@ -0,0 +1,15 @@
+PING 10.10.10.11 (10.8.38.65) 512(540) bytes of data.
+520 bytes from 10.10.10.11: icmp_req=1 ttl=255 time=1.17 ms
+520 bytes from 10.10.10.11: icmp_req=2 ttl=255 time=1.32 ms
+520 bytes from 10.10.10.11: icmp_req=3 ttl=255 time=1.21 ms
+520 bytes from 10.10.10.11: icmp_req=4 ttl=255 time=1.46 ms
+520 bytes from 10.10.10.11: icmp_req=5 ttl=255 time=1.32 ms
+520 bytes from 10.10.10.11: icmp_req=6 ttl=255 time=1.28 ms
+520 bytes from 10.10.10.11: icmp_req=7 ttl=255 time=1.25 ms
+520 bytes from 10.10.10.11: icmp_req=8 ttl=255 time=1.23 ms
+520 bytes from 10.10.10.11: icmp_req=9 ttl=255 time=1.34 ms
+520 bytes from 10.10.10.11: icmp_req=10 ttl=255 time=21.0 ms
+
+--- 10.10.10.11 ping statistics ---
+10 packets transmitted, 10 received, 0% packet loss, time 9012ms
+rtt min/avg/max/mdev = 1.170/3.262/21.002/5.913 ms

test/units/modules/network/vyos/fixtures/vyos_ping_ping_10.10.10.20_count_4

@@ -0,0 +1,9 @@
+PING 10.10.10.20 (10.10.10.20) 56(84) bytes of data.
+From 10.10.10.20 icmp_seq=1 Destination Host Unreachable
+From 10.10.10.20 icmp_seq=2 Destination Host Unreachable
+From 10.10.10.20 icmp_seq=3 Destination Host Unreachable
+From 10.10.10.20 icmp_seq=4 Destination Host Unreachable
+
+--- 10.10.10.20 ping statistics ---
+4 packets transmitted, 0 received, +4 errors, 100% packet loss, time 3053ms
+pipe 3

test/units/modules/network/vyos/test_vyos_ping.py

@@ -0,0 +1,102 @@
+# (c) 2016 Red Hat Inc.
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+# Make coding more python3-ish
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+from units.compat.mock import patch
+from ansible.modules.network.vyos import vyos_ping
+from units.modules.utils import set_module_args
+from .vyos_module import TestVyosModule, load_fixture
+
+
+class TestVyosPingModule(TestVyosModule):
+
+    module = vyos_ping
+
+    def setUp(self):
+        super(TestVyosPingModule, self).setUp()
+        self.mock_run_commands = patch('ansible.modules.network.vyos.vyos_ping.run_commands')
+        self.run_commands = self.mock_run_commands.start()
+
+    def tearDown(self):
+        super(TestVyosPingModule, self).tearDown()
+        self.mock_run_commands.stop()
+
+    def load_fixtures(self, commands=None):
+        def load_from_file(*args, **kwargs):
+            commands = kwargs['commands']
+            output = list()
+
+            for command in commands:
+                filename = str(command).split(' | ')[0].replace(' ', '_')
+                output.append(load_fixture('vyos_ping_%s' % filename))
+            return output
+
+        self.run_commands.side_effect = load_from_file
+
+    def test_vyos_ping_expected_success(self):
+        ''' Test for successful pings when destination should be reachable '''
+        set_module_args(dict(count=2, dest="10.10.10.10"))
+        self.execute_module()
+
+    def test_vyos_ping_expected_failure(self):
+        ''' Test for unsuccessful pings when destination should not be reachable '''
+        set_module_args(dict(count=4, dest="10.10.10.20", state="absent"))
+        self.execute_module()
+
+    def test_vyos_ping_unexpected_success(self):
+        ''' Test for successful pings when destination should not be reachable - FAIL. '''
+        set_module_args(dict(count=2, dest="10.10.10.10", state="absent"))
+        self.execute_module(failed=True)
+
+    def test_vyos_ping_unexpected_failure(self):
+        ''' Test for unsuccessful pings when destination should be reachable - FAIL. '''
+        set_module_args(dict(count=4, dest="10.10.10.20"))
+        self.execute_module(failed=True)
+
+    def test_vyos_ping_failure_stats(self):
+        '''Test for asserting stats when ping fails'''
+        set_module_args(dict(count=4, dest="10.10.10.20"))
+        result = self.execute_module(failed=True)
+        self.assertEqual(result['packet_loss'], '100%')
+        self.assertEqual(result['packets_rx'], 0)
+        self.assertEqual(result['packets_tx'], 4)
+
+    def test_vyos_ping_success_stats(self):
+        '''Test for asserting stats when ping passes'''
+        set_module_args(dict(count=2, dest="10.10.10.10"))
+        result = self.execute_module()
+        self.assertEqual(result['packet_loss'], '0%')
+        self.assertEqual(result['packets_rx'], 2)
+        self.assertEqual(result['packets_tx'], 2)
+        self.assertEqual(result['rtt']['min'], 12)
+        self.assertEqual(result['rtt']['avg'], 17)
+        self.assertEqual(result['rtt']['max'], 22)
+        self.assertEqual(result['rtt']['mdev'], 10)
+
+    def test_vyos_ping_success_stats_with_options(self):
+        set_module_args(dict(count=10, ttl=128, size=512, dest="10.10.10.11"))
+        result = self.execute_module()
+        self.assertEqual(result['packet_loss'], '0%')
+        self.assertEqual(result['packets_rx'], 10)
+        self.assertEqual(result['packets_tx'], 10)
+        self.assertEqual(result['rtt']['min'], 1)
+        self.assertEqual(result['rtt']['avg'], 3)
+        self.assertEqual(result['rtt']['max'], 21)
+        self.assertEqual(result['rtt']['mdev'], 5)