summaryrefslogtreecommitdiff
path: root/opendc-web/opendc-web-api/opendc/api/v2/projects
diff options
context:
space:
mode:
authorFabian Mastenbroek <mail.fabianm@gmail.com>2021-04-25 16:01:14 +0200
committerFabian Mastenbroek <mail.fabianm@gmail.com>2021-04-25 16:01:14 +0200
commitcd0b45627f0d8da8c8dc4edde223f3c36e9bcfbf (patch)
tree6ae1681630a0e270c23804e6dbb3bd414ebe5d6e /opendc-web/opendc-web-api/opendc/api/v2/projects
parent128a1db017545597a5c035b7960eb3fd36b5f987 (diff)
build: Migrate to flat project structure
This change updates the project structure to become flattened. Previously, the simulator, frontend and API each lived into their own directory. With this change, all modules of the project live in the top-level directory of the repository. This should improve discoverability of modules of the project.
Diffstat (limited to 'opendc-web/opendc-web-api/opendc/api/v2/projects')
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/projects/__init__.py0
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/projects/endpoint.py32
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/__init__.py0
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/authorizations/__init__.py0
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/authorizations/endpoint.py17
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/authorizations/test_endpoint.py43
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/endpoint.py66
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/__init__.py0
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/endpoint.py35
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/test_endpoint.py85
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/test_endpoint.py122
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/__init__.py0
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/endpoint.py31
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/test_endpoint.py52
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/projects/test_endpoint.py25
15 files changed, 508 insertions, 0 deletions
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/__init__.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/projects/__init__.py
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/endpoint.py
new file mode 100644
index 00000000..bf031382
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/projects/endpoint.py
@@ -0,0 +1,32 @@
+from datetime import datetime
+
+from opendc.models.project import Project
+from opendc.models.topology import Topology
+from opendc.models.user import User
+from opendc.util.database import Database
+from opendc.util.rest import Response
+
+
+def POST(request):
+ """Create a new project, and return that new project."""
+
+ request.check_required_parameters(body={'project': {'name': 'string'}})
+
+ topology = Topology({'name': 'Default topology', 'rooms': []})
+ topology.insert()
+
+ project = Project(request.params_body['project'])
+ project.set_property('datetimeCreated', Database.datetime_to_string(datetime.now()))
+ project.set_property('datetimeLastEdited', Database.datetime_to_string(datetime.now()))
+ project.set_property('topologyIds', [topology.get_id()])
+ project.set_property('portfolioIds', [])
+ project.insert()
+
+ topology.set_property('projectId', project.get_id())
+ topology.update()
+
+ user = User.from_google_id(request.google_id)
+ user.obj['authorizations'].append({'projectId': project.get_id(), 'authorizationLevel': 'OWN'})
+ user.update()
+
+ return Response(200, 'Successfully created project.', project.obj)
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/__init__.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/__init__.py
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/authorizations/__init__.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/authorizations/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/authorizations/__init__.py
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/authorizations/endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/authorizations/endpoint.py
new file mode 100644
index 00000000..9f6a60ec
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/authorizations/endpoint.py
@@ -0,0 +1,17 @@
+from opendc.models.project import Project
+from opendc.util.rest import Response
+
+
+def GET(request):
+ """Find all authorizations for a Project."""
+
+ request.check_required_parameters(path={'projectId': 'string'})
+
+ project = Project.from_id(request.params_path['projectId'])
+
+ project.check_exists()
+ project.check_user_access(request.google_id, False)
+
+ authorizations = project.get_all_authorizations()
+
+ return Response(200, 'Successfully retrieved project authorizations', authorizations)
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/authorizations/test_endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/authorizations/test_endpoint.py
new file mode 100644
index 00000000..bebd6cff
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/authorizations/test_endpoint.py
@@ -0,0 +1,43 @@
+from opendc.util.database import DB
+
+test_id = 24 * '1'
+test_id_2 = 24 * '2'
+
+
+def test_get_authorizations_non_existing(client, mocker):
+ mocker.patch.object(DB, 'fetch_one', return_value=None)
+ mocker.patch.object(DB, 'fetch_all', return_value=None)
+ assert '404' in client.get(f'/v2/projects/{test_id}/authorizations').status
+
+
+def test_get_authorizations_not_authorized(client, mocker):
+ mocker.patch.object(DB,
+ 'fetch_one',
+ return_value={
+ '_id': test_id,
+ 'name': 'test trace',
+ 'authorizations': [{
+ 'projectId': test_id_2,
+ 'authorizationLevel': 'OWN'
+ }]
+ })
+ mocker.patch.object(DB, 'fetch_all', return_value=[])
+ res = client.get(f'/v2/projects/{test_id}/authorizations')
+ assert '403' in res.status
+
+
+def test_get_authorizations(client, mocker):
+ mocker.patch.object(DB,
+ 'fetch_one',
+ return_value={
+ '_id': test_id,
+ 'name': 'test trace',
+ 'authorizations': [{
+ 'projectId': test_id,
+ 'authorizationLevel': 'OWN'
+ }]
+ })
+ mocker.patch.object(DB, 'fetch_all', return_value=[])
+ res = client.get(f'/v2/projects/{test_id}/authorizations')
+ assert len(res.json['content']) == 0
+ assert '200' in res.status
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/endpoint.py
new file mode 100644
index 00000000..caac37ca
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/endpoint.py
@@ -0,0 +1,66 @@
+from datetime import datetime
+
+from opendc.models.portfolio import Portfolio
+from opendc.models.project import Project
+from opendc.models.topology import Topology
+from opendc.models.user import User
+from opendc.util.database import Database
+from opendc.util.rest import Response
+
+
+def GET(request):
+ """Get this Project."""
+
+ request.check_required_parameters(path={'projectId': 'string'})
+
+ project = Project.from_id(request.params_path['projectId'])
+
+ project.check_exists()
+ project.check_user_access(request.google_id, False)
+
+ return Response(200, 'Successfully retrieved project', project.obj)
+
+
+def PUT(request):
+ """Update a project's name."""
+
+ request.check_required_parameters(body={'project': {'name': 'name'}}, path={'projectId': 'string'})
+
+ project = Project.from_id(request.params_path['projectId'])
+
+ project.check_exists()
+ project.check_user_access(request.google_id, True)
+
+ project.set_property('name', request.params_body['project']['name'])
+ project.set_property('datetime_last_edited', Database.datetime_to_string(datetime.now()))
+ project.update()
+
+ return Response(200, 'Successfully updated project.', project.obj)
+
+
+def DELETE(request):
+ """Delete this Project."""
+
+ request.check_required_parameters(path={'projectId': 'string'})
+
+ project = Project.from_id(request.params_path['projectId'])
+
+ project.check_exists()
+ project.check_user_access(request.google_id, True)
+
+ for topology_id in project.obj['topologyIds']:
+ topology = Topology.from_id(topology_id)
+ topology.delete()
+
+ for portfolio_id in project.obj['portfolioIds']:
+ portfolio = Portfolio.from_id(portfolio_id)
+ portfolio.delete()
+
+ user = User.from_google_id(request.google_id)
+ user.obj['authorizations'] = list(
+ filter(lambda x: x['projectId'] != project.get_id(), user.obj['authorizations']))
+ user.update()
+
+ old_object = project.delete()
+
+ return Response(200, 'Successfully deleted project.', old_object)
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/__init__.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/__init__.py
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/endpoint.py
new file mode 100644
index 00000000..2cdb1194
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/endpoint.py
@@ -0,0 +1,35 @@
+from opendc.models.portfolio import Portfolio
+from opendc.models.project import Project
+from opendc.util.rest import Response
+
+
+def POST(request):
+ """Add a new Portfolio for this Project."""
+
+ request.check_required_parameters(path={'projectId': 'string'},
+ body={
+ 'portfolio': {
+ 'name': 'string',
+ 'targets': {
+ 'enabledMetrics': 'list',
+ 'repeatsPerScenario': 'int',
+ },
+ }
+ })
+
+ project = Project.from_id(request.params_path['projectId'])
+
+ project.check_exists()
+ project.check_user_access(request.google_id, True)
+
+ portfolio = Portfolio(request.params_body['portfolio'])
+
+ portfolio.set_property('projectId', project.get_id())
+ portfolio.set_property('scenarioIds', [])
+
+ portfolio.insert()
+
+ project.obj['portfolioIds'].append(portfolio.get_id())
+ project.update()
+
+ return Response(200, 'Successfully added Portfolio.', portfolio.obj)
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/test_endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/test_endpoint.py
new file mode 100644
index 00000000..04c699b5
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/portfolios/test_endpoint.py
@@ -0,0 +1,85 @@
+from opendc.util.database import DB
+
+test_id = 24 * '1'
+
+
+def test_add_portfolio_missing_parameter(client):
+ assert '400' in client.post(f'/v2/projects/{test_id}/portfolios').status
+
+
+def test_add_portfolio_non_existing_project(client, mocker):
+ mocker.patch.object(DB, 'fetch_one', return_value=None)
+ assert '404' in client.post(f'/v2/projects/{test_id}/portfolios',
+ json={
+ 'portfolio': {
+ 'name': 'test',
+ 'targets': {
+ 'enabledMetrics': ['test'],
+ 'repeatsPerScenario': 2
+ }
+ }
+ }).status
+
+
+def test_add_portfolio_not_authorized(client, mocker):
+ mocker.patch.object(DB,
+ 'fetch_one',
+ return_value={
+ '_id': test_id,
+ 'projectId': test_id,
+ 'authorizations': [{
+ 'projectId': test_id,
+ 'authorizationLevel': 'VIEW'
+ }]
+ })
+ assert '403' in client.post(f'/v2/projects/{test_id}/portfolios',
+ json={
+ 'portfolio': {
+ 'name': 'test',
+ 'targets': {
+ 'enabledMetrics': ['test'],
+ 'repeatsPerScenario': 2
+ }
+ }
+ }).status
+
+
+def test_add_portfolio(client, mocker):
+ mocker.patch.object(DB,
+ 'fetch_one',
+ return_value={
+ '_id': test_id,
+ 'projectId': test_id,
+ 'portfolioIds': [test_id],
+ 'authorizations': [{
+ 'projectId': test_id,
+ 'authorizationLevel': 'EDIT'
+ }]
+ })
+ mocker.patch.object(DB,
+ 'insert',
+ return_value={
+ '_id': test_id,
+ 'name': 'test',
+ 'targets': {
+ 'enabledMetrics': ['test'],
+ 'repeatsPerScenario': 2
+ },
+ 'projectId': test_id,
+ 'scenarioIds': [],
+ })
+ mocker.patch.object(DB, 'update', return_value=None)
+ res = client.post(
+ f'/v2/projects/{test_id}/portfolios',
+ json={
+ 'portfolio': {
+ 'name': 'test',
+ 'targets': {
+ 'enabledMetrics': ['test'],
+ 'repeatsPerScenario': 2
+ }
+ }
+ })
+ assert 'projectId' in res.json['content']
+ assert 'scenarioIds' in res.json['content']
+ assert '200' in res.status
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/test_endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/test_endpoint.py
new file mode 100644
index 00000000..f9ffaf37
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/test_endpoint.py
@@ -0,0 +1,122 @@
+from opendc.util.database import DB
+
+test_id = 24 * '1'
+test_id_2 = 24 * '2'
+
+
+def test_get_project_non_existing(client, mocker):
+ mocker.patch.object(DB, 'fetch_one', return_value=None)
+ assert '404' in client.get(f'/v2/projects/{test_id}').status
+
+
+def test_get_project_no_authorizations(client, mocker):
+ mocker.patch.object(DB, 'fetch_one', return_value={'authorizations': []})
+ res = client.get(f'/v2/projects/{test_id}')
+ assert '403' in res.status
+
+
+def test_get_project_not_authorized(client, mocker):
+ mocker.patch.object(DB,
+ 'fetch_one',
+ return_value={
+ '_id': test_id,
+ 'authorizations': [{
+ 'projectId': test_id_2,
+ 'authorizationLevel': 'OWN'
+ }]
+ })
+ res = client.get(f'/v2/projects/{test_id}')
+ assert '403' in res.status
+
+
+def test_get_project(client, mocker):
+ mocker.patch.object(DB,
+ 'fetch_one',
+ return_value={
+ '_id': test_id,
+ 'authorizations': [{
+ 'projectId': test_id,
+ 'authorizationLevel': 'EDIT'
+ }]
+ })
+ res = client.get(f'/v2/projects/{test_id}')
+ assert '200' in res.status
+
+
+def test_update_project_missing_parameter(client):
+ assert '400' in client.put(f'/v2/projects/{test_id}').status
+
+
+def test_update_project_non_existing(client, mocker):
+ mocker.patch.object(DB, 'fetch_one', return_value=None)
+ assert '404' in client.put(f'/v2/projects/{test_id}', json={'project': {'name': 'S'}}).status
+
+
+def test_update_project_not_authorized(client, mocker):
+ mocker.patch.object(DB,
+ 'fetch_one',
+ return_value={
+ '_id': test_id,
+ 'authorizations': [{
+ 'projectId': test_id,
+ 'authorizationLevel': 'VIEW'
+ }]
+ })
+ mocker.patch.object(DB, 'update', return_value={})
+ assert '403' in client.put(f'/v2/projects/{test_id}', json={'project': {'name': 'S'}}).status
+
+
+def test_update_project(client, mocker):
+ mocker.patch.object(DB,
+ 'fetch_one',
+ return_value={
+ '_id': test_id,
+ 'authorizations': [{
+ 'projectId': test_id,
+ 'authorizationLevel': 'OWN'
+ }]
+ })
+ mocker.patch.object(DB, 'update', return_value={})
+
+ res = client.put(f'/v2/projects/{test_id}', json={'project': {'name': 'S'}})
+ assert '200' in res.status
+
+
+def test_delete_project_non_existing(client, mocker):
+ mocker.patch.object(DB, 'fetch_one', return_value=None)
+ assert '404' in client.delete(f'/v2/projects/{test_id}').status
+
+
+def test_delete_project_different_user(client, mocker):
+ mocker.patch.object(DB,
+ 'fetch_one',
+ return_value={
+ '_id': test_id,
+ 'googleId': 'other_test',
+ 'authorizations': [{
+ 'projectId': test_id,
+ 'authorizationLevel': 'VIEW'
+ }],
+ 'topologyIds': []
+ })
+ mocker.patch.object(DB, 'delete_one', return_value=None)
+ assert '403' in client.delete(f'/v2/projects/{test_id}').status
+
+
+def test_delete_project(client, mocker):
+ mocker.patch.object(DB,
+ 'fetch_one',
+ return_value={
+ '_id': test_id,
+ 'googleId': 'test',
+ 'authorizations': [{
+ 'projectId': test_id,
+ 'authorizationLevel': 'OWN'
+ }],
+ 'topologyIds': [],
+ 'portfolioIds': [],
+ })
+ mocker.patch.object(DB, 'update', return_value=None)
+ mocker.patch.object(DB, 'delete_one', return_value={'googleId': 'test'})
+ res = client.delete(f'/v2/projects/{test_id}')
+ assert '200' in res.status
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/__init__.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/__init__.py
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/endpoint.py
new file mode 100644
index 00000000..44a0d575
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/endpoint.py
@@ -0,0 +1,31 @@
+from datetime import datetime
+
+from opendc.models.project import Project
+from opendc.models.topology import Topology
+from opendc.util.rest import Response
+from opendc.util.database import Database
+
+
+def POST(request):
+ """Add a new Topology to the specified project and return it"""
+
+ request.check_required_parameters(path={'projectId': 'string'}, body={'topology': {'name': 'string'}})
+
+ project = Project.from_id(request.params_path['projectId'])
+
+ project.check_exists()
+ project.check_user_access(request.google_id, True)
+
+ topology = Topology({
+ 'projectId': project.get_id(),
+ 'name': request.params_body['topology']['name'],
+ 'rooms': request.params_body['topology']['rooms'],
+ })
+
+ topology.insert()
+
+ project.obj['topologyIds'].append(topology.get_id())
+ project.set_property('datetimeLastEdited', Database.datetime_to_string(datetime.now()))
+ project.update()
+
+ return Response(200, 'Successfully inserted topology.', topology.obj)
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/test_endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/test_endpoint.py
new file mode 100644
index 00000000..71e88f00
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/projects/projectId/topologies/test_endpoint.py
@@ -0,0 +1,52 @@
+from opendc.util.database import DB
+
+test_id = 24 * '1'
+
+
+def test_add_topology_missing_parameter(client):
+ assert '400' in client.post(f'/v2/projects/{test_id}/topologies').status
+
+
+def test_add_topology(client, mocker):
+ mocker.patch.object(DB,
+ 'fetch_one',
+ return_value={
+ '_id': test_id,
+ 'authorizations': [{
+ 'projectId': test_id,
+ 'authorizationLevel': 'OWN'
+ }],
+ 'topologyIds': []
+ })
+ mocker.patch.object(DB,
+ 'insert',
+ return_value={
+ '_id': test_id,
+ 'datetimeCreated': '000',
+ 'datetimeLastEdited': '000',
+ 'topologyIds': []
+ })
+ mocker.patch.object(DB, 'update', return_value={})
+ res = client.post(f'/v2/projects/{test_id}/topologies', json={'topology': {'name': 'test project', 'rooms': []}})
+ assert 'rooms' in res.json['content']
+ assert '200' in res.status
+
+
+def test_add_topology_not_authorized(client, mocker):
+ mocker.patch.object(DB,
+ 'fetch_one',
+ return_value={
+ '_id': test_id,
+ 'projectId': test_id,
+ 'authorizations': [{
+ 'projectId': test_id,
+ 'authorizationLevel': 'VIEW'
+ }]
+ })
+ assert '403' in client.post(f'/v2/projects/{test_id}/topologies',
+ json={
+ 'topology': {
+ 'name': 'test_topology',
+ 'rooms': {}
+ }
+ }).status
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/projects/test_endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/projects/test_endpoint.py
new file mode 100644
index 00000000..9444b1e4
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/projects/test_endpoint.py
@@ -0,0 +1,25 @@
+from opendc.util.database import DB
+
+test_id = 24 * '1'
+
+
+def test_add_project_missing_parameter(client):
+ assert '400' in client.post('/v2/projects').status
+
+
+def test_add_project(client, mocker):
+ mocker.patch.object(DB, 'fetch_one', return_value={'_id': test_id, 'authorizations': []})
+ mocker.patch.object(DB,
+ 'insert',
+ return_value={
+ '_id': test_id,
+ 'datetimeCreated': '000',
+ 'datetimeLastEdited': '000',
+ 'topologyIds': []
+ })
+ mocker.patch.object(DB, 'update', return_value={})
+ res = client.post('/v2/projects', json={'project': {'name': 'test project'}})
+ assert 'datetimeCreated' in res.json['content']
+ assert 'datetimeLastEdited' in res.json['content']
+ assert 'topologyIds' in res.json['content']
+ assert '200' in res.status