refactor test rockets route

Author: GabrielBarberini

lib/controllers/flight.py

@@ -22,15 +22,15 @@ def __init__(self):
         super().__init__(models=[FlightModel])
 
     @controller_exception_handler
-    async def update_env_by_flight_id(
-        self, flight_id: str, *, env: EnvironmentModel
+    async def update_environment_by_flight_id(
+        self, flight_id: str, *, environment: EnvironmentModel
     ) -> FlightUpdated:
         """
-        Update a models.Flight.env in the database.
+        Update a models.Flight.environment in the database.
 
         Args:
             flight_id: str
-            env: models.Env
+            environment: models.Environment
 
         Returns:
             views.FlightUpdated
@@ -39,7 +39,7 @@ async def update_env_by_flight_id(
             HTTP 404 Not Found: If the flight is not found in the database.
         """
         flight = await self.get_flight_by_id(flight_id)
-        flight.environment = env
+        flight.environment = environment
         self.update_flight_by_id(flight_id, flight)
         return FlightUpdated(flight_id=flight_id)
 

lib/models/motor.py

@@ -1,5 +1,5 @@
 from enum import Enum
-from typing import Optional, Tuple, List, Union, Self, ClassVar
+from typing import Optional, Tuple, List, Union, Self, ClassVar, Literal
 from pydantic import PrivateAttr, model_validator
 
 from lib.models.interface import ApiBaseModel

lib/routes/environment.py

@@ -94,14 +94,15 @@ async def delete_environment(environment_id: str) -> EnvironmentDeleted:
     status_code=203,
     response_class=Response,
 )
-async def read_rocketpy_env(environment_id: str):
+async def get_rocketpy_environment_binary(environment_id: str):
     """
-    Loads rocketpy.environment as a dill binary
+    Loads rocketpy.environment as a dill binary.
+    Currently only amd64 architecture is supported.
 
     ## Args
     ``` environment_id: str ```
     """
-    with tracer.start_as_current_span("read_rocketpy_env"):
+    with tracer.start_as_current_span("get_rocketpy_environment_binary"):
         headers = {
             'Content-Disposition': f'attachment; filename="rocketpy_environment_{environment_id}.dill"'
         }

lib/routes/flight.py

@@ -99,14 +99,15 @@ async def delete_flight(flight_id: str) -> FlightDeleted:
     status_code=203,
     response_class=Response,
 )
-async def read_rocketpy_flight(flight_id: str):
+async def get_rocketpy_flight_binary(flight_id: str):
     """
-    Loads rocketpy.flight as a dill binary
+    Loads rocketpy.flight as a dill binary.
+    Currently only amd64 architecture is supported.
 
     ## Args
     ``` flight_id: str ```
     """
-    with tracer.start_as_current_span("read_rocketpy_flight"):
+    with tracer.start_as_current_span("get_rocketpy_flight_binary"):
         controller = FlightController()
         headers = {
             'Content-Disposition': f'attachment; filename="rocketpy_flight_{flight_id}.dill"'
@@ -120,21 +121,21 @@ async def read_rocketpy_flight(flight_id: str):
         )
 
 
-@router.put("/{flight_id}/env")
-async def update_flight_env(flight_id: str, env: EnvironmentModel) -> FlightUpdated:
+@router.put("/{flight_id}/environment")
+async def update_flight_environment(flight_id: str, environment: EnvironmentModel) -> FlightUpdated:
     """
     Updates flight environment
 
     ## Args
     ```
         flight_id: Flight ID
-        env: env object as JSON
+        environment: env object as JSON
     ```
     """
-    with tracer.start_as_current_span("update_flight_env"):
+    with tracer.start_as_current_span("update_flight_environment"):
         controller = FlightController()
-        return await controller.update_env_by_flight_id(
-            flight_id, env=env
+        return await controller.update_environment_by_flight_id(
+            flight_id, environment=environment
         )
 
 

lib/routes/motor.py

@@ -96,14 +96,15 @@ async def delete_motor(motor_id: str) -> MotorDeleted:
     status_code=203,
     response_class=Response,
 )
-async def read_rocketpy_motor(motor_id: str):
+async def get_rocketpy_motor_binary(motor_id: str):
     """
-    Loads rocketpy.motor as a dill binary
+    Loads rocketpy.motor as a dill binary.
+    Currently only amd64 architecture is supported.
 
     ## Args
     ``` motor_id: str ```
     """
-    with tracer.start_as_current_span("read_rocketpy_motor"):
+    with tracer.start_as_current_span("get_rocketpy_motor_binary"):
         headers = {
             'Content-Disposition': f'attachment; filename="rocketpy_motor_{motor_id}.dill"'
         }

lib/routes/rocket.py

@@ -97,14 +97,15 @@ async def delete_rocket(rocket_id: str) -> RocketDeleted:
     status_code=203,
     response_class=Response,
 )
-async def read_rocketpy_rocket(rocket_id: str):
+async def get_rocketpy_rocket_binary(rocket_id: str):
     """
-    Loads rocketpy.rocket as a dill binary
+    Loads rocketpy.rocket as a dill binary.
+    Currently only amd64 architecture is supported.
 
     ## Args
     ``` rocket_id: str ```
     """
-    with tracer.start_as_current_span("read_rocketpy_rocket"):
+    with tracer.start_as_current_span("get_rocketpy_rocket_binary"):
         headers = {
             'Content-Disposition': f'attachment; filename="rocketpy_rocket_{rocket_id}.dill"'
         }

tests/test_routes/conftest.py

@@ -45,14 +45,14 @@ def stub_tank_dump():
 
 
 @pytest.fixture
-def stub_level_tank(stub_tank):
-    stub_tank.update({'tank_kind': TankKinds.LEVEL, 'liquid_height': 0})
-    return stub_tank
+def stub_level_tank_dump(stub_tank_dump):
+    stub_tank_dump.update({'tank_kind': TankKinds.LEVEL, 'liquid_height': 0})
+    return stub_tank_dump
 
 
 @pytest.fixture
-def stub_mass_flow_tank(stub_tank):
-    stub_tank.update(
+def stub_mass_flow_tank_dump(stub_tank_dump):
+    stub_tank_dump.update(
         {
             'tank_kind': TankKinds.MASS_FLOW,
             'gas_mass_flow_rate_in': 0,
@@ -63,21 +63,21 @@ def stub_mass_flow_tank(stub_tank):
             'initial_gas_mass': 0,
         }
     )
-    return stub_tank
+    return stub_tank_dump
 
 
 @pytest.fixture
-def stub_ullage_tank(stub_tank):
-    stub_tank.update({'tank_kind': TankKinds.ULLAGE, 'ullage': 0})
-    return stub_tank
+def stub_ullage_tank_dump(stub_tank_dump):
+    stub_tank_dump.update({'tank_kind': TankKinds.ULLAGE, 'ullage': 0})
+    return stub_tank_dump
 
 
 @pytest.fixture
-def stub_mass_tank(stub_tank):
-    stub_tank.update(
+def stub_mass_tank_dump(stub_tank_dump):
+    stub_tank_dump.update(
         {'tank_kind': TankKinds.MASS, 'liquid_mass': 0, 'gas_mass': 0}
     )
-    return stub_tank
+    return stub_tank_dump
 
 
 @pytest.fixture
@@ -109,18 +109,18 @@ def stub_fins_dump():
 
 
 @pytest.fixture
-def stub_rocket_dump(stub_motor, stub_nose_cone, stub_fins):
+def stub_rocket_dump(stub_motor_dump, stub_nose_cone_dump, stub_fins_dump):
     rocket = RocketModel(
-        motor=stub_motor,
+        motor=stub_motor_dump,
         radius=0,
         mass=0,
         motor_position=0,
         center_of_mass_without_motor=0,
         inertia=[0, 0, 0],
         power_off_drag=[(0, 0)],
         power_on_drag=[(0, 0)],
-        nose=stub_nose_cone,
-        fins=[stub_fins],
+        nose=stub_nose_cone_dump,
+        fins=[stub_fins_dump],
         coordinate_system_orientation='tail_to_nose',
     )
     rocket_json = rocket.model_dump_json()

tests/test_routes/test_environments_route.py

@@ -1,13 +1,14 @@
-from unittest.mock import patch
+from unittest.mock import patch, Mock, AsyncMock
 import json
 import pytest
 from fastapi.testclient import TestClient
-from fastapi import HTTPException, status
+from fastapi import HTTPException
 from lib.models.environment import EnvironmentModel
-from lib.controllers.environment import EnvironmentController
 from lib.views.environment import (
+    EnvironmentView,
     EnvironmentCreated,
     EnvironmentUpdated,
+    EnvironmentRetrieved,
     EnvironmentDeleted,
     EnvironmentSummary,
 )
@@ -22,6 +23,7 @@ def stub_environment_summary_dump():
     env_summary_json = env_summary.model_dump_json()
     return json.loads(env_summary_json)
 
+
 @pytest.fixture(autouse=True)
 def mock_controller_instance():
     with patch(
@@ -34,6 +36,7 @@ def mock_controller_instance():
         mock_controller_instance.delete_environment_by_id = Mock()
         yield mock_controller_instance
 
+
 def test_create_environment(stub_environment_dump, mock_controller_instance):
     mock_response = AsyncMock(return_value=EnvironmentCreated(environment_id='123'))
     mock_controller_instance.post_environment = mock_response
@@ -47,6 +50,7 @@ def test_create_environment(stub_environment_dump, mock_controller_instance):
         EnvironmentModel(**stub_environment_dump)
     )
 
+
 def test_create_environment_optional_params(stub_environment_dump, mock_controller_instance):
     stub_environment_dump.update({
         'latitude': 0,
@@ -65,12 +69,14 @@ def test_create_environment_optional_params(stub_environment_dump, mock_controll
         'message': 'Environment successfully created',
     }
 
+
 def test_create_environment_invalid_input():
     response = client.post(
         '/environments/', json={'latitude': 'foo', 'longitude': 'bar'}
     )
     assert response.status_code == 422
 
+
 def test_create_environment_server_error(
     stub_environment_dump, mock_controller_instance
 ):
@@ -80,8 +86,9 @@ def test_create_environment_server_error(
     assert response.status_code == 500
     assert response.json() == {'detail': 'Internal Server Error'}
 
-def test_read_environment(stub_env):
-    stub_environment_out = EnvironmentModelOut(environment_id='123', **stub_environment_dump)
+
+def test_read_environment(stub_environment_dump, mock_controller_instance):
+    stub_environment_out = EnvironmentView(environment_id='123', **stub_environment_dump)
     mock_response = AsyncMock(
         return_value=EnvironmentRetrieved(environment=stub_environment_out)
     )
@@ -92,6 +99,8 @@ def test_read_environment(stub_env):
         'message': 'Environment successfully retrieved',
         'environment': json.loads(stub_environment_out.model_dump_json()),
     }
+    mock_controller_instance.get_environment_by_id.assert_called_once_with('123')
+
 
 def test_read_environment_not_found(mock_controller_instance):
     mock_response = AsyncMock(side_effect=HTTPException(status_code=404))
@@ -101,13 +110,15 @@ def test_read_environment_not_found(mock_controller_instance):
     assert response.json() == {'detail': 'Not Found'}
     mock_controller_instance.get_environment_by_id.assert_called_once_with('123')
 
+
 def test_read_environment_server_error(mock_controller_instance):
     mock_response = AsyncMock(side_effect=HTTPException(status_code=500))
     mock_controller_instance.get_environment_by_id = mock_response
     response = client.get('/environments/123')
     assert response.status_code == 500
     assert response.json() == {'detail': 'Internal Server Error'}
 
+
 def test_update_environment(stub_environment_dump, mock_controller_instance):
     mock_reponse = AsyncMock(return_value=EnvironmentUpdated(environment_id='123'))
     mock_controller_instance.put_environment_by_id = mock_reponse
@@ -120,12 +131,14 @@ def test_update_environment(stub_environment_dump, mock_controller_instance):
         '123', EnvironmentModel(**stub_environment_dump)
     )
 
+
 def test_update_environment_invalid_input():
     response = client.put(
         '/environments/123', json={'consignment': 'foo', 'delivery': 'bar'}
     )
     assert response.status_code == 422
 
+
 def test_update_environment_not_found(stub_environment_dump, mock_controller_instance):
     mock_reponse = AsyncMock(side_effect=HTTPException(status_code=404))
     mock_controller_instance.put_environment_by_id = mock_reponse
@@ -136,6 +149,7 @@ def test_update_environment_not_found(stub_environment_dump, mock_controller_ins
         '123', EnvironmentModel(**stub_environment_dump)
     )
 
+
 def test_update_environment_server_error(
     stub_environment_dump, mock_controller_instance
 ):
@@ -145,6 +159,7 @@ def test_update_environment_server_error(
     assert response.status_code == 500
     assert response.json() == {'detail': 'Internal Server Error'}
 
+
 def test_delete_environment(mock_controller_instance):
     mock_reponse = AsyncMock(return_value=EnvironmentDeleted(environment_id='123'))
     mock_controller_instance.delete_environment_by_id = mock_reponse
@@ -155,13 +170,15 @@ def test_delete_environment(mock_controller_instance):
     }
     mock_controller_instance.delete_environment_by_id.assert_called_once_with('123')
 
+
 def test_delete_environment_server_error(mock_controller_instance):
     mock_response = AsyncMock(side_effect=HTTPException(status_code=500))
     mock_controller_instance.delete_environment_by_id = mock_response
     response = client.delete('/environments/123')
     assert response.status_code == 500
     assert response.json() == {'detail': 'Internal Server Error'}
 
+
 def test_simulate_environment_success(
     stub_environment_summary_dump, mock_controller_instance
 ):
@@ -172,6 +189,7 @@ def test_simulate_environment_success(
     assert response.json() == stub_environment_summary_dump
     mock_controller_instance.get_environment_simulation.assert_called_once_with('123')
 
+
 def test_simulate_environment_not_found(mock_controller_instance):
     mock_response = AsyncMock(side_effect=HTTPException(status_code=404))
     mock_controller_instance.get_environment_simulation = mock_response
@@ -180,14 +198,16 @@ def test_simulate_environment_not_found(mock_controller_instance):
     assert response.json() == {'detail': 'Not Found'}
     mock_controller_instance.get_environment_simulation.assert_called_once_with('123')
 
+
 def test_simulate_environment_server_error(mock_controller_instance):
     mock_response = AsyncMock(side_effect=HTTPException(status_code=500))
     mock_controller_instance.get_environment_simulation = mock_response
     response = client.get('/environments/123/summary')
     assert response.status_code == 500
     assert response.json() == {'detail': 'Internal Server Error'}
 
-def test_read_rocketpy_environment(mock_controller_instance):
+
+def test_read_rocketpy_environment_binary(mock_controller_instance):
     mock_response = AsyncMock(return_value=b'rocketpy')
     mock_controller_instance.get_rocketpy_environment_binary = mock_response
     response = client.get('/environments/123/rocketpy')
@@ -198,7 +218,8 @@ def test_read_rocketpy_environment(mock_controller_instance):
         '123'
     )
 
-def test_read_rocketpy_environment_not_found(mock_controller_instance):
+
+def test_read_rocketpy_environment_binary_not_found(mock_controller_instance):
     mock_response = AsyncMock(side_effect=HTTPException(status_code=404))
     mock_controller_instance.get_rocketpy_environment_binary = mock_response
     response = client.get('/environments/123/rocketpy')
@@ -208,7 +229,8 @@ def test_read_rocketpy_environment_not_found(mock_controller_instance):
         '123'
     )
 
-def test_read_rocketpy_environment_server_error(mock_controller_instance):
+
+def test_read_rocketpy_environment_binary_server_error(mock_controller_instance):
     mock_response = AsyncMock(side_effect=HTTPException(status_code=500))
     mock_controller_instance.get_rocketpy_environment_binary = mock_response
     response = client.get('/environments/123/rocketpy')