Extract pep8 messages for inline comments

Move the zuul requirement from test-requirements into the linters
section of tox.ini because we need it as a src install in the tox
env, so that we can reference the ansible library location.

Change-Id: I089c69b539107bdbc25791f5730502a4f46e7cf6
This commit is contained in:
Monty Taylor 2018-08-07 15:54:52 -05:00 committed by James E. Blair
parent d661ad4042
commit 421f533b61
4 changed files with 102 additions and 1 deletions

View File

@ -0,0 +1,75 @@
#!/usr/bin/python
# Copyright (c) 2018 Red Hat
#
# This module 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.
#
# This software 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 this software. If not, see <http://www.gnu.org/licenses/>.
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
module: tox_parse_output
short_description: Parses the output of tox looking for per-line comments
author: Monty Taylor (@mordred)
description:
- Looks for output from the tox command to find content that could be
returned as inline comments.
requirements:
- "python >= 3.5"
options:
tox_output:
description:
- Output from the tox command run
required: true
type: str
'''
from ansible.module_utils.basic import AnsibleModule
def extract_file_comments(tox_output):
ret = {}
for line in tox_output.split('\n'):
try:
if not line:
continue
if line[0].isspace():
continue
if ': ' not in line:
continue
(file_info, message) = line.split(': ', 1)
(file_path, start_line, start_char) = file_info.split(':')
if file_path.startswith('./'):
file_path = file_path[2:]
ret.setdefault(file_path, [])
ret[file_path].append(dict(line=int(start_line),
message=message))
except Exception:
pass
return ret
def main():
module = AnsibleModule(
argument_spec=dict(
tox_output=dict(required=True, type='str'),
)
)
tox_output = module.params['tox_output']
file_comments = extract_file_comments(tox_output)
module.exit_json(changed=False, file_comments=file_comments)
if __name__ == '__main__':
main()

View File

@ -36,3 +36,26 @@
chdir: "{{ zuul_work_dir }}"
environment: "{{ tox_environment|combine(tox_constraints_env|default({})) }}"
command: "{{ tox_executable }} -e{{ tox_envlist }} {{ tox_extra_args }}"
failed_when: false
register: tox_output
- name: Look for output
tox_parse_output:
tox_output: '{{ tox_output.stdout }}'
register: file_comments
- name: Return file comments to Zuul
when: file_comments.file_comments
delegate_to: localhost
zuul_return:
data:
zuul:
file_comments: '{{ file_comments.file_comments }}'
tags:
# Avoid "no action detected in task" linter error
- skip_ansible_lint
- name: Return tox status
fail:
msg: 'tox exited with return code {{ tox_output.rc }}'
when: tox_output.rc != 0

View File

@ -2,7 +2,6 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
flake8
zuul
# We need to pin the ansible version directly here; per the
# deprecation policy it should trail the version used by Zuul by 4

View File

@ -26,6 +26,10 @@ commands =
sphinx-build -E -W -d doc/build/doctrees -b html doc/source/ doc/build/html
[testenv:linters]
deps =
# Zuul is required to supply the zuul ansible modules for ansible-lint
-r{toxinidir}/test-requirements.txt
-egit+https://git.openstack.org/openstack-infra/zuul#egg=zuul
passenv =
# NOTE(pabelanger): if you'd like to run tox -elinters locally, you'll need
# to export ANSIBLE_ROLES_PATH pointing to the currect repos.