mirror of
https://github.com/saltstack/salt.git
synced 2025-04-16 09:40:20 +00:00
Man pages test does not need to be an integration test
This commit is contained in:
Pedro Algarvio
Daniel Wozniak
parent
ce2ab6282d
commit
2352457b35
5 changed files with 114 additions and 90 deletions
|
|
@ -1,89 +0,0 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
Tests for existence of manpages
|
||||
"""
|
||||
# Import python libs
|
||||
from __future__ import absolute_import, print_function, unicode_literals
|
||||
|
||||
import os
|
||||
import pprint
|
||||
import shutil
|
||||
|
||||
# Import Salt libs
|
||||
import salt.utils.platform
|
||||
from tests.support.case import ModuleCase
|
||||
|
||||
# Import Salt Testing libs
|
||||
from tests.support.runtests import RUNTIME_VARS
|
||||
from tests.support.unit import skipIf
|
||||
|
||||
|
||||
@skipIf(salt.utils.platform.is_windows(), "minion is windows")
|
||||
@skipIf(salt.utils.platform.is_aix(), "minion is AIX")
|
||||
class ManTest(ModuleCase):
|
||||
@classmethod
|
||||
def setUpClass(cls):
|
||||
cls.rootdir = os.path.join(RUNTIME_VARS.TMP, "mantest")
|
||||
# Map filenames to search strings which should be in the manpage
|
||||
cls.manpages = {
|
||||
"salt-cp.1": ["salt-cp Documentation", "copies files from the master"],
|
||||
"salt-cloud.1": [
|
||||
"Salt Cloud Command",
|
||||
"Provision virtual machines in the cloud",
|
||||
],
|
||||
"salt-call.1": ["salt-call Documentation", "run module functions locally"],
|
||||
"salt-api.1": [
|
||||
"salt-api Command",
|
||||
"Start interfaces used to remotely connect",
|
||||
],
|
||||
"salt-unity.1": ["salt-unity Command", "unified invocation wrapper"],
|
||||
"salt-syndic.1": ["salt-syndic Documentation", "Salt syndic daemon"],
|
||||
"salt-ssh.1": ["salt-ssh Documentation", "executed using only SSH"],
|
||||
"salt-run.1": ["salt-run Documentation", "frontend command for executing"],
|
||||
"salt-proxy.1": ["salt-proxy Documentation", "proxies these commands"],
|
||||
"salt-minion.1": ["salt-minion Documentation", "Salt minion daemon"],
|
||||
"salt-master.1": ["salt-master Documentation", "Salt master daemon"],
|
||||
"salt-key.1": [
|
||||
"salt-key Documentation",
|
||||
"management of Salt server public keys",
|
||||
],
|
||||
"salt.1": ["allows for commands to be executed"],
|
||||
"salt.7": ["Salt Documentation"],
|
||||
"spm.1": [
|
||||
"Salt Package Manager Command",
|
||||
"command for managing Salt packages",
|
||||
],
|
||||
}
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls):
|
||||
cls.manpages = None
|
||||
|
||||
def setUp(self):
|
||||
self.addCleanup(shutil.rmtree, self.rootdir, ignore_errors=True)
|
||||
if not os.path.exists(self.rootdir):
|
||||
ret = self.run_function("mantest.install", [self.rootdir])
|
||||
if not isinstance(ret, dict):
|
||||
self.fail(
|
||||
"The 'mantest.install' command did not return the excepted dictionary. Output:\n{}".format(
|
||||
ret
|
||||
)
|
||||
)
|
||||
if ret["retcode"] != 0:
|
||||
self.fail(
|
||||
"Failed to install. Full return dictionary:\n{}".format(
|
||||
pprint.pformat(ret)
|
||||
)
|
||||
)
|
||||
|
||||
@skipIf(True, "SLOWTEST skip")
|
||||
def test_man(self):
|
||||
"""
|
||||
Make sure that man pages are installed
|
||||
"""
|
||||
ret = self.run_function("mantest.search", [self.manpages, self.rootdir])
|
||||
# The above function returns True if successful and an exception (which
|
||||
# will manifest in the return as a stringified exception) if
|
||||
# unsuccessful. Therefore, a simple assertTrue is not sufficient.
|
||||
if ret is not True:
|
||||
self.fail(ret)
|
||||
1
tests/unit/setup/__init__.py
Normal file
1
tests/unit/setup/__init__.py
Normal file
|
|
@ -0,0 +1 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
111
tests/unit/setup/test_man.py
Normal file
111
tests/unit/setup/test_man.py
Normal file
|
|
@ -0,0 +1,111 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
Tests for existence of manpages
|
||||
"""
|
||||
from __future__ import absolute_import, print_function, unicode_literals
|
||||
|
||||
import os
|
||||
import pprint
|
||||
|
||||
import salt.utils.platform
|
||||
from salt.modules.virtualenv_mod import KNOWN_BINARY_NAMES
|
||||
from tests.support.helpers import VirtualEnv
|
||||
from tests.support.runtests import RUNTIME_VARS
|
||||
from tests.support.unit import TestCase, skipIf
|
||||
|
||||
|
||||
@skipIf(salt.utils.platform.is_windows(), "minion is windows")
|
||||
@skipIf(salt.utils.platform.is_aix(), "minion is AIX")
|
||||
@skipIf(
|
||||
salt.utils.path.which_bin(KNOWN_BINARY_NAMES) is None, "virtualenv not installed"
|
||||
)
|
||||
class ManPagesTest(TestCase):
|
||||
@skipIf(True, "SLOWTEST skip")
|
||||
def test_man_pages(self):
|
||||
"""
|
||||
Make sure that man pages are installed
|
||||
"""
|
||||
# Map filenames to search strings which should be in the manpage
|
||||
manpages = {
|
||||
"salt-cp.1": ["salt-cp Documentation", "copies files from the master"],
|
||||
"salt-cloud.1": [
|
||||
"Salt Cloud Command",
|
||||
"Provision virtual machines in the cloud",
|
||||
],
|
||||
"salt-call.1": ["salt-call Documentation", "run module functions locally"],
|
||||
"salt-api.1": [
|
||||
"salt-api Command",
|
||||
"Start interfaces used to remotely connect",
|
||||
],
|
||||
"salt-unity.1": ["salt-unity Command", "unified invocation wrapper"],
|
||||
"salt-syndic.1": ["salt-syndic Documentation", "Salt syndic daemon"],
|
||||
"salt-ssh.1": ["salt-ssh Documentation", "executed using only SSH"],
|
||||
"salt-run.1": ["salt-run Documentation", "frontend command for executing"],
|
||||
"salt-proxy.1": ["salt-proxy Documentation", "proxies these commands"],
|
||||
"salt-minion.1": ["salt-minion Documentation", "Salt minion daemon"],
|
||||
"salt-master.1": ["salt-master Documentation", "Salt master daemon"],
|
||||
"salt-key.1": [
|
||||
"salt-key Documentation",
|
||||
"management of Salt server public keys",
|
||||
],
|
||||
"salt.1": ["allows for commands to be executed"],
|
||||
"salt.7": ["Salt Documentation"],
|
||||
"spm.1": [
|
||||
"Salt Package Manager Command",
|
||||
"command for managing Salt packages",
|
||||
],
|
||||
}
|
||||
|
||||
with VirtualEnv() as venv:
|
||||
rootdir = os.path.join(venv.venv_dir, "installed")
|
||||
venv.run(
|
||||
venv.venv_python,
|
||||
"setup.py",
|
||||
"install",
|
||||
"--root={}".format(rootdir),
|
||||
cwd=RUNTIME_VARS.CODE_DIR,
|
||||
)
|
||||
|
||||
manpage_fns = set(manpages)
|
||||
manpage_paths = {}
|
||||
for root, _, files in os.walk(rootdir):
|
||||
if not manpage_fns:
|
||||
# All manpages found, no need to keep walking
|
||||
break
|
||||
# Using list because we will be modifying the set during iteration
|
||||
for manpage_fn in list(manpage_fns):
|
||||
if manpage_fn in files:
|
||||
manpage_path = salt.utils.path.join(root, manpage_fn)
|
||||
manpage_paths[manpage_fn] = manpage_path
|
||||
manpage_fns.remove(manpage_fn)
|
||||
|
||||
assert (
|
||||
not manpage_fns
|
||||
), "The following manpages were not found under {}: {}".format(
|
||||
rootdir, ", ".join(sorted(manpage_fns))
|
||||
)
|
||||
|
||||
failed = {}
|
||||
for manpage in sorted(manpages):
|
||||
with salt.utils.files.fopen(manpage_paths[manpage]) as fp_:
|
||||
contents = salt.utils.stringutils.to_unicode(fp_.read())
|
||||
# Check for search string in contents
|
||||
for search_string in manpages[manpage]:
|
||||
if search_string not in contents:
|
||||
failed.setdefault(manpage, []).append(
|
||||
"No match for search string '{}' found in {}".format(
|
||||
search_string, manpage_paths[manpage]
|
||||
)
|
||||
)
|
||||
# Check for correct install dir
|
||||
path = "/man{}/".format(manpage.rsplit(".", 1)[-1])
|
||||
if path not in manpage_paths[manpage]:
|
||||
failed.setdefault(manpage, []).append(
|
||||
"{} not found in manpage path {}".format(
|
||||
path, manpage_paths[manpage]
|
||||
)
|
||||
)
|
||||
|
||||
assert not failed, "One or more manpages failed:\n{}".format(
|
||||
pprint.pformat(failed)
|
||||
)
|
||||
|
|
@ -23,6 +23,7 @@ EXCLUDED_DIRS = [
|
|||
os.path.join("tests", "pkg"),
|
||||
os.path.join("tests", "perf"),
|
||||
os.path.join("tests", "support"),
|
||||
os.path.join("tests", "unit", "setup"),
|
||||
os.path.join("tests", "unit", "utils", "cache_mods"),
|
||||
os.path.join("tests", "unit", "modules", "inspectlib"),
|
||||
os.path.join("tests", "unit", "modules", "zypp"),
|
||||
|
|
@ -127,6 +128,7 @@ class BadTestModuleNamesTestCase(TestCase):
|
|||
"unit.test_proxy_minion",
|
||||
"unit.cache.test_cache",
|
||||
"unit.serializers.test_serializers",
|
||||
"unit.setup.test_man",
|
||||
"unit.states.test_postgres",
|
||||
"unit.utils.scheduler.test_run_job",
|
||||
"unit.utils.scheduler.test_maxrunning",
|
||||
|
|
|
|||
|
|
@ -5,7 +5,6 @@ integration.client.test_kwarg
|
|||
integration.client.test_runner
|
||||
integration.client.test_standard
|
||||
integration.client.test_syndic
|
||||
integration.doc.test_man
|
||||
integration.grains.test_core
|
||||
integration.grains.test_custom
|
||||
integration.loader.test_ext_grains
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue