summaryrefslogtreecommitdiffstats
path: root/tests/test_ipalib/test_cli.py
blob: 56297fdf74012920d618ca086151b6579d0132f5 (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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
# Authors:
#   Jason Gerard DeRose <jderose@redhat.com>
#
# Copyright (C) 2008  Red Hat
# see file 'COPYING' for use and warranty information
#
# 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; version 2 only
#
# 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, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

"""
Test the `ipalib.cli` module.
"""

from tests.util import raises, get_api, ClassChecker
from ipalib import cli, plugable, frontend, backend


class test_textui(ClassChecker):
    _cls = cli.textui

    def test_max_col_width(self):
        """
        Test the `ipalib.cli.textui.max_col_width` method.
        """
        o = self.cls()
        e = raises(TypeError, o.max_col_width, 'hello')
        assert str(e) == 'rows: need %r or %r; got %r' % (list, tuple, 'hello')
        rows = [
            'hello',
            'naughty',
            'nurse',
        ]
        assert o.max_col_width(rows) == len('naughty')
        rows = (
            ( 'a',  'bbb',  'ccccc'),
            ('aa', 'bbbb', 'cccccc'),
        )
        assert o.max_col_width(rows, col=0) == 2
        assert o.max_col_width(rows, col=1) == 4
        assert o.max_col_width(rows, col=2) == 6


def test_to_cli():
    """
    Test the `ipalib.cli.to_cli` function.
    """
    f = cli.to_cli
    assert f('initialize') == 'initialize'
    assert f('user_add') == 'user-add'


def test_from_cli():
    """
    Test the `ipalib.cli.from_cli` function.
    """
    f = cli.from_cli
    assert f('initialize') == 'initialize'
    assert f('user-add') == 'user_add'


def get_cmd_name(i):
    return 'cmd_%d' % i


class DummyCommand(object):
    def __init__(self, name):
        self.__name = name

    def __get_name(self):
        return self.__name
    name = property(__get_name)


class DummyAPI(object):
    def __init__(self, cnt):
        self.__cmd = plugable.NameSpace(self.__cmd_iter(cnt))

    def __get_cmd(self):
        return self.__cmd
    Command = property(__get_cmd)

    def __cmd_iter(self, cnt):
        for i in xrange(cnt):
            yield DummyCommand(get_cmd_name(i))

    def finalize(self):
        pass

    def register(self, *args, **kw):
        pass


config_cli = """
[global]

from_cli_conf = set in cli.conf
"""

config_default = """
[global]

from_default_conf = set in default.conf

# Make sure cli.conf is loaded first:
from_cli_conf = overridden in default.conf
"""


class test_CLI(ClassChecker):
    """
    Test the `ipalib.cli.CLI` class.
    """
    _cls = cli.CLI

    def new(self, argv=tuple()):
        (api, home) = get_api()
        o = self.cls(api, argv)
        assert o.api is api
        return (o, api, home)

    def check_cascade(self, *names):
        (o, api, home) = self.new()
        method = getattr(o, names[0])
        for name in names:
            assert o.isdone(name) is False
        method()
        for name in names:
            assert o.isdone(name) is True
        e = raises(StandardError, method)
        assert str(e) == 'CLI.%s() already called' % names[0]

    def test_init(self):
        """
        Test the `ipalib.cli.CLI.__init__` method.
        """
        argv = ['-v', 'user-add', '--first=Jonh', '--last=Doe']
        (o, api, home) = self.new(argv)
        assert o.api is api
        assert o.argv == tuple(argv)

    def test_run_real(self):
        """
        Test the `ipalib.cli.CLI.run_real` method.
        """
        self.check_cascade(
            'run_real',
            'finalize',
            'load_plugins',
            'bootstrap',
            'parse_globals'
        )

    def test_finalize(self):
        """
        Test the `ipalib.cli.CLI.finalize` method.
        """
        self.check_cascade(
            'finalize',
            'load_plugins',
            'bootstrap',
            'parse_globals'
        )

        (o, api, home) = self.new()
        assert api.isdone('finalize') is False
        assert 'Command' not in api
        o.finalize()
        assert api.isdone('finalize') is True
        assert list(api.Command) == \
            sorted(k.__name__ for k in cli.cli_application_commands)

    def test_load_plugins(self):
        """
        Test the `ipalib.cli.CLI.load_plugins` method.
        """
        self.check_cascade(
            'load_plugins',
            'bootstrap',
            'parse_globals'
        )
        (o, api, home) = self.new()
        assert api.isdone('load_plugins') is False
        o.load_plugins()
        assert api.isdone('load_plugins') is True

    def test_bootstrap(self):
        """
        Test the `ipalib.cli.CLI.bootstrap` method.
        """
        self.check_cascade(
            'bootstrap',
            'parse_globals'
        )
        # Test with empty argv
        (o, api, home) = self.new()
        keys = tuple(api.env)
        assert api.isdone('bootstrap') is False
        o.bootstrap()
        assert api.isdone('bootstrap') is True
        e = raises(StandardError, o.bootstrap)
        assert str(e) == 'CLI.bootstrap() already called'
        assert api.env.verbose is False
        assert api.env.context == 'cli'
        keys = tuple(api.env)
        added = (
                'my_key',
                'from_default_conf',
                'from_cli_conf'
        )
        for key in added:
            assert key not in api.env
            assert key not in keys

        # Test with a populated argv
        argv = ['-e', 'my_key=my_val,whatever=Hello']
        (o, api, home) = self.new(argv)
        home.write(config_default, '.ipa', 'default.conf')
        home.write(config_cli, '.ipa', 'cli.conf')
        o.bootstrap()
        assert api.env.my_key == 'my_val,whatever=Hello'
        assert api.env.from_default_conf == 'set in default.conf'
        assert api.env.from_cli_conf == 'set in cli.conf'
        assert list(api.env) == sorted(keys + added)

    def test_parse_globals(self):
        """
        Test the `ipalib.cli.CLI.parse_globals` method.
        """
        # Test with empty argv:
        (o, api, home) = self.new()
        assert not hasattr(o, 'options')
        assert not hasattr(o, 'cmd_argv')
        assert o.isdone('parse_globals') is False
        o.parse_globals()
        assert o.isdone('parse_globals') is True
        assert o.options.prompt_all is False
        assert o.options.interactive is True
        assert o.options.verbose is None
        assert o.options.conf is None
        assert o.options.env is None
        assert o.cmd_argv == tuple()
        e = raises(StandardError, o.parse_globals)
        assert str(e) == 'CLI.parse_globals() already called'

        # Test with a populated argv:
        argv = ('-a', '-n', '-v', '-c', '/my/config.conf', '-e', 'my_key=my_val')
        cmd_argv = ('user-add', '--first', 'John', '--last', 'Doe')
        (o, api, home) = self.new(argv + cmd_argv)
        assert not hasattr(o, 'options')
        assert not hasattr(o, 'cmd_argv')
        assert o.isdone('parse_globals') is False
        o.parse_globals()
        assert o.isdone('parse_globals') is True
        assert o.options.prompt_all is True
        assert o.options.interactive is False
        assert o.options.verbose is True
        assert o.options.conf == '/my/config.conf'
        assert o.options.env == ['my_key=my_val']
        assert o.cmd_argv == cmd_argv
        e = raises(StandardError, o.parse_globals)
        assert str(e) == 'CLI.parse_globals() already called'

        # Test with multiple -e args:
        argv = ('-e', 'key1=val1', '-e', 'key2=val2')
        (o, api, home) = self.new(argv)
        o.parse_globals()
        assert o.options.env == ['key1=val1', 'key2=val2']