Improved input structure and pytest

Author: GioeleB00

src/app/api/simulation.py

@@ -4,13 +4,13 @@
 from fastapi import APIRouter
 
 from app.core.simulation.simulation_run import run_simulation
-from app.schemas.requests_generator_input import RqsGeneratorInput
+from app.schemas.full_simulation_input import SimulationPayload
 from app.schemas.simulation_output import SimulationOutput
 
 router = APIRouter()
 
 @router.post("/simulation")
-async def event_loop_simulation(input_data: RqsGeneratorInput) -> SimulationOutput:
+async def event_loop_simulation(input_data: SimulationPayload) -> SimulationOutput:
     """Run the simulation and return aggregate KPIs."""
     rng = np.random.default_rng()
     return run_simulation(input_data, rng=rng)

src/app/core/event_samplers/gaussian_poisson.py

@@ -17,10 +17,12 @@
     uniform_variable_generator,
 )
 from app.schemas.requests_generator_input import RqsGeneratorInput
+from app.schemas.simulation_settings_input import SimulationSettings
 
 
 def gaussian_poisson_sampling(
     input_data: RqsGeneratorInput,
+    settings: SimulationSettings,
     *,
     rng: np.random.Generator | None = None,
 ) -> Generator[float, None, None]:
@@ -35,11 +37,11 @@ def gaussian_poisson_sampling(
          Λ = U * (mean_req_per_minute_per_user / 60)  [req/s].
     3. While inside the current window, draw gaps
          Δt ~ Exponential(Λ)   using inverse-CDF.
-    4. Stop once the virtual clock exceeds *simulation_time*.
+    4. Stop once the virtual clock exceeds *total_simulation_time*.
     """
     rng = rng or np.random.default_rng()
 
-    simulation_time = input_data.total_simulation_time
+    simulation_time = settings.total_simulation_time
     user_sampling_window = input_data.user_sampling_window
 
     # λ_u : mean concurrent users per window

src/app/core/event_samplers/poisson_poisson.py

@@ -14,10 +14,12 @@
     uniform_variable_generator,
 )
 from app.schemas.requests_generator_input import RqsGeneratorInput
+from app.schemas.simulation_settings_input import SimulationSettings
 
 
 def poisson_poisson_sampling(
     input_data: RqsGeneratorInput,
+    settings: SimulationSettings,
     *,
     rng: np.random.Generator | None = None,
 ) ->  Generator[float, None, None]:
@@ -32,11 +34,11 @@ def poisson_poisson_sampling(
          Λ = U * (mean_req_per_minute_per_user / 60)  [req/s].
     3. While inside the current window, draw gaps
          Δt ~ Exponential(Λ)   using inverse-CDF.
-    4. Stop once the virtual clock exceeds *simulation_time*.
+    4. Stop once the virtual clock exceeds *total_simulation_time*.
     """
     rng = rng or np.random.default_rng()
 
-    simulation_time = input_data.total_simulation_time
+    simulation_time = settings.total_simulation_time
     user_sampling_window = input_data.user_sampling_window
 
     # λ_u : mean concurrent users per window

src/app/core/simulation/requests_generator.py

@@ -17,10 +17,12 @@
     import numpy as np
 
     from app.schemas.requests_generator_input import RqsGeneratorInput
+    from app.schemas.simulation_settings_input import SimulationSettings
 
 
 def requests_generator(
     input_data: RqsGeneratorInput,
+    settings: SimulationSettings,
     *,
     rng: np.random.Generator | None = None,
 ) -> Generator[float, None, None]:
@@ -41,12 +43,14 @@ def requests_generator(
         #Gaussian-Poisson model
         return gaussian_poisson_sampling(
             input_data=input_data,
+            settings=settings,
             rng=rng,
 
         )
 
     # Poisson + Poisson
     return poisson_poisson_sampling(
         input_data=input_data,
+        settings=settings,
         rng=rng,
     )

src/app/core/simulation/simulation_run.py

@@ -14,26 +14,35 @@
 
     import numpy as np
 
-    from app.schemas.requests_generator_input import RqsGeneratorInput
+    from app.schemas.full_simulation_input import SimulationPayload
+
+
 
 
 
 
 def run_simulation(
-    input_data: RqsGeneratorInput,
+    input_data: SimulationPayload,
     *,
     rng: np.random.Generator,
 ) -> SimulationOutput:
     """Simulation executor in Simpy"""
-    gaps: Generator[float, None, None] = requests_generator(input_data, rng=rng)
-    env = simpy.Environment()
-
-    simulation_time = input_data.total_simulation_time
+    settings = input_data.settings
+    simulation_time = settings.total_simulation_time
     # pydantic in the validation assign a value and mypy is not
     # complaining because a None cannot be compared in the loop
     # to a float
     assert simulation_time is not None
 
+    requests_generator_input = input_data.rqs_input
+
+    gaps: Generator[float, None, None] = requests_generator(
+        requests_generator_input,
+        settings,
+        rng=rng)
+    env = simpy.Environment()
+
+
     total_request_per_time_period = {
         "simulation_time": simulation_time,
         "total_requests": 0,
@@ -51,6 +60,6 @@ def arrival_process(
 
     return SimulationOutput(
         total_requests=total_request_per_time_period,
-        metric_2=str(input_data.avg_request_per_minute_per_user.mean),
-        metric_n=str(input_data.avg_active_users.mean),
+        metric_2=str(requests_generator_input.avg_request_per_minute_per_user.mean),
+        metric_n=str(requests_generator_input.avg_active_users.mean),
     )

src/app/schemas/full_simulation_input.py

@@ -3,6 +3,7 @@
 from pydantic import BaseModel
 
 from app.schemas.requests_generator_input import RqsGeneratorInput
+from app.schemas.simulation_settings_input import SimulationSettings
 from app.schemas.system_topology_schema.full_system_topology_schema import TopologyGraph
 
 
@@ -11,3 +12,4 @@ class SimulationPayload(BaseModel):
 
     rqs_input: RqsGeneratorInput
     topology_graph: TopologyGraph
+    settings: SimulationSettings

src/app/schemas/requests_generator_input.py

@@ -12,13 +12,6 @@ class RqsGeneratorInput(BaseModel):
 
     avg_active_users: RVConfig
     avg_request_per_minute_per_user: RVConfig
-    total_simulation_time: int = Field(
-        default=TimeDefaults.SIMULATION_TIME,
-        ge=TimeDefaults.MIN_SIMULATION_TIME,
-        description=(
-            f"Simulation time in seconds (>= {TimeDefaults.MIN_SIMULATION_TIME})."
-        ),
-    )
 
     user_sampling_window: int = Field(
         default=TimeDefaults.USER_SAMPLING_WINDOW,

src/app/schemas/simulation_settings_input.py

@@ -0,0 +1,15 @@
+"""define a class with the global settings for the simulation"""
+
+from pydantic import BaseModel, Field
+
+from app.config.constants import TimeDefaults
+
+
+class SimulationSettings(BaseModel):
+    """Global parameters that apply to the whole run."""
+
+    total_simulation_time: int = Field(
+        default=TimeDefaults.SIMULATION_TIME,
+        ge=TimeDefaults.MIN_SIMULATION_TIME,
+        description="Simulation horizon in seconds.",
+    )