Rename /controller/servers to /controller/hypervisors

gns3server/controller/__init__.py

@@ -20,10 +20,10 @@ from ..config import Config
 
 
 class Controller:
-    """The controller manage multiple gns3 servers"""
+    """The controller manage multiple gns3 hypervisors"""
 
     def __init__(self):
-        self._servers = {}
+        self._hypervisors = {}
 
     def isEnabled(self):
         """
@@ -32,18 +32,18 @@ class Controller:
         """
         return Config.instance().get_section_config("Server").getboolean("controller")
 
-    def addServer(self, server):
+    def addHypervisor(self, hypervisor):
         """
-        Add a server to the dictionnary of servers controlled by GNS3
+        Add a server to the dictionnary of hypervisors controlled by GNS3
         """
-        self._servers[server.id] = server
+        self._hypervisors[hypervisor.id] = hypervisor
 
     @property
-    def servers(self):
+    def hypervisors(self):
         """
-        :returns: The dictionnary of servers managed by GNS3
+        :returns: The dictionnary of hypervisors managed by GNS3
         """
-        return self._servers
+        return self._hypervisors
 
     @staticmethod
     def instance():

gns3server/controller/hypervisor.py

@@ -25,50 +25,50 @@ import logging
 log = logging.getLogger(__name__)
 
 
-class ServerError(ControllerError):
+class HypervisorError(ControllerError):
     pass
 
 
-class Server:
+class Hypervisor:
     """
-    A GNS3 server.
+    A GNS3 hypervisor.
     """
 
-    def __init__(self, server_id, protocol="http", host="localhost", port=8000, user=None, password=None):
-        log.info("Create server %s", server_id)
-        self._id = server_id
+    def __init__(self, hypervisor_id, protocol="http", host="localhost", port=8000, user=None, password=None):
+        log.info("Create hypervisor %s", hypervisor_id)
+        self._id = hypervisor_id
         self._protocol = protocol
         self._host = host
         self._port = port
         self._user = user
         self._password = password
         self._connected = False
-        # The remote server version
+        # The remote hypervisor version
         # TODO: For the moment it's fake we return the controller version
         self._version = __version__
 
-        # If the server is local but the server id is local
+        # If the hypervisor is local but the hypervisor id is local
         # it's a configuration issue
-        if server_id == "local" and Config.instance().get_section_config("Server")["local"] is False:
-            raise ServerError("The local server is started without --local")
+        if hypervisor_id == "local" and Config.instance().get_section_config("Hypervisor")["local"] is False:
+            raise HypervisorError("The local hypervisor is started without --local")
 
     @property
     def id(self):
         """
-        :returns: Server identifier (string)
+        :returns: Hypervisor identifier (string)
         """
         return self._id
 
     @property
     def host(self):
         """
-        :returns: Server host (string)
+        :returns: Hypervisor host (string)
         """
         return self._host
 
     def __json__(self):
         return {
-            "server_id": self._id,
+            "hypervisor_id": self._id,
             "protocol": self._protocol,
             "host": self._host,
             "port": self._port,

gns3server/handlers/api/controller/__init__.py

@@ -15,5 +15,5 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-from .server_handler import ServerHandler
+from .hypervisor_handler import HypervisorHandler
 from .version_handler import VersionHandler

gns3server/handlers/api/controller/hypervisor_handler.py

@@ -21,48 +21,48 @@ from aiohttp.web import HTTPForbidden
 from ....web.route import Route
 from ....config import Config
 from ....modules.project_manager import ProjectManager
-from ....schemas.server import SERVER_CREATE_SCHEMA, SERVER_OBJECT_SCHEMA
+from ....schemas.hypervisor import HYPERVISOR_CREATE_SCHEMA, HYPERVISOR_OBJECT_SCHEMA
 from ....controller import Controller
-from ....controller.server import Server
+from ....controller.hypervisor import Hypervisor
 
 
 import logging
 log = logging.getLogger(__name__)
 
 
-class ServerHandler:
-    """API entry points for server management."""
+class HypervisorHandler:
+    """API entry points for hypervisor management."""
 
     @classmethod
     @Route.post(
-        r"/servers",
-        description="Register a server",
+        r"/hypervisors",
+        description="Register a hypervisor",
         status_codes={
-            201: "Server added"
+            201: "Hypervisor added"
         },
-        input=SERVER_CREATE_SCHEMA,
-        output=SERVER_OBJECT_SCHEMA)
+        input=HYPERVISOR_CREATE_SCHEMA,
+        output=HYPERVISOR_OBJECT_SCHEMA)
     def create(request, response):
 
-        server = Server(request.json.pop("server_id"), **request.json)
-        Controller.instance().addServer(server)
+        hypervisor = Hypervisor(request.json.pop("hypervisor_id"), **request.json)
+        Controller.instance().addHypervisor(hypervisor)
 
         response.set_status(201)
-        response.json(server)
+        response.json(hypervisor)
 
     @classmethod
     @Route.post(
-        r"/servers/shutdown",
-        description="Shutdown the local server",
+        r"/hypervisors/shutdown",
+        description="Shutdown the local hypervisor",
         status_codes={
-            201: "Server is shutting down",
-            403: "Server shutdown refused"
+            201: "Hypervisor is shutting down",
+            403: "Hypervisor 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")
+        if config.get_section_config("Hypervisor").getboolean("local", False) is False:
+            raise HTTPForbidden(text="You can only stop a local hypervisor")
 
         # close all the projects first
         pm = ProjectManager.instance()
@@ -81,7 +81,7 @@ class ServerHandler:
                     log.error("Could not close project {}".format(e), exc_info=1)
                     continue
 
-        # then shutdown the server itself
+        # then shutdown the hypervisor itself
         from gns3server.web.web_server import WebServer
         server = WebServer.instance()
         asyncio.async(server.shutdown_server())

gns3server/schemas/hypervisor.py

@@ -16,12 +16,12 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
-SERVER_CREATE_SCHEMA = {
+HYPERVISOR_CREATE_SCHEMA = {
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "Request validation to register a GNS3 server instance",
+    "description": "Request validation to register a GNS3 hypervisor instance",
     "type": "object",
     "properties": {
-        "server_id": {
+        "hypervisor_id": {
             "description": "Server identifier",
             "type": "string"
         },
@@ -47,15 +47,15 @@ SERVER_CREATE_SCHEMA = {
         }
     },
     "additionalProperties": False,
-    "required": ["server_id", "protocol", "host", "port"]
+    "required": ["hypervisor_id", "protocol", "host", "port"]
 }
 
-SERVER_OBJECT_SCHEMA = {
+HYPERVISOR_OBJECT_SCHEMA = {
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "Request validation to a GNS3 server object instance",
+    "description": "Request validation to a GNS3 hypervisor object instance",
     "type": "object",
     "properties": {
-        "server_id": {
+        "hypervisor_id": {
             "description": "Server identifier",
             "type": "string"
         },
@@ -76,14 +76,14 @@ SERVER_OBJECT_SCHEMA = {
             "type": "string"
         },
         "connected": {
-            "description": "True if controller is connected to the server",
+            "description": "True if controller is connected to the hypervisor",
             "type": "boolean"
         },
         "version": {
-            "description": "Version of the GNS3 remote server",
+            "description": "Version of the GNS3 remote hypervisor",
             "type": ["string", "null"]
         }
     },
     "additionalProperties": False,
-    "required": ["server_id", "protocol", "host", "port"]
+    "required": ["hypervisor_id", "protocol", "host", "port"]
 }

tests/controller/test_controller.py

@@ -18,7 +18,7 @@
 import pytest
 
 from gns3server.controller import Controller
-from gns3server.controller.server import Server
+from gns3server.controller.hypervisor import Hypervisor
 from gns3server.config import Config
 
 
@@ -29,12 +29,12 @@ def test_isEnabled(controller):
     assert controller.isEnabled()
 
 
-def test_addServer(controller):
-    server1 = Server("test1")
+def test_addHypervisor(controller):
+    hypervisor1 = Hypervisor("test1")
 
-    controller.addServer(server1)
-    assert len(controller.servers) == 1
-    controller.addServer(Server("test1"))
-    assert len(controller.servers) == 1
-    controller.addServer(Server("test2"))
-    assert len(controller.servers) == 2
+    controller.addHypervisor(hypervisor1)
+    assert len(controller.hypervisors) == 1
+    controller.addHypervisor(Hypervisor("test1"))
+    assert len(controller.hypervisors) == 1
+    controller.addHypervisor(Hypervisor("test2"))
+    assert len(controller.hypervisors) == 2

tests/controller/test_hypervisor.py

@@ -19,36 +19,36 @@
 import pytest
 from unittest.mock import patch
 
-from gns3server.controller.server import Server, ServerError
+from gns3server.controller.hypervisor import Hypervisor, HypervisorError
 from gns3server.version import __version__
 
 
 @pytest.fixture
-def server():
-    return Server("my_server_id", protocol="https", host="example.com", port=84, user="test", password="secure")
+def hypervisor():
+    return Hypervisor("my_hypervisor_id", protocol="https", host="example.com", port=84, user="test", password="secure")
 
 
-def test_init(server):
-    assert server.id == "my_server_id"
+def test_init(hypervisor):
+    assert hypervisor.id == "my_hypervisor_id"
 
 
-def test_server_local(server):
+def test_hypervisor_local(hypervisor):
     """
-    If the server is local but the server id is local
+    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(ServerError):
-            s = Server("local")
+        with pytest.raises(HypervisorError):
+            s = Hypervisor("local")
 
     with patch("gns3server.config.Config.get_section_config", return_value={"local": True}):
-        s = Server("test")
+        s = Hypervisor("test")
 
 
-def test_json(server):
-    assert server.__json__() == {
-        "server_id": "my_server_id",
+def test_json(hypervisor):
+    assert hypervisor.__json__() == {
+        "hypervisor_id": "my_hypervisor_id",
         "protocol": "https",
         "host": "example.com",
         "port": 84,

tests/handlers/api/controller/test_hypervisor.py

@@ -16,21 +16,21 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
-def test_server_create(http_controller, controller):
+def test_hypervisor_create(http_controller, controller):
 
     params = {
-        "server_id": "my_server_id",
+        "hypervisor_id": "my_hypervisor_id",
         "protocol": "http",
         "host": "example.com",
         "port": 84,
         "user": "julien",
         "password": "secure"
     }
-    response = http_controller.post("/servers", params, example=True)
+    response = http_controller.post("/hypervisors", params, example=True)
     assert response.status == 201
-    assert response.route == "/servers"
+    assert response.route == "/hypervisors"
     assert response.json["user"] == "julien"
     assert "password" not in response.json
 
-    assert len(controller.servers) == 1
-    assert controller.servers["my_server_id"].host == "example.com"
+    assert len(controller.hypervisors) == 1
+    assert controller.hypervisors["my_hypervisor_id"].host == "example.com"

tests/web/test_documentation.py

@@ -39,4 +39,4 @@ def test_documentation_write(tmpdir):
         assert "Sample session" in content
         assert "literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvirtualboxvms.txt" in content
 
-    assert os.path.exists(str(tmpdir / "api" / "v2" / "controller" / "server.rst"))
+    assert os.path.exists(str(tmpdir / "api" / "v2" / "controller" / "hypervisor.rst"))