diff --git a/changelogs/fragments/fix_src_backup_with_module_alias.yaml b/changelogs/fragments/fix_src_backup_with_module_alias.yaml new file mode 100644 index 0000000..fb641c9 --- /dev/null +++ b/changelogs/fragments/fix_src_backup_with_module_alias.yaml @@ -0,0 +1,3 @@ +--- +bugfixes: + - Make `src`, `backup` and `backup_options` in vyos_config work when module alias is used (https://github.com/ansible-collections/vyos.vyos/pull/67). diff --git a/plugins/action/vyos.py b/plugins/action/vyos.py index cab2f3f..9519d36 100644 --- a/plugins/action/vyos.py +++ b/plugins/action/vyos.py @@ -1,129 +1,131 @@ # # (c) 2016 Red Hat Inc. # # This file is part of Ansible # # Ansible is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # Ansible is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with Ansible. If not, see . # from __future__ import absolute_import, division, print_function __metaclass__ = type import sys import copy from ansible_collections.ansible.netcommon.plugins.action.network import ( ActionModule as ActionNetworkModule, ) from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import ( load_provider, ) from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import ( vyos_provider_spec, ) from ansible.utils.display import Display display = Display() class ActionModule(ActionNetworkModule): def run(self, tmp=None, task_vars=None): del tmp # tmp no longer has any effect module_name = self._task.action.split(".")[-1] - self._config_module = True if module_name == "vyos_config" else False + self._config_module = ( + True if module_name in ["vyos_config", "config"] else False + ) persistent_connection = self._play_context.connection.split(".")[-1] warnings = [] if persistent_connection == "network_cli": provider = self._task.args.get("provider", {}) if any(provider.values()): display.warning( "provider is unnecessary when using network_cli and will be ignored" ) del self._task.args["provider"] elif self._play_context.connection == "local": provider = load_provider(vyos_provider_spec, self._task.args) pc = copy.deepcopy(self._play_context) pc.connection = "ansible.netcommon.network_cli" pc.network_os = "vyos.vyos.vyos" pc.remote_addr = provider["host"] or self._play_context.remote_addr pc.port = int(provider["port"] or self._play_context.port or 22) pc.remote_user = ( provider["username"] or self._play_context.connection_user ) pc.password = provider["password"] or self._play_context.password pc.private_key_file = ( provider["ssh_keyfile"] or self._play_context.private_key_file ) connection = self._shared_loader_obj.connection_loader.get( "ansible.netcommon.persistent", pc, sys.stdin, task_uuid=self._task._uuid, ) # TODO: Remove below code after ansible minimal is cut out if connection is None: pc.connection = "network_cli" pc.network_os = "vyos" connection = self._shared_loader_obj.connection_loader.get( "persistent", pc, sys.stdin, task_uuid=self._task._uuid ) display.vvv( "using connection plugin %s (was local)" % pc.connection, pc.remote_addr, ) command_timeout = ( int(provider["timeout"]) if provider["timeout"] else connection.get_option("persistent_command_timeout") ) connection.set_options( direct={"persistent_command_timeout": command_timeout} ) socket_path = connection.run() display.vvvv("socket_path: %s" % socket_path, pc.remote_addr) if not socket_path: return { "failed": True, "msg": "unable to open shell. Please see: " + "https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell", } task_vars["ansible_socket"] = socket_path warnings.append( [ "connection local support for this module is deprecated and will be removed in version 2.14, use connection %s" % pc.connection ] ) else: return { "failed": True, "msg": "Connection type %s is not valid for this module" % self._play_context.connection, } result = super(ActionModule, self).run(task_vars=task_vars) if warnings: if "warnings" in result: result["warnings"].extend(warnings) else: result["warnings"] = warnings return result diff --git a/tests/integration/targets/vyos_config/templates/config.j2 b/tests/integration/targets/vyos_config/templates/config.j2 new file mode 100644 index 0000000..fc4d42c --- /dev/null +++ b/tests/integration/targets/vyos_config/templates/config.j2 @@ -0,0 +1,2 @@ +set interfaces ethernet eth0 description TEST-INTF +set system login user test_user diff --git a/tests/integration/targets/vyos_config/tests/redirection/cli/shortname.yaml b/tests/integration/targets/vyos_config/tests/redirection/cli/shortname.yaml index ac84154..3f3e489 100644 --- a/tests/integration/targets/vyos_config/tests/redirection/cli/shortname.yaml +++ b/tests/integration/targets/vyos_config/tests/redirection/cli/shortname.yaml @@ -1,57 +1,99 @@ --- - debug: msg="START cli/shortname.yaml on connection={{ ansible_connection }}" - name: setup- ensure interface is not present vyos.vyos.config: lines: delete interfaces loopback lo - name: setup- create interface register: result vyos.vyos.config: lines: - interfaces - interfaces loopback lo - interfaces loopback lo description test - name: Check that multiple duplicate lines collapse into a single commands assert: that: - '{{ result.commands|length }} == 1' - name: Check that set is correctly prepended assert: that: - result.commands[0] == 'set interfaces loopback lo description test' - name: configure config_check config command register: result vyos.vyos.config: lines: delete interfaces loopback lo - assert: that: - result.changed == true - name: check config_check config command idempontent register: result vyos.vyos.config: lines: delete interfaces loopback lo - assert: that: - result.changed == false - name: check multiple line config filter is working register: result vyos.vyos.config: lines: - set system login user esa level admin - set system login user esa authentication encrypted-password '!abc!' - set system login user vyos level admin - set system login user vyos authentication encrypted-password 'abc' - assert: that: - '{{ result.filtered|length }} == 2' +- name: Remove interface description and delete temp user + vyos.vyos.config: &cleanup + lines: + - "delete interfaces ethernet eth0 description TEST-INTF" + - "delete system login user test_user" + +- name: Use src with module alias + register: result + vyos.vyos.config: + src: config.j2 + +- assert: + that: + - result.changed == true + - '"set interfaces ethernet eth0 description TEST-INTF" in result.commands' + - '"set system login user test_user" in result.commands' + +- name: "Restore hostname to {{ inventory_hostname }} and delete temp user" + vyos.vyos.config: *cleanup + +- name: use module alias to take configuration backup + register: result + vyos.vyos.config: + backup: true + backup_options: + filename: backup_with_alias.cfg + dir_path: '{{ role_path }}/backup_test_dir/{{ inventory_hostname_short }}' + +- assert: + that: + - result.changed == true + +- name: check if the backup file-4 exist + find: + paths: '{{ role_path }}/backup_test_dir/{{ inventory_hostname_short }}/backup_with_alias.cfg' + register: backup_file + connection: local + +- assert: + that: + - backup_file.files is defined + - debug: msg="END cli/shortname.yaml on connection={{ ansible_connection }}"