Skip to main content

utPLSQL tests should have descriptions

ZPA rule for PL/SQL and Oracle SQL · UtPlSqlTestShouldHaveDescription

utPLSQL accepts a test without a description and shows the procedure's name in its report. A description says what the test checks in plain words, which the report and its readers rely on.

This rule reports a %test without a description. A %displayname(description) on the test also counts, but %test(description) is preferred: utPLSQL documents %displayname as redundant.

Examples​

Noncompliant Code Example
create package crate_test as
--%suite
--%test -- Noncompliant
procedure creates_crate;
end;
Compliant Solution
create package crate_test as
--%suite
--%test(Creates a crate with the next free code)
procedure creates_crate;
end;