summaryrefslogtreecommitdiff
path: root/opendc-web/opendc-web-api/opendc/api/v2/prefabs/prefabId
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/prefabs/prefabId
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/prefabs/prefabId')
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/prefabs/prefabId/__init__.py0
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/prefabs/prefabId/endpoint.py50
-rw-r--r--opendc-web/opendc-web-api/opendc/api/v2/prefabs/prefabId/test_endpoint.py145
3 files changed, 195 insertions, 0 deletions
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/prefabs/prefabId/__init__.py b/opendc-web/opendc-web-api/opendc/api/v2/prefabs/prefabId/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/prefabs/prefabId/__init__.py
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/prefabs/prefabId/endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/prefabs/prefabId/endpoint.py
new file mode 100644
index 00000000..7b81f546
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/prefabs/prefabId/endpoint.py
@@ -0,0 +1,50 @@
+from datetime import datetime
+
+from opendc.models.prefab import Prefab
+from opendc.util.database import Database
+from opendc.util.rest import Response
+
+
+def GET(request):
+ """Get this Prefab."""
+
+ request.check_required_parameters(path={'prefabId': 'string'})
+
+ prefab = Prefab.from_id(request.params_path['prefabId'])
+ prefab.check_exists()
+ prefab.check_user_access(request.google_id)
+
+ return Response(200, 'Successfully retrieved prefab', prefab.obj)
+
+
+def PUT(request):
+ """Update a prefab's name and/or contents."""
+
+ request.check_required_parameters(body={'prefab': {'name': 'name'}}, path={'prefabId': 'string'})
+
+ prefab = Prefab.from_id(request.params_path['prefabId'])
+
+ prefab.check_exists()
+ prefab.check_user_access(request.google_id)
+
+ prefab.set_property('name', request.params_body['prefab']['name'])
+ prefab.set_property('rack', request.params_body['prefab']['rack'])
+ prefab.set_property('datetime_last_edited', Database.datetime_to_string(datetime.now()))
+ prefab.update()
+
+ return Response(200, 'Successfully updated prefab.', prefab.obj)
+
+
+def DELETE(request):
+ """Delete this Prefab."""
+
+ request.check_required_parameters(path={'prefabId': 'string'})
+
+ prefab = Prefab.from_id(request.params_path['prefabId'])
+
+ prefab.check_exists()
+ prefab.check_user_access(request.google_id)
+
+ old_object = prefab.delete()
+
+ return Response(200, 'Successfully deleted prefab.', old_object)
diff --git a/opendc-web/opendc-web-api/opendc/api/v2/prefabs/prefabId/test_endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/prefabs/prefabId/test_endpoint.py
new file mode 100644
index 00000000..2daeb6bf
--- /dev/null
+++ b/opendc-web/opendc-web-api/opendc/api/v2/prefabs/prefabId/test_endpoint.py
@@ -0,0 +1,145 @@
+from opendc.util.database import DB
+from unittest.mock import Mock
+
+test_id = 24 * '1'
+test_id_2 = 24 * '2'
+
+
+def test_get_prefab_non_existing(client, mocker):
+ mocker.patch.object(DB, 'fetch_one', return_value=None)
+ assert '404' in client.get(f'/v2/prefabs/{test_id}').status
+
+
+def test_get_private_prefab_not_authorized(client, mocker):
+ DB.fetch_one = Mock()
+ DB.fetch_one.side_effect = [{
+ '_id': test_id,
+ 'name': 'test prefab',
+ 'authorId': test_id_2,
+ 'visibility': 'private',
+ 'rack': {}
+ },
+ {
+ '_id': test_id
+ }
+ ]
+ res = client.get(f'/v2/prefabs/{test_id}')
+ assert '403' in res.status
+
+
+def test_get_private_prefab(client, mocker):
+ DB.fetch_one = Mock()
+ DB.fetch_one.side_effect = [{
+ '_id': test_id,
+ 'name': 'test prefab',
+ 'authorId': test_id,
+ 'visibility': 'private',
+ 'rack': {}
+ },
+ {
+ '_id': test_id
+ }
+ ]
+ res = client.get(f'/v2/prefabs/{test_id}')
+ assert '200' in res.status
+
+
+def test_get_public_prefab(client, mocker):
+ DB.fetch_one = Mock()
+ DB.fetch_one.side_effect = [{
+ '_id': test_id,
+ 'name': 'test prefab',
+ 'authorId': test_id_2,
+ 'visibility': 'public',
+ 'rack': {}
+ },
+ {
+ '_id': test_id
+ }
+ ]
+ res = client.get(f'/v2/prefabs/{test_id}')
+ assert '200' in res.status
+
+
+def test_update_prefab_missing_parameter(client):
+ assert '400' in client.put(f'/v2/prefabs/{test_id}').status
+
+
+def test_update_prefab_non_existing(client, mocker):
+ mocker.patch.object(DB, 'fetch_one', return_value=None)
+ assert '404' in client.put(f'/v2/prefabs/{test_id}', json={'prefab': {'name': 'S'}}).status
+
+
+def test_update_prefab_not_authorized(client, mocker):
+ DB.fetch_one = Mock()
+ DB.fetch_one.side_effect = [{
+ '_id': test_id,
+ 'name': 'test prefab',
+ 'authorId': test_id_2,
+ 'visibility': 'private',
+ 'rack': {}
+ },
+ {
+ '_id': test_id
+ }
+ ]
+ mocker.patch.object(DB, 'update', return_value={})
+ assert '403' in client.put(f'/v2/prefabs/{test_id}', json={'prefab': {'name': 'test prefab', 'rack': {}}}).status
+
+
+def test_update_prefab(client, mocker):
+ DB.fetch_one = Mock()
+ DB.fetch_one.side_effect = [{
+ '_id': test_id,
+ 'name': 'test prefab',
+ 'authorId': test_id,
+ 'visibility': 'private',
+ 'rack': {}
+ },
+ {
+ '_id': test_id
+ }
+ ]
+ mocker.patch.object(DB, 'update', return_value={})
+ res = client.put(f'/v2/prefabs/{test_id}', json={'prefab': {'name': 'test prefab', 'rack': {}}})
+ assert '200' in res.status
+
+
+def test_delete_prefab_non_existing(client, mocker):
+ mocker.patch.object(DB, 'fetch_one', return_value=None)
+ assert '404' in client.delete(f'/v2/prefabs/{test_id}').status
+
+
+def test_delete_prefab_different_user(client, mocker):
+ DB.fetch_one = Mock()
+ DB.fetch_one.side_effect = [{
+ '_id': test_id,
+ 'name': 'test prefab',
+ 'authorId': test_id_2,
+ 'visibility': 'private',
+ 'rack': {}
+ },
+ {
+ '_id': test_id
+ }
+ ]
+ mocker.patch.object(DB, 'delete_one', return_value=None)
+ assert '403' in client.delete(f'/v2/prefabs/{test_id}').status
+
+
+def test_delete_prefab(client, mocker):
+ DB.fetch_one = Mock()
+ DB.fetch_one.side_effect = [{
+ '_id': test_id,
+ 'name': 'test prefab',
+ 'authorId': test_id,
+ 'visibility': 'private',
+ 'rack': {}
+ },
+ {
+ '_id': test_id
+ }
+ ]
+ mocker.patch.object(DB, 'delete_one', return_value={'prefab': {'name': 'name'}})
+ res = client.delete(f'/v2/prefabs/{test_id}')
+ assert '200' in res.status