gns3-server/tests/controller/test_hypervisor.py

#!/usr/bin/env python
#
# Copyright (C) 2016 GNS3 Technologies Inc.
#
# This program 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.
#
# This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.


import pytest
import json
import aiohttp
import asyncio
from unittest.mock import patch, MagicMock

from gns3server.controller.project import Project
from gns3server.controller.hypervisor import Hypervisor, HypervisorError
from gns3server.version import __version__
from tests.utils import asyncio_patch, AsyncioMagicMock


@pytest.fixture
def hypervisor():
    hypervisor = Hypervisor("my_hypervisor_id", protocol="https", host="example.com", port=84, controller=MagicMock())
    hypervisor._connected = True
    return hypervisor


def test_init(hypervisor):
    assert hypervisor.id == "my_hypervisor_id"


def test_hypervisor_local(hypervisor):
    """
    If the hypervisor is local but the hypervisor id is local
    it's a configuration issue
    """

    with patch("gns3server.config.Config.get_section_config", return_value={"local": False}):
        with pytest.raises(HypervisorError):
            s = Hypervisor("local", controller=MagicMock())

    with patch("gns3server.config.Config.get_section_config", return_value={"local": True}):
        s = Hypervisor("test", controller=MagicMock())


def test_hypervisor_httpQuery(hypervisor, async_run):
    response = MagicMock()
    with asyncio_patch("aiohttp.ClientSession.request", return_value=response) as mock:
        response.status = 200

        async_run(hypervisor.post("/projects", {"a": "b"}))
        mock.assert_called_with("POST", "https://example.com:84/v2/hypervisor/projects", data='{"a": "b"}', headers={'content-type': 'application/json'}, auth=None)
        assert hypervisor._auth is None


def test_hypervisor_httpQueryAuth(hypervisor, async_run):
    response = MagicMock()
    with asyncio_patch("aiohttp.ClientSession.request", return_value=response) as mock:
        response.status = 200

        hypervisor.user = "root"
        hypervisor.password = "toor"
        async_run(hypervisor.post("/projects", {"a": "b"}))
        mock.assert_called_with("POST", "https://example.com:84/v2/hypervisor/projects", data='{"a": "b"}', headers={'content-type': 'application/json'}, auth=hypervisor._auth)
        assert hypervisor._auth.login == "root"
        assert hypervisor._auth.password == "toor"


def test_hypervisor_httpQueryNotConnected(hypervisor, async_run):
    hypervisor._connected = False
    response = AsyncioMagicMock()
    response.read = AsyncioMagicMock(return_value=json.dumps({"version": __version__}).encode())
    response.status = 200
    with asyncio_patch("aiohttp.ClientSession.request", return_value=response) as mock:
        async_run(hypervisor.post("/projects", {"a": "b"}))
        mock.assert_any_call("GET", "https://example.com:84/v2/hypervisor/version", headers={'content-type': 'application/json'}, data=None, auth=None)
        mock.assert_any_call("POST", "https://example.com:84/v2/hypervisor/projects", data='{"a": "b"}', headers={'content-type': 'application/json'}, auth=None)
        assert hypervisor._connected


def test_hypervisor_httpQueryNotConnectedInvalidVersion(hypervisor, async_run):
    hypervisor._connected = False
    response = AsyncioMagicMock()
    response.read = AsyncioMagicMock(return_value=json.dumps({"version": "1.42.4"}).encode())
    response.status = 200
    with asyncio_patch("aiohttp.ClientSession.request", return_value=response) as mock:
        with pytest.raises(aiohttp.web.HTTPConflict):
            async_run(hypervisor.post("/projects", {"a": "b"}))
        mock.assert_any_call("GET", "https://example.com:84/v2/hypervisor/version", headers={'content-type': 'application/json'}, data=None, auth=None)


def test_hypervisor_httpQueryNotConnectedNonGNS3Server(hypervisor, async_run):
    hypervisor._connected = False
    response = AsyncioMagicMock()
    response.read = AsyncioMagicMock(return_value=b'Blocked by super antivirus')
    response.status = 200
    with asyncio_patch("aiohttp.ClientSession.request", return_value=response) as mock:
        with pytest.raises(aiohttp.web.HTTPConflict):
            async_run(hypervisor.post("/projects", {"a": "b"}))
        mock.assert_any_call("GET", "https://example.com:84/v2/hypervisor/version", headers={'content-type': 'application/json'}, data=None, auth=None)


def test_hypervisor_httpQueryNotConnectedNonGNS3Server2(hypervisor, async_run):
    hypervisor._connected = False
    response = AsyncioMagicMock()
    response.read = AsyncioMagicMock(return_value=b'{}')
    response.status = 200
    with asyncio_patch("aiohttp.ClientSession.request", return_value=response) as mock:
        with pytest.raises(aiohttp.web.HTTPConflict):
            async_run(hypervisor.post("/projects", {"a": "b"}))
        mock.assert_any_call("GET", "https://example.com:84/v2/hypervisor/version", headers={'content-type': 'application/json'}, data=None, auth=None)


def test_hypervisor_httpQueryError(hypervisor, async_run):
    response = MagicMock()
    with asyncio_patch("aiohttp.ClientSession.request", return_value=response) as mock:
        response.status = 409

        with pytest.raises(aiohttp.web.HTTPConflict):
            async_run(hypervisor.post("/projects", {"a": "b"}))


def test_hypervisor_httpQuery_project(hypervisor, async_run):
    response = MagicMock()
    with asyncio_patch("aiohttp.ClientSession.request", return_value=response) as mock:
        response.status = 200

        project = Project()
        async_run(hypervisor.post("/projects", project))
        mock.assert_called_with("POST", "https://example.com:84/v2/hypervisor/projects", data=json.dumps(project.__json__()), headers={'content-type': 'application/json'}, auth=None)


def test_connectNotification(hypervisor, async_run):
    ws_mock = AsyncioMagicMock()

    call = 0

    @asyncio.coroutine
    def receive():
        nonlocal call
        call += 1
        if call == 1:
            response = MagicMock()
            response.data = '{"action": "test", "event": {"a": 1}, "project_id": "42"}'
            response.tp = aiohttp.MsgType.text
            return response
        else:
            response = MagicMock()
            response.tp = aiohttp.MsgType.closed
            return response

    hypervisor._controller = MagicMock()
    hypervisor._session = AsyncioMagicMock(return_value=ws_mock)
    hypervisor._session.ws_connect = AsyncioMagicMock(return_value=ws_mock)
    ws_mock.receive = receive
    async_run(hypervisor._connectNotification())

    hypervisor._controller.emit.assert_called_with('test', {'a': 1}, hypervisor_id=hypervisor.id, project_id='42')
    assert hypervisor._connected is False


def test_json(hypervisor):
    hypervisor.user = "test"
    assert hypervisor.__json__() == {
        "hypervisor_id": "my_hypervisor_id",
        "protocol": "https",
        "host": "example.com",
        "port": 84,
        "user": "test",
        "connected": True
    }