mirror of
https://github.com/valitydev/salt.git
synced 2024-11-08 01:18:58 +00:00
29 lines
919 B
Python
29 lines
919 B
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Import python libs
|
|
from __future__ import absolute_import
|
|
|
|
# Import Salt Testing libs
|
|
import tests.integration as integration
|
|
|
|
|
|
class SysModuleTest(integration.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
|
|
|
|
raise AssertionError(
|
|
'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']]),
|
|
)
|
|
)
|