Show doc URL for sanity test failures
This commit is contained in:
parent
4afe757f93
commit
8dd79fbbd2
1 changed files with 15 additions and 1 deletions
|
@ -4,11 +4,13 @@ __metaclass__ = type
|
||||||
|
|
||||||
import datetime
|
import datetime
|
||||||
import os
|
import os
|
||||||
|
import re
|
||||||
|
|
||||||
from . import types as t
|
from . import types as t
|
||||||
|
|
||||||
from .util import (
|
from .util import (
|
||||||
display,
|
display,
|
||||||
|
get_ansible_version,
|
||||||
)
|
)
|
||||||
|
|
||||||
from .util_common import (
|
from .util_common import (
|
||||||
|
@ -276,6 +278,10 @@ class TestFailure(TestResult):
|
||||||
for message in self.messages:
|
for message in self.messages:
|
||||||
display.error(message.format(show_confidence=True))
|
display.error(message.format(show_confidence=True))
|
||||||
|
|
||||||
|
doc_url = self.find_docs()
|
||||||
|
if doc_url:
|
||||||
|
display.info('See documentation for help: %s' % doc_url)
|
||||||
|
|
||||||
def write_lint(self):
|
def write_lint(self):
|
||||||
"""Write lint results to stdout."""
|
"""Write lint results to stdout."""
|
||||||
if self.summary:
|
if self.summary:
|
||||||
|
@ -358,7 +364,15 @@ class TestFailure(TestResult):
|
||||||
"""
|
"""
|
||||||
:rtype: str
|
:rtype: str
|
||||||
"""
|
"""
|
||||||
testing_docs_url = 'https://docs.ansible.com/ansible/devel/dev_guide/testing'
|
|
||||||
|
# Use the major.minor version for the URL only if this a release that
|
||||||
|
# matches the pattern 2.4.0, otherwise, use 'devel'
|
||||||
|
ansible_version = get_ansible_version()
|
||||||
|
url_version = 'devel'
|
||||||
|
if re.search(r'^[0-9.]+$', ansible_version):
|
||||||
|
url_version = '.'.join(ansible_version.split('.')[:2])
|
||||||
|
|
||||||
|
testing_docs_url = 'https://docs.ansible.com/ansible/%s/dev_guide/testing' % url_version
|
||||||
testing_docs_dir = 'docs/docsite/rst/dev_guide/testing'
|
testing_docs_dir = 'docs/docsite/rst/dev_guide/testing'
|
||||||
|
|
||||||
url = '%s/%s/' % (testing_docs_url, self.command)
|
url = '%s/%s/' % (testing_docs_url, self.command)
|
||||||
|
|
Loading…
Reference in a new issue