Merge pull request #218 from atlanticwave-sdx/217.docker-app-fixes

Docker and app fixes

Dockerfile

@@ -21,4 +21,4 @@ RUN --mount=source=.git,target=.git,type=bind \
 EXPOSE 8080
 
 ENTRYPOINT ["python3"]
-CMD ["-m", "uvicorn", "sdx_controller.app:app"]
+CMD ["-m", "uvicorn", "sdx_controller.app:asgi_app", "--host", "0.0.0.0", "--port", "8080"]

README.md

@@ -140,7 +140,7 @@ $ python3 -m venv venv --upgrade-deps
 $ source ./venv/bin/activate
 $ pip3 install [--editable] .
 $ source .env
-$ python3 -m sdx_controller
+$ flask --app sdx_controller.app:app run --debug
 ```
 
 ### Test topology files and connection requests
@@ -165,7 +165,7 @@ with Docker:
 
 ```console
 $ docker run --rm -d --name rabbitmq -p 5672:5672 -p 15672:15672 rabbitmq:latest
-$ docker run --rm -d --name mongo -p 27017:27017 -e MONGO_INITDB_ROOT_USERNAME=guest -e MONGO_INITDB_ROOT_PASSWORD=guest mongo:3.7
+$ docker run --rm -d --name mongo -p 27017:27017 -e MONGO_INITDB_ROOT_USERNAME=guest -e MONGO_INITDB_ROOT_PASSWORD=guest mongo:7.0.5
 ```
 
 Some environment variables are expected to be set for the tests to

pyproject.toml

@@ -25,6 +25,7 @@ classifiers = [
 dependencies = [
     "jsonschema == 3.2.0",
     "connexion[swagger-ui] >= 2.14.1",
+    "asgiref >= 3.7.2",
     "python_dateutil >= 2.8",
     "setuptools >= 21.0.0",
     "pika >= 1.2.0",

sdx_controller/__init__.py

@@ -37,11 +37,11 @@ def create_app(run_listener: bool = True):
     Create a connexion app.
 
     The object returned is a Connexion App, which in turn contains a
-    Flask app, that we can run either with Flask or WSGI server such
-    as uvicorn::
+    Flask app, that we can run either with Flask or an ASGI server
+    such as uvicorn::
 
-        $ flask run sdx_server.app
-        $ uvicorn run sdx_server.app:app
+        $ flask run sdx_server.app:app
+        $ uvicorn run sdx_server.app:asgi_app
 
     We also create a thread that subscribes to our message queue.
     Occasionally it might be useful not to start the thread (such as
@@ -66,5 +66,7 @@ def create_app(run_listener: bool = True):
 
     if run_listener:
         create_rpc_thread(app)
+    else:
+        app.rpc_consumer = None
 
     return app

sdx_controller/app.py

@@ -1,10 +1,33 @@
 import atexit
 
+from asgiref.wsgi import WsgiToAsgi
+from flask import redirect
+
 from sdx_controller import create_app
 
+# This is a `connexion.apps.flask_app.FlaskApp` that we created using
+# connexion.App().
 application = create_app()
+
+# The application above contains a `flask.app.Flask` object.  We can
+# run the app using flask, like so:
+#
+#     $ flask --app sdx_controller.app:app run --debug
+#
 app = application.app
 
+# We use WsgiToAsgi adapter so that we can use an ASGI server (such as
+# uvicorn or hypercorn), like so:
+#
+#     $ uvicorn sdx_controller.app:asgi_app --host 0.0.0.0 --port 8080
+#
+asgi_app = WsgiToAsgi(app)
+
+
+@app.route("/", methods=["GET"])
+def index():
+    return redirect("/SDX-Controller/1.0.0/ui/")
+
 
 @atexit.register
 def on_app_exit():
@@ -14,7 +37,8 @@ def on_app_exit():
     We run a message queue consumer in a separate thread, and here we
     signal the thread that we're exiting.
     """
-    application.rpc_consumer.stop_threads()
+    if application.rpc_consumer:
+        application.rpc_consumer.stop_threads()
 
 
 if __name__ == "__main__":