Ignore SPDX and contract size for tests (#775)

* Filter for unignored warnings

* Pass compiler output to diagnostics

* Ignore SPDX and contract size warnings for tests

* Fix lint

* Skip lookups if error is not a warning
This commit is contained in:
Bjerg 2022-01-08 21:26:23 +01:00 committed by GitHub
parent 8ddf111560
commit 48bd3f13e2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 42 additions and 11 deletions

View File

@ -537,12 +537,18 @@ impl CompilerOutput {
} }
/// Whether the output contains a compiler warning /// Whether the output contains a compiler warning
pub fn has_warning(&self) -> bool { pub fn has_warning(&self, ignored_error_codes: &[u64]) -> bool {
self.errors.iter().any(|err| err.severity.is_warning()) self.errors.iter().any(|err| {
if err.severity.is_warning() {
err.error_code.as_ref().map_or(false, |code| !ignored_error_codes.contains(code))
} else {
false
}
})
} }
pub fn diagnostics<'a>(&'a self, ignored_error_codes: &'a [u64]) -> OutputDiagnostics { pub fn diagnostics<'a>(&'a self, ignored_error_codes: &'a [u64]) -> OutputDiagnostics {
OutputDiagnostics { errors: &self.errors, ignored_error_codes } OutputDiagnostics { compiler_output: self, ignored_error_codes }
} }
/// Finds the _first_ contract with the given name /// Finds the _first_ contract with the given name
@ -683,19 +689,29 @@ impl OutputContracts {
/// Helper type to implement display for solc errors /// Helper type to implement display for solc errors
#[derive(Clone, Debug)] #[derive(Clone, Debug)]
pub struct OutputDiagnostics<'a> { pub struct OutputDiagnostics<'a> {
errors: &'a [Error], compiler_output: &'a CompilerOutput,
ignored_error_codes: &'a [u64], ignored_error_codes: &'a [u64],
} }
impl<'a> OutputDiagnostics<'a> { impl<'a> OutputDiagnostics<'a> {
/// Returns true if there is at least one error of high severity /// Returns true if there is at least one error of high severity
pub fn has_error(&self) -> bool { pub fn has_error(&self) -> bool {
self.errors.iter().any(|err| err.severity.is_error()) self.compiler_output.has_error()
} }
/// Returns true if there is at least one warning /// Returns true if there is at least one warning
pub fn has_warning(&self) -> bool { pub fn has_warning(&self) -> bool {
self.errors.iter().any(|err| err.severity.is_warning()) self.compiler_output.has_warning(self.ignored_error_codes)
}
fn is_test<T: AsRef<str>>(&self, contract_path: T) -> bool {
if contract_path.as_ref().ends_with(".t.sol") {
return true
}
self.compiler_output.find(&contract_path).map_or(false, |contract| {
contract.abi.map_or(false, |abi| abi.functions.contains_key("IS_TEST"))
})
} }
} }
@ -708,10 +724,22 @@ impl<'a> fmt::Display for OutputDiagnostics<'a> {
} else { } else {
f.write_str("Compiler run successful")?; f.write_str("Compiler run successful")?;
} }
for err in self.errors { for err in &self.compiler_output.errors {
// Do not log any ignored error codes if err.severity.is_warning() {
if let Some(error_code) = err.error_code { let is_ignored = err.error_code.as_ref().map_or(false, |code| {
if !self.ignored_error_codes.contains(&error_code) { if let Some(source_location) = &err.source_location {
// we ignore spdx and contract size warnings in test
// files. if we are looking at one of these warnings
// from a test file we skip
if self.is_test(&source_location.file) && (*code == 1878 || *code == 5574) {
return true
}
}
self.ignored_error_codes.contains(code)
});
if !is_ignored {
writeln!(f, "\n{}", err)?; writeln!(f, "\n{}", err)?;
} }
} else { } else {

View File

@ -779,7 +779,10 @@ impl<T: ArtifactOutput> ProjectCompileOutput<T> {
/// Whether there were warnings /// Whether there were warnings
pub fn has_compiler_warnings(&self) -> bool { pub fn has_compiler_warnings(&self) -> bool {
self.compiler_output.as_ref().map(|o| o.has_warning()).unwrap_or_default() self.compiler_output
.as_ref()
.map(|o| o.has_warning(&self.ignored_error_codes))
.unwrap_or_default()
} }
/// Finds the first contract with the given name and removes it from the set /// Finds the first contract with the given name and removes it from the set