Page History

The assert() statement is a convenient mechanism for incorporating diagnostic tests in code. Expressions used with the standard assert statement must 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-operationop; any side effects resulting from evaluation of the expression in the assertion are lost when assertions are disabled. Consequently, programs expressions used with the standard assert statement must not use side-effecting expressions in assertionsproduce 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.

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.:

private ArrayList<String> names;

void process(int index) {
  boolean nullsRemoved = names.remove(null);
  assert nullsRemoved; // noNo side- effect 
  // ... 
}

Risk Assessment

Side effects in assertions results result in program behavior that depends on whether assertions are enabled or disabled.

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 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.

Bibliography

[Java Tutorials

2008

]	Programming With Assertions
[Seacord 2015]	Image Added IDS17-J. Prevent XML External Entity Attacks LiveLesson

...

Image Added Image Added Image AddedEXP05-J. Do not write more than once to the same variable within an expression      02. Expressions (EXP)      EXP07-J. Ensure that autoboxed values have the intended type