Tidy up validate-modules nonexistent-parameter-documented

[russoz]

SUMMARY

Tidy up on sanity tests' ignore files, removing lines with validation-modules for these modules.

The focus was to pass the tests so no code was changed other than adjusting argument_spec for missing types or inconsistencies with the docs. The priority has been not to change any functionality, but to ensure that code and docs are synchronized.

Some lines were added back to the files, but a total of 17 lines were removed (among 2.9, 2.10 and 2.11).

ISSUE TYPE

• Docs Pull Request

COMPONENT NAME

plugins/modules/storage/zfs/zpool_facts.py
plugins/modules/storage/zfs/zfs_facts.py
plugins/modules/net_tools/nios/nios_host_record.py
plugins/modules/cloud/univention/udm_share.py
plugins/modules/cloud/spotinst/spotinst_aws_elastigroup.py

ADDITIONAL INFORMATION

[felixfontein]

The first three modules also have undocumented-parameter. Maybe there's a typo/other discrepancy in the option name?

[ansibullbot]

cc @NilashishC @Qalthos @bcoca @danielmellado @fishman @ganeshrn @jasperla @jpdasma @justjais @keachi @mator @nerzhul @privateip @scathatheworm @sganesh-infoblox @talzur @trishnaguha @troy2914 @xen0l
click here for bot help

[ansibullbot]

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

plugins/modules/notification/grove.py:0:0: nonexistent-parameter-documented: Argument 'message' is listed in DOCUMENTATION.options, but not accepted by the module argument_spec

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

plugins/modules/notification/grove.py:0:0: nonexistent-parameter-documented: Argument 'message' is listed in DOCUMENTATION.options, but not accepted by the module argument_spec

click here for bot help

[russoz]

@felixfontein @keachi thanks for reviewing! Will update the samba option soon.

In the meanwhile, any idea what's going on with grove.py?

    module = AnsibleModule(
        argument_spec=dict(
            channel_token=dict(type='str', required=True, no_log=True),
            message=dict(type='str', required=True),
            service=dict(type='str', default='ansible'),
            url=dict(type='str', default=None),
            icon_url=dict(type='str', default=None),
            validate_certs=dict(default=True, type='bool'),
        )
    )

Parameter message is accepted in the module argument_spec.

[felixfontein]

@russoz that's because message is an invalid option name (see the other ignore.txt entry). It's interesting that this wasn't fixed, because this way, the module probably will not work at all.

[felixfontein]

Looks like some modules have this problem. Here's the original PR that fixed some, and added the sanity test: https://github.com/ansible/ansible/pull/60051/files

[ansibullbot]

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

tests/sanity/ignore-2.9.txt:197:1: A100: Ignoring 'undocumented-parameter' on 'plugins/modules/cloud/univention/udm_share.py' is unnecessary

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

tests/sanity/ignore-2.10.txt:227:1: A100: Ignoring 'undocumented-parameter' on 'plugins/modules/cloud/univention/udm_share.py' is unnecessary

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

tests/sanity/ignore-2.11.txt:227:1: A100: Ignoring 'undocumented-parameter' on 'plugins/modules/cloud/univention/udm_share.py' is unnecessary

click here for bot help

[felixfontein]

@russoz thanks for fixing this!
@keachi thanks for reviewing!

[russoz]

Thanks you both

On Fri, 27 Nov 2020 at 12:28 AM, Felix Fontein ***@***.***> wrote: @russoz <https://github.com/russoz> thanks for fixing this! @keachi <https://github.com/keachi> thanks for reviewing! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1389 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAZFRVOO2NZ7F4EJ4YZOALSRY3U3ANCNFSM4UCEPJMA> .

-- Alexei Znamensky | russoz gmail com http://github.com/russoz