Create rule S7445: env! should be preferred over option_env! (#4789)

* Create rule S7445

* 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:
github-actions[bot] 2025-03-19 14:06:20 +01:00 committed by GitHub
parent c008bdb1a8
commit cb4497e15d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 50 additions and 0 deletions

View File

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

View File

@ -0,0 +1,24 @@
{
"title": "`env!` should be preferred over `option_env!`",
"type": "BUG",
"status": "ready",
"remediation": {
"func": "Constant\/Issue",
"constantCost": "5min"
},
"tags": [
"clippy"
],
"defaultSeverity": "Major",
"ruleSpecification": "RSPEC-7445",
"sqKey": "S7445",
"scope": "All",
"defaultQualityProfiles": ["Sonar way"],
"quickfix": "unknown",
"code": {
"impacts": {
"RELIABILITY": "LOW"
},
"attribute": "LOGICAL"
}
}

View File

@ -0,0 +1,24 @@
== Why is this an issue?
Unwrapping the result of `option_env!` will panic at runtime if the environment variable doesn't exist, whereas `env!` catches it at compile-time, ensuring safer code execution.
=== Code examples
==== Noncompliant code example
[source,rust,diff-id=1,diff-type=noncompliant]
---_
let _ = option_env!("HOME").unwrap(); // Noncompliant: Can panic at runtime.
---_
==== Compliant solution
[source,rust,diff-id=1,diff-type=compliant]
---_
let _ = env!("HOME"); // Compliant: Ensures compile-time checking.
---_
== Resources
=== Documentation
* Clippy Lints - https://rust-lang.github.io/rust-clippy/master/index.html#option_env_unwrap