# Copyright (c) 2016 Cable Television Laboratories, Inc. ("CableLabs")
#                    and others.  All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import uuid
import unittest

from snaps.openstack.create_network import OpenStackNetwork, NetworkSettings, SubnetSettings, PortSettings
from snaps.openstack import create_router
from snaps.openstack.tests import openstack_tests
from snaps.openstack.tests.os_source_file_test import OSIntegrationTestCase, OSComponentTestCase
from snaps.openstack.utils import neutron_utils
from snaps.openstack.utils.tests import neutron_utils_tests

__author__ = 'spisarski'


class NetworkSettingsUnitTests(unittest.TestCase):
    """
    Tests the construction of the NetworkSettings class
    """

    def test_no_params(self):
        with self.assertRaises(Exception):
            NetworkSettings()

    def test_empty_config(self):
        with self.assertRaises(Exception):
            NetworkSettings(config=dict())

    def test_name_only(self):
        settings = NetworkSettings(name='foo')
        self.assertEquals('foo', settings.name)
        self.assertTrue(settings.admin_state_up)
        self.assertIsNone(settings.shared)
        self.assertIsNone(settings.project_name)
        self.assertFalse(settings.external)
        self.assertIsNone(settings.network_type)
        self.assertEquals(0, len(settings.subnet_settings))

    def test_config_with_name_only(self):
        settings = NetworkSettings(config={'name': 'foo'})
        self.assertEquals('foo', settings.name)
        self.assertTrue(settings.admin_state_up)
        self.assertIsNone(settings.shared)
        self.assertIsNone(settings.project_name)
        self.assertFalse(settings.external)
        self.assertIsNone(settings.network_type)
        self.assertEquals(0, len(settings.subnet_settings))

    def test_all(self):
        sub_settings = SubnetSettings(name='foo-subnet', cidr='10.0.0.0/24')
        settings = NetworkSettings(name='foo', admin_state_up=False, shared=True, project_name='bar', external=True,
                                   network_type='flat', physical_network='phy', subnet_settings=[sub_settings])
        self.assertEquals('foo', settings.name)
        self.assertFalse(settings.admin_state_up)
        self.assertTrue(settings.shared)
        self.assertEquals('bar', settings.project_name)
        self.assertTrue(settings.external)
        self.assertEquals('flat', settings.network_type)
        self.assertEquals('phy', settings.physical_network)
        self.assertEquals(1, len(settings.subnet_settings))
        self.assertEquals('foo-subnet', settings.subnet_settings[0].name)

    def test_config_all(self):
        settings = NetworkSettings(config={'name': 'foo', 'admin_state_up': False, 'shared': True,
                                           'project_name': 'bar', 'external': True, 'network_type': 'flat',
                                           'physical_network': 'phy',
                                           'subnets':
                                               [{'subnet': {'name': 'foo-subnet', 'cidr': '10.0.0.0/24'}}]})
        self.assertEquals('foo', settings.name)
        self.assertFalse(settings.admin_state_up)
        self.assertTrue(settings.shared)
        self.assertEquals('bar', settings.project_name)
        self.assertTrue(settings.external)
        self.assertEquals('flat', settings.network_type)
        self.assertEquals('phy', settings.physical_network)
        self.assertEquals(1, len(settings.subnet_settings))
        self.assertEquals('foo-subnet', settings.subnet_settings[0].name)


class SubnetSettingsUnitTests(unittest.TestCase):
    """
    Tests the construction of the SubnetSettings class
    """

    def test_no_params(self):
        with self.assertRaises(Exception):
            SubnetSettings()

    def test_empty_config(self):
        with self.assertRaises(Exception):
            SubnetSettings(config=dict())

    def test_name_only(self):
        with self.assertRaises(Exception):
            SubnetSettings(name='foo')

    def test_config_with_name_only(self):
        with self.assertRaises(Exception):
            SubnetSettings(config={'name': 'foo'})

    def test_name_cidr_only(self):
        settings = SubnetSettings(name='foo', cidr='10.0.0.0/24')
        self.assertEquals('foo', settings.name)
        self.assertEquals('10.0.0.0/24', settings.cidr)
        self.assertEquals(4, settings.ip_version)
        self.assertIsNone(settings.project_name)
        self.assertIsNone(settings.start)
        self.assertIsNone(settings.end)
        self.assertIsNone(settings.enable_dhcp)
        self.assertEquals(1, len(settings.dns_nameservers))
        self.assertEquals('8.8.8.8', settings.dns_nameservers[0])
        self.assertIsNone(settings.host_routes)
        self.assertIsNone(settings.destination)
        self.assertIsNone(settings.nexthop)
        self.assertIsNone(settings.ipv6_ra_mode)
        self.assertIsNone(settings.ipv6_address_mode)

    def test_config_with_name_cidr_only(self):
        settings = SubnetSettings(config={'name': 'foo', 'cidr': '10.0.0.0/24'})
        self.assertEquals('foo', settings.name)
        self.assertEquals('10.0.0.0/24', settings.cidr)
        self.assertEquals(4, settings.ip_version)
        self.assertIsNone(settings.project_name)
        self.assertIsNone(settings.start)
        self.assertIsNone(settings.end)
        self.assertIsNone(settings.gateway_ip)
        self.assertIsNone(settings.enable_dhcp)
        self.assertEquals(1, len(settings.dns_nameservers))
        self.assertEquals('8.8.8.8', settings.dns_nameservers[0])
        self.assertIsNone(settings.host_routes)
        self.assertIsNone(settings.destination)
        self.assertIsNone(settings.nexthop)
        self.assertIsNone(settings.ipv6_ra_mode)
        self.assertIsNone(settings.ipv6_address_mode)

    def test_all(self):
        host_routes = {'destination': '0.0.0.0/0', 'nexthop': '123.456.78.9'}
        settings = SubnetSettings(name='foo', cidr='10.0.0.0/24', ip_version=6, project_name='bar-project',
                                  start='10.0.0.2', end='10.0.0.101', gateway_ip='10.0.0.1', enable_dhcp=False,
                                  dns_nameservers=['8.8.8.8'], host_routes=[host_routes], destination='dest',
                                  nexthop='hop', ipv6_ra_mode='dhcpv6-stateful', ipv6_address_mode='slaac')
        self.assertEquals('foo', settings.name)
        self.assertEquals('10.0.0.0/24', settings.cidr)
        self.assertEquals(6, settings.ip_version)
        self.assertEquals('bar-project', settings.project_name)
        self.assertEquals('10.0.0.2', settings.start)
        self.assertEquals('10.0.0.101', settings.end)
        self.assertEquals('10.0.0.1', settings.gateway_ip)
        self.assertEquals(False, settings.enable_dhcp)
        self.assertEquals(1, len(settings.dns_nameservers))
        self.assertEquals('8.8.8.8', settings.dns_nameservers[0])
        self.assertEquals(1, len(settings.host_routes))
        self.assertEquals(host_routes, settings.host_routes[0])
        self.assertEquals('dest', settings.destination)
        self.assertEquals('hop', settings.nexthop)
        self.assertEquals('dhcpv6-stateful', settings.ipv6_ra_mode)
        self.assertEquals('slaac', settings.ipv6_address_mode)

    def test_config_all(self):
        host_routes = {'destination': '0.0.0.0/0', 'nexthop': '123.456.78.9'}
        settings = SubnetSettings(config={'name': 'foo', 'cidr': '10.0.0.0/24', 'ip_version': 6,
                                          'project_name': 'bar-project', 'start': '10.0.0.2', 'end': '10.0.0.101',
                                          'gateway_ip': '10.0.0.1', 'enable_dhcp': False,
                                          'dns_nameservers': ['8.8.8.8'], 'host_routes': [host_routes],
                                          'destination': 'dest', 'nexthop': 'hop', 'ipv6_ra_mode': 'dhcpv6-stateful',
                                          'ipv6_address_mode': 'slaac'})
        self.assertEquals('foo', settings.name)
        self.assertEquals('10.0.0.0/24', settings.cidr)
        self.assertEquals(6, settings.ip_version)
        self.assertEquals('bar-project', settings.project_name)
        self.assertEquals('10.0.0.2', settings.start)
        self.assertEquals('10.0.0.101', settings.end)
        self.assertEquals('10.0.0.1', settings.gateway_ip)
        self.assertEquals(False, settings.enable_dhcp)
        self.assertEquals(1, len(settings.dns_nameservers))
        self.assertEquals('8.8.8.8', settings.dns_nameservers[0])
        self.assertEquals(1, len(settings.host_routes))
        self.assertEquals(host_routes, settings.host_routes[0])
        self.assertEquals('dest', settings.destination)
        self.assertEquals('hop', settings.nexthop)
        self.assertEquals('dhcpv6-stateful', settings.ipv6_ra_mode)
        self.assertEquals('slaac', settings.ipv6_address_mode)


class PortSettingsUnitTests(unittest.TestCase):
    """
    Tests the construction of the PortSettings class
    """

    def test_no_params(self):
        with self.assertRaises(Exception):
            PortSettings()

    def test_empty_config(self):
        with self.assertRaises(Exception):
            PortSettings(config=dict())

    def test_name_only(self):
        with self.assertRaises(Exception):
            PortSettings(name='foo')

    def test_config_name_only(self):
        with self.assertRaises(Exception):
            PortSettings(config={'name': 'foo'})

    def test_name_netname_only(self):
        settings = PortSettings(name='foo', network_name='bar')
        self.assertEquals('foo', settings.name)
        self.assertEquals('bar', settings.network_name)
        self.assertTrue(settings.admin_state_up)
        self.assertIsNone(settings.project_name)
        self.assertIsNone(settings.mac_address)
        self.assertIsNone(settings.ip_addrs)
        self.assertIsNone(settings.fixed_ips)
        self.assertIsNone(settings.security_groups)
        self.assertIsNone(settings.allowed_address_pairs)
        self.assertIsNone(settings.opt_value)
        self.assertIsNone(settings.opt_name)
        self.assertIsNone(settings.device_owner)
        self.assertIsNone(settings.device_id)

    def test_config_with_name_netname_only(self):
        settings = PortSettings(config={'name': 'foo', 'network_name': 'bar'})
        self.assertEquals('foo', settings.name)
        self.assertEquals('bar', settings.network_name)
        self.assertTrue(settings.admin_state_up)
        self.assertIsNone(settings.project_name)
        self.assertIsNone(settings.mac_address)
        self.assertIsNone(settings.ip_addrs)
        self.assertIsNone(settings.fixed_ips)
        self.assertIsNone(settings.security_groups)
        self.assertIsNone(settings.allowed_address_pairs)
        self.assertIsNone(settings.opt_value)
        self.assertIsNone(settings.opt_name)
        self.assertIsNone(settings.device_owner)
        self.assertIsNone(settings.device_id)

    def test_all(self):
        ip_addrs = [{'subnet_name', 'foo-sub', 'ip', '10.0.0.10'}]
        fixed_ips = {'sub_id', '10.0.0.10'}
        allowed_address_pairs = {'10.0.0.101', '1234.5678'}

        settings = PortSettings(name='foo', network_name='bar', admin_state_up=False, project_name='foo-project',
                                mac_address='1234', ip_addrs=ip_addrs, fixed_ips=fixed_ips,
                                security_groups=['foo_grp_id'], allowed_address_pairs=allowed_address_pairs,
                                opt_value='opt value', opt_name='opt name', device_owner='owner',
                                device_id='device number')
        self.assertEquals('foo', settings.name)
        self.assertEquals('bar', settings.network_name)
        self.assertFalse(settings.admin_state_up)
        self.assertEquals('foo-project', settings.project_name)
        self.assertEquals('1234', settings.mac_address)
        self.assertEquals(ip_addrs, settings.ip_addrs)
        self.assertEquals(fixed_ips, settings.fixed_ips)
        self.assertEquals(1, len(settings.security_groups))
        self.assertEquals('foo_grp_id', settings.security_groups[0])
        self.assertEquals(allowed_address_pairs, settings.allowed_address_pairs)
        self.assertEquals('opt value', settings.opt_value)
        self.assertEquals('opt name', settings.opt_name)
        self.assertEquals('owner', settings.device_owner)
        self.assertEquals('device number', settings.device_id)

    def test_config_all(self):
        ip_addrs = [{'subnet_name', 'foo-sub', 'ip', '10.0.0.10'}]
        fixed_ips = {'sub_id', '10.0.0.10'}
        allowed_address_pairs = {'10.0.0.101', '1234.5678'}

        settings = PortSettings(config={'name': 'foo', 'network_name': 'bar', 'admin_state_up': False,
                                        'project_name': 'foo-project', 'mac_address': '1234', 'ip_addrs': ip_addrs,
                                        'fixed_ips': fixed_ips, 'security_groups': ['foo_grp_id'],
                                        'allowed_address_pairs': allowed_address_pairs, 'opt_value': 'opt value',
                                        'opt_name': 'opt name', 'device_owner': 'owner', 'device_id': 'device number'})
        self.assertEquals('foo', settings.name)
        self.assertEquals('bar', settings.network_name)
        self.assertFalse(settings.admin_state_up)
        self.assertEquals('foo-project', settings.project_name)
        self.assertEquals('1234', settings.mac_address)
        self.assertEquals(ip_addrs, settings.ip_addrs)
        self.assertEquals(fixed_ips, settings.fixed_ips)
        self.assertEquals(1, len(settings.security_groups))
        self.assertEquals('foo_grp_id', settings.security_groups[0])
        self.assertEquals(allowed_address_pairs, settings.allowed_address_pairs)
        self.assertEquals('opt value', settings.opt_value)
        self.assertEquals('opt name', settings.opt_name)
        self.assertEquals('owner', settings.device_owner)
        self.assertEquals('device number', settings.device_id)


class CreateNetworkSuccessTests(OSIntegrationTestCase):
    """
    Test for the CreateNework class defined in create_nework.py
    """

    def setUp(self):
        """
        Sets up object for test
        """
        super(self.__class__, self).__start__()

        guid = self.__class__.__name__ + '-' + str(uuid.uuid4())
        self.net_config = openstack_tests.get_pub_net_config(
            net_name=guid + '-pub-net', subnet_name=guid + '-pub-subnet',
            router_name=guid + '-pub-router', external_net=self.ext_net_name)

        self.neutron = neutron_utils.neutron_client(self.os_creds)

        # Initialize for cleanup
        self.net_creator = None
        self.router_creator = None
        self.neutron = neutron_utils.neutron_client(self.os_creds)

    def tearDown(self):
        """
        Cleans the network
        """
        if self.router_creator:
            self.router_creator.clean()

        if self.net_creator:
            if len(self.net_creator.get_subnets()) > 0:
                # Validate subnet has been deleted
                neutron_utils_tests.validate_subnet(
                    self.neutron, self.net_creator.network_settings.subnet_settings[0].name,
                    self.net_creator.network_settings.subnet_settings[0].cidr, False)

            if self.net_creator.get_network():
                # Validate network has been deleted
                neutron_utils_tests.validate_network(self.neutron, self.net_creator.network_settings.name,
                                                     False)
            self.net_creator.clean()

        super(self.__class__, self).__clean__()

    def test_create_network_without_router(self):
        """
        Tests the creation of an OpenStack network without a router.
        """
        # Create Nework
        self.net_creator = OpenStackNetwork(self.os_creds, self.net_config.network_settings)
        self.net_creator.create()

        # Validate network was created
        neutron_utils_tests.validate_network(self.neutron, self.net_creator.network_settings.name, True)

        # Validate subnets
        neutron_utils_tests.validate_subnet(
            self.neutron, self.net_creator.network_settings.subnet_settings[0].name,
            self.net_creator.network_settings.subnet_settings[0].cidr, True)

    def test_create_delete_network(self):
        """
        Tests the creation of an OpenStack network, it's deletion, then cleanup.
        """
        # Create Nework
        self.net_creator = OpenStackNetwork(self.os_creds, self.net_config.network_settings)
        self.net_creator.create()

        # Validate network was created
        neutron_utils_tests.validate_network(self.neutron, self.net_creator.network_settings.name, True)

        neutron_utils.delete_network(self.neutron, self.net_creator.get_network())
        self.assertIsNone(neutron_utils.get_network(self.neutron, self.net_creator.network_settings.name))

        # This shall not throw an exception here
        self.net_creator.clean()

    def test_create_network_with_router(self):
        """
        Tests the creation of an OpenStack network with a router.
        """
        # Create Network
        self.net_creator = OpenStackNetwork(self.os_creds, self.net_config.network_settings)
        self.net_creator.create()

        # Create Router
        self.router_creator = create_router.OpenStackRouter(self.os_creds, self.net_config.router_settings)
        self.router_creator.create()

        # Validate network was created
        neutron_utils_tests.validate_network(self.neutron, self.net_creator.network_settings.name, True)

        # Validate subnets
        neutron_utils_tests.validate_subnet(
            self.neutron, self.net_creator.network_settings.subnet_settings[0].name,
            self.net_creator.network_settings.subnet_settings[0].cidr, True)

        # Validate routers
        neutron_utils_tests.validate_router(self.neutron, self.router_creator.router_settings.name, True)

        neutron_utils_tests.validate_interface_router(self.router_creator.get_internal_router_interface(),
                                                      self.router_creator.get_router(),
                                                      self.net_creator.get_subnets()[0])

    def test_create_networks_same_name(self):
        """
        Tests the creation of an OpenStack network and ensures that the OpenStackNetwork object will not create
        a second.
        """
        # Create Nework
        self.net_creator = OpenStackNetwork(self.os_creds, self.net_config.network_settings)
        self.net_creator.create()

        self.net_creator2 = OpenStackNetwork(self.os_creds, self.net_config.network_settings)
        self.net_creator2.create()

        self.assertEquals(self.net_creator.get_network()['network']['id'],
                          self.net_creator2.get_network()['network']['id'])


class CreateNetworkTypeTests(OSComponentTestCase):
    """
    Test for the CreateNework class defined in create_nework.py for testing creating networks of different types
    """

    def setUp(self):
        """
        Sets up object for test
        """
        guid = self.__class__.__name__ + '-' + str(uuid.uuid4())
        self.net_config = openstack_tests.get_pub_net_config(
            net_name=guid + '-pub-net', subnet_name=guid + '-pub-subnet')

        self.neutron = neutron_utils.neutron_client(self.os_creds)

        # Initialize for cleanup
        self.net_creator = None
        self.neutron = neutron_utils.neutron_client(self.os_creds)

    def tearDown(self):
        """
        Cleans the network
        """
        if self.net_creator:
            if len(self.net_creator.get_subnets()) > 0:
                # Validate subnet has been deleted
                neutron_utils_tests.validate_subnet(
                    self.neutron, self.net_creator.network_settings.subnet_settings[0].name,
                    self.net_creator.network_settings.subnet_settings[0].cidr, False)

            if self.net_creator.get_network():
                # Validate network has been deleted
                neutron_utils_tests.validate_network(self.neutron, self.net_creator.network_settings.name,
                                                     False)
            self.net_creator.clean()
    # TODO - determine why this is not working on Newton
    #        - Unable to create the network. No tenant network is available for allocation.
    # def test_create_network_type_vlan(self):
    #     """
    #     Tests the creation of an OpenStack network of type vlan.
    #     """
    #     # Create Network
    #     network_type = 'vlan'
    #     net_settings = NetworkSettings(name=self.net_config.network_settings.name,
    #                                    subnet_settings=self.net_config.network_settings.subnet_settings,
    #                                    network_type=network_type)
    #
    #     # When setting the network_type, creds must be admin
    #     self.net_creator = OpenStackNetwork(self.os_creds, net_settings)
    #     network = self.net_creator.create()
    #
    #     # Validate network was created
    #     neutron_utils_tests.validate_network(self.neutron, net_settings.name, True)
    #
    #     self.assertEquals(network_type, network['network']['provider:network_type'])

    def test_create_network_type_vxlan(self):
        """
        Tests the creation of an OpenStack network of type vxlan.
        """
        # Create Network
        network_type = 'vxlan'
        net_settings = NetworkSettings(name=self.net_config.network_settings.name,
                                       subnet_settings=self.net_config.network_settings.subnet_settings,
                                       network_type=network_type)

        # When setting the network_type, creds must be admin
        self.net_creator = OpenStackNetwork(self.os_creds, net_settings)
        network = self.net_creator.create()

        # Validate network was created
        neutron_utils_tests.validate_network(self.neutron, net_settings.name, True)

        self.assertEquals(network_type, network['network']['provider:network_type'])

    # TODO - determine what value we need to place into physical_network
    #        - Do not know what vaule to place into the 'physical_network' setting.
    # def test_create_network_type_flat(self):
    #     """
    #     Tests the creation of an OpenStack network of type flat.
    #     """
    #     # Create Network
    #     network_type = 'flat'
    #
    #     # Unable to find documentation on how to find a value that will work here.
    #     # https://visibilityspots.org/vlan-flat-neutron-provider.html
    #     # https://community.rackspace.com/products/f/45/t/4225
    #     # It appears that this may be due to how OPNFV is configuring OpenStack.
    #     physical_network = '???'
    #     net_settings = NetworkSettings(name=self.net_config.network_settings.name,
    #                                    subnet_settings=self.net_config.network_settings.subnet_settings,
    #                                    network_type=network_type, physical_network=physical_network)
    #     self.net_creator = OpenStackNetwork(self.os_creds, net_settings)
    #     network = self.net_creator.create()
    #
    #     # Validate network was created
    #     neutron_utils_tests.validate_network(self.neutron, net_settings.name, True)
    #
    #     self.assertEquals(network_type, network['network']['provider:network_type'])

    def test_create_network_type_foo(self):
        """
        Tests the creation of an OpenStack network of type foo which should raise an exception.
        """
        # Create Network
        network_type = 'foo'
        net_settings = NetworkSettings(name=self.net_config.network_settings.name,
                                       subnet_settings=self.net_config.network_settings.subnet_settings,
                                       network_type=network_type)
        self.net_creator = OpenStackNetwork(self.os_creds, net_settings)
        with self.assertRaises(Exception):
            self.net_creator.create()