Refactor tests and start work on database integration.

gns3server/api/routes/compute/capabilities.py

@@ -35,7 +35,7 @@ router = APIRouter()
 @router.get("/capabilities",
             response_model=schemas.Capabilities
 )
-def get_compute_capabilities():
+def get_capabilities():
 
     node_types = []
     for module in MODULES:

gns3server/api/routes/compute/cloud_nodes.py

@@ -104,7 +104,7 @@ def update_cloud(node_data: schemas.CloudUpdate, node: Cloud = Depends(dep_node)
 @router.delete("/{node_id}",
                status_code=status.HTTP_204_NO_CONTENT,
                responses=responses)
-async def delete_node(node: Cloud = Depends(dep_node)):
+async def delete_cloud(node: Cloud = Depends(dep_node)):
     """
     Delete a cloud node.
     """
@@ -151,10 +151,10 @@ async def suspend_cloud(node: Cloud = Depends(dep_node)):
              status_code=status.HTTP_201_CREATED,
              response_model=Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
              responses=responses)
-async def create_nio(adapter_number: int,
-                     port_number: int,
-                     nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
-                     node: Cloud = Depends(dep_node)):
+async def create_cloud_nio(adapter_number: int,
+                           port_number: int,
+                           nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+                           node: Cloud = Depends(dep_node)):
     """
     Add a NIO (Network Input/Output) to the node.
     The adapter number on the cloud is always 0.
@@ -169,10 +169,10 @@ async def create_nio(adapter_number: int,
             status_code=status.HTTP_201_CREATED,
             response_model=Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
             responses=responses)
-async def update_nio(adapter_number: int,
-                     port_number: int,
-                     nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
-                     node: Cloud = Depends(dep_node)):
+async def update_cloud_nio(adapter_number: int,
+                           port_number: int,
+                           nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+                           node: Cloud = Depends(dep_node)):
     """
     Update a NIO (Network Input/Output) to the node.
     The adapter number on the cloud is always 0.
@@ -188,7 +188,7 @@ async def update_nio(adapter_number: int,
 @router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
                status_code=status.HTTP_204_NO_CONTENT,
                responses=responses)
-async def delete_nio(adapter_number: int, port_number: int, node: Cloud = Depends(dep_node)):
+async def delete_cloud_nio(adapter_number: int, port_number: int, node: Cloud = Depends(dep_node)):
     """
     Remove a NIO (Network Input/Output) from the node.
     The adapter number on the cloud is always 0.
@@ -199,10 +199,10 @@ async def delete_nio(adapter_number: int, port_number: int, node: Cloud = Depend
 
 @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start",
              responses=responses)
-async def start_capture(adapter_number: int,
-                        port_number: int,
-                        node_capture_data: schemas.NodeCapture,
-                        node: Cloud = Depends(dep_node)):
+async def start_cloud_capture(adapter_number: int,
+                              port_number: int,
+                              node_capture_data: schemas.NodeCapture,
+                              node: Cloud = Depends(dep_node)):
     """
     Start a packet capture on the node.
     The adapter number on the cloud is always 0.
@@ -216,7 +216,7 @@ async def start_capture(adapter_number: int,
 @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop",
              status_code=status.HTTP_204_NO_CONTENT,
              responses=responses)
-async def stop_capture(adapter_number: int, port_number: int, node: Cloud = Depends(dep_node)):
+async def stop_cloud_capture(adapter_number: int, port_number: int, node: Cloud = Depends(dep_node)):
     """
     Stop a packet capture on the node.
     The adapter number on the cloud is always 0.

gns3server/api/routes/compute/compute.py

@@ -78,7 +78,7 @@ def network_ports() -> dict:
 
 
 @router.get("/version")
-def version() -> dict:
+def compute_version() -> dict:
     """
     Retrieve the server version number.
     """
@@ -89,7 +89,7 @@ def version() -> dict:
 
 
 @router.get("/statistics")
-def statistics() -> dict:
+def compute_statistics() -> dict:
     """
     Retrieve the server version number.
     """
@@ -124,19 +124,19 @@ def statistics() -> dict:
 
 
 @router.get("/qemu/binaries")
-async def get_binaries(archs: Optional[List[str]] = Body(None, embed=True)):
+async def get_qemu_binaries(archs: Optional[List[str]] = Body(None, embed=True)):
 
     return await Qemu.binary_list(archs)
 
 
 @router.get("/qemu/img-binaries")
-async def get_img_binaries():
+async def get_image_binaries():
 
     return await Qemu.img_binary_list()
 
 
 @router.get("/qemu/capabilities")
-async def get_capabilities() -> dict:
+async def get_qemu_capabilities() -> dict:
     capabilities = {"kvm": []}
     kvms = await Qemu.get_kvm_archs()
     if kvms:
@@ -147,7 +147,7 @@ async def get_capabilities() -> dict:
 @router.post("/qemu/img",
              status_code=status.HTTP_204_NO_CONTENT,
              responses={403: {"model": schemas.ErrorMessage, "description": "Forbidden to create Qemu image"}})
-async def create_img(image_data: schemas.QemuImageCreate):
+async def create_qemu_image(image_data: schemas.QemuImageCreate):
     """
     Create a Qemu image.
     """
@@ -163,7 +163,7 @@ async def create_img(image_data: schemas.QemuImageCreate):
 @router.put("/qemu/img",
             status_code=status.HTTP_204_NO_CONTENT,
             responses={403: {"model": schemas.ErrorMessage, "description": "Forbidden to update Qemu image"}})
-async def update_img(image_data: schemas.QemuImageUpdate):
+async def update_qemu_image(image_data: schemas.QemuImageUpdate):
     """
     Update a Qemu image.
     """

gns3server/api/routes/compute/docker_nodes.py

@@ -98,7 +98,7 @@ def get_docker_node(node: DockerVM = Depends(dep_node)):
 @router.put("/{node_id}",
             response_model=schemas.Docker,
             responses=responses)
-async def update_docker(node_data: schemas.DockerUpdate, node: DockerVM = Depends(dep_node)):
+async def update_docker_node(node_data: schemas.DockerUpdate, node: DockerVM = Depends(dep_node)):
     """
     Update a Docker node.
     """
@@ -217,10 +217,10 @@ async def duplicate_docker_node(destination_node_id: UUID = Body(..., embed=True
              status_code=status.HTTP_201_CREATED,
              response_model=schemas.UDPNIO,
              responses=responses)
-async def create_nio(adapter_number: int,
-                     port_number: int,
-                     nio_data: schemas.UDPNIO,
-                     node: DockerVM = Depends(dep_node)):
+async def create_docker_node_nio(adapter_number: int,
+                                port_number: int,
+                                nio_data: schemas.UDPNIO,
+                                node: DockerVM = Depends(dep_node)):
     """
     Add a NIO (Network Input/Output) to the node.
     The port number on the Docker node is always 0.
@@ -235,9 +235,9 @@ async def create_nio(adapter_number: int,
             status_code=status.HTTP_201_CREATED,
             response_model=schemas.UDPNIO,
             responses=responses)
-async def update_nio(adapter_number: int,
-                     port_number: int, nio_data: schemas.UDPNIO,
-                     node: DockerVM = Depends(dep_node)):
+async def update_docker_node_nio(adapter_number: int,
+                                 port_number: int, nio_data: schemas.UDPNIO,
+                                 node: DockerVM = Depends(dep_node)):
     """
     Update a NIO (Network Input/Output) on the node.
     The port number on the Docker node is always 0.
@@ -253,7 +253,7 @@ async def update_nio(adapter_number: int,
 @router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
                status_code=status.HTTP_204_NO_CONTENT,
                responses=responses)
-async def delete_nio(adapter_number: int, port_number: int, node: DockerVM = Depends(dep_node)):
+async def delete_docker_node_nio(adapter_number: int, port_number: int, node: DockerVM = Depends(dep_node)):
     """
     Delete a NIO (Network Input/Output) from the node.
     The port number on the Docker node is always 0.
@@ -264,10 +264,10 @@ async def delete_nio(adapter_number: int, port_number: int, node: DockerVM = Dep
 
 @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start",
              responses=responses)
-async def start_capture(adapter_number: int,
-                        port_number: int,
-                        node_capture_data: schemas.NodeCapture,
-                        node: DockerVM = Depends(dep_node)):
+async def start_docker_node_capture(adapter_number: int,
+                                    port_number: int,
+                                    node_capture_data: schemas.NodeCapture,
+                                    node: DockerVM = Depends(dep_node)):
     """
     Start a packet capture on the node.
     The port number on the Docker node is always 0.
@@ -281,7 +281,7 @@ async def start_capture(adapter_number: int,
 @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop",
              status_code=status.HTTP_204_NO_CONTENT,
              responses=responses)
-async def stop_capture(adapter_number: int, port_number: int, node: DockerVM = Depends(dep_node)):
+async def stop_docker_node_capture(adapter_number: int, port_number: int, node: DockerVM = Depends(dep_node)):
     """
     Stop a packet capture on the node.
     The port number on the Docker node is always 0.

gns3server/api/routes/compute/iou_nodes.py

@@ -159,7 +159,7 @@ async def start_iou_node(start_data: schemas.IOUStart, node: IOUVM = Depends(dep
 @router.post("/{node_id}/stop",
              status_code=status.HTTP_204_NO_CONTENT,
              responses=responses)
-async def stop(node: IOUVM = Depends(dep_node)):
+async def stop_iou_node(node: IOUVM = Depends(dep_node)):
     """
     Stop an IOU node.
     """
@@ -194,10 +194,10 @@ async def reload_iou_node(node: IOUVM = Depends(dep_node)):
              status_code=status.HTTP_201_CREATED,
              response_model=Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
              responses=responses)
-async def create_nio(adapter_number: int,
-                     port_number: int,
-                     nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
-                     node: IOUVM = Depends(dep_node)):
+async def create_iou_node_nio(adapter_number: int,
+                              port_number: int,
+                              nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+                              node: IOUVM = Depends(dep_node)):
     """
     Add a NIO (Network Input/Output) to the node.
     """
@@ -211,10 +211,10 @@ async def create_nio(adapter_number: int,
             status_code=status.HTTP_201_CREATED,
             response_model=Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
             responses=responses)
-async def update_nio(adapter_number: int,
-                     port_number: int,
-                     nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
-                     node: IOUVM = Depends(dep_node)):
+async def update_iou_node_nio(adapter_number: int,
+                              port_number: int,
+                              nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+                              node: IOUVM = Depends(dep_node)):
     """
     Update a NIO (Network Input/Output) on the node.
     """
@@ -229,7 +229,7 @@ async def update_nio(adapter_number: int,
 @router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
                status_code=status.HTTP_204_NO_CONTENT,
                responses=responses)
-async def delete_nio(adapter_number: int, port_number: int, node: IOUVM = Depends(dep_node)):
+async def delete_iou_node_nio(adapter_number: int, port_number: int, node: IOUVM = Depends(dep_node)):
     """
     Delete a NIO (Network Input/Output) from the node.
     """
@@ -239,10 +239,10 @@ async def delete_nio(adapter_number: int, port_number: int, node: IOUVM = Depend
 
 @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start",
              responses=responses)
-async def start_capture(adapter_number: int,
-                        port_number: int,
-                        node_capture_data: schemas.NodeCapture,
-                        node: IOUVM = Depends(dep_node)):
+async def start_iou_node_capture(adapter_number: int,
+                                 port_number: int,
+                                 node_capture_data: schemas.NodeCapture,
+                                 node: IOUVM = Depends(dep_node)):
     """
     Start a packet capture on the node.
     """
@@ -255,7 +255,7 @@ async def start_capture(adapter_number: int,
 @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop",
              status_code=status.HTTP_204_NO_CONTENT,
              responses=responses)
-async def stop_capture(adapter_number: int, port_number: int, node: IOUVM = Depends(dep_node)):
+async def stop_iou_node_capture(adapter_number: int, port_number: int, node: IOUVM = Depends(dep_node)):
     """
     Stop a packet capture on the node.
     """

gns3server/api/routes/compute/nat_nodes.py

@@ -52,7 +52,7 @@ def dep_node(project_id: UUID, node_id: UUID):
              response_model=schemas.NAT,
              status_code=status.HTTP_201_CREATED,
              responses={409: {"model": schemas.ErrorMessage, "description": "Could not create NAT node"}})
-async def create_nat(project_id: UUID, node_data: schemas.NATCreate):
+async def create_nat_node(project_id: UUID, node_data: schemas.NATCreate):
     """
     Create a new NAT node.
     """
@@ -72,7 +72,7 @@ async def create_nat(project_id: UUID, node_data: schemas.NATCreate):
 @router.get("/{node_id}",
             response_model=schemas.NAT,
             responses=responses)
-def get_nat(node: Nat = Depends(dep_node)):
+def get_nat_node(node: Nat = Depends(dep_node)):
     """
     Return a NAT node.
     """
@@ -83,7 +83,7 @@ def get_nat(node: Nat = Depends(dep_node)):
 @router.put("/{node_id}",
             response_model=schemas.NAT,
             responses=responses)
-def update_nat(node_data: schemas.NATUpdate, node: Nat = Depends(dep_node)):
+def update_nat_node(node_data: schemas.NATUpdate, node: Nat = Depends(dep_node)):
     """
     Update a NAT node.
     """
@@ -99,7 +99,7 @@ def update_nat(node_data: schemas.NATUpdate, node: Nat = Depends(dep_node)):
 @router.delete("/{node_id}",
                status_code=status.HTTP_204_NO_CONTENT,
                responses=responses)
-async def delete_nat(node: Nat = Depends(dep_node)):
+async def delete_nat_node(node: Nat = Depends(dep_node)):
     """
     Delete a cloud node.
     """
@@ -110,7 +110,7 @@ async def delete_nat(node: Nat = Depends(dep_node)):
 @router.post("/{node_id}/start",
              status_code=status.HTTP_204_NO_CONTENT,
              responses=responses)
-async def start_nat(node: Nat = Depends(dep_node)):
+async def start_nat_node(node: Nat = Depends(dep_node)):
     """
     Start a NAT node.
     """
@@ -121,7 +121,7 @@ async def start_nat(node: Nat = Depends(dep_node)):
 @router.post("/{node_id}/stop",
              status_code=status.HTTP_204_NO_CONTENT,
              responses=responses)
-async def stop_nat(node: Nat = Depends(dep_node)):
+async def stop_nat_node(node: Nat = Depends(dep_node)):
     """
     Stop a NAT node.
     This endpoint results in no action since cloud nodes cannot be stopped.
@@ -133,7 +133,7 @@ async def stop_nat(node: Nat = Depends(dep_node)):
 @router.post("/{node_id}/suspend",
              status_code=status.HTTP_204_NO_CONTENT,
              responses=responses)
-async def suspend_nat(node: Nat = Depends(dep_node)):
+async def suspend_nat_node(node: Nat = Depends(dep_node)):
     """
     Suspend a NAT node.
     This endpoint results in no action since NAT nodes cannot be suspended.
@@ -146,10 +146,10 @@ async def suspend_nat(node: Nat = Depends(dep_node)):
              status_code=status.HTTP_201_CREATED,
              response_model=Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
              responses=responses)
-async def create_nio(adapter_number: int,
-                     port_number: int,
-                     nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
-                     node: Nat = Depends(dep_node)):
+async def create_nat_node_nio(adapter_number: int,
+                              port_number: int,
+                              nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+                              node: Nat = Depends(dep_node)):
     """
     Add a NIO (Network Input/Output) to the node.
     The adapter number on the cloud is always 0.
@@ -164,10 +164,10 @@ async def create_nio(adapter_number: int,
             status_code=status.HTTP_201_CREATED,
             response_model=Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
             responses=responses)
-async def update_nio(adapter_number: int,
-                     port_number: int,
-                     nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
-                     node: Nat = Depends(dep_node)):
+async def update_nat_node_nio(adapter_number: int,
+                              port_number: int,
+                              nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+                              node: Nat = Depends(dep_node)):
     """
     Update a NIO (Network Input/Output) to the node.
     The adapter number on the cloud is always 0.
@@ -183,7 +183,7 @@ async def update_nio(adapter_number: int,
 @router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
                status_code=status.HTTP_204_NO_CONTENT,
                responses=responses)
-async def delete_nio(adapter_number: int, port_number: int, node: Nat = Depends(dep_node)):
+async def delete_nat_node_nio(adapter_number: int, port_number: int, node: Nat = Depends(dep_node)):
     """
     Remove a NIO (Network Input/Output) from the node.
     The adapter number on the cloud is always 0.
@@ -194,10 +194,10 @@ async def delete_nio(adapter_number: int, port_number: int, node: Nat = Depends(
 
 @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start",
              responses=responses)
-async def start_capture(adapter_number: int,
-                        port_number: int,
-                        node_capture_data: schemas.NodeCapture,
-                        node: Nat = Depends(dep_node)):
+async def start_nat_node_capture(adapter_number: int,
+                                 port_number: int,
+                                 node_capture_data: schemas.NodeCapture,
+                                 node: Nat = Depends(dep_node)):
     """
     Start a packet capture on the node.
     The adapter number on the cloud is always 0.
@@ -211,7 +211,7 @@ async def start_capture(adapter_number: int,
 @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop",
              status_code=status.HTTP_204_NO_CONTENT,
              responses=responses)
-async def stop_capture(adapter_number: int, port_number: int, node: Nat = Depends(dep_node)):
+async def stop_nat_node_capture(adapter_number: int, port_number: int, node: Nat = Depends(dep_node)):
     """
     Stop a packet capture on the node.
     The adapter number on the cloud is always 0.

gns3server/api/routes/compute/projects.py

@@ -52,7 +52,7 @@ def dep_project(project_id: UUID):
 
 
 @router.get("/projects", response_model=List[schemas.Project])
-def get_projects():
+def get_compute_projects():
     """
     Get all projects opened on the compute.
     """
@@ -64,7 +64,7 @@ def get_projects():
 @router.post("/projects",
              status_code=status.HTTP_201_CREATED,
              response_model=schemas.Project)
-def create_project(project_data: schemas.ProjectCreate):
+def create_compute_project(project_data: schemas.ProjectCreate):
     """
     Create a new project on the compute.
     """
@@ -80,7 +80,7 @@ def create_project(project_data: schemas.ProjectCreate):
 
 @router.put("/projects/{project_id}",
              response_model=schemas.Project)
-async def update_project(project_data: schemas.ProjectUpdate, project: Project = Depends(dep_project)):
+async def update_compute_project(project_data: schemas.ProjectUpdate, project: Project = Depends(dep_project)):
     """
     Update project on the compute.
     """
@@ -91,7 +91,7 @@ async def update_project(project_data: schemas.ProjectUpdate, project: Project =
 
 @router.get("/projects/{project_id}",
             response_model=schemas.Project)
-def get_project(project: Project = Depends(dep_project)):
+def get_compute_project(project: Project = Depends(dep_project)):
     """
     Return a project from the compute.
     """
@@ -101,7 +101,7 @@ def get_project(project: Project = Depends(dep_project)):
 
 @router.post("/projects/{project_id}/close",
              status_code=status.HTTP_204_NO_CONTENT)
-async def close_project(project: Project = Depends(dep_project)):
+async def close_compute_project(project: Project = Depends(dep_project)):
     """
     Close a project on the compute.
     """
@@ -120,7 +120,7 @@ async def close_project(project: Project = Depends(dep_project)):
 
 @router.delete("/projects/{project_id}",
                status_code=status.HTTP_204_NO_CONTENT)
-async def delete_project(project: Project = Depends(dep_project)):
+async def delete_compute_project(project: Project = Depends(dep_project)):
     """
     Delete project from the compute.
     """
@@ -184,7 +184,7 @@ async def delete_project(project: Project = Depends(dep_project)):
 
 @router.get("/projects/{project_id}/files",
             response_model=List[schemas.ProjectFile])
-async def get_project_files(project: Project = Depends(dep_project)):
+async def get_compute_project_files(project: Project = Depends(dep_project)):
     """
     Return files belonging to a project.
     """
@@ -193,7 +193,7 @@ async def get_project_files(project: Project = Depends(dep_project)):
 
 
 @router.get("/projects/{project_id}/files/{file_path:path}")
-async def get_file(file_path: str, project: Project = Depends(dep_project)):
+async def get_compute_project_file(file_path: str, project: Project = Depends(dep_project)):
     """
     Get a file from a project.
     """
@@ -213,7 +213,7 @@ async def get_file(file_path: str, project: Project = Depends(dep_project)):
 
 @router.post("/projects/{project_id}/files/{file_path:path}",
              status_code=status.HTTP_204_NO_CONTENT)
-async def write_file(file_path: str, request: Request, project: Project = Depends(dep_project)):
+async def write_compute_project_file(file_path: str, request: Request, project: Project = Depends(dep_project)):
 
     path = os.path.normpath(file_path)
 

gns3server/api/routes/compute/qemu_nodes.py

@@ -210,7 +210,10 @@ async def resume_qemu_node(node: QemuVM = Depends(dep_node)):
              status_code=status.HTTP_201_CREATED,
              response_model=schemas.UDPNIO,
              responses=responses)
-async def create_nio(adapter_number: int, port_number: int, nio_data: schemas.UDPNIO, node: QemuVM = Depends(dep_node)):
+async def create_qemu_node_nio(adapter_number: int,
+                               port_number: int,
+                               nio_data: schemas.UDPNIO,
+                               node: QemuVM = Depends(dep_node)):
     """
     Add a NIO (Network Input/Output) to the node.
     The port number on the Qemu node is always 0.
@@ -225,7 +228,10 @@ async def create_nio(adapter_number: int, port_number: int, nio_data: schemas.UD
             status_code=status.HTTP_201_CREATED,
             response_model=schemas.UDPNIO,
             responses=responses)
-async def update_nio(adapter_number: int, port_number: int, nio_data: schemas.UDPNIO, node: QemuVM = Depends(dep_node)):
+async def update_qemu_node_nio(adapter_number: int,
+                               port_number: int,
+                               nio_data: schemas.UDPNIO,
+                               node: QemuVM = Depends(dep_node)):
     """
     Update a NIO (Network Input/Output) on the node.
     The port number on the Qemu node is always 0.
@@ -243,7 +249,9 @@ async def update_nio(adapter_number: int, port_number: int, nio_data: schemas.UD
 @router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
                status_code=status.HTTP_204_NO_CONTENT,
                responses=responses)
-async def delete_nio(adapter_number: int, port_number: int, node: QemuVM = Depends(dep_node)):
+async def delete_qemu_node_nio(adapter_number: int,
+                               port_number: int,
+                               node: QemuVM = Depends(dep_node)):
     """
     Delete a NIO (Network Input/Output) from the node.
     The port number on the Qemu node is always 0.
@@ -254,10 +262,10 @@ async def delete_nio(adapter_number: int, port_number: int, node: QemuVM = Depen
 
 @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start",
              responses=responses)
-async def start_capture(adapter_number: int,
-                        port_number: int,
-                        node_capture_data: schemas.NodeCapture,
-                        node: QemuVM = Depends(dep_node)):
+async def start_qemu_node_capture(adapter_number: int,
+                                  port_number: int,
+                                  node_capture_data: schemas.NodeCapture,
+                                  node: QemuVM = Depends(dep_node)):
     """
     Start a packet capture on the node.
     The port number on the Qemu node is always 0.
@@ -271,7 +279,7 @@ async def start_capture(adapter_number: int,
 @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop",
              status_code=status.HTTP_204_NO_CONTENT,
              responses=responses)
-async def stop_capture(adapter_number: int, port_number: int, node: QemuVM = Depends(dep_node)):
+async def stop_qemu_node_capture(adapter_number: int, port_number: int, node: QemuVM = Depends(dep_node)):
     """
     Stop a packet capture on the node.
     The port number on the Qemu node is always 0.

gns3server/api/routes/compute/virtualbox_nodes.py

@@ -212,10 +212,10 @@ async def reload_virtualbox_node(node: VirtualBoxVM = Depends(dep_node)):
              status_code=status.HTTP_201_CREATED,
              response_model=schemas.UDPNIO,
              responses=responses)
-async def create_nio(adapter_number: int,
-                     port_number: int,
-                     nio_data: schemas.UDPNIO,
-                     node: VirtualBoxVM = Depends(dep_node)):
+async def create_virtualbox_node_nio(adapter_number: int,
+                                     port_number: int,
+                                     nio_data: schemas.UDPNIO,
+                                     node: VirtualBoxVM = Depends(dep_node)):
     """
     Add a NIO (Network Input/Output) to the node.
     The port number on the VirtualBox node is always 0.
@@ -230,10 +230,10 @@ async def create_nio(adapter_number: int,
             status_code=status.HTTP_201_CREATED,
             response_model=schemas.UDPNIO,
             responses=responses)
-async def update_nio(adapter_number: int,
-                     port_number: int,
-                     nio_data: schemas.UDPNIO,
-                     node: VirtualBoxVM = Depends(dep_node)):
+async def update_virtualbox_node_nio(adapter_number: int,
+                                     port_number: int,
+                                     nio_data: schemas.UDPNIO,
+                                     node: VirtualBoxVM = Depends(dep_node)):
     """
     Update a NIO (Network Input/Output) on the node.
     The port number on the VirtualBox node is always 0.
@@ -251,7 +251,7 @@ async def update_nio(adapter_number: int,
 @router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
                status_code=status.HTTP_204_NO_CONTENT,
                responses=responses)
-async def delete_nio(adapter_number: int, port_number: int, node: VirtualBoxVM = Depends(dep_node)):
+async def delete_virtualbox_node_nio(adapter_number: int, port_number: int, node: VirtualBoxVM = Depends(dep_node)):
     """
     Delete a NIO (Network Input/Output) from the node.
     The port number on the VirtualBox node is always 0.
@@ -262,10 +262,10 @@ async def delete_nio(adapter_number: int, port_number: int, node: VirtualBoxVM =
 
 @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start",
              responses=responses)
-async def start_capture(adapter_number: int,
-                        port_number: int,
-                        node_capture_data: schemas.NodeCapture,
-                        node: VirtualBoxVM = Depends(dep_node)):
+async def start_virtualbox_node_capture(adapter_number: int,
+                                        port_number: int,
+                                        node_capture_data: schemas.NodeCapture,
+                                        node: VirtualBoxVM = Depends(dep_node)):
     """
     Start a packet capture on the node.
     The port number on the VirtualBox node is always 0.
@@ -279,7 +279,7 @@ async def start_capture(adapter_number: int,
 @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop",
              status_code=status.HTTP_204_NO_CONTENT,
              responses=responses)
-async def stop_capture(adapter_number: int, port_number: int, node: VirtualBoxVM = Depends(dep_node)):
+async def stop_virtualbox_node_capture(adapter_number: int, port_number: int, node: VirtualBoxVM = Depends(dep_node)):
     """
     Stop a packet capture on the node.
     The port number on the VirtualBox node is always 0.

gns3server/api/routes/compute/vmware_nodes.py

@@ -180,10 +180,10 @@ async def reload_vmware_node(node: VMwareVM = Depends(dep_node)):
              status_code=status.HTTP_201_CREATED,
              response_model=schemas.UDPNIO,
              responses=responses)
-async def create_nio(adapter_number: int,
-                     port_number: int,
-                     nio_data: schemas.UDPNIO,
-                     node: VMwareVM = Depends(dep_node)):
+async def create_vmware_node_nio(adapter_number: int,
+                                 port_number: int,
+                                 nio_data: schemas.UDPNIO,
+                                 node: VMwareVM = Depends(dep_node)):
     """
     Add a NIO (Network Input/Output) to the node.
     The port number on the VMware node is always 0.
@@ -198,9 +198,9 @@ async def create_nio(adapter_number: int,
             status_code=status.HTTP_201_CREATED,
             response_model=schemas.UDPNIO,
             responses=responses)
-async def update_nio(adapter_number: int,
-                     port_number: int,
-                     nio_data: schemas.UDPNIO, node: VMwareVM = Depends(dep_node)):
+async def update_vmware_node_nio(adapter_number: int,
+                                 port_number: int,
+                                 nio_data: schemas.UDPNIO, node: VMwareVM = Depends(dep_node)):
     """
     Update a NIO (Network Input/Output) on the node.
     The port number on the VMware node is always 0.
@@ -216,7 +216,7 @@ async def update_nio(adapter_number: int,
 @router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
                status_code=status.HTTP_204_NO_CONTENT,
                responses=responses)
-async def delete_nio(adapter_number: int, port_number: int, node: VMwareVM = Depends(dep_node)):
+async def delete_vmware_node_nio(adapter_number: int, port_number: int, node: VMwareVM = Depends(dep_node)):
     """
     Delete a NIO (Network Input/Output) from the node.
     The port number on the VMware node is always 0.
@@ -227,10 +227,10 @@ async def delete_nio(adapter_number: int, port_number: int, node: VMwareVM = Dep
 
 @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start",
              responses=responses)
-async def start_capture(adapter_number: int,
-                        port_number: int,
-                        node_capture_data: schemas.NodeCapture,
-                        node: VMwareVM = Depends(dep_node)):
+async def start_vmware_node_capture(adapter_number: int,
+                                    port_number: int,
+                                    node_capture_data: schemas.NodeCapture,
+                                    node: VMwareVM = Depends(dep_node)):
     """
     Start a packet capture on the node.
     The port number on the VMware node is always 0.
@@ -244,7 +244,7 @@ async def start_capture(adapter_number: int,
 @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop",
              status_code=status.HTTP_204_NO_CONTENT,
              responses=responses)
-async def stop_capture(adapter_number: int, port_number: int, node: VMwareVM = Depends(dep_node)):
+async def stop_vmware_node_capture(adapter_number: int, port_number: int, node: VMwareVM = Depends(dep_node)):
     """
     Stop a packet capture on the node.
     The port number on the VMware node is always 0.

gns3server/api/routes/compute/vpcs_nodes.py

@@ -168,7 +168,10 @@ async def reload_vpcs_node(node: VPCSVM = Depends(dep_node)):
              status_code=status.HTTP_201_CREATED,
              response_model=schemas.UDPNIO,
              responses=responses)
-async def create_nio(adapter_number: int, port_number: int, nio_data: schemas.UDPNIO, node: VPCSVM = Depends(dep_node)):
+async def create_vpcs_node_nio(adapter_number: int,
+                               port_number: int,
+                               nio_data: schemas.UDPNIO,
+                               node: VPCSVM = Depends(dep_node)):
     """
     Add a NIO (Network Input/Output) to the node.
     The adapter number on the VPCS node is always 0.
@@ -183,7 +186,10 @@ async def create_nio(adapter_number: int, port_number: int, nio_data: schemas.UD
             status_code=status.HTTP_201_CREATED,
             response_model=schemas.UDPNIO,
             responses=responses)
-async def update_nio(adapter_number: int, port_number: int, nio_data: schemas.UDPNIO, node: VPCSVM = Depends(dep_node)):
+async def update_vpcs_node_nio(adapter_number: int,
+                               port_number: int,
+                               nio_data: schemas.UDPNIO,
+                               node: VPCSVM = Depends(dep_node)):
     """
     Update a NIO (Network Input/Output) on the node.
     The adapter number on the VPCS node is always 0.
@@ -199,7 +205,9 @@ async def update_nio(adapter_number: int, port_number: int, nio_data: schemas.UD
 @router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
                status_code=status.HTTP_204_NO_CONTENT,
                responses=responses)
-async def delete_nio(adapter_number: int, port_number: int, node: VPCSVM = Depends(dep_node)):
+async def delete_vpcs_node_nio(adapter_number: int,
+                               port_number: int,
+                               node: VPCSVM = Depends(dep_node)):
     """
     Delete a NIO (Network Input/Output) from the node.
     The adapter number on the VPCS node is always 0.
@@ -210,10 +218,10 @@ async def delete_nio(adapter_number: int, port_number: int, node: VPCSVM = Depen
 
 @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start",
              responses=responses)
-async def start_capture(adapter_number: int,
-                        port_number: int,
-                        node_capture_data: schemas.NodeCapture,
-                        node: VPCSVM = Depends(dep_node)):
+async def start_vpcs_node_capture(adapter_number: int,
+                                  port_number: int,
+                                  node_capture_data: schemas.NodeCapture,
+                                  node: VPCSVM = Depends(dep_node)):
     """
     Start a packet capture on the node.
     The adapter number on the VPCS node is always 0.
@@ -227,7 +235,7 @@ async def start_capture(adapter_number: int,
 @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop",
              status_code=status.HTTP_204_NO_CONTENT,
              responses=responses)
-async def stop_capture(adapter_number: int, port_number: int, node: VPCSVM = Depends(dep_node)):
+async def stop_vpcs_node_capture(adapter_number: int, port_number: int, node: VPCSVM = Depends(dep_node)):
     """
     Stop a packet capture on the node.
     The adapter number on the VPCS node is always 0.

gns3server/api/routes/controller/__init__.py

@@ -28,9 +28,11 @@ from . import projects
 from . import snapshots
 from . import symbols
 from . import templates
+from . import users
 
 router = APIRouter()
 router.include_router(controller.router, tags=["Controller"])
+router.include_router(users.router, prefix="/users", tags=["Users"])
 router.include_router(appliances.router, prefix="/appliances", tags=["Appliances"])
 router.include_router(computes.router, prefix="/computes", tags=["Computes"])
 router.include_router(drawings.router, prefix="/projects/{project_id}/drawings", tags=["Drawings"])

gns3server/api/routes/controller/controller.py

@@ -71,7 +71,7 @@ async def shutdown():
 
 @router.get("/version",
             response_model=schemas.Version)
-def version():
+def get_version():
     """
     Return the server version number.
     """

gns3server/api/routes/controller/dependencies/authentication.py

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020 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/>.
+
+
+from fastapi import Depends, HTTPException, status
+from fastapi.security import OAuth2PasswordBearer
+
+from gns3server import schemas
+from gns3server.db.repositories.users import UsersRepository
+from gns3server.services import auth_service
+
+
+oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/v3/users/login")  # FIXME: URL prefix
+
+
+async def get_user_from_token(token: str = Depends(oauth2_scheme),
+                              user_repo: UsersRepository = Depends()) -> schemas.User:
+
+    username = auth_service.get_username_from_token(token)
+    user = await user_repo.get_user_by_username(username)
+    if user is None:
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Could not validate credentials",
+            headers={"WWW-Authenticate": "Bearer"}
+        )
+    return user
+
+
+async def get_current_active_user(current_user: schemas.User = Depends(get_user_from_token)) -> schemas.User:
+
+    if not current_user.is_active:
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Not an active user",
+            headers={"WWW-Authenticate": "Bearer"}
+        )
+    return current_user

gns3server/api/routes/controller/nodes.py

@@ -416,7 +416,7 @@ async def ws_console(websocket: WebSocket, node: Node = Depends(dep_node)):
 @router.post("/console/reset",
              status_code=status.HTTP_204_NO_CONTENT,
              responses=responses)
-async def reset_console_all(project: Project = Depends(dep_project)):
+async def reset_console_all_nodes(project: Project = Depends(dep_project)):
     """
     Reset console for all nodes belonging to the project.
     """

gns3server/api/routes/controller/projects.py

@@ -347,7 +347,7 @@ async def import_project(project_id: UUID, request: Request, path: Optional[Path
                  **responses,
                  409: {"model": schemas.ErrorMessage, "description": "Could not duplicate project"}
              })
-async def duplicate(project_data: schemas.ProjectDuplicate, project: Project = Depends(dep_project)):
+async def duplicate_project(project_data: schemas.ProjectDuplicate, project: Project = Depends(dep_project)):
     """
     Duplicate a project.
     """

gns3server/api/routes/controller/snapshots.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# Copyright (C) 2016 GNS3 Technologies Inc.
+# Copyright (C) 2020 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

gns3server/api/routes/controller/users.py

@@ -0,0 +1,125 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2020 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/>.
+
+"""
+API routes for users.
+"""
+
+from fastapi import APIRouter, Depends, HTTPException, status
+from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
+from uuid import UUID
+from typing import List
+
+from gns3server import schemas
+from gns3server.controller.controller_error import ControllerBadRequestError, ControllerNotFoundError
+from gns3server.db.repositories.users import UsersRepository
+from gns3server.services import auth_service
+
+from .dependencies.authentication import get_current_active_user
+
+import logging
+log = logging.getLogger(__name__)
+
+router = APIRouter()
+
+
+@router.get("", response_model=List[schemas.User])
+async def get_users(user_repo: UsersRepository = Depends()) -> List[schemas.User]:
+    """
+    Get all users.
+    """
+
+    users = await user_repo.get_users()
+    return users
+
+
+@router.post("", response_model=schemas.User, status_code=status.HTTP_201_CREATED)
+async def create_user(new_user: schemas.UserCreate, user_repo: UsersRepository = Depends()) -> schemas.User:
+    """
+    Create a new user.
+    """
+
+    if await user_repo.get_user_by_username(new_user.username):
+        raise ControllerBadRequestError(f"Username '{new_user.username}' is already registered")
+
+    if new_user.email and await user_repo.get_user_by_email(new_user.email):
+        raise ControllerBadRequestError(f"Email '{new_user.email}' is already registered")
+
+    return await user_repo.create_user(new_user)
+
+
+@router.get("/{user_id}", response_model=schemas.User)
+async def get_user(user_id: UUID, user_repo: UsersRepository = Depends()) -> schemas.User:
+    """
+    Get an user.
+    """
+
+    user = await user_repo.get_user(user_id)
+    if not user:
+        raise ControllerNotFoundError(f"User '{user_id}' not found")
+    return user
+
+
+@router.put("/{user_id}", response_model=schemas.User)
+async def update_user(user_id: UUID,
+                      update_user: schemas.UserUpdate,
+                      user_repo: UsersRepository = Depends()) -> schemas.User:
+    """
+    Update an user.
+    """
+
+    user = await user_repo.update_user(user_id, update_user)
+    if not user:
+        raise ControllerNotFoundError(f"User '{user_id}' not found")
+    return user
+
+
+@router.delete("/{user_id}", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_user(user_id: UUID, user_repo: UsersRepository = Depends()):
+    """
+    Delete an user.
+    """
+
+    success = await user_repo.delete_user(user_id)
+    if not success:
+        raise ControllerNotFoundError(f"User '{user_id}' not found")
+
+
+@router.post("/login", response_model=schemas.Token)
+async def login(user_repo: UsersRepository = Depends(),
+                form_data: OAuth2PasswordRequestForm = Depends()) -> schemas.Token:
+    """
+    User login.
+    """
+
+    user = await user_repo.authenticate_user(username=form_data.username, password=form_data.password)
+    if not user:
+        raise HTTPException(status_code=status.HTTP_401_UNAUTHORIZED,
+                            detail="Authentication was unsuccessful.",
+                            headers={"WWW-Authenticate": "Bearer"})
+
+    token = schemas.Token(access_token=auth_service.create_access_token(user.username), token_type="bearer")
+    return token
+
+
+@router.get("/users/me/", response_model=schemas.User)
+async def get_current_active_user(current_user: schemas.User = Depends(get_current_active_user)) -> schemas.User:
+    """
+    Get the current active user.
+    """
+
+    return current_user