Create rule S7447: File open options should be consistent (#4791)
* Create rule S7447 * Update RSPEC --------- Co-authored-by: yassin-kammoun-sonarsource <yassin-kammoun-sonarsource@users.noreply.github.com> Co-authored-by: yassin-kammoun-sonarsource <yassin.kammoun@sonarsource.com>
This commit is contained in:
parent
b294a06b26
commit
0b46bc20f9
2
rules/S7447/metadata.json
Normal file
2
rules/S7447/metadata.json
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
{
|
||||||
|
}
|
24
rules/S7447/rust/metadata.json
Normal file
24
rules/S7447/rust/metadata.json
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
{
|
||||||
|
"title": "File open options should be consistent",
|
||||||
|
"type": "BUG",
|
||||||
|
"status": "ready",
|
||||||
|
"remediation": {
|
||||||
|
"func": "Constant\/Issue",
|
||||||
|
"constantCost": "5min"
|
||||||
|
},
|
||||||
|
"tags": [
|
||||||
|
"clippy"
|
||||||
|
],
|
||||||
|
"defaultSeverity": "Major",
|
||||||
|
"ruleSpecification": "RSPEC-7447",
|
||||||
|
"sqKey": "S7447",
|
||||||
|
"scope": "All",
|
||||||
|
"defaultQualityProfiles": ["Sonar way"],
|
||||||
|
"quickfix": "unknown",
|
||||||
|
"code": {
|
||||||
|
"impacts": {
|
||||||
|
"RELIABILITY": "HIGH"
|
||||||
|
},
|
||||||
|
"attribute": "LOGICAL"
|
||||||
|
}
|
||||||
|
}
|
28
rules/S7447/rust/rule.adoc
Normal file
28
rules/S7447/rust/rule.adoc
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
== Why is this an issue?
|
||||||
|
|
||||||
|
Using contradictory or nonsensical combinations of file open options, such as `read(true)` with `truncate(true)`, can lead to code that is confusing and harder to read. In some cases, it can result in runtime errors or undefined behavior, potentially causing data corruption or loss.
|
||||||
|
|
||||||
|
=== Code examples
|
||||||
|
|
||||||
|
==== Noncompliant code example
|
||||||
|
|
||||||
|
[source,rust,diff-id=1,diff-type=noncompliant]
|
||||||
|
----
|
||||||
|
use std::fs::OpenOptions;
|
||||||
|
|
||||||
|
OpenOptions::new().read(true).truncate(true); // Noncompliant: Invalid combination of file open options.
|
||||||
|
----
|
||||||
|
|
||||||
|
==== Compliant solution
|
||||||
|
|
||||||
|
[source,rust,diff-id=1,diff-type=compliant]
|
||||||
|
----
|
||||||
|
use std::fs::OpenOptions;
|
||||||
|
|
||||||
|
OpenOptions::new().write(true).truncate(true); // Compliant: Valid combination of file open options.
|
||||||
|
----
|
||||||
|
|
||||||
|
== Resources
|
||||||
|
=== Documentation
|
||||||
|
|
||||||
|
* Clippy Lints - https://rust-lang.github.io/rust-clippy/master/index.html#nonsensical_open_options
|
Loading…
x
Reference in New Issue
Block a user