From: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Date: Thu, 15 Sep 2022 04:14:49 +0000 (+1200)
Subject: pytests: samba_tool.help checks you updated the man page
X-Git-Tag: tevent-0.17.0~532
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1319a21c94f4a22f756feb05c778bc41562c1a11;p=thirdparty%2Fsamba.git

pytests: samba_tool.help checks you updated the man page

It tries to help by printing something that is a little bit like the
correct DocBook text to insert.

Signed-off-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Reviewed-by: Rowland Penny <rpenny@samba.org>
---

diff --git a/python/samba/tests/samba_tool/help.py b/python/samba/tests/samba_tool/help.py
index 3459dd21619..f631e2420d1 100644
--- a/python/samba/tests/samba_tool/help.py
+++ b/python/samba/tests/samba_tool/help.py
@@ -17,12 +17,14 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+import os
 import re
 from samba.tests.samba_tool.base import SambaToolCmdTest
-from samba.tests import BlackboxProcessError
+from samba.tests import BlackboxProcessError, BINDIR
 from samba.tests import check_help_consistency
 from samba.common import get_string
 from samba import version
+from pathlib import Path
 
 
 class HelpTestCase(SambaToolCmdTest):
@@ -40,10 +42,15 @@ class HelpTestCase(SambaToolCmdTest):
         # self.runcmd() or self.runsubcmd().
         known_commands = [[]]
         failed_commands = []
+        undocumented = []
+        with open(Path(BINDIR) / '../docs-xml/manpages/samba-tool.8.xml') as f:
+            man = f.read()
 
         for i in range(4):
             new_commands = []
             for c in known_commands:
+                if ' '.join(c) not in man:
+                    undocumented.append(c)
                 line = ' '.join(['samba-tool'] + c + ['--help'])
                 try:
                     output = self.check_output(line)
@@ -81,6 +88,31 @@ class HelpTestCase(SambaToolCmdTest):
 
         self.assertEqual(failed_commands, [])
 
+        if undocumented:
+            print("-=" * 36)
+            print("\nPlease update `man samba-tool`!\n")
+            print("Some samba-tool subcommands seem to missing from the man-page!")
+            print("To help fix this, below are Docbook-like snippets based on the ")
+            print("--help text. Please modify these to be correct (both as XML and")
+            print("as content) and add them to docs-xml/manpages/samba-tool.8.xml")
+            print("Remember, you can explain things more deeply in a man-page,")
+            print("but you can also trim off common options that have already been")
+            print("explained.")
+            print()
+            env = dict(os.environ)
+            env['SAMBATOOL_HELP_IS_XML'] = '1'
+            for c in undocumented:
+                line = ' '.join(['samba-tool'] + c + ['--help'])
+                print(f" <!-- SAMBATOOL_HELP_IS_XML=1 {line} -->")
+                try:
+                    output = self.check_output(line, env=env)
+                except BlackboxProcessError as e:
+                    print(f"<!-- {e} ->")
+                print(output.decode())
+                print()
+            print("-=" * 36)
+            self.fail("Some commands are undocumented. See test output for help")
+
     def test_bad_password_option(self):
         """Do we get a warning with an invalid --pass option?"""
         (result, out, err) = self.run_command(["samba-tool",