chore:implements Rawbase methods on ComponentSummary and LicenseSummary commands

Author: agustingroh

src/scanoss/cli.py

@@ -1272,7 +1272,11 @@ def setup_args() -> None:  # noqa: PLR0912, PLR0915
     ) and not args.subparsercmd:
         parser.parse_args([args.subparser, '--help'])  # Force utils helps to be displayed
         sys.exit(1)
-    elif (args.subparser in 'inspect') and (args.subparsercmd in ('raw', 'dt')) and (args.subparser_subcmd is None):
+    elif (
+        (args.subparser in 'inspect')
+        and (args.subparsercmd in ('raw', 'dt', 'glc', 'gitlab'))
+        and (args.subparser_subcmd is None)
+    ):
         parser.parse_args([args.subparser, args.subparsercmd, '--help'])  # Force utils helps to be displayed
         sys.exit(1)
     args.func(parser, args)  # Execute the function associated with the sub-command
@@ -1696,8 +1700,8 @@ def convert(parser, args):
     elif args.format == 'glc-codequality':
         if not args.quiet:
             print_stderr('Producing Gitlab code quality report...')
-        glcCodeQuality = GitLabQualityReport(debug=args.debug, trace=args.trace, quiet=args.quiet)
-        success = glcCodeQuality.produce_from_file(args.input, output_file=args.output)
+        glc_code_quality = GitLabQualityReport(debug=args.debug, trace=args.trace, quiet=args.quiet)
+        success = glc_code_quality.produce_from_file(args.input, output_file=args.output)
     else:
         print_stderr(f'ERROR: Unknown output format (--format): {args.format}')
     if not success:
@@ -1971,9 +1975,9 @@ def inspect_dep_track_project_violations(parser, args):
         sys.exit(1)
 
 
-def inspect_gitlab_matches(parser, args):
+def inspect_gitlab_matches(parser,args):
     """
-    Handle GitLab matches summary inspection command.
+    Handle GitLab matches the summary inspection command.
 
     Analyzes SCANOSS scan results and generates a GitLab-compatible Markdown summary
     report of component matches. The report includes match details, file locations,
@@ -1983,6 +1987,8 @@ def inspect_gitlab_matches(parser, args):
 
     Parameters
     ----------
+    parser : ArgumentParser
+        Command line parser object for help display
     args : Namespace
         Parsed command line arguments containing:
         - input: Path to SCANOSS scan results file (JSON format) to analyze
@@ -1999,6 +2005,15 @@ def inspect_gitlab_matches(parser, args):
     - Line range prefix enables clickable file references in the report
     - If output is not specified, the report is written to stdout
     """
+
+    if args.input is None:
+        parser.parse_args([args.subparser, '-h'])
+        sys.exit(1)
+
+    if args.line_range_prefix is None:
+        parser.parse_args([args.subparser, '-h'])
+        sys.exit(1)
+
     # Initialize output file if specified (create/truncate)
     if args.output:
         initialise_empty_file(args.output)

src/scanoss/gitlabqualityreport.py

@@ -31,7 +31,6 @@
 from .utils import scanoss_scan_results_utils
 
 
-
 @dataclass
 class Lines:
     begin: int
@@ -152,7 +151,7 @@ def _produce_from_json(self, data: dict, output_file: str = None) -> bool:
 
     def _produce_from_str(self, json_str: str, output_file: str = None) -> bool:
         """
-        Produce Gitlab Code Quality Reportoutput from input JSON string
+        Produce Gitlab Code Quality Report output from input JSON string
         :param json_str: input JSON string
         :param output_file: Output file (optional)
         :return: True if successful, False otherwise

src/scanoss/inspection/raw/component_summary.py

@@ -21,16 +21,57 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 """
-
 import json
-from typing import Dict, Any
+from typing import Any
 
-from .raw_base import RawBase
 from ..policy_check import T
+from .raw_base import RawBase
 
 
 class ComponentSummary(RawBase):
 
+    def _json(self, data: dict[str,Any]) -> dict[str,Any]:
+        """
+        Format component summary data as JSON.
+
+        This method returns the component summary data in its original JSON structure
+        without any transformation. The data can be directly serialized to JSON format.
+
+        :param data: Dictionary containing component summary information including:
+                     - components: List of component-license pairs with status and metadata
+                     - totalComponents: Total number of unique components
+                     - undeclaredComponents: Number of components with 'pending' status
+                     - declaredComponents: Number of components with 'identified' status
+                     - totalFilesDetected: Total count of files where components were detected
+                     - totalFilesUndeclared: Count of files with undeclared components
+                     - totalFilesDeclared: Count of files with declared components
+        :return: The same data dictionary, ready for JSON serialization
+        """
+        return data
+
+    def _markdown(self, data: list[T]) -> dict[str, Any]:
+        """
+        Format component summary data as Markdown (not yet implemented).
+
+        This method is intended to convert component summary data into a human-readable
+        Markdown format with tables and formatted sections.
+
+        :param data: List of component summary items to format
+        :return: Dictionary containing formatted Markdown output
+        """
+        pass
+
+    def _jira_markdown(self, data: list[T]) -> dict[str, Any]:
+        """
+        Format component summary data as Jira-flavored Markdown (not yet implemented).
+
+        This method is intended to convert component summary data into Jira-compatible
+        Markdown format, which may include Jira-specific syntax for tables and formatting.
+
+        :param data: List of component summary items to format
+        :return: Dictionary containing Jira-formatted Markdown output
+        """
+        pass
 
     def _get_component_summary_from_components(self, scan_components: list)-> dict:
         """
@@ -88,10 +129,16 @@ def _get_components(self):
         self._get_components_data(self.results, components)
         return self._convert_components_to_list(components)
 
+    def _format(self, component_summary) -> str:
+        # TODO: Implement formatter to support dynamic outputs
+        json_data = self._json(component_summary)
+        return json.dumps(json_data, indent=2)
+
     def run(self):
         components = self._get_components()
         component_summary = self._get_component_summary_from_components(components)
-        self.print_to_file_or_stdout(json.dumps(component_summary, indent=2), self.output)
+        output = self._format(component_summary)
+        self.print_to_file_or_stdout(output, self.output)
         return component_summary
 #
 # End of ComponentSummary Class

src/scanoss/inspection/raw/license_summary.py

@@ -23,7 +23,9 @@
 """
 
 import json
+from typing import Any
 
+from ..policy_check import T
 from .raw_base import RawBase
 
 
@@ -36,6 +38,46 @@ class LicenseSummary(RawBase):
        information, providing detailed summaries including copyleft analysis and license statistics.
        """
 
+    def _json(self, data: dict[str,Any]) -> dict[str, Any]:
+        """
+        Format license summary data as JSON (not yet implemented).
+
+        This method is intended to return the license summary data in JSON structure
+        for serialization. The data should include license information with copyleft
+        analysis and license statistics.
+
+        :param data: List of license summary items to format
+        :return: Dictionary containing license summary information including:
+                 - licenses: List of detected licenses with SPDX IDs, URLs, and copyleft status
+                 - detectedLicenses: Total number of unique licenses
+                 - detectedLicensesWithCopyleft: Count of licenses marked as copyleft
+        """
+        return data
+
+    def _markdown(self, data: list[T]) -> dict[str, Any]:
+        """
+        Format license summary data as Markdown (not yet implemented).
+
+        This method is intended to convert license summary data into a human-readable
+        Markdown format with tables and formatted sections.
+
+        :param data: List of license summary items to format
+        :return: Dictionary containing formatted Markdown output
+        """
+        pass
+
+    def _jira_markdown(self, data: list[T]) -> dict[str, Any]:
+        """
+        Format license summary data as Jira-flavored Markdown (not yet implemented).
+
+        This method is intended to convert license summary data into Jira-compatible
+        Markdown format, which may include Jira-specific syntax for tables and formatting.
+
+        :param data: List of license summary items to format
+        :return: Dictionary containing Jira-formatted Markdown output
+        """
+        pass
+
     # Define required license fields as class constants
     REQUIRED_LICENSE_FIELDS = ['spdxid', 'url', 'copyleft', 'source']
 
@@ -131,10 +173,16 @@ def _get_components(self):
         self._get_dependencies_data(self.results, components)
         return self._convert_components_to_list(components)
 
+    def _format(self, license_summary) -> str:
+        # TODO: Implement formatter to support dynamic outputs
+        json_data = self._json(license_summary)
+        return json.dumps(json_data, indent=2)
+
     def run(self):
         components = self._get_components()
         license_summary = self._get_licenses_summary_from_components(components)
-        self.print_to_file_or_stdout(json.dumps(license_summary, indent=2), self.output)
+        output = self._format(license_summary)
+        self.print_to_file_or_stdout(output, self.output)
         return license_summary
 #
 # End of LicenseSummary Class

src/scanoss/inspection/raw/match_summary.py

@@ -90,7 +90,7 @@ def __init__(  # noqa: PLR0913
         :param scanoss_results_path: Path to SCANOSS scan results file in JSON format
         :param output: Output file path for the generated Markdown report (default: stdout)
         """
-        super().__init__(debug, trace, quiet)
+        super().__init__(debug=debug, trace=trace, quiet=quiet)
         self.scanoss_results_path = scanoss_results_path
         self.line_range_prefix = line_range_prefix
         self.output = output
@@ -185,6 +185,7 @@ def _get_matches_summary(self) -> ComponentMatchSummary:
             for result in results:
                 # Skip non-matches
                 if result.get('id') == "none":
+                    self.print_debug(f'Skipping non-match for file {file_name}')
                     continue
 
                 # Validate required fields