Merge dev into main

Author: DinisCruz

README.md

@@ -1,6 +1,6 @@
 # OSBot-Fast-API
 
-![Current Release](https://img.shields.io/badge/release-v0.19.0-blue)
+![Current Release](https://img.shields.io/badge/release-v0.19.1-blue)
 ![Python](https://img.shields.io/badge/python-3.8+-green)
 ![FastAPI](https://img.shields.io/badge/FastAPI-0.100+-red)
 ![Type-Safe](https://img.shields.io/badge/Type--Safe-✓-brightgreen)

osbot_fast_api/admin_ui/api/routes/Routes__Admin__Cookies.py

@@ -1,6 +1,6 @@
 import json
-from typing                                     import Dict, Any, List, Optional
 import osbot_fast_api
+from typing                                     import Dict, Any, List, Optional
 from fastapi                                    import Request, Response
 from osbot_utils.utils.Files                    import path_combine, file_exists
 from osbot_fast_api.api.routes.Fast_API__Routes import Fast_API__Routes

osbot_fast_api/api/routes/Fast_API__Routes.py

@@ -22,14 +22,23 @@ class Fast_API__Routes(Type_Safe):       # refactor to Fast_API__Routes
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
-        if not self.prefix:                                                 # if not set explicitly
-            self.prefix = Safe_Str__Fast_API__Route__Prefix(self.tag)        # create the prefix from the lower case tag and with a starting /
+        if not self.prefix:                                                     # if not set explicitly
+            self.prefix = Safe_Str__Fast_API__Route__Prefix(self.tag)           # create the prefix from the lower case tag and with a starting /
 
     def add_route(self,function, methods):
         path = self.parse_function_name(function)
         self.router.add_api_route(path=path, endpoint=function, methods=methods)
         return self
 
+    def add_route_any(self, function, path=None):                               # Add route that accepts ANY HTTP method
+        methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS']
+
+        if path:
+            self.router.add_api_route(path=path, endpoint=function, methods=methods)
+        else:
+            self.add_route(function, methods)
+
+        return self
     def add_route_with_body(self, function, methods):
         sig        = inspect.signature(function)                                                                # Get function signature
         type_hints = get_type_hints(function)                                                                   # Get type annotations

osbot_fast_api/schemas/Safe_Str__Fast_API__Route__Tag.py

@@ -1,7 +1,7 @@
 import re
 from osbot_utils.type_safe.primitives.safe_str.Safe_Str import Safe_Str
 
-TYPE_SAFE_STR__FASTAPI__ROUTE__REGEX = re.compile(r'[^a-zA-Z0-9\-_/{}.]')
+TYPE_SAFE_STR__FASTAPI__ROUTE__REGEX = re.compile(r'[^a-zA-Z0-9\-_/{}.:]')
 TYPE_SAFE_STR__FASTAPI__ROUTE__MAX_LENGTH = 512
 
 class Safe_Str__Fast_API__Route__Tag(Safe_Str):

osbot_fast_api/schemas/consts__Fast_API.py

@@ -1,5 +1,4 @@
 import re
-
 from osbot_fast_api.schemas.Safe_Str__Fast_API__Route__Prefix import Safe_Str__Fast_API__Route__Prefix
 
 # todo: the names of these variables need a bit of refactoring and normalising
@@ -34,15 +33,19 @@
                                             'set_cookie_form' ,
                                             'status'          ,
                                             'version'         ]
-EXPECTED_ROUTES_PATHS                   = ['/'                     ,
-                                           '/auth/set-auth-cookie' ,
-                                           '/auth/set-cookie-form',
-                                           '/config/info'          ,
+EXPECTED_ROUTES__CONFIG                 = ['/config/info'          ,
                                            '/config/openapi.py'    ,
                                            '/config/routes/html'   ,
                                            '/config/routes/json'   ,
                                            '/config/status'        ,
                                            '/config/version'       ]
+EXPECTED_ROUTES__SET_COOKIE             = ['/auth/set-auth-cookie' ,
+                                           '/auth/set-cookie-form']
+
+EXPECTED_ROUTES_PATHS                   = (['/']                    +
+                                           EXPECTED_ROUTES__CONFIG  +
+                                           EXPECTED_ROUTES__SET_COOKIE)
+
 EXPECTED_DEFAULT_ROUTES                 = ['/docs', '/openapi.json', '/redoc', '/static-docs'      ]
 
 

osbot_fast_api/utils/Fast_API_Server.py

@@ -1,15 +1,15 @@
 import requests
 import threading
-from urllib.parse           import urljoin
-from threading              import Thread
-from fastapi                import FastAPI
+from urllib.parse                    import urljoin
+from threading                       import Thread
+from fastapi                         import FastAPI
 from osbot_utils.type_safe.Type_Safe import Type_Safe
-from osbot_utils.testing.Stderr import Stderr
-from osbot_utils.testing.Stdout import Stdout
-from osbot_utils.utils.Http import wait_for_port, wait_for_port_closed, is_port_open, url_join_safe
-from osbot_utils.utils.Objects import base_types
-from uvicorn                import Config, Server
-from osbot_utils.utils.Misc import random_port
+from osbot_utils.testing.Stderr      import Stderr
+from osbot_utils.testing.Stdout      import Stdout
+from osbot_utils.utils.Http          import wait_for_port, wait_for_port_closed, is_port_open, url_join_safe
+from osbot_utils.utils.Objects       import base_types
+from uvicorn                         import Config, Server
+from osbot_utils.utils.Misc          import random_port
 
 FAST_API__HOST      = "127.0.0.1"
 FAST_API__LOG_LEVEL = "error"

osbot_fast_api/utils/Fast_API__Server_Info.py

@@ -1,8 +1,8 @@
-from osbot_utils.type_safe.Type_Safe     import Type_Safe
+from osbot_utils.type_safe.Type_Safe                                          import Type_Safe
 from osbot_utils.type_safe.primitives.safe_str.identifiers.Random_Guid        import Random_Guid
 from osbot_utils.type_safe.primitives.safe_str.identifiers.Safe_Id            import Safe_Id
-from osbot_utils.type_safe.primitives.safe_int.Timestamp_Now      import Timestamp_Now
-from osbot_utils.utils.Env                  import get_env
+from osbot_utils.type_safe.primitives.safe_int.Timestamp_Now                  import Timestamp_Now
+from osbot_utils.utils.Env                                                    import get_env
 
 ENV_NAME__FAST_API__SERVER_ID   = 'FAST_API__SERVER_ID'
 ENV_NAME__FAST_API__SERVER_NAME = 'FAST_API__SERVER_NAME'

osbot_fast_api/version

@@ -1 +1 @@
-v0.19.0
+v0.19.1

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name        = "osbot_fast_api"
-version     = "v0.19.0"
+version     = "v0.19.1"
 description = "OWASP Security Bot - Fast API"
 authors     = ["Dinis Cruz <dinis.cruz@owasp.org>"]
 license     = "MIT"

tests/unit/admin_ui/api/test_Admin_UI__Fast_API__multiple_workflows.py

@@ -1,3 +1,5 @@
+import time
+import concurrent.futures
 from unittest                                                   import TestCase
 from osbot_utils.utils.Env                                      import in_github_action
 from osbot_utils.utils.Misc                                     import list_set
@@ -7,12 +9,7 @@
 from osbot_fast_api.admin_ui.api.testing.Admin_UI__Test_Context import Admin_UI__Test_Context
 from osbot_fast_api.api.Fast_API                                import Fast_API
 from osbot_fast_api.utils.Fast_API_Server                       import Fast_API_Server
-
-import concurrent.futures
-import time
-import json
-
-from osbot_fast_api.utils.Version import version__osbot_fast_api
+from osbot_fast_api.utils.Version                               import version__osbot_fast_api
 
 
 class test_Admin_UI__Fast_API__multiple_workflows(TestCase):         # Full integration tests for Admin UI
@@ -240,7 +237,7 @@ def set_cookie(name):
                 assert throughput > 100  # At least 100 req/s
             else:
                 assert duration   < 0.3  # 100 requests in under 0.3 seconds (locally)
-                assert throughput > 500  # At least 500 req/s                (locally)
+                assert throughput > 400  # At least 500 req/s                (locally)
 
     def test_05_error_handling(self):
         """Test error handling in Admin UI"""