Double extended error message in AnsibleParserError (triple in 2.4) #36848

diafour · 2018-02-28T13:43:28Z

ISSUE TYPE

Bug Report

COMPONENT NAME

AnsibleError, AnsibleParserError, Task#preprocess_data, ModuleArgsParser#parse

ANSIBLE VERSION

2.4, 2.5, devel

CONFIGURATION

No special configuration, local connection.

ansible-playbook -c local -i localhost, playbook.yml

playbook.yml:

---
- hosts: all
  tasks:
  - apk: msgfd

OS / ENVIRONMENT

Ubuntu 16.04, Python 3.5.2 (default, Nov 23 2017, 16:37:01) in virtualenv

SUMMARY

ModuleArgsParser#parse raises AnsibleParserError if something is wrong with tasks or their arguments.
AnsibleParserError#__init__ append extended error to the message.
Then Task#preprocess_data wraps AnsibleParserError with new instance of AnsibleParserError and thus extended error is doubled in message.

Extended error is printed 3 times in version 2.4. devel branch has merged PR #24468 and extended error is printed 2 times.

May be something wrong with this wrapping?

ansible/lib/ansible/playbook/task.py

Lines 183 to 187 in ebf971f

    
           args_parser = ModuleArgsParser(task_ds=ds) 
        
           try: 
        
               (action, args, delegate_to) = args_parser.parse() 
        
           except AnsibleParserError as e: 
        
               raise AnsibleParserError(to_native(e), obj=ds, orig_exc=e)

STEPS TO REPRODUCE

Simple test case that raises error about extra params from

ansible/lib/ansible/parsing/mod_args.py

Line 303 in ebf971f

    
           raise AnsibleParserError("this task '%s' has extra params, which is only allowed in the following modules: %s" % (action,

---
- hosts: all
  tasks:
  - apk: msgfd

Create file and run it localy for verification:

$ ansible-playbook -c local -i localhost, playbook.yml

EXPECTED RESULTS

Clean error message with offending lines:

ERROR! this task 'apk' has extra params, which is only allowed in the following modules: command, win_command, shell, win_shell, script, include, include_vars, include_tasks, include_role, import_tasks, import_role, add_host, group_by, set_fact, raw, meta

The error appears to have been in '/home/diafour/Projects/dapp/ansible-test/debug-playbook.yml': line 6, column 7, but may
be elsewhere in the file depending on the exact syntax problem.

The offending line appears to be:

  tasks:
    - apk: msgfd
      ^ here

ACTUAL RESULTS

devel branch:

Double output

ERROR! this task 'apk' has extra params, which is only allowed in the following modules: command, win_command, shell, win_shell, script, include, include_vars, include_tasks, include_role, import_tasks, import_role, add_host, group_by, set_fact, raw, meta

The error appears to have been in '/home/diafour/Projects/dapp/ansible-test/debug-playbook.yml': line 6, column 7, but may
be elsewhere in the file depending on the exact syntax problem.

The offending line appears to be:

  tasks:
    - apk: msgfd
      ^ here


The error appears to have been in '/home/diafour/Projects/dapp/ansible-test/debug-playbook.yml': line 6, column 7, but may
be elsewhere in the file depending on the exact syntax problem.

The offending line appears to be:

  tasks:
    - apk: msgfd
      ^ here

version 2.4 (git checkout stable-2.4)

Triple output

ERROR! this task 'apk' has extra params, which is only allowed in the following modules: command, win_command, shell, win_shell, script, include, include_vars, include_tasks, include_role, import_tasks, import_role, add_host, group_by, set_fact, raw, meta

The error appears to have been in '/home/diafour/Projects/dapp/ansible-test/debug-playbook.yml': line 6, column 7, but may
be elsewhere in the file depending on the exact syntax problem.

The offending line appears to be:

  tasks:
    - apk: msgfd
      ^ here


The error appears to have been in '/home/diafour/Projects/dapp/ansible-test/debug-playbook.yml': line 6, column 7, but may
be elsewhere in the file depending on the exact syntax problem.

The offending line appears to be:

  tasks:
    - apk: msgfd
      ^ here

exception type: <class 'ansible.errors.AnsibleParserError'>
exception: this task 'apk' has extra params, which is only allowed in the following modules: command, win_command, shell, win_shell, script, include, include_vars, include_tasks, include_role, import_tasks, import_role, add_host, group_by, set_fact, raw, meta

The error appears to have been in '/home/diafour/Projects/dapp/ansible-test/debug-playbook.yml': line 6, column 7, but may
be elsewhere in the file depending on the exact syntax problem.

The offending line appears to be:

  tasks:
    - apk: msgfd
      ^ here

The text was updated successfully, but these errors were encountered:

ansibot · 2018-02-28T13:44:25Z

Files identified in the description:
None

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

diafour · 2018-02-28T13:48:50Z

!component +lib/ansible/errors/init.py
!component +lib/ansible/parsing/mod_args.py
!component +lib/ansible/playbook/task.py

ansibot · 2018-02-28T13:53:15Z

Files identified in the description:

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

ansibot · 2018-02-28T14:10:51Z

Files identified in the description:

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

alikins · 2018-03-01T16:20:44Z

The mod_args.py and task.py cases need some tweaking, since currently they catch AnsibleParserError and then raises a new AnsibleParserError() with additional args, so the final displayed exception's orig_exc has two or more instances of the same exception type with the same message. And when displayed as shown, that doesn't make a ton of sense.

alikins · 2018-03-01T17:06:43Z

For cases like:

https://github.com/ansible/ansible/blob/devel/lib/ansible/playbook/task.py#L187

... guess there is no particular reason to re raise a new AnsibleParserError in those cases.
As far as I can tell, we could either just do a plain (re) raise, or if we need to set/update the AnsibleParserError._obj we can do it the original Exception instance and (re) raise

try:
    whatever()
except AnsibleParserError as e:
    # if we don't need to add/change the AnsibleError._obj, just re raise
    raise

try:
    whatever(some_thing_related_to_some_yaml_object)
except AnsibleParserError as e:
    # if whatever() doesn't specify obj=some_yaml_obj when it raises AnsibleParserError()
    # we can just set/update it here and re raise
    e._obj = some_yaml_obj
    raise

* Fix redundant yaml error blurbs on ModArgs parse errors Some of the AnsibleParserErrors from parsing.mod_args are created with the obj=some_yaml_ds options but some are not. If they were, we don't want to add another yaml_ds to it, because that will result in double yaml error blurbs. And since we dont need to add info, we can just re raise it. But if there is no ._obj, add it here so we get the extra detail in the error message (see issue #14790) and raise a new AnsibleParserError instance. Fixes #36848 * cleanup existing test_tasks pep8/sanity issues

* Fix redundant yaml error blurbs on ModArgs parse errors Some of the AnsibleParserErrors from parsing.mod_args are created with the obj=some_yaml_ds options but some are not. If they were, we don't want to add another yaml_ds to it, because that will result in double yaml error blurbs. And since we dont need to add info, we can just re raise it. But if there is no ._obj, add it here so we get the extra detail in the error message (see issue #14790) and raise a new AnsibleParserError instance. Fixes #36848 * cleanup existing test_tasks pep8/sanity issues (cherry picked from commit e166946)

ansibot added affects_2.4 This issue/PR affects Ansible v2.4 bug_report needs_triage Needs a first human triage before being processed. python3 support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Feb 28, 2018

jborean93 removed the needs_triage Needs a first human triage before being processed. label Feb 28, 2018

alikins self-assigned this Mar 1, 2018

ansibot added the bug This issue/PR relates to a bug. label Mar 1, 2018

alikins mentioned this issue Mar 1, 2018

Fix redundant yaml error blurbs on ModArgs parse errors #36923

Merged

ansibot removed the bug_report label Mar 1, 2018

abadger removed the python3 label Mar 19, 2018

bcoca closed this as completed in #36923 Mar 19, 2018

ansible locked and limited conversation to collaborators Apr 27, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Double extended error message in AnsibleParserError (triple in 2.4) #36848

Double extended error message in AnsibleParserError (triple in 2.4) #36848

diafour commented Feb 28, 2018

ansibot commented Feb 28, 2018

diafour commented Feb 28, 2018 •

edited

ansibot commented Feb 28, 2018

ansibot commented Feb 28, 2018

alikins commented Mar 1, 2018

alikins commented Mar 1, 2018

Double extended error message in AnsibleParserError (triple in 2.4) #36848

Double extended error message in AnsibleParserError (triple in 2.4) #36848

Comments

diafour commented Feb 28, 2018

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

CONFIGURATION

OS / ENVIRONMENT

SUMMARY

STEPS TO REPRODUCE

EXPECTED RESULTS

ACTUAL RESULTS

devel branch:

version 2.4 (git checkout stable-2.4)

ansibot commented Feb 28, 2018

diafour commented Feb 28, 2018 • edited

ansibot commented Feb 28, 2018

ansibot commented Feb 28, 2018

alikins commented Mar 1, 2018

alikins commented Mar 1, 2018

diafour commented Feb 28, 2018 •

edited