The ansible-test’s validate-module sanity test that comes with ansible-core devel now has a new check for modules: it ensures that the set of option name and alias of a argument spec option corresponds to the same set of a documented option.
Until now only a match between the total set of options and aliases was checked: for example, if a module has two options foo
and bar
in the argument spec, and foo
has an alias baz
, the sanity check accepted if the documentation had two options foo
and bar
, where bar
had an alias baz
.
(This mismatch was basically caused by the lenient matching logic which allowed to document an alias of an argument spec option instead of the option itself. For example in the above case, it is also valid to document an option baz
with alias foo
, instead of foo
with an alias baz
.)