Adds PackageManifest class for maven

Creates PackageManifest class for maven pom.xml  manifests
and overrides the methods for detection and PackageManifest creation.

See #2748

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

Author: AyanSinhaMahapatra

src/packagedcode/__init__.py

@@ -47,7 +47,7 @@
     jar_manifest.JavaManifest,
     models.JavaEar,
     models.JavaWar,
-    maven.MavenPomPackage,
+    maven.PomXml,
     jar_manifest.IvyJar,
     models.JBossSar,
     models.Axis2Mar,

src/packagedcode/maven.py

@@ -47,20 +47,14 @@
 
 
 @attr.s()
-class MavenPomPackage(models.Package, models.PackageManifest):
-    file_patterns = ('*.pom', 'pom.xml',)
-    extensions = ('.pom',)
+class MavenPomPackage(models.Package):
     default_type = 'maven'
     default_primary_language = 'Java'
 
     default_web_baseurl = 'https://repo1.maven.org/maven2'
     default_download_baseurl = 'https://repo1.maven.org/maven2'
     default_api_baseurl = 'https://repo1.maven.org/maven2'
 
-    @classmethod
-    def recognize(cls, location):
-        yield parse(location)
-
     @classmethod
     def get_package_root(cls, manifest_resource, codebase):
         if manifest_resource.name.endswith(('pom.xml', '.pom',)):
@@ -822,36 +816,6 @@ def substring(s, start, end):
     return s[start:end]
 
 
-def is_pom(location):
-    """
-    Return True if the file at location is highly likely to be a POM.
-    """
-    if (not filetype.is_file(location)
-     or not location.endswith(('.pom', 'pom.xml', 'project.xml',))):
-
-        if TRACE: logger.debug('is_pom: not a POM on name: {}'.format(location))
-        return
-
-    T = contenttype.get_type(location)
-    if T.is_text:
-
-        # check the POM version in the first 150 lines
-        with open(location, 'rb') as pom:
-            for n, line in enumerate(pom):
-                if n > 150:
-                    break
-                if any(x in line for x in
-                       (b'http://maven.apache.org/POM/4.0.0',
-                        b'http://maven.apache.org/xsd/maven-4.0.0.xsd',
-                        b'<modelVersion>',
-                        # somehow we can still parse version 3 poms too
-                        b'<pomVersion>',)
-                       ):
-                    return True
-
-    if TRACE: logger.debug('is_pom: not a POM based on type: {}: {}'.format(T, location))
-
-
 def has_basic_pom_attributes(pom):
     """
     Return True if a POM object has basic attributes needed to make this
@@ -870,7 +834,7 @@ def get_maven_pom(location=None, text=None, check_is_pom=False, extra_properties
     Return a MavenPom object from a POM file at `location` or provided as a
     `text` string.
     """
-    if location and check_is_pom and not is_pom(location):
+    if location and check_is_pom and not PomXml.is_manifest(location):
         return
     pom = MavenPom(location, text)
     if not extra_properties:
@@ -1016,85 +980,122 @@ def get_parties(pom):
     return parties
 
 
-def parse(location=None, text=None, check_is_pom=True, extra_properties=None):
-    """
-    Return a MavenPomPackage or None.
-    Parse a pom file at `location` or using the provided `text` (one or
-    the other but not both).
-    Check if the location is a POM if `check_is_pom` is True.
-    When resolving the POM, use an optional `extra_properties` mapping
-    of name/value pairs to resolve properties.
-    """
-    pom = get_maven_pom(location, text, check_is_pom, extra_properties)
-    if not pom:
-        return
+@attr.s()
+class PomXml(MavenPomPackage, models.PackageManifest):
+
+    file_patterns = ('*.pom', 'pom.xml',)
+    extensions = ('.pom',)
+
+    @classmethod
+    def is_manifest(cls, location):
+        """
+        Return True if the file at location is highly likely to be a POM.
+        """
+        if (not filetype.is_file(location)
+        or not location.endswith(('.pom', 'pom.xml', 'project.xml',))):
 
-    if TRACE:
-        logger.debug('parse: pom:.to_dict()\n{}'.format(pformat(pom.to_dict())))
+            if TRACE: logger.debug('is_pom: not a POM on name: {}'.format(location))
+            return
 
-    version = pom.version
-    # pymaven whart
-    if version == 'latest.release':
-        version = None
+        T = contenttype.get_type(location)
+        if T.is_text:
+
+            # check the POM version in the first 150 lines
+            with open(location, 'rb') as pom:
+                for n, line in enumerate(pom):
+                    if n > 150:
+                        break
+                    if any(x in line for x in
+                        (b'http://maven.apache.org/POM/4.0.0',
+                            b'http://maven.apache.org/xsd/maven-4.0.0.xsd',
+                            b'<modelVersion>',
+                            # somehow we can still parse version 3 poms too
+                            b'<pomVersion>',)
+                        ):
+                        return True
+
+        if TRACE: logger.debug('is_pom: not a POM based on type: {}: {}'.format(T, location))
 
-    qualifiers = {}
-    classifier = pom.classifier
-    if classifier:
-        qualifiers['classifier'] = classifier
-
-    packaging = pom.packaging
-    if packaging:
-        extension = get_extension(packaging)
-        if extension and extension not in ('jar', 'pom'):
-            # we use type as in the PURL spec: this is a problematic field with
-            # complex defeinition in Maven
-            qualifiers['type'] = extension
-
-    declared_license = pom.licenses
-
-    source_packages = []
-    # TODO: what does this mean????
-    if not classifier and all([pom.group_id, pom.artifact_id, version]):
-        spurl = PackageURL(
-            type=MavenPomPackage.default_type,
+    @classmethod
+    def recognize(cls, location, text=None, check_is_pom=True, extra_properties=None):
+        """
+        Yield one or more PomXml objects or None.
+
+        Parse a pom file at `location` or using the provided `text` (one or
+        the other but not both).
+        Check if the location is a POM if `check_is_pom` is True.
+        When resolving the POM, use an optional `extra_properties` mapping
+        of name/value pairs to resolve properties.
+        """
+        pom = get_maven_pom(location, text, check_is_pom, extra_properties)
+        if not pom:
+            return
+
+        if TRACE:
+            logger.debug('parse: pom:.to_dict()\n{}'.format(pformat(pom.to_dict())))
+
+        version = pom.version
+        # pymaven whart
+        if version == 'latest.release':
+            version = None
+
+        qualifiers = {}
+        classifier = pom.classifier
+        if classifier:
+            qualifiers['classifier'] = classifier
+
+        packaging = pom.packaging
+        if packaging:
+            extension = get_extension(packaging)
+            if extension and extension not in ('jar', 'pom'):
+                # we use type as in the PURL spec: this is a problematic field with
+                # complex defeinition in Maven
+                qualifiers['type'] = extension
+
+        declared_license = pom.licenses
+
+        source_packages = []
+        # TODO: what does this mean????
+        if not classifier and all([pom.group_id, pom.artifact_id, version]):
+            spurl = PackageURL(
+                type=MavenPomPackage.default_type,
+                namespace=pom.group_id,
+                name=pom.artifact_id,
+                version=version,
+                # we hardcode the source qualifier for now...
+                qualifiers=dict(classifier='sources'))
+            source_packages = [spurl.to_string()]
+
+        pname = pom.name or ''
+        pdesc = pom.description or ''
+        if pname == pdesc:
+            description = pname
+        else:
+            description = [d for d in (pname, pdesc) if d]
+            description = '\n'.join(description)
+
+        issue_mngt = pom.issue_management or {}
+        bug_tracking_url = issue_mngt.get('url')
+
+        scm = pom.scm or {}
+        vcs_url, code_view_url = build_vcs_and_code_view_urls(scm)
+
+        # FIXME: there are still other data to map in a Package
+        yield cls(
             namespace=pom.group_id,
             name=pom.artifact_id,
             version=version,
-            # we hardcode the source qualifier for now...
-            qualifiers=dict(classifier='sources'))
-        source_packages = [spurl.to_string()]
-
-    pname = pom.name or ''
-    pdesc = pom.description or ''
-    if pname == pdesc:
-        description = pname
-    else:
-        description = [d for d in (pname, pdesc) if d]
-        description = '\n'.join(description)
-
-    issue_mngt = pom.issue_management or {}
-    bug_tracking_url = issue_mngt.get('url')
-
-    scm = pom.scm or {}
-    vcs_url, code_view_url = build_vcs_and_code_view_urls(scm)
-
-    # FIXME: there are still other data to map in a Package
-    package = MavenPomPackage(
-        namespace=pom.group_id,
-        name=pom.artifact_id,
-        version=version,
-        qualifiers=qualifiers or None,
-        description=description or None,
-        homepage_url=pom.url or None,
-        declared_license=declared_license or None,
-        parties=get_parties(pom),
-        dependencies=get_dependencies(pom),
-        source_packages=source_packages,
-        bug_tracking_url=bug_tracking_url,
-        vcs_url=vcs_url,
-        code_view_url=code_view_url,
-    )
-    return package
+            qualifiers=qualifiers or None,
+            description=description or None,
+            homepage_url=pom.url or None,
+            declared_license=declared_license or None,
+            parties=get_parties(pom),
+            dependencies=get_dependencies(pom),
+            source_packages=source_packages,
+            bug_tracking_url=bug_tracking_url,
+            vcs_url=vcs_url,
+            code_view_url=code_view_url,
+        )
 
 
 def build_vcs_and_code_view_urls(scm):
@@ -1175,7 +1176,7 @@ def recon(self, location):
             if not filetype.is_file(loc):
                 continue
             # a pom is an xml doc
-            if not is_pom(location):
+            if not PomXml.is_manifest(location):
                 continue
 
             if f == 'pom.xml':

tests/packagedcode/data/plugin/help.txt

@@ -229,7 +229,7 @@ Package: jboss
 
 --------------------------------------------
 Package: maven
-  class: packagedcode.maven:MavenPomPackage
+  class: packagedcode.maven:PomXml
   file_patterns: *.pom, pom.xml
   extensions: .pom