From cd0b45627f0d8da8c8dc4edde223f3c36e9bcfbf Mon Sep 17 00:00:00 2001 From: Fabian Mastenbroek Date: Sun, 25 Apr 2021 16:01:14 +0200 Subject: 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. --- .../opendc/api/v2/prefabs/__init__.py | 0 .../api/v2/prefabs/authorizations/__init__.py | 0 .../api/v2/prefabs/authorizations/endpoint.py | 22 ++++ .../api/v2/prefabs/authorizations/test_endpoint.py | 71 ++++++++++ .../opendc/api/v2/prefabs/endpoint.py | 23 ++++ .../opendc/api/v2/prefabs/prefabId/__init__.py | 0 .../opendc/api/v2/prefabs/prefabId/endpoint.py | 50 +++++++ .../api/v2/prefabs/prefabId/test_endpoint.py | 145 +++++++++++++++++++++ .../opendc/api/v2/prefabs/test_endpoint.py | 24 ++++ 9 files changed, 335 insertions(+) create mode 100644 opendc-web/opendc-web-api/opendc/api/v2/prefabs/__init__.py create mode 100644 opendc-web/opendc-web-api/opendc/api/v2/prefabs/authorizations/__init__.py create mode 100644 opendc-web/opendc-web-api/opendc/api/v2/prefabs/authorizations/endpoint.py create mode 100644 opendc-web/opendc-web-api/opendc/api/v2/prefabs/authorizations/test_endpoint.py create mode 100644 opendc-web/opendc-web-api/opendc/api/v2/prefabs/endpoint.py create mode 100644 opendc-web/opendc-web-api/opendc/api/v2/prefabs/prefabId/__init__.py create mode 100644 opendc-web/opendc-web-api/opendc/api/v2/prefabs/prefabId/endpoint.py create mode 100644 opendc-web/opendc-web-api/opendc/api/v2/prefabs/prefabId/test_endpoint.py create mode 100644 opendc-web/opendc-web-api/opendc/api/v2/prefabs/test_endpoint.py (limited to 'opendc-web/opendc-web-api/opendc/api/v2/prefabs') diff --git a/opendc-web/opendc-web-api/opendc/api/v2/prefabs/__init__.py b/opendc-web/opendc-web-api/opendc/api/v2/prefabs/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/opendc-web/opendc-web-api/opendc/api/v2/prefabs/authorizations/__init__.py b/opendc-web/opendc-web-api/opendc/api/v2/prefabs/authorizations/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/opendc-web/opendc-web-api/opendc/api/v2/prefabs/authorizations/endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/prefabs/authorizations/endpoint.py new file mode 100644 index 00000000..0d9ad5cd --- /dev/null +++ b/opendc-web/opendc-web-api/opendc/api/v2/prefabs/authorizations/endpoint.py @@ -0,0 +1,22 @@ +from opendc.models.prefab import Prefab +from opendc.util.database import DB +from opendc.models.user import User +from opendc.util.rest import Response + + +def GET(request): + """Return all prefabs the user is authorized to access""" + + user = User.from_google_id(request.google_id) + + user.check_exists() + + own_prefabs = DB.fetch_all({'authorId': user.get_id()}, Prefab.collection_name) + public_prefabs = DB.fetch_all({'visibility': 'public'}, Prefab.collection_name) + + authorizations = {"authorizations": []} + + authorizations["authorizations"].append(own_prefabs) + authorizations["authorizations"].append(public_prefabs) + + return Response(200, 'Successfully fetched authorizations.', authorizations) diff --git a/opendc-web/opendc-web-api/opendc/api/v2/prefabs/authorizations/test_endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/prefabs/authorizations/test_endpoint.py new file mode 100644 index 00000000..6d36d428 --- /dev/null +++ b/opendc-web/opendc-web-api/opendc/api/v2/prefabs/authorizations/test_endpoint.py @@ -0,0 +1,71 @@ +from opendc.util.database import DB +from unittest.mock import Mock + +test_id = 24 * '1' + + +def test_get_authorizations(client, mocker): + DB.fetch_all = Mock() + mocker.patch.object(DB, 'fetch_one', return_value={'_id': test_id}) + DB.fetch_all.side_effect = [ + [{ + '_id': test_id, + 'datetimeCreated': '000', + 'datetimeLastEdited': '000', + 'authorId': test_id, + 'visibility' : 'private' + }, + { + '_id': '2' * 24, + 'datetimeCreated': '000', + 'datetimeLastEdited': '000', + 'authorId': test_id, + 'visibility' : 'private' + }, + { + '_id': '3' * 24, + 'datetimeCreated': '000', + 'datetimeLastEdited': '000', + 'authorId': test_id, + 'visibility' : 'public' + }, + { + '_id': '4' * 24, + 'datetimeCreated': '000', + 'datetimeLastEdited': '000', + 'authorId': test_id, + 'visibility' : 'public' + }], + [{ + '_id': '5' * 24, + 'datetimeCreated': '000', + 'datetimeLastEdited': '000', + 'authorId': '2' * 24, + 'visibility' : 'public' + }, + { + '_id': '6' * 24, + 'datetimeCreated': '000', + 'datetimeLastEdited': '000', + 'authorId': '2' * 24, + 'visibility' : 'public' + }, + { + '_id': '7' * 24, + 'datetimeCreated': '000', + 'datetimeLastEdited': '000', + 'authorId': '2' * 24, + 'visibility' : 'public' + }, + { + '_id': '8' * 24, + 'datetimeCreated': '000', + 'datetimeLastEdited': '000', + 'authorId': '2' * 24, + 'visibility' : 'public' + }] + ] + mocker.patch.object(DB, 'fetch_one', return_value={'_id': test_id}) + res = client.get('/v2/prefabs/authorizations') + assert '200' in res.status + diff --git a/opendc-web/opendc-web-api/opendc/api/v2/prefabs/endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/prefabs/endpoint.py new file mode 100644 index 00000000..723a2f0d --- /dev/null +++ b/opendc-web/opendc-web-api/opendc/api/v2/prefabs/endpoint.py @@ -0,0 +1,23 @@ +from datetime import datetime + +from opendc.models.prefab import Prefab +from opendc.models.user import User +from opendc.util.database import Database +from opendc.util.rest import Response + + +def POST(request): + """Create a new prefab, and return that new prefab.""" + + request.check_required_parameters(body={'prefab': {'name': 'string'}}) + + prefab = Prefab(request.params_body['prefab']) + prefab.set_property('datetimeCreated', Database.datetime_to_string(datetime.now())) + prefab.set_property('datetimeLastEdited', Database.datetime_to_string(datetime.now())) + + user = User.from_google_id(request.google_id) + prefab.set_property('authorId', user.get_id()) + + prefab.insert() + + return Response(200, 'Successfully created prefab.', prefab.obj) 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 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 diff --git a/opendc-web/opendc-web-api/opendc/api/v2/prefabs/test_endpoint.py b/opendc-web/opendc-web-api/opendc/api/v2/prefabs/test_endpoint.py new file mode 100644 index 00000000..39a78c21 --- /dev/null +++ b/opendc-web/opendc-web-api/opendc/api/v2/prefabs/test_endpoint.py @@ -0,0 +1,24 @@ +from opendc.util.database import DB + +test_id = 24 * '1' + + +def test_add_prefab_missing_parameter(client): + assert '400' in client.post('/v2/prefabs').status + + +def test_add_prefab(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', + 'authorId': test_id + }) + res = client.post('/v2/prefabs', json={'prefab': {'name': 'test prefab'}}) + assert 'datetimeCreated' in res.json['content'] + assert 'datetimeLastEdited' in res.json['content'] + assert 'authorId' in res.json['content'] + assert '200' in res.status -- cgit v1.2.3