Create rule S7424 Avoid manual PartialEq implementation with a derived Hash (#4765)

* Create rule S7424

* Update rule.adoc

* Update metadata.json

---------

Co-authored-by: sallaigy <sallaigy@users.noreply.github.com>
Co-authored-by: Gyula Sallai <gyula.sallai@sonarsource.com>
This commit is contained in:
github-actions[bot] 2025-03-19 14:09:42 +00:00 committed by GitHub
parent b16523921f
commit c83072239e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 59 additions and 0 deletions

View File

@ -0,0 +1,2 @@
{
}

View File

@ -0,0 +1,24 @@
{
"title": "Avoid manual PartialEq implementation with a derived Hash",
"type": "BUG",
"status": "ready",
"remediation": {
"func": "Constant\/Issue",
"constantCost": "5min"
},
"tags": [
"clippy"
],
"defaultSeverity": "Critical",
"ruleSpecification": "RSPEC-7424",
"sqKey": "S7424",
"scope": "All",
"defaultQualityProfiles": ["Sonar way"],
"quickfix": "unknown",
"code": {
"impacts": {
"RELIABILITY": "HIGH"
},
"attribute": "LOGICAL"
}
}

View File

@ -0,0 +1,33 @@
== Why is this an issue?
Having a manual `PartialEq` implementation for types with a derived `Hash` can lead to inconsistencies. The contract `k1 == k2 ⇒ hash(k1) == hash(k2)` must always hold. Inconsistencies can cause undefined behaviors, especially when these types are used in collections such as `HashMap`.
=== Code examples
==== Noncompliant code example
[source,rust,diff-id=1,diff-type=noncompliant]
----
#[derive(Hash)]
struct Foo;
impl PartialEq for Foo {
fn eq(&self, other: &Self) -> bool {
// Some custom equality logic
true // Noncompliant
}
}
----
==== Compliant solution
[source,rust,diff-id=1,diff-type=compliant]
----
#[derive(Hash, PartialEq)]
struct Foo;
----
== Resources
=== Documentation
* Clippy Lints - https://rust-lang.github.io/rust-clippy/master/index.html#derived_hash_with_manual_eq