From 3a9083cf48bc43344b6252525b0f7da39c3b36dd Mon Sep 17 00:00:00 2001 From: James Mighion Date: Wed, 13 Dec 2017 06:36:43 -0800 Subject: [PATCH] ios_config save (#33791) * Fixing save so it still works. Adding changed as an option for save_when. * Updating unit tests. * Updating description to state that changed was added in 2.5. --- lib/ansible/modules/network/ios/ios_config.py | 34 ++++++++++++------- .../modules/network/ios/test_ios_config.py | 30 +++++++++++++++- 2 files changed, 51 insertions(+), 13 deletions(-) diff --git a/lib/ansible/modules/network/ios/ios_config.py b/lib/ansible/modules/network/ios/ios_config.py index a158efd818..2e2dd7f742 100644 --- a/lib/ansible/modules/network/ios/ios_config.py +++ b/lib/ansible/modules/network/ios/ios_config.py @@ -181,10 +181,12 @@ options: will only be copied to the startup-config if it has changed since the last save to startup-config. If the argument is set to I(never), the running-config will never be copied to the - startup-config + startup-config. If the argument is set to I(changed), then the running-config + will only be copied to the startup-config if the task has made a change. + I(changed) was added in Ansible 2.5. required: false default: never - choices: ['always', 'never', 'modified'] + choices: ['always', 'never', 'modified', 'changed'] version_added: "2.4" diff_against: description: @@ -366,6 +368,16 @@ def get_candidate(module): return candidate, banners +def save_config(module, result): + result['changed'] = True + if not module.check_mode: + run_commands(module, 'copy running-config startup-config\r') + else: + module.warn('Skipping command `copy running-config startup-config` ' + 'due to check_mode. Configuration not copied to ' + 'non-volatile storage') + + def main(): """ main entry point for module execution """ @@ -388,7 +400,7 @@ def main(): defaults=dict(type='bool', default=False), backup=dict(type='bool', default=False), - save_when=dict(choices=['always', 'never', 'modified'], default='never'), + save_when=dict(choices=['always', 'never', 'modified', 'changed'], default='never'), diff_against=dict(choices=['startup', 'intended', 'running']), diff_ignore_lines=dict(type='list'), @@ -474,20 +486,18 @@ def main(): diff_ignore_lines = module.params['diff_ignore_lines'] - if module.params['save_when'] != 'never': + if module.params['save_when'] == 'always' or module.params['save']: + save_config(module, result) + elif module.params['save_when'] == 'modified': output = run_commands(module, ['show running-config', 'show startup-config']) running_config = NetworkConfig(indent=1, contents=output[0], ignore_lines=diff_ignore_lines) startup_config = NetworkConfig(indent=1, contents=output[1], ignore_lines=diff_ignore_lines) - if running_config.sha1 != startup_config.sha1 or module.params['save_when'] == 'always': - result['changed'] = True - if not module.check_mode: - run_commands(module, 'copy running-config startup-config\r') - else: - module.warn('Skipping command `copy running-config startup-config` ' - 'due to check_mode. Configuration not copied to ' - 'non-volatile storage') + if running_config.sha1 != startup_config.sha1: + save_config(module, result) + elif module.params['save_when'] == 'changed' and result['changed']: + save_config(module, result) if module._diff: if not running_config: diff --git a/test/units/modules/network/ios/test_ios_config.py b/test/units/modules/network/ios/test_ios_config.py index 2294bce3fe..bdf88e033f 100644 --- a/test/units/modules/network/ios/test_ios_config.py +++ b/test/units/modules/network/ios/test_ios_config.py @@ -74,7 +74,35 @@ class TestIosConfigModule(TestIosModule): self.run_commands.return_value = "Hostname foo" set_module_args(dict(save_when='always')) self.execute_module(changed=True) - self.assertEqual(self.run_commands.call_count, 2) + self.assertEqual(self.run_commands.call_count, 1) + self.assertEqual(self.get_config.call_count, 0) + self.assertEqual(self.load_config.call_count, 0) + args = self.run_commands.call_args[0][1] + self.assertIn('copy running-config startup-config\r', args) + + def test_ios_config_save_changed_true(self): + src = load_fixture('ios_config_src.cfg') + set_module_args(dict(src=src, save_when='changed')) + commands = ['hostname foo', 'interface GigabitEthernet0/0', 'no ip address'] + self.execute_module(changed=True, commands=commands) + self.assertEqual(self.run_commands.call_count, 1) + self.assertEqual(self.get_config.call_count, 1) + self.assertEqual(self.load_config.call_count, 1) + args = self.run_commands.call_args[0][1] + self.assertIn('copy running-config startup-config\r', args) + + def test_aruba_config_save_changed_false(self): + set_module_args(dict(save_when='changed')) + self.execute_module(changed=False) + self.assertEqual(self.run_commands.call_count, 0) + self.assertEqual(self.get_config.call_count, 0) + self.assertEqual(self.load_config.call_count, 0) + + def test_ios_config_save(self): + self.run_commands.return_value = "hostname foo" + set_module_args(dict(save=True)) + self.execute_module(changed=True) + self.assertEqual(self.run_commands.call_count, 1) self.assertEqual(self.get_config.call_count, 0) self.assertEqual(self.load_config.call_count, 0) args = self.run_commands.call_args[0][1]