Add support for writing and parsing Snippet information.

Signed-off-by: Xavier Figueroa <[email protected]>

Author: xavierfigueroav

spdx/parsers/jsonyaml.py

@@ -389,6 +389,147 @@ def parse_annotation_id(self, annotation_id):
         else:
             self.value_error('ANNOTATION_ID', annotation_id)
 
+class SnippetParser(BaseParser):
+    def __init__(self, builder, logger):
+        super(SnippetParser, self).__init__(builder, logger)
+    
+    def parse_snippets(self, snippets):
+        """
+        Responsible for parsing Snippet Information fields
+        - snippets: Python list with Snippet Information dicts in it
+        """
+        if isinstance(snippets, list):
+            for snippet in snippets:
+                if isinstance(snippet, dict):
+                    if self.parse_snippet_id(snippet.get('id')):
+                        self.parse_snippet_name(snippet.get('name'))
+                        self.parse_snippet_comment(snippet.get('comment'))
+                        self.parse_snippet_copyright(snippet.get('copyrightText'))
+                        self.parse_snippet_license_comment(snippet.get('licenseComments'))
+                        self.parse_snippet_file_spdxid(snippet.get('fileId'))
+                        self.parse_snippet_concluded_license(snippet.get('licenseConcluded'))
+                        self.parse_snippet_license_info_from_snippet(snippet.get('licenseInfoFromSnippet'))
+                else:
+                    self.value_error('SNIPPET', snippet)
+    
+    def parse_snippet_id(self, snippet_id):
+        """
+        Responsible for parsing Snippet id
+        - snippet_id: Python str/unicode
+        """
+        if isinstance(snippet_id, six.string_types):
+            try:
+                return self.builder.create_snippet(self.document, snippet_id)
+            except SPDXValueError:
+                self.value_error('SNIPPET_SPDX_ID_VALUE', snippet_id)
+        else:
+            self.value_error('SNIPPET_SPDX_ID_VALUE', snippet_id)
+
+    def parse_snippet_name(self, snippet_name):
+        """
+        Responsible for parsing Snippet name
+        - snippet_name: Python str/unicode
+        """
+        if isinstance(snippet_name, six.string_types):
+            try:
+                return self.builder.set_snippet_name(self.document, snippet_name)
+            except CardinalityError:
+                self.more_than_one_error('SNIPPET_NAME')
+        elif snippet_name is not None:
+            self.value_error('SNIPPET_NAME', snippet_name)
+
+    def parse_snippet_comment(self, snippet_comment):
+        """
+        Responsible for parsing Snippet comment
+        - snippet_comment: Python str/unicode
+        """
+        if isinstance(snippet_comment, six.string_types):
+            try:
+                return self.builder.set_snippet_comment(self.document, snippet_comment)
+            except CardinalityError:
+                self.more_than_one_error('SNIPPET_COMMENT')
+        elif snippet_comment is not None:
+            self.value_error('SNIPPET_COMMENT', snippet_comment)
+
+    def parse_snippet_copyright(self, copyright_text):
+        """
+        Responsible for parsing Snippet copyright text
+        - copyright_text: Python str/unicode
+        """
+        if isinstance(copyright_text, six.string_types):
+            try:
+                return self.builder.set_snippet_copyright(self.document, copyright_text)
+            except CardinalityError:
+                self.more_than_one_error('SNIPPET_COPYRIGHT')
+        else:
+            self.value_error('SNIPPET_COPYRIGHT', copyright_text)
+
+    def parse_snippet_license_comment(self, license_comment):
+        """
+        Responsible for parsing Snippet license comment
+        - license_comment: Python str/unicode
+        """
+        if isinstance(license_comment, six.string_types):
+            try:
+                return self.builder.set_snippet_lic_comment(self.document, license_comment)
+            except CardinalityError:
+                self.more_than_one_error('SNIPPET_LIC_COMMENTS')
+        elif license_comment is not None:
+            self.value_error('SNIPPET_LIC_COMMENTS', license_comment)
+
+    def parse_snippet_file_spdxid(self, file_spdxid):
+        """
+        Responsible for parsing Snippet file id
+        - file_spdxid: Python str/unicode
+        """
+        if isinstance(file_spdxid, six.string_types):
+            try:
+                return self.builder.set_snip_from_file_spdxid(self.document, file_spdxid)
+            except SPDXValueError:
+                self.value_error('SNIPPET_FILE_ID', file_spdxid)
+            except CardinalityError:
+                self.more_than_one_error('SNIPPET_FILE_ID')
+        else:
+            self.value_error('SNIPPET_FILE_ID', file_spdxid)
+
+    def parse_snippet_concluded_license(self, concluded_license):
+        """
+        Responsible for parsing Snippet concluded license
+        - concluded_license: Python str/unicode
+        """
+        if isinstance(concluded_license, six.string_types):
+            lic_parser = utils.LicenseListParser()
+            lic_parser.build(write_tables=0, debug=0)
+            license_object = self.replace_license(lic_parser.parse(concluded_license))
+            try:
+                return self.builder.set_snip_concluded_license(self.document, license_object)
+            except SPDXValueError:
+                self.value_error('SNIPPET_SINGLE_LICS', concluded_license)
+            except CardinalityError:
+                self.more_than_one_error('SNIPPET_SINGLE_LICS')
+        else:
+            self.value_error('SNIPPET_SINGLE_LICS', concluded_license)
+
+    def parse_snippet_license_info_from_snippet(self, license_info_from_snippet):
+        """
+        Responsible for parsing Snippet license information from snippet
+        - license_info_from_snippet: Python list of licenses information from snippet (str/unicode)
+        """
+        if isinstance(license_info_from_snippet, list):
+            for lic_in_snippet in license_info_from_snippet:
+                if isinstance(lic_in_snippet, six.string_types):
+                    lic_parser = utils.LicenseListParser()
+                    lic_parser.build(write_tables=0, debug=0)
+                    license_object = self.replace_license(lic_parser.parse(lic_in_snippet))
+                    try:
+                        return self.builder.set_snippet_lics_info(self.document, license_object)
+                    except SPDXValueError:
+                        self.value_error('SNIPPET_LIC_INFO', lic_in_snippet)
+                else:
+                    self.value_error('SNIPPET_LIC_INFO', lic_in_snippet)
+        else:
+            self.value_error('SNIPPET_LIC_INFO_FIELD', license_info_from_snippet)
+
 class ReviewParser(BaseParser):
     def __init__(self, builder, logger):
         super(ReviewParser, self).__init__(builder, logger)

spdx/writers/jsonyaml.py

@@ -307,6 +307,37 @@ def set_all_annotations_as_document_annotations(self):
         if annotation_objects:
             self.document_object['annotations'] = annotation_objects
 
+class SnippetWriter(BaseWriter):
+    """
+    Responsible for representing spdx.annotation as json-serializable objects
+    """
+    def __init__(self, document):
+        super(SnippetWriter, self).__init__(document)
+    
+    def create_snippet_info(self):
+        snippet_info_objects = []
+        snippets = self.document.snippet
+
+        for snippet in snippets:
+            snippet_object = dict()
+            snippet_object['id'] = self.spdx_id(snippet.spdx_id)
+            snippet_object['copyrightText'] = snippet.copyright
+            snippet_object['fileId'] = self.spdx_id(snippet.snip_from_file_spdxid)
+            snippet_object['licenseConcluded'] = self.license(snippet.conc_lics)
+            snippet_object['licenseInfoFromSnippet'] = list(map(self.license, snippet.licenses_in_snippet))
+
+            if snippet.has_optional_field('name'):
+                snippet_object['name'] = snippet.name
+                
+            if snippet.has_optional_field('comment'):
+                snippet_object['comment'] = snippet.comment
+
+            if snippet.has_optional_field('license_comment'):
+                snippet_object['licenseComments'] = snippet.license_comment
+            
+            snippet_info_objects.append(snippet_object)
+
+        return snippet_info_objects
 
 class ExtractedLicenseWriter(BaseWriter):
     """
@@ -360,7 +391,7 @@ def create_extracted_license(self):
         return extracted_license_objects
 
 class Writer(CreationInfoWriter, ReviewInfoWriter, FileWriter, PackageWriter, 
-    AnnotationInfoWriter, ExtractedLicenseWriter):
+    AnnotationInfoWriter, SnippetWriter, ExtractedLicenseWriter):
     """
     Wrapper for the other writers.
     Responsible for representing a whole SPDX Document as json-serializable objects to then
@@ -413,6 +444,9 @@ def create_document(self):
 
         if self.document.reviews:
             self.document_object['reviewers'] = self.create_review_info()
+        
+        if self.document.snippet:
+            self.document_object['snippets'] = self.create_snippet_info()
 
         self.set_all_annotations_as_document_annotations()