Report fact exceptions 25365 #25708

alikins · 2017-06-14T16:51:22Z

SUMMARY

Add a 'fail_on_error' option to setup.py and set a 'ansible_facts_exceptions' with any fact collector exceptions.

If setup.py encounters an exception while running a fact
collector, the default (fail_on_error=False) is to not consider
that a fatal error. In that case, all collectors will run,
and any exceptions found will be collected in 'ansible_facts_exceptions'
and returned in the 'facts_exceptions' return value.

If 'fail_on_error=True', the module will return a failure (fail_json()).
The 'ansible_facts_exceptions' and 'facts_exceptions' return value will
still have the list of exceptions encounterd. The first exception in
the list will be returned as the 'exception' return value so callback
plugins can display it.

This is provided to aid in debugging fact collection errors.

Fixes #25365

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME

lib/ansible/modules_utils/facts/system/setup.py

ANSIBLE VERSION

ansible 2.4.0 (report_fact_exceptions_25365 2960a510a6) last updated 2017/06/14 12:45:40 (GMT -400)
  config file = None
  configured module search path = [u'/home/adrian/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /home/adrian/src/ansible/lib/ansible
  executable location = /home/adrian/src/ansible/bin/ansible
  python version = 2.7.13 (default, May 10 2017, 20:04:28) [GCC 6.3.1 20161221 (Red Hat 6.3.1-1)]

ADDITIONAL INFORMATION

Example output when running 'ansible -vvv localhost -m setup.py -a fail_on_error=True' where the 'local' facts collector hits a divide-by-zero

The full traceback is:
Traceback (most recent call last):
  File "/tmp/ansible_chVxqA/ansible_module_setup.py", line 180, in collect
    collected_facts=collected_facts)
  File "/tmp/ansible_chVxqA/ansible_modlib.zip/ansible/module_utils/facts/collector.py", line 68, in collect_with_namespace
    facts_dict = self.collect(module=module, collected_facts=collected_facts)
  File "/tmp/ansible_chVxqA/ansible_modlib.zip/ansible/module_utils/facts/system/env.py", line 34, in collect
    raise Exception("Just a test exception from env fact collector")
Exception: Just a test exception from env fact collector

localhost | FAILED! => {
    "changed": false, 
    "facts_exceptions": [
        {
            "collector_name": "env", 
            "error_message": "Just a test exception from env fact collector", 
            "traceback": "Traceback (most recent call last):\n  File \"/tmp/ansible_chVxqA/ansible_module_setup.py\", line 180, in collect\n    collected_facts=collected_facts)\n  File \"/tmp/ansible_chVxqA/ansible_modlib.zip/ansible/module_utils/facts/collector.py\", line 68, in collect_with_namespace\n    facts_dict = self.collect(module=module, collected_facts=collected_facts)\n  File \"/tmp/ansible_chVxqA/ansible_modlib.zip/ansible/module_utils/facts/system/env.py\", line 34, in collect\n    raise Exception(\"Just a test exception from env fact collector\")\nException: Just a test exception from env fact collector\n"
        }, 
        {
            "collector_name": "local", 
            "error_message": "division by zero", 
            "traceback": "Traceback (most recent call last):\n  File \"/tmp/ansible_chVxqA/ansible_module_setup.py\", line 180, in collect\n    collected_facts=collected_facts)\n  File \"/tmp/ansible_chVxqA/ansible_modlib.zip/ansible/module_utils/facts/collector.py\", line 68, in collect_with_namespace\n    facts_dict = self.collect(module=module, collected_facts=collected_facts)\n  File \"/tmp/ansible_chVxqA/ansible_modlib.zip/ansible/module_utils/facts/system/local.py\", line 40, in collect\n    37/0\nZeroDivisionError: division by zero\n"
        }
    ], 
    "failed": true, 
    "invocation": {
        "module_args": {
            "fact_path": "/etc/ansible/facts.d", 
            "fail_on_error": true, 
            "filter": "*", 
            "gather_subset": [
                "all"
            ], 
            "gather_timeout": 10
        }
    }, 
    "msg": "There was one or more exceptions while collecting facts and fail_on_error is True. The first exception is provided as the 'exception' return value."
}

Fixes #25365

If setup.py encounters an exception while running a fact collector, the default (fail_on_error=False) is to not consider that a fatal error. In that case, all collectors will run, and any exceptions found will be collected in 'ansible_facts_exceptions' and returned in the 'facts_exceptions' return value. If 'fail_on_error=True', the module will return a failure (fail_json()). The 'ansible_facts_exceptions' and 'facts_exceptions' return value will still have the list of exceptions encounterd. The first exception in the list will be returned as the 'exception' return value so callback plugins can display it. This is provided to aid in debugging fact collection errors. Fixes #25365

alikins · 2017-06-14T16:52:56Z

Example sections of facts output of 'ansible localhost -m setup' (default fail_on_error behavior)

    "ansible_facts_exceptions": [
        {
            "collector_name": "env", 
            "error_message": "Just a test exception from env fact collector", 
            "traceback": "Traceback (most recent call last):\n  File \"/home/adrian/debug_dir/ansible_module_setup.py\", line 180, in collect\n    collected_facts=collected_facts)\n  File \"/home/adrian/debug_dir/ansible/module_utils/facts/collector.py\", line 68, in collect_with_namespace\n    facts_dict = self.collect(module=module, collected_facts=collected_facts)\n  File \"/home/adrian/debug_dir/ansible/module_utils/facts/system/env.py\", line 34, in collect\n    raise Exception(\"Just a test exception from env fact collector\")\nException: Just a test exception from env fact collector\n"
        }, 
        {
            "collector_name": "local", 
            "error_message": "division by zero", 
            "traceback": "Traceback (most recent call last):\n  File \"/home/adrian/debug_dir/ansible_module_setup.py\", line 180, in collect\n    collected_facts=collected_facts)\n  File \"/home/adrian/debug_dir/ansible/module_utils/facts/collector.py\", line 68, in collect_with_namespace\n    facts_dict = self.collect(module=module, collected_facts=collected_facts)\n  File \"/home/adrian/debug_dir/ansible/module_utils/facts/system/local.py\", line 40, in collect\n    37/0\nZeroDivisionError: division by zero\n"
        }
    ],

alikins · 2017-06-14T16:54:46Z

Example output for: ansible localhost -m setup -a 'fail_on_error=True'
(verbosity was default, so exception not shown like -vvv)

[newswoop:F25:ansible (report_fact_exceptions_25365 %)]$ ansible localhost -m setup -a 'fail_on_error=True'
 [WARNING]: No inventory was parsed, only implicit localhost is available

 [WARNING]: provided hosts list is empty, only localhost is available

An exception occurred during task execution. To see the full traceback, use -vvv. The error was: ZeroDivisionError: division by zero
localhost | FAILED! => {
    "changed": false, 
    "facts_exceptions": [
        {
            "collector_name": "local", 
            "error_message": "division by zero", 
            "traceback": "Traceback (most recent call last):\n  File \"/tmp/ansible_TbCY4V/ansible_module_setup.py\", line 189, in collect\n    collected_facts=collected_facts)\n  File \"/tmp/ansible_TbCY4V/ansible_modlib.zip/ansible/module_utils/facts/collector.py\", line 68, in collect_with_namespace\n    facts_dict = self.collect(module=module, collected_facts=collected_facts)\n  File \"/tmp/ansible_TbCY4V/ansible_modlib.zip/ansible/module_utils/facts/system/local.py\", line 40, in collect\n    37/0\nZeroDivisionError: division by zero\n"
        }, 
        {
            "collector_name": "env", 
            "error_message": "Just a test exception from env fact collector", 
            "traceback": "Traceback (most recent call last):\n  File \"/tmp/ansible_TbCY4V/ansible_module_setup.py\", line 189, in collect\n    collected_facts=collected_facts)\n  File \"/tmp/ansible_TbCY4V/ansible_modlib.zip/ansible/module_utils/facts/collector.py\", line 68, in collect_with_namespace\n    facts_dict = self.collect(module=module, collected_facts=collected_facts)\n  File \"/tmp/ansible_TbCY4V/ansible_modlib.zip/ansible/module_utils/facts/system/env.py\", line 34, in collect\n    raise Exception(\"Just a test exception from env fact collector\")\nException: Just a test exception from env fact collector\n"
        }
    ], 
    "failed": true, 
    "msg": "There was one or more exceptions while collecting facts and fail_on_error is True. The first exception is provided as the 'exception' return value."
}

alikins · 2017-06-14T16:57:12Z

Example output of: ansible localhost -m setup -a 'fail_on_error=False'
(fail_on_error=False is the default as well)


[newswoop:F25:ansible (report_fact_exceptions_25365 %)]$ ansible localhost -m setup -a 'fail_on_error=False'
 [WARNING]: No inventory was parsed, only implicit localhost is available

 [WARNING]: provided hosts list is empty, only localhost is available

localhost | SUCCESS => {
    "ansible_facts": {
        "ansible_all_ipv4_addresses": [
            "192.168.1.140", 
            "192.168.122.1", 
            "192.168.1.102"
        ], 

<  LOTS AND LOTS OF NORMAL FACTS CUT FOR SPACE >

        "gather_subset": [
            "all"
        ], 
        "module_setup": true
    }, 
    "ansible_facts_exceptions": [
        {
            "collector_name": "local", 
            "error_message": "division by zero", 
            "traceback": "Traceback (most recent call last):\n  File \"/tmp/ansible_wRem0r/ansible_module_setup.py\", line 189, in collect\n    collected_facts=collected_facts)\n  File \"/tmp/ansible_wRem0r/ansible_modlib.zip/ansible/module_utils/facts/collector.py\", line 68, in collect_with_namespace\n    facts_dict = self.collect(module=module, collected_facts=collected_facts)\n  File \"/tmp/ansible_wRem0r/ansible_modlib.zip/ansible/module_utils/facts/system/local.py\", line 40, in collect\n    37/0\nZeroDivisionError: division by zero\n"
        }, 
        {
            "collector_name": "env", 
            "error_message": "Just a test exception from env fact collector", 
            "traceback": "Traceback (most recent call last):\n  File \"/tmp/ansible_wRem0r/ansible_module_setup.py\", line 189, in collect\n    collected_facts=collected_facts)\n  File \"/tmp/ansible_wRem0r/ansible_modlib.zip/ansible/module_utils/facts/collector.py\", line 68, in collect_with_namespace\n    facts_dict = self.collect(module=module, collected_facts=collected_facts)\n  File \"/tmp/ansible_wRem0r/ansible_modlib.zip/ansible/module_utils/facts/system/env.py\", line 34, in collect\n    raise Exception(\"Just a test exception from env fact collector\")\nException: Just a test exception from env fact collector\n"
        }
    ], 
    "changed": false, 
    "failed": false
}

bcoca · 2017-06-14T17:10:43Z

i would add 2nd toggle to return all exceptions, the default is would be not to fail on many of the errors (this varied in previous code) ... facts are normally big/slow enough to not add tons of normally unused exception output to results

ansibot · 2017-06-14T18:22:24Z

The test ansible-test sanity --test pep8 failed with the following error:

lib/ansible/modules/system/setup.py:195:17: E265 block comment should start with '# '

click here for bot help

It doesn't test fail_on_error=true with collector exceptions yet though.

ansibot · 2017-06-14T18:40:06Z

The test ansible-test sanity --test pep8 failed with the following error:

lib/ansible/modules/system/setup.py:195:17: E265 block comment should start with '# '

click here for bot help

ansibot · 2017-08-24T16:00:50Z

cc @david_obrien
click here for bot help

ansibot · 2018-11-26T03:17:09Z

cc @davidobrien1985
click here for bot help

jimi-c · 2020-06-05T15:40:53Z

Hi @alikins, going through backlog and saw this was quite out of date. Per discussion we're going to close this and add a future project to re-evaluate how we handle this problem.

Thanks!

alikins added 2 commits June 14, 2017 11:45

Return a fact with any exceptions from fact collection

58a376b

Fixes #25365

ansibot added affects_2.4 This issue/PR affects Ansible v2.4 bugfix_pull_request core_review In order to be merged, this PR must follow the core review workflow. module This issue/PR relates to a module. needs_triage Needs a first human triage before being processed. labels Jun 14, 2017

alikins mentioned this pull request Jun 14, 2017

Setup module debugging: traceback missing in 2.4 #25365

Closed

pep8

c4355ef

add some unit tests for facts_exceptions

e82fe8b

ansibot added needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI. test_pull_requests and removed needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI. labels Jun 14, 2017

ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Jun 14, 2017

add an intg test for setup.py with fail_on_error=true

d140269

It doesn't test fail_on_error=true with collector exceptions yet though.

ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Jun 14, 2017

ansibot added the ci_verified Changes made in this PR are causing tests to fail. label Jun 14, 2017

nitzmahone removed the needs_triage Needs a first human triage before being processed. label Jun 15, 2017

ansibot added stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Jun 23, 2017

ansibot added the needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html label Jul 18, 2017

ansibot added the test This PR relates to tests. label Sep 1, 2017

ansibot added the support:community This issue/PR relates to code supported by the Ansible community. label Nov 21, 2017

ansibot added bug This issue/PR relates to a bug. and removed bugfix_pull_request labels Mar 2, 2018

ansibot added the traceback This issue/PR includes a traceback. label May 29, 2018

dagwieers added test This PR relates to tests. and removed test This PR relates to tests. test_pull_requests labels Jun 22, 2018

ansibot added the system System category label Feb 17, 2019

ansibot added the has_issue label Jul 28, 2019

jimi-c closed this Jun 5, 2020

ansible locked and limited conversation to collaborators Jul 3, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Report fact exceptions 25365 #25708

Report fact exceptions 25365 #25708

alikins commented Jun 14, 2017 •

edited

Loading

alikins commented Jun 14, 2017

alikins commented Jun 14, 2017 •

edited

Loading

alikins commented Jun 14, 2017

bcoca commented Jun 14, 2017

ansibot commented Jun 14, 2017

ansibot commented Jun 14, 2017

ansibot commented Aug 24, 2017

ansibot commented Nov 26, 2018

jimi-c commented Jun 5, 2020

Report fact exceptions 25365 #25708

Report fact exceptions 25365 #25708

Conversation

alikins commented Jun 14, 2017 • edited Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

ADDITIONAL INFORMATION

alikins commented Jun 14, 2017

alikins commented Jun 14, 2017 • edited Loading

alikins commented Jun 14, 2017

bcoca commented Jun 14, 2017

ansibot commented Jun 14, 2017

ansibot commented Jun 14, 2017

ansibot commented Aug 24, 2017

ansibot commented Nov 26, 2018

jimi-c commented Jun 5, 2020

alikins commented Jun 14, 2017 •

edited

Loading

alikins commented Jun 14, 2017 •

edited

Loading