summaryrefslogtreecommitdiff
path: root/python/samba/tests/netcmd.py
blob: 63f204a2c2393d6df00aae0cc8d9fe1a0269c233 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# Unix SMB/CIFS implementation.
# Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2009-2011
#
# 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 samba.netcmd."""

import os
import tempfile

from io import StringIO
from samba.netcmd import Command
from samba.netcmd.testparm import cmd_testparm
from samba.netcmd.main import cmd_sambatool
import samba.tests


class NetCmdTestCase(samba.tests.TestCaseInTempDir):

    def run_netcmd(self, cmd_klass, args, retcode=0):
        cmd = cmd_klass(outf=StringIO(), errf=StringIO())
        cmd.command_name = "apricots"
        try:
            retval = cmd._run(*args)
        except Exception as e:
            cmd.show_command_error(e)
            retval = 1
        self.assertEqual(retcode, retval)
        return cmd.outf.getvalue(), cmd.errf.getvalue()

    def iter_all_subcommands(self):
        todo = list(cmd_sambatool.subcommands.items())
        while todo:
            (path, cmd) = todo.pop()
            yield path, cmd
            subcmds = getattr(cmd, "subcommands", {})
            todo.extend([(path + " " + k, v) for (k, v) in
                         subcmds.items()])


class TestParmTests(NetCmdTestCase):

    def setUp(self):
        super().setUp()

        # Override these global parameters in case their default values are
        # invalid.
        contents = """[global]
    netbios name = test
    lock dir = /
    pid directory = /
[tmp]
    path = /
"""
        self.smbconf = self.create_smbconf(contents)

    def create_smbconf(self, contents):
        smbconf = tempfile.NamedTemporaryFile(mode='w',
                                              dir=self.tempdir,
                                              delete=False)
        self.addCleanup(os.remove, smbconf.name)

        try:
            smbconf.write(contents)
        finally:
            smbconf.close()

        return smbconf

    def test_no_client_ip(self):
        out, err = self.run_netcmd(cmd_testparm, ["--client-name=foo"],
                                   retcode=-1)
        self.assertEqual("", out)
        self.assertEqual(
            "ERROR: Both a DNS name and an IP address are "
            "required for the host access check\n", err)

    def test_section(self):
        # We don't get an opportunity to verify the output, as the parameters
        # are dumped directly to stdout, so just check the return code.
        self.run_netcmd(cmd_testparm,
                        ["--configfile=%s" % self.smbconf.name,
                         "--section-name=tmp"],
                        retcode=None)

    def test_section_globals(self):
        # We can have '[global]' and '[globals]'
        for name in ['global', 'globals']:
            self.run_netcmd(cmd_testparm,
                            [f"--configfile={self.smbconf.name}",
                             f"--section-name={name}"],
                            retcode=None)

    def test_no_such_section(self):
        out, err = self.run_netcmd(cmd_testparm,
                                   ["--configfile=%s" % self.smbconf.name,
                                    "--section-name=foo"],
                                   retcode=-1)
        # Ensure all exceptions are caught.
        self.assertEqual("", out)
        self.assertNotIn("uncaught exception", err)

        out, err = self.run_netcmd(cmd_testparm,
                                   ["--configfile=%s" % self.smbconf.name,
                                    "--section-name=foo",
                                    "--parameter-name=foo"],
                                   retcode=-1)
        # Ensure all exceptions are caught.
        self.assertEqual("", out)
        self.assertNotIn("uncaught exception", err)

    def test_no_such_parameter(self):
        out, err = self.run_netcmd(cmd_testparm,
                                   ["--configfile=%s" % self.smbconf.name,
                                    "--section-name=tmp",
                                    "--parameter-name=foo"],
                                   retcode=-1)
        # Ensure all exceptions are caught.
        self.assertEqual("", out)
        self.assertNotIn("uncaught exception", err)


class CommandTests(NetCmdTestCase):

    def test_description(self):
        class cmd_foo(Command):
            """Mydescription"""
        self.assertEqual("Mydescription", cmd_foo().short_description)

    def test_name(self):
        class cmd_foo(Command):
            pass
        self.assertEqual("foo", cmd_foo().name)

    def test_synopsis_everywhere(self):
        missing = []
        for path, cmd in self.iter_all_subcommands():
            if cmd.synopsis is None:
                missing.append(path)
        if missing:
            self.fail("The following commands do not have a synopsis set: %r" %
                      missing)

    def test_short_description_everywhere(self):
        missing = []
        for path, cmd in self.iter_all_subcommands():
            if cmd.short_description is None:
                missing.append(path)
        if not missing:
            return
        self.fail(
            "The following commands do not have a short description set: %r" %
            missing)