summaryrefslogtreecommitdiff
path: root/web-server/opendc/api/v2/experiments
diff options
context:
space:
mode:
authorGeorgios Andreadis <info@gandreadis.com>2020-06-30 11:17:06 +0200
committerFabian Mastenbroek <mail.fabianm@gmail.com>2020-08-24 19:42:26 +0200
commit4ec6212a220c3627bdad070ac2f0e05e2d663979 (patch)
treeaa1b635a44ed68366fbbc660138ef55a3799e5fa /web-server/opendc/api/v2/experiments
parent0df6d7e388ec9bd5a514b2b75de8d95550b48802 (diff)
Add new experiment endpoints
Diffstat (limited to 'web-server/opendc/api/v2/experiments')
-rw-r--r--web-server/opendc/api/v2/experiments/experimentId/endpoint.py112
-rw-r--r--web-server/opendc/api/v2/experiments/experimentId/statistics/__init__.py0
-rw-r--r--web-server/opendc/api/v2/experiments/experimentId/statistics/task-durations/__init__.py0
-rw-r--r--web-server/opendc/api/v2/experiments/experimentId/statistics/task-durations/endpoint.py37
-rw-r--r--web-server/opendc/api/v2/experiments/experimentId/task-states/__init__.py0
-rw-r--r--web-server/opendc/api/v2/experiments/experimentId/task-states/endpoint.py42
6 files changed, 28 insertions, 163 deletions
diff --git a/web-server/opendc/api/v2/experiments/experimentId/endpoint.py b/web-server/opendc/api/v2/experiments/experimentId/endpoint.py
index bc2b139e..8632e19e 100644
--- a/web-server/opendc/api/v2/experiments/experimentId/endpoint.py
+++ b/web-server/opendc/api/v2/experiments/experimentId/endpoint.py
@@ -1,4 +1,4 @@
-from opendc.models_old.experiment import Experiment
+from opendc.models.experiment import Experiment
from opendc.util import exceptions
from opendc.util.rest import Response
@@ -6,108 +6,52 @@ from opendc.util.rest import Response
def GET(request):
"""Get this Experiment."""
- try:
- request.check_required_parameters(path={'experimentId': 'int'})
+ request.check_required_parameters(path={'experimentId': 'string'})
- except exceptions.ParameterError as e:
- return Response(400, str(e))
+ experiment = Experiment.from_id(request.params_path['experimentId'])
- # Instantiate an Experiment from the database
+ experiment.check_exists()
+ experiment.check_user_access(request.google_id, False)
- experiment = Experiment.from_primary_key((request.params_path['experimentId'], ))
-
- # Make sure this Experiment exists
-
- if not experiment.exists():
- return Response(404, '{} not found.'.format(experiment))
-
- # Make sure this user is authorized to view this Experiment
-
- if not experiment.google_id_has_at_least(request.google_id, 'VIEW'):
- return Response(403, 'Forbidden from retrieving {}.'.format(experiment))
-
- # Return this Experiment
-
- experiment.read()
-
- return Response(200, 'Successfully retrieved {}.'.format(experiment), experiment.to_JSON())
+ return Response(200, f'Successfully retrieved Experiment.', experiment.obj)
def PUT(request):
- """Update this Experiment's Path, Trace, Scheduler, and/or name."""
-
- # Make sure required parameters are there
-
- try:
- request.check_required_parameters(
- path={'experimentId': 'int'},
- body={'experiment': {
- 'pathId': 'int',
- 'traceId': 'int',
- 'schedulerName': 'string',
- 'name': 'string'
- }})
-
- except exceptions.ParameterError as e:
- return Response(400, str(e))
-
- # Instantiate an Experiment from the database
+ """Update this Experiment."""
- experiment = Experiment.from_primary_key((request.params_path['experimentId'], ))
+ request.check_required_parameters(path={'experimentId': 'string'},
+ body={'experiment': {
+ 'topologyId': 'string',
+ 'traceId': 'string',
+ 'schedulerName': 'string',
+ 'name': 'string',
+ }})
- # Make sure this Experiment exists
+ experiment = Experiment.from_id(request.params_path['experimentId'])
- if not experiment.exists():
- return Response(404, '{} not found.'.format(experiment))
+ experiment.check_exists()
+ experiment.check_user_access(request.google_id, True)
- # Make sure this user is authorized to edit this Experiment
+ experiment.set_property('topologyId', request.params_body['experiment']['topologyId'])
+ experiment.set_property('traceId', request.params_body['experiment']['traceId'])
+ experiment.set_property('scheduleName', request.params_body['experiment']['scheduleName'])
+ experiment.set_property('name', request.params_body['experiment']['name'])
- if not experiment.google_id_has_at_least(request.google_id, 'EDIT'):
- return Response(403, 'Forbidden from updating {}.'.format(experiment))
+ experiment.update()
- # Update this Experiment
-
- experiment.path_id = request.params_body['experiment']['pathId']
- experiment.trace_id = request.params_body['experiment']['traceId']
- experiment.scheduler_name = request.params_body['experiment']['schedulerName']
- experiment.name = request.params_body['experiment']['name']
-
- try:
- experiment.update()
-
- except exceptions.ForeignKeyError:
- return Response(400, 'Foreign key error.')
-
- # Return this Experiment
-
- return Response(200, 'Successfully updated {}.'.format(experiment), experiment.to_JSON())
+ return Response(200, 'Successfully updated experiment', experiment.obj)
def DELETE(request):
"""Delete this Experiment."""
- # Make sure required parameters are there
-
- try:
- request.check_required_parameters(path={'experimentId': 'int'})
-
- except exceptions.ParameterError as e:
- return Response(400, str(e))
-
- # Instantiate an Experiment and make sure it exists
-
- experiment = Experiment.from_primary_key((request.params_path['experimentId'], ))
-
- if not experiment.exists():
- return Response(404, '{} not found.'.format(experiment))
-
- # Make sure this user is authorized to delete this Experiment
+ request.check_required_parameters(path={'userId': 'string'})
- if not experiment.google_id_has_at_least(request.google_id, 'EDIT'):
- return Response(403, 'Forbidden from deleting {}.'.format(experiment))
+ experiment = Experiment.from_id(request.params_path['experimentId'])
- # Delete and return this Experiment
+ experiment.check_exists()
+ experiment.check_user_access(request.google_id, True)
experiment.delete()
- return Response(200, 'Successfully deleted {}.'.format(experiment), experiment.to_JSON())
+ return Response(200, 'Successfully deleted experiment.', experiment.obj)
diff --git a/web-server/opendc/api/v2/experiments/experimentId/statistics/__init__.py b/web-server/opendc/api/v2/experiments/experimentId/statistics/__init__.py
deleted file mode 100644
index e69de29b..00000000
--- a/web-server/opendc/api/v2/experiments/experimentId/statistics/__init__.py
+++ /dev/null
diff --git a/web-server/opendc/api/v2/experiments/experimentId/statistics/task-durations/__init__.py b/web-server/opendc/api/v2/experiments/experimentId/statistics/task-durations/__init__.py
deleted file mode 100644
index e69de29b..00000000
--- a/web-server/opendc/api/v2/experiments/experimentId/statistics/task-durations/__init__.py
+++ /dev/null
diff --git a/web-server/opendc/api/v2/experiments/experimentId/statistics/task-durations/endpoint.py b/web-server/opendc/api/v2/experiments/experimentId/statistics/task-durations/endpoint.py
deleted file mode 100644
index 498db239..00000000
--- a/web-server/opendc/api/v2/experiments/experimentId/statistics/task-durations/endpoint.py
+++ /dev/null
@@ -1,37 +0,0 @@
-from opendc.models_old.experiment import Experiment
-from opendc.models_old.task_duration import TaskDuration
-from opendc.util import exceptions
-from opendc.util.rest import Response
-
-
-def GET(request):
- """Get this Experiment's Task Durations."""
-
- # Make sure required parameters are there
-
- try:
- request.check_required_parameters(path={'experimentId': 'int'})
-
- except exceptions.ParameterError as e:
- return Response(400, str(e))
-
- # Instantiate an Experiment from the database
-
- experiment = Experiment.from_primary_key((request.params_path['experimentId'], ))
-
- # Make sure this Experiment exists
-
- if not experiment.exists():
- return Response(404, '{} not found.'.format(experiment))
-
- # Make sure this user is authorized to view this Experiment's Task Durations
-
- if not experiment.google_id_has_at_least(request.google_id, 'VIEW'):
- return Response(403, 'Forbidden from viewing Task Durations for {}.'.format(experiment))
-
- # Get and return the Task Durations
-
- task_durations = TaskDuration.from_experiment_id(request.params_path['experimentId'])
-
- return Response(200, 'Successfully retrieved Task Durations for {}.'.format(experiment),
- [x.to_JSON() for x in task_durations])
diff --git a/web-server/opendc/api/v2/experiments/experimentId/task-states/__init__.py b/web-server/opendc/api/v2/experiments/experimentId/task-states/__init__.py
deleted file mode 100644
index e69de29b..00000000
--- a/web-server/opendc/api/v2/experiments/experimentId/task-states/__init__.py
+++ /dev/null
diff --git a/web-server/opendc/api/v2/experiments/experimentId/task-states/endpoint.py b/web-server/opendc/api/v2/experiments/experimentId/task-states/endpoint.py
deleted file mode 100644
index c0ae47fc..00000000
--- a/web-server/opendc/api/v2/experiments/experimentId/task-states/endpoint.py
+++ /dev/null
@@ -1,42 +0,0 @@
-from opendc.models_old.experiment import Experiment
-from opendc.models_old.task_state import TaskState
-from opendc.util import exceptions
-from opendc.util.rest import Response
-
-
-def GET(request):
- """Get this Experiment's Task States."""
-
- # Make sure required parameters are there
-
- try:
- request.check_required_parameters(path={'experimentId': 'int'})
-
- except exceptions.ParameterError as e:
- return Response(400, str(e))
-
- # Instantiate an Experiment from the database
-
- experiment = Experiment.from_primary_key((request.params_path['experimentId'], ))
-
- # Make sure this Experiment exists
-
- if not experiment.exists():
- return Response(404, '{} not found.'.format(experiment))
-
- # Make sure this user is authorized to view Task States for this Experiment
-
- if not experiment.google_id_has_at_least(request.google_id, 'VIEW'):
- return Response(403, 'Forbidden from viewing Task States for {}.'.format(experiment))
-
- # Get and return the Task States
-
- if 'tick' in request.params_query:
- task_states = TaskState.from_experiment_id_and_tick(request.params_path['experimentId'],
- request.params_query['tick'])
-
- else:
- task_states = TaskState.query('experiment_id', request.params_path['experimentId'])
-
- return Response(200, 'Successfully retrieved Task States for {}.'.format(experiment),
- [x.to_JSON() for x in task_states])