ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Fix error on 'help module' in ansible-console (#19390)

Browse source 
If 'help xattr' for example, ansible-console would
traceback because module_docs.get_docstring() now
returns 4 values (module metadata was added)
This commit is contained in:
Adrian Likins 2016-12-20 15:50:29 -05:00 committed by GitHub
parent ebf835045f
commit 727ca6f436
2 changed files with 22 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lib/ansible/cli/console.py
View file

@ -356,7 +356,7 @@ class ConsoleCLI(CLI, cmd.Cmd):
if module_name in self.modules:
in_path = module_loader.find_plugin(module_name)
if in_path:
oc, a, _ = module_docs.get_docstring(in_path)
oc, a, _, _ = module_docs.get_docstring(in_path)
if oc:
display.display(oc['short_description'])
display.display('Parameters:')
@ -388,8 +388,8 @@ class ConsoleCLI(CLI, cmd.Cmd):
def module_args(self, module_name):
in_path = module_loader.find_plugin(module_name)
oc, a, _ = module_docs.get_docstring(in_path)
return oc['options'].keys()
oc, a, _, _ = module_docs.get_docstring(in_path)
return list(oc['options'].keys())
def run(self):

19
test/units/cli/test_console.py
View file

@ -20,6 +20,7 @@ from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
from ansible.compat.tests import unittest
from ansible.compat.tests.mock import patch
from ansible.cli.console import ConsoleCLI
@ -30,3 +31,21 @@ class TestConsoleCLI(unittest.TestCase):
cli.parse()
self.assertTrue(cli.parser is not None)
def test_module_args(self):
cli = ConsoleCLI([])
cli.parse()
res = cli.module_args('copy')
self.assertTrue(cli.parser is not None)
self.assertIn('src', res)
self.assertIn('backup', res)
self.assertIsInstance(res, list)
@patch('ansible.utils.display.Display.display')
def test_helpdefault(self, mock_display):
cli = ConsoleCLI([])
cli.parse()
cli.modules = set(['copy'])
cli.helpdefault('copy')
self.assertTrue(cli.parser is not None)
self.assertTrue(len(mock_display.call_args_list) > 0,
"display.display should have been called but was not")