summaryrefslogtreecommitdiff
path: root/web-server/opendc/api/v2/simulations/simulationId/experiments
diff options
context:
space:
mode:
authorGeorgios Andreadis <info@gandreadis.com>2020-06-30 11:43:07 +0200
committerFabian Mastenbroek <mail.fabianm@gmail.com>2020-08-24 19:42:27 +0200
commit676ccde281841005e3f318bf267ea1dbcdf6fc87 (patch)
tree53c9257ada1cffeb0cba4f0079e2cad679e0990e /web-server/opendc/api/v2/simulations/simulationId/experiments
parent9b910a49270311fd6f099f0f0674a1fd0ab48a20 (diff)
Add experiment POST
Diffstat (limited to 'web-server/opendc/api/v2/simulations/simulationId/experiments')
-rw-r--r--web-server/opendc/api/v2/simulations/simulationId/experiments/endpoint.py105
-rw-r--r--web-server/opendc/api/v2/simulations/simulationId/experiments/test_endpoint.py75
2 files changed, 95 insertions, 85 deletions
diff --git a/web-server/opendc/api/v2/simulations/simulationId/experiments/endpoint.py b/web-server/opendc/api/v2/simulations/simulationId/experiments/endpoint.py
index 9df84838..2b8aac4d 100644
--- a/web-server/opendc/api/v2/simulations/simulationId/experiments/endpoint.py
+++ b/web-server/opendc/api/v2/simulations/simulationId/experiments/endpoint.py
@@ -1,97 +1,32 @@
-from opendc.models_old.experiment import Experiment
-from opendc.models_old.simulation import Simulation
-from opendc.util import exceptions
+from opendc.models.experiment import Experiment
+from opendc.models.simulation import Simulation
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': 'string'})
-
- except exceptions.ParameterError as e:
- return Response(400, str(e))
-
- # 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': 'string'},
- body={
- 'experiment': {
- 'simulationId': 'string',
- 'pathId': 'int',
- 'traceId': 'int',
- 'schedulerName': 'string',
- 'name': 'string'
- }
- })
-
- except exceptions.ParameterError as e:
- return Response(400, str(e))
-
- # 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
+ request.check_required_parameters(path={'simulationId': 'string'},
+ body={
+ 'experiment': {
+ 'topologyId': 'string',
+ 'traceId': 'string',
+ 'schedulerName': 'string',
+ 'name': 'string',
+ }
+ })
- # Try to insert this Experiment
+ simulation = Simulation.from_id(request.params_path['simulationId'])
- try:
- experiment.insert()
+ simulation.check_exists()
+ simulation.check_user_access(request.google_id, True)
- except exceptions.ForeignKeyError as e:
- return Response(400, 'Foreign key constraint not met.' + e)
+ experiment = Experiment(request.params_body['experiment'])
- # Return this Experiment
+ experiment.set_property('simulationId', request.params_path['simulationId'])
+ experiment.set_property('state', 'QUEUED')
+ experiment.set_property('lastSimulatedTick', 0)
- experiment.read()
+ experiment.insert()
- return Response(200, 'Successfully added {}.'.format(experiment), experiment.to_JSON())
+ return Response(200, 'Successfully added Experiment.', experiment.obj)
diff --git a/web-server/opendc/api/v2/simulations/simulationId/experiments/test_endpoint.py b/web-server/opendc/api/v2/simulations/simulationId/experiments/test_endpoint.py
new file mode 100644
index 00000000..6a459a3c
--- /dev/null
+++ b/web-server/opendc/api/v2/simulations/simulationId/experiments/test_endpoint.py
@@ -0,0 +1,75 @@
+from opendc.util.database import DB
+
+
+def test_add_experiment_missing_parameter(client):
+ assert '400' in client.post('/api/v2/simulations/1/experiments').status
+
+
+def test_add_experiment_non_existing_simulation(client, mocker):
+ mocker.patch.object(DB, 'fetch_one', return_value=None)
+ assert '404' in client.post('/api/v2/simulations/1/experiments',
+ json={
+ 'experiment': {
+ 'topologyId': '1',
+ 'traceId': '1',
+ 'schedulerName': 'default',
+ 'name': 'test',
+ }
+ }).status
+
+
+def test_add_experiment_not_authorized(client, mocker):
+ mocker.patch.object(DB,
+ 'fetch_one',
+ return_value={
+ '_id': '1',
+ 'simulationId': '1',
+ 'authorizations': [{
+ 'simulationId': '1',
+ 'authorizationLevel': 'VIEW'
+ }]
+ })
+ assert '403' in client.post('/api/v2/simulations/1/experiments',
+ json={
+ 'experiment': {
+ 'topologyId': '1',
+ 'traceId': '1',
+ 'schedulerName': 'default',
+ 'name': 'test',
+ }
+ }).status
+
+
+def test_add_experiment(client, mocker):
+ mocker.patch.object(DB,
+ 'fetch_one',
+ return_value={
+ '_id': '1',
+ 'simulationId': '1',
+ 'authorizations': [{
+ 'simulationId': '1',
+ 'authorizationLevel': 'EDIT'
+ }]
+ })
+ mocker.patch.object(DB,
+ 'insert',
+ return_value={
+ 'topologyId': '1',
+ 'traceId': '1',
+ 'schedulerName': 'default',
+ 'name': 'test',
+ 'state': 'QUEUED',
+ 'lastSimulatedTick': 0,
+ })
+ res = client.post(
+ '/api/v2/simulations/1/experiments',
+ json={'experiment': {
+ 'topologyId': '1',
+ 'traceId': '1',
+ 'schedulerName': 'default',
+ 'name': 'test',
+ }})
+ assert 'topologyId' in res.json['content']
+ assert 'state' in res.json['content']
+ assert 'lastSimulatedTick' in res.json['content']
+ assert '200' in res.status