summaryrefslogtreecommitdiff
path: root/opendc/api/v2/simulations/simulationId/experiments
diff options
context:
space:
mode:
authorGeorgios Andreadis <info@gandreadis.com>2020-06-23 18:08:28 +0200
committerGeorgios Andreadis <info@gandreadis.com>2020-06-23 18:08:28 +0200
commit565ede0dc50c3b2df09c066ea3a28a4901cce547 (patch)
treee81a1bbed43d2eaf7e2be0bc61007963f807b62d /opendc/api/v2/simulations/simulationId/experiments
parent6f41be7d9c244b67bfa5ff72f1e90d18fa45b590 (diff)
Add DB handlers and rename to v2
Diffstat (limited to 'opendc/api/v2/simulations/simulationId/experiments')
-rw-r--r--opendc/api/v2/simulations/simulationId/experiments/__init__.py0
-rw-r--r--opendc/api/v2/simulations/simulationId/experiments/endpoint.py112
2 files changed, 112 insertions, 0 deletions
diff --git a/opendc/api/v2/simulations/simulationId/experiments/__init__.py b/opendc/api/v2/simulations/simulationId/experiments/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/opendc/api/v2/simulations/simulationId/experiments/__init__.py
diff --git a/opendc/api/v2/simulations/simulationId/experiments/endpoint.py b/opendc/api/v2/simulations/simulationId/experiments/endpoint.py
new file mode 100644
index 00000000..86fadb24
--- /dev/null
+++ b/opendc/api/v2/simulations/simulationId/experiments/endpoint.py
@@ -0,0 +1,112 @@
+from opendc.models.experiment import Experiment
+from opendc.models.simulation import Simulation
+from opendc.util import exceptions
+from opendc.util.rest import Response
+
+
+def GET(request):
+ """Get this Simulation's Experiments."""
+
+ # Make sure required parameters are there
+
+ try:
+ request.check_required_parameters(
+ path={
+ 'simulationId': 'int'
+ }
+ )
+
+ except exceptions.ParameterError as e:
+ return Response(400, e.message)
+
+ # Instantiate a Simulation from the database
+
+ simulation = Simulation.from_primary_key((request.params_path['simulationId'],))
+
+ # Make sure this Simulation exists
+
+ if not simulation.exists():
+ return Response(404, '{} not found.'.format(simulation))
+
+ # Make sure this user is authorized to view this Simulation's Experiments
+
+ if not simulation.google_id_has_at_least(request.google_id, 'VIEW'):
+ return Reponse(403, 'Forbidden from viewing Experiments for {}.'.format(simulation))
+
+ # Get and return the Experiments
+
+ experiments = Experiment.query('simulation_id', request.params_path['simulationId'])
+
+ return Response(
+ 200,
+ 'Successfully retrieved Experiments for {}.'.format(simulation),
+ [x.to_JSON() for x in experiments]
+ )
+
+
+def POST(request):
+ """Add a new Experiment for this Simulation."""
+
+ # Make sure required parameters are there
+
+ try:
+ request.check_required_parameters(
+ path={
+ 'simulationId': 'int'
+ },
+ body={
+ 'experiment': {
+ 'simulationId': 'int',
+ 'pathId': 'int',
+ 'traceId': 'int',
+ 'schedulerName': 'string',
+ 'name': 'string'
+ }
+ }
+ )
+
+ except exceptions.ParameterError as e:
+ return Response(400, e.message)
+
+ # Make sure the passed object's simulation id matches the path simulation id
+
+ if request.params_path['simulationId'] != request.params_body['experiment']['simulationId']:
+ return Response(403, 'ID mismatch.')
+
+ # Instantiate a Simulation from the database
+
+ simulation = Simulation.from_primary_key((request.params_path['simulationId'],))
+
+ # Make sure this Simulation exists
+
+ if not simulation.exists():
+ return Response(404, '{} not found.'.format(simulation))
+
+ # Make sure this user is authorized to edit this Simulation's Experiments
+
+ if not simulation.google_id_has_at_least(request.google_id, 'EDIT'):
+ return Response(403, 'Forbidden from adding an experiment to {}.'.format(simulation))
+
+ # Instantiate an Experiment
+
+ experiment = Experiment.from_JSON(request.params_body['experiment'])
+ experiment.state = 'QUEUED'
+ experiment.last_simulated_tick = 0
+
+ # Try to insert this Experiment
+
+ try:
+ experiment.insert()
+
+ except exceptions.ForeignKeyError as e:
+ return Response(400, 'Foreign key constraint not met.' + e.message)
+
+ # Return this Experiment
+
+ experiment.read()
+
+ return Response(
+ 200,
+ 'Successfully added {}.'.format(experiment),
+ experiment.to_JSON()
+ )