feat: add utility to check V2 and V3 compatibility

Author: alvarolopez

deepaas/api/__init__.py

@@ -99,6 +99,15 @@ def get_fastapi_app(
         response_model=responses.VersionsAndLinks,
     )
 
+    # Add a redirect from the old swagger.json to the new openapi.json
+    APP.add_api_route(
+        f"{base_path}/swagger.json",
+        APP.openapi,
+        methods=["GET"],
+        summary="Get OpenAPI schema",
+        tags=["version"],
+    )
+
     return APP
 
 

deepaas/cmd/deepaas_test_v2_v3.py

@@ -0,0 +1,127 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Copyright 2018 Spanish National Research Council (CSIC)
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+import argparse
+import requests
+
+parser = argparse.ArgumentParser(
+    description="DEEPaaS API v2 to v3 migration test script"
+)
+parser.add_argument(
+    "--old-api-base-url",
+    default="http://127.0.0.1:5000",
+    help="Base URL of the old API",
+)
+parser.add_argument(
+    "--new-api-base-url",
+    default="http://127.0.0.1:5001",
+    help="Base URL of the new API",
+)
+parser.add_argument(
+    "--model-name",
+    default="demo_app",
+    help="Name of the model to test. To make testing easier, you should provide "
+         "the name of the model you want to test.",
+)
+
+args = parser.parse_args()
+
+OLD_API_BASE_URL = args.old_api_base_url
+NEW_API_BASE_URL = args.new_api_base_url
+MODEL_NAME = args.model_name
+
+
+def get_openapi_spec(base_url):
+    """Retrieve the OpenAPI spec from the given base URL."""
+
+    response = requests.get(f"{base_url}/swagger.json", timeout=5)
+    response.raise_for_status()  # Raise an error for bad responses
+    return response.json()
+
+
+def compare_endpoints(old_spec, new_spec):
+    """Compare endpoints in both OpenAPI specs.
+
+    This method ignoring methods that have been removed.
+    """
+    old_paths = set(old_spec['paths'].keys())
+    new_paths = set(new_spec['paths'].keys())
+
+    removed_paths = [f'/v2/models/{MODEL_NAME}/train']
+    for path in removed_paths:
+        old_paths.discard(path)
+
+    # Find paths that are in new but not in old
+    missing_in_old = new_paths - old_paths
+
+    if missing_in_old:
+        print("The following endpoints are missing in the old API:")
+        for path in missing_in_old:
+            print(f" - {path}")
+
+    # Check if all old paths (except removed) are in the new API
+    missing_in_new = old_paths - new_paths
+
+    if missing_in_new:
+        print("The following endpoints are missing in the new API:")
+        for path in missing_in_new:
+            print(f" - {path}")
+
+    return old_paths, new_paths
+
+
+def test_endpoint(old_url, new_url, method, endpoint):
+    """Test both endpoints and check if responses are equivalent."""
+
+    old_response = requests.request(method, old_url + endpoint)
+    new_response = requests.request(method, new_url + endpoint)
+
+    assert old_response.status_code == new_response.status_code, (  # nosec
+        f"Status code mismatch for {method} {endpoint}: "
+        f"Old: {old_response.status_code}, New: {new_response.status_code}"
+    )
+
+    old_data = old_response.json()
+    new_data = new_response.json()
+
+    assert old_data == new_data, (  # nosec
+        f"Response mismatch for {method} {endpoint}: Old: {old_data}, New: {new_data}"
+    )
+
+
+def main():
+    """Main function to test the API endpoints."""
+
+    # Retrieve OpenAPI specifications
+    old_openapi_spec = get_openapi_spec(OLD_API_BASE_URL)
+    new_openapi_spec = get_openapi_spec(NEW_API_BASE_URL)
+
+    old_paths, new_paths = compare_endpoints(old_openapi_spec, new_openapi_spec)
+
+    # Testing the endpoints
+    for endpoint in old_paths.intersection(new_paths):
+        # We will loop through all HTTP methods available in the old API
+        for method in ['GET', 'POST', 'PUT', 'DELETE']:
+            try:
+                test_endpoint(OLD_API_BASE_URL, NEW_API_BASE_URL, method, endpoint)
+                print(f"Test passed for {method} {endpoint}")
+            except Exception as e:
+                print(f"Test failed for {method} {endpoint}: {e}")
+
+
+if __name__ == "__main__":
+    main()

deepaas/model/v2/wrapper.py

@@ -19,6 +19,7 @@
 import contextlib
 import functools
 import io
+
 # import os
 # import tempfile
 

pyproject.toml

@@ -41,6 +41,7 @@ classifiers = [
 [tool.poetry.scripts]
 deepaas-run = "deepaas.cmd.run:main"
 deepaas-cli = "deepaas.cmd.cli:main"
+deepaas-test-v2-v3 = "deepaas.cmd.deepaas_test_v2_v3:main"
 
 [tool.poetry.plugins] # Optional super table