X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/b58a4d160ecbdde279f06d2ece052f67f9a60408..43c16a8a1adfd543751fcaf60ad4c8e04cf83688:/test/docs_unittest.py?ds=inline diff --git a/test/docs_unittest.py b/test/docs_unittest.py index 87aa26d..c437920 100755 --- a/test/docs_unittest.py +++ b/test/docs_unittest.py @@ -23,12 +23,19 @@ import unittest import re +import itertools +import operator from ganeti import _autoconf from ganeti import utils from ganeti import cmdlib from ganeti import build from ganeti import compat +from ganeti import mcpu +from ganeti import opcodes +from ganeti import constants +from ganeti.rapi import baserlib +from ganeti.rapi import rlib2 from ganeti.rapi import connector import testutils @@ -36,20 +43,60 @@ import testutils VALID_URI_RE = re.compile(r"^[-/a-z0-9]*$") - -class TestDocs(unittest.TestCase): - """Documentation tests""" - - @staticmethod - def _ReadDocFile(filename): - return utils.ReadFile("%s/doc/%s" % - (testutils.GetSourceDir(), filename)) - - def testHookDocs(self): +RAPI_OPCODE_EXCLUDE = frozenset([ + # Not yet implemented + opcodes.OpBackupQuery, + opcodes.OpBackupRemove, + opcodes.OpClusterConfigQuery, + opcodes.OpClusterRepairDiskSizes, + opcodes.OpClusterVerify, + opcodes.OpClusterVerifyDisks, + opcodes.OpInstanceChangeGroup, + opcodes.OpInstanceMove, + opcodes.OpNodeQueryvols, + opcodes.OpOobCommand, + opcodes.OpTagsSearch, + opcodes.OpClusterActivateMasterIp, + opcodes.OpClusterDeactivateMasterIp, + + # Difficult if not impossible + opcodes.OpClusterDestroy, + opcodes.OpClusterPostInit, + opcodes.OpClusterRename, + opcodes.OpNodeAdd, + opcodes.OpNodeRemove, + + # Helper opcodes (e.g. submitted by LUs) + opcodes.OpClusterVerifyConfig, + opcodes.OpClusterVerifyGroup, + opcodes.OpGroupEvacuate, + opcodes.OpGroupVerifyDisks, + + # Test opcodes + opcodes.OpTestAllocator, + opcodes.OpTestDelay, + opcodes.OpTestDummy, + opcodes.OpTestJqueue, + ]) + + +def _ReadDocFile(filename): + return utils.ReadFile("%s/doc/%s" % + (testutils.GetSourceDir(), filename)) + + +class TestHooksDocs(unittest.TestCase): + def test(self): """Check whether all hooks are documented. """ - hooksdoc = self._ReadDocFile("hooks.rst") + hooksdoc = _ReadDocFile("hooks.rst") + + # Reverse mapping from LU to opcode + lu2opcode = dict((lu, op) + for (op, lu) in mcpu.Processor.DISPATCH_TABLE.items()) + assert len(lu2opcode) == len(mcpu.Processor.DISPATCH_TABLE), \ + "Found duplicate entries" for name in dir(cmdlib): obj = getattr(cmdlib, name) @@ -57,21 +104,31 @@ class TestDocs(unittest.TestCase): if (isinstance(obj, type) and issubclass(obj, cmdlib.LogicalUnit) and hasattr(obj, "HPATH")): - self._CheckHook(name, obj, hooksdoc) + self._CheckHook(name, obj, hooksdoc, lu2opcode) + + def _CheckHook(self, name, lucls, hooksdoc, lu2opcode): + opcls = lu2opcode.get(lucls, None) - def _CheckHook(self, name, lucls, hooksdoc): if lucls.HTYPE is None: return # TODO: Improve this test (e.g. find hooks documented but no longer # existing) + if opcls: + self.assertTrue(re.findall("^%s$" % re.escape(opcls.OP_ID), + hooksdoc, re.M), + msg=("Missing hook documentation for %s" % + (opcls.OP_ID))) + pattern = r"^:directory:\s*%s\s*$" % re.escape(lucls.HPATH) self.assert_(re.findall(pattern, hooksdoc, re.M), msg=("Missing documentation for hook %s/%s" % (lucls.HTYPE, lucls.HPATH))) + +class TestRapiDocs(unittest.TestCase): def _CheckRapiResource(self, uri, fixup, handler): docline = "%s resource." % uri self.assertEqual(handler.__doc__.splitlines()[0].strip(), docline, @@ -84,20 +141,26 @@ class TestDocs(unittest.TestCase): self.assertTrue(VALID_URI_RE.match(uri), msg="Invalid URI %r" % uri) - def testRapiDocs(self): + def test(self): """Check whether all RAPI resources are documented. """ - rapidoc = self._ReadDocFile("rapi.rst") + rapidoc = _ReadDocFile("rapi.rst") node_name = re.escape("[node_name]") instance_name = re.escape("[instance_name]") group_name = re.escape("[group_name]") job_id = re.escape("[job_id]") disk_index = re.escape("[disk_index]") + query_res = re.escape("[resource]") resources = connector.GetHandlers(node_name, instance_name, group_name, - job_id, disk_index) + job_id, disk_index, query_res) + + handler_dups = utils.FindDuplicates(resources.values()) + self.assertFalse(handler_dups, + msg=("Resource handlers used more than once: %r" % + handler_dups)) uri_check_fixup = { re.compile(node_name): "node1examplecom", @@ -105,6 +168,7 @@ class TestDocs(unittest.TestCase): re.compile(group_name): "group4440", re.compile(job_id): "9409", re.compile(disk_index): "123", + re.compile(query_res): "lock", } assert compat.all(VALID_URI_RE.match(value) @@ -123,6 +187,7 @@ class TestDocs(unittest.TestCase): prefix_exception = frozenset(["/", "/version", "/2"]) undocumented = [] + used_uris = [] for key, handler in resources.iteritems(): # Regex objects @@ -137,6 +202,7 @@ class TestDocs(unittest.TestCase): uri = title[2:-2] if key.match(uri): self._CheckRapiResource(uri, uri_check_fixup, handler) + used_uris.append(uri) found = True break @@ -150,6 +216,7 @@ class TestDocs(unittest.TestCase): if ("``%s``" % key) in titles: self._CheckRapiResource(key, {}, handler) + used_uris.append(key) else: undocumented.append(key) @@ -157,6 +224,42 @@ class TestDocs(unittest.TestCase): msg=("Missing RAPI resource documentation for %s" % utils.CommaJoin(undocumented))) + uri_dups = utils.FindDuplicates(used_uris) + self.failIf(uri_dups, + msg=("URIs matched by more than one resource: %s" % + utils.CommaJoin(uri_dups))) + + self._FindRapiMissing(resources.values()) + self._CheckTagHandlers(resources.values()) + + def _FindRapiMissing(self, handlers): + used = frozenset(itertools.chain(*map(baserlib.GetResourceOpcodes, + handlers))) + + unexpected = used & RAPI_OPCODE_EXCLUDE + self.assertFalse(unexpected, + msg=("Found RAPI resources for excluded opcodes: %s" % + utils.CommaJoin(_GetOpIds(unexpected)))) + + missing = (frozenset(opcodes.OP_MAPPING.values()) - used - + RAPI_OPCODE_EXCLUDE) + self.assertFalse(missing, + msg=("Missing RAPI resources for opcodes: %s" % + utils.CommaJoin(_GetOpIds(missing)))) + + def _CheckTagHandlers(self, handlers): + tag_handlers = filter(lambda x: issubclass(x, rlib2._R_Tags), handlers) + self.assertEqual(frozenset(map(operator.attrgetter("TAG_LEVEL"), + tag_handlers)), + constants.VALID_TAG_TYPES) + + +def _GetOpIds(ops): + """Returns C{OP_ID} for all opcodes in passed sequence. + + """ + return sorted(opcls.OP_ID for opcls in ops) + class TestManpages(unittest.TestCase): """Manpage tests"""