Set basePath on swagger.json when serving under OpenWhisk

We need to setup the proper base path when we are running under
OpenWhisk, as the OpenAPI spec states that all URLs are constructed
using basePath (if exists) or otherwise they are absolute urls. Since we
are running as Web actions in OW, we need to set the basePath to the
actual action path.

Author: alvarolopez

deepaas/api/__init__.py

@@ -54,7 +54,7 @@
 
 
 async def get_app(swagger=True, doc="/ui", prefix="",
-                  static_path="/static/swagger",
+                  static_path="/static/swagger", base_path="",
                   enable_train=True, enable_predict=True):
     """Get the main app."""
     global APP
@@ -120,6 +120,7 @@ async def get_app(swagger=True, doc="/ui", prefix="",
                 "description": "API documentation",
                 "url": "https://deepaas.readthedocs.org/",
             },
+            basePath=base_path,
             version=deepaas.__version__,
             url="/swagger.json",
             swagger_path=doc if doc else None,

deepaas/openwhisk/proxy.py

@@ -29,11 +29,24 @@
 from deepaas import api
 from deepaas.openwhisk import handle
 
+cli_opts = [
+    cfg.StrOpt('base-openwhisk-path',
+               default='/api/v1/web',
+               help="""
+Base path where OpenWhisk web actions are served.
+
+This option is being used to build the base path for the swagger.json file
+that is served as part of the OpenWhisk action. By default this configuration
+variable points to "/api/v1/web/". We append to this variable the name of the
+action, so that the swagger.json contains the correct basePath.
+"""),
+]
+
 CONF = cfg.CONF
+CONF.register_cli_opts(cli_opts)
 
 LOG_SENTINEL = 'XXX_THE_END_OF_A_WHISK_ACTIVATION_XXX'
 
-
 routes = web.RouteTableDef()
 
 APP = None
@@ -46,11 +59,30 @@
 async def init(request):
     global APP
 
+    try:
+        message = await request.json()
+    except Exception as e:
+        return error_bad_request(msg="Error: {}".format(e))
+
+    if message and not isinstance(message, dict):
+        return error_bad_request()
+    else:
+        args = message.get('value', {}) if message else {}
+        if not isinstance(args, dict):
+            return error_bad_request()
+        env = args.get('env', {})
+        if not isinstance(env, dict):
+            return error_bad_request()
+
+    base = CONF.base_openwhisk_path
+    action_name = env.get('__OW_ACTION_NAME', '')
+    base_path = "{}{}".format(base, action_name)
+
     try:
         if APP is None:
             APP = await api.get_app(swagger=True,
                                     doc=False,
-                                    prefix=".",
+                                    base_path=base_path,
                                     enable_train=False)
         return web.Response(text="OK", status=200)
     except Exception as e:

deepaas/tests/test_openwhisk.py

@@ -49,6 +49,16 @@ def setUp(self):
 
         proxy.APP = None
 
+    async def init_action(self):
+        data = {
+            "value": {
+                "env": {
+                    "__OW_ACTION_NAME": "/foo/bar",
+                }
+            }
+        }
+        return await self.client.post("/init", json=data)
+
     def get_wsk_args(self, path):
         return {
             "value": {
@@ -65,7 +75,7 @@ def assertJSON(self, expected, actual):
 
     @test_utils.unittest_run_loop
     async def test_init(self):
-        ret = await self.client.post("/init")
+        ret = await self.init_action()
         self.assertEqual(200, ret.status)
         txt = await ret.text()
         self.assertEqual("OK", txt)
@@ -78,7 +88,7 @@ def test_mock(self):
             m_get_app.side_effect = Exception("K-Boom")
 
             async def test_init_failure():
-                ret = await self.client.post("/init")
+                ret = await self.init_action()
                 self.assertEqual(500, ret.status)
                 self.assertDictEqual(
                     {'error': 'Internal error. K-Boom'},
@@ -96,15 +106,15 @@ async def do_test():
 
     def test_run_no_data(self):
         async def do_test():
-            ret = await self.client.post("/init")
+            ret = await self.init_action()
             ret = await self.client.post("/run")
             self.assertEqual(400, ret.status)
         self.loop.run_until_complete(do_test())
 
     def test_run_versions(self):
         async def do_test():
             data = self.get_wsk_args("/")
-            ret = await self.client.post("/init")
+            ret = await self.init_action()
             ret = await self.client.post("/run", json=data)
             body = copy.deepcopy(fake_responses.versions)
             # Terrible
@@ -120,7 +130,7 @@ async def do_test():
     def test_run_version_v2(self):
         async def do_test():
             data = self.get_wsk_args("/v2/")
-            ret = await self.client.post("/init")
+            ret = await self.init_action()
             ret = await self.client.post("/run", json=data)
             body = fake_responses.v2_version
             resp = {
@@ -134,7 +144,7 @@ async def do_test():
     def test_run_models(self):
         async def do_test():
             data = self.get_wsk_args("/v2/models")
-            ret = await self.client.post("/init")
+            ret = await self.init_action()
             ret = await self.client.post("/run", json=data)
             body = fake_responses.models_meta
             resp = {
@@ -148,7 +158,7 @@ async def do_test():
     def test_run_models_deepaas(self):
         async def do_test():
             data = self.get_wsk_args("/v2/models/deepaas-test")
-            ret = await self.client.post("/init")
+            ret = await self.init_action()
             ret = await self.client.post("/run", json=data)
             body = fake_responses.deepaas_test_meta
             resp = {