--select-instances hbal manpage update

[ganeti-local] / test / docs_unittest.py

diff --git a/test/docs_unittest.py b/test/docs_unittest.py
index 075ec39..82e5a9d 100755 (executable)
--- a/test/docs_unittest.py
+++ b/test/docs_unittest.py
@@ -28,11 +28,16 @@ from ganeti import _autoconf
 from ganeti import utils
 from ganeti import cmdlib
 from ganeti import build
 from ganeti import utils
 from ganeti import cmdlib
 from ganeti import build

+from ganeti import compat
+from ganeti import mcpu

 from ganeti.rapi import connector
 
 import testutils
 
 
 from ganeti.rapi import connector
 
 import testutils
 
 

+VALID_URI_RE = re.compile(r"^[-/a-z0-9]*$")
+
+

 class TestDocs(unittest.TestCase):
   """Documentation tests"""
 
 class TestDocs(unittest.TestCase):
   """Documentation tests"""
 

@@ -47,27 +52,52 @@ class TestDocs(unittest.TestCase):
     """
     hooksdoc = self._ReadDocFile("hooks.rst")
 
     """
     hooksdoc = self._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)
 
       if (isinstance(obj, type) and
           issubclass(obj, cmdlib.LogicalUnit) and
           hasattr(obj, "HPATH")):
     for name in dir(cmdlib):
       obj = getattr(cmdlib, name)
 
       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 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)))
 
     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)))
 

+  def _CheckRapiResource(self, uri, fixup, handler):
+    docline = "%s resource." % uri
+    self.assertEqual(handler.__doc__.splitlines()[0].strip(), docline,
+                     msg=("First line of %r's docstring is not %r" %
+                          (handler, docline)))
+
+    # Apply fixes before testing
+    for (rx, value) in fixup.items():
+      uri = rx.sub(value, uri)
+
+    self.assertTrue(VALID_URI_RE.match(uri), msg="Invalid URI %r" % uri)

 
   def testRapiDocs(self):
     """Check whether all RAPI resources are documented.
 
   def testRapiDocs(self):
     """Check whether all RAPI resources are documented.

@@ -75,17 +105,33 @@ class TestDocs(unittest.TestCase):
     """
     rapidoc = self._ReadDocFile("rapi.rst")
 
     """
     rapidoc = self._ReadDocFile("rapi.rst")
 

-    node_name = "[node_name]"
-    instance_name = "[instance_name]"
-    group_name = "[group_name]"
-    job_id = "[job_id]"
-    disk_index = "[disk_index]"
-
-    resources = connector.GetHandlers(re.escape(node_name),
-                                      re.escape(instance_name),
-                                      re.escape(group_name),
-                                      re.escape(job_id),
-                                      re.escape(disk_index))
+    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, 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",
+      re.compile(instance_name): "inst1examplecom",
+      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)
+                      for value in uri_check_fixup.values()), \
+           "Fixup values must be valid URIs, too"

 
     titles = []
 
 
     titles = []
 

@@ -99,20 +145,24 @@ class TestDocs(unittest.TestCase):
     prefix_exception = frozenset(["/", "/version", "/2"])
 
     undocumented = []
     prefix_exception = frozenset(["/", "/version", "/2"])
 
     undocumented = []

+    used_uris = []

 
     for key, handler in resources.iteritems():
       # Regex objects
       if hasattr(key, "match"):
         self.assert_(key.pattern.startswith("^/2/"),
                      msg="Pattern %r does not start with '^/2/'" % key.pattern)
 
     for key, handler in resources.iteritems():
       # Regex objects
       if hasattr(key, "match"):
         self.assert_(key.pattern.startswith("^/2/"),
                      msg="Pattern %r does not start with '^/2/'" % key.pattern)

+        self.assertEqual(key.pattern[-1], "$")

 
         found = False
         for title in titles:
 
         found = False
         for title in titles:

-          if (title.startswith("``") and
-              title.endswith("``") and
-              key.match(title[2:-2])):
-            found = True
-            break
+          if title.startswith("``") and title.endswith("``"):
+            uri = title[2:-2]
+            if key.match(uri):
+              self._CheckRapiResource(uri, uri_check_fixup, handler)
+              used_uris.append(uri)
+              found = True
+              break

 
         if not found:
           # TODO: Find better way of identifying resource
 
         if not found:
           # TODO: Find better way of identifying resource

@@ -122,13 +172,21 @@ class TestDocs(unittest.TestCase):
         self.assert_(key.startswith("/2/") or key in prefix_exception,
                      msg="Path %r does not start with '/2/'" % key)
 
         self.assert_(key.startswith("/2/") or key in prefix_exception,
                      msg="Path %r does not start with '/2/'" % key)
 

-        if ("``%s``" % key) not in titles:
+        if ("``%s``" % key) in titles:
+          self._CheckRapiResource(key, {}, handler)
+          used_uris.append(key)
+        else:

           undocumented.append(key)
 
     self.failIf(undocumented,
                 msg=("Missing RAPI resource documentation for %s" %
                      utils.CommaJoin(undocumented)))
 
           undocumented.append(key)
 
     self.failIf(undocumented,
                 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)))
+

 
 class TestManpages(unittest.TestCase):
   """Manpage tests"""
 
 class TestManpages(unittest.TestCase):
   """Manpage tests"""