Merge pull request #1 from arista-eosplus/develop

change banners via system api

pyeapi/api/bgp.py

@@ -161,12 +161,18 @@ def set_shutdown(self, default=False, disable=True):
         return self.configure_bgp(cmd)
 
     def add_network(self, prefix, length, route_map=None):
+        if prefix == '' or length == '':
+            raise ValueError('network prefix and length values '
+                             'may not be empty')
         cmd = 'network {}/{}'.format(prefix, length)
         if route_map:
             cmd += ' route-map {}'.format(route_map)
         return self.configure_bgp(cmd)
 
     def remove_network(self, prefix, masklen, route_map=None):
+        if prefix == '' or masklen == '':
+            raise ValueError('network prefix and length values '
+                             'may not be empty')
         cmd = 'no network {}/{}'.format(prefix, masklen)
         if route_map:
             cmd += ' route-map {}'.format(route_map)

pyeapi/api/ntp.py

@@ -0,0 +1,196 @@
+#
+# Copyright (c) 2015, Arista Networks, Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#   Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+#   Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+#   Neither the name of Arista Networks nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ARISTA NETWORKS
+# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+# IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+"""Module for managing the NTP configuration in EOS
+
+This module provides an API for configuring NTP resources using
+EOS and eAPI.
+
+Arguments:
+    name (string): The interface port that specifies the NTP source.
+"""
+
+import re
+
+from pyeapi.api import Entity
+
+
+class Ntp(Entity):
+    """The Ntp class implements global NTP router configuration
+    """
+
+    def __init__(self, *args, **kwargs):
+        super(Ntp, self).__init__(*args, **kwargs)
+
+    def get(self):
+        """Returns the current NTP configuration
+
+        The Ntp resource returns the following:
+
+            * source_interface (str): The interface port that specifies
+                                      NTP server
+            * servers (list): A list of the NTP servers that have been
+                              assigned to the node. Each entry in the
+                              list is a key/value pair of the name of
+                              the server as the key and None or 'prefer'
+                              as the value if the server is preferred.
+
+        Returns:
+            A Python dictionary object of key/value pairs that represents
+            the current NTP configuration of the node::
+
+                {
+                    "source_interface": 'Loopback0',
+                    'servers': [
+                        { '1.1.1.1': None },
+                        { '1.1.1.2': 'prefer' },
+                        { '1.1.1.3': 'prefer' },
+                        { '1.1.1.4': None },
+                    ]
+                }
+        """
+        config = self.config
+        if not config:
+            return None
+
+        response = dict()
+        response.update(self._parse_source_interface(config))
+        response.update(self._parse_servers(config))
+
+        return response
+
+    def _parse_source_interface(self, config):
+        match = re.search(r'^ntp source ([^\s]+)', config, re.M)
+        value = match.group(1) if match else None
+        return dict(source_interface=value)
+
+    def _parse_servers(self, config):
+        matches = re.findall(r'ntp server ([\S]+) ?(prefer)?', config, re.M)
+        value = []
+        for match in matches:
+            server = match[0]
+            prefer = match[1] if match[1] == 'prefer' else None
+            value.append({server: prefer})
+        return dict(servers=value)
+
+    def create(self, name):
+        """Instantiate the NTP by setting the source interface.
+
+        Args:
+            name (string): The interface port that specifies the NTP source.
+
+        Returns:
+            True if the operation succeeds, otherwise False.
+        """
+        return self.set_source_interface(name)
+
+    def delete(self):
+        """Delete the NTP source entry from the node.
+
+        Returns:
+            True if the operation succeeds, otherwise False.
+        """
+        cmd = self.command_builder('ntp source', disable=True)
+        return self.configure(cmd)
+
+    def default(self):
+        """Default the NTP source entry from the node.
+
+        Returns:
+            True if the operation succeeds, otherwise False.
+        """
+        cmd = self.command_builder('ntp source', default=True)
+        return self.configure(cmd)
+
+    def set_source_interface(self, name):
+        """Assign the NTP source on the node
+
+        Args:
+            name (string): The interface port that specifies the NTP source.
+
+        Returns:
+            True if the operation succeeds, otherwise False.
+        """
+        cmd = self.command_builder('ntp source', value=name)
+        return self.configure(cmd)
+
+    def add_server(self, name, prefer=False):
+        """Add or update an NTP server entry to the node config
+
+        Args:
+            name (string): The IP address or FQDN of the NTP server.
+            prefer (bool): Sets the NTP server entry as preferred if True.
+
+        Returns:
+            True if the operation succeeds, otherwise False.
+        """
+        if not name or re.match(r'^[\s]+$', name):
+            raise ValueError('ntp server name must be specified')
+        if prefer:
+            name = '%s prefer' % name
+        cmd = self.command_builder('ntp server', value=name)
+        return self.configure(cmd)
+
+    def remove_server(self, name):
+        """Remove an NTP server entry from the node config
+
+        Args:
+            name (string): The IP address or FQDN of the NTP server.
+
+        Returns:
+            True if the operation succeeds, otherwise False.
+        """
+        cmd = self.command_builder('no ntp server', value=name)
+        return self.configure(cmd)
+
+    def remove_all_servers(self):
+        """Remove all NTP server entries from the node config
+
+        Returns:
+            True if the operation succeeds, otherwise False.
+        """
+        # 'no ntp' removes all server entries.
+        # For command_builder, disable command 'ntp' gives the desired command
+        cmd = self.command_builder('ntp', disable=True)
+        return self.configure(cmd)
+
+
+def instance(node):
+    """Returns an instance of Ntp
+
+    Args:
+        node (Node): The node argument passes an instance of Node to the
+            resource
+
+    Returns:
+        object: An instance of Ntp
+    """
+    return Ntp(node)

setup.py

@@ -81,7 +81,7 @@ def install():
 
 # Use the following to dynamically build pyeapi module documentation
 if install() and environ.get('READTHEDOCS'):
-    print 'This method is only called by READTHEDOCS.'
+    print('This method is only called by READTHEDOCS.')
     from subprocess import Popen
     proc = Popen(['make', 'modules'], cwd='docs/')
     (_, err) = proc.communicate()

test/fixtures/running_config.text

@@ -241,6 +241,12 @@ ip host puppet 192.168.1.130
 !
 no ntp trusted-key
 no ntp authenticate
+ntp source Loopback1
+ntp server 1.2.3.4 prefer
+ntp server 10.20.30.40
+ntp server 11.22.33.44
+ntp server 123.33.22.11 prefer
+ntp server 123.44.55.66
 ntp server 192.168.1.32 iburst
 no ntp serve all
 !

test/system/test_api_ntp.py

@@ -0,0 +1,157 @@
+#
+# Copyright (c) 2015, Arista Networks, Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#   Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+#   Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+#   Neither the name of Arista Networks nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ARISTA NETWORKS
+# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+# IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+import os
+import unittest
+import itertools
+
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), '../lib'))
+
+from systestlib import DutSystemTest
+
+
+class TestApiNtp(DutSystemTest):
+
+    def test_get(self):
+        for dut in self.duts:
+            dut.config(['ntp source Ethernet1', 'ntp server 99.99.1.1'])
+            response = dut.api('ntp').get()
+            self.assertIsNotNone(response)
+
+    def test_create(self):
+        intf = 'Ethernet1'
+        for dut in self.duts:
+            dut.config(['no ntp source'])
+            response = dut.api('ntp').create(intf)
+            self.assertTrue(response)
+            response = dut.api('ntp').get()
+            self.assertEqual(response['source_interface'], intf)
+
+    def test_delete(self):
+        for dut in self.duts:
+            dut.config(['ntp source Ethernet1'])
+            response = dut.api('ntp').delete()
+            self.assertTrue(response)
+            response = dut.api('ntp').get()
+            self.assertIsNone(response['source_interface'])
+
+    def test_default(self):
+        for dut in self.duts:
+            dut.config(['ntp source Ethernet1'])
+            response = dut.api('ntp').default()
+            self.assertTrue(response)
+            response = dut.api('ntp').get()
+            self.assertIsNone(response['source_interface'])
+
+    def test_set_source_interface(self):
+        intf = 'Ethernet1'
+        for dut in self.duts:
+            dut.config(['ntp source Loopback0'])
+            response = dut.api('ntp').set_source_interface(intf)
+            self.assertTrue(response)
+            response = dut.api('ntp').get()
+            self.assertEqual(response['source_interface'], intf)
+
+    def test_add_server_single(self):
+        server = '10.10.10.35'
+        for dut in self.duts:
+            dut.config(['ntp source Ethernet1', 'no ntp'])
+            response = dut.api('ntp').add_server(server)
+            self.assertTrue(response)
+            response = dut.api('ntp').get()
+            keys = [x.keys() for x in response['servers']]
+            keys = list(itertools.chain.from_iterable(keys))
+            self.assertListEqual(keys, [server])
+
+    def test_add_server_multiple(self):
+        servers = ['10.10.10.37', '10.10.10.36', '10.10.10.34']
+        for dut in self.duts:
+            dut.config(['ntp source Ethernet1', 'no ntp'])
+            for server in servers:
+                response = dut.api('ntp').add_server(server)
+            self.assertTrue(response)
+            response = dut.api('ntp').get()
+            keys = [x.keys() for x in response['servers']]
+            keys = list(itertools.chain.from_iterable(keys))
+            self.assertListEqual(sorted(keys), sorted(servers))
+
+    def test_add_server_prefer(self):
+        server = '10.10.10.35'
+        for dut in self.duts:
+            dut.config(['ntp source Ethernet1', 'no ntp'])
+            response = dut.api('ntp').add_server(server, prefer=False)
+            self.assertTrue(response)
+            response = dut.api('ntp').get()
+            self.assertIsNone(response['servers'][0][server])
+
+            response = dut.api('ntp').add_server(server, prefer=True)
+            self.assertTrue(response)
+            response = dut.api('ntp').get()
+            self.assertEqual(response['servers'][0][server], 'prefer')
+
+    def test_add_server_invalid(self):
+        for dut in self.duts:
+            dut.config(['ntp source Ethernet1', 'no ntp'])
+            with self.assertRaises(ValueError):
+                dut.api('ntp').add_server(None)
+                dut.api('ntp').add_server('')
+                dut.api('ntp').add_server(' ')
+
+    def test_remove_server(self):
+        server = '10.10.10.35'
+        servers = ['10.10.10.37', '10.10.10.36', '10.10.10.34']
+        for dut in self.duts:
+            dut.config(['ntp source Ethernet1', 'no ntp',
+                        'ntp server %s' % server])
+            for addserver in servers:
+                dut.config(['ntp server %s' % addserver])
+            response = dut.api('ntp').remove_server(server)
+            self.assertTrue(response)
+            response = dut.api('ntp').get()
+            keys = [x.keys() for x in response['servers']]
+            keys = list(itertools.chain.from_iterable(keys))
+            self.assertListEqual(sorted(keys), sorted(servers))
+
+    def test_remove_all_servers(self):
+        servers = ['10.10.10.37', '10.10.10.36', '10.10.10.34']
+        for dut in self.duts:
+            dut.config(['ntp source Ethernet1', 'no ntp'])
+            for addserver in servers:
+                dut.config(['ntp server %s' % addserver])
+            response = dut.api('ntp').remove_all_servers()
+            self.assertTrue(response)
+            response = dut.api('ntp').get()
+            self.assertEqual(response['servers'], [])
+
+
+if __name__ == '__main__':
+    unittest.main()