Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix broken slxos_config due to changed backup options #58804

Merged
merged 1 commit into from
Jul 8, 2019
Merged

Fix broken slxos_config due to changed backup options #58804

merged 1 commit into from
Jul 8, 2019

Conversation

LindsayHill
Copy link
Contributor

SUMMARY

PR #50301 overhauled network backup options. A change was missed in slxos_config, resulting in inability to use slxos_config.

This applies to both devel and 2.8.2. We'll probably need to backport this fix

ISSUE TYPE
  • Bugfix Pull Request
COMPONENT NAME

lib/ansible/modules/network/slxos/slxos_config.py
lib/ansible/plugins/action/slxos_config.py

ADDITIONAL INFORMATION

PR #50301 removed lib/ansible/module_utils/network/common/backup.py. Most action plugins were updated to account for this, but slxos_config.py was missed.

This means that slxos_config is unusable in 2.8 and devel.

Simple playbook used for testing:

---
- hosts: slx01
  gather_facts: no

  tasks:
    - name: NTP server 172.16.10.3
      slxos_config:
        lines: "ntp server 172.16.10.3 use-vrf mgmt-vrf"
        save_when: changed
        backup: yes

Example output using Ansible 2.8.2:

lhill @ Lindsays-MacBook-Pro $ ansible-playbook -i hosts slx_config_set_ntp.yaml -vvvv
ansible-playbook 2.8.2
  config file = None
  configured module search path = [u'/Users/lhill/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /Users/lhill/venv/lib/python2.7/site-packages/ansible
  executable location = /Users/lhill/venv/bin/ansible-playbook
  python version = 2.7.10 (default, Feb 22 2019, 21:55:15) [GCC 4.2.1 Compatible Apple LLVM 10.0.1 (clang-1001.0.37.14)]
No config file found; using defaults
setting up inventory plugins
host_list declined parsing /Users/lhill/github/ansible-extreme/slxos/playbooks/hosts as it did not pass it's verify_file() method
script declined parsing /Users/lhill/github/ansible-extreme/slxos/playbooks/hosts as it did not pass it's verify_file() method
auto declined parsing /Users/lhill/github/ansible-extreme/slxos/playbooks/hosts as it did not pass it's verify_file() method
Parsed /Users/lhill/github/ansible-extreme/slxos/playbooks/hosts inventory source with ini plugin
Loading callback plugin default of type stdout, v2.0 from /Users/lhill/venv/lib/python2.7/site-packages/ansible/plugins/callback/default.pyc

PLAYBOOK: slx_config_set_ntp.yaml ******************************************************************************************************
Positional arguments: slx_config_set_ntp.yaml
become_method: sudo
inventory: (u'/Users/lhill/github/ansible-extreme/slxos/playbooks/hosts',)
forks: 5
tags: (u'all',)
verbosity: 4
connection: smart
timeout: 10
1 plays in slx_config_set_ntp.yaml

PLAY [slx01] ***************************************************************************************************************************
META: ran handlers
ERROR! Unexpected Exception, this is probably a bug: No module named backup
the full traceback was:

Traceback (most recent call last):
  File "/Users/lhill/venv/bin/ansible-playbook", line 110, in <module>
    exit_code = cli.run()
  File "/Users/lhill/venv/lib/python2.7/site-packages/ansible/cli/playbook.py", line 123, in run
    results = pbex.run()
  File "/Users/lhill/venv/lib/python2.7/site-packages/ansible/executor/playbook_executor.py", line 169, in run
    result = self._tqm.run(play=play)
  File "/Users/lhill/venv/lib/python2.7/site-packages/ansible/executor/task_queue_manager.py", line 249, in run
    play_return = strategy.run(iterator, play_context)
  File "/Users/lhill/venv/lib/python2.7/site-packages/ansible/plugins/strategy/linear.py", line 245, in run
    action = action_loader.get(task.action, class_only=True)
  File "/Users/lhill/venv/lib/python2.7/site-packages/ansible/plugins/loader.py", line 558, in get
    self._module_cache[path] = self._load_module_source(name, path)
  File "/Users/lhill/venv/lib/python2.7/site-packages/ansible/plugins/loader.py", line 536, in _load_module_source
    module = imp.load_source(to_native(full_name), to_native(path), module_file)
  File "/Users/lhill/venv/lib/python2.7/site-packages/ansible/plugins/action/slxos_config.py", line 26, in <module>
    from ansible.module_utils.network.common.backup import write_backup, handle_template
ImportError: No module named backup
lhill @ Lindsays-MacBook-Pro $

Output after making changes in this PR

lhill @ Lindsays-MacBook-Pro $ ansible-playbook -i hosts slx_config_set_ntp.yaml -vvvv
ansible-playbook 2.8.2
  config file = None
  configured module search path = [u'/Users/lhill/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /Users/lhill/venv/lib/python2.7/site-packages/ansible
  executable location = /Users/lhill/venv/bin/ansible-playbook
  python version = 2.7.10 (default, Feb 22 2019, 21:55:15) [GCC 4.2.1 Compatible Apple LLVM 10.0.1 (clang-1001.0.37.14)]
No config file found; using defaults
setting up inventory plugins
host_list declined parsing /Users/lhill/github/ansible-extreme/slxos/playbooks/hosts as it did not pass it's verify_file() method
script declined parsing /Users/lhill/github/ansible-extreme/slxos/playbooks/hosts as it did not pass it's verify_file() method
auto declined parsing /Users/lhill/github/ansible-extreme/slxos/playbooks/hosts as it did not pass it's verify_file() method
Parsed /Users/lhill/github/ansible-extreme/slxos/playbooks/hosts inventory source with ini plugin
Loading callback plugin default of type stdout, v2.0 from /Users/lhill/venv/lib/python2.7/site-packages/ansible/plugins/callback/default.pyc

PLAYBOOK: slx_config_set_ntp.yaml ******************************************************************************************************
Positional arguments: slx_config_set_ntp.yaml
become_method: sudo
inventory: (u'/Users/lhill/github/ansible-extreme/slxos/playbooks/hosts',)
forks: 5
tags: (u'all',)
verbosity: 4
connection: smart
timeout: 10
1 plays in slx_config_set_ntp.yaml

PLAY [slx01] ***************************************************************************************************************************
META: ran handlers

TASK [NTP server 172.16.10.3] **********************************************************************************************************
task path: /Users/lhill/github/ansible-extreme/slxos/playbooks/slx_config_set_ntp.yaml:6
<slx01> attempting to start connection
<slx01> using connection plugin network_cli
<slx01> local domain socket does not exist, starting it
<slx01> control socket path is /Users/lhill/.ansible/pc/0dbd5c273e
<slx01> <slx01> ESTABLISH PARAMIKO SSH CONNECTION FOR USER: admin on PORT 22 TO slx01
<slx01> connection to remote device started successfully
<slx01> local domain socket listeners started successfully
<slx01> loaded cliconf plugin for network_os slxos
<slx01> ssh connection done, setting terminal
<slx01> loaded terminal plugin for network_os slxos
<slx01> Response received, triggered 'persistent_buffer_read_timeout' timer of 0.1 seconds
<slx01> firing event: on_open_shell()
<slx01> Response received, triggered 'persistent_buffer_read_timeout' timer of 0.1 seconds
<slx01> ssh connection has completed successfully
<slx01>
<slx01> local domain socket path is /Users/lhill/.ansible/pc/0dbd5c273e
<slx01> ESTABLISH LOCAL CONNECTION FOR USER: lhill
<slx01> EXEC /bin/sh -c '( umask 77 && mkdir -p "` echo /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540345.47-108247373026628 `" && echo ansible-tmp-1562540345.47-108247373026628="` echo /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540345.47-108247373026628 `" ) && sleep 0'
<slx01> Attempting python interpreter discovery
<slx01> EXEC /bin/sh -c 'echo PLATFORM; uname; echo FOUND; command -v '"'"'/usr/bin/python'"'"'; command -v '"'"'python3.7'"'"'; command -v '"'"'python3.6'"'"'; command -v '"'"'python3.5'"'"'; command -v '"'"'python2.7'"'"'; command -v '"'"'python2.6'"'"'; command -v '"'"'/usr/libexec/platform-python'"'"'; command -v '"'"'/usr/bin/python3'"'"'; command -v '"'"'python'"'"'; echo ENDFOUND && sleep 0'
<slx01> Python interpreter discovery fallback (unsupported platform for extended discovery: darwin)
Using module file /Users/lhill/venv/lib/python2.7/site-packages/ansible/modules/network/slxos/slxos_config.py
<slx01> PUT /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/tmpi6pLG8 TO /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540345.47-108247373026628/AnsiballZ_slxos_config.py
<slx01> EXEC /bin/sh -c 'chmod u+x /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540345.47-108247373026628/ /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540345.47-108247373026628/AnsiballZ_slxos_config.py && sleep 0'
<slx01> EXEC /bin/sh -c '/usr/bin/python /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540345.47-108247373026628/AnsiballZ_slxos_config.py && sleep 0'
<slx01> EXEC /bin/sh -c 'rm -f -r /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540345.47-108247373026628/ > /dev/null 2>&1 && sleep 0'
<slx01> EXEC /bin/sh -c '( umask 77 && mkdir -p "` echo /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540358.36-37340971994596 `" && echo ansible-tmp-1562540358.36-37340971994596="` echo /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540358.36-37340971994596 `" ) && sleep 0'
Using module file /Users/lhill/venv/lib/python2.7/site-packages/ansible/modules/files/stat.py
<slx01> PUT /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/tmp3nnlWE TO /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540358.36-37340971994596/AnsiballZ_stat.py
<slx01> EXEC /bin/sh -c 'chmod u+x /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540358.36-37340971994596/ /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540358.36-37340971994596/AnsiballZ_stat.py && sleep 0'
<slx01> EXEC /bin/sh -c '/usr/bin/python /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540358.36-37340971994596/AnsiballZ_stat.py && sleep 0'
<slx01> PUT /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/tmpzK8sa3 TO /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540358.36-37340971994596/source
<slx01> EXEC /bin/sh -c 'chmod u+x /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540358.36-37340971994596/ /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540358.36-37340971994596/source && sleep 0'
Using module file /Users/lhill/venv/lib/python2.7/site-packages/ansible/modules/files/copy.py
<slx01> PUT /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/tmpmTwfLo TO /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540358.36-37340971994596/AnsiballZ_copy.py
<slx01> EXEC /bin/sh -c 'chmod u+x /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540358.36-37340971994596/ /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540358.36-37340971994596/AnsiballZ_copy.py && sleep 0'
<slx01> EXEC /bin/sh -c '/usr/bin/python /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540358.36-37340971994596/AnsiballZ_copy.py && sleep 0'
<slx01> EXEC /bin/sh -c 'rm -f -r /Users/lhill/.ansible/tmp/ansible-local-19295wupicU/ansible-tmp-1562540358.36-37340971994596/ > /dev/null 2>&1 && sleep 0'
 [WARNING]: Platform darwin on host slx01 is using the discovered Python interpreter at /usr/bin/python, but future installation of
another Python interpreter could change this. See https://docs.ansible.com/ansible/2.8/reference_appendices/interpreter_discovery.html
for more information.

changed: [slx01] => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/bin/python"
    },
    "backup_path": "/Users/lhill/github/ansible-extreme/slxos/playbooks/backup/slx01_config.2019-07-07@15:59:18",
    "changed": true,
    "commands": [
        "ntp server 172.16.10.3 use-vrf mgmt-vrf"
    ],
    "date": "2019-07-07",
    "filename": "slx01_config.2019-07-07@15:59:18",
    "invocation": {
        "module_args": {
            "after": null,
            "backup": true,
            "backup_options": null,
            "before": null,
            "defaults": false,
            "diff_against": null,
            "diff_ignore_lines": null,
            "intended_config": null,
            "lines": [
                "ntp server 172.16.10.3 use-vrf mgmt-vrf"
            ],
            "match": "line",
            "multiline_delimiter": "@",
            "parents": null,
            "replace": "line",
            "running_config": null,
            "save_when": "changed",
            "src": null
        }
    },
    "shortname": "/Users/lhill/github/ansible-extreme/slxos/playbooks/backup/slx01_config",
    "time": "15:59:18",
    "updates": [
        "ntp server 172.16.10.3 use-vrf mgmt-vrf"
    ]
}
META: ran handlers
META: ran handlers

PLAY RECAP *****************************************************************************************************************************
slx01                      : ok=1    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
lhill @ Lindsays-MacBook-Pro $

@ansibot ansibot added affects_2.9 This issue/PR affects Ansible v2.9 bug This issue/PR relates to a bug. community_review In order to be merged, this PR must follow the community review workflow. needs_triage Needs a first human triage before being processed. python3 small_patch support:community This issue/PR relates to code supported by the Ansible community. traceback This issue/PR includes a traceback. labels Jul 7, 2019
ganeshrn
ganeshrn approved these changes Jul 8, 2019
View reviewed changes
Copy link
Member

@ganeshrn ganeshrn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@LindsayHill Thank you!

@ganeshrn ganeshrn merged commit 5b2d1cc into ansible:devel Jul 8, 2019
@ganeshrn ganeshrn mentioned this pull request Jul 8, 2019
Merged
ganeshrn pushed a commit to ganeshrn/ansible that referenced this pull request Jul 8, 2019
@LindsayHill @ganeshrn
Fix broken slxos_config due to changed backup options (ansible#58804)
bf71380 
(cherry picked from commit 5b2d1cc)
@ganeshrn
Copy link
Member

ganeshrn commented Jul 8, 2019

Raised a backport PR #58810 for stable-2.8

@LindsayHill
Copy link
Contributor Author

Thanks for merging, and doing the backport. I should have been doing some testing with devel pre-2.8 release and picked it up

@sivel sivel removed the needs_triage Needs a first human triage before being processed. label Jul 8, 2019
abadger pushed a commit that referenced this pull request Jul 16, 2019
@LindsayHill @abadger
Fix broken slxos_config due to changed backup options (#58804)
044923e 
(cherry picked from commit 5b2d1cc)
@ansible ansible locked and limited conversation to collaborators Aug 5, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ganeshrn ganeshrn ganeshrn approved these changes

Assignees
No one assigned
Labels
affects_2.9 This issue/PR affects Ansible v2.9 bug This issue/PR relates to a bug. community_review In order to be merged, this PR must follow the community review workflow. python3 small_patch support:community This issue/PR relates to code supported by the Ansible community. traceback This issue/PR includes a traceback.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@LindsayHill @ganeshrn @sivel @ansibot