Improve handling of potentially invalid openapi versions

Author: Danthewaann

src/apifairy/core.py

@@ -19,6 +19,7 @@
 except ImportError:  # pragma: no cover
     HTTPBasicAuth = None
     HTTPTokenAuth = None
+from packaging.version import Version
 from werkzeug.http import HTTP_STATUS_CODES
 
 from apifairy.decorators import _webhooks
@@ -46,7 +47,8 @@ def init_app(self, app):
         self.version = app.config.get('APIFAIRY_VERSION', 'No version')
         self.apispec_path = app.config.get('APIFAIRY_APISPEC_PATH',
                                            '/apispec.json')
-        self.apispec_version = app.config.get('APIFAIRY_APISPEC_VERSION', None)
+        self.apispec_version = app.config.get('APIFAIRY_APISPEC_VERSION',
+                                              '3.0.3')
         self.apispec_decorators = app.config.get(
             'APIFAIRY_APISPEC_DECORATORS', [])
         self.ui = app.config.get('APIFAIRY_UI', 'redoc')
@@ -148,11 +150,13 @@ def resolver(schema):
             tags[name] = tag
         tag_list = [tags[name] for name in tag_names]
         ma_plugin = MarshmallowPlugin(schema_name_resolver=resolver)
-        oas_version = '3.1.0' if _webhooks else self.apispec_version or '3.0.3'
+        if Version(self.apispec_version) < Version('3.1.0') and _webhooks:
+            raise RuntimeError("Must use at least openapi version '3.1.0' "
+                               'when using the @webhook decorator')
         spec = APISpec(
             title=self.title,
             version=self.version,
-            openapi_version=oas_version,
+            openapi_version=self.apispec_version,
             plugins=[ma_plugin],
             info=info,
             servers=servers,

tests/test_apifairy.py

@@ -151,7 +151,7 @@ def test_custom_apispec_version(self):
         assert rv.json['openapi'] == '3.1.0'
 
     def test_custom_apispec_no_version(self):
-        app, _ = self.create_app(config={'APIFAIRY_APISPEC_VERSION': None})
+        app, _ = self.create_app()
 
         client = app.test_client()
         rv = client.get('/apispec.json')
@@ -160,6 +160,22 @@ def test_custom_apispec_no_version(self):
             'openapi', 'info', 'servers', 'paths', 'tags'}
         assert rv.json['openapi'] == '3.0.3'
 
+    def test_custom_apispec_invalid_version(self):
+        app, _ = self.create_app(
+                config={'APIFAIRY_APISPEC_VERSION': '4.0.0'})
+
+        client = app.test_client()
+        rv = client.get('/apispec.json')
+        assert rv.status_code == 500
+
+    def test_custom_apispec_non_semver_version(self):
+        app, _ = self.create_app(
+                config={'APIFAIRY_APISPEC_VERSION': 'invalid'})
+
+        client = app.test_client()
+        rv = client.get('/apispec.json')
+        assert rv.status_code == 500
+
     def test_ui(self):
         app, _ = self.create_app(config={'APIFAIRY_UI': 'swagger_ui'})
 
@@ -1014,7 +1030,8 @@ async def foo(query, body):
         assert rv.json == {'id': 2, 'name': 'foo'}
 
     def test_webhook(self):
-        app, apifairy = self.create_app()
+        app, apifairy = self.create_app(
+                config={'APIFAIRY_APISPEC_VERSION': '3.1.0'})
         bp = Blueprint('bp', __name__)
 
         @webhook
@@ -1060,6 +1077,19 @@ def blueprint_webhook():
         assert 'blueprint_webhook' in rv.json['webhooks']
         assert 'get' in rv.json['webhooks']['blueprint_webhook']
 
+    def test_webhook_invalid_apispec_version(self):
+        app, apifairy = self.create_app(
+                config={'APIFAIRY_APISPEC_VERSION': '3.0.3'})
+
+        @webhook
+        @body(Schema)
+        def unsupported_webhook():
+            pass
+
+        client = app.test_client()
+        rv = client.get('/apispec.json')
+        assert rv.status_code == 500
+
     def test_webhook_duplicate(self):
         app, apifairy = self.create_app()