Skip to content

Commit

Permalink
add type hints
Browse files Browse the repository at this point in the history
  • Loading branch information
@Limmen
Limmen committed Aug 10, 2023
1 parent 4fb0aaa commit 2239475
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 36 deletions.
4 changes: 1 addition & 3 deletions simulation-system/libs/csle-rest-api/src/csle_rest_api/resources/simulation_traces/routes.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@
Routes and sub-resources for the /simulation-traces resource
"""
from typing import Tuple

from flask import Blueprint, Response, jsonify, request
import csle_common.constants.constants as constants
from csle_common.metastore.metastore_facade import MetastoreFacade
from flask import Blueprint, Response, jsonify, request

import csle_rest_api.constants.constants as api_constants
import csle_rest_api.util.rest_api_util as rest_api_util

Expand Down
55 changes: 22 additions & 33 deletions simulation-system/libs/csle-rest-api/tests/test_resources_simulation_traces.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def flask_app(self):
return create_app(static_folder="../../../../../management-system/csle-mgmt-webapp/build")

@pytest.fixture
def list_sim_tr(self, mocker):
def list_sim_tr(self, mocker: pytest_mock.MockFixture):
"""
Pytest fixture for mocking the list_simulation_traces method
Expand All @@ -39,7 +39,7 @@ def list_simulation_traces() -> List[SimulationTrace]:
return list_simulation_traces_mocker

@pytest.fixture
def list_sim_tr_ids(self, mocker):
def list_sim_tr_ids(self, mocker: pytest_mock.MockFixture):
"""
Pytest fixture for mocking the list_simulation_traces_ids method
Expand All @@ -64,7 +64,7 @@ def remove_simulation_trace(simulation_trace: SimulationTrace) -> None:
return remove_simulation_trace_mocker

@pytest.fixture
def get_sim_tr(self, mocker):
def get_sim_tr(self, mocker: pytest_mock.MockFixture):
"""
Pytest fixture for mocking the get_simulation_trace
Expand All @@ -87,8 +87,8 @@ def get_ex_sim_trace():
sim_trace = SimulationTrace(simulation_env="null")
return sim_trace

def test_simulation_traces_get(self, mocker, flask_app, not_logged_in, logged_in,
logged_in_as_admin, list_sim_tr, list_sim_tr_ids):
def test_simulation_traces_get(self, mocker: pytest_mock.MockFixture, flask_app, not_logged_in, logged_in,
logged_in_as_admin, list_sim_tr, list_sim_tr_ids) -> None:
"""
Testing the GET HTTPS for the /simulation-traces resource
:param mocker: the pytest mocker object
Expand All @@ -103,8 +103,7 @@ def test_simulation_traces_get(self, mocker, flask_app, not_logged_in, logged_in
side_effect=list_sim_tr)
mocker.patch("csle_common.metastore.metastore_facade.MetastoreFacade.list_simulation_traces_ids",
side_effect=list_sim_tr_ids)
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized",
side_effect=not_logged_in)
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized", side_effect=not_logged_in)
response = flask_app.test_client().get(f"{api_constants.MGMT_WEBAPP.SIMULATION_TRACES_RESOURCE}")
response_data = response.data.decode("utf-8")
response_data_dict = json.loads(response_data)
Expand All @@ -128,8 +127,7 @@ def test_simulation_traces_get(self, mocker, flask_app, not_logged_in, logged_in
ex_sim_tr_dict = ex_sim_tr.to_dict()
for k in response_data_dict:
assert response_data_dict[k] == ex_sim_tr_dict[k]
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized",
side_effect=logged_in_as_admin)
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized", side_effect=logged_in_as_admin)
response = flask_app.test_client().get(f"{api_constants.MGMT_WEBAPP.SIMULATION_TRACES_RESOURCE}"
f"?{api_constants.MGMT_WEBAPP.IDS_QUERY_PARAM}=true")
response_data = response.data.decode("utf-8")
Expand All @@ -147,8 +145,8 @@ def test_simulation_traces_get(self, mocker, flask_app, not_logged_in, logged_in
for k in response_data_dict:
assert response_data_dict[k] == ex_sim_tr_dict[k]

def test_simulation_traces_delete(self, mocker, flask_app, not_logged_in, logged_in,
logged_in_as_admin, list_sim_tr, remove):
def test_simulation_traces_delete(self, mocker: pytest_mock.MockFixture, flask_app, not_logged_in, logged_in,
logged_in_as_admin, list_sim_tr, remove) -> None:
"""
Testing the DELETE HTTPS for the /simulation-traces resource
:param mocker: the pytest mocker object
Expand All @@ -163,30 +161,27 @@ def test_simulation_traces_delete(self, mocker, flask_app, not_logged_in, logged
side_effect=list_sim_tr)
mocker.patch("csle_common.metastore.metastore_facade.MetastoreFacade.remove_simulation_trace",
side_effect=remove)
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized",
side_effect=not_logged_in)
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized", side_effect=not_logged_in)
response = flask_app.test_client().delete(f"{api_constants.MGMT_WEBAPP.SIMULATION_TRACES_RESOURCE}")
response_data = response.data.decode("utf-8")
response_data_dict = json.loads(response_data)
assert response_data_dict == {}
assert response.status_code == constants.HTTPS.UNAUTHORIZED_STATUS_CODE
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized",
side_effect=logged_in)
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized", side_effect=logged_in)
response = flask_app.test_client().delete(f"{api_constants.MGMT_WEBAPP.SIMULATION_TRACES_RESOURCE}")
response_data = response.data.decode("utf-8")
response_data_dict = json.loads(response_data)
assert response_data_dict == {}
assert response.status_code == constants.HTTPS.UNAUTHORIZED_STATUS_CODE
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized",
side_effect=logged_in_as_admin)
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized", side_effect=logged_in_as_admin)
response = flask_app.test_client().delete(f"{api_constants.MGMT_WEBAPP.SIMULATION_TRACES_RESOURCE}")
response_data = response.data.decode("utf-8")
response_data_dict = json.loads(response_data)
assert response_data_dict == {}
assert response.status_code == constants.HTTPS.OK_STATUS_CODE

def test_simulation_traces_ids_get(self, mocker, flask_app, not_logged_in, logged_in,
logged_in_as_admin, get_sim_tr):
def test_simulation_traces_ids_get(self, mocker: pytest_mock.MockFixture, flask_app, not_logged_in, logged_in,
logged_in_as_admin, get_sim_tr) -> None:
"""
Testing the GET HTTPS for the /simulation-traces/id resource
:param mocker: the pytest mocker object
Expand All @@ -198,24 +193,21 @@ def test_simulation_traces_ids_get(self, mocker, flask_app, not_logged_in, logge
"""
mocker.patch("csle_common.metastore.metastore_facade.MetastoreFacade.get_simulation_trace",
side_effect=get_sim_tr)
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized",
side_effect=not_logged_in)
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized", side_effect=not_logged_in)
response = flask_app.test_client().get(f"{api_constants.MGMT_WEBAPP.SIMULATION_TRACES_RESOURCE}/10")
response_data = response.data.decode("utf-8")
response_data_dict = json.loads(response_data)
assert response_data_dict == {}
assert response.status_code == constants.HTTPS.UNAUTHORIZED_STATUS_CODE
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized",
side_effect=logged_in)
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized", side_effect=logged_in)
response = flask_app.test_client().get(f"{api_constants.MGMT_WEBAPP.SIMULATION_TRACES_RESOURCE}/10")
response_data = response.data.decode("utf-8")
response_data_dict = json.loads(response_data)
ex_sim_tr = TestResourcesSimulationTracesSuite.get_ex_sim_trace()
ex_sim_tr_dict = ex_sim_tr.to_dict()
for k in response_data_dict:
assert response_data_dict[k] == ex_sim_tr_dict[k]
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized",
side_effect=logged_in_as_admin)
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized", side_effect=logged_in_as_admin)
response = flask_app.test_client().get(f"{api_constants.MGMT_WEBAPP.SIMULATION_TRACES_RESOURCE}/10")
response_data = response.data.decode("utf-8")
response_data_dict = json.loads(response_data)
Expand All @@ -224,8 +216,8 @@ def test_simulation_traces_ids_get(self, mocker, flask_app, not_logged_in, logge
for k in response_data_dict:
assert response_data_dict[k] == ex_sim_tr_dict[k]

def test_simulation_traces_ids_delete(self, mocker, flask_app, not_logged_in, logged_in,
logged_in_as_admin, get_sim_tr, remove):
def test_simulation_traces_ids_delete(self, mocker: pytest_mock.MockFixture, flask_app, not_logged_in, logged_in,
logged_in_as_admin, get_sim_tr, remove) -> None:
"""
Testing the DELETE HTTPS for the /simulation-traces/id resource
:param mocker: the pytest mocker object
Expand All @@ -239,22 +231,19 @@ def test_simulation_traces_ids_delete(self, mocker, flask_app, not_logged_in, lo
side_effect=get_sim_tr)
mocker.patch("csle_common.metastore.metastore_facade.MetastoreFacade.remove_simulation_trace",
side_effect=remove)
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized",
side_effect=not_logged_in)
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized", side_effect=not_logged_in)
response = flask_app.test_client().delete(f"{api_constants.MGMT_WEBAPP.SIMULATION_TRACES_RESOURCE}/10")
response_data = response.data.decode("utf-8")
response_data_dict = json.loads(response_data)
assert response_data_dict == {}
assert response.status_code == constants.HTTPS.UNAUTHORIZED_STATUS_CODE
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized",
side_effect=logged_in)
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized", side_effect=logged_in)
response = flask_app.test_client().delete(f"{api_constants.MGMT_WEBAPP.SIMULATION_TRACES_RESOURCE}/10")
response_data = response.data.decode("utf-8")
response_data_dict = json.loads(response_data)
assert response_data_dict == {}
assert response.status_code == constants.HTTPS.UNAUTHORIZED_STATUS_CODE
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized",
side_effect=logged_in_as_admin)
mocker.patch("csle_rest_api.util.rest_api_util.check_if_user_is_authorized", side_effect=logged_in_as_admin)
response = flask_app.test_client().delete(f"{api_constants.MGMT_WEBAPP.SIMULATION_TRACES_RESOURCE}/10")
response_data = response.data.decode("utf-8")
response_data_dict = json.loads(response_data)
Expand Down

0 comments on commit 2239475

Please sign in to comment.