Fix Poetry lock optional dependency parsing

Signed-off-by: Adnan Raza <imadnanraza4@gmail.com>

Author: Mars-60

AUTHORS.rst

@@ -2,6 +2,7 @@ The following organizations or individuals have contributed to ScanCode:
 
 - Abhigyan Kumar Singh @Abhigyankrsingh
 - Abhishek Kumar @Abhishek-Dev09
+- Adnan Raza @Mars-60
 - Aditya Viki @adityaviki
 - Adrian Braemer @abraemer
 - Agni Bhattacharyya @PyAgni

CHANGELOG.rst

@@ -4,6 +4,9 @@ Changelog
 Next release
 --------------
 
+- Fix incorrect optional dependency reporting when parsing Poetry lockfiles.
+  https://github.com/aboutcode-org/scancode-toolkit/issues/5294
+
 - Fix the optional ``licenses`` extra dependency typo to install
   ``licensedcode-data``.
   https://github.com/aboutcode-org/scancode-toolkit/pull/5056

src/packagedcode/pypi.py

@@ -806,7 +806,7 @@ def parse(cls, location, package_only=False):
             )
             resolved_package = models.PackageData.from_data(package_data, package_only)
 
-            is_optional = package.get("is_optional") or True
+            is_optional = package.get("optional", False)
             dependency = models.DependentPackage(
                 purl=resolved_package.purl,
                 extracted_requirement=None,

tests/packagedcode/data/pypi/poetry/univers-package-assembly-expected.json

@@ -146,7 +146,7 @@
       "extracted_requirement": null,
       "scope": null,
       "is_runtime": true,
-      "is_optional": true,
+      "is_optional": false,
       "is_pinned": true,
       "is_direct": false,
       "resolved_package": {
@@ -579,7 +579,7 @@
       "extracted_requirement": null,
       "scope": null,
       "is_runtime": true,
-      "is_optional": true,
+      "is_optional": false,
       "is_pinned": true,
       "is_direct": false,
       "resolved_package": {
@@ -649,7 +649,7 @@
       "extracted_requirement": null,
       "scope": null,
       "is_runtime": true,
-      "is_optional": true,
+      "is_optional": false,
       "is_pinned": true,
       "is_direct": false,
       "resolved_package": {
@@ -730,7 +730,7 @@
       "extracted_requirement": null,
       "scope": null,
       "is_runtime": true,
-      "is_optional": true,
+      "is_optional": false,
       "is_pinned": true,
       "is_direct": false,
       "resolved_package": {
@@ -921,7 +921,7 @@
       "extracted_requirement": null,
       "scope": null,
       "is_runtime": true,
-      "is_optional": true,
+      "is_optional": false,
       "is_pinned": true,
       "is_direct": false,
       "resolved_package": {
@@ -1033,7 +1033,7 @@
               "extracted_requirement": null,
               "scope": null,
               "is_runtime": true,
-              "is_optional": true,
+              "is_optional": false,
               "is_pinned": true,
               "is_direct": false,
               "resolved_package": {
@@ -1462,7 +1462,7 @@
               "extracted_requirement": null,
               "scope": null,
               "is_runtime": true,
-              "is_optional": true,
+              "is_optional": false,
               "is_pinned": true,
               "is_direct": false,
               "resolved_package": {
@@ -1528,7 +1528,7 @@
               "extracted_requirement": null,
               "scope": null,
               "is_runtime": true,
-              "is_optional": true,
+              "is_optional": false,
               "is_pinned": true,
               "is_direct": false,
               "resolved_package": {
@@ -1605,7 +1605,7 @@
               "extracted_requirement": null,
               "scope": null,
               "is_runtime": true,
-              "is_optional": true,
+              "is_optional": false,
               "is_pinned": true,
               "is_direct": false,
               "resolved_package": {
@@ -1792,7 +1792,7 @@
               "extracted_requirement": null,
               "scope": null,
               "is_runtime": true,
-              "is_optional": true,
+              "is_optional": false,
               "is_pinned": true,
               "is_direct": false,
               "resolved_package": {

tests/packagedcode/data/pypi/poetry/univers-poetry.lock-expected.json

@@ -398,6 +398,39 @@ def test_parse_poetry_lock_univers(self):
         expected_loc = self.get_test_loc('pypi/poetry/univers-poetry.lock-expected.json')
         self.check_packages_data(package, expected_loc, regen=REGEN_TEST_FIXTURES)
 
+    def test_parse_poetry_lock_package_optional(self):
+        test_file = self.get_temp_file('poetry.lock')
+        with open(test_file, 'w') as lockfile:
+            lockfile.write('''\
+[[package]]
+name = "required-dep"
+version = "1.0.0"
+description = "required dependency"
+optional = false
+python-versions = ">=3.8"
+
+[[package]]
+name = "optional-dep"
+version = "2.0.0"
+description = "optional dependency"
+optional = true
+python-versions = ">=3.8"
+
+[metadata]
+lock-version = "2.0"
+python-versions = ">=3.8"
+content-hash = "test"
+''')
+
+        package_data = list(pypi.PoetryLockHandler.parse(test_file))[0]
+        dependencies_by_purl = {
+            dependency['purl']: dependency
+            for dependency in package_data.dependencies
+        }
+
+        assert dependencies_by_purl['pkg:pypi/required-dep@1.0.0']['is_optional'] is False
+        assert dependencies_by_purl['pkg:pypi/optional-dep@2.0.0']['is_optional'] is True
+
     def test_parse_pyproject_toml_poetry_univers(self):
         test_file = self.get_test_loc('pypi/poetry/univers/pyproject.toml')
         package = pypi.PoetryPyprojectTomlHandler.parse(test_file)
@@ -805,4 +838,3 @@ def test_parse_setup_py(test_loc):
 )
 def test_parse_more_setup_py(test_loc):
     check_setup_py_parsing(test_loc)
-