samba-mirror/python/samba/tests/docs.py

# 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 subprocess
import xml.etree.ElementTree as ET
import multiprocessing
import concurrent.futures
import tempfile

class TestCase(samba.tests.TestCaseInTempDir):

    def _format_message(self, parameters, message):
        parameters = list(parameters)
        parameters = list(map(str, parameters))
        parameters.sort()
        return message + '\n\n    %s' % ('\n    '.join(parameters))

def get_max_worker_count():
    cpu_count = multiprocessing.cpu_count()

    # Always run two processes in parallel
    if cpu_count < 2:
        return 2

    max_workers = int(cpu_count / 2)
    if max_workers < 2:
        return 2

    return max_workers

def check_or_set_smbconf_default(cmdline, topdir, param, default_param):
    p = subprocess.Popen(cmdline,
                         stdout=subprocess.PIPE,
                         stderr=subprocess.PIPE,
                         cwd=topdir).communicate()
    result = p[0].decode().upper().strip()
    if result != default_param.upper():
        if not (result == "" and default_param == '""'):
            return result, param, default_param

    return None

def set_smbconf_arbitrary(cmdline, topdir, param, param_type, value_to_use):
    p = subprocess.Popen(cmdline,
                         stdout=subprocess.PIPE,
                         stderr=subprocess.PIPE,
                         cwd=topdir).communicate()
    result = p[0].decode().upper().strip()
    if result != value_to_use.upper():
        # currently no way to distinguish command lists
        if param_type == 'list':
            if ", ".join(result.split()) == value_to_use.upper():
                return None

    # currently no way to identify octal
    if param_type == 'integer':
        try:
            if int(value_to_use, 8) == int(p[0].strip(), 8):
                return None
        except:
            pass

        return result, param, value_to_use

    return None

def set_smbconf_arbitrary_opposite(cmdline, topdir, tempdir, section, param,
                                   param_type, opposite_value, value_to_use):
    g = tempfile.NamedTemporaryFile(mode='w', dir=tempdir, delete=False)
    try:
        towrite = section + "\n"
        towrite += param + " = " + opposite_value
        g.write(towrite)
    finally:
        g.close()

    p = subprocess.Popen(cmdline + ["-s", g.name],
                         stdout=subprocess.PIPE,
                         stderr=subprocess.PIPE,
                         cwd=topdir).communicate()
    os.unlink(g.name)

    # testparm doesn't display a value if they are equivalent
    if (value_to_use.lower() != opposite_value.lower()):
        for line in p[0].decode().splitlines():
            if not line.strip().startswith(param):
                return None

            value_found = line.split("=")[1].upper().strip()
            if value_found != value_to_use.upper():
                # currently no way to distinguish command lists
                if param_type == 'list':
                    if ", ".join(value_found.split()) == value_to_use.upper():
                        return None

                # currently no way to identify octal
                if param_type == 'integer':
                    try:
                        if int(value_to_use, 8) == int(value_found, 8):
                            continue
                    except:
                        pass

                    return param, value_to_use, value_found

    return None

def get_documented_parameters(sourcedir):
    path = os.path.join(sourcedir, "bin", "default", "docs-xml", "smbdotconf")
    if not os.path.exists(os.path.join(path, "parameters.all.xml")):
        raise Exception("Unable to find parameters.all.xml")
    try:
        p = open(os.path.join(path, "parameters.all.xml"), 'r')
    except IOError as e:
        raise Exception("Error opening parameters file")
    out = p.read()

    root = ET.fromstring(out)
    for parameter in root:
        name = parameter.attrib.get('name')
        if parameter.attrib.get('removed') == "1":
            continue
        yield name
        syn = parameter.findall('synonym')
        if syn is not None:
            for sy in syn:
                yield sy.text
    p.close()


def get_documented_tuples(sourcedir, omit_no_default=True):
    path = os.path.join(sourcedir, "bin", "default", "docs-xml", "smbdotconf")
    if not os.path.exists(os.path.join(path, "parameters.all.xml")):
        raise Exception("Unable to find parameters.all.xml")
    try:
        p = open(os.path.join(path, "parameters.all.xml"), 'r')
    except IOError as e:
        raise Exception("Error opening parameters file")
    out = p.read()

    root = ET.fromstring(out)
    for parameter in root:
        name = parameter.attrib.get("name")
        param_type = parameter.attrib.get("type")
        if parameter.attrib.get('removed') == "1":
            continue
        values = parameter.findall("value")
        defaults = []
        for value in values:
            if value.attrib.get("type") == "default":
                defaults.append(value)

        default_text = None
        if len(defaults) == 0:
            if omit_no_default:
                continue
        elif len(defaults) > 1:
            raise Exception("More than one default found for parameter %s" % name)
        else:
            default_text = defaults[0].text

        if default_text is None:
            default_text = ""
        context = parameter.attrib.get("context")
        yield name, default_text, context, param_type
    p.close()


class SmbDotConfTests(TestCase):

    # defines the cases where the defaults may differ from the documentation
    #
    # Please pass the default via waf rather than adding to this
    # list if at all possible.
    special_cases = set([
        'log level',
        'path',
        'panic action',
        'homedir map',
        'NIS homedir',
        'server string',
        'netbios name',
        'socket options',
        'ctdbd socket',
        'printing',
        'printcap name',
        'queueresume command',
        'queuepause command',
        'lpresume command',
        'lppause command',
        'lprm command',
        'lpq command',
        'print command',
        'template homedir',
        'max open files',
        'include system krb5 conf',
        'smbd max async dosmode',
        'dns hostname',
    ])

    def setUp(self):
        super().setUp()
        # create a minimal smb.conf file for testparm
        self.smbconf = os.path.join(self.tempdir, "paramtestsmb.conf")
        f = open(self.smbconf, 'w')
        try:
            f.write("""
[test]
   path = /
""")
        finally:
            f.close()

        self.blankconf = os.path.join(self.tempdir, "emptytestsmb.conf")
        f = open(self.blankconf, 'w')
        try:
            f.write("")
        finally:
            f.close()

        self.topdir = os.path.abspath(samba.source_tree_topdir())

        try:
            self.documented = set(get_documented_parameters(self.topdir))
        except:
            self.fail("Unable to load documented parameters")

        try:
            self.defaults = set(get_documented_tuples(self.topdir))
        except:
            self.fail("Unable to load parameters")

        try:
            self.defaults_all = set(get_documented_tuples(self.topdir, False))
        except:
            self.fail("Unable to load parameters")

    def tearDown(self):
        super().tearDown()
        os.unlink(self.smbconf)
        os.unlink(self.blankconf)

    def test_default_s3(self):
        self._test_default(['bin/testparm'])
        self._set_defaults(['bin/testparm'])

        # registry shares appears to need sudo
        self._set_arbitrary(['bin/testparm'],
            exceptions = ['client lanman auth',
                          'client plaintext auth',
                          'registry shares',
                          'smb ports',
                          'rpc server dynamic port range',
                          'name resolve order',
                          'clustering'])
        self._test_empty(['bin/testparm'])

    def test_default_s4(self):
        self._test_default(['bin/samba-tool', 'testparm'])
        self._set_defaults(['bin/samba-tool', 'testparm'])
        self._set_arbitrary(['bin/samba-tool', 'testparm'],
                            exceptions=['smb ports',
                                        'rpc server dynamic port range',
                                        'name resolve order'])
        self._test_empty(['bin/samba-tool', 'testparm'])

    def _test_default(self, program):

        if program[0] == 'bin/samba-tool' and os.getenv("PYTHON", None):
            program = [os.environ["PYTHON"]] + program

        failset = set()

        with concurrent.futures.ProcessPoolExecutor(max_workers=get_max_worker_count()) as executor:
            result_futures = []

            for tuples in self.defaults:
                param, default, context, param_type = tuples

                if param in self.special_cases:
                    continue
                # bad, bad parametric options - we don't have their default values
                if ':' in param:
                    continue
                section = None
                if context == "G":
                    section = "global"
                elif context == "S":
                    section = "test"
                else:
                    self.fail("%s has no valid context" % param)

                program_arg1 = ["--configfile=%s" % (self.smbconf)]
                if (program[0] == 'bin/testparm'):
                    program_arg1 = ["--suppress-prompt", self.smbconf]

                cmdline = program + program_arg1 + [
                                     "--section-name",
                                     section,
                                     "--parameter-name",
                                     param]

                future = executor.submit(check_or_set_smbconf_default, cmdline, self.topdir, param, default)
                result_futures.append(future)

            for f in concurrent.futures.as_completed(result_futures):
                if f.result():
                    result, param, default_param = f.result()

                    doc_triple = "%s\n      Expected: %s" % (param, default_param)
                    failset.add("%s\n      Got: %s" % (doc_triple, result))

        if len(failset) > 0:
            self.fail(self._format_message(failset,
                                           "Parameters that do not have matching defaults:"))

    def _set_defaults(self, program):

        if program[0] == 'bin/samba-tool' and os.getenv("PYTHON", None):
            program = [os.environ["PYTHON"]] + program

        failset = set()

        with concurrent.futures.ProcessPoolExecutor(max_workers=get_max_worker_count()) as executor:
            result_futures = []

            for tuples in self.defaults:
                param, default, context, param_type = tuples

                exceptions = set([
                    'printing',
                    'smbd max async dosmode',
                ])

                if param in exceptions:
                    continue

                section = None
                if context == "G":
                    section = "global"
                elif context == "S":
                    section = "test"
                else:
                    self.fail("%s has no valid context" % param)

                program_arg1 = ["--configfile=%s" % (self.smbconf)]
                if (program[0] == 'bin/testparm'):
                    program_arg1 = ["--suppress-prompt", self.smbconf]

                cmdline = program + program_arg1 + [
                                     "--section-name",
                                     section,
                                     "--parameter-name",
                                     param,
                                     "--option",
                                     "%s = %s" % (param, default)]
                future = executor.submit(check_or_set_smbconf_default, cmdline, self.topdir, param, default)
                result_futures.append(future)

            for f in concurrent.futures.as_completed(result_futures):
                if f.result():
                    result, param, default_param = f.result()

                    doc_triple = "%s\n      Expected: %s" % (param, default)
                    failset.add("%s\n      Got: %s" % (doc_triple, result))

        if len(failset) > 0:
            self.fail(self._format_message(failset,
                                           "Parameters that do not have matching defaults:"))

    def _set_arbitrary(self, program, exceptions=None):

        if program[0] == 'bin/samba-tool' and os.getenv("PYTHON", None):
            program = [os.environ["PYTHON"]] + program

        arbitrary = {'string': 'string', 'boolean': 'yes', 'integer': '5',
                     'boolean-rev': 'yes',
                     'cmdlist': 'a b c',
                     'bytes': '10',
                     'octal': '0123',
                     'ustring': 'ustring',
                     'enum': '', 'boolean-auto': '', 'char': 'a', 'list': 'a, b, c'}
        opposite_arbitrary = {'string': 'string2', 'boolean': 'no', 'integer': '6',
                              'boolean-rev': 'no',
                              'cmdlist': 'd e f',
                              'bytes': '11',
                              'octal': '0567',
                              'ustring': 'ustring2',
                              'enum': '', 'boolean-auto': '', 'char': 'b', 'list': 'd, e, f'}

        failset = set()

        with concurrent.futures.ProcessPoolExecutor(max_workers=get_max_worker_count()) as executor:
            result_futures1 = []
            result_futures2 = []

            for tuples in self.defaults_all:
                param, default, context, param_type = tuples

                if param in ['printing', 'copy', 'include', 'log level']:
                    continue

                # currently no easy way to set an arbitrary value for these
                if param_type in ['enum', 'boolean-auto']:
                    continue

                if exceptions is not None:
                    if param in exceptions:
                        continue

                section = None
                if context == "G":
                    section = "global"
                elif context == "S":
                    section = "test"
                else:
                    self.fail("%s has no valid context" % param)

                value_to_use = arbitrary.get(param_type)
                if value_to_use is None:
                    self.fail("%s has an invalid type" % param)

                program_arg1 = ["--configfile=%s" % (self.smbconf)]
                if (program[0] == 'bin/testparm'):
                    program_arg1 = ["--suppress-prompt", self.smbconf]

                cmdline = program + program_arg1 + [
                                     "--section-name",
                                     section,
                                     "--parameter-name",
                                     param,
                                     "--option",
                                     "%s = %s" % (param, value_to_use)]

                future = executor.submit(set_smbconf_arbitrary, cmdline, self.topdir, param, param_type, value_to_use)
                result_futures1.append(future)

                opposite_value = opposite_arbitrary.get(param_type)

                cmdline = program + ["--suppress-prompt",
                                     "--option",
                                     "%s = %s" % (param, value_to_use)]

                future = executor.submit(set_smbconf_arbitrary_opposite, cmdline, self.topdir, self.tempdir,
                                         section, param, param_type, opposite_value, value_to_use)
                result_futures2.append(future)

            for f in concurrent.futures.as_completed(result_futures1):
                if f.result():
                    result, param, value_to_use = f.result()

                    doc_triple = "%s\n      Expected: %s" % (param, value_to_use)
                    failset.add("%s\n      Got: %s" % (doc_triple, result))

            for f in concurrent.futures.as_completed(result_futures2):
                if f.result():
                    param, value_to_use, value_found = f.result()

                    doc_triple = "%s\n      Expected: %s" % (param, value_to_use)
                    failset.add("%s\n      Got: %s" % (doc_triple, value_found))

        if len(failset) > 0:
            self.fail(self._format_message(failset,
                                           "Parameters that were unexpectedly not set:"))

    def _test_empty(self, program):

        if program[0] == 'bin/samba-tool' and os.getenv("PYTHON", None):
            program = [os.environ["PYTHON"]] + program

        program_arg1 = ["--configfile=%s" % (self.blankconf), "--suppress-prompt"]
        if (program[0] == 'bin/testparm'):
            program_arg1 = ["--suppress-prompt", self.blankconf]

        print(program + program_arg1)
        p = subprocess.Popen(program + program_arg1,
                             stdout=subprocess.PIPE,
                             stderr=subprocess.PIPE,
                             cwd=self.topdir).communicate()
        output = ""

        for line in p[0].decode().splitlines():
            if line.strip().startswith('#'):
                continue
            if line.strip().startswith("idmap config *"):
                continue
            output += line.strip().lower() + '\n'

        if output.strip() != '[global]' and output.strip() != '[globals]':
            self.fail("Testparm returned unexpected output on an empty smb.conf.")