Bugfixes (#9)

* OpenAPI integration work in progress

* API Gateway updates

* API Gateway support - beta release

* README updated

* README updated

* README updated

* README updated

* README updated

* README updated

* Declaration schema updated, Developer portal alpha release

* Postman collection updated

* Devportal alpha release commit

* Devportal alpha release commit

* Added Developer Portal support

* README updated

* README updated

* README updated

* README updated

* README updated

* README updated

* README updated

* README updated

* config.toml updated

* Bugfixes

* Bugfixes

Author: fabriziofiorucci

README.md

@@ -183,6 +183,6 @@ Configuration can be customized mounting `config.toml` as a volume `nginx-declar
 
 When NGINX Declarative API is running, REST API documentation can be accessed at:
 
-- Documentation and testing: http://<NGINX_DECLARATIVE_API_ADDRESS>:5000/docs
-- Redoc documentation: http://<NGINX_DECLARATIVE_API_ADDRESS>:5000/redoc
-- OpenAPI specification: http://<NGINX_DECLARATIVE_API_ADDRESS>:5000/openapi.json
+- Documentation and testing: `http://<NGINX_DECLARATIVE_API_ADDRESS>:5000/docs`
+- Redoc documentation: `http://<NGINX_DECLARATIVE_API_ADDRESS>:5000/redoc`
+- OpenAPI specification: `http://<NGINX_DECLARATIVE_API_ADDRESS>:5000/openapi.json`

contrib/devportal/README.md

@@ -6,7 +6,7 @@ To build:
 
 	docker build --no-cache -t <YOUR_TARGET_IMAGE_NAME> .
 
-To run the pre-build image:
+To run the pre-built image:
 
 	docker run --rm -d -p 5001:5000 --name devportal fiorucci/nginx-declarative-api-devportal
 

etc/config.toml

@@ -24,13 +24,13 @@ port = 5000
 
 # Redis backend for CI/CD automation
 [redis]
-host = "127.0.0.1"
+host = "redis"
 port = 6379
 
 # Devportal helper
 [devportal]
 host = "devportal"
-port = 5000
+port = 5001
 uri = "/v1/devportal"
 
 # Staged configuration for NGINX Management Suite
@@ -42,15 +42,13 @@ devportal_dir = '/etc/nginx/devportal'
 # Time to wait to get status after committing a staged config
 staged_config_publish_waittime = 2
 
-# API v0 & V1
+# NGINX App Protect support
 nap_policies_dir = '/etc/nginx/waf/policies'
 nap_logformats_dir = '/etc/nginx/waf/logformats'
 nap_logformats_template = "logformat.tmpl"
-
-# API v2 - support for v2 Policy Compiler
 nap_policies_dir_pum = '/etc/nms'
 nap_logformats_dir_pum = '/etc/nms'
 
-# Staged configuration filenames
+# NGINX Instance Manager staged configuration filenames
 staged_config_http_filename = 'conf.d/services.conf'
 staged_config_stream_filename = 'stream-conf.d/services.conf'

src/Contrib/DevPortal.py

@@ -13,9 +13,12 @@
 
 
 def buildDevPortal(openapischema):
-    response = requests.post(f"http://{NcgConfig.config['devportal']['host']}:"
-                             f"{NcgConfig.config['devportal']['port']}{NcgConfig.config['devportal']['uri']}",
-                             headers={'Content-Type': 'application/json'}, data=openapischema)
+    try:
+        response = requests.post(f"http://{NcgConfig.config['devportal']['host']}:"
+                                 f"{NcgConfig.config['devportal']['port']}{NcgConfig.config['devportal']['uri']}",
+                                 headers={'Content-Type': 'application/json'}, data=openapischema)
+    except Exception as e:
+        return 400, ""
 
     return response.status_code, json.loads(response.text)
 
@@ -32,6 +35,9 @@ def createDevPortal(locationDeclaration: dict):
             apiSchemaString = Contrib.MiscUtils.yaml_to_json(apiSchemaString)
 
         status, devportalJSON = buildDevPortal(openapischema=apiSchemaString)
-        devportalHTML = base64.b64encode(bytes(devportalJSON['devportal'], 'utf-8')).decode('utf-8')
+        if status == 200:
+            devportalHTML = base64.b64encode(bytes(devportalJSON['devportal'], 'utf-8')).decode('utf-8')
+        else:
+            devportalHTML = ""
 
-    return 200, devportalHTML
+    return status, devportalHTML

src/V3_CreateConfig.py

@@ -152,6 +152,11 @@ def createconfig(declaration: ConfigDeclaration, apiversion: str, runfromautosyn
                         status, devPortalHTML = (
                             Contrib.DevPortal.createDevPortal(locationDeclaration=loc))
 
+                        if status != 200:
+                            return {"status_code": 400,
+                                    "message": {"status_code": status, "message":
+                                        {"code": status, "content": f"Developer Portal creation failed for {loc['apigateway']['openapi_schema']}"}}}
+
                         ### Add optional API Developer portal HTML files
                         # devPortalHTML
                         newAuxFile = {'contents': devPortalHTML, 'name': NcgConfig.config['nms']['devportal_dir'] +
@@ -443,8 +448,13 @@ def createconfig(declaration: ConfigDeclaration, apiversion: str, runfromautosyn
             print(f'Configuration [{configUid}] changed, publishing to NMS')
 
             # Retrieve instance group uid
-            ig = requests.get(url=f'{nmsUrl}/api/platform/v1/instance-groups', auth=(nmsUsername, nmsPassword),
-                              verify=False)
+            try:
+                ig = requests.get(url=f'{nmsUrl}/api/platform/v1/instance-groups', auth=(nmsUsername, nmsPassword),
+                                  verify=False)
+            except Exception as e:
+                return {"status_code": 400,
+                        "message": {"status_code": 400,
+                                    "message": {"code": 400, "content": f"Can't connect to {nmsUrl}"}}}
 
             if ig.status_code != 200:
                 try:

src/V3_NginxConfigDeclaration.py

@@ -10,9 +10,9 @@
 
 
 class OutputConfigMap(BaseModel, extra=Extra.forbid):
-    name: str = ""
+    name: str = "nginx-config"
     namespace: Optional[str] = ""
-    filename: str = ""
+    filename: str = "nginx-config.conf"
 
 
 class OutputHttp(BaseModel, extra=Extra.forbid):