mirror of
https://github.com/samba-team/samba.git
synced 2025-01-12 09:18:10 +03:00
tests: Convert find_missing_doc into a unit test.
This commit is contained in:
parent
47902702b3
commit
d2f8fe855d
@ -263,8 +263,7 @@ $(PEARSONDIR)/%.report.html: $(PEARSONDIR)/%.xml
|
|||||||
cd $(<D) && $(XMLLINT) --xinclude --noent --postvalid --noout $(<F)
|
cd $(<D) && $(XMLLINT) --xinclude --noent --postvalid --noout $(<F)
|
||||||
|
|
||||||
# Find undocumented parameters
|
# Find undocumented parameters
|
||||||
undocumented: $(SMBDOTCONFDOC)/parameters.all.xml scripts/find_missing_doc scripts/find_missing_manpages
|
undocumented: $(SMBDOTCONFDOC)/parameters.all.xml scripts/find_missing_manpages
|
||||||
$(PERL) scripts/find_missing_doc $(SRCDIR)
|
|
||||||
$(PERL) scripts/find_missing_manpages $(SRCDIR)/source3
|
$(PERL) scripts/find_missing_manpages $(SRCDIR)/source3
|
||||||
|
|
||||||
samples: $(DOCBOOKDIR)/Samba3-HOWTO.xml xslt/extract-examples.xsl scripts/indent-smb.conf.pl
|
samples: $(DOCBOOKDIR)/Samba3-HOWTO.xml xslt/extract-examples.xsl scripts/indent-smb.conf.pl
|
||||||
|
@ -1,83 +0,0 @@
|
|||||||
#!/usr/bin/python
|
|
||||||
|
|
||||||
# Copyright (C) 2007,2012 Jelmer Vernooij <jelmer@samba.org>
|
|
||||||
|
|
||||||
# This program is free software; you can redistribute it and/or modify
|
|
||||||
# it under the terms of the GNU General Public License as published by
|
|
||||||
# the Free Software Foundation; either version 3 of the License, or
|
|
||||||
# (at your option) any later version.
|
|
||||||
#
|
|
||||||
# This program is distributed in the hope that it will be useful,
|
|
||||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
# GNU General Public License for more details.
|
|
||||||
#
|
|
||||||
# You should have received a copy of the GNU General Public License
|
|
||||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
#
|
|
||||||
|
|
||||||
import optparse
|
|
||||||
import os
|
|
||||||
import re
|
|
||||||
|
|
||||||
parser = optparse.OptionParser("source_dir")
|
|
||||||
|
|
||||||
(opts, args) = parser.parse_args()
|
|
||||||
|
|
||||||
if len(args) == 1:
|
|
||||||
topdir = args[0]
|
|
||||||
else:
|
|
||||||
topdir = "."
|
|
||||||
|
|
||||||
# Reading links from manpage
|
|
||||||
|
|
||||||
curdir = os.getcwd()
|
|
||||||
doc = {}
|
|
||||||
|
|
||||||
os.chdir("smbdotconf");
|
|
||||||
|
|
||||||
f = os.popen("xsltproc --xinclude --param smb.context ALL generate-context.xsl parameters.all.xml", "r")
|
|
||||||
try:
|
|
||||||
for l in f.readlines():
|
|
||||||
m = re.match('<samba:parameter .*?name="([^"]*?)"', l)
|
|
||||||
if m:
|
|
||||||
name = m.group(1).replace(" ", "")
|
|
||||||
doc[name] = False
|
|
||||||
finally:
|
|
||||||
f.close()
|
|
||||||
|
|
||||||
os.chdir(curdir)
|
|
||||||
|
|
||||||
# Reading entries from source code
|
|
||||||
|
|
||||||
f = open(os.path.join(topdir, "lib/param/param_table.c"), "r")
|
|
||||||
|
|
||||||
# burn through the preceding lines
|
|
||||||
while True:
|
|
||||||
l = f.readline()
|
|
||||||
if l.startswith("static struct parm_struct parm_table"):
|
|
||||||
break
|
|
||||||
|
|
||||||
for l in f.readlines():
|
|
||||||
if re.match("^\s*\}\;\s*$", l):
|
|
||||||
break
|
|
||||||
# pull in the param names only
|
|
||||||
if re.match(".*P_SEPARATOR.*", l):
|
|
||||||
continue
|
|
||||||
m = re.match("\s*\.label\s*=\s*\"(.*)\".*", l)
|
|
||||||
if not m:
|
|
||||||
continue
|
|
||||||
|
|
||||||
name = m.group(1)
|
|
||||||
name = name.replace(" ", "")
|
|
||||||
|
|
||||||
if name.lower() in doc:
|
|
||||||
doc[name.lower()] = True
|
|
||||||
else:
|
|
||||||
print "'%s' is not documented" % name
|
|
||||||
f.close()
|
|
||||||
|
|
||||||
# Try to find missing references
|
|
||||||
for key in doc.keys():
|
|
||||||
if doc[key] == "FOUND":
|
|
||||||
print "'$_' is documented but is not a configuration option"
|
|
@ -21,6 +21,7 @@
|
|||||||
from selftesthelpers import *
|
from selftesthelpers import *
|
||||||
|
|
||||||
planpythontestsuite("none", "samba.tests.source")
|
planpythontestsuite("none", "samba.tests.source")
|
||||||
|
planpythontestsuite("none", "samba.tests.docs")
|
||||||
planpythontestsuite("none", "selftest.tests.test_suite", extra_path=[srcdir()])
|
planpythontestsuite("none", "selftest.tests.test_suite", extra_path=[srcdir()])
|
||||||
planpythontestsuite("none", "subunit")
|
planpythontestsuite("none", "subunit")
|
||||||
planpythontestsuite("none", "samba.tests.blackbox.ndrdump")
|
planpythontestsuite("none", "samba.tests.blackbox.ndrdump")
|
||||||
|
90
source4/scripting/python/samba/tests/docs.py
Normal file
90
source4/scripting/python/samba/tests/docs.py
Normal file
@ -0,0 +1,90 @@
|
|||||||
|
# Unix SMB/CIFS implementation.
|
||||||
|
# Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007-2012
|
||||||
|
#
|
||||||
|
# Tests for documentation.
|
||||||
|
#
|
||||||
|
# This program is free software; you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU General Public License as published by
|
||||||
|
# the Free Software Foundation; either version 3 of the License, or
|
||||||
|
# (at your option) any later version.
|
||||||
|
#
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU General Public License
|
||||||
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
|
||||||
|
"""Tests for presence of documentation."""
|
||||||
|
|
||||||
|
import samba
|
||||||
|
import samba.tests
|
||||||
|
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import subprocess
|
||||||
|
|
||||||
|
|
||||||
|
class TestCase(samba.tests.TestCase):
|
||||||
|
|
||||||
|
def _format_message(self, parameters, message):
|
||||||
|
parameters = list(parameters)
|
||||||
|
parameters.sort()
|
||||||
|
return message + '\n\n %s' % ('\n '.join(parameters))
|
||||||
|
|
||||||
|
|
||||||
|
def get_documented_parameters(sourcedir):
|
||||||
|
p = subprocess.Popen(
|
||||||
|
["xsltproc", "--xinclude", "--param", "smb.context", "ALL", "generate-context.xsl", "parameters.all.xml"],
|
||||||
|
stdout=subprocess.PIPE, cwd=os.path.join(sourcedir, "docs-xml", "smbdotconf"))
|
||||||
|
out, err = p.communicate()
|
||||||
|
assert p.returncode == 0, "returncode was %r" % p.returncode
|
||||||
|
for l in out.splitlines():
|
||||||
|
m = re.match('<samba:parameter .*?name="([^"]*?)"', l)
|
||||||
|
if m:
|
||||||
|
name = m.group(1).replace(" ", "")
|
||||||
|
yield name
|
||||||
|
|
||||||
|
|
||||||
|
def get_implementation_parameters(sourcedir):
|
||||||
|
# Reading entries from source code
|
||||||
|
f = open(os.path.join(sourcedir, "lib/param/param_table.c"), "r")
|
||||||
|
try:
|
||||||
|
# burn through the preceding lines
|
||||||
|
while True:
|
||||||
|
l = f.readline()
|
||||||
|
if l.startswith("static struct parm_struct parm_table"):
|
||||||
|
break
|
||||||
|
|
||||||
|
for l in f.readlines():
|
||||||
|
if re.match("^\s*\}\;\s*$", l):
|
||||||
|
break
|
||||||
|
# pull in the param names only
|
||||||
|
if re.match(".*P_SEPARATOR.*", l):
|
||||||
|
continue
|
||||||
|
m = re.match("\s*\.label\s*=\s*\"(.*)\".*", l)
|
||||||
|
if not m:
|
||||||
|
continue
|
||||||
|
|
||||||
|
name = m.group(1)
|
||||||
|
yield name.lower().replace(" ", "")
|
||||||
|
finally:
|
||||||
|
f.close()
|
||||||
|
|
||||||
|
|
||||||
|
class SmbDotConfTests(TestCase):
|
||||||
|
|
||||||
|
def test_missing(self):
|
||||||
|
topdir = samba.source_tree_topdir()
|
||||||
|
documented = set(get_documented_parameters(topdir))
|
||||||
|
parameters = set(get_implementation_parameters(topdir))
|
||||||
|
unknown = documented.difference(parameters)
|
||||||
|
if len(unknown) > 0:
|
||||||
|
self.fail(self._format_message(unknown,
|
||||||
|
"Parameters that are documented but not in the implementation:"))
|
||||||
|
undocumented = parameters.difference(documented)
|
||||||
|
if len(undocumented) > 0:
|
||||||
|
self.fail(self._format_message(undocumented,
|
||||||
|
"Parameters that are in the implementation but undocumented:"))
|
Loading…
Reference in New Issue
Block a user