Capture python warnings and report some of them as matches #3324

ssbarnea · 2023-04-22T12:19:16Z

This change introduces a new way to generate warnings in linter, one that uses the warnings support in Python. The benefit is that this allows use to generate warnings from anywhere inside the code without having to pass them from function to function.

For start we will be using this for internal rules, like ability to report outdated tag names in noqa comments.

This change introduces a new way to generate warnings in linter, one that uses the warnings support in Python. The benefit is that this allows use to generate warnings from anywhere inside the code without having to pass them from function to function. For start we will be using this for internal rules, like ability to report outdated noqa comments.

This PR contains the following updates: | Package | Update | Change | |---|---|---| | [ansible-lint](https://github.com/ansible/ansible-lint) ([changelog](https://github.com/ansible/ansible-lint/releases)) | minor | `==6.15.0` -> `==6.17.2` | --- ### Release Notes <details> <summary>ansible/ansible-lint (ansible-lint)</summary> ### [`v6.17.2`](https://github.com/ansible/ansible-lint/releases/tag/v6.17.2) [Compare Source](ansible/ansible-lint@v6.17.1...v6.17.2) #### Bugfixes - Allow use as a reusable github action ([#3513](ansible/ansible-lint#3513)) [@ssbarnea](https://github.com/ssbarnea) - Add action and args properties to task class ([#3576](ansible/ansible-lint#3576)) [@ssbarnea](https://github.com/ssbarnea) - Fixed error when sarif file option is provided ([#3587](ansible/ansible-lint#3587)) [@ajinkyau](https://github.com/ajinkyau) - Add NetBSD as a recognized platform ([#3586](ansible/ansible-lint#3586)) [@he32](https://github.com/he32) - Display ansible-compat version alongwith with other deps ([#3584](ansible/ansible-lint#3584)) [@ajinkyau](https://github.com/ajinkyau) - Refactored syntax-checking ([#3568](ansible/ansible-lint#3568)) [@ssbarnea](https://github.com/ssbarnea) - Avoid app reinitialization during syntax-check ([#3563](ansible/ansible-lint#3563)) [@ssbarnea](https://github.com/ssbarnea) - Allow config file to have `.yaml` extension ([#3559](ansible/ansible-lint#3559)) [@bdsoha](https://github.com/bdsoha) - Allow lists of lists of strings for vars_files ([#3561](ansible/ansible-lint#3561)) [@ajinkyau](https://github.com/ajinkyau) ### [`v6.17.1`](https://github.com/ansible/ansible-lint/releases/tag/v6.17.1) [Compare Source](ansible/ansible-lint@v6.17.0...v6.17.1) #### Bugfixes - Update guess install method check ([#3553](ansible/ansible-lint#3553)) [@ajinkyau](https://github.com/ajinkyau) - Fix exclude logic bug that can cause cause partial linting ([#3552](ansible/ansible-lint#3552)) [@ssbarnea](https://github.com/ssbarnea) - Make profile information on summary line more clear ([#3545](ansible/ansible-lint#3545)) [@ssbarnea](https://github.com/ssbarnea) - Avoid adding pip related messages if installation method is different ([#3551](ansible/ansible-lint#3551)) [@ajinkyau](https://github.com/ajinkyau) - Avoid false positive with var-naming\[no-role-prefix] ([#3550](ansible/ansible-lint#3550)) [@ssbarnea](https://github.com/ssbarnea) - Make refresh_schemas handle firewalls that cut the file transfer midway ([#3546](ansible/ansible-lint#3546)) [@sverrehu](https://github.com/sverrehu) - Rename marketplace action ([#3548](ansible/ansible-lint#3548)) [@ssbarnea](https://github.com/ssbarnea) - Fix action name ([#3536](ansible/ansible-lint#3536)) [@coaxial](https://github.com/coaxial) - Handling of exclude paths with trailing slashs ([#3527](ansible/ansible-lint#3527)) [@hille721](https://github.com/hille721) - Ensure that rules collections use Runtime in offline mode ([#3526](ansible/ansible-lint#3526)) [@ssbarnea](https://github.com/ssbarnea) - Avoid using get_app() from inside the rule ([#3525](ansible/ansible-lint#3525)) [@ssbarnea](https://github.com/ssbarnea) - Avoid dependency error from rich ([#3517](ansible/ansible-lint#3517)) [@ssbarnea](https://github.com/ssbarnea) ### [`v6.17.0`](https://github.com/ansible/ansible-lint/releases/tag/v6.17.0) [Compare Source](ansible/ansible-lint@v6.16.2...v6.17.0) #### Minor Changes - fqcn\[deep]: detect deep plugins ([#3502](ansible/ansible-lint#3502)) [@ssbarnea](https://github.com/ssbarnea) #### Bugfixes - Reimplement file exclusion logic ([#3507](ansible/ansible-lint#3507)) [@ssbarnea](https://github.com/ssbarnea) - Check validity of 'become_method' values from code ([#3499](ansible/ansible-lint#3499)) [@ajinkyau](https://github.com/ajinkyau) - Fix role_name\_ prefix include_role var name error ([#3500](ansible/ansible-lint#3500)) [@ajinkyau](https://github.com/ajinkyau) - Hide pip error if not present ([#3494](ansible/ansible-lint#3494)) [@Et7f3](https://github.com/Et7f3) - Update formatter to avoid reporting paths with .. ([#3496](ansible/ansible-lint#3496)) [@ssbarnea](https://github.com/ssbarnea) - Remove false positive on 'cacheable' property of set_fact ([#3490](ansible/ansible-lint#3490)) [@ajinkyau](https://github.com/ajinkyau) - Add missing become_method plugins to the schema ([#3484](ansible/ansible-lint#3484)) [@ajinkyau](https://github.com/ajinkyau) - Add support for ansible-builder v3 schema ([#3480](ansible/ansible-lint#3480)) [@ajinkyau](https://github.com/ajinkyau) - Add Github Marketplace Action ([#3476](ansible/ansible-lint#3476)) [@ssbarnea](https://github.com/ssbarnea) - Add oracle linux 8.8 ([#3479](ansible/ansible-lint#3479)) [@facorazza](https://github.com/facorazza) - Revert ansible-compat vendoring ([#3478](ansible/ansible-lint#3478)) [@ssbarnea](https://github.com/ssbarnea) - Updated file or dir not found message ([#3474](ansible/ansible-lint#3474)) [@ajinkyau](https://github.com/ajinkyau) - Check for included role prefix instead of current one ([#3473](ansible/ansible-lint#3473)) [@ssbarnea](https://github.com/ssbarnea) ### [`v6.16.2`](https://github.com/ansible/ansible-lint/releases/tag/v6.16.2) [Compare Source](ansible/ansible-lint@v6.16.1...v6.16.2) #### Bugfixes - Update test dependencies ([#3470](ansible/ansible-lint#3470)) [@ssbarnea](https://github.com/ssbarnea) - Fix and document installing of requirements.yml files ([#3471](ansible/ansible-lint#3471)) [@ssbarnea](https://github.com/ssbarnea) - Do not ever exclude files given as arguments ([#3468](ansible/ansible-lint#3468)) [@ssbarnea](https://github.com/ssbarnea) - Ensure we return error if argument gives are not present ([#3467](ansible/ansible-lint#3467)) [@ssbarnea](https://github.com/ssbarnea) - Allow rules to expose all tags they can produce ([#3464](ansible/ansible-lint#3464)) [@ssbarnea](https://github.com/ssbarnea) - Enable var-name rule to detect read-only variables ([#3462](ansible/ansible-lint#3462)) [@ssbarnea](https://github.com/ssbarnea) - Add Oracle Enterprise Linux 7.\* ([#3463](ansible/ansible-lint#3463)) [@Rylon](https://github.com/Rylon) - Fix for var-naming rule to not break on include_tasks and vars ([#3458](ansible/ansible-lint#3458)) [@ajinkyau](https://github.com/ajinkyau) - var-naming now prevents use of Ansible reserved names ([#3460](ansible/ansible-lint#3460)) [@ssbarnea](https://github.com/ssbarnea) - Ensure that we also lint files from git submodules ([#3431](ansible/ansible-lint#3431)) [@ssbarnea](https://github.com/ssbarnea) - Adding 2.16 to the list of allowed ansible-core versions in meta-runtime rule ([#3455](ansible/ansible-lint#3455)) [@alisonlhart](https://github.com/alisonlhart) ### [`v6.16.1`](https://github.com/ansible/ansible-lint/releases/tag/v6.16.1) [Compare Source](ansible/ansible-lint@v6.16.0...v6.16.1) #### Bugfixes - Update lock file to use ansible-core 2.15.0 ([#3449](ansible/ansible-lint#3449)) [@ssbarnea](https://github.com/ssbarnea) - Install requirements from galaxy.yml and tests/requirements.yml ([#3446](ansible/ansible-lint#3446)) [@ssbarnea](https://github.com/ssbarnea) - Add Kali Linux as a supported platform ([#3448](ansible/ansible-lint#3448)) [@mcdonnnj](https://github.com/mcdonnnj) - Do not trigger no_handler upon complex conditions ([#3437](ansible/ansible-lint#3437)) [@klaus-tux](https://github.com/klaus-tux) - Hide warning about unique filter originating from core ([#3436](ansible/ansible-lint#3436)) [@ssbarnea](https://github.com/ssbarnea) - Relax ruamel-yaml requirements ([#3433](ansible/ansible-lint#3433)) [@ssbarnea](https://github.com/ssbarnea) - Suggest correct alternative for `with_filetree` ([#3432](ansible/ansible-lint#3432)) [@ErwinJanssen](https://github.com/ErwinJanssen) - Upgrade var-naming rule to include role name prefix ([#3422](ansible/ansible-lint#3422)) [@ssbarnea](https://github.com/ssbarnea) - Fix exception when using reformatting on scalars ([#3423](ansible/ansible-lint#3423)) [@ssbarnea](https://github.com/ssbarnea) - Find and lint imported playbooks ([#3413](ansible/ansible-lint#3413)) [@ajinkyau](https://github.com/ajinkyau) ### [`v6.16.0`](https://github.com/ansible/ansible-lint/releases/tag/v6.16.0) [Compare Source](ansible/ansible-lint@v6.15.0...v6.16.0) #### Minor Changes - Capture python warnings and report some of them as matches ([#3324](ansible/ansible-lint#3324)) [@ssbarnea](https://github.com/ssbarnea) - Capture and hide ansible core warnings by default ([#3361](ansible/ansible-lint#3361)) [@ssbarnea](https://github.com/ssbarnea) - Remove progressive mode ([#3350](ansible/ansible-lint#3350)) [@ssbarnea](https://github.com/ssbarnea) - Enforce use of lineno variable name inside the library ([#3326](ansible/ansible-lint#3326)) [@ssbarnea](https://github.com/ssbarnea) #### Bugfixes - Add Amazon Linux 2023 as a supported platform ([#3405](ansible/ansible-lint#3405)) [@artis3n](https://github.com/artis3n) - Capture python warnings and report some of them as matches ([#3324](ansible/ansible-lint#3324)) [@ssbarnea](https://github.com/ssbarnea) - Fix missing required arguments issue from args rule ([#3402](ansible/ansible-lint#3402)) [@ajinkyau](https://github.com/ajinkyau) - Change matchtask to receive a Task instance ([#3403](ansible/ansible-lint#3403)) [@ssbarnea](https://github.com/ssbarnea) - Require ruamel.yaml>=0.17.24 ([#3406](ansible/ansible-lint#3406)) [@ssbarnea](https://github.com/ssbarnea) - Avoid exception when trying to load invalid text files ([#3399](ansible/ansible-lint#3399)) [@ssbarnea](https://github.com/ssbarnea) - Fix ansible collection path detection ([#3398](ansible/ansible-lint#3398)) [@ssbarnea](https://github.com/ssbarnea) - ruff: Address FBT002 ([#3389](ansible/ansible-lint#3389)) [@shatakshiiii](https://github.com/shatakshiiii) - More pathlib adoption ([#3390](ansible/ansible-lint#3390)) [@ssbarnea](https://github.com/ssbarnea) - Avoid dropping comments on YAML transformation ([#3392](ansible/ansible-lint#3392)) [@ssbarnea](https://github.com/ssbarnea) - Correct docs on navigator schema location ([#3394](ansible/ansible-lint#3394)) [@yajo](https://github.com/yajo) - Fix changelog schema for connection plugins ([#3388](ansible/ansible-lint#3388)) [@Qalthos](https://github.com/Qalthos) - Migrate from os.path to pathlib ([#3384](ansible/ansible-lint#3384)) [@ssbarnea](https://github.com/ssbarnea) - Remove resolvelib from requirements lock ([#3387](ansible/ansible-lint#3387)) [@ssbarnea](https://github.com/ssbarnea) - Make cwd use pathlib ([#3383](ansible/ansible-lint#3383)) [@ssbarnea](https://github.com/ssbarnea) - ruff: Address PGH ([#3380](ansible/ansible-lint#3380)) [@ssbarnea](https://github.com/ssbarnea) - ruff: Address A ([#3379](ansible/ansible-lint#3379)) [@ssbarnea](https://github.com/ssbarnea) - ruff: Address B ([#3377](ansible/ansible-lint#3377)) [@ssbarnea](https://github.com/ssbarnea) - ruff: Address SLF ([#3372](ansible/ansible-lint#3372)) [@ssbarnea](https://github.com/ssbarnea) - ruff: Address `SIM` ([#3373](ansible/ansible-lint#3373)) [@shatakshiiii](https://github.com/shatakshiiii) - ruff: Address EXE ([#3367](ansible/ansible-lint#3367)) [@ssbarnea](https://github.com/ssbarnea) - ruff: Address BLE ([#3368](ansible/ansible-lint#3368)) [@shatakshiiii](https://github.com/shatakshiiii) - ruff: Address INP and PLW ([#3366](ansible/ansible-lint#3366)) [@ssbarnea](https://github.com/ssbarnea) - Add initial handling of submodules to contribution docs ([#3362](ansible/ansible-lint#3362)) [@klaus-tux](https://github.com/klaus-tux) - ruff: Address T and RET ([#3364](ansible/ansible-lint#3364)) [@ssbarnea](https://github.com/ssbarnea) - Find "changed" not only in first "when" condition ([#3358](ansible/ansible-lint#3358)) [@klaus-tux](https://github.com/klaus-tux) - ruff: fix S rule ([#3363](ansible/ansible-lint#3363)) [@ssbarnea](https://github.com/ssbarnea) - Make MatchError a dataclass ([#3345](ansible/ansible-lint#3345)) [@ssbarnea](https://github.com/ssbarnea) - Remove `EM` from ruff ignores ([#3356](ansible/ansible-lint#3356)) [@shatakshiiii](https://github.com/shatakshiiii) - Mock jinja filters to prevent templating errors ([#3355](ansible/ansible-lint#3355)) [@ssbarnea](https://github.com/ssbarnea) - Update schema files ([#3354](ansible/ansible-lint#3354)) [@ssbarnea](https://github.com/ssbarnea) - Add Fedora 38 to meta.json schema file ([#3353](ansible/ansible-lint#3353)) [@Marek-Mantaj-Mobica](https://github.com/Marek-Mantaj-Mobica) - Remove `RUF` from ruff ignores ([#3346](ansible/ansible-lint#3346)) [@ajinkyau](https://github.com/ajinkyau) - Remove `G` from ruff ignores ([#3332](ansible/ansible-lint#3332)) [@shatakshiiii](https://github.com/shatakshiiii) - Remove `ISC` from ruff ignores ([#3342](ansible/ansible-lint#3342)) [@shatakshiiii](https://github.com/shatakshiiii) - Remove `C` from ruff ignores ([#3343](ansible/ansible-lint#3343)) [@ajinkyau](https://github.com/ajinkyau) - Make linter configuration a dataclass ([#3334](ansible/ansible-lint#3334)) [@ssbarnea](https://github.com/ssbarnea) - Remove `N` from ruff ignores ([#3328](ansible/ansible-lint#3328)) [@shatakshiiii](https://github.com/shatakshiiii) - Remove useless . from additional_dependencies in pre-commit hook ([#3327](ansible/ansible-lint#3327)) [@trallnag](https://github.com/trallnag) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: Nicolas Dufour <nrdufour@gmail.com> Reviewed-on: https://git.home/nrdufour/home-ops/pulls/9 Co-authored-by: Renovate <renovate@ptinem.io> Co-committed-by: Renovate <renovate@ptinem.io>

github-actions bot added the bug label Apr 22, 2023

ssbarnea requested a review from cidrblock April 22, 2023 12:28

ssbarnea changed the title ~~Capture python warnings and report them as matches~~ Capture python warnings and report some of them as matches Apr 23, 2023

ssbarnea force-pushed the fix/clean branch from 8bb3c05 to f65e10e Compare April 24, 2023 16:38

ssbarnea force-pushed the fix/clean branch 2 times, most recently from 89d9e72 to 1aeb6f4 Compare May 8, 2023 10:16

ssbarnea force-pushed the fix/clean branch from 1aeb6f4 to 9782c0c Compare May 8, 2023 10:17

ssbarnea added enhancement and removed bug labels May 8, 2023

github-actions bot added the bug label May 8, 2023

ssbarnea marked this pull request as ready for review May 8, 2023 10:19

ssbarnea requested a review from a team as a code owner May 8, 2023 10:19

ssbarnea requested review from a team, audgirka, priyamsahoo and shatakshiiii May 8, 2023 10:19

audgirka approved these changes May 8, 2023

View reviewed changes

ssbarnea merged commit 62e3e21 into main May 9, 2023

ssbarnea deleted the fix/clean branch May 9, 2023 07:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Capture python warnings and report some of them as matches #3324

Capture python warnings and report some of them as matches #3324

ssbarnea commented Apr 22, 2023 •

edited

Loading

Capture python warnings and report some of them as matches #3324

Capture python warnings and report some of them as matches #3324

Conversation

ssbarnea commented Apr 22, 2023 • edited Loading

ssbarnea commented Apr 22, 2023 •

edited

Loading