Source code for statick_tool.plugins.tool.groovylint

"""Apply GroovyLint tool and gather results."""

import json
import logging
import subprocess
from typing import Optional

from statick_tool.issue import Issue
from statick_tool.package import Package
from statick_tool.tool_plugin import ToolPlugin




class GroovyLintToolPlugin(ToolPlugin):
    """Apply GroovyLint tool and gather results."""



    def get_name(self) -> str:
        """Get name of tool.

        Returns:
            Name of the tool.
        """
        return "groovylint"




    def get_file_types(self) -> list[str]:
        """Return a list of file types the plugin can scan.

        Returns:
            List of file types.
        """
        return ["groovy_src"]




    def get_binary(  # pylint: disable=unused-argument
        self, level: Optional[str] = None, package: Optional[Package] = None
    ) -> str:
        """Get tool binary name.

        Args:
            level: The analysis level.
            package: The package being analyzed.

        Returns:
            Name of the tool binary.
        """
        return "npm-groovy-lint"




    def get_version(self) -> str:
        """Figure out and return the version of the tool that's installed.

        Returns:
            Version of the tool or "Unknown" if not found.
        """
        return self.get_version_from_npm()




    def process_files(
        self, package: Package, level: str, files: list[str], user_flags: list[str]
    ) -> Optional[list[str]]:
        """Run tool and gather output.

        Args:
            package: The package being analyzed.
            level: The analysis level.
            files: List of files to process.
            user_flags: List of user flags.

        Returns:
            List of output strings or None.
        """
        tool_bin = self.get_binary()

        tool_config = ".groovylintrc.json"
        user_config = None
        format_file_name = None

        if self.plugin_context:
            user_config = self.plugin_context.config.get_tool_config(
                self.get_name(), level, "config"
            )
        if user_config is not None:
            tool_config = user_config
        if self.plugin_context:
            format_file_name = self.plugin_context.resources.get_file(tool_config)

        flags: list[str] = []
        if format_file_name is not None:
            flags += ["--config", format_file_name]
        flags += ["--serverhost", "http://127.0.0.1"]
        flags += ["--serverport", "7484"]
        flags += ["--output", "json"]
        flags += user_flags

        total_output: list[str] = []
        try:
            exe = [tool_bin] + flags + files
            output = subprocess.check_output(
                exe,
                stderr=subprocess.STDOUT,
                universal_newlines=True,
                cwd=package.path,
            )
            total_output.append(output)
        except subprocess.CalledProcessError as ex:
            # npm-groovy-lint returns 1 on some errors but still has valid output
            if ex.returncode == 1:
                total_output.append(ex.output)
            else:
                logging.warning("%s failed! Returncode = %d", tool_bin, ex.returncode)
                logging.warning("%s exception: %s", self.get_name(), ex.output)
                return None

        except OSError as ex:
            logging.warning("Couldn't find %s! (%s)", tool_bin, ex)
            return None

        logging.debug("%s", total_output)

        return total_output




    def parse_output(
        self, total_output: list[str], package: Optional[Package] = None
    ) -> list[Issue]:
        """Parse tool output and report issues.

        Args:
            total_output: List of output strings.
            package: The package being analyzed.

        Returns:
            List of issues.
        """
        issues: list[Issue] = []

        summary = {}
        for line in total_output[0].split("\n"):
            try:
                err_dict = json.loads(line)
                summary = err_dict
            except ValueError as ex:
                logging.warning("ValueError: %s", ex)

        if "files" in summary:
            all_files = summary["files"]
            for file_name in all_files:
                file_errs = all_files[file_name]
                if "errors" in file_errs:
                    for issue in file_errs["errors"]:
                        severity_str = issue["severity"]
                        severity = 3
                        if severity_str == "info":
                            severity = 1
                        elif severity_str == "warning":
                            severity = 3
                        elif severity_str == "error":
                            severity = 5
                        issues.append(
                            Issue(
                                file_name,
                                issue["line"],
                                self.get_name(),
                                issue["rule"],
                                severity,
                                issue["msg"],
                                None,
                            )
                        )

        return issues