Refactor tests and upgrade dev package requirements

tests/api/routes/compute/test_projects.py

@@ -30,173 +30,197 @@ from gns3server.compute.project import Project
 pytestmark = pytest.mark.asyncio
 
 
-@pytest.fixture
-def base_params(tmpdir) -> dict:
-    """Return standard parameters"""
+class TestComputeProjectRoutes:
 
-    params = {
-        "name": "test",
-        "project_id": str(uuid.uuid4())
-    }
-    return params
+    @pytest.fixture
+    def base_params(self, tmpdir) -> dict:
+        """Return standard parameters"""
+
+        params = {
+            "name": "test",
+            "project_id": str(uuid.uuid4())
+        }
+        return params
 
 
-async def test_create_project_without_dir(app: FastAPI, compute_client: AsyncClient, base_params: dict) -> None:
+    async def test_create_project_without_dir(
+            self,
+            app: FastAPI,
+            compute_client: AsyncClient,
+            base_params: dict
+    ) -> None:
 
-    response = await compute_client.post(app.url_path_for("compute:create_compute_project"), json=base_params)
-    assert response.status_code == status.HTTP_201_CREATED
-    assert response.json()["project_id"] == base_params["project_id"]
-    assert response.json()["name"] == base_params["name"]
+        response = await compute_client.post(app.url_path_for("compute:create_compute_project"), json=base_params)
+        assert response.status_code == status.HTTP_201_CREATED
+        assert response.json()["project_id"] == base_params["project_id"]
+        assert response.json()["name"] == base_params["name"]
 
 
-async def test_show_project(app: FastAPI, compute_client: AsyncClient, base_params: dict) -> None:
+    async def test_show_project(
+            self,
+            app: FastAPI,
+            compute_client: AsyncClient,
+            base_params: dict
+    ) -> None:
 
-    response = await compute_client.post(app.url_path_for("compute:create_compute_project"), json=base_params)
-    assert response.status_code == status.HTTP_201_CREATED
-    response = await compute_client.get(app.url_path_for("compute:get_compute_project", project_id=base_params["project_id"]))
+        response = await compute_client.post(app.url_path_for("compute:create_compute_project"), json=base_params)
+        assert response.status_code == status.HTTP_201_CREATED
+        response = await compute_client.get(app.url_path_for("compute:get_compute_project", project_id=base_params["project_id"]))
 
-    #print(response.json().keys())
-    #assert len(response.json().keys()) == 3
-    assert response.json()["project_id"] == base_params["project_id"]
-    assert response.json()["name"] == base_params["name"]
-    assert response.json()["variables"] is None
+        #print(response.json().keys())
+        #assert len(response.json().keys()) == 3
+        assert response.json()["project_id"] == base_params["project_id"]
+        assert response.json()["name"] == base_params["name"]
+        assert response.json()["variables"] is None
 
 
-async def test_show_project_invalid_uuid(app: FastAPI, compute_client: AsyncClient) -> None:
+    async def test_show_project_invalid_uuid(self, app: FastAPI, compute_client: AsyncClient) -> None:
 
-    response = await compute_client.get(app.url_path_for("compute:get_compute_project",
-                                                 project_id="50010203-0405-0607-0809-0a0b0c0d0e42"))
-    assert response.status_code == status.HTTP_404_NOT_FOUND
+        response = await compute_client.get(app.url_path_for("compute:get_compute_project",
+                                                     project_id="50010203-0405-0607-0809-0a0b0c0d0e42"))
+        assert response.status_code == status.HTTP_404_NOT_FOUND
 
 
-async def test_list_projects(app: FastAPI, compute_client: AsyncClient) -> dict:
+    async def test_list_projects(self, app: FastAPI, compute_client: AsyncClient) -> dict:
 
-    ProjectManager.instance()._projects = {}
+        ProjectManager.instance()._projects = {}
 
-    params = {"name": "test", "project_id": "51010203-0405-0607-0809-0a0b0c0d0e0f"}
-    response = await compute_client.post(app.url_path_for("compute:create_compute_project"), json=params)
-    assert response.status_code == status.HTTP_201_CREATED
-    params = {"name": "test", "project_id": "52010203-0405-0607-0809-0a0b0c0d0e0b"}
-    response = await compute_client.post(app.url_path_for("compute:create_compute_project"), json=params)
-    assert response.status_code == status.HTTP_201_CREATED
+        params = {"name": "test", "project_id": "51010203-0405-0607-0809-0a0b0c0d0e0f"}
+        response = await compute_client.post(app.url_path_for("compute:create_compute_project"), json=params)
+        assert response.status_code == status.HTTP_201_CREATED
+        params = {"name": "test", "project_id": "52010203-0405-0607-0809-0a0b0c0d0e0b"}
+        response = await compute_client.post(app.url_path_for("compute:create_compute_project"), json=params)
+        assert response.status_code == status.HTTP_201_CREATED
 
-    response = await compute_client.get(app.url_path_for("compute:get_compute_projects"))
-    assert response.status_code == status.HTTP_200_OK
-    assert len(response.json()) == 2
-    assert "51010203-0405-0607-0809-0a0b0c0d0e0f" in [p["project_id"] for p in response.json()]
+        response = await compute_client.get(app.url_path_for("compute:get_compute_projects"))
+        assert response.status_code == status.HTTP_200_OK
+        assert len(response.json()) == 2
+        assert "51010203-0405-0607-0809-0a0b0c0d0e0f" in [p["project_id"] for p in response.json()]
 
 
-async def test_delete_project(app: FastAPI, compute_client: AsyncClient, compute_project: Project) -> None:
+    async def test_delete_project(self, app: FastAPI, compute_client: AsyncClient, compute_project: Project) -> None:
 
-    with asyncio_patch("gns3server.compute.project.Project.delete", return_value=True) as mock:
-        response = await compute_client.delete(app.url_path_for("compute:delete_compute_project", project_id=compute_project.id))
-        assert response.status_code == status.HTTP_204_NO_CONTENT
-        assert mock.called
+        with asyncio_patch("gns3server.compute.project.Project.delete", return_value=True) as mock:
+            response = await compute_client.delete(app.url_path_for("compute:delete_compute_project", project_id=compute_project.id))
+            assert response.status_code == status.HTTP_204_NO_CONTENT
+            assert mock.called
 
 
-async def test_update_project(app: FastAPI, compute_client: AsyncClient, base_params: dict) -> None:
+    async def test_update_project(self, app: FastAPI, compute_client: AsyncClient, base_params: dict) -> None:
 
-    response = await compute_client.post(app.url_path_for("compute:create_compute_project"), json=base_params)
-    assert response.status_code == status.HTTP_201_CREATED
+        response = await compute_client.post(app.url_path_for("compute:create_compute_project"), json=base_params)
+        assert response.status_code == status.HTTP_201_CREATED
 
-    params = {"variables": [{"name": "TEST1", "value": "VAL1"}]}
-    response = await compute_client.put(app.url_path_for("compute:update_compute_project", project_id=base_params["project_id"]),
-                                json=params)
-    assert response.status_code == status.HTTP_200_OK
-    assert response.json()["variables"] == [{"name": "TEST1", "value": "VAL1"}]
+        params = {"variables": [{"name": "TEST1", "value": "VAL1"}]}
+        response = await compute_client.put(app.url_path_for("compute:update_compute_project", project_id=base_params["project_id"]),
+                                    json=params)
+        assert response.status_code == status.HTTP_200_OK
+        assert response.json()["variables"] == [{"name": "TEST1", "value": "VAL1"}]
 
 
-async def test_delete_project_invalid_uuid(app: FastAPI, compute_client: AsyncClient) -> None:
+    async def test_delete_project_invalid_uuid(self, app: FastAPI, compute_client: AsyncClient) -> None:
 
-    response = await compute_client.delete(app.url_path_for("compute:delete_compute_project", project_id=str(uuid.uuid4())))
-    assert response.status_code == status.HTTP_404_NOT_FOUND
+        response = await compute_client.delete(app.url_path_for("compute:delete_compute_project", project_id=str(uuid.uuid4())))
+        assert response.status_code == status.HTTP_404_NOT_FOUND
 
 
-async def test_close_project(app: FastAPI, compute_client: AsyncClient, compute_project: Project) -> None:
+    async def test_close_project(self, app: FastAPI, compute_client: AsyncClient, compute_project: Project) -> None:
 
-    with asyncio_patch("gns3server.compute.project.Project.close", return_value=True) as mock:
-        response = await compute_client.post(app.url_path_for("compute:close_compute_project", project_id=compute_project.id))
-        assert response.status_code == status.HTTP_204_NO_CONTENT
-        assert mock.called
+        with asyncio_patch("gns3server.compute.project.Project.close", return_value=True) as mock:
+            response = await compute_client.post(app.url_path_for("compute:close_compute_project", project_id=compute_project.id))
+            assert response.status_code == status.HTTP_204_NO_CONTENT
+            assert mock.called
 
 
-# @pytest.mark.asyncio
-# async def test_close_project_two_client_connected(compute_api, compute_project):
-#
-#     ProjectHandler._notifications_listening = {compute_project.id: 2}
-#     with asyncio_patch("gns3server.compute.project.Project.close", return_value=True) as mock:
-#         response = await compute_client.post("/projects/{project_id}/close".format(project_id=compute_project.id))
-#         assert response.status_code == status.HTTP_204_NO_CONTENT
-#         assert not mock.called
+    # @pytest.mark.asyncio
+    # async def test_close_project_two_client_connected(compute_api, compute_project):
+    #
+    #     ProjectHandler._notifications_listening = {compute_project.id: 2}
+    #     with asyncio_patch("gns3server.compute.project.Project.close", return_value=True) as mock:
+    #         response = await compute_client.post("/projects/{project_id}/close".format(project_id=compute_project.id))
+    #         assert response.status_code == status.HTTP_204_NO_CONTENT
+    #         assert not mock.called
 
 
-async def test_close_project_invalid_uuid(app: FastAPI, compute_client: AsyncClient) -> None:
+    async def test_close_project_invalid_uuid(self, app: FastAPI, compute_client: AsyncClient) -> None:
 
-    response = await compute_client.post(app.url_path_for("compute:close_compute_project", project_id=str(uuid.uuid4())))
-    assert response.status_code == status.HTTP_404_NOT_FOUND
+        response = await compute_client.post(app.url_path_for("compute:close_compute_project", project_id=str(uuid.uuid4())))
+        assert response.status_code == status.HTTP_404_NOT_FOUND
 
 
-async def test_get_file(app: FastAPI, compute_client: AsyncClient) -> None:
+    async def test_get_file(self, app: FastAPI, compute_client: AsyncClient) -> None:
 
-    project = ProjectManager.instance().create_project(project_id="01010203-0405-0607-0809-0a0b0c0d0e0b")
+        project = ProjectManager.instance().create_project(project_id="01010203-0405-0607-0809-0a0b0c0d0e0b")
 
-    with open(os.path.join(project.path, "hello"), "w+") as f:
-        f.write("world")
+        with open(os.path.join(project.path, "hello"), "w+") as f:
+            f.write("world")
 
-    response = await compute_client.get(app.url_path_for("compute:get_compute_project_file", project_id=project.id, file_path="hello"))
-    assert response.status_code == status.HTTP_200_OK
-    assert response.content == b"world"
+        response = await compute_client.get(app.url_path_for("compute:get_compute_project_file", project_id=project.id, file_path="hello"))
+        assert response.status_code == status.HTTP_200_OK
+        assert response.content == b"world"
 
-    response = await compute_client.get(app.url_path_for("compute:get_compute_project_file", project_id=project.id, file_path="false"))
-    assert response.status_code == status.HTTP_404_NOT_FOUND
+        response = await compute_client.get(app.url_path_for("compute:get_compute_project_file", project_id=project.id, file_path="false"))
+        assert response.status_code == status.HTTP_404_NOT_FOUND
 
-    response = await compute_client.get(app.url_path_for("compute:get_compute_project_file",
-                                                 project_id=project.id,
-                                                 file_path="../hello"))
-    assert response.status_code == status.HTTP_404_NOT_FOUND
+        response = await compute_client.get(app.url_path_for("compute:get_compute_project_file",
+                                                     project_id=project.id,
+                                                     file_path="../hello"))
+        assert response.status_code == status.HTTP_404_NOT_FOUND
 
 
-async def test_get_file_forbidden_location(app: FastAPI, compute_client: AsyncClient, config, tmpdir) -> None:
+    async def test_get_file_forbidden_location(
+            self,
+            app: FastAPI,
+            compute_client: AsyncClient,
+            config,
+            tmpdir
+    ) -> None:
 
-    config.settings.Server.projects_path = str(tmpdir)
-    project = ProjectManager.instance().create_project(project_id="01010203-0405-0607-0809-0a0b0c0d0e0b")
-    file_path = "foo/%2e%2e/%2e%2e/%2e%2e/%2e%2e/%2e%2e/%2e%2e/etc/passwd"
-    response = await compute_client.get(
-        app.url_path_for(
-            "compute:get_compute_project_file",
-            project_id=project.id,
-            file_path=file_path
+        config.settings.Server.projects_path = str(tmpdir)
+        project = ProjectManager.instance().create_project(project_id="01010203-0405-0607-0809-0a0b0c0d0e0b")
+        file_path = "foo/%2e%2e/%2e%2e/%2e%2e/%2e%2e/%2e%2e/%2e%2e/etc/passwd"
+        response = await compute_client.get(
+            app.url_path_for(
+                "compute:get_compute_project_file",
+                project_id=project.id,
+                file_path=file_path
+            )
         )
-    )
-    assert response.status_code == status.HTTP_403_FORBIDDEN
+        assert response.status_code == status.HTTP_403_FORBIDDEN
 
 
-async def test_write_file(app: FastAPI, compute_client: AsyncClient, config, tmpdir) -> None:
+    async def test_write_file(self, app: FastAPI, compute_client: AsyncClient, config, tmpdir) -> None:
 
-    config.settings.Server.projects_path = str(tmpdir)
-    project = ProjectManager.instance().create_project(project_id="01010203-0405-0607-0809-0a0b0c0d0e0b")
+        config.settings.Server.projects_path = str(tmpdir)
+        project = ProjectManager.instance().create_project(project_id="01010203-0405-0607-0809-0a0b0c0d0e0b")
 
-    response = await compute_client.post(app.url_path_for("compute:write_compute_project_file",
-                                                  project_id=project.id,
-                                                  file_path="hello"), content=b"world")
-    assert response.status_code == status.HTTP_204_NO_CONTENT
+        response = await compute_client.post(app.url_path_for("compute:write_compute_project_file",
+                                                      project_id=project.id,
+                                                      file_path="hello"), content=b"world")
+        assert response.status_code == status.HTTP_204_NO_CONTENT
 
-    with open(os.path.join(project.path, "hello")) as f:
-        assert f.read() == "world"
+        with open(os.path.join(project.path, "hello")) as f:
+            assert f.read() == "world"
 
-    response = await compute_client.post(app.url_path_for("compute:write_compute_project_file",
-                                                  project_id=project.id,
-                                                  file_path="../hello"))
-    assert response.status_code == status.HTTP_404_NOT_FOUND
+        response = await compute_client.post(app.url_path_for("compute:write_compute_project_file",
+                                                      project_id=project.id,
+                                                      file_path="../hello"))
+        assert response.status_code == status.HTTP_404_NOT_FOUND
 
 
-async def test_write_file_forbidden_location(app: FastAPI, compute_client: AsyncClient, config, tmpdir) -> None:
+    async def test_write_file_forbidden_location(
+            self,
+            app: FastAPI,
+            compute_client: AsyncClient,
+            config,
+            tmpdir
+    ) -> None:
 
-    config.settings.Server.projects_path = str(tmpdir)
-    project = ProjectManager.instance().create_project(project_id="01010203-0405-0607-0809-0a0b0c0d0e0b")
+        config.settings.Server.projects_path = str(tmpdir)
+        project = ProjectManager.instance().create_project(project_id="01010203-0405-0607-0809-0a0b0c0d0e0b")
 
-    file_path = "%2e%2e/hello"
-    response = await compute_client.post(app.url_path_for("compute:write_compute_project_file",
-                                                  project_id=project.id,
-                                                  file_path=file_path), content=b"world")
-    assert response.status_code == status.HTTP_403_FORBIDDEN
+        file_path = "%2e%2e/hello"
+        response = await compute_client.post(app.url_path_for("compute:write_compute_project_file",
+                                                      project_id=project.id,
+                                                      file_path=file_path), content=b"world")
+        assert response.status_code == status.HTTP_403_FORBIDDEN