chore:SP-1676 Refactor on scanoss-py policy analyzer

Author: agustingroh

src/scanoss/cli.py

@@ -25,16 +25,13 @@
 import os
 from pathlib import Path
 import sys
-
-
 import pypac
 from scanoss.inspection.copyleft import Copyleft
 from scanoss.inspection.undeclared_component import UndeclaredComponent
 from .threadeddependencies import SCOPE
-from .scanner import Scanner
 from .scanoss_settings import ScanossSettings
 from .scancodedeps import ScancodeDeps
-from .scanner import FAST_WINNOWING, Scanner
+from .scanner import Scanner
 from .scantype import ScanType
 from .filecount import FileCount
 from .cyclonedx import CycloneDx
@@ -313,11 +310,11 @@ def setup_args() -> None:
     p_copyleft.add_argument('--include', help='List of Copyleft licenses to append to the default list. Provide licenses as a comma-separated list.')
     p_copyleft.add_argument('--exclude', help='List of Copyleft licenses to remove from default list. Provide licenses as a comma-separated list.')
     p_copyleft.add_argument('--explicit', help='Explicit list of Copyleft licenses to consider. Provide licenses as a comma-separated list.s')
-    p_copyleft.set_defaults(func=inspect)
+    p_copyleft.set_defaults(func=inspect_copyleft)
 
     # Inspect Sub-command: inspect undeclared
     p_undeclared = p_inspect_sub.add_parser('undeclared', aliases=['un'],description="Inspect for undeclared components", help='Inspect for undeclared components')
-    p_undeclared.set_defaults(func=inspect)
+    p_undeclared.set_defaults(func=inspect_undeclared)
 
     for p in [p_copyleft, p_undeclared]:
         p.add_argument('-i', '--input', nargs='?', help='Path to results file')
@@ -810,7 +807,7 @@ def convert(parser, args):
     if not success:
         exit(1)
 
-def inspect(parser, args):
+def inspect_copyleft(parser, args):
     """
     Run the "inspect" sub-command
     Parameters
@@ -820,27 +817,59 @@ def inspect(parser, args):
         args: Namespace
             Parsed arguments
     """
-    if args.subparsercmd and not args.input :
+    if args.input is None:
         print_stderr('Please specify an input file to inspect')
         parser.parse_args([args.subparser, args.subparsercmd, '-h'])
         exit(1)
-    success = False
-    if args.subparsercmd == 'copyleft':
-        i_copyleft = Copyleft(debug=False, trace=args.trace, quiet=args.quiet, filepath=args.input, format=args.format,
-                             status=args.status, output=args.output, include=args.include,
-                             exclude=args.exclude, explicit=args.explicit)
-        status, _ = i_copyleft.run()
-        sys.exit(status)
-
-    if args.subparsercmd == 'undeclared':
-        i_undeclared = UndeclaredComponent(debug=args.debug, trace=args.trace, quiet=args.quiet, filepath=args.input,
-                                        format=args.format, status=args.status, output=args.output)
-        status, _ = i_undeclared.run()
-        sys.exit(status)
 
-    if not success:
+    output: str = None
+    if args.output:
+        output = args.output
+        open(output, 'w').close()
+
+    status_output: str = None
+    if args.status:
+        status_output = args.status
+        open(status_output, 'w').close()
+
+    i_copyleft = Copyleft(debug=False, trace=args.trace, quiet=args.quiet, filepath=args.input,
+                          format_type=args.format, status=status_output, output=output, include=args.include,
+                         exclude=args.exclude, explicit=args.explicit)
+    status, _ = i_copyleft.run()
+    sys.exit(status)
+
+
+
+def inspect_undeclared(parser, args):
+    """
+    Run the "inspect" sub-command
+    Parameters
+    ----------
+        parser: ArgumentParser
+            command line parser object
+        args: Namespace
+            Parsed arguments
+    """
+    if args.input is None:
+        print_stderr('Please specify an input file to inspect')
+        parser.parse_args([args.subparser, args.subparsercmd, '-h'])
         exit(1)
 
+    output: str = None
+    if args.output:
+        output = args.output
+        open(output, 'w').close()
+
+    status_output: str = None
+    if args.output:
+        status_output = args.status_output
+        open(status_output, 'w').close()
+    i_undeclared = UndeclaredComponent(debug=args.debug, trace=args.trace, quiet=args.quiet,
+                                       filepath=args.input, format_type=args.format,
+                                       status=status_output, output=output)
+    status, _ = i_undeclared.run()
+    sys.exit(status)
+
 
 def utils_certloc(*_):
     """

src/scanoss/inspection/copyleft.py

@@ -1,10 +1,29 @@
+"""
+ SPDX-License-Identifier: MIT
+
+   Copyright (c) 2021, SCANOSS
+
+   Permission is hereby granted, free of charge, to any person obtaining a copy
+   of this software and associated documentation files (the "Software"), to deal
+   in the Software without restriction, including without limitation the rights
+   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+   copies of the Software, and to permit persons to whom the Software is
+   furnished to do so, subject to the following conditions:
+
+   The above copyright notice and this permission notice shall be included in
+   all copies or substantial portions of the Software.
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+   THE SOFTWARE.
+"""
 import json
-import sys
-from typing import Dict, Any, Callable, List
+from typing import Dict, Any
 from scanoss.inspection.policy_check import PolicyCheck, PolicyStatus
-from scanoss.inspection.utils.license_utils import license_util
-from scanoss.inspection.utils.markdown_utils import generate_table
-
 
 class Copyleft(PolicyCheck):
     """
@@ -13,21 +32,23 @@ class Copyleft(PolicyCheck):
     """
 
     def __init__(self, debug: bool = False, trace: bool = True, quiet: bool = False, filepath: str = None,
-                 format: str = 'json', status: str = None, output: str = None, include: str = None, exclude: str = None, explicit: str = None):
+                 format_type: str = 'json', status: str = None, output: str = None, include: str = None,
+                 exclude: str = None, explicit: str = None):
         """
                Initialize the Copyleft class.
                :param debug: Enable debug mode
                :param trace: Enable trace mode (default True)
                :param quiet: Enable quiet mode
                :param filepath: Path to the file containing component data
-               :param format: Output format ('json' or 'md')
+               :param format_type: Output format ('json' or 'md')
                :param status: Path to save the status output
                :param output: Path to save detailed output
                :param include: Licenses to include in the analysis
                :param exclude: Licenses to exclude from the analysis
                :param explicit: Explicitly defined licenses
         """
-        super().__init__(debug, trace, quiet, filepath, format, status, output, name='Copyleft Policy')
+        super().__init__(debug, trace, quiet, filepath, format_type, status, output, name='Copyleft Policy')
+        self.license_util.init(include, exclude, explicit)
         self.filepath = filepath
         self.format = format
         self.output = output
@@ -74,25 +95,10 @@ def _markdown(self, components: list) -> Dict[str,Any]:
                 rows.append(row)
 
         return  {
-            'details': f"### Copyleft licenses \n {generate_table(headers,rows,centeredColumns)}",
+            'details': f"### Copyleft licenses \n {self.generate_table(headers,rows,centeredColumns)}",
             'summary' : f"{len(components)} component(s) with copyleft licenses were found."
         }
 
-    def _get_formatter(self)-> Callable[[List[dict]], Dict[str,Any]] or None:
-        """
-            Get the appropriate formatter function based on the specified format.
-            :return: Formatter function (either _json or _markdown)
-        """
-        valid_format = self._is_valid_format()
-        if not valid_format:
-            return None
-
-        function_map = {
-            'json': self._json,
-            'md': self._markdown
-        }
-        return function_map[self.format]
-
     def _filter_components_with_copyleft_licenses(self, components: list) -> list:
         """
            Filter the components list to include only those with copyleft licenses.
@@ -124,12 +130,8 @@ def run(self):
 
         :return: Dictionary containing the inspection results
         """
-        if not self._init():
-            return PolicyStatus.ERROR.value, {}
 
         self._debug()
-
-        license_util.init(self.include, self.exclude, self.explicit)
         components = self._get_components()
         if components is None:
             return PolicyStatus.ERROR.value, {}