diff --git a/doc/source/roles/role-test_json_error_callback.rst b/doc/source/roles/role-test_json_error_callback.rst new file mode 100644 index 000000000..abc2dc852 --- /dev/null +++ b/doc/source/roles/role-test_json_error_callback.rst @@ -0,0 +1,15 @@ +=============================================== +TripleO-Ansible Role - test_json_error_callback +=============================================== + +This role provides for the following services: + + * test_json_error_callback + + +Example playbook +~~~~~~~~~~~~~~~~ + +.. literalinclude:: ../../../tripleo_ansible/roles/test_json_error_callback/molecule/default/playbook.yml + :language: yaml + :start-after: under the License. diff --git a/tox.ini b/tox.ini index c83e404e5..cca96ff8e 100644 --- a/tox.ini +++ b/tox.ini @@ -143,6 +143,17 @@ envdir = {toxworkdir}/mol commands = python -m pytest --color=yes --html={envlogdir}/reports.html --self-contained-html {tty:-s} {toxinidir}/tests/test_molecule.py +[testenv:mol-test_json_error_callback] +setenv = + {[testenv]setenv} + JSON_ERROR_LOG_FILE=/tmp/json_error.log + ANSIBLE_LOAD_CALLBACK_PLUGINS=true + ANSIBLE_CALLBACK_WHITELIST=json_error +basepython = {[testenv:mol]basepython} +deps = {[testenv:mol]deps} +changedir = {toxinidir}/tripleo_ansible/roles/test_json_error_callback +commands = python -m pytest --color=yes --html={envlogdir}/reports.html --self-contained-html {tty:-s} {toxinidir}/tests/test_molecule.py + [testenv:mol-test_package_action] basepython = {[testenv:mol]basepython} deps = {[testenv:mol]deps} diff --git a/tripleo_ansible/ansible_plugins/callback/.gitkeep b/tripleo_ansible/ansible_plugins/callback/.gitkeep deleted file mode 100644 index e69de29bb..000000000 diff --git a/tripleo_ansible/ansible_plugins/callback/json_error.py b/tripleo_ansible/ansible_plugins/callback/json_error.py new file mode 100644 index 000000000..9431505f8 --- /dev/null +++ b/tripleo_ansible/ansible_plugins/callback/json_error.py @@ -0,0 +1,59 @@ +# Copyright 2018 Red Hat, Inc. +# All Rights Reserved. +# +# 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. + +# Ansible has another callback plugin just called "json.py", which overrides +# a normal import of "import json", so use absolute imports +from __future__ import absolute_import +import json +import os + +from ansible.plugins.callback import CallbackBase + + +DOCUMENTATION = ''' + callback: json_error + short_description: Write errors in JSON format to a log file + description: + - This callback writes errors in JSON format to a log file + type: aggregate + options: + output_dir: + name: json-error log file + default: ansible-error.json + description: Log file where to write errors in JSON format. + env: + - name: JSON_ERROR_LOG_FILE +''' + + +class CallbackModule(CallbackBase): + CALLBACK_VERSION = 2.5 + CALLBACK_TYPE = 'aggregate' + CALLBACK_NAME = 'json-error' + + def __init__(self, display=None): + super(CallbackModule, self).__init__(display) + self.errors = {} + self.log_file = os.getenv( + 'JSON_ERROR_LOG_FILE', 'ansible-errors.json') + + def v2_playbook_on_stats(self, stats): + with open(self.log_file, 'w') as f: + f.write(json.dumps(self.errors)) + + def v2_runner_on_failed(self, result, ignore_errors=False): + if not ignore_errors: + host_errors = self.errors.setdefault(result._host.name, []) + host_errors.append((result.task_name, result._result)) diff --git a/tripleo_ansible/roles/test_json_error_callback/README.md b/tripleo_ansible/roles/test_json_error_callback/README.md new file mode 100644 index 000000000..4a9078b0d --- /dev/null +++ b/tripleo_ansible/roles/test_json_error_callback/README.md @@ -0,0 +1,4 @@ +test_json_error_callback +======================== + +Role to test the json_error callback plugin. diff --git a/tripleo_ansible/roles/test_json_error_callback/meta/main.yml b/tripleo_ansible/roles/test_json_error_callback/meta/main.yml new file mode 100644 index 000000000..fac6bfa40 --- /dev/null +++ b/tripleo_ansible/roles/test_json_error_callback/meta/main.yml @@ -0,0 +1,44 @@ +--- +# Copyright 2019 Red Hat, Inc. +# All Rights Reserved. +# +# 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. + + +galaxy_info: + author: OpenStack + description: TripleO OpenStack Role -- test_json_error_callback + company: Red Hat + license: Apache-2.0 + min_ansible_version: 2.7 + # + # Provide a list of supported platforms, and for each platform a list of versions. + # If you don't wish to enumerate all versions for a particular platform, use 'all'. + # To view available platforms and versions (or releases), visit: + # https://galaxy.ansible.com/api/v1/platforms/ + # + platforms: + - name: Fedora + versions: + - 28 + - name: CentOS + versions: + - 7 + + galaxy_tags: + - tripleo + + +# List your role dependencies here, one per line. Be sure to remove the '[]' above, +# if you add dependencies to this list. +dependencies: [] diff --git a/tripleo_ansible/roles/test_json_error_callback/molecule/default/Dockerfile b/tripleo_ansible/roles/test_json_error_callback/molecule/default/Dockerfile new file mode 100644 index 000000000..fcdbd2990 --- /dev/null +++ b/tripleo_ansible/roles/test_json_error_callback/molecule/default/Dockerfile @@ -0,0 +1,37 @@ +# Molecule managed +# Copyright 2019 Red Hat, Inc. +# All Rights Reserved. +# +# 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. + + +{% if item.registry is defined %} +FROM {{ item.registry.url }}/{{ item.image }} +{% else %} +FROM {{ item.image }} +{% endif %} + +RUN if [ $(command -v apt-get) ]; then apt-get update && apt-get install -y python sudo bash ca-certificates && apt-get clean; \ + elif [ $(command -v dnf) ]; then dnf makecache && dnf --assumeyes install python sudo python-devel python*-dnf bash {{ item.pkg_extras | default('') }} && dnf clean all; \ + elif [ $(command -v yum) ]; then yum makecache fast && yum install -y python sudo yum-plugin-ovl python-setuptools bash {{ item.pkg_extras | default('') }} && sed -i 's/plugins=0/plugins=1/g' /etc/yum.conf && yum clean all; \ + elif [ $(command -v zypper) ]; then zypper refresh && zypper install -y python sudo bash python-xml {{ item.pkg_extras | default('') }} && zypper clean -a; \ + elif [ $(command -v apk) ]; then apk update && apk add --no-cache python sudo bash ca-certificates {{ item.pkg_extras | default('') }}; \ + elif [ $(command -v xbps-install) ]; then xbps-install -Syu && xbps-install -y python sudo bash ca-certificates {{ item.pkg_extras | default('') }} && xbps-remove -O; fi + +{% for pkg in item.easy_install | default([]) %} +# install pip for centos where there is no python-pip rpm in default repos +RUN easy_install {{ pkg }} +{% endfor %} + + +CMD ["sh", "-c", "while true; do sleep 10000; done"] \ No newline at end of file diff --git a/tripleo_ansible/roles/test_json_error_callback/molecule/default/molecule.yml b/tripleo_ansible/roles/test_json_error_callback/molecule/default/molecule.yml new file mode 100644 index 000000000..513dcec24 --- /dev/null +++ b/tripleo_ansible/roles/test_json_error_callback/molecule/default/molecule.yml @@ -0,0 +1,52 @@ +--- +driver: + name: docker + +log: true + +platforms: + - name: centos7 + hostname: centos7 + image: centos:7 + dockerfile: Dockerfile + pkg_extras: python-setuptools + easy_install: + - pip + environment: &env + http_proxy: "{{ lookup('env', 'http_proxy') }}" + https_proxy: "{{ lookup('env', 'https_proxy') }}" + volumes: + - /tmp:/tmp + + - name: fedora28 + hostname: fedora28 + image: fedora:28 + dockerfile: Dockerfile + pkg_extras: python*-setuptools + environment: + <<: *env + volumes: + - /tmp:/tmp + +provisioner: + name: ansible + log: true + env: + ANSIBLE_STDOUT_CALLBACK: yaml + +scenario: + test_sequence: + - destroy + - create + - prepare + - converge + - verify + - destroy + +lint: + enabled: false + +verifier: + name: testinfra + lint: + name: flake8 diff --git a/tripleo_ansible/roles/test_json_error_callback/molecule/default/playbook.yml b/tripleo_ansible/roles/test_json_error_callback/molecule/default/playbook.yml new file mode 100644 index 000000000..6f09cc422 --- /dev/null +++ b/tripleo_ansible/roles/test_json_error_callback/molecule/default/playbook.yml @@ -0,0 +1,21 @@ +--- +# Copyright 2019 Red Hat, Inc. +# All Rights Reserved. +# +# 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. + + +- name: Converge + hosts: all + roles: + - role: "test_json_error_callback" diff --git a/tripleo_ansible/roles/test_json_error_callback/molecule/default/prepare.yml b/tripleo_ansible/roles/test_json_error_callback/molecule/default/prepare.yml new file mode 100644 index 000000000..ef85c3128 --- /dev/null +++ b/tripleo_ansible/roles/test_json_error_callback/molecule/default/prepare.yml @@ -0,0 +1,21 @@ +--- +# Copyright 2019 Red Hat, Inc. +# All Rights Reserved. +# +# 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. + + +- name: Prepare + hosts: all + roles: + - role: test_deps diff --git a/tripleo_ansible/roles/test_json_error_callback/molecule/default/tests/test_default.py b/tripleo_ansible/roles/test_json_error_callback/molecule/default/tests/test_default.py new file mode 100644 index 000000000..fc8d1b11c --- /dev/null +++ b/tripleo_ansible/roles/test_json_error_callback/molecule/default/tests/test_default.py @@ -0,0 +1,27 @@ +# Copyright 2019 Red Hat, Inc. +# All Rights Reserved. +# +# 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 os + +import testinfra.utils.ansible_runner + + +testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner( + os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all') + + +def test_for_logfile(host): + assert host.file("/tmp/json_error.log").exists diff --git a/tripleo_ansible/roles/test_json_error_callback/molecule/default/verify.yml b/tripleo_ansible/roles/test_json_error_callback/molecule/default/verify.yml new file mode 100644 index 000000000..dfd4c7352 --- /dev/null +++ b/tripleo_ansible/roles/test_json_error_callback/molecule/default/verify.yml @@ -0,0 +1,15 @@ +--- +# Copyright 2019 Red Hat, Inc. +# All Rights Reserved. +# +# 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. diff --git a/tripleo_ansible/roles/test_json_error_callback/tasks/main.yml b/tripleo_ansible/roles/test_json_error_callback/tasks/main.yml new file mode 100644 index 000000000..8feb7a367 --- /dev/null +++ b/tripleo_ansible/roles/test_json_error_callback/tasks/main.yml @@ -0,0 +1,22 @@ +--- +# Copyright 2019 Red Hat, Inc. +# All Rights Reserved. +# +# 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. + + +- name: Force error + package: + name: bison + state: notastate + ignore_errors: true diff --git a/zuul.d/molecule.yaml b/zuul.d/molecule.yaml index a3eabd128..b2bc7baef 100644 --- a/zuul.d/molecule.yaml +++ b/zuul.d/molecule.yaml @@ -4,6 +4,7 @@ jobs: - tripleo-ansible-centos-7-molecule-aide - tripleo-ansible-centos-7-molecule-test_deps + - tripleo-ansible-centos-7-molecule-test_json_error_callback - tripleo-ansible-centos-7-molecule-test_package_action - tripleo-ansible-centos-7-molecule-tripleo-bootstrap - tripleo-ansible-centos-7-molecule-tuned @@ -12,6 +13,7 @@ jobs: - tripleo-ansible-centos-7-molecule-aide - tripleo-ansible-centos-7-molecule-test_deps + - tripleo-ansible-centos-7-molecule-test_json_error_callback - tripleo-ansible-centos-7-molecule-test_package_action - tripleo-ansible-centos-7-molecule-tripleo-bootstrap - tripleo-ansible-centos-7-molecule-tuned @@ -31,6 +33,13 @@ parent: tripleo-ansible-centos vars: tox_envlist: mol-test_deps +- job: + files: + - ^tripleo_ansible/roles/test_json_error_callback/.* + name: tripleo-ansible-centos-7-molecule-test_json_error_callback + parent: tripleo-ansible-centos + vars: + tox_envlist: mol-test_json_error_callback - job: files: - ^ansible_plugins/action/package.py