zuul/tests/unit/test_inventory.py

229 lines
8.4 KiB
Python

# Copyright 2017 Red Hat, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import base64
import os
import yaml
from tests.base import AnsibleZuulTestCase
from tests.base import ZuulTestCase
class TestInventoryBase(ZuulTestCase):
tenant_config_file = 'config/inventory/main.yaml'
def setUp(self):
super(TestInventoryBase, self).setUp()
self.executor_server.hold_jobs_in_build = True
A = self.fake_gerrit.addFakeChange('org/project', 'master', 'A')
self.fake_gerrit.addEvent(A.getPatchsetCreatedEvent(1))
self.waitUntilSettled()
def _get_build_inventory(self, name):
build = self.getBuildByName(name)
inv_path = os.path.join(build.jobdir.root, 'ansible', 'inventory.yaml')
return yaml.safe_load(open(inv_path, 'r'))
def _get_setup_inventory(self, name):
build = self.getBuildByName(name)
setup_inv_path = os.path.join(build.jobdir.root, 'ansible',
'setup-inventory.yaml')
return yaml.safe_load(open(setup_inv_path, 'r'))
class TestInventory(TestInventoryBase):
def test_single_inventory(self):
inventory = self._get_build_inventory('single-inventory')
all_nodes = ('ubuntu-xenial',)
self.assertIn('all', inventory)
self.assertIn('hosts', inventory['all'])
self.assertIn('vars', inventory['all'])
for node_name in all_nodes:
self.assertIn(node_name, inventory['all']['hosts'])
self.assertIn('zuul', inventory['all']['vars'])
z_vars = inventory['all']['vars']['zuul']
self.assertIn('executor', z_vars)
self.assertIn('src_root', z_vars['executor'])
self.assertIn('job', z_vars)
self.assertEqual(z_vars['job'], 'single-inventory')
self.assertEqual(z_vars['message'], 'QQ==')
self.executor_server.release()
self.waitUntilSettled()
def test_single_inventory_list(self):
inventory = self._get_build_inventory('single-inventory-list')
all_nodes = ('compute', 'controller')
self.assertIn('all', inventory)
self.assertIn('hosts', inventory['all'])
self.assertIn('vars', inventory['all'])
for node_name in all_nodes:
self.assertIn(node_name, inventory['all']['hosts'])
self.assertIn('zuul', inventory['all']['vars'])
z_vars = inventory['all']['vars']['zuul']
self.assertIn('executor', z_vars)
self.assertIn('src_root', z_vars['executor'])
self.assertIn('job', z_vars)
self.assertEqual(z_vars['job'], 'single-inventory-list')
self.executor_server.release()
self.waitUntilSettled()
def test_group_inventory(self):
inventory = self._get_build_inventory('group-inventory')
all_nodes = ('controller', 'compute1', 'compute2')
self.assertIn('all', inventory)
self.assertIn('children', inventory['all'])
self.assertIn('hosts', inventory['all'])
self.assertIn('vars', inventory['all'])
for group_name in ('ceph-osd', 'ceph-monitor'):
self.assertIn(group_name, inventory['all']['children'])
for node_name in all_nodes:
self.assertIn(node_name, inventory['all']['hosts'])
self.assertIn(node_name,
inventory['all']['children']
['ceph-monitor']['hosts'])
self.assertIn('zuul', inventory['all']['vars'])
z_vars = inventory['all']['vars']['zuul']
self.assertIn('executor', z_vars)
self.assertIn('src_root', z_vars['executor'])
self.assertIn('job', z_vars)
self.assertEqual(z_vars['job'], 'group-inventory')
self.executor_server.release()
self.waitUntilSettled()
def test_hostvars_inventory(self):
inventory = self._get_build_inventory('hostvars-inventory')
all_nodes = ('default', 'fakeuser')
self.assertIn('all', inventory)
self.assertIn('hosts', inventory['all'])
self.assertIn('vars', inventory['all'])
for node_name in all_nodes:
self.assertIn(node_name, inventory['all']['hosts'])
# check if the nodes use the correct username
if node_name == 'fakeuser':
username = 'fakeuser'
else:
username = 'zuul'
self.assertEqual(
inventory['all']['hosts'][node_name]['ansible_user'], username)
# check if the nodes use the correct or no ansible_connection
if node_name == 'windows':
self.assertEqual(
inventory['all']['hosts'][node_name]['ansible_connection'],
'winrm')
else:
self.assertEqual(
'local',
inventory['all']['hosts'][node_name]['ansible_connection'])
self.executor_server.release()
self.waitUntilSettled()
def test_setup_inventory(self):
setup_inventory = self._get_setup_inventory('hostvars-inventory')
inventory = self._get_build_inventory('hostvars-inventory')
self.assertIn('all', inventory)
self.assertIn('hosts', inventory['all'])
self.assertIn('default', setup_inventory['all']['hosts'])
self.assertIn('fakeuser', setup_inventory['all']['hosts'])
self.assertIn('windows', setup_inventory['all']['hosts'])
self.assertNotIn('network', setup_inventory['all']['hosts'])
self.assertIn('default', inventory['all']['hosts'])
self.assertIn('fakeuser', inventory['all']['hosts'])
self.assertIn('windows', inventory['all']['hosts'])
self.assertIn('network', inventory['all']['hosts'])
self.executor_server.release()
self.waitUntilSettled()
class TestAnsibleInventory(AnsibleZuulTestCase):
tenant_config_file = 'config/inventory/main.yaml'
def _get_file(self, build, path):
p = os.path.join(build.jobdir.root, path)
with open(p) as f:
return f.read()
def _jinja2_message(self, expected_message):
# This test runs a bit long and needs extra time.
self.wait_timeout = 120
# Keep the jobdir around to check inventory
self.executor_server.keep_jobdir = True
# Output extra ansible info so we might see errors.
self.executor_server.verbose = True
A = self.fake_gerrit.addFakeChange(
'org/project2', 'master', expected_message)
self.fake_gerrit.addEvent(A.getPatchsetCreatedEvent(1))
self.waitUntilSettled()
self.assertHistory([
dict(name='jinja2-message', result='SUCCESS', changes='1,1')])
build = self.history[0]
inv_path = os.path.join(build.jobdir.root, 'ansible', 'inventory.yaml')
inventory = yaml.safe_load(open(inv_path, 'r'))
decoded_message = base64.b64decode(
inventory['all']['vars']['zuul']['message']).decode('utf-8')
self.assertEqual(decoded_message, expected_message)
obtained_message = self._get_file(self.history[0],
'work/logs/commit-message.txt')
self.assertEqual(obtained_message, expected_message)
def test_jinja2_message_brackets(self):
self._jinja2_message("This message has {{ jinja2 }} in it ")
def test_jinja2_message_raw(self):
self._jinja2_message("This message has {% raw %} in {% endraw %} it ")
class TestWindowsInventory(TestInventoryBase):
config_file = 'zuul-winrm.conf'
def test_windows_inventory(self):
inventory = self._get_build_inventory('hostvars-inventory')
windows_host = inventory['all']['hosts']['windows']
self.assertEqual(windows_host['ansible_connection'], 'winrm')
self.assertEqual(
windows_host['ansible_winrm_operation_timeout_sec'],
'120')
self.assertEqual(
windows_host['ansible_winrm_read_timeout_sec'],
'180')
self.executor_server.release()
self.waitUntilSettled()