Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The assert() statement is a convenient mechanism for incorporating diagnostic tests in code. Expressions used with the standard assert statement should not have side effects. Typically, the The behavior of the assert statement depends on the status of a runtime property. If definedWhen enabled, the assert statement is defined to evaluate evaluates its expression argument and abort if the result of the expression is convertible to false. If undefinedthrows an AssertionError if false. When disabled, assert is defined to be a no-op. Consequently, ; any side effects resulting from evaluation of the expression in the assertion are lost in non-debugging versions of the code. Consequently, expressions used with the standard assert statement must not produce side effects.

Noncompliant Code Example

This noncompliant code attempts to delete all the null names from the list in an assertion. However, the Boolean expression is not evaluated when assertions are disabled.

Code Block
bgColor#ffcccc
private ArrayList<String> names;

void process(int index) {
  assert names.remove(null); /*/ sideSide effect */
  //* ... */
}

Compliant Solution

Avoid the The possibility of side effects in assertions .can be avoided by decoupling the Boolean expression from the assertion:

Code Block
bgColor#ccccff
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 unexpected and erroneous behaviorresult in program behavior that depends on whether assertions are enabled or disabled.

Rule

Severity

Likelihood

Remediation Cost

Priority

Level

EXP31

EXP06-J

low

Low

unlikely

Unlikely

low

Low

P3

L3

Related Vulnerabilities

Search for vulnerabilities resulting from the violation of this rule on the CERT website.

Other Languages

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 lack side effects.

ToolVersionCheckerDescription
CodeSonar
Include Page
CodeSonar_V
CodeSonar_V

JAVA.STRUCT.SE.ASSERT

Assertion Contains Side Effects (Java)

PVS-Studio

Include Page
PVS-Studio_V
PVS-Studio_V

V6055
SonarQube

Include Page
SonarQube_V
SonarQube_V

S3346Expressions used in "assert" should not produce side effects


Related Guidelines

...

...

This rule appears in the C++ Coding Standard as EXP31-CPP. Avoid side effects in assertions.

References

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.

Bibliography


...

Image Added Image Added Image Added[Tutorials 08] Programming With Assertions