mirror of
https://github.com/valitydev/salt.git
synced 2024-11-08 01:18:58 +00:00
77 lines
2.3 KiB
Python
77 lines
2.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Import python libs
|
|
from __future__ import absolute_import
|
|
import re
|
|
|
|
# Import Salt Testing libs
|
|
from salttesting.helpers import ensure_in_syspath
|
|
ensure_in_syspath('../../')
|
|
|
|
# Import salt libs
|
|
import integration
|
|
|
|
# Import 3rd-party libs
|
|
import salt.ext.six as six
|
|
|
|
|
|
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
|
|
'''
|
|
docs = self.run_function('sys.doc')
|
|
nodoc = set()
|
|
noexample = set()
|
|
allow_failure = (
|
|
'cp.recv',
|
|
'libcloud_dns.get_driver',
|
|
'lxc.run_cmd',
|
|
'ipset.long_range',
|
|
'pkg.expand_repo_def',
|
|
'runtests_decorators.depends',
|
|
'runtests_decorators.depends_will_fallback',
|
|
'runtests_decorators.missing_depends',
|
|
'runtests_decorators.missing_depends_will_fallback',
|
|
'swift.head',
|
|
'glance.warn_until',
|
|
'yumpkg.expand_repo_def',
|
|
'yumpkg5.expand_repo_def',
|
|
'container_resource.run',
|
|
'nspawn.stop',
|
|
'nspawn.restart',
|
|
'lowpkg.bin_pkg_info',
|
|
'state.apply',
|
|
'cmd.win_runas',
|
|
'status.list2cmdline'
|
|
)
|
|
|
|
for fun in docs:
|
|
if fun.startswith('runtests_helpers'):
|
|
continue
|
|
if fun in allow_failure:
|
|
continue
|
|
if not isinstance(docs[fun], six.string_types):
|
|
nodoc.add(fun)
|
|
elif not re.search(r'([E|e]xample(?:s)?)+(?:.*)::?', docs[fun]):
|
|
noexample.add(fun)
|
|
|
|
if not nodoc and not noexample:
|
|
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 sorted(nodoc)]),
|
|
'\n'.join([' - {0}'.format(f) for f in sorted(noexample)]),
|
|
)
|
|
)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
from integration import run_tests
|
|
run_tests(SysModuleTest)
|