Synnefo

# Copyright 2012 GRNET S.A. All rights reserved.

#

# Redistribution and use in source and binary forms, with or

# without modification, are permitted provided that the following

# conditions are met:

#

#   1. Redistributions of source code must retain the above

#      copyright notice, this list of conditions and the following

#      disclaimer.

#

#   2. 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.

#

# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``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 GRNET S.A OR

# CONTRIBUTORS 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.

#

# The views and conclusions contained in the software and

# documentation are those of the authors and should not be

# interpreted as representing official policies, either expressed

# or implied, of GRNET S.A.

import json

from mock import patch

from snf_django.utils.testing import BaseAPITest, mocked_quotaholder

from synnefo.db.models import Network, NetworkInterface

from synnefo.db import models_factory as mfactory

from synnefo.cyclades_settings import cyclades_services

from synnefo.lib.services import get_service_path

from synnefo.lib import join_urls

class ComputeAPITest(BaseAPITest):

    def setUp(self, *args, **kwargs):

        super(ComputeAPITest, self).setUp(*args, **kwargs)

        self.compute_path = get_service_path(cyclades_services, 'compute',

                                             version='v2.0')

    def myget(self, path, *args, **kwargs):

        path = join_urls(self.compute_path, path)

        return self.get(path, *args, **kwargs)

    def myput(self, path, *args, **kwargs):

        path = join_urls(self.compute_path, path)

        return self.put(path, *args, **kwargs)

    def mypost(self, path, *args, **kwargs):

        path = join_urls(self.compute_path, path)

        return self.post(path, *args, **kwargs)

    def mydelete(self, path, *args, **kwargs):

        path = join_urls(self.compute_path, path)

        return self.delete(path, *args, **kwargs)

@patch('synnefo.logic.rapi_pool.GanetiRapiClient')

class NetworkAPITest(ComputeAPITest):

    def setUp(self):

        self.mac_prefixes = mfactory.MacPrefixPoolTableFactory()

        self.bridges = mfactory.BridgePoolTableFactory(base="link")

        self.user = 'dummy-user'

        self.net1 = mfactory.NetworkFactory(userid=self.user)

        self.vm1 = mfactory.VirtualMachineFactory(userid=self.user)

        self.nic1 = mfactory.NetworkInterfaceFactory(network=self.net1,

                                                     machine=self.vm1)

        self.nic2 = mfactory.NetworkInterfaceFactory(network=self.net1,

                                                     machine=self.vm1)

        self.net2 = mfactory.NetworkFactory(userid=self.user)

        self.nic3 = mfactory.NetworkInterfaceFactory(network=self.net2)

        super(NetworkAPITest, self).setUp()

    def assertNetworksEqual(self, db_net, api_net, detail=False):

        self.assertEqual(str(db_net.id), api_net["id"])

        self.assertEqual(db_net.name, api_net['name'])

        if detail:

            self.assertEqual(db_net.state, api_net['status'])

            self.assertEqual(db_net.flavor, api_net['type'])

            self.assertEqual(db_net.subnet, api_net['cidr'])

            self.assertEqual(db_net.subnet6, api_net['cidr6'])

            self.assertEqual(db_net.gateway, api_net['gateway'])

            self.assertEqual(db_net.gateway6, api_net['gateway6'])

            self.assertEqual(db_net.dhcp, api_net['dhcp'])

            self.assertEqual(db_net.public, api_net['public'])

            db_nics = ["nic-%d-%d" % (nic.machine.id, nic.index) for nic in

                       db_net.nics.filter(machine__userid=db_net.userid)]

            self.assertEqual(db_nics, api_net['attachments'])

    def test_create_network_1(self, mrapi):

        request = {

            'network': {'name': 'foo', "type": "MAC_FILTERED"}

        }

        with mocked_quotaholder():

            response = self.mypost('networks/', 'user1',

                                   json.dumps(request), 'json')

        self.assertEqual(response.status_code, 202)

        db_networks = Network.objects.filter(userid='user1')

        self.assertEqual(len(db_networks), 1)

        db_net = db_networks[0]

        api_net = json.loads(response.content)['network']

        self.assertNetworksEqual(db_net, api_net)

        mrapi.CreateNetwork.assert_called()

        mrapi.ConnectNetwork.assert_called()

    def test_invalid_data_1(self, mrapi):

        """Test invalid flavor"""

        request = {

            'network': {'name': 'foo', 'type': 'LoLo'}

            }

        response = self.mypost('networks/', 'user1',

                               json.dumps(request), 'json')

        self.assertBadRequest(response)

        self.assertEqual(len(Network.objects.filter(userid='user1')), 0)

    def test_invalid_data_2(self, mrapi):

        """Test invalid data/subnet"""

        request = {

            'network': {'name': 'foo',

                        'cidr': '10.0.0.0/8', "type":

                        "MAC_FILTERED"}

        }

        response = self.mypost('networks/', 'user1',

                               json.dumps(request), 'json')

        self.assertFault(response, 413, "overLimit")

    def test_invalid_data_3(self, mrapi):

        """Test unauthorized to create public network"""

        request = {

                'network': {'name': 'foo',

                            "public": "True",

                            "type": "MAC_FILTERED"}

            }

        response = self.mypost('networks/', 'user1',

                               json.dumps(request), 'json')

        self.assertFault(response, 403, "forbidden")

    def test_invalid_data_4(self, mrapi):

        """Test unauthorized to create network not in settings"""

        request = {

                'network': {'name': 'foo', 'type': 'CUSTOM'}

            }

        response = self.mypost('networks/', 'user1',

                               json.dumps(request), 'json')

        self.assertFault(response, 403, "forbidden")

    def test_invalid_subnet(self, mrapi):

        """Test invalid subnet"""

        request = {

            'network': {'name': 'foo',

                        'cidr': '10.0.0.10/27',

                        "type": "MAC_FILTERED"}

        }

        response = self.mypost('networks/', 'user1',

                               json.dumps(request), 'json')

        self.assertBadRequest(response)

    def test_invalid_gateway_1(self, mrapi):

        request = {

            'network': {'name': 'foo',

                        'cidr': '10.0.0.0/28',

                        'gateway': '10.0.0.0.300'}

        }

        response = self.mypost('networks/', 'user1',

                               json.dumps(request), 'json')

        self.assertBadRequest(response)

    def test_invalid_gateway_2(self, mrapi):

        request = {

            'network': {'name': 'foo',

                        'cidr': '10.0.0.0/28',

                        'gateway': '10.2.0.1'}

        }

        response = self.mypost('networks/', 'user1',

                               json.dumps(request), 'json')

        self.assertBadRequest(response)

    def test_invalid_network6(self, mrapi):

        request = {

            'network': {'name': 'foo',

                        'cidr': '10.0.0.0/28',

                        'subnet6': '10.0.0.0/28',

                        'gateway': '10.2.0.1'}

        }

        response = self.mypost('networks/', 'user1',

                               json.dumps(request), 'json')

        self.assertBadRequest(response)

    def test_invalid_gateway6(self, mrapi):

        request = {

            'network': {'name': 'foo',

                        'cidr': '10.0.0.0/28',

                        'subnet6': '2001:0db8:0123:4567:89ab:cdef:1234:5678',

                        'gateway': '10.2.0.1'}

        }

        response = self.mypost('networks/', 'user1',

                               json.dumps(request), 'json')

        self.assertBadRequest(response)

    def test_list_networks(self, mrapi):

        """Test that expected list of networks is returned."""

        # Create a deleted network

        mfactory.NetworkFactory(userid=self.user, deleted=True)

        response = self.myget('networks/', self.user)

        self.assertSuccess(response)

        db_nets = Network.objects.filter(userid=self.user, deleted=False)

        api_nets = json.loads(response.content)["networks"]

        self.assertEqual(len(db_nets), len(api_nets))

        for api_net in api_nets:

            net_id = api_net['id']

            self.assertNetworksEqual(Network.objects.get(id=net_id), api_net)

    def test_list_networks_detail(self, mrapi):

        """Test that expected networks details are returned."""

        # Create a deleted network

        mfactory.NetworkFactory(userid=self.user, deleted=True)

        response = self.myget('networks/detail', self.user)

        self.assertSuccess(response)

        db_nets = Network.objects.filter(userid=self.user, deleted=False)

        api_nets = json.loads(response.content)["networks"]

        self.assertEqual(len(db_nets), len(api_nets))

        for api_net in api_nets:

            net_id = api_net['id']

            self.assertNetworksEqual(Network.objects.get(id=net_id), api_net,

                                     detail=True)

    def test_get_network_building_nics(self, mrapi):

        net = mfactory.NetworkFactory()

        machine = mfactory.VirtualMachineFactory(userid=net.userid)

        mfactory.NetworkInterfaceFactory(network=net, machine=machine,

                                         state="BUILDING")

        response = self.myget('networks/%d' % net.id, net.userid)

        self.assertSuccess(response)

        api_net = json.loads(response.content)["network"]

        self.assertEqual(len(api_net["attachments"]), 0)

    def test_network_details_1(self, mrapi):

        """Test that expected details for a network are returned"""

        response = self.myget('networks/%d' % self.net1.id, self.net1.userid)

        self.assertSuccess(response)

        api_net = json.loads(response.content)["network"]

        self.assertNetworksEqual(self.net1, api_net, detail=True)

    def test_invalid_network(self, mrapi):

        """Test details for non-existing network."""

        response = self.myget('networks/%d' % 42, self.net1.userid)

        self.assertItemNotFound(response)

    def test_rename_network(self, mrapi):

        request = {'network': {'name': "new_name"}}

        response = self.myput('networks/%d' % self.net2.id,

                              self.net2.userid, json.dumps(request), 'json')

        self.assertEqual(response.status_code, 204)

        self.assertEqual(Network.objects.get(id=self.net2.id).name, "new_name")

        # Check invalid

        request = {'name': "new_name"}

        response = self.myput('networks/%d' % self.net2.id,

                              self.net2.userid, json.dumps(request), 'json')

        self.assertBadRequest(response)

    def test_rename_deleted_network(self, mrapi):

        net = mfactory.NetworkFactory(deleted=True)

        request = {'network': {'name': "new_name"}}

        response = self.myput('networks/%d' % net.id,

                              net.userid, json.dumps(request), 'json')

        self.assertBadRequest(response)

    def test_rename_public_network(self, mrapi):

        net = mfactory.NetworkFactory(public=True)

        request = {'network': {'name': "new_name"}}

        response = self.myput('networks/%d' % net.id,

                              self.net2.userid, json.dumps(request), 'json')

        self.assertFault(response, 403, 'forbidden')

    def test_delete_network(self, mrapi):

        net = mfactory.NetworkFactory(deleted=False, state='ACTIVE',

                                      link="link-10")

        with mocked_quotaholder():

            response = self.mydelete('networks/%d' % net.id, net.userid)

        self.assertEqual(response.status_code, 204)

        net = Network.objects.get(id=net.id, userid=net.userid)

        self.assertEqual(net.action, 'DESTROY')

        mrapi.DeleteNetwork.assert_called()

    def test_delete_public_network(self, mrapi):

        net = mfactory.NetworkFactory(public=True)

        response = self.mydelete('networks/%d' % net.id, self.net2.userid)

        self.assertFault(response, 403, 'forbidden')

        self.assertFalse(mrapi.called)

    def test_delete_deleted_network(self, mrapi):

        net = mfactory.NetworkFactory(deleted=True)

        response = self.mydelete('networks/%d' % net.id, net.userid)

        self.assertBadRequest(response)

    def test_delete_network_in_use(self, mrapi):

        net = self.net1

        response = self.mydelete('networks/%d' % net.id, net.userid)

        self.assertFault(response, 421, 'networkInUse')

        self.assertFalse(mrapi.called)

    def test_add_nic(self, mrapi):

        user = 'userr'

        vm = mfactory.VirtualMachineFactory(name='yo', userid=user)

        net = mfactory.NetworkFactory(state='ACTIVE', userid=user)

        mrapi().ModifyInstance.return_value = 1

        request = {'add': {'serverRef': vm.id}}

        response = self.mypost('networks/%d/action' % net.id,

                               net.userid, json.dumps(request), 'json')

        self.assertEqual(response.status_code, 202)

    def test_add_nic_to_deleted_network(self, mrapi):

        user = 'userr'

        vm = mfactory.VirtualMachineFactory(name='yo', userid=user)

        net = mfactory.NetworkFactory(state='ACTIVE', userid=user,

                                      deleted=True)

        request = {'add': {'serverRef': vm.id}}

        response = self.mypost('networks/%d/action' % net.id,

                               net.userid, json.dumps(request), 'json')

        self.assertBadRequest(response)

        self.assertFalse(mrapi.called)

    def test_add_nic_to_public_network(self, mrapi):

        user = 'userr'

        vm = mfactory.VirtualMachineFactory(name='yo', userid=user)

        net = mfactory.NetworkFactory(state='ACTIVE', userid=user, public=True)

        request = {'add': {'serverRef': vm.id}}

        response = self.mypost('networks/%d/action' % net.id,

                               net.userid, json.dumps(request), 'json')

        self.assertFault(response, 403, 'forbidden')

        self.assertFalse(mrapi.called)

    def test_add_nic_malformed_1(self, mrapi):

        user = 'userr'

        vm = mfactory.VirtualMachineFactory(name='yo', userid=user)

        net = mfactory.NetworkFactory(state='ACTIVE', userid=user)

        request = {'add': {'serveRef': vm.id}}

        response = self.mypost('networks/%d/action' % net.id,

                               net.userid, json.dumps(request), 'json')

        self.assertBadRequest(response)

        self.assertFalse(mrapi.called)

    def test_add_nic_malformed_2(self, mrapi):

        user = 'userr'

        vm = mfactory.VirtualMachineFactory(name='yo', userid=user)

        net = mfactory.NetworkFactory(state='ACTIVE', userid=user)

        request = {'add': {'serveRef': [vm.id, 22]}}

        response = self.mypost('networks/%d/action' % net.id,

                               net.userid, json.dumps(request), 'json')

        self.assertBadRequest(response)

        self.assertFalse(mrapi.called)

    def test_add_nic_not_active(self, mrapi):

        """Test connecting VM to non-active network"""

        user = 'dummy'

        vm = mfactory.VirtualMachineFactory(name='yo', userid=user)

        net = mfactory.NetworkFactory(state='PENDING', subnet='10.0.0.0/31',

                                      userid=user)

        request = {'add': {'serverRef': vm.id}}

        response = self.mypost('/api/v1.1/networks/%d/action' % net.id,

                               net.userid, json.dumps(request), 'json')

        # Test that returns BuildInProgress

        self.assertEqual(response.status_code, 409)

        self.assertFalse(mrapi.called)

    def test_add_nic_full_network(self, mrapi):

        """Test connecting VM to a full network"""

        user = 'userr'

        vm = mfactory.VirtualMachineFactory(name='yo', userid=user,

                                            operstate="STARTED")

        net = mfactory.NetworkFactory(state='ACTIVE', subnet='10.0.0.0/30',

                                      userid=user, dhcp=True)

        pool = net.get_pool()

        while not pool.empty():

            pool.get()

        pool.save()

        pool = net.get_pool()

        self.assertTrue(pool.empty())

        request = {'add': {'serverRef': vm.id}}

        response = self.mypost('networks/%d/action' % net.id,

                               net.userid, json.dumps(request), 'json')

        # Test that returns OverLimit

        self.assertEqual(response.status_code, 413)

        self.assertFalse(mrapi.called)

    def test_remove_nic(self, mrapi):

        user = 'userr'

        vm = mfactory.VirtualMachineFactory(name='yo', userid=user)

        net = mfactory.NetworkFactory(state='ACTIVE', userid=user)

        nic = mfactory.NetworkInterfaceFactory(machine=vm, network=net)

        mrapi().ModifyInstance.return_value = 1

        request = {'remove': {'attachment': 'nic-%s-%s' % (vm.id, nic.index)}}

        response = self.mypost('networks/%d/action' % net.id,

                               net.userid, json.dumps(request), 'json')

        self.assertEqual(response.status_code, 202)

        self.assertTrue(NetworkInterface.objects.get(id=nic.id).dirty)

        vm.task = None

        vm.task_job_id = None

        vm.save()

        # Remove dirty nic

        response = self.mypost('networks/%d/action' % net.id,

                               net.userid, json.dumps(request), 'json')

        self.assertFault(response, 409, 'buildInProgress')

    def test_remove_nic_malformed(self, mrapi):

        user = 'userr'

        vm = mfactory.VirtualMachineFactory(name='yo', userid=user)

        net = mfactory.NetworkFactory(state='ACTIVE', userid=user)

        nic = mfactory.NetworkInterfaceFactory(machine=vm, network=net)

        request = {'remove':

                    {'att234achment': 'nic-%s-%s' % (vm.id, nic.index)}

                  }

        response = self.mypost('networks/%d/action' % net.id,

                               net.userid, json.dumps(request), 'json')

        self.assertBadRequest(response)

    def test_remove_nic_malformed_2(self, mrapi):

        user = 'userr'

        vm = mfactory.VirtualMachineFactory(name='yo', userid=user)

        net = mfactory.NetworkFactory(state='ACTIVE', userid=user)

        request = {'remove':

                    {'attachment': 'nic-%s' % vm.id}

                  }

        response = self.mypost('networks/%d/action' % net.id,

                               net.userid, json.dumps(request), 'json')

        self.assertBadRequest(response)

    def test_catch_wrong_api_paths(self, *args):

        response = self.myget('nonexistent')

        self.assertEqual(response.status_code, 400)

        try:

            error = json.loads(response.content)

        except ValueError:

            self.assertTrue(False)

    def test_method_not_allowed(self, *args):

        # /networks/ allows only POST, GET

        response = self.myput('networks', '', '')

        self.assertMethodNotAllowed(response)

        response = self.mydelete('networks')

        self.assertMethodNotAllowed(response)

        # /networks/<srvid>/ allows only GET, PUT, DELETE

        response = self.mypost("networks/42")

        self.assertMethodNotAllowed(response)