mirror of
https://github.com/valitydev/salt.git
synced 2024-11-07 17:09:03 +00:00
33 lines
1.0 KiB
Python
33 lines
1.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Import python libs
|
|
from __future__ import absolute_import, print_function, unicode_literals
|
|
|
|
# Import Salt Testing libs
|
|
from tests.support.case import ModuleCase
|
|
from salt.ext import six
|
|
|
|
|
|
class SysModuleTest(ModuleCase):
|
|
'''
|
|
Validate the sys module
|
|
'''
|
|
def test_valid_docs(self):
|
|
'''
|
|
Make sure no functions are exposed that don't have valid docstrings
|
|
'''
|
|
ret = self.run_function('runtests_helpers.get_invalid_docs')
|
|
if ret == {'missing_docstring': [], 'missing_cli_example': []}:
|
|
return
|
|
|
|
if isinstance(ret, six.string_types):
|
|
self.fail(ret)
|
|
|
|
self.fail(
|
|
'There are some functions which do not have a docstring or do not '
|
|
'have an example:\nNo docstring:\n{0}\nNo example:\n{1}\n'.format(
|
|
'\n'.join([' - {0}'.format(f) for f in ret['missing_docstring']]),
|
|
'\n'.join([' - {0}'.format(f) for f in ret['missing_cli_example']]),
|
|
)
|
|
)
|