mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
ade3fc2893
When building in automated build systems, there are sometimes cases where the user doing the building does not have a .ssh directory. In this case, we need to mock out some os.path functions so that the add_host_key() function we're testing won't complain or try to create one.
112 lines
5 KiB
Python
112 lines
5 KiB
Python
# -*- coding: utf-8 -*-
|
|
# (c) 2015, Michael Scherer <mscherer@redhat.com>
|
|
#
|
|
# 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 <http://www.gnu.org/licenses/>.
|
|
|
|
import json
|
|
import os.path
|
|
|
|
import ansible.module_utils.basic
|
|
from ansible.compat.tests import unittest
|
|
from ansible.compat.tests.mock import Mock, patch
|
|
from ansible.module_utils import known_hosts
|
|
from units.mock.procenv import swap_stdin_and_argv
|
|
|
|
|
|
class TestAnsibleModuleKnownHosts(unittest.TestCase):
|
|
urls = {
|
|
'ssh://one.example.org/example.git':
|
|
{'is_ssh_url': True, 'get_fqdn': 'one.example.org',
|
|
'add_host_key_cmd': " -t rsa one.example.org",
|
|
'port': None},
|
|
'ssh+git://two.example.org/example.git':
|
|
{'is_ssh_url': True, 'get_fqdn': 'two.example.org',
|
|
'add_host_key_cmd': " -t rsa two.example.org",
|
|
'port': None},
|
|
'rsync://three.example.org/user/example.git':
|
|
{'is_ssh_url': False, 'get_fqdn': 'three.example.org',
|
|
'add_host_key_cmd': None, # not called for non-ssh urls
|
|
'port': None},
|
|
'git@four.example.org:user/example.git':
|
|
{'is_ssh_url': True, 'get_fqdn': 'four.example.org',
|
|
'add_host_key_cmd': " -t rsa four.example.org",
|
|
'port': None},
|
|
'git+ssh://five.example.org/example.git':
|
|
{'is_ssh_url': True, 'get_fqdn': 'five.example.org',
|
|
'add_host_key_cmd': " -t rsa five.example.org",
|
|
'port': None},
|
|
'ssh://six.example.org:21/example.org': # ssh on FTP Port?
|
|
{'is_ssh_url': True, 'get_fqdn': 'six.example.org',
|
|
'add_host_key_cmd': " -t rsa -p 21 six.example.org",
|
|
'port': '21'},
|
|
'ssh://[2001:DB8::abcd:abcd]/example.git':
|
|
{'is_ssh_url': True, 'get_fqdn': '[2001:DB8::abcd:abcd]',
|
|
'add_host_key_cmd': " -t rsa [2001:DB8::abcd:abcd]",
|
|
'port': None},
|
|
'ssh://[2001:DB8::abcd:abcd]:22/example.git':
|
|
{'is_ssh_url': True, 'get_fqdn': '[2001:DB8::abcd:abcd]',
|
|
'add_host_key_cmd': " -t rsa -p 22 [2001:DB8::abcd:abcd]",
|
|
'port': '22'},
|
|
'username@[2001:DB8::abcd:abcd]/example.git':
|
|
{'is_ssh_url': True, 'get_fqdn': '[2001:DB8::abcd:abcd]',
|
|
'add_host_key_cmd': " -t rsa [2001:DB8::abcd:abcd]",
|
|
'port': None},
|
|
'username@[2001:DB8::abcd:abcd]:path/example.git':
|
|
{'is_ssh_url': True, 'get_fqdn': '[2001:DB8::abcd:abcd]',
|
|
'add_host_key_cmd': " -t rsa [2001:DB8::abcd:abcd]",
|
|
'port': None},
|
|
'ssh://internal.git.server:7999/repos/repo.git':
|
|
{'is_ssh_url': True, 'get_fqdn': 'internal.git.server',
|
|
'add_host_key_cmd': " -t rsa -p 7999 internal.git.server",
|
|
'port': '7999'}
|
|
}
|
|
|
|
def test_is_ssh_url(self):
|
|
for u in self.urls:
|
|
self.assertEqual(known_hosts.is_ssh_url(u), self.urls[u]['is_ssh_url'])
|
|
|
|
def test_get_fqdn_and_port(self):
|
|
for u in self.urls:
|
|
self.assertEqual(known_hosts.get_fqdn_and_port(u), (self.urls[u]['get_fqdn'], self.urls[u]['port']))
|
|
|
|
def test_add_host_key(self):
|
|
|
|
# Copied
|
|
args = json.dumps(dict(ANSIBLE_MODULE_ARGS={}))
|
|
# unittest doesn't have a clean place to use a context manager, so we have to enter/exit manually
|
|
|
|
with swap_stdin_and_argv(stdin_data=args):
|
|
ansible.module_utils.basic._ANSIBLE_ARGS = None
|
|
self.module = ansible.module_utils.basic.AnsibleModule(argument_spec=dict())
|
|
|
|
get_bin_path = Mock()
|
|
get_bin_path.return_value = keyscan_cmd = "/custom/path/ssh-keyscan"
|
|
self.module.get_bin_path = get_bin_path
|
|
|
|
run_command = Mock()
|
|
run_command.return_value = (0, "Needs output, otherwise thinks ssh-keyscan timed out'", "")
|
|
self.module.run_command = run_command
|
|
|
|
append_to_file = Mock()
|
|
append_to_file.return_value = (None,)
|
|
self.module.append_to_file = append_to_file
|
|
|
|
with patch('os.path.isdir', return_value=True):
|
|
with patch('os.path.exists', return_value=True):
|
|
for u in self.urls:
|
|
if self.urls[u]['is_ssh_url']:
|
|
known_hosts.add_host_key(self.module, self.urls[u]['get_fqdn'], port=self.urls[u]['port'])
|
|
run_command.assert_called_with(keyscan_cmd + self.urls[u]['add_host_key_cmd'])
|