mirrors/dmd
1
0
Fork 0
mirror of https://github.com/dlang/dmd.git synced 2025-04-26 05:00:16 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

feat(errors): consolidate multiple sarif reports into a single report

Browse source 
Signed-off-by: royalpinto007 <royalpinto007@gmail.com>

fix(errors): buffer size

Signed-off-by: royalpinto007 <royalpinto007@gmail.com>

fix(errors): diagnostics array

Signed-off-by: royalpinto007 <royalpinto007@gmail.com>

fix(errors): repeated sarif blocks in errors.d and sarif.d

Signed-off-by: royalpinto007 <royalpinto007@gmail.com>

fix(errors): pre-commit checks

Signed-off-by: royalpinto007 <royalpinto007@gmail.com>

fix(errors): circleci build

Signed-off-by: royalpinto007 <royalpinto007@gmail.com>

fix(errors): Ddoc comments and docs

Signed-off-by: royalpinto007 <royalpinto007@gmail.com>

fix(errors): plugSink function by adding early return for empty diagnostics

Signed-off-by: royalpinto007 <royalpinto007@gmail.com>

fix(errors): remove unnecessary change

Signed-off-by: royalpinto007 <royalpinto007@gmail.com>

fix(errors): global array initialisation

Signed-off-by: royalpinto007 <royalpinto007@gmail.com>

fix(errors): separate formatting message

Signed-off-by: royalpinto007 <royalpinto007@gmail.com>

fix(errors): dDoc comments

Signed-off-by: royalpinto007 <royalpinto007@gmail.com>
This commit is contained in:
royalpinto007 2024-11-08 05:38:14 +05:30 • committed by Nicholas Wilson
parent b70e66033c
commit dc5f8db05c
7 changed files with 192 additions and 87 deletions
Download patch file Download diff file Expand all files Collapse all files

36
compiler/src/dmd/errors.d
View file

@ -37,6 +37,19 @@ enum ErrorKind
message,
}
/********************************
* Represents a diagnostic message generated during compilation, such as errors,
* warnings, or other messages.
*/
struct Diagnostic
{
SourceLoc loc; // The location in the source code where the diagnostic was generated (includes file, line, and column).
string message; // The text of the diagnostic message, describing the issue.
ErrorKind kind; // The type of diagnostic, indicating whether it is an error, warning, deprecation, etc.
}
__gshared Diagnostic[] diagnostics = [];
/***************************
* Error message sink for D compiler.
*/
@ -101,6 +114,18 @@ class ErrorSinkCompiler : ErrorSink
verrorReport(loc, format, ap, ErrorKind.message);
va_end(ap);
}
void plugSink()
{
// Exit if there are no collected diagnostics
if (!diagnostics.length) return;
// Generate the SARIF report with the current diagnostics
generateSarifReport(false);
// Clear diagnostics after generating the report
diagnostics.length = 0;
}
}
@ -467,6 +492,7 @@ private extern(C++) void verrorReport(const Loc loc, const(char)* format, va_lis
private extern(C++) void verrorReport(const SourceLoc loc, const(char)* format, va_list ap, ErrorKind kind, const(char)* p1 = null, const(char)* p2 = null)
{
auto info = ErrorInfo(loc, kind, p1, p2);
final switch (info.kind)
{
case ErrorKind.error:
@ -476,7 +502,7 @@ private extern(C++) void verrorReport(const SourceLoc loc, const(char)* format,
info.headerColor = Classification.error;
if (global.params.v.messageStyle == MessageStyle.sarif)
{
generateSarifReport(loc, format, ap, info.kind, false);
addSarifDiagnostic(loc, format, ap, kind);
return;
}
verrorPrint(format, ap, info);
@ -510,7 +536,7 @@ private extern(C++) void verrorReport(const SourceLoc loc, const(char)* format,
info.headerColor = Classification.deprecation;
if (global.params.v.messageStyle == MessageStyle.sarif)
{
generateSarifReport(loc, format, ap, info.kind, false);
addSarifDiagnostic(loc, format, ap, kind);
return;
}
verrorPrint(format, ap, info);
@ -531,7 +557,7 @@ private extern(C++) void verrorReport(const SourceLoc loc, const(char)* format,
info.headerColor = Classification.warning;
if (global.params.v.messageStyle == MessageStyle.sarif)
{
generateSarifReport(loc, format, ap, info.kind, false);
addSarifDiagnostic(loc, format, ap, kind);
return;
}
verrorPrint(format, ap, info);
@ -551,7 +577,7 @@ private extern(C++) void verrorReport(const SourceLoc loc, const(char)* format,
info.headerColor = Classification.tip;
if (global.params.v.messageStyle == MessageStyle.sarif)
{
generateSarifReport(loc, format, ap, info.kind, false);
addSarifDiagnostic(loc, format, ap, kind);
return;
}
verrorPrint(format, ap, info);
@ -571,7 +597,7 @@ private extern(C++) void verrorReport(const SourceLoc loc, const(char)* format,
fflush(stdout); // ensure it gets written out in case of compiler aborts
if (global.params.v.messageStyle == MessageStyle.sarif)
{
generateSarifReport(loc, format, ap, info.kind, false);
addSarifDiagnostic(loc, format, ap, kind);
return;
}
return;

3
compiler/src/dmd/frontend.d
View file

@ -180,6 +180,7 @@ void deinitializeDMD()
import dmd.mtype : Type;
import dmd.objc : Objc;
import dmd.target : target;
import dmd.errors : diagnostics;
diagnosticHandler = null;
fatalErrorHandler = null;
@ -194,6 +195,8 @@ void deinitializeDMD()
Objc.deinitialize();
Dsymbol.deinitialize();
EscapeState.reset();
diagnostics.length = 0;
}
/**

4
compiler/src/dmd/main.d
View file

@ -177,9 +177,7 @@ private int tryMain(size_t argc, const(char)** argv, ref Param params)
if (global.errors == 0 && global.params.v.messageStyle == MessageStyle.sarif)
{
SourceLoc defaultLoc = SourceLoc(null, 0u, 0u);
va_list ap;
generateSarifReport(defaultLoc, "", ap, ErrorKind.message, true);
generateSarifReport(true);
}
}

130
compiler/src/dmd/sarif.d
View file

@ -91,6 +91,29 @@ struct SarifResult {
}
}
/**
Adds a SARIF diagnostic entry to the diagnostics list.
Formats a diagnostic message and appends it to the global diagnostics array, allowing errors, warnings, or other diagnostics to be captured in SARIF format.
Params:
loc = The location in the source code where the diagnostic was generated (includes file, line, and column).
format = The printf-style format string for the diagnostic message.
ap = The variadic argument list containing values to format into the diagnostic message.
kind = The type of diagnostic, indicating whether it is an error, warning, deprecation, etc.
*/
void addSarifDiagnostic(const SourceLoc loc, const(char)* format, va_list ap, ErrorKind kind) nothrow
{
char[1024] buffer;
int written = vsnprintf(buffer.ptr, buffer.length, format, ap);
// Handle any truncation
string formattedMessage = cast(string) buffer[0 .. (written < 0 || written > buffer.length ? buffer.length : written)].dup;
// Add the Diagnostic to the global diagnostics array
diagnostics ~= Diagnostic(loc, formattedMessage, kind);
}
/// Represents a SARIF report containing tool information, invocation, and results.
struct SarifReport {
ToolInformation tool; /// Information about the analysis tool.
@ -155,16 +178,31 @@ string formatErrorMessage(const(char)* format, va_list ap) nothrow {
}
/**
Generates a SARIF (Static Analysis Results Interchange Format) report and prints it to `stdout`.
This function builds a JSON-formatted SARIF report, including information about the tool,
invocation status, error message, severity level, and the location of the issue in the source code.
Converts an `ErrorKind` value to a string representation.
Params:
kind = The `ErrorKind` value to convert (e.g., error, warning, deprecation).
Returns:
A string representing the `ErrorKind` value, such as "Error" or "Warning".
*/
string errorKindToString(ErrorKind kind) nothrow
{
final switch (kind) {
case ErrorKind.error: return "Error";
case ErrorKind.warning: return "Warning";
case ErrorKind.deprecation: return "Deprecation";
case ErrorKind.tip: return "Tip";
case ErrorKind.message: return "Message";
}
}
/**
Generates a SARIF (Static Analysis Results Interchange Format) report and prints it to `stdout`.
This function constructs a JSON-formatted SARIF report that includes information about the tool used (such as compiler version and URI), the invocation status (indicating whether the execution was successful), and a detailed array of diagnostics (results) when `executionSuccessful` is set to `false`. Each diagnostic entry in the results array contains the rule identifier (`ruleId`), a text message describing the issue (`message`), the severity level (`level`), and the location of the issue in the source code, including the file path, line number, and column number. The SARIF report adheres to the SARIF 2.1.0 standard.
Params:
loc = The source location where the error occurred (file, line, and column).
format = A format string for constructing the error message.
ap = A variable argument list used with the format string.
kind = The kind of error (error, warning, deprecation, note, or message).
executionSuccessful = `true` for an empty `results` array; `false` for detailed errors.
Throws:
@ -173,7 +211,7 @@ Throws:
See_Also:
$(LINK2 https://schemastore.azurewebsites.net/schemas/json/sarif-2.1.0.json, SARIF 2.1.0 schema)
*/
void generateSarifReport(const ref SourceLoc loc, const(char)* format, va_list ap, ErrorKind kind, bool executionSuccessful) nothrow
void generateSarifReport(bool executionSuccessful) nothrow
{
// Create an OutBuffer to store the SARIF report
OutBuffer ob;
@ -194,7 +232,6 @@ void generateSarifReport(const ref SourceLoc loc, const(char)* format, va_list a
string cleanedVersion = toolVersion[0 .. length];
// Build SARIF report
ob.level = 0;
ob.writestringln("{");
ob.level = 1;
@ -235,65 +272,30 @@ void generateSarifReport(const ref SourceLoc loc, const(char)* format, va_list a
ob.level -= 1;
ob.writestringln("}],");
// Empty results array for successful execution
if (executionSuccessful)
{
ob.writestringln(`"results": []`);
}
// Error information if execution was unsuccessful
else
{
// Format the error message
string formattedMessage = formatErrorMessage(format, ap);
// Results Array
ob.writestringln(`"results": [`);
ob.level += 1;
// Map ErrorKind to SARIF levels
const(char)* level;
string ruleId;
final switch (kind) {
case ErrorKind.error:
level = "error";
ruleId = "DMD-ERROR";
break;
case ErrorKind.warning:
level = "warning";
ruleId = "DMD-WARNING";
break;
case ErrorKind.deprecation:
level = "deprecation";
ruleId = "DMD-DEPRECATION";
break;
case ErrorKind.tip:
level = "note";
ruleId = "DMD-NOTE";
break;
case ErrorKind.message:
level = "none";
ruleId = "DMD-MESSAGE";
break;
}
// Results Array for errors
ob.writestringln(`"results": [{`);
foreach (idx, diag; diagnostics) {
ob.writestringln("{");
ob.level += 1;
// Rule ID
ob.writestring(`"ruleId": "`);
ob.writestring(ruleId);
ob.writestringln(`",`);
ob.writestring(`"ruleId": "DMD-` ~ errorKindToString(diag.kind) ~ `",`);
ob.writestringln("");
// Message Information
ob.writestringln(`"message": {`);
ob.level += 1;
ob.writestring(`"text": "`);
ob.writestring(formattedMessage.ptr);
ob.writestring(diag.message);
ob.writestringln(`"`);
ob.level -= 1;
ob.writestringln("},");
// Error Severity Level
ob.writestring(`"level": "`);
ob.writestring(level);
ob.writestringln(`",`);
ob.writestring(`"level": "` ~ errorKindToString(diag.kind) ~ `",`);
ob.writestringln("");
// Location Information
ob.writestringln(`"locations": [{`);
@ -305,7 +307,7 @@ void generateSarifReport(const ref SourceLoc loc, const(char)* format, va_list a
ob.writestringln(`"artifactLocation": {`);
ob.level += 1;
ob.writestring(`"uri": "`);
ob.writestring(loc.filename);
ob.writestring(diag.loc.filename);
ob.writestringln(`"`);
ob.level -= 1;
ob.writestringln("},");
@ -314,10 +316,10 @@ void generateSarifReport(const ref SourceLoc loc, const(char)* format, va_list a
ob.writestringln(`"region": {`);
ob.level += 1;
ob.writestring(`"startLine": `);
ob.printf(`%d,`, loc.linnum);
ob.printf(`%d,`, diag.loc.linnum);
ob.writestringln("");
ob.writestring(`"startColumn": `);
ob.printf(`%d`, loc.charnum);
ob.printf(`%d`, diag.loc.charnum);
ob.writestringln("");
ob.level -= 1;
ob.writestringln("}");
@ -327,14 +329,22 @@ void generateSarifReport(const ref SourceLoc loc, const(char)* format, va_list a
ob.writestringln("}");
ob.level -= 1;
ob.writestringln("}]");
// Closing brace for each diagnostic item
ob.level -= 1;
ob.writestringln("}]");
if (idx < diagnostics.length - 1) {
ob.writestringln("},");
} else {
ob.writestringln("}");
}
}
// Close the run and SARIF JSON
ob.level -= 1;
ob.writestringln("]");
ob.level -= 1;
ob.writestringln("}]");
ob.level = 0;
ob.level -= 1;
ob.writestringln("}");
// Extract the final null-terminated string and print it to stdout

3
compiler/test/compilable/sarif_success_test.d
View file

@ -16,7 +16,8 @@ TEST_OUTPUT:
"invocations": [{
"executionSuccessful": true
}],
"results": []
"results": [
]
}]
}
---

12
compiler/test/fail_compilation/sarif_test.d
View file

@ -16,24 +16,26 @@ TEST_OUTPUT:
"invocations": [{
"executionSuccessful": false
}],
"results": [{
"ruleId": "DMD-ERROR",
"results": [
{
"ruleId": "DMD-Error",
"message": {
"text": "undefined identifier `x`"
},
"level": "error",
"level": "Error",
"locations": [{
"physicalLocation": {
"artifactLocation": {
"uri": "fail_compilation/sarif_test.d"
},
"region": {
"startLine": 43,
"startLine": 45,
"startColumn": 5
}
}
}]
}]
}
]
}]
}
---

65
compiler/test/fail_compilation/sarifmultiple_test.d Normal file
View file

@ -0,0 +1,65 @@
// REQUIRED_ARGS: -verror-style=sarif
/*
TEST_OUTPUT:
---
{
"version": "2.1.0",
"$schema": "https://schemastore.azurewebsites.net/schemas/json/sarif-2.1.0.json",
"runs": [{
"tool": {
"driver": {
"name": "Digital Mars D",
"version": "$r:\d+\.\d+\.\d+$",
"informationUri": "https://dlang.org/dmd.html"
}
},
"invocations": [{
"executionSuccessful": false
}],
"results": [
{
"ruleId": "DMD-Error",
"message": {
"text": "undefined identifier `x`"
},
"level": "Error",
"locations": [{
"physicalLocation": {
"artifactLocation": {
"uri": "fail_compilation/sarifmultiple_test.d"
},
"region": {
"startLine": 63,
"startColumn": 5
}
}
}]
},
{
"ruleId": "DMD-Error",
"message": {
"text": "undefined identifier `y`"
},
"level": "Error",
"locations": [{
"physicalLocation": {
"artifactLocation": {
"uri": "fail_compilation/sarifmultiple_test.d"
},
"region": {
"startLine": 64,
"startColumn": 5
}
}
}]
}
]
}]
}
---
*/
void main() {
x = 5; // Undefined variable to trigger the error
y = 5; // Undefined variable to trigger the error
}