step3.md

ansible-test

ansible-test is distributed as part of the ansible-base (and therefore ansible) package.

ansible-test supports three types of tests:

• Sanity
• Unit
• Integration

Although these tests may run automatically when sending a pull request (PR), we should run them locally to catch errors before sending new commits for review.

For this example we will be running the Sanity Tests, by doing:

ansible-test sanity --docker{{execute}}

We prefer to run the tests in Docker as it ensures all test dependencies are installed, and nothing pollutes the host operating system.

From the output of ansible-test, see there is a parameter-type-not-in-doc error for the mysql_user module (plugins/modules/mysql_user.py) like below:

ERROR: Found 1 validate-modules issue(s) which need to be resolved:
ERROR: plugins/modules/mysql_user.py:0:0: parameter-type-not-in-doc: Argument 'append_privs' inargument_spec defines type as 'bool' but documentation doesn't define type
See documentation for help: https://docs.ansible.com/ansible/2.10/dev_guide/testing/sanity/validate-modules.html
Running sanity test 'yamllint' with Python 3.6
ERROR: The 1 sanity test(s) listed below (out of 45) failed. See error output above for details.

Fix mysql_user.py

Now add the type for the append_privs parameter, in the documentation for the mysql_user module, by editing the plugins/modules/mysql_user.py file.

ansible_collections/community/mysql/plugins/modules/mysql_user.py{{open}}

We can see from line 1004 in that file append_privs=dict(type='bool', default=False),, so the documentation should say this is a bool (boolean).

Add a new line between existing 62 & 63 type: bool so the entry looks like:

  append_privs:
    description:
      - Append the privileges defined by priv to the existing ones for this
        user instead of overwriting existing ones.
    default: no
    type: bool

Once you've added the line, click the x on the top of the file name to edit the editor and save mysql_user.py

Validate the fix

Run again the sanity check to ensure the warning disappeared after the modification. ansible-test sanity --docker{{execute}}

You can also run sanity tests on a specific file to make it faster. ansible-test sanity plugins/modules/mysql_user.py --docker{{execute}}

If the test fails, reopen the file with the above command.