api: Migrate to Flask Restful

This change updates the API to use Flask Restful instead of our own
in-house REST library. This change reduces the maintenance effort and
allows us to drastically simplify the API implementation needed for the
OpenDC v2 API.

1 files changed, 135 insertions, 0 deletions

diff --git a/opendc-web/opendc-web-api/tests/api/test_scenarios.py b/opendc-web/opendc-web-api/tests/api/test_scenarios.py
new file mode 100644
index 00000000..bdd5c4a3
--- /dev/null
+++ b/opendc-web/opendc-web-api/tests/api/test_scenarios.py
@@ -0,0 +1,135 @@
+#  Copyright (c) 2021 AtLarge Research
+#
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+#  The above copyright notice and this permission notice shall be included in all
+#  copies or substantial portions of the Software.
+#
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#  SOFTWARE.
+
+from opendc.exts import db
+
+test_id = 24 * '1'
+test_id_2 = 24 * '2'
+
+
+def test_get_scenario_non_existing(client, mocker):
+    mocker.patch.object(db, 'fetch_one', return_value=None)
+    assert '404' in client.get(f'/scenarios/{test_id}').status
+
+
+def test_get_scenario_no_authorizations(client, mocker):
+    m = mocker.MagicMock()
+    m.side_effect = ({'portfolioId': test_id}, {'projectId': test_id}, {'authorizations': []})
+    mocker.patch.object(db, 'fetch_one', m)
+    res = client.get(f'/scenarios/{test_id}')
+    assert '403' in res.status
+
+
+def test_get_scenario(client, mocker):
+    mocker.patch.object(db,
+                        'fetch_one',
+                        side_effect=[
+                            {'portfolioId': test_id},
+                            {'projectId': test_id},
+                            {'authorizations':
+                                 [{'userId': 'test', 'level': 'OWN'}]
+                             }])
+    res = client.get(f'/scenarios/{test_id}')
+    assert '200' in res.status
+
+
+def test_update_scenario_missing_parameter(client):
+    assert '400' in client.put(f'/scenarios/{test_id}').status
+
+
+def test_update_scenario_non_existing(client, mocker):
+    mocker.patch.object(db, 'fetch_one', return_value=None)
+    assert '404' in client.put(f'/scenarios/{test_id}', json={
+        'scenario': {
+            'name': 'test',
+        }
+    }).status
+
+
+def test_update_scenario_not_authorized(client, mocker):
+    mocker.patch.object(db,
+                        'fetch_one',
+                        side_effect=[
+                            {'portfolioId': test_id},
+                            {'projectId': test_id},
+                            {'authorizations':
+                                 [{'userId': 'test', 'level': 'VIEW'}]
+                             }])
+    mocker.patch.object(db, 'update', return_value={})
+    assert '403' in client.put(f'/scenarios/{test_id}', json={
+        'scenario': {
+            'name': 'test',
+        }
+    }).status
+
+
+def test_update_scenario(client, mocker):
+    mocker.patch.object(db,
+                        'fetch_one',
+                        side_effect=[
+                            {'_id': test_id, 'portfolioId': test_id},
+                            {'projectId': test_id},
+                            {'authorizations':
+                                 [{'userId': 'test', 'level': 'OWN'}]
+                             }])
+    mocker.patch.object(db, 'update', return_value={})
+
+    res = client.put(f'/scenarios/{test_id}', json={'scenario': {
+        'name': 'test',
+    }})
+    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'/scenarios/{test_id}').status
+
+
+def test_delete_project_different_user(client, mocker):
+    mocker.patch.object(db,
+                        'fetch_one',
+                        side_effect=[
+                            {'_id': test_id, 'portfolioId': test_id},
+                            {'projectId': test_id},
+                            {'authorizations':
+                                 [{'userId': 'test', 'level': 'VIEW'}]
+                             }])
+    mocker.patch.object(db, 'delete_one', return_value=None)
+    assert '403' in client.delete(f'/scenarios/{test_id}').status
+
+
+def test_delete_project(client, mocker):
+    mocker.patch.object(db,
+                        'fetch_one',
+                        return_value={
+                            '_id': test_id,
+                            'projectId': test_id,
+                            'portfolioId': test_id,
+                            'googleId': 'test',
+                            'scenarioIds': [test_id],
+                            'authorizations': [{
+                                'userId': 'test',
+                                'level': 'OWN'
+                            }]
+                        })
+    mocker.patch.object(db, 'delete_one', return_value={})
+    mocker.patch.object(db, 'update', return_value=None)
+    res = client.delete(f'/scenarios/{test_id}')
+    assert '200' in res.status