diff options
| author | Fabian Mastenbroek <mail.fabianm@gmail.com> | 2022-04-04 17:00:31 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-04 17:00:31 +0200 |
| commit | 38769373c7e89783d33849283586bfa0b62e8251 (patch) | |
| tree | 4fda128ee6b30018c1aa14c584cc53ade80e67f7 /opendc-web/opendc-web-api/conftest.py | |
| parent | 6021aa4278bebb34bf5603ead4b5daeabcdc4c19 (diff) | |
| parent | 527ae2230f5c2dd22f496f45d5d8e3bd4acdb854 (diff) | |
merge: Migrate to Quarkus-based web API
This pull request changes the web API to a Quarkus-based version. Currently, the OpenDC web API is written in Python (using Flask). Although Python is a powerful language to develop web services, having another language next to Kotlin/Java and JavaScript introduces some challenges.
For instance, the web API and UI lack integration with our Gradle-based build pipeline and require additional steps from the developer to start working with. Furthermore, deploying OpenDC requires having Python installed in addition to the JVM.
By converting the web API into a Quarkus application, we can enjoy further integration with our Gradle-based build pipeline and simplify the development/deployment process of OpenDC, by requiring only the JVM and Node to work with OpenDC.
## Implementation Notes :hammer_and_pick:
* Move build dependencies into version catalog
* Design unified communication protocol
* Add Quarkus API implementation
* Add new web client implementation
* Update runner to use new web client
* Fix compatibility with React.js UI
* Remove Python build steps from CI pipeline
* Update Docker deployment for new web API
* Remove obsolete database configuration
## External Dependencies :four_leaf_clover:
* Quarkus
## Breaking API Changes :warning:
* The new web API only supports SQL-based databases for storing user-data, as opposed to MongoDB currently. We intend to use H2 for development and Postgres for production.
Diffstat (limited to 'opendc-web/opendc-web-api/conftest.py')
| -rw-r--r-- | opendc-web/opendc-web-api/conftest.py | 45 |
1 files changed, 0 insertions, 45 deletions
diff --git a/opendc-web/opendc-web-api/conftest.py b/opendc-web/opendc-web-api/conftest.py deleted file mode 100644 index 958a5894..00000000 --- a/opendc-web/opendc-web-api/conftest.py +++ /dev/null @@ -1,45 +0,0 @@ -""" -Configuration file for all unit tests. -""" - -from functools import wraps -import pytest -from flask import _request_ctx_stack, g -from opendc.database import Database - - -def requires_auth_mock(f): - @wraps(f) - def decorated_function(*args, **kwargs): - _request_ctx_stack.top.current_user = {'sub': 'test'} - return f(*args, **kwargs) - return decorated_function - - -def requires_scope_mock(required_scope): - def decorator(f): - @wraps(f) - def decorated_function(*args, **kwargs): - return f(*args, **kwargs) - return decorated_function - return decorator - - -@pytest.fixture -def client(): - """Returns a Flask API client to interact with.""" - - # Disable authorization for test API endpoints - from opendc import exts - exts.requires_auth = requires_auth_mock - exts.requires_scope = requires_scope_mock - exts.has_scope = lambda x: False - - from app import create_app - - app = create_app(testing=True) - - with app.app_context(): - g.db = Database() - with app.test_client() as client: - yield client |
