The assert()
statement is a convenient mechanism for incorporating diagnostic tests in code. Expressions used with the standard assert
statement should avoid side-effects. Typically, the The behavior of the assert
statement depends on the status of a runtime property. When enabled, the assert
statement is designed to evaluate evaluates its expression argument and throw throws an AssertionError
if the result of the expression is false. When disabled, assert
is defined to be a no-operation. Consequently, op; any side - effects resulting from evaluation of the expression in the assertion are lost when assertions are disabled. Consequently, expressions used with the standard assert
statement must not produce side effects.
Noncompliant Code Example
This noncompliant code example demonstrates an action being carried out in an assertion. The idea is attempts to delete all the null names from the list ; howeverin an assertion. However, the boolean
Boolean expression is unexpectedly not evaluated when assertions are disabled.
Code Block | ||
---|---|---|
| ||
private ArrayList<String> names; void process(int index) { assert names.remove(null); // side-Side effect // ... } |
Compliant Solution
Avoid the The possibility of side - effects in assertions . This can be achieved avoided by decoupling the boolean
Boolean expression from the assertion.:
Code Block | ||
---|---|---|
| ||
private ArrayList<String> names; void process(int index) { boolean nullsRemoved = names.remove(null); assert nullsRemoved; // noNo side- effect // ... } |
Risk Assessment
Side - effects in assertions can lead to differences result in program behavior that depend depends on whether assertions are enabled or disabled.
Rule | Severity | Likelihood | Remediation Cost | Priority | Level |
---|
EXP06-J |
Low |
Unlikely |
Low | P3 | L3 |
Automated Detection
Automated detection of assertion operands that contain locally - visible side - effects is straightforward. Some analyses could require programmer assistance to determine which method invocations could contain lack side - effects.
Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this guideline on the CERT website.
Related Guidelines
...
Tool | Version | Checker | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
CodeSonar |
| JAVA.STRUCT.SE.ASSERT | Assertion Contains Side Effects (Java) | ||||||
PVS-Studio |
| V6055 | |||||||
SonarQube |
| S3346 | Expressions used in "assert" should not produce side effects |
Related Guidelines
Android Implementation Details
The assert
statement is supported on the Dalvik VM but is ignored under the default configuration. Assertions may be enabled by setting the system property debug.assert
via: adb shell setprop debug.assert 1
or by sending the command-line argument --enable-assert
to the Dalvik VM. assertionsC++ Coding Standard: EXP31-CPP. Avoid side effects in assertions
Bibliography
...
...
EXP09-J. Do not allow an expression to write more than once to the same variable 04. Expressions (EXP) EXP11-J. Be careful of autoboxing when removing elements from a Collection