Modify DependentPackage Atrributes

Rename "requirement" to "extracted_requirement" and add new attribute
"resolved_package".

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>

src/packagedcode/alpine.py

@@ -891,7 +891,7 @@ def D_dependencies_handler(value, dependencies=None, **kwargs):
         dependency = models.DependentPackage(
             purl=purl,
             scope=scope,
-            requirement=requirement,
+            extracted_requirement=requirement,
             is_resolved=is_resolved,
         )
         if dependency not in dependencies:

src/packagedcode/bower.py

@@ -114,7 +114,7 @@ def recognize(cls, location):
                 models.DependentPackage(
                     purl=PackageURL(type='bower', name=dep_name).to_string(),
                     scope='dependencies',
-                    requirement=requirement,
+                    extracted_requirement=requirement,
                     is_runtime=True,
                     is_optional=False,
                 )
@@ -126,7 +126,7 @@ def recognize(cls, location):
                 models.DependentPackage(
                     purl=PackageURL(type='bower', name=dep_name).to_string(),
                     scope='devDependencies',
-                    requirement=requirement,
+                    extracted_requirement=requirement,
                     is_runtime=False,
                     is_optional=True,
                 )

src/packagedcode/build_gradle.py

@@ -278,7 +278,7 @@ def build_package(cls, dependencies):
                     version=version
                 ).to_string(),
                 scope=scope,
-                requirement=version,
+                extracted_requirement=version,
                 is_runtime=is_runtime,
                 is_optional=is_optional,
             )

src/packagedcode/cargo.py

@@ -134,7 +134,7 @@ def recognize(cls, location):
                         name=dep.get('name'),
                         version=dep.get('version')
                     ).to_string(),
-                    requirement=dep.get('version'),
+                    extracted_requirement=dep.get('version'),
                     scope='dependency',
                     is_runtime=True,
                     is_optional=False,

src/packagedcode/chef.py

@@ -267,7 +267,7 @@ def build_package(cls, package_data):
             models.DependentPackage(
                 purl=PackageURL(type='chef', name=dependency_name).to_string(),
                 scope='dependencies',
-                requirement=requirement,
+                extracted_requirement=requirement,
                 is_runtime=True,
                 is_optional=False,
             )

src/packagedcode/cocoapods.py

@@ -217,7 +217,7 @@ def recognize(cls, location):
                         models.DependentPackage(
                             purl=purl,
                             scope='requires-dev',
-                            requirement=version,
+                            extracted_requirement=version,
                             is_runtime=False,
                             is_optional=True,
                             is_resolved=True,
@@ -237,7 +237,7 @@ def recognize(cls, location):
                     models.DependentPackage(
                         purl=purl,
                         scope='requires-dev',
-                        requirement=version,
+                        extracted_requirement=version,
                         is_runtime=False,
                         is_optional=True,
                         is_resolved=True,

src/packagedcode/conda.py

@@ -157,7 +157,7 @@ def recognize(cls, location):
                             models.DependentPackage(
                                 purl=PackageURL(
                                     type='conda', name=dependency).to_string(),
-                                requirement=requirement,
+                                extracted_requirement=requirement,
                                 scope='dependencies',
                                 is_runtime=True,
                                 is_optional=False,

src/packagedcode/cran.py

@@ -113,7 +113,7 @@ def recognize(cls, location):
                         models.DependentPackage(
                             purl=PackageURL(
                                 type='cran', name=dependency).to_string(),
-                            requirement=requirement,
+                            extracted_requirement=requirement,
                             scope='dependencies',
                             is_runtime=True,
                             is_optional=False,

src/packagedcode/golang.py

@@ -79,7 +79,7 @@ def recognize(cls, location):
             package_dependencies.append(
                 models.DependentPackage(
                     purl=gomod.purl(include_version=True),
-                    requirement=gomod.version,
+                    extracted_requirement=gomod.version,
                     scope='require',
                     is_runtime=True,
                     is_optional=False,
@@ -92,7 +92,7 @@ def recognize(cls, location):
             package_dependencies.append(
                 models.DependentPackage(
                     purl=gomod.purl(include_version=True),
-                    requirement=gomod.version,
+                    extracted_requirement=gomod.version,
                     scope='exclude',
                     is_runtime=True,
                     is_optional=False,
@@ -141,7 +141,7 @@ def recognize(cls, location):
             package_dependencies.append(
                 models.DependentPackage(
                     purl=gosum.purl(),
-                    requirement=gosum.version,
+                    extracted_requirement=gosum.version,
                     scope='dependency',
                     is_runtime=True,
                     is_optional=False,

src/packagedcode/maven.py

@@ -936,7 +936,7 @@ def get_dependencies(pom):
 
             dep_pack = models.DependentPackage(
                 purl=str(dpurl),
-                requirement=dversion,
+                extracted_requirement=dversion,
                 scope=scope,
                 is_runtime=is_runtime,
                 is_optional=is_optional,

src/packagedcode/models.py

@@ -361,13 +361,13 @@ class DependentPackage(BaseModel):
              'If the dependency is resolved, the version should be added to '
              'the purl')
 
-    # ToDo: rename to `extracted_requirement`  * as found in the package manifest *
-    requirement = String(
+    extracted_requirement = String(
         repr=True,
         label='dependent package version requirement',
-        help='A string defining version(s)requirements. Package-type specific.')
+        help='A string defining version(s)requirements. Package-type specific '
+             'and as found in the lockfile/package-data.')
 
-    # ToDo: add `vers` See https://github.com/nexB/univers/blob/main/src/univers/version_range.py
+    # ToDo: add `vers` support. See https://github.com/nexB/univers/blob/main/src/univers/version_range.py
 
     scope = String(
         repr=True,
@@ -392,7 +392,10 @@ class DependentPackage(BaseModel):
              'been resolved and this dependency url points to an '
              'exact version.')
 
-    #ToDo: add `resolved_package` -> (PackageData)
+    resolved_package = Mapping(
+        label='resolved package data',
+        help='A mapping containing the package data for this DependentPackage, '
+             'resolved from the lockfile itself or by fetching from other sources.')
 
 
 @attr.s
@@ -1011,7 +1014,7 @@ def update(self, package_data, replace=False):
                     for dependency in dependencies:
                         dep_new = DependentPackage(
                             purl=dependency['purl'],
-                            requirement=dependency['requirement'],
+                            extracted_requirement=dependency['requirement'],
                             scope=dependency['scope'],
                             is_runtime=dependency['is_runtime'],
                             is_optional=dependency['is_optional'],

src/packagedcode/npm.py

@@ -229,7 +229,7 @@ def recognize(cls, location):
                         models.DependentPackage(
                             purl=purl,
                             scope='requires-dev',
-                            requirement=dep_req,
+                            extracted_requirement=dep_req,
                             is_runtime=False,
                             is_optional=True,
                             is_resolved=True,
@@ -240,7 +240,7 @@ def recognize(cls, location):
                         models.DependentPackage(
                             purl=purl,
                             scope='requires',
-                            requirement=dep_req,
+                            extracted_requirement=dep_req,
                             is_runtime=True,
                             is_optional=False,
                             is_resolved=True,
@@ -264,7 +264,7 @@ def recognize(cls, location):
                             version=dep_version,
                         ).to_string(),
                         scope='dependencies',
-                        requirement=requirement,
+                        extracted_requirement=requirement,
                         is_runtime=True,
                         is_optional=False,
                         is_resolved=True,
@@ -396,7 +396,7 @@ def recognize(cls, location):
                                 models.DependentPackage(
                                     purl=PackageURL(type='npm', name=dep).to_string(),
                                     scope='dependencies',
-                                    requirement=req,
+                                    extracted_requirement=req,
                                     is_runtime=True,
                                     is_optional=False,
                                     is_resolved=True,
@@ -421,7 +421,7 @@ def recognize(cls, location):
                         models.DependentPackage(
                             purl=PackageURL(type='npm', name=dep).to_string(),
                             scope='dependencies',
-                            requirement=req,
+                            extracted_requirement=req,
                             is_runtime=True,
                             is_optional=False,
                             is_resolved=True,
@@ -447,7 +447,7 @@ def recognize(cls, location):
                             name=package.name,
                             version=package.version
                         ).to_string(),
-                        requirement=requirement,
+                        extracted_requirement=requirement,
                         scope='dependencies',
                         is_runtime=True,
                         is_optional=False,
@@ -924,7 +924,7 @@ def deps_mapper(deps, package, field_name):
             dep = models.DependentPackage(
                 purl=purl,
                 scope=field_name,
-                requirement=requirement,
+                extracted_requirement=requirement,
                 **dependency_attributes
             )
             dependencies.append(dep)

src/packagedcode/opam.py

@@ -81,7 +81,7 @@ def recognize(cls, location):
             package_dependencies.append(
                 models.DependentPackage(
                     purl=dep.purl,
-                    requirement=dep.version,
+                    extracted_requirement=dep.version,
                     scope='dependency',
                     is_runtime=True,
                     is_optional=False,

src/packagedcode/phpcomposer.py

@@ -372,7 +372,7 @@ def _deps_mapper(deps, package, scope, is_runtime=False, is_optional=False):
         purl = models.PackageURL(type='composer', namespace=ns, name=name).to_string()
         dep = models.DependentPackage(
             purl=purl,
-            requirement=requirement,
+            extracted_requirement=requirement,
             scope=scope,
             is_runtime=is_runtime,
             is_optional=is_optional)

src/packagedcode/plugin_package.py

@@ -268,13 +268,14 @@ def create_dependency_instances(path, dependencies):
         dependency_instances.append(
             Dependency(
                 dependency_uuid=purl.to_string(),
+                lockfile=path,
                 purl=dependency['purl'],
-                requirement=dependency['requirement'],
+                extracted_requirement=dependency['extracted_requirement'],
                 scope=dependency['scope'],
                 is_runtime=dependency['is_runtime'],
                 is_optional=dependency['is_optional'],
                 is_resolved=dependency['is_resolved'],
-                lockfile=path,
+                resolved_package=dependency['resolved_package']
             )
         )
 

src/packagedcode/pubspec.py

@@ -311,7 +311,7 @@ def build_dep(name, version, scope, is_runtime=True, is_optional=False):
 
     dep = models.DependentPackage(
         purl=purl.to_string(),
-        requirement=version,
+        extracted_requirement=version,
         scope=scope,
         is_runtime=is_runtime,
         is_optional=is_optional,

src/packagedcode/pypi.py

@@ -421,7 +421,7 @@ def get_requirements_txt_dependencies(location):
                 is_runtime=is_runtime,
                 is_optional=is_optional,
                 is_resolved=req.is_pinned or False,
-                requirement=requirement
+                extracted_requirement=requirement
             )
         )
 
@@ -734,7 +734,7 @@ def get_requires_dependencies(requires, default_scope='install'):
                 is_runtime=True,
                 is_optional=False,
                 is_resolved=is_resolved,
-                requirement=requirement,
+                extracted_requirement=requirement,
         ))
 
     return dependent_packages
@@ -878,7 +878,7 @@ def parse_with_dparse2(location, file_name=None):
                 is_runtime=True,
                 is_optional=False,
                 is_resolved=is_resolved,
-                requirement=requirement
+                extracted_requirement=requirement
             )
         )
 

src/packagedcode/rubygems.py

@@ -207,7 +207,7 @@ def recognize(cls, location):
                         type='gem',
                         name=name
                     ).to_string(),
-                    requirement=', '.join(version),
+                    extracted_requirement=', '.join(version),
                     scope='dependencies',
                     is_runtime=True,
                     is_optional=False,
@@ -269,7 +269,7 @@ def recognize(cls, location):
                         name=gem.name,
                         version=gem.version
                     ).to_string(),
-                    requirement=', '.join(gem.requirements),
+                    extracted_requirement=', '.join(gem.requirements),
                     scope='dependencies',
                     is_runtime=True,
                     is_optional=False,
@@ -289,7 +289,7 @@ def recognize(cls, location):
                             name=dep.name,
                             version=dep.version
                         ).to_string(),
-                        requirement=', '.join(dep.requirements),
+                        extracted_requirement=', '.join(dep.requirements),
                         scope='dependencies',
                         is_runtime=True,
                         is_optional=False,
@@ -663,7 +663,7 @@ def get_dependencies(dependencies):
 
         dep = models.DependentPackage(
             purl=RubyGemData.create(name=name).purl,
-            requirement=version_constraint or None,
+            extracted_requirement=version_constraint or None,
             scope=scope,
             is_runtime=is_runtime,
             is_optional=is_optional,

tests/licensedcode/data/plugin_license/package/package.expected.json

@@ -9,7 +9,7 @@
         "--package": true
       },
       "notice": "Generated with ScanCode and provided on an \"AS IS\" BASIS, WITHOUT WARRANTIES\nOR CONDITIONS OF ANY KIND, either express or implied. No content created from\nScanCode should be considered or used as legal advice. Consult an Attorney\nfor any legal advice.\nScanCode is a free software code scanning tool from nexB Inc. and others.\nVisit https://github.com/nexB/scancode-toolkit/ for support and download.",
-      "output_format_version": "2.0.0",
+      "output_format_version": "3.0.0",
       "message": null,
       "errors": [],
       "extra_data": {
@@ -21,22 +21,24 @@
   "dependencies": [
     {
       "purl": "pkg:npm/dicer",
-      "requirement": "0.2.5",
+      "extracted_requirement": "0.2.5",
       "scope": "dependencies",
       "is_runtime": true,
       "is_optional": false,
       "is_resolved": false,
+      "resolved_package": {},
       "dependency_uuid": "pkg:npm/dicer",
       "for_package": "pkg:npm/[email protected]",
       "lockfile": "package.json"
     },
     {
       "purl": "pkg:npm/readable-stream",
-      "requirement": "1.1.x",
+      "extracted_requirement": "1.1.x",
       "scope": "dependencies",
       "is_runtime": true,
       "is_optional": false,
       "is_resolved": false,
+      "resolved_package": {},
       "dependency_uuid": "pkg:npm/readable-stream",
       "for_package": "pkg:npm/[email protected]",
       "lockfile": "package.json"
@@ -202,19 +204,21 @@
           "dependencies": [
             {
               "purl": "pkg:npm/dicer",
-              "requirement": "0.2.5",
+              "extracted_requirement": "0.2.5",
               "scope": "dependencies",
               "is_runtime": true,
               "is_optional": false,
-              "is_resolved": false
+              "is_resolved": false,
+              "resolved_package": {}
             },
             {
               "purl": "pkg:npm/readable-stream",
-              "requirement": "1.1.x",
+              "extracted_requirement": "1.1.x",
               "scope": "dependencies",
               "is_runtime": true,
               "is_optional": false,
-              "is_resolved": false
+              "is_resolved": false,
+              "resolved_package": {}
             }
           ],
           "purl": "pkg:npm/[email protected]",