Update gatewayApi for different response + error messaging

Author: rustyjux

microservices/gatewayApi/README.md

@@ -22,7 +22,7 @@ Run `pip install -r requirements.txt` to install dependencies and `python3 wsgi.
 Run `docker build . -t gwa_kong_api` to build the docker container and the following commands to run it
 
 ```sh
-hostip=$(ifconfig en0 | awk '$1 == "inet" {print $2}')
+hostip=$(hostname -I | awk '{print $1}')
 
 docker run -ti --rm \
  -e CONFIG_PATH=/tmp/production.json -e ENVIRONMENT=production \
@@ -40,6 +40,7 @@ docker run -ti --rm \
  -e HOST_TRANSFORM_BASE_URL=api.cloud \
  -e PLUGINS_RATELIMITING_REDIS_PASSWORD="" \
  -e DATA_PLANES_CONFIG_PATH=/dp/data_planes_config.json \
+ -e COMPATIBILITY_API_URL=https://compatibility-api.cloud \
  -v `pwd`/_tmp:/ssl \
  -v `pwd`/_tmp:/dp/ \
  -v ~/.kube/config:/root/.kube/config \

microservices/gatewayApi/clients/compatibility.py

@@ -1,10 +1,10 @@
 import requests
 from flask import current_app as app
 
-def check_kong3_compatibility(namespace: str, config: dict) -> tuple[bool, str, dict | None]:
+def check_kong3_compatibility(namespace: str, config: dict) -> tuple[bool, str, list[str], dict | None]:
     """
     Check Kong 3.x compatibility of configuration using compatibility API
-    Returns (is_compatible, warning_message, kong2_config)
+    Returns (is_compatible, warning_message, failed_routes, kong2_config)
     """
     log = app.logger
 
@@ -16,11 +16,13 @@ def check_kong3_compatibility(namespace: str, config: dict) -> tuple[bool, str,
         res.raise_for_status()
 
         data = res.json()
+        log.debug("[%s] - Compatibility API result for Kong 3 compatibility check: %s" % (namespace, data["kong3_compatible"]))
         return (
             data["kong3_compatible"],
-            data["conversion_output"] if not data["kong3_compatible"] else "",
+            data["message"],
+            data["failed_routes"],
             data["kong2_output"]
         )
     except Exception as e:
         log.error("[%s] - Compatibility API error: %s" % (namespace, str(e)))
-        return (True, "", {}) # Fail open - assume compatible if service unavailable 
+        return (True, "", [], {}) # Fail open - assume compatible if service unavailable 

microservices/gatewayApi/tests/conftest.py

@@ -297,33 +297,45 @@ def mock_requests_post(url, json=None, **kwargs):
         if url == 'http://compatibility-api/configs':
             log.debug(f"Mocking compatibility API: {url}")
             class Response:
-                status_code = 200
                 def json(self):
-                    # Default to compatible if no paths
-                    is_compatible = True
-                    has_paths = False
+                    # Check if any routes have regex without tilde
+                    has_incompatible = False
+                    failed_routes = []
+                    
+                    if json and "services" in json:
+                        for service in json["services"]:
+                            if "routes" in service:
+                                for route in service["routes"]:
+                                    if "paths" in route and "name" in route:
+                                        for path in route["paths"]:
+                                            if "*" in path and not path.startswith("~"):
+                                                has_incompatible = True
+                                                failed_routes.append(route["name"])
+                    
+                    message = (
+                        "Gateway configuration is compatible with Kong 3." 
+                        if not has_incompatible else
+                        "WARNING: Kong 3 incompatible routes found.\n\n"
+                        "APS will soon be updated to use Kong gateway version 3.\n"
+                        "Kong 3 requires that regular expressions in route paths start with a '~' character.\n\n"
+                        "For related information, please visit:\n"
+                        "https://docs.konghq.com/deck/latest/3.0-upgrade\n\n"
+                        "Please update the following routes:"
+                    )
 
-                    if json and 'services' in json:
-                        for service in json['services']:
-                            if 'routes' in service:
-                                for route in service['routes']:
-                                    if 'paths' in route:
-                                        has_paths = True
-                                        # If any path doesn't start with ~, mark as incompatible
-                                        for path in route['paths']:
-                                            if not path.startswith('~'):
-                                                is_compatible = False
-                                                break
-
                     return {
-                        "kong3_compatible": is_compatible,
-                        "conversion_output": "Warning: unsupported routes' paths format with Kong version 3.0" if not is_compatible else "",
+                        "kong3_compatible": not has_incompatible,
+                        "message": message,
+                        "failed_routes": failed_routes,
                         "kong2_output": json
                     }
-                    
+                
                 def raise_for_status(self):
-                    if self.status_code >= 400:
+                    if self.status_code != 200:
                         raise Exception(f"HTTP {self.status_code}")
+                
+                status_code = 200
+                
             return Response()
         raise Exception(f"Unexpected URL: {url}")
 

microservices/gatewayApi/tests/routes/v2/test_gateway.py

@@ -169,7 +169,7 @@ def test_success_mtls_reference(client):
     assert json.dumps(response.json) == '{"message": "Sync successful.", "results": "Deck reported no changes"}'
 
 def test_kong3_compatibility_warning(client):
-    """Test that Kong 3 incompatible config generates warning but still succeeds"""
+    """Test that Kong 3 incompatible config generates warning"""
     configFile = '''
         services:
         - name: my-service
@@ -178,7 +178,11 @@ def test_kong3_compatibility_warning(client):
           routes:
           - name: route-1
             hosts: [ myapi.api.gov.bc.ca ]
-            paths: [ "/example*" ]
+            paths: [ "/path*" ]
+            tags: ["ns.mytest", "another2"]
+          - name: route-2
+            hosts: [ myapi2.api.gov.bc.ca ]
+            paths: [ "/other*" ]
             tags: ["ns.mytest", "another2"]
         '''
 
@@ -190,4 +194,11 @@ def test_kong3_compatibility_warning(client):
     assert response.status_code == 200
     response_data = response.json
     assert response_data["message"] == "Sync successful."
-    assert "Kong 3 Compatibility Warning" in response_data["results"]
+    
+    # Verify warning message and failed routes are in results
+    results = response_data["results"]
+    assert "WARNING: Kong 3 incompatible routes found" in results
+    assert "route-1" in results
+    assert "route-2" in results
+    # Routes should only be listed once even if multiple incompatible paths
+    assert results.count("route-1") == 1

microservices/gatewayApi/v2/routes/gateway.py

@@ -219,6 +219,10 @@ def write_config(namespace: str) -> object:
     orig_config = prep_submitted_config(clone_yaml_files(yaml_documents))
 
     update_routes_flag = False
+    
+    warning_message = ""
+    all_failed_routes = []
+    has_incompatible_routes = False
 
     for index, gw_config in enumerate(yaml_documents):
         log.info("[%s] Parsing file %s" % (namespace, index))
@@ -240,19 +244,17 @@ def write_config(namespace: str) -> object:
         # Enrich the rate-limiting plugin with the appropriate Redis details
         plugins_transformations(namespace, gw_config)
 
-        # Check Kong 3.x compatibility
-        is_compatible, warning, kong2_config = check_kong3_compatibility(namespace, gw_config)
-        if is_compatible:
-            log.info("[%s] Kong 3 compatibility check passed" % (namespace))
-            # If Kong 3 compatibility check passed, use the downgraded Kong 2 config
-            # This is a temporary measure and can be removed once Kong 3 is deployed
+        # Check Kong 3 compatibility
+        is_compatible, warning_message, failed_routes, kong2_config = check_kong3_compatibility(namespace, gw_config)
+        
+        # Track incompatible routes
+        if not is_compatible:
+            has_incompatible_routes = True
+            all_failed_routes.extend(failed_routes)
+        
+        # Use kong2_config (which has compatibility tags) regardless of compatibility status
+        if kong2_config:
             gw_config = kong2_config
-        else:
-            log.info("[%s] Kong 3 compatibility warning: %s" % (namespace, warning))
-            # Add warning to the final results
-            if 'warnings' not in locals():
-                warnings = []
-            warnings.append("Kong 3 Compatibility Warning: %s" % warning)
 
         # After enrichments, dump config to file
         with open("%s/%s" % (tempFolder, 'config-%02d.yaml' % index), 'w') as file:
@@ -423,8 +425,18 @@ def write_config(namespace: str) -> object:
         record_gateway_event(event_id, 'published', 'completed', namespace, blob=orig_config)
 
     results = mask(out.decode('utf-8'))
-    if 'warnings' in locals() and warnings:
-        results = results + "\n\n" + "\n".join(warnings)
+    
+    # Add Kong 3 compatibility warning if needed
+    if has_incompatible_routes:
+        # Add unique failed routes
+        unique_failed_routes = sorted(set(all_failed_routes))
+        route_list = "\n".join(f"  - {route}" for route in unique_failed_routes)
+        warning_message = warning_message + "\n" + route_list
+        
+        # Note: When all routes are compatible, no special response is given.
+        # To add the success message (contained in warning_message), move this
+        # line out of the if block above.
+        results = results + warning_message
 
     return make_response(jsonify(message=message, results=results))