diff --git a/AUTHORS.rst b/AUTHORS.rst index 9a8224dc7d..779a0d5677 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -87,6 +87,7 @@ The following organizations or individuals have contributed to ScanCode: - Shrijal Acharya @OctoPie23 - Shivam Chauhan @chashiv - Shivam Sandbhor @sbs2001 +- Shivani Patel @patelshivani2283-lab - Steven Esser @majurg - Sushant Gupta @susg - Theodore Aptekarev @piiq diff --git a/CHANGELOG.rst b/CHANGELOG.rst index abc3ae41ad..d14c47cc2e 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,9 @@ Changelog Next release -------------- +- Fix KeyError in NuGet .nuspec parsing when dependency groups omit targetFramework, + support project references in packages.lock.json, and extract expression license text. + - Fix the optional ``licenses`` extra dependency typo to install ``licensedcode-data``. https://github.com/aboutcode-org/scancode-toolkit/pull/5056 diff --git a/src/packagedcode/nuget.py b/src/packagedcode/nuget.py index d0d7e110f2..75cd3af046 100644 --- a/src/packagedcode/nuget.py +++ b/src/packagedcode/nuget.py @@ -39,7 +39,8 @@ def get_dependencies(nuspec): groups = [groups] for group in groups: - extra_data = dict(framework=group['@targetFramework']) + framework = group.get('@targetFramework') + extra_data = dict(framework=framework) if framework else {} deps = group.get('dependency') or [] yield from _get_dep_packs(deps, extra_data) else: @@ -159,7 +160,11 @@ def parse(cls, location, package_only=False): # See https://docs.microsoft.com/en-us/nuget/reference/nuspec#license # This is a SPDX license expression if 'license' in nuspec: - extracted_license_statement = nuspec.get('license') + license_val = nuspec.get('license') + if isinstance(license_val, dict): + extracted_license_statement = license_val.get('#text') + else: + extracted_license_statement = license_val # Deprecated and not a license expression, just a URL elif 'licenseUrl' in nuspec: extracted_license_statement = nuspec.get('licenseUrl') @@ -233,7 +238,7 @@ def parse(cls, location, package_only=False): ) resolved_package = models.PackageData.from_data(resolved_package_mapping) package_type = package_info.get('type') - if package_type == "Direct": + if package_type in ("Direct", "Project"): is_direct = True elif package_type == "Transitive": is_direct = False diff --git a/tests/packagedcode/test_nuget.py b/tests/packagedcode/test_nuget.py index d3af13ab51..b93492f55e 100644 --- a/tests/packagedcode/test_nuget.py +++ b/tests/packagedcode/test_nuget.py @@ -72,3 +72,77 @@ def test_parse_nuget_package_lock_json(self): def test_package_lock_json_is_package_data_file(self): test_file = self.get_test_loc('nuget/packages.lock.json') assert nuget.NugetPackagesLockHandler.is_datafile(test_file) + + def test_parse_nuspec_with_fallback_group_without_target_framework(self): + test_file = self.get_temp_file('test.nuspec') + with open(test_file, 'w') as f: + f.write(''' + + + SamplePackage + 1.0.0 + + + + + + + + + +''') + packages = list(nuget.NugetNuspecHandler.parse(test_file)) + assert len(packages) == 1 + package = packages[0] + assert package.name == 'SamplePackage' + assert len(package.dependencies) == 2 + dep_fallback = [d for d in package.dependencies if d.purl == 'pkg:nuget/FallbackDep'][0] + assert dep_fallback.extracted_requirement == '1.0.0' + assert not dep_fallback.extra_data.get('framework') + + dep_net6 = [d for d in package.dependencies if d.purl == 'pkg:nuget/Net6Dep'][0] + assert dep_net6.extracted_requirement == '2.0.0' + assert dep_net6.extra_data.get('framework') == 'net6.0' + + def test_parse_nuspec_with_expression_license(self): + test_file = self.get_temp_file('test_license.nuspec') + with open(test_file, 'w') as f: + f.write(''' + + + SampleLicensePackage + 1.0.0 + Apache-2.0 + +''') + packages = list(nuget.NugetNuspecHandler.parse(test_file)) + assert len(packages) == 1 + package = packages[0] + assert package.extracted_license_statement == 'Apache-2.0' + assert package.declared_license_expression == 'apache-2.0' + + def test_parse_packages_lock_with_project_dependency(self): + test_file = self.get_temp_file('packages.lock.json') + with open(test_file, 'w') as f: + f.write('''{ + "version": 1, + "dependencies": { + "net6.0": { + "MyClassLib": { + "type": "Project", + "dependencies": {} + }, + "Newtonsoft.Json": { + "type": "Direct", + "resolved": "13.0.1", + "contentHash": "abc" + } + } + } +}''') + packages = list(nuget.NugetPackagesLockHandler.parse(test_file)) + assert len(packages) == 1 + package = packages[0] + assert len(package.dependencies) == 2 + proj_dep = [d for d in package.dependencies if d['purl'] == 'pkg:nuget/MyClassLib'][0] + assert proj_dep['is_direct'] is True