From 87f15eafe0acbd65dbfbcb4efcfe35c7d97fbffb Mon Sep 17 00:00:00 2001 From: Julien Duponchelle Date: Wed, 1 Jun 2016 15:39:46 +0200 Subject: [PATCH] Shutdown on controller Ref https://github.com/GNS3/gns3-gui/issues/1191 --- .../handlers/api/controller/__init__.py | 1 + .../api/controller/compute_handler.py | 36 ---------- .../handlers/api/controller/server_handler.py | 68 +++++++++++++++++++ tests/handlers/api/controller/test_server.py | 52 ++++++++++++++ 4 files changed, 121 insertions(+), 36 deletions(-) create mode 100644 gns3server/handlers/api/controller/server_handler.py create mode 100644 tests/handlers/api/controller/test_server.py diff --git a/gns3server/handlers/api/controller/__init__.py b/gns3server/handlers/api/controller/__init__.py index cc964434..5920a677 100644 --- a/gns3server/handlers/api/controller/__init__.py +++ b/gns3server/handlers/api/controller/__init__.py @@ -20,3 +20,4 @@ from .project_handler import ProjectHandler from .version_handler import VersionHandler from .node_handler import NodeHandler from .link_handler import LinkHandler +from .server_handler import ServerHandler diff --git a/gns3server/handlers/api/controller/compute_handler.py b/gns3server/handlers/api/controller/compute_handler.py index f1d128c8..9c238b36 100644 --- a/gns3server/handlers/api/controller/compute_handler.py +++ b/gns3server/handlers/api/controller/compute_handler.py @@ -56,42 +56,6 @@ class ComputeHandler: controller = Controller.instance() response.json([c for c in controller.computes.values()]) - @Route.post( - r"/computes/shutdown", - description="Shutdown a local compute server", - status_codes={ - 201: "Compute server is shutting down", - 403: "Compute server shutdown refused" - }) - def shutdown(request, response): - - config = Config.instance() - if config.get_section_config("Server").getboolean("local", False) is False: - raise HTTPForbidden(text="Only a local server can be shutdown") - - # close all the projects first - pm = ProjectManager.instance() - projects = pm.projects - - tasks = [] - for project in projects: - tasks.append(asyncio.async(project.close())) - - if tasks: - done, _ = yield from asyncio.wait(tasks) - for future in done: - try: - future.result() - except Exception as e: - log.error("Could not close project {}".format(e), exc_info=1) - continue - - # then shutdown the compute itself - from gns3server.web.web_server import WebServer - server = WebServer.instance() - asyncio.async(server.shutdown_server()) - response.set_status(201) - @Route.put( r"/computes/{compute_id:.+}", description="Get a compute server information", diff --git a/gns3server/handlers/api/controller/server_handler.py b/gns3server/handlers/api/controller/server_handler.py new file mode 100644 index 00000000..737ac4f7 --- /dev/null +++ b/gns3server/handlers/api/controller/server_handler.py @@ -0,0 +1,68 @@ +# -*- coding: utf-8 -*- +# +# Copyright (C) 2015 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 . + +from ....web.route import Route +from ....config import Config +from ....controller import Controller +from aiohttp.web import HTTPForbidden + +import asyncio +import logging + +log = logging.getLogger(__name__) + + +class ServerHandler: + + @classmethod + @Route.post( + r"/server/shutdown", + description="Shutdown the local server", + status_codes={ + 201: "Server is shutting down", + 403: "Server shutdown refused" + }) + def shutdown(request, response): + + config = Config.instance() + if config.get_section_config("Server").getboolean("local", False) is False: + raise HTTPForbidden(text="You can only stop a local server") + + log.info("Start shuting down the server") + + # close all the projets first + controller = Controller.instance() + projects = controller.projects + + tasks = [] + for project in projects: + tasks.append(asyncio.async(project.close())) + + if tasks: + done, _ = yield from asyncio.wait(tasks) + for future in done: + try: + future.result() + except Exception as e: + log.error("Could not close project {}".format(e), exc_info=1) + continue + + # then shutdown the server itself + from gns3server.web.web_server import WebServer + server = WebServer.instance() + asyncio.async(server.shutdown_server()) + response.set_status(201) diff --git a/tests/handlers/api/controller/test_server.py b/tests/handlers/api/controller/test_server.py new file mode 100644 index 00000000..e522ec0b --- /dev/null +++ b/tests/handlers/api/controller/test_server.py @@ -0,0 +1,52 @@ +#!/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 . + +import pytest +import asyncio + +from unittest.mock import MagicMock, patch +from gns3server.web.web_server import WebServer + + +@pytest.yield_fixture +def web_server(): + WebServer._instance = MagicMock() + yield WebServer._instance + WebServer._instance = None + + +def test_shutdown_local(http_controller, web_server, config): + @asyncio.coroutine + def hello(): + return 0 + + web_server.shutdown_server.return_value = hello() + config.set("Server", "local", True) + response = http_controller.post('/server/shutdown', example=True) + assert response.status == 201 + assert web_server.shutdown_server.called + + +def test_shutdown_non_local(http_controller, web_server, config): + """ + Dissalow shutdown of a non local GNS3 server + """ + WebServer._instance = MagicMock() + config.set("Server", "local", False) + response = http_controller.post('/server/shutdown') + assert response.status == 403 + assert not web_server.shutdown_server.called