Implement ApplicationMetadata class and add unit tests (#5)

* Implement ApplicationMetadata class and add unit tests

Author: paoptu023

serverlessrepo/application_metadata.py

@@ -1,3 +1,6 @@
+from .exceptions import InvalidApplicationMetadataError
+
+
 class ApplicationMetadata(object):
     """
     Class representing SAR metadata
@@ -36,10 +39,17 @@ def __init__(self, app_metadata):
     def __eq__(self, other):
         return isinstance(other, type(self)) and self.__dict__ == other.__dict__
 
-    def is_valid(self):
+    def validate(self, required_props):
         """
-        Checks if the required properties for application metadata have been populated
+        Checks if the required application metadata properties have been populated
 
+        :param required_props: List of required properties
+        :type required_props: list
         :return: True, if the metadata is valid
+        :raises: InvalidApplicationMetadataError
         """
+        missing_props = [p for p in required_props if not getattr(self, p)]
+        if missing_props:
+            missing_props_str = ', '.join(sorted(missing_props))
+            raise InvalidApplicationMetadataError(properties=missing_props_str)
         return True

tests/unit/test_application_metadata.py

@@ -0,0 +1,46 @@
+from unittest import TestCase
+
+from serverlessrepo.application_metadata import ApplicationMetadata
+from serverlessrepo.exceptions import InvalidApplicationMetadataError
+
+
+class TestApplicationMetadata(TestCase):
+
+    def test_init(self):
+        app_metadata_dict = {
+            'Name': 'name',
+            'Description': 'description',
+            'Author': 'author',
+            'SpdxLicenseId': '123456',
+            'LicenseUrl': 's3://bucket/license.txt',
+            'ReadmeUrl': 's3://bucket/README.md',
+            'Labels': ['label1', 'label2', 'label3'],
+            'HomepageUrl': 'https://github.com/my-id/my-repo/',
+            'SemanticVersion': '1.0.0',
+            'SourceCodeUrl': 's3://bucket/code.zip'
+        }
+        app_metadata = ApplicationMetadata(app_metadata_dict)
+        self.assertEqual(app_metadata.name, app_metadata_dict['Name'])
+        self.assertEqual(app_metadata.description, app_metadata_dict['Description'])
+        self.assertEqual(app_metadata.author, app_metadata_dict['Author'])
+        self.assertEqual(app_metadata.spdx_license_id, app_metadata_dict['SpdxLicenseId'])
+        self.assertEqual(app_metadata.license_url, app_metadata_dict['LicenseUrl'])
+        self.assertEqual(app_metadata.readme_url, app_metadata_dict['ReadmeUrl'])
+        self.assertEqual(app_metadata.labels, app_metadata_dict['Labels'])
+        self.assertEqual(app_metadata.home_page_url, app_metadata_dict['HomepageUrl'])
+        self.assertEqual(app_metadata.semantic_version, app_metadata_dict['SemanticVersion'])
+        self.assertEqual(app_metadata.source_code_url, app_metadata_dict['SourceCodeUrl'])
+
+    def test_invalid_app_metadata(self):
+        app_metadata_dict = { 'description': 'hello' }
+        app_metadata = ApplicationMetadata(app_metadata_dict)
+        required_props = ['author', 'name']
+        with self.assertRaises(InvalidApplicationMetadataError) as context:
+            app_metadata.validate(required_props)
+
+        message = str(context.exception)
+        self.assertTrue(', '.join(required_props) in message)
+
+    def test_valid_app_metadata(self):
+        app_metadata = ApplicationMetadata({})
+        self.assertTrue(app_metadata.validate([]))