validate-modules

分析模块中代码和文档中的常见问题。

用法

cd /path/to/ansible/source
source hacking/env-setup
ansible-test sanity --test validate-modules

帮助

键入 ansible-test sanity --test validate-modules -h 以显示使用此健全性测试的帮助信息。

扩展 validate-modules

validate-modules 工具有一个 schema.py 用于验证 YAML 块，例如 DOCUMENTATION 和 RETURNS。

代码

错误代码	类型	级别	示例消息
ansible-deprecated-module	文档	错误	模块已弃用，应该在当前或更早的 Ansible 版本中删除
collection-deprecated-module	文档	错误	模块已弃用，应该在当前或更早的集合版本中删除
ansible-deprecated-version	文档	错误	功能已弃用，应该在当前或更早的 Ansible 版本中删除
ansible-module-not-initialized	语法	错误	模块的执行未导致 AnsibleModule 的初始化
collection-deprecated-version	文档	错误	功能已弃用，应该在当前或更早的集合版本中删除
deprecated-date	文档	错误	早于今天的日期显示为 removed_at_date 或在 deprecated_aliases 中
deprecation-mismatch	文档	错误	模块在文件名、其元数据或 DOCUMENTATION 中至少一个地方被标记为已弃用或已删除（为弃用设置 DOCUMENTATION.deprecated 或为已删除删除所有文档），但在所有三个地方都没有。
doc-choices-do-not-match-spec	文档	错误	argument_spec 中“choices”的值与文档不匹配
doc-choices-incompatible-type	文档	错误	文档中的 Choices 值与 argument_spec 中定义的类型不兼容
doc-default-does-not-match-spec	文档	错误	argument_spec 中“default”的值与文档不匹配
doc-default-incompatible-type	文档	错误	文档中的默认值与 argument_spec 中定义的类型不兼容
doc-elements-invalid	文档	错误	文档为参数指定了元素，而“type”不是 list。
doc-elements-mismatch	文档	错误	Argument_spec 定义的元素与文档不同
doc-missing-type	文档	错误	文档未指定类型，但 argument_spec 中的参数使用默认类型 (str)
doc-required-mismatch	文档	错误	argument_spec 中的参数是必需的，但文档说不是，反之亦然
doc-type-does-not-match-spec	文档	错误	Argument_spec 定义的类型与文档不同
documentation-error	文档	错误	未知的 DOCUMENTATION 错误
documentation-syntax-error	文档	错误	无效的 DOCUMENTATION 架构
import-before-documentation	导入	错误	在文档变量之前发现导入。所有导入都必须出现在 DOCUMENTATION/EXAMPLES/RETURN 之后
import-error	文档	错误	尝试为 argument_spec 自省导入模块时出现 Exception
attributes-check-mode	文档	错误	如果模块记录了 check_mode 属性，则其 support 值必须与 AnsibleModule 的 supports_check_mode 参数兼容
attributes-check-mode-details	文档	错误	如果模块记录了 check_mode 属性，其支持值为 partial 或 N/A，则必须提供 details
import-placement	位置	警告	导入应该直接位于 DOCUMENTATION/EXAMPLES/RETURN 之后
imports-improper-location	导入	错误	导入应该直接位于 DOCUMENTATION/EXAMPLES/RETURN 之后
incompatible-choices	文档	错误	argument_spec 中的 Choices 值与 argument_spec 中定义的类型不兼容
incompatible-default-type	文档	错误	argument_spec 中的默认值与 argument_spec 中定义的类型不兼容
invalid-argument-name	文档	错误	argument_spec 中的参数不得为 'message'、'syslog_facility'，因为它们由 Ansible Core Engine 内部使用
invalid-argument-spec	文档	错误	使用时，argument_spec 中的参数必须是字典/哈希
invalid-argument-spec-options	文档	错误	argument_spec 中的子选项无效
invalid-documentation	文档	错误	DOCUMENTATION 不是有效的 YAML
invalid-documentation-markup	文档	错误	DOCUMENTATION 或 RETURN 包含无效的标记
invalid-documentation-options	文档	错误	DOCUMENTATION.options 使用时必须是字典/哈希
invalid-examples	文档	错误	EXAMPLES 不是有效的 YAML
invalid-extension	命名	错误	官方 Ansible 模块必须具有 .py 扩展名（用于 python 模块）或 .ps1 扩展名（用于 powershell 模块）
invalid-module-schema	文档	错误	AnsibleModule 架构验证错误
invalid-removal-version	文档	错误	无法解析预期删除功能的版本（对于集合，它必须是 语义版本）
invalid-requires-extension	命名	错误	模块 #AnsibleRequires -CSharpUtil 不应以 .cs 结尾，模块 #Requires 不应以 .psm1 结尾
missing-doc-fragment	文档	错误	DOCUMENTATION 片段丢失
missing-existing-doc-fragment	文档	警告	预先存在的 DOCUMENTATION 片段丢失
missing-documentation	文档	错误	未提供 DOCUMENTATION
missing-examples	文档	错误	未提供 EXAMPLES
missing-gplv3-license	文档	错误	未找到 GPLv3 许可证头
缺少模块实用程序基本导入	导入	警告	未找到 ansible.module_utils.basic 导入
缺少模块实用程序导入 C# 需求	导入	错误	未找到 Ansible.ModuleUtils 或 C# Ansible 实用程序需求/导入
缺少 PowerShell 解释器	语法	错误	解释器行不是 #!powershell
缺少 Python 解释器	语法	错误	解释器行不是 #!/usr/bin/python
缺少返回值	文档	错误	未提供 RETURN 文档
缺少旧版返回值	文档	警告	未为旧版模块提供 RETURN 文档
缺少子选项文档	文档	错误	argument_spec 中的参数具有子选项，但文档未定义子选项
模块版本添加不正确	文档	错误	模块级 version_added 不正确
模块版本添加无效	文档	错误	模块级 version_added 不是有效的版本号
模块实用程序特定导入	导入	错误	module_utils 导入应导入特定组件，而不是 *
每个需求多个实用程序	导入	错误	Ansible.ModuleUtils 需求不支持每个语句多个模块
每个需求多个 C# 实用程序	导入	错误	Ansible C# 实用程序需求不支持每个语句多个实用程序
必需参数没有默认值	文档	错误	选项标记为必需但指定了默认值。具有默认值的参数不应标记为必需
不需要日志	参数	错误	选项名称表明该选项包含一个秘密值，而 no_log 在参数规范中未为此选项指定。如果这是一个误报，请显式设置 no_log=False
不存在的参数已记录	文档	错误	参数在 DOCUMENTATION.options 中列出，但模块不接受
选项版本添加不正确	文档	错误	新选项的 version_added 不正确
选项版本添加无效	文档	错误	选项的 version_added 不是有效的版本号
参数无效	文档	错误	argument_spec 中的参数不是有效的 Python 标识符
参数元素无效	文档	错误	“elements”的值仅在“type”的值为 list 时有效
隐含参数类型不匹配	文档	错误	Argument_spec 隐含 type="str" 但文档将其定义为不同的数据类型
参数类型不在文档中	文档	错误	argument_spec 中定义了 Type 值，但文档未指定类型
参数别名重复	参数	错误	argument_spec 中的参数在别名中至少指定了一个重复的别名
参数自身是别名	参数	错误	argument_spec 中的参数被指定为其自身的别名
参数已记录多次	文档	错误	具有别名的 argument_spec 中的参数已记录多次
参数列表没有元素	参数	错误	argument_spec 中的参数“type”被指定为 list 且未定义“elements”
参数状态选择无效	参数	错误	参数 state 包括 get、list 或 info 作为选择。功能应位于 _info 或（如果适用其他条件）_facts 模块中。
Python 语法错误	语法	错误	解析模块时出现 Python SyntaxError
移除版本必须为主版本	文档	错误	根据语义版本控制规范 (https://semver.org/)，允许移除功能的唯一版本为主版本 (x.0.0)
返回值语法错误	文档	错误	RETURN 不是有效的 YAML，RETURN 片段丢失或无效
返回值版本添加无效	文档	错误	返回值的 version_added 不是有效的版本号
子目录缺少初始化	命名	错误	Ansible 模块子目录必须包含 __init__.py
缺少 try/except HAS 表达式	导入	警告	缺少 Try/Except HAS_ 表达式
未记录的参数	文档	错误	参数在 argument_spec 中列出，但在模块中未记录
不规范的类型检查	语法	错误	发现使用 type() 进行类型比较。请改用 isinstance()
未知文档片段	文档	警告	未知的预先存在的 DOCUMENTATION 错误
使用 boto3	导入	错误	发现 boto 导入，新模块应使用 boto3
使用 fail_json 而不是 sys.exit	导入	错误	发现 sys.exit() 调用。应为 exit_json/fail_json
使用模块实用程序 URL	导入	错误	发现 requests 导入，应改用 ansible.module_utils.urls
使用 run_command 而不是 os 调用	导入	错误	使用 os.call 而不是 module.run_command
使用 run_command 而不是 popen	导入	错误	使用 subprocess.Popen 而不是 module.run_command
使用简短的 GPLv3 许可证	文档	错误	GPLv3 许可证头对于新模块应为 简短形式
互斥类型	文档	错误	mutually_exclusive 条目包含非字符串值
互斥冲突	文档	错误	mutually_exclusive 条目具有重复的术语
互斥未知	文档	错误	mutually_exclusive 条目包含未出现在 argument_spec 中的选项（可能是选项的别名？）
必需之一类型	文档	错误	required_one_of 条目包含非字符串值
必需之一冲突	文档	错误	required_one_of 条目具有重复的术语
必需之一未知	文档	错误	required_one_of 条目包含未出现在 argument_spec 中的选项（可能是选项的别名？）
必需在一起类型	文档	错误	required_together 条目包含非字符串值
必需在一起冲突	文档	错误	required_together 条目具有重复的术语
必需在一起未知	文档	错误	required_together 条目包含未出现在 argument_spec 中的选项（可能是选项的别名？）
必需如果之一类型	文档	错误	required_if 条目具有第四个值，该值不是布尔值
必需如果需求类型	文档	错误	required_if 条目具有第三个值（需求），该值不是列表或元组
必需如果需求冲突	文档	错误	required_if 条目在需求中具有重复的术语
必需如果需求未知	文档	错误	required_if 条目的需求包含未出现在 argument_spec 中的选项（可能是选项的别名？）
必需如果未知键	文档	错误	required_if 条目的键未出现在 argument_spec 中（可能是选项的别名？）
必需如果键在需求中	文档	错误	required_if 条目在其需求列表/元组中包含其键
必需如果值类型	文档	错误	required_if 条目的值与其键指定的类型不符
被必需冲突	文档	错误	required_by 条目具有重复的术语
被必需未知	文档	错误	required_by 条目包含未出现在 argument_spec 中的选项（可能是选项的别名？）
版本添加必须为主版本或次版本	文档	错误	根据语义版本控制规范 (https://semver.org/)，允许添加功能的唯一版本为主版本和次版本 (x.y.0)