测试插件文档

开发时的一个快速测试是使用 ansible-doc -t <plugin_type> <name> 来查看它是否呈现,如果模块不在 Ansible 期望找到它的位置,你可能需要添加 -M /path/to/module

在提交插件以包含在 ansible-core 中之前,你必须运行测试以确保 argspec 与 Python 文件中的文档匹配,并且 argspec 和文档的结构正确。

如果你使用其他 RST 文件扩展 Ansible 文档,社区页面会提供关于 本地测试 reStructuredText 文档的更多信息。

要确保你的模块文档与你的 argument_spec 匹配

  1. 安装所需的 Python 包 (在 venv/virtualenv 中删除 '–user')

    pip install --user -r test/lib/ansible_test/_data/requirements/sanity.txt
    
  2. 运行 validate-modules 测试

    ansible-test sanity --test validate-modules mymodule
    

如果你安装了 Docker 或 Podman,你也可以将它们与 --docker 选项一起使用,该选项使用一个已经安装了所有要求的镜像

ansible-test sanity --docker --test validate-modules mymodule

对于其他插件类型,步骤类似,只需调整名称和路径为特定类型即可。