matchplay false postivies cannot be disabled with # noqa

[cdesouza71]

Summary

False positives reported by matchplay cannot be disabled with # noqa rule-name

Issue Type

• Bug Report

Ansible and Ansible Lint details

ansible --version
ansible [core 2.11.5] 
  config file = None
  configured module search path = ['/home/qc/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/local/lib/python3.8/dist-packages/ansible
  ansible collection location = /home/qc/.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/local/bin/ansible
  python version = 3.8.10 (default, Nov 26 2021, 20:14:08) [GCC 9.3.0]
  jinja version = 3.0.1
  libyaml = True
ansible-lint --version
ansible-lint 5.1.3 using ansible 2.11.5

• ansible installation method: pip
• ansible-lint installation method: pip

OS / ENVIRONMENT

Distributor ID:	Ubuntu
Description:	Ubuntu 20.04.3 LTS
Release:	20.04
Codename:	focal

STEPS TO REPRODUCE

ansible-lint -p -t var-naming

playbook.yml

---
- name: var-naming issue
  vars:
    test-var: testValue # noqa var-naming
  hosts:
    - localhost
  roles:
    - test

Desired Behaviour

The invalid variable name should be ignored due to the # noqa var-naming. Note var-naming is just an example rule that is used to illustrate the issues. As far as I can tell this is the case for all rules that rule matchplay.

Actual Behaviour

WARNING  Listing 1 violation(s) that are fatal
playbook.yml:4: var-naming Play defines variable 'test-var' within 'vars' section that violates variable naming standards
You can skip specific rules or tags by adding them to your configuration file:
# .ansible-lint
warn_list:  # or 'skip_list' to silence them completely
  - experimental  # all rules tagged as experimental

Finished with 0 failure(s), 1 warning(s) on 1 files.

[ssbarnea]

This is a false bug report as the tool version was outdated and the real output looks like below:

syntax-check: Invalid variable name in vars specified for Play: 'test-var' is not a valid variable name

If you read the docs, you will find that you cannot ignore syntax-check failures, as these are coming from Ansible.

[cdesouza71]

Another example using up to date ansible-lint version and custom code.

qc@qc-pde:$ ansible-lint --version
ansible-lint 5.3.2 using ansible 2.11.5

Rule using matchplay

from ansiblelint.rules import AnsibleLintRule

class TaskInPlaybookRule(AnsibleLintRule):
    id = "task-in-playbook"
    shortdesc = "Tasks should go in roles not the main playbook"
    description = (
        "Tasks should normally go into roles rather than our top level "
        + "playbooks. This is to keep the playbooks simple and make the code reusable. "
    )

    def matchplay(self, playbookfile, play):
        if "tasks" in play:
            matches = []
            for t in play["tasks"]:
                match = "Task '{}' in playbook".format(t.get("name", ""))
                matches.append(
                    self.create_matcherror(
                        message=match, filename=playbookfile, linenumber=t["__line__"]
                    )
                )
            return matches
        return []

Expected result

Playbook with task

---
- name: Playbooks contains task
  hosts: localhost
  tasks:
    - name: Check if directory exists
      stat:
        path: "/tmp"

Output

qc@qc-pde:$ ansible-lint -p -r ../rules/ -R -t task-in-playbook -vv
DEBUG    Logging initialized to level 10
DEBUG    Options: Namespace(cache_dir='/home/qc/.cache/ansible-lint/dc1163', colored=True, config_file='/home/qc/projects/linter-bug/dev/docker/ansible-linter/custom-rules/.ansible-lint', configured=True, cwd=PosixPath('/home/qc/projects/linter-bug/dev/docker/ansible-linter/custom-rules/bug'), display_relative_path=True, enable_list=[], exclude_paths=['/home/qc/projects/linter-bug/dev/docker/ansible-linter/custom-rules/dummy'], extra_vars=None, format='rich', kinds=[{'jinja2': '**/*.j2'}, {'jinja2': '**/*.j2.*'}, {'inventory': '**/inventory/**.yml'}, {'requirements': '**/meta/requirements.yml'}, {'galaxy': '**/galaxy.yml'}, {'reno': '**/releasenotes/*/*.{yaml,yml}'}, {'playbook': '**/playbooks/*.{yml,yaml}'}, {'playbook': '**/*playbook*.{yml,yaml}'}, {'role': '**/roles/*/'}, {'tasks': '**/tasks/**/*.{yaml,yml}'}, {'handlers': '**/handlers/*.{yaml,yml}'}, {'vars': '**/{host_vars,group_vars,vars,defaults}/**/*.{yaml,yml}'}, {'meta': '**/meta/main.{yaml,yml}'}, {'yaml': '.config/molecule/config.{yaml,yml}'}, {'requirements': '**/molecule/*/{collections,requirements}.{yaml,yml}'}, {'yaml': '**/molecule/*/{base,molecule}.{yaml,yml}'}, {'requirements': '**/requirements.yml'}, {'playbook': '**/molecule/*/*.{yaml,yml}'}, {'yaml': '**/{.ansible-lint,.yamllint}'}, {'yaml': '**/*.{yaml,yml}'}, {'yaml': '**/.*.{yaml,yml}'}], lintables=[], listrules=False, listtags=False, loop_var_prefix=None, mock_modules=[], mock_roles=[], offline=False, parseable=True, parseable_severity=False, progressive=False, project_dir='..', quiet=False, rules={}, rulesdir=[PosixPath('/home/qc/projects/linter-bug/dev/docker/ansible-linter/custom-rules/rules')], rulesdirs=[PosixPath('/home/qc/projects/linter-bug/dev/docker/ansible-linter/custom-rules/rules'), '/usr/local/lib/python3.8/dist-packages/ansiblelint/rules'], skip_action_validation=True, skip_list=[], tags=['task-in-playbook'], use_default_rules=True, var_naming_pattern=None, verbosity=2, version=False, warn_list=['experimental', 'role-name'])
DEBUG    /home/qc/projects/linter-bug/dev/docker/ansible-linter/custom-rules/bug
DEBUG    Loading rules from /home/qc/projects/linter-bug/dev/docker/ansible-linter/custom-rules/rules
WARNING  Skipped invalid rule from AdasTaskInPlaybookRule
DEBUG    Loading rules from /usr/local/lib/python3.8/dist-packages/ansiblelint/rules
DEBUG    Effective yamllint rules used: {'braces': {'level': 'error', 'forbid': False, 'min-spaces-inside': 0, 'max-spaces-inside': 0, 'min-spaces-inside-empty': -1, 'max-spaces-inside-empty': -1}, 'brackets': {'level': 'error', 'forbid': False, 'min-spaces-inside': 0, 'max-spaces-inside': 0, 'min-spaces-inside-empty': -1, 'max-spaces-inside-empty': -1}, 'colons': {'level': 'error', 'max-spaces-before': 0, 'max-spaces-after': 1}, 'commas': {'level': 'error', 'max-spaces-before': 0, 'min-spaces-after': 1, 'max-spaces-after': 1}, 'comments': {'level': 'warning', 'require-starting-space': True, 'ignore-shebangs': True, 'min-spaces-from-content': 2}, 'comments-indentation': False, 'document-end': False, 'document-start': False, 'empty-lines': {'level': 'error', 'max': 2, 'max-start': 0, 'max-end': 0}, 'empty-values': False, 'hyphens': {'level': 'error', 'max-spaces-after': 1}, 'indentation': {'level': 'error', 'spaces': 'consistent', 'indent-sequences': True, 'check-multi-line-strings': False}, 'key-duplicates': {'level': 'error'}, 'key-ordering': False, 'line-length': {'level': 'error', 'max': 160, 'allow-non-breakable-words': True, 'allow-non-breakable-inline-mappings': False}, 'new-line-at-end-of-file': {'level': 'error'}, 'new-lines': {'level': 'error', 'type': 'unix'}, 'octal-values': False, 'quoted-strings': False, 'trailing-spaces': {'level': 'error'}, 'truthy': {'level': 'warning', 'allowed-values': ['true', 'false'], 'check-keys': True}}
INFO     Discovered files to lint using: git ls-files --cached --others --exclude-standard -z
INFO     Excluded removed files using: git ls-files --deleted -z
INFO     Executing syntax check on task-in-playbook.yml (2.18s)
DEBUG    Examining task-in-playbook.yml of type playbook
WARNING  Listing 1 violation(s) that are fatal
task-in-playbook.yml:5: task-in-playbook Task 'Check if directory exists' in playbook
You can skip specific rules or tags by adding them to your configuration file:
# .ansible-lint
warn_list:  # or 'skip_list' to silence them completely
  - task-in-playbook  # Tasks should go in roles not the main playbook

Finished with 1 failure(s), 0 warning(s) on 1 files.

Unexpected result

Playbook with task but rule disabled for task

---
- name: Playbooks contains task
  hosts: localhost
  tasks:
    - name: Check if directory exists  # noqa task-in-playbook
      stat:
        path: "/tmp"

Output

qc@qc-pde:$ ansible-lint -p -r ../rules/ -R -t task-in-playbook -vv
DEBUG    Logging initialized to level 10
DEBUG    Options: Namespace(cache_dir='/home/qc/.cache/ansible-lint/dc1163', colored=True, config_file='/home/qc/projects/linter-bug/dev/docker/ansible-linter/custom-rules/.ansible-lint', configured=True, cwd=PosixPath('/home/qc/projects/linter-bug/dev/docker/ansible-linter/custom-rules/bug'), display_relative_path=True, enable_list=[], exclude_paths=['/home/qc/projects/linter-bug/dev/docker/ansible-linter/custom-rules/dummy'], extra_vars=None, format='rich', kinds=[{'jinja2': '**/*.j2'}, {'jinja2': '**/*.j2.*'}, {'inventory': '**/inventory/**.yml'}, {'requirements': '**/meta/requirements.yml'}, {'galaxy': '**/galaxy.yml'}, {'reno': '**/releasenotes/*/*.{yaml,yml}'}, {'playbook': '**/playbooks/*.{yml,yaml}'}, {'playbook': '**/*playbook*.{yml,yaml}'}, {'role': '**/roles/*/'}, {'tasks': '**/tasks/**/*.{yaml,yml}'}, {'handlers': '**/handlers/*.{yaml,yml}'}, {'vars': '**/{host_vars,group_vars,vars,defaults}/**/*.{yaml,yml}'}, {'meta': '**/meta/main.{yaml,yml}'}, {'yaml': '.config/molecule/config.{yaml,yml}'}, {'requirements': '**/molecule/*/{collections,requirements}.{yaml,yml}'}, {'yaml': '**/molecule/*/{base,molecule}.{yaml,yml}'}, {'requirements': '**/requirements.yml'}, {'playbook': '**/molecule/*/*.{yaml,yml}'}, {'yaml': '**/{.ansible-lint,.yamllint}'}, {'yaml': '**/*.{yaml,yml}'}, {'yaml': '**/.*.{yaml,yml}'}], lintables=[], listrules=False, listtags=False, loop_var_prefix=None, mock_modules=[], mock_roles=[], offline=False, parseable=True, parseable_severity=False, progressive=False, project_dir='..', quiet=False, rules={}, rulesdir=[PosixPath('/home/qc/projects/linter-bug/dev/docker/ansible-linter/custom-rules/rules')], rulesdirs=[PosixPath('/home/qc/projects/linter-bug/dev/docker/ansible-linter/custom-rules/rules'), '/usr/local/lib/python3.8/dist-packages/ansiblelint/rules'], skip_action_validation=True, skip_list=[], tags=['task-in-playbook'], use_default_rules=True, var_naming_pattern=None, verbosity=2, version=False, warn_list=['experimental', 'role-name'])
DEBUG    /home/qc/projects/linter-bug/dev/docker/ansible-linter/custom-rules/bug
DEBUG    Loading rules from /home/qc/projects/linter-bug/dev/docker/ansible-linter/custom-rules/rules
WARNING  Skipped invalid rule from AdasTaskInPlaybookRule
DEBUG    Loading rules from /usr/local/lib/python3.8/dist-packages/ansiblelint/rules
DEBUG    Effective yamllint rules used: {'braces': {'level': 'error', 'forbid': False, 'min-spaces-inside': 0, 'max-spaces-inside': 0, 'min-spaces-inside-empty': -1, 'max-spaces-inside-empty': -1}, 'brackets': {'level': 'error', 'forbid': False, 'min-spaces-inside': 0, 'max-spaces-inside': 0, 'min-spaces-inside-empty': -1, 'max-spaces-inside-empty': -1}, 'colons': {'level': 'error', 'max-spaces-before': 0, 'max-spaces-after': 1}, 'commas': {'level': 'error', 'max-spaces-before': 0, 'min-spaces-after': 1, 'max-spaces-after': 1}, 'comments': {'level': 'warning', 'require-starting-space': True, 'ignore-shebangs': True, 'min-spaces-from-content': 2}, 'comments-indentation': False, 'document-end': False, 'document-start': False, 'empty-lines': {'level': 'error', 'max': 2, 'max-start': 0, 'max-end': 0}, 'empty-values': False, 'hyphens': {'level': 'error', 'max-spaces-after': 1}, 'indentation': {'level': 'error', 'spaces': 'consistent', 'indent-sequences': True, 'check-multi-line-strings': False}, 'key-duplicates': {'level': 'error'}, 'key-ordering': False, 'line-length': {'level': 'error', 'max': 160, 'allow-non-breakable-words': True, 'allow-non-breakable-inline-mappings': False}, 'new-line-at-end-of-file': {'level': 'error'}, 'new-lines': {'level': 'error', 'type': 'unix'}, 'octal-values': False, 'quoted-strings': False, 'trailing-spaces': {'level': 'error'}, 'truthy': {'level': 'warning', 'allowed-values': ['true', 'false'], 'check-keys': True}}
INFO     Discovered files to lint using: git ls-files --cached --others --exclude-standard -z
INFO     Excluded removed files using: git ls-files --deleted -z
INFO     Executing syntax check on task-in-playbook.yml (2.19s)
DEBUG    Examining task-in-playbook.yml of type playbook
WARNING  Listing 1 violation(s) that are fatal
task-in-playbook.yml:5: task-in-playbook Task 'Check if directory exists' in playbook
You can skip specific rules or tags by adding them to your configuration file:
# .ansible-lint
warn_list:  # or 'skip_list' to silence them completely
  - task-in-playbook  # Tasks should go in roles not the main playbook

Finished with 1 failure(s), 0 warning(s) on 1 files.