feat: implement exclude settings

co-authored-by: Agustin Groh <[email protected]>

Author: isasmendiagus

src/scanoss/cli.py

@@ -1071,9 +1071,8 @@ def scan(parser, args):  # noqa: PLR0912, PLR0915
                     'blacklist'
                 )
             else:
-                scan_settings.load_json_file(args.settings, args.scan_dir).set_file_type('new').set_scan_type(
-                    'identify'
-                )
+                scan_settings.load_json_file(args.settings, args.scan_dir).set_file_type('new')
+
         except ScanossSettingsError as e:
             print_stderr(f'Error: {e}')
             sys.exit(1)

src/scanoss/scanoss_settings.py

@@ -172,7 +172,7 @@ def _is_valid_sbom_file(self):
 
     def _get_bom(self):
         """
-        Get the Billing of Materials from the settings file
+        Get the Bill of Materials from the settings file
         Returns:
             dict: If using scanoss.json
             list: If using SBOM.json
@@ -196,6 +196,17 @@ def get_bom_include(self) -> List[BomEntry]:
             return self._get_bom()
         return self._get_bom().get('include', [])
 
+
+    def get_bom_exclude(self) -> List[BomEntry]:
+        """
+        Get the list of components to exclude from the scan
+        Returns:
+            list: List of components to exclude from the scan
+        """
+        if self.settings_file_type == 'legacy':
+            return self._get_bom()
+        return self._get_bom().get('exclude', [])
+
     def get_bom_remove(self) -> List[BomEntry]:
         """
         Get the list of components to remove from the scan
@@ -225,8 +236,8 @@ def get_sbom(self):
         if not self.data:
             return None
         return {
-            'scan_type': self.scan_type,
             'assets': json.dumps(self._get_sbom_assets()),
+            'scan_type': self.scan_type,
         }
 
     def _get_sbom_assets(self):
@@ -235,7 +246,18 @@ def _get_sbom_assets(self):
         Returns:
             List: List of SBOM assets
         """
-        if self.scan_type == 'identify':
+
+        if self.settings_file_type == 'new':
+            if len(self.get_bom_include()):
+                self.scan_type = 'identify'
+                include_bom_entries = self._remove_duplicates(self.normalize_bom_entries(self.get_bom_include()))
+                return {"components": include_bom_entries}
+            elif len(self.get_bom_exclude()):
+                self.scan_type = 'blacklist'
+                exclude_bom_entries = self._remove_duplicates(self.normalize_bom_entries(self.get_bom_exclude()))
+                return {"components": exclude_bom_entries}
+
+        if self.settings_file_type == 'legacy' and self.scan_type == 'identify':            # sbom-identify.json
             include_bom_entries = self._remove_duplicates(self.normalize_bom_entries(self.get_bom_include()))
             replace_bom_entries = self._remove_duplicates(self.normalize_bom_entries(self.get_bom_replace()))
             self.print_debug(
@@ -244,6 +266,14 @@ def _get_sbom_assets(self):
                 f'From Replace list: {[entry["purl"] for entry in replace_bom_entries]} \n'
             )
             return include_bom_entries + replace_bom_entries
+
+        if self.settings_file_type == 'legacy' and self.scan_type == 'blacklist':            # sbom-identify.json
+            exclude_bom_entries = self._remove_duplicates(self.normalize_bom_entries(self.get_bom_exclude()))
+            self.print_debug(
+                f"Scan type set to 'blacklist'. Adding {len(exclude_bom_entries)} components as context to the scan. \n"  # noqa: E501
+                f'From Exclude list: {[entry["purl"] for entry in exclude_bom_entries]} \n')
+            return exclude_bom_entries
+
         return self.normalize_bom_entries(self.get_bom_remove())
 
     @staticmethod