Merge pull request #94 from atlassian-labs/fix-validator-io

Fix validator io

Author: jwong101

tests/examples/descriptor_io_base_url.json

@@ -0,0 +1,37 @@
+{
+    "key": "confluence-helloworld-addon",
+    "name": "Hello World",
+    "description": "My very first add-on",
+    "vendor": {
+      "name": "Angry Nerds",
+      "url": "https://www.atlassian.com/angrynerds"
+    },
+    "baseUrl": "https://foo.bar.io",
+    "links": {
+      "self": "https://atlassian.com/atlassian-connect.json",
+      "homepage": "https://atlassian.com/atlassian-connect.json"
+    },
+    "authentication": {
+      "type": "none"
+    },
+    "lifecycle": {
+      "installed": "/installed"
+    },
+    "scopes": ["READ"],
+    "modules": {
+      "dynamicContentMacros": [
+        {
+          "key": "helloworld-macro",
+          "name": {
+            "value": "<svg/onload=prompt(2)>"
+          },
+          "url": "/macro",
+          "description": {
+            "value": "Says 'Hello World'."
+          },
+          "outputType": "block",
+          "bodyType": "none"
+        }
+      ]
+    }
+  }

tests/test_app_validator.py

@@ -52,6 +52,7 @@ def test_missing_keys():
 
 def test_invalid_base_url():
     descriptor_file = 'tests/examples/descriptor_invalid_base_url.json'
+    # avoid calling constructor
     validator = object.__new__(AppValidator)
     validator.session = None
     validator.descriptor_url = 'https://example.com'
@@ -65,6 +66,15 @@ def test_invalid_base_url():
     assert wrapped_e.type == SystemExit
     assert wrapped_e.value.code == 1
 
+def test_invalid_base_url():
+    descriptor_file = 'tests/examples/descriptor_io_base_url.json'
+    validator = object.__new__(AppValidator)
+    validator.session = None
+    validator.descriptor_url = 'https://example.com'
+    validator.descriptor = json.loads(open(descriptor_file, 'r').read())
+    validator.timeout = 30
+
+    assert validator._validate_base_url()
 
 def test_invalid_remote_descriptor():
     # Test for exceptions on non-JSON responses and when a descriptor returns an error HTTP status code

utils/app_validator.py

@@ -28,7 +28,9 @@ def _get_and_request_descriptor(self) -> Optional[dict]:
         return descriptor
 
     def _validate_base_url(self) -> bool:
-        res = validators.url(self.descriptor['baseUrl'], rfc_1034=True)
+        url = self.descriptor['baseUrl']
+        # optional trailing dot not handled correctly for .io domains
+        res = validators.url(url, rfc_1034=True) or validators.url(url)
         if not res:
             logging.error(f"{self.descriptor['baseUrl']} was not a valid URL.")
         return bool(res)