search

ansible-collections / ibm_zos_core

Red Hat Ansible Certified Content for IBM Z
75 stars 44 forks source link

[Enabler] [Epic] Review all ignore entries and update modules to reduce the ignore entries. #811

Open ddimatos opened 1 year ago

ddimatos commented 1 year ago

Is there an existing issue for this?

Ansible module

No response

Enabler description

After running ansible-lint in preparation for 2.15 certification the linter flagged our ignore entries. It is time we revisit the ignore entries although they cause no issue for our users, they do put us a risk of certification but more so, added noise.

Quickly scanning I could see we have quite a bit of work to do here, it should not be complicated mostly updating the code to match the arg spec and possibly the better_arg_parser. I also see many variables passed from plugins to the modules where those variables are not part of the arg spec that sanity flags them and we have them in the ignore entry. I think we could try to remove them from the arg spec or pass only the vars the module expects instead of introducing new vars simply for invocation.

The issue is that we do have ignore entries that would look without explanation questionable; most of the ignore entries are a result of trying to use one module_spec, meaning we pass the same spec to AnsibleModule and our own parser. Where our parser will invoke rules to ensure they meet the needs of z/OS. For example, a type=str in our case needs extra validation across all our modules for data set names so we have one parser for all them.

Below is a list of the offending ones ansible-lint found and I extracted the ignore entry below with comments as to why they are ignored.

Version 6.14.3:

                   Rule Violation Summary
 count tag                  profile   rule associated tags
  111 sanity[cannot-ignore] production experimental (warning)

Passed with shared profile, 4/5 star rating: 0 failure(s), 111 warning(s) on 63 files.
A new release of ansible-lint is available: 6.14.3 → 6.17.1 Upgrade by running: pip install --upgrade ansible-lint

Version 6.17.1:

                 Rule Violation Summary
 count tag                  profile   rule associated tags
   96 sanity[cannot-ignore] production idiom

Failed: 96 failure(s), 0 warning(s) on 63 files. Last profile that met the validation criteria was 'shared'. Rating: 4/5 star

ignore-txt entry: plugins/modules/zos_copy.py validate-modules:doc-type-does-not-match-spec # doc type should be str, while spec type is path to allow user path expansion


- [x] 2) '**issue**: #990

ansible-lint error: tests/sanity/ignore-2.14.txt:6: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 6, which is not a permitted ignore. tests/sanity/ignore-2.15.txt:6: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 6, which is not a permitted ignore. tests/sanity/ignore-2.16.txt:6: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 6, which is not a permitted ignore.

ignore-txt entry: plugins/modules/zos_copy.py validate-modules:parameter-type-not-in-doc # Passing args from action plugin


- [x] 3) **issue**: #991

ansible-lint error: tests/sanity/ignore-2.14.txt:7: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 7, which is not a permitted ignore. tests/sanity/ignore-2.15.txt:7: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 7, which is not a permitted ignore. tests/sanity/ignore-2.16.txt:7: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 7, which is not a permitted ignore.

ignore-txt entry: plugins/modules/zos_copy.py validate-modules:undocumented-parameter # Passing args from action plugin


- [x] 4) **issue**: #992

ansible-lint error: tests/sanity/ignore-2.14.txt:8: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 8, which is not a permitted ignore. tests/sanity/ignore-2.15.txt:8: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 8, which is not a permitted ignore. tests/sanity/ignore-2.16.txt:8: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 8, which is not a permitted ignore.

ignore-txt entry: plugins/modules/zos_data_set.py validate-modules:doc-choices-do-not-match-spec # We use our own argument parser for advanced conditional and dependent arguments.


- [x] 5)  **issue**: #993

ansible-lint error: tests/sanity/ignore-2.14.txt:9: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 9, which is not a permitted ignore. tests/sanity/ignore-2.15.txt:9: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 9, which is not a permitted ignore. tests/sanity/ignore-2.16.txt:9: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 9, which is not a permitted ignore.

ignore-txt entry: plugins/modules/zos_data_set.py validate-modules:doc-type-does-not-match-spec # Have to use raw here for backwards compatibility with old module args, but would confuse current users if exposed.


- [x] 6) **issue**: #994

ansible-lint error: tests/sanity/ignore-2.14.txt:11: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 11, which is not a permitted ignore. tests/sanity/ignore-2.15.txt:11: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 11, which is not a permitted ignore. tests/sanity/ignore-2.16.txt:11: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 11, which is not a permitted ignore.

ignore-txt entry: plugins/modules/zos_data_set.py validate-modules:undocumented-parameter # Keep aliases to match behavior of old module spec, but some aliases were functionally inaccurate, and detailing in docs would only confuse user.


- [x] 7) **issue**: #995

ansible-lint error: tests/sanity/ignore-2.14.txt:14: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 14, which is not a permitted ignore. tests/sanity/ignore-2.15.txt:14: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 14, which is not a permitted ignore. tests/sanity/ignore-2.16.txt:14: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 14, which is not a permitted ignore.

ignore-txt entry: plugins/modules/zos_fetch.py validate-modules:parameter-type-not-in-doc # Passing args from action plugin


- [x] 8) **issue**: #996

ansible-lint error: tests/sanity/ignore-2.14.txt:15: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 15, which is not a permitted ignore. tests/sanity/ignore-2.15.txt:15: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 15, which is not a permitted ignore. tests/sanity/ignore-2.16.txt:15: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 15, which is not a permitted ignore.

ignore-txt entry: plugins/modules/zos_fetch.py validate-modules:undocumented-parameter # Passing args from action plugin


- [x] 9) **issue**: #997

ansible-lint error: tests/sanity/ignore-2.15.txt:22: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 22, which is not a permitted ignore.

ignore-txt entry: plugins/modules/zos_job_submit.py validate-modules:parameter-type-not-in-doc # Passing args from action plugin


- [x] 10) **issue**: #998

ansible-lint error: tests/sanity/ignore-2.15.txt:23: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 23, which is not a permitted ignore.

ignore-txt entry: plugins/modules/zos_job_submit.py validate-modules:undocumented-parameter # Passing args from action plugin


- [x] 11) **issue**: #999

ansible-lint error: tests/sanity/ignore-2.15.txt:24: sanity[cannot-ignore]: Ignore file contains pylint:catching-non-exception at line 24, which is not a permitted ignore.

ignore-txt entry: plugins/modules/zos_job_submit.py pylint:catching-non-exception # False positive, Exception is inherited


- [x] 12) **issue**: #1197

ansible-lint error: tests/sanity/ignore-2.14.txt:2: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 2, which is not a permitted ignore. tests/sanity/ignore-2.15.txt:2: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 2, which is not a permitted ignore. tests/sanity/ignore-2.16.txt:2: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 2, which is not a permitted ignore.

ignore-txt entry: plugins/modules/zos_backup_restore.py validate-modules:doc-choices-do-not-match-spec # We use our own argument parser for advanced conditional and dependent arguments.


- [-] 13) **issue**: #1000 - Depends on [79784](https://github.com/ansible/ansible/issues/79784), and [82604](https://github.com/ansible/ansible/issues/82604) , thus this will need a certification exemption

ansible-lint error: tests/sanity/ignore-2.14.txt:26: sanity[cannot-ignore]: Ignore file contains validate-modules:invalid-extension at line 26, which is not a permitted ignore. tests/sanity/ignore-2.15.txt:26: sanity[cannot-ignore]: Ignore file contains validate-modules:invalid-extension at line 26, which is not a permitted ignore. tests/sanity/ignore-2.16.txt:26: sanity[cannot-ignore]: Ignore file contains validate-modules:invalid-extension at line 26, which is not a permitted ignore.

ignore-txt entry: plugins/modules/zos_ping.rexx validate-modules:invalid-extension # Opened issue https://github.com/ansible/ansible/issues/79784


- [-] 14) **issue**:   #1001 - Depends on [79784](https://github.com/ansible/ansible/issues/79784), and [82604](https://github.com/ansible/ansible/issues/82604) , thus this will need a certification exemption

ansible-lint error: tests/sanity/ignore-2.14.txt:27: sanity[cannot-ignore]: Ignore file contains validate-modules:python-syntax-error at line 27, which is not a permitted ignore. tests/sanity/ignore-2.15.txt:27: sanity[cannot-ignore]: Ignore file contains validate-modules:python-syntax-error at line 27, which is not a permitted ignore. tests/sanity/ignore-2.16.txt:27: sanity[cannot-ignore]: Ignore file contains validate-modules:python-syntax-error at line 27, which is not a permitted ignore.

ignore-txt entry: plugins/modules/zos_ping.rexx validate-modules:python-syntax-error # Opened issue https://github.com/ansible/ansible/issues/79784

ddimatos commented 1 year ago

This item will become a blocker for certification by the time AAP releases version 2.5.

ddimatos commented 1 year ago

You can run lint in our tooling with: Option 1: ./ac --ac-lint

Option 2:

./ac --venv-start
(venv-2.15) ansible-lint -c .ansible-lint --profile production
ddimatos commented 1 year ago

Full list is here:

tests/sanity/ignore-2.11.txt:16: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 16, which is not a permitted ignore.
tests/sanity/ignore-2.11.txt:23: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-default-does-not-match-spec at line 23, which is not a permitted ignore.
tests/sanity/ignore-2.11.txt:24: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 24, which is not a permitted ignore.
tests/sanity/ignore-2.11.txt:26: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 26, which is not a permitted ignore.
tests/sanity/ignore-2.11.txt:27: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 27, which is not a permitted ignore.
tests/sanity/ignore-2.11.txt:30: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 30, which is not a permitted ignore.
tests/sanity/ignore-2.11.txt:31: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 31, which is not a permitted ignore.
tests/sanity/ignore-2.11.txt:33: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 33, which is not a permitted ignore.
tests/sanity/ignore-2.11.txt:40: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 40, which is not a permitted ignore.
tests/sanity/ignore-2.11.txt:41: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 41, which is not a permitted ignore.
tests/sanity/ignore-2.11.txt:56: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 56, which is not a permitted ignore.
tests/sanity/ignore-2.11.txt:57: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 57, which is not a permitted ignore.
tests/sanity/ignore-2.11.txt:58: sanity[cannot-ignore]: Ignore file contains pylint:catching-non-exception at line 58, which is not a permitted ignore.
tests/sanity/ignore-2.12.txt:16: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 16, which is not a permitted ignore.
tests/sanity/ignore-2.12.txt:23: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-default-does-not-match-spec at line 23, which is not a permitted ignore.
tests/sanity/ignore-2.12.txt:24: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 24, which is not a permitted ignore.
tests/sanity/ignore-2.12.txt:26: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 26, which is not a permitted ignore.
tests/sanity/ignore-2.12.txt:27: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 27, which is not a permitted ignore.
tests/sanity/ignore-2.12.txt:30: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 30, which is not a permitted ignore.
tests/sanity/ignore-2.12.txt:31: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 31, which is not a permitted ignore.
tests/sanity/ignore-2.12.txt:33: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 33, which is not a permitted ignore.
tests/sanity/ignore-2.12.txt:40: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 40, which is not a permitted ignore.
tests/sanity/ignore-2.12.txt:41: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 41, which is not a permitted ignore.
tests/sanity/ignore-2.12.txt:56: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 56, which is not a permitted ignore.
tests/sanity/ignore-2.12.txt:57: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 57, which is not a permitted ignore.
tests/sanity/ignore-2.12.txt:58: sanity[cannot-ignore]: Ignore file contains pylint:catching-non-exception at line 58, which is not a permitted ignore.
tests/sanity/ignore-2.13.txt:2: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 2, which is not a permitted ignore.
tests/sanity/ignore-2.13.txt:5: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-default-does-not-match-spec at line 5, which is not a permitted ignore.
tests/sanity/ignore-2.13.txt:6: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 6, which is not a permitted ignore.
tests/sanity/ignore-2.13.txt:8: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 8, which is not a permitted ignore.
tests/sanity/ignore-2.13.txt:9: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 9, which is not a permitted ignore.
tests/sanity/ignore-2.13.txt:10: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 10, which is not a permitted ignore.
tests/sanity/ignore-2.13.txt:11: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 11, which is not a permitted ignore.
tests/sanity/ignore-2.13.txt:13: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 13, which is not a permitted ignore.
tests/sanity/ignore-2.13.txt:16: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 16, which is not a permitted ignore.
tests/sanity/ignore-2.13.txt:17: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 17, which is not a permitted ignore.
tests/sanity/ignore-2.13.txt:22: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 22, which is not a permitted ignore.
tests/sanity/ignore-2.13.txt:23: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 23, which is not a permitted ignore.
tests/sanity/ignore-2.13.txt:24: sanity[cannot-ignore]: Ignore file contains pylint:catching-non-exception at line 24, which is not a permitted ignore.
tests/sanity/ignore-2.13.txt:31: sanity[cannot-ignore]: Ignore file contains validate-modules:invalid-extension at line 31, which is not a permitted ignore.
tests/sanity/ignore-2.13.txt:32: sanity[cannot-ignore]: Ignore file contains validate-modules:python-syntax-error at line 32, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:2: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 2, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:5: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-default-does-not-match-spec at line 5, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:6: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 6, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:8: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 8, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:9: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 9, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:10: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 10, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:11: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 11, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:13: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 13, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:16: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 16, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:17: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 17, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:22: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 22, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:23: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 23, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:24: sanity[cannot-ignore]: Ignore file contains pylint:catching-non-exception at line 24, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:31: sanity[cannot-ignore]: Ignore file contains validate-modules:invalid-extension at line 31, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:32: sanity[cannot-ignore]: Ignore file contains validate-modules:python-syntax-error at line 32, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:2: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 2, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:5: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-default-does-not-match-spec at line 5, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:6: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 6, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:8: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 8, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:9: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 9, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:10: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 10, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:11: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 11, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:13: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 13, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:16: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 16, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:17: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 17, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:22: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 22, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:23: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 23, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:24: sanity[cannot-ignore]: Ignore file contains pylint:catching-non-exception at line 24, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:31: sanity[cannot-ignore]: Ignore file contains validate-modules:invalid-extension at line 31, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:32: sanity[cannot-ignore]: Ignore file contains validate-modules:python-syntax-error at line 32, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:2: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 2, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:5: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-default-does-not-match-spec at line 5, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:6: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 6, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:8: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 8, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:9: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 9, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:10: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 10, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:11: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 11, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:13: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 13, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:16: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 16, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:17: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 17, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:22: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 22, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:23: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 23, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:24: sanity[cannot-ignore]: Ignore file contains pylint:catching-non-exception at line 24, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:31: sanity[cannot-ignore]: Ignore file contains validate-modules:invalid-extension at line 31, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:32: sanity[cannot-ignore]: Ignore file contains validate-modules:python-syntax-error at line 32, which is not a permitted ignore.
tests/sanity/ignore-2.9.txt:16: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 16, which is not a permitted ignore.
tests/sanity/ignore-2.9.txt:23: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 23, which is not a permitted ignore.
tests/sanity/ignore-2.9.txt:25: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 25, which is not a permitted ignore.
tests/sanity/ignore-2.9.txt:26: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 26, which is not a permitted ignore.
tests/sanity/ignore-2.9.txt:29: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 29, which is not a permitted ignore.
tests/sanity/ignore-2.9.txt:30: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 30, which is not a permitted ignore.
tests/sanity/ignore-2.9.txt:32: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 32, which is not a permitted ignore.
tests/sanity/ignore-2.9.txt:39: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 39, which is not a permitted ignore.
tests/sanity/ignore-2.9.txt:40: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 40, which is not a permitted ignore.
tests/sanity/ignore-2.9.txt:55: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 55, which is not a permitted ignore.
tests/sanity/ignore-2.9.txt:56: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 56, which is not a permitted ignore.
tests/sanity/ignore-2.9.txt:57: sanity[cannot-ignore]: Ignore file contains pylint:catching-non-exception at line 57, which is not a permitted ignore.
Read documentation for instructions on how to ignore specific rule violations.

                         Rule Violation Summary
 count tag                               profile    rule associated tags
     1 meta-runtime[unsupported-version] shared     metadata
    98 sanity[cannot-ignore]             production idiom

Failed: 99 failure(s), 0 warning(s) on 64 files. Profile 'production' was required, but only 'safety' profile passed. Rating: 3/5 star
ddimatos commented 1 year ago

This item would be best broken down into smaller units of work and more often run through our pipeline to avoid running a full regression. We have until the end of the year to complete this, it would be ok to push this to Q4 as it would meet the Red Hat requirement.

ddimatos commented 5 months ago

Transferring this to Q1 2024 as there are a few pending carry over items still being worked on for this epic. Status is that #994, #995, #996 which corresponds to sanity 4,5 and 6 are currently in progress , where #995 and #996 corresponding to sanity 7 and 8 will be postponed to a later date in Q1 if capacity is available (possibly not making into the 1.9 GA) else they will be carried over to Q2 2024.

ddimatos commented 5 months ago

Latest stats as we prepare version 1.9.0-beta.1:

~/git/gh/ibm_zos_core $: ././ac --ac-lint
-----------------------------------------------------------------------
Linting with ansible-lint on GH branch: 'staging-v1.9.0-beta.1'.
-----------------------------------------------------------------------
INFO     Running ansible-galaxy collection install -v -r collections/requirements.yml -p /Users/ddimatos/.cache/ansible-compat/6109a3/collections
INFO     Set ANSIBLE_LIBRARY=/Users/ddimatos/.cache/ansible-compat/6109a3/modules:plugins/modules:/Users/ddimatos/.ansible/collections/ansible_collections/ibm/ibm_zos_core/plugins/modules:/Users/ddimatos/.ansible/collections/ansible_collections/ibm/ibm_zos_core/plugins/modules
INFO     Set ANSIBLE_COLLECTIONS_PATH=/Users/ddimatos/.cache/ansible-compat/6109a3/collections:/Users/ddimatos/.ansible/collections:/usr/share/ansible/collections
INFO     Set ANSIBLE_ROLES_PATH=/Users/ddimatos/.cache/ansible-compat/6109a3/roles:/Users/ddimatos/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles
INFO     Running from /Users/ddimatos/git/gh/ibm_zos_core : ansible-galaxy collection install -vvv --force -p /Users/ddimatos/.cache/ansible-compat/6109a3/collections .
INFO     Discovered files to lint using: git -c safe.directory=/Users/ddimatos/git/gh/ibm_zos_core ls-files --cached --others --exclude-standard -z
INFO     Excluded removed files using: git -c safe.directory=/Users/ddimatos/git/gh/ibm_zos_core ls-files --deleted -z
WARNING  Listing 30 violation(s) that are fatal
tests/sanity/ignore-2.14.txt:2: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 2, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:6: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 6, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:7: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 7, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:8: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 8, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:9: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 9, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:11: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 11, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:14: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 14, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:15: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 15, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:26: sanity[cannot-ignore]: Ignore file contains validate-modules:invalid-extension at line 26, which is not a permitted ignore.
tests/sanity/ignore-2.14.txt:27: sanity[cannot-ignore]: Ignore file contains validate-modules:python-syntax-error at line 27, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:2: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 2, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:6: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 6, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:7: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 7, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:8: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 8, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:9: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 9, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:11: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 11, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:14: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 14, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:15: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 15, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:26: sanity[cannot-ignore]: Ignore file contains validate-modules:invalid-extension at line 26, which is not a permitted ignore.
tests/sanity/ignore-2.15.txt:27: sanity[cannot-ignore]: Ignore file contains validate-modules:python-syntax-error at line 27, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:2: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 2, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:6: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 6, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:7: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 7, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:8: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-choices-do-not-match-spec at line 8, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:9: sanity[cannot-ignore]: Ignore file contains validate-modules:doc-type-does-not-match-spec at line 9, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:11: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 11, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:14: sanity[cannot-ignore]: Ignore file contains validate-modules:parameter-type-not-in-doc at line 14, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:15: sanity[cannot-ignore]: Ignore file contains validate-modules:undocumented-parameter at line 15, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:26: sanity[cannot-ignore]: Ignore file contains validate-modules:invalid-extension at line 26, which is not a permitted ignore.
tests/sanity/ignore-2.16.txt:27: sanity[cannot-ignore]: Ignore file contains validate-modules:python-syntax-error at line 27, which is not a permitted ignore.
Read documentation for instructions on how to ignore specific rule violations.

                   Rule Violation Summary
 count tag                   profile    rule associated tags
    30 sanity[cannot-ignore] production

Failed after shared profile, 4/5 star rating: 30 failure(s), 0 warning(s) on 67 files.
~/git/gh/ibm_zos_core $: ./ac --venv-start
-----------------------------------------------------------------------
Starting managed python virtual environment: venv-2.15
-----------------------------------------------------------------------
(venv-2.15) ansible-lint --version
ansible-lint 6.14.3 using ansible 2.15.0
(venv-2.15) exit
~/git/gh/ibm_zos_core $:
ddimatos commented 5 months ago

The community has voted on lifting the restriction for sanity tests such that validate-modules:undocumented-parameter results in error.

They are permitted under these circumstances:

  1. deprecated parameters;
  2. internal parameters used to transport data from an action plugin to a module.

Ours fall under condition (2).

The PR for this vote is set for ansible-core 2.16, I can discuss this with AnsiblePartners to see if we can relax this requirement for ansible-core 2.14+.

This would address 3 of the 4, validate-modules:undocumented-parameter errors; 1 was resolved already, and another is currently in progress.