Skip to content

Add --gitlab option to mh_style and mh_lint #303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LucasDooms wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add --gitlab option to mh_style and mh_lint #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion miss_hit/mh_lint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@
from miss_hit_core.errors import (Error,
Message_Handler,
HTML_Message_Handler,
JSON_Message_Handler)
JSON_Message_Handler,
GITLAB_Message_Handler)
from miss_hit_core.m_lexer import MATLAB_Lexer
from miss_hit_core.m_parser import MATLAB_Parser
from miss_hit_core.m_language_builtins import BUILTIN_FUNCTIONS
Expand Down Expand Up @@ -238,6 +239,10 @@ def main_handler():
"--json",
default=None,
help="Produce JSON report")
clp["output_options"].add_argument(
"--gitlab",
default=None,
help="Produce gitlab code quality report")

# Extra debug options
clp["debug_options"].add_argument(
Expand All @@ -251,15 +256,25 @@ def main_handler():
if options.html:
if options.json:
clp["ap"].error("Cannot produce JSON and HTML at the same time")
if options.gitlab:
clp["ap"].error("Cannot produce GITLAB and HTML at the same time")
if os.path.exists(options.html) and not os.path.isfile(options.html):
clp["ap"].error("Cannot write to %s: it is not a file" %
options.html)
mh = HTML_Message_Handler("lint", options.html)
elif options.json:
if options.gitlab:
clp["ap"].error("Cannot produce JSON and GITLAB at the same time")
if os.path.exists(options.json) and not os.path.isfile(options.json):
clp["ap"].error("Cannot write to %s: it is not a file" %
options.json)
mh = JSON_Message_Handler("lint", options.json)
elif options.gitlab:
if os.path.exists(options.gitlab) \
and not os.path.isfile(options.gitlab):
clp["ap"].error("Cannot write to %s: it is not a file" %
options.gitlab)
mh = GITLAB_Message_Handler("lint", options.gitlab)
else:
mh = Message_Handler("lint")

Expand Down
68 changes: 68 additions & 0 deletions miss_hit_core/errors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import sys
import html
import json
import hashlib

from miss_hit_core import pathutil
from miss_hit_core.config import STYLE_RULES, METRICS
Expand Down Expand Up @@ -103,6 +104,12 @@ def to_json(self, detailed=True):
rv["context"] = self.context
return rv

def to_gitlab(self):
rv = {}
rv["path"] = self.filename if self.filename else ""
rv["lines"] = {"begin": self.line if self.line else 0}

@pvogt09 pvogt09 Jul 30, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
rv["lines"] = {"begin": self.line if self.line else 0}
if self.col_start and self.col_end:
rv["positions"] = {
"begin": {
"line": self.line if self.line else 0,
"column": self.col_start if self.col_start else 0,
},
"end": {
"line": self.line if self.line else 0,
"column": self.col_end if self.col_end else 0,
},
}
else:
rv["lines"] = {"begin": self.line if self.line else 0}

return rv

def short_string(self):
rv = self.filename
if self.line:
Expand Down Expand Up @@ -197,6 +204,36 @@ def to_json(self):
"fixable" : self.fixed,
"fatal" : self.fatal}

def to_gitlab(self):
check_name = self.check_id if self.check_id else ""

map_severity = {
"low": "info",
"medium": "minor",
"high": "major",
}
severity = map_severity.get(self.severity, "minor")

if self.fatal:
severity = "critical"
check_name = "fatal"

contents = {
"description" : self.message,
"check_name" : check_name,

@pvogt09 pvogt09 Jul 30, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"check_name" : check_name,
"type": "issue",
"check_name" : check_name,
"categories": ["Style"],

Eventually map categories in https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md#data-types to Message.kind?

"fingerprint" : 0,
"severity" : severity,
"location" : self.location.to_gitlab(),
}

# Produce unique fingerprint based on contents
# Use sort_keys for better reproducibility
contents["fingerprint"] = hashlib.sha1(
json.dumps(contents, sort_keys=True).encode("utf-8")
).hexdigest()

return contents


class Check_Message(Message):
def __init__(self, location, severity, check_id, message):
Expand Down Expand Up @@ -760,3 +797,34 @@ def emit_summary(self):
json.dump(self.blob, self.fd, indent=2)
self.fd.write("\n")
self.fd.close()


class GITLAB_Message_Handler(File_Based_Message_Handler):
def __init__(self, tool_id, filename):
super().__init__(tool_id, filename)
self.blob = None

def fork(self):
rv = GITLAB_Message_Handler(self.tool_id, self.filename)
self.fork_copy_attributes(rv)
return rv

def setup_fd(self):
# pylint: disable=consider-using-with
if self.fd is not None:
return

self.fd = open(self.filename, "w", encoding="UTF-8")
self.blob = []

def emit_message(self, message):
self.setup_fd()

self.blob.append(message.to_gitlab())

def emit_summary(self):
self.setup_fd()
super().emit_summary()
json.dump(self.blob, self.fd, indent=2)
self.fd.write("\n")
self.fd.close()
17 changes: 16 additions & 1 deletion miss_hit_core/mh_style.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@
from miss_hit_core.errors import (Location, Error, ICE,
Message_Handler,
HTML_Message_Handler,
JSON_Message_Handler)
JSON_Message_Handler,
GITLAB_Message_Handler)
from miss_hit_core.m_ast import *
from miss_hit_core.m_lexer import MATLAB_Lexer, Token_Buffer
from miss_hit_core.m_parser import MATLAB_Parser
Expand Down Expand Up @@ -1217,6 +1218,10 @@ def main_handler():
"--json",
default=None,
help="Produce JSON report")
clp["output_options"].add_argument(
"--gitlab",
default=None,
help="Produce gitlab code quality report")
clp["output_options"].add_argument(
"--no-style",
action="store_true",
Expand Down Expand Up @@ -1260,15 +1265,25 @@ def main_handler():
if options.html:
if options.json:
clp["ap"].error("Cannot produce JSON and HTML at the same time")
if options.gitlab:
clp["ap"].error("Cannot produce GITLAB and HTML at the same time")
if os.path.exists(options.html) and not os.path.isfile(options.html):
clp["ap"].error("Cannot write to %s: it is not a file" %
options.html)
mh = HTML_Message_Handler("style", options.html)
elif options.json:
if options.gitlab:
clp["ap"].error("Cannot produce JSON and GITLAB at the same time")
if os.path.exists(options.json) and not os.path.isfile(options.json):
clp["ap"].error("Cannot write to %s: it is not a file" %
options.json)
mh = JSON_Message_Handler("style", options.json)
elif options.gitlab:
if os.path.exists(options.gitlab) \
and not os.path.isfile(options.gitlab):
clp["ap"].error("Cannot write to %s: it is not a file" %
options.gitlab)
mh = GITLAB_Message_Handler("style", options.gitlab)
else:
mh = Message_Handler("style")

Expand Down