Coverage for lib/ansible/plugins/callback/foreman.py : 25%

# -*- coding: utf-8 -*- 

# (c) 2015, 2016 Daniel Lobato <elobatocs@gmail.com> 

# (c) 2016 Guido Günther <agx@sigxcpu.org> 

# (c) 2017 Ansible Project 

# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 

from __future__ import (absolute_import, division, print_function) 

__metaclass__ = type 

DOCUMENTATION = ''' 

callback: foreman 

type: notification 

short_description: Sends events to Foreman 

description: 

- This callback will report facts and task events to Foreman https://theforeman.org/ 

- Before 2.4, if you wanted to use an ini configuration, the file must be placed in the same directory as this plugin and named foreman.ini 

- In 2.4 and above you can just put it in the main Ansible configuration file. 

version_added: "2.2" 

requirements: 

- whitelisting in configuration 

- requests (python library) 

options: 

url: 

description: URL to the Foreman server 

env: 

- name: FOREMAN_URL 

required: True 

default: http://localhost:3000 

ini: 

- section: callback_foreman 

key: url 

ssl_cert: 

description: X509 certificate to authenticate to Foreman if https is used 

env: 

- name: FOREMAN_SSL_CERT 

default: /etc/foreman/client_cert.pem 

ini: 

- section: callback_foreman 

key: ssl_cert 

ssl_key: 

description: the corresponding private key 

env: 

- name: FOREMAN_SSL_KEY 

default: /etc/foreman/client_key.pem 

ini: 

- section: callback_foreman 

key: ssl_key 

verify_certs: 

description: 

- Toggle to decidewhether to verify the Foreman certificate. 

- It can be set to '1' to verify SSL certificates using the installed CAs or to a path pointing to a CA bundle. 

- Set to '0' to disable certificate checking. 

env: 

- name: FOREMAN_SSL_VERIFY 

default: 1 

ini: 

- section: callback_foreman 

key: verify_certs 

''' 

import os 

from datetime import datetime 

from collections import defaultdict 

import json 

import time 

try: 

import requests 

HAS_REQUESTS = True 

except ImportError: 

HAS_REQUESTS = False 

from ansible.plugins.callback import CallbackBase 

class CallbackModule(CallbackBase): 

CALLBACK_VERSION = 2.0 

CALLBACK_TYPE = 'notification' 

CALLBACK_NAME = 'foreman' 

CALLBACK_NEEDS_WHITELIST = True 

FOREMAN_HEADERS = { 

"Content-Type": "application/json", 

"Accept": "application/json" 

} 

TIME_FORMAT = "%Y-%m-%d %H:%M:%S %f" 

def __init__(self): 

super(CallbackModule, self).__init__() 

self.items = defaultdict(list) 

self.start_time = int(time.time()) 

def set_options(self, options): 

super(CallbackModule, self).set_options(options) 

self.FOREMAN_URL = self._plugin_options['url'] 

self.FOREMAN_SSL_CERT = (self._plugin_options['ssl_cert'], self._plugin_options['ssl_key']) 

self.FOREMAN_SSL_VERIFY = self._plugin_options['verify_certs'] 

if HAS_REQUESTS: 

requests_major = int(requests.__version__.split('.')[0]) 

if requests_major >= 2: 

self.ssl_verify = self._ssl_verify() 

else: 

self._disable_plugin('The `requests` python module is too old.') 

else: 

self._disable_plugin('The `requests` python module is not installed.') 

if self.FOREMAN_URL.startswith('https://'): 

if not os.path.exists(self.FOREMAN_SSL_CERT[0]): 

self._disable_plugin('FOREMAN_SSL_CERT %s not found.' % self.FOREMAN_SSL_CERT[0]) 

if not os.path.exists(self.FOREMAN_SSL_CERT[1]): 

self._disable_plugin('FOREMAN_SSL_KEY %s not found.' % self.FOREMAN_SSL_CERT[1]) 

def _disable_plugin(self, msg): 

self.disabled = True 

self._display.warning(msg + ' Disabling the Foreman callback plugin.') 

def _ssl_verify(self): 

if self.FOREMAN_SSL_VERIFY.lower() in ["1", "true", "on"]: 

verify = True 

elif self.FOREMAN_SSL_VERIFY.lower() in ["0", "false", "off"]: 

requests.packages.urllib3.disable_warnings() 

self._display.warning("SSL verification of %s disabled" % 

self.FOREMAN_URL) 

verify = False 

else: # Set to a CA bundle: 

verify = self.FOREMAN_SSL_VERIFY 

return verify 

def send_facts(self, host, data): 

""" 

Sends facts to Foreman, to be parsed by foreman_ansible fact 

parser. The default fact importer should import these facts 

properly. 

""" 

data["_type"] = "ansible" 

data["_timestamp"] = datetime.now().strftime(self.TIME_FORMAT) 

facts = {"name": host, 

"facts": data, 

} 

try: 

r = requests.post(url=self.FOREMAN_URL + '/api/v2/hosts/facts', 

data=json.dumps(facts), 

headers=self.FOREMAN_HEADERS, 

cert=self.FOREMAN_SSL_CERT, 

verify=self.ssl_verify) 

r.raise_for_status() 

except requests.exceptions.RequestException as err: 

print(str(err)) 

def _build_log(self, data): 

logs = [] 

for entry in data: 

source, msg = entry 

if 'failed' in msg: 

level = 'err' 

else: 

level = 'notice' if 'changed' in msg and msg['changed'] else 'info' 

logs.append({ 

"log": { 

'sources': { 

'source': source 

}, 

'messages': { 

'message': json.dumps(msg) 

}, 

'level': level 

} 

}) 

return logs 

def send_reports(self, stats): 

""" 

Send reports to Foreman to be parsed by its config report 

importer. THe data is in a format that Foreman can handle 

without writing another report importer. 

""" 

status = defaultdict(lambda: 0) 

metrics = {} 

for host in stats.processed.keys(): 

sum = stats.summarize(host) 

status["applied"] = sum['changed'] 

status["failed"] = sum['failures'] + sum['unreachable'] 

status["skipped"] = sum['skipped'] 

log = self._build_log(self.items[host]) 

metrics["time"] = {"total": int(time.time()) - self.start_time} 

now = datetime.now().strftime(self.TIME_FORMAT) 

report = { 

"report": { 

"host": host, 

"reported_at": now, 

"metrics": metrics, 

"status": status, 

"logs": log, 

} 

} 

# To be changed to /api/v2/config_reports in 1.11. Maybe we 

# could make a GET request to get the Foreman version & do 

# this automatically. 

try: 

r = requests.post(url=self.FOREMAN_URL + '/api/v2/reports', 

data=json.dumps(report), 

headers=self.FOREMAN_HEADERS, 

cert=self.FOREMAN_SSL_CERT, 

verify=self.ssl_verify) 

r.raise_for_status() 

except requests.exceptions.RequestException as err: 

print(str(err)) 

self.items[host] = [] 

def append_result(self, result): 

name = result._task.get_name() 

host = result._host.get_name() 

self.items[host].append((name, result._result)) 

# Ansible callback API 

def v2_runner_on_failed(self, result, ignore_errors=False): 

self.append_result(result) 

def v2_runner_on_unreachable(self, result): 

self.append_result(result) 

def v2_runner_on_async_ok(self, result, jid): 

self.append_result(result) 

def v2_runner_on_async_failed(self, result, jid): 

self.append_result(result) 

def v2_playbook_on_stats(self, stats): 

self.send_reports(stats) 

def v2_runner_on_ok(self, result): 

res = result._result 

module = result._task.action 

if module == 'setup' or 'ansible_facts' in res: 

host = result._host.get_name() 

self.send_facts(host, res) 

else: 

self.append_result(result)