test: add edge case tests for diagnostics module#9316
Open
mattvaux wants to merge 2 commits intostarkware-libs:mainfrom
Open
test: add edge case tests for diagnostics module#9316mattvaux wants to merge 2 commits intostarkware-libs:mainfrom
mattvaux wants to merge 2 commits intostarkware-libs:mainfrom
Conversation
orizi
requested changes
Dec 24, 2025
Collaborator
orizi
left a comment
There was a problem hiding this comment.
@orizi made 3 comments.
Reviewable status: 0 of 1 files reviewed, 3 unresolved discussions (waiting on @mattvaux).
crates/cairo-lang-diagnostics/src/diagnostics_test.rs line 42 at r1 (raw file):
fn format(&self, _db: &dyn Database) -> String { self.message.clone() }
as not really used.
Suggestion:
file_id: FileId<'db>,
severity: Severity,
notes: Vec<DiagnosticNote<'db>>,
}
impl<'db> SimpleDiag<'db> {
fn new(file_id: FileId<'db>) -> Self {
Self { file_id, severity: Severity::Error, notes: vec![] }
}
fn with_severity(file_id: FileId<'db>, severity: Severity) -> Self {
Self { file_id, severity, notes: vec![] }
}
fn with_notes(file_id: FileId<'db>, notes: Vec<DiagnosticNote<'db>>) -> Self {
Self { file_id, severity: Severity::Error, notes }
}
}
impl<'db> DiagnosticEntry<'db> for SimpleDiag<'db> {
fn format(&self, _db: &dyn Database) -> String {
"Simple diagnostic.".into()
}crates/cairo-lang-diagnostics/src/diagnostics_test.rs line 48 at r1 (raw file):
file_id: self.file_id, span: TextSpan::new(TextOffset::START, TextWidth::new_for_testing(6).as_offset()), }
make the location somewhat configurable instead - to check duplications.
Code quote:
SpanInFile {
file_id: self.file_id,
span: TextSpan::new(TextOffset::START, TextWidth::new_for_testing(6).as_offset()),
}crates/cairo-lang-diagnostics/src/diagnostics_test.rs line 208 at r1 (raw file):
let formatted = diagnostics.build().format(&db_val); assert!(formatted.contains("note:")); assert!(formatted.contains("This is a note."));
Suggestion:
let formatted = diagnostics.build().format(&db_val);
assert_eq!(diagnostics.build().format(&db_val), indoc! {"
...
"});
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds 7 edge case tests for the diagnostics module, expanding coverage from 1 to 8 tests. Covers empty diagnostics, multiple diagnostics, severity handling, extend/merge operations, notes formatting, and duplicate filtering.
Type of change
Please check one:
Why is this change needed?
The diagnostics module is core infrastructure used across the compiler, but it had minimal test coverage—only one basic test. Critical methods like
is_empty(),has_errors(),extend(),merge(), andget_diagnostics_without_duplicates()lacked tests, creating risk of regressions.What was the behavior or documentation before?
Only one test (
test_diagnostics) verified basic formatting of a single error diagnostic.What is the behavior or documentation after?
8 tests covering empty diagnostics, multiple diagnostics, severity handling (warnings vs errors), extend/merge operations, notes formatting, and duplicate filtering.
Related issue or discussion (if any)
None.
Additional context
The diagnostics module is used throughout the Cairo compiler. These tests validate edge cases and help prevent regressions. All tests pass.