Add support for Code Quality report format to diff_quality to allow test results being ingested into Gitlab

[VMois]

I am a user of SQLFluff and it supports diff_quality for lint. I am interested in ingesting lint results from SQLFluff (run by diff_quality tool) into Gitlab.

Gitlab supports Code Quality format. Looking at a diff_quality codebase, the json format is not the same as required by Gitlab.

I am happy to look into it and prepare an MR. It looks like adding a new JsonReporter is a possiblity.

What do you think about it? Any pointers or advice? Thank you.

[Bachmann1234]

Yeah, I think this could work. But I think there would have to be a larger change then you may be thinking.

If you look at the current json report it does not actually do that much in diff quality. It takes the stats collected by the BaseReportGenerator and just seralizes the underlying dict as json.

I think what you may end up having to do is treat the BaseReportGenerator as an interface but override much of its functionality to collect the stats you need for this report.

then I think the problem you will run into issues where the violations the tools provide dont give you what you need (see the namedtuple Violation (give you line and message. Where you will need line, message, name, severity, etc)

SO to sum that up

1. Update violation to collect more data
2. Either update the BaseReporter to store more in its stash or (more likely) override more of the functionality in baseReporter with what you need for this usecase

[VMois]

Thank you for the tips! I will find some time in the next few weeks and work on it.