Add a basic job to test integration between server, clients and plugins
The callback has been moved to ara-plugins. Change-Id: Idf364871b0f1783b57332a992a0dcd0784353f80
This commit is contained in:
David Moreau Simard
parent
b0091d40e0
commit
64df7943a4
5
.zuul.d/jobs.yaml
Normal file
5
.zuul.d/jobs.yaml
Normal file
@ -0,0 +1,5 @@
|
||||
- job:
|
||||
name: ara-server-ansible-integration
|
||||
parent: tox
|
||||
vars:
|
||||
tox_envlist: ansible-integration
|
||||
@ -1,9 +1,11 @@
|
||||
- project:
|
||||
check:
|
||||
jobs:
|
||||
- ara-server-ansible-integration
|
||||
- tox-py35
|
||||
- tox-pep8
|
||||
gate:
|
||||
jobs:
|
||||
- ara-server-ansible-integration
|
||||
- tox-py35
|
||||
- tox-pep8
|
||||
@ -1,262 +0,0 @@
|
||||
# Copyright (c) 2018 Red Hat, Inc.
|
||||
#
|
||||
# This file is part of ARA: Ansible Run Analysis.
|
||||
#
|
||||
# ARA 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.
|
||||
#
|
||||
# ARA 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 ARA. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
|
||||
import datetime
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
import six
|
||||
|
||||
from ansible import __version__ as ansible_version
|
||||
from ansible.plugins.callback import CallbackBase
|
||||
# To retrieve Ansible CLI options
|
||||
try:
|
||||
from __main__ import cli
|
||||
except ImportError:
|
||||
cli = None
|
||||
|
||||
try:
|
||||
# Default to offline API client
|
||||
from django import setup as django_setup
|
||||
from django.core.management import execute_from_command_line
|
||||
from django.test import Client as offline_client
|
||||
|
||||
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'ara.settings')
|
||||
|
||||
# Automatically create the database and run migrations (is there a better way?)
|
||||
execute_from_command_line(['django', 'migrate'])
|
||||
|
||||
# Set up the things Django needs
|
||||
django_setup()
|
||||
|
||||
except ImportError:
|
||||
# Default to online API client
|
||||
# TODO
|
||||
pass
|
||||
|
||||
|
||||
class AraOfflineClient(object):
|
||||
def __init__(self):
|
||||
self.log = logging.getLogger('ara.client.offline')
|
||||
self.client = offline_client()
|
||||
|
||||
def _request(self, method, endpoint, **kwargs):
|
||||
func = getattr(self.client, method)
|
||||
response = func(
|
||||
endpoint,
|
||||
json.dumps(kwargs),
|
||||
content_type='application/json'
|
||||
)
|
||||
|
||||
self.log.debug('HTTP {status}: {method} on {endpoint}'.format(
|
||||
status=response.status_code,
|
||||
method=method,
|
||||
endpoint=endpoint
|
||||
))
|
||||
|
||||
if response.status_code not in [200, 201]:
|
||||
self.log.error(
|
||||
'Failed to {method} on {endpoint}: {content}'.format(
|
||||
method=method,
|
||||
endpoint=endpoint,
|
||||
content=kwargs
|
||||
)
|
||||
)
|
||||
self.log.fatal(response.content)
|
||||
|
||||
return response.json()
|
||||
|
||||
def get(self, endpoint, **kwargs):
|
||||
return self._request('get', endpoint, **kwargs)
|
||||
|
||||
def patch(self, endpoint, **kwargs):
|
||||
return self._request('patch', endpoint, **kwargs)
|
||||
|
||||
def post(self, endpoint, **kwargs):
|
||||
return self._request('post', endpoint, **kwargs)
|
||||
|
||||
def put(self, endpoint, **kwargs):
|
||||
return self._request('put', endpoint, **kwargs)
|
||||
|
||||
def delete(self, endpoint, **kwargs):
|
||||
return self._request('delete', endpoint, **kwargs)
|
||||
|
||||
|
||||
class CallbackModule(CallbackBase):
|
||||
"""
|
||||
Saves data from an Ansible run into a database
|
||||
"""
|
||||
CALLBACK_VERSION = 2.0
|
||||
CALLBACK_TYPE = 'awesome'
|
||||
CALLBACK_NAME = 'ara'
|
||||
|
||||
def __init__(self):
|
||||
super(CallbackModule, self).__init__()
|
||||
self.log = logging.getLogger('ara.callback')
|
||||
|
||||
# TODO: logic for picking between offline and online client
|
||||
self.client = AraOfflineClient()
|
||||
|
||||
self.result = None
|
||||
self.task = None
|
||||
self.play = None
|
||||
self.playbook = None
|
||||
self.stats = None
|
||||
self.loop_items = []
|
||||
|
||||
if cli:
|
||||
self._options = cli.options
|
||||
else:
|
||||
self._options = None
|
||||
|
||||
def v2_playbook_on_start(self, playbook):
|
||||
self.log.debug('v2_playbook_on_start')
|
||||
|
||||
path = os.path.abspath(playbook._file_name)
|
||||
if self._options is not None:
|
||||
parameters = self._options.__dict__.copy()
|
||||
else:
|
||||
parameters = {}
|
||||
|
||||
# Create the playbook
|
||||
self.playbook = self.client.post(
|
||||
'/api/v1/playbooks/',
|
||||
ansible_version=ansible_version,
|
||||
parameters=parameters,
|
||||
file=dict(
|
||||
path=path,
|
||||
content=self._read_file(path)
|
||||
)
|
||||
)
|
||||
|
||||
# Record all the files involved in the playbook
|
||||
self._load_files(playbook._loader._FILE_CACHE.keys())
|
||||
|
||||
return self.playbook
|
||||
|
||||
def v2_playbook_on_play_start(self, play):
|
||||
self.log.debug('v2_playbook_on_play_start')
|
||||
self._end_task()
|
||||
self._end_play()
|
||||
|
||||
# Record all the files involved in the play
|
||||
self._load_files(play._loader._FILE_CACHE.keys())
|
||||
|
||||
# Create the play
|
||||
self.play = self.client.post(
|
||||
'/api/v1/plays/',
|
||||
name=play.name,
|
||||
playbook=self.playbook['id']
|
||||
)
|
||||
|
||||
return self.play
|
||||
|
||||
def v2_playbook_on_task_start(self, task, is_conditional, handler=False):
|
||||
self.log.debug('v2_playbook_on_task_start')
|
||||
self._end_task()
|
||||
|
||||
pathspec = task.get_path()
|
||||
if pathspec:
|
||||
path, lineno = pathspec.split(':', 1)
|
||||
lineno = int(lineno)
|
||||
else:
|
||||
# Task doesn't have a path, default to "something"
|
||||
path = self.playbook['path']
|
||||
lineno = 1
|
||||
|
||||
# Ensure this task's file was added to the playbook -- files that are
|
||||
# dynamically included do not show up in the playbook or play context
|
||||
self._load_files([path])
|
||||
|
||||
# Find the task file (is there a better way?)
|
||||
task_file = self.playbook['file']['id']
|
||||
for file in self.playbook['files']:
|
||||
if file['path'] == path:
|
||||
task_file = file['id']
|
||||
break
|
||||
|
||||
self.task = self.client.post(
|
||||
'/api/v1/tasks/',
|
||||
name=task.get_name(),
|
||||
action=task.action,
|
||||
play=self.play['id'],
|
||||
playbook=self.playbook['id'],
|
||||
file=task_file,
|
||||
tags=task._attributes['tags'],
|
||||
lineno=lineno,
|
||||
handler=handler
|
||||
)
|
||||
|
||||
return self.task
|
||||
|
||||
def v2_playbook_on_stats(self, stats):
|
||||
self.log.debug('v2_playbook_on_stats')
|
||||
|
||||
self._end_task()
|
||||
self._end_play()
|
||||
self._end_playbook()
|
||||
|
||||
def _end_task(self):
|
||||
if self.task is not None:
|
||||
self.client.patch(
|
||||
'/api/v1/tasks/%s/' % self.task['id'],
|
||||
completed=True,
|
||||
ended=datetime.datetime.now().isoformat()
|
||||
)
|
||||
self.task = None
|
||||
self.loop_items = []
|
||||
|
||||
def _end_play(self):
|
||||
if self.play is not None:
|
||||
self.client.patch(
|
||||
'/api/v1/plays/%s/' % self.play['id'],
|
||||
completed=True,
|
||||
ended=datetime.datetime.now().isoformat()
|
||||
)
|
||||
self.play = None
|
||||
|
||||
def _end_playbook(self):
|
||||
self.playbook = self.client.patch(
|
||||
'/api/v1/playbooks/%s/' % self.playbook['id'],
|
||||
completed=True,
|
||||
ended=datetime.datetime.now().isoformat()
|
||||
)
|
||||
|
||||
def _load_files(self, files):
|
||||
self.log.debug('Loading %s file(s)...' % len(files))
|
||||
playbook_files = [file['path'] for file in self.playbook['files']]
|
||||
for file in files:
|
||||
if file not in playbook_files:
|
||||
self.client.post(
|
||||
'/api/v1/playbooks/%s/files/' % self.playbook['id'],
|
||||
path=file,
|
||||
content=self._read_file(file)
|
||||
)
|
||||
|
||||
def _read_file(self, path):
|
||||
try:
|
||||
with open(path, 'r') as fd:
|
||||
content = fd.read()
|
||||
except IOError as e:
|
||||
self.log.error("Unable to open {0} for reading: {1}".format(
|
||||
path, six.text_type(e)
|
||||
))
|
||||
content = """ARA was not able to read this file successfully.
|
||||
Refer to the logs for more information"""
|
||||
return content
|
||||
@ -1,3 +1,21 @@
|
||||
---
|
||||
# Copyright (c) 2018 Red Hat, Inc.
|
||||
#
|
||||
# This file is part of ARA Records Ansible.
|
||||
#
|
||||
# ARA 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.
|
||||
#
|
||||
# ARA 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 ARA. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
- name: A test play
|
||||
hosts: localhost
|
||||
tasks:
|
||||
|
||||
77
hacking/validate.py
Normal file
77
hacking/validate.py
Normal file
@ -0,0 +1,77 @@
|
||||
#!/usr/bin/env python
|
||||
# Copyright (c) 2018 Red Hat, Inc.
|
||||
#
|
||||
# This file is part of ARA Records Ansible.
|
||||
#
|
||||
# ARA 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.
|
||||
#
|
||||
# ARA 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 ARA. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
# A very basic script to smoke test that the Ansible integration is not
|
||||
# horribly broken until we get something more robust in place.
|
||||
|
||||
from ara.clients.offline import AraOfflineClient
|
||||
|
||||
|
||||
def validate_playbook(playbook):
|
||||
assert len(playbook['parameters']) == 40
|
||||
assert 'hacking/test-playbook.yml' in playbook['file']['path']
|
||||
assert len(playbook['files']) == 15
|
||||
assert playbook['completed']
|
||||
|
||||
|
||||
def validate_play(play):
|
||||
assert play['completed']
|
||||
|
||||
|
||||
def validate_task(task):
|
||||
assert task['completed']
|
||||
|
||||
|
||||
def main():
|
||||
client = AraOfflineClient()
|
||||
|
||||
playbooks = client.get('/api/v1/playbooks/')
|
||||
assert len(playbooks['results']) == 1
|
||||
assert playbooks['count'] == 1
|
||||
validate_playbook(playbooks['results'][0])
|
||||
|
||||
playbook = client.get(
|
||||
'/api/v1/playbooks/%s/' % playbooks['results'][0]['id']
|
||||
)
|
||||
validate_playbook(playbook)
|
||||
|
||||
plays = client.get('/api/v1/plays/')
|
||||
assert len(plays['results']) == 2
|
||||
assert plays['count'] == 2
|
||||
validate_play(plays['results'][0])
|
||||
|
||||
play = client.get(
|
||||
'/api/v1/plays/%s/' % plays['results'][0]['id']
|
||||
)
|
||||
validate_play(play)
|
||||
|
||||
tasks = client.get('/api/v1/tasks/')
|
||||
assert len(tasks['results']) == 8
|
||||
assert tasks['count'] == 8
|
||||
validate_task(tasks['results'][0])
|
||||
|
||||
task = client.get(
|
||||
'/api/v1/tasks/%s/' % tasks['results'][0]['id']
|
||||
)
|
||||
validate_task(task)
|
||||
|
||||
client.log.info('All assertions passed.')
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
16
tox.ini
16
tox.ini
@ -19,7 +19,7 @@ commands = sphinx-build -W -b html doc/source doc/build/html
|
||||
|
||||
[testenv:pep8]
|
||||
commands =
|
||||
flake8 ara
|
||||
flake8 ara hacking
|
||||
bandit -r ara
|
||||
|
||||
[testenv:py35]
|
||||
@ -33,13 +33,21 @@ commands =
|
||||
setenv =
|
||||
DJANGO_DEBUG=1
|
||||
|
||||
[testenv:ansible-playbook]
|
||||
deps = ansible
|
||||
# Temporary venv to help bootstrap integration
|
||||
[testenv:ansible-integration]
|
||||
deps =
|
||||
git+https://git.openstack.org/openstack/ara-plugins@master#egg=ara-plugins
|
||||
git+https://git.openstack.org/openstack/ara-clients@master#egg=ara-clients
|
||||
commands =
|
||||
ansible-playbook {toxinidir}/hacking/test-playbook.yml
|
||||
rm -f {toxinidir}/db.sqlite3
|
||||
bash -c 'ANSIBLE_CALLBACK_PLUGINS=$(python -c "import os,ara.plugins; print(os.path.dirname(ara.plugins.__file__))")/callback ansible-playbook {toxinidir}/hacking/test-playbook.yml'
|
||||
python {toxinidir}/hacking/validate.py
|
||||
setenv =
|
||||
DJANGO_DEBUG=1
|
||||
DJANGO_LOG_LEVEL=DEBUG
|
||||
whitelist_externals =
|
||||
rm
|
||||
bash
|
||||
|
||||
[testenv:cover]
|
||||
commands =
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user