File: test_schema_plugin.py

package info (click to toggle)
freeipa 4.13.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 367,240 kB
  • sloc: javascript: 562,763; python: 310,289; ansic: 49,809; sh: 7,176; makefile: 2,589; xml: 343; sed: 16
file content (456 lines) | stat: -rw-r--r-- 17,120 bytes parent folder | download | duplicates (4)
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
#
# Copyright (C) 2017  FreeIPA Contributors see COPYING for license
#

"""
Test the `ipaserver/plugins/schema.py` module.
"""

import pytest

from ipalib import api, errors
from ipapython.dnsutil import DNSName
from ipatests.test_xmlrpc.xmlrpc_test import XMLRPC_test


@pytest.mark.tier1
class TestParamFindAndShowCommand(XMLRPC_test):
    """Test functionality of the ipa param-{find,show} command"""
    def run_command(self, command, *args, **options):
        cmd = api.Command[command]
        cmd_result = cmd(*args, **options)
        return cmd_result

    def test_param_find(self):
        """Test param-find command"""
        cmd = "param_find"
        # right command without criteria
        result = self.run_command(cmd, "user-add")
        assert len(result['result']) != 0, result
        assert result['result'][0]['name'] == 'uid', result
        assert result['result'][0]['cli_name'] == 'login', result
        assert result['result'][0]['label'] == 'User login', result

        # right command, right criteria
        criteria = u'postalcode'
        result = self.run_command(cmd, "user-add", criteria)
        assert len(result['result']) != 0, result
        for item in result['result']:
            assert (criteria in item['name'].lower() or
                    criteria in item['doc'].lower()), item

        # right command, wrong criteria
        result = self.run_command(cmd, "user-add", "fake")
        assert len(result['result']) == 0, result

        # wrong command, wrong criteria
        result = self.run_command(cmd, "fake", "fake")
        assert len(result['result']) == 0, result

        # too many args
        with pytest.raises(errors.MaxArgumentError):
            self.run_command(cmd, "arg1", "arg2", "arg3")

    def test_param_show(self):
        """Test param-show command"""
        # right command, right criteria
        criteria = "uid"
        cmd = "param_show"
        result = self.run_command(cmd, "user-add", criteria)
        assert result['result'] is not None, result
        assert result['result']['name'] == 'uid', result
        assert result['result']['cli_name'] == 'login', result
        assert result['result']['label'] == 'User login', result

        # right command without criteria
        with pytest.raises(errors.RequirementError):
            self.run_command(cmd, "user-add")

        # right command, wrong criteria
        with pytest.raises(errors.NotFound):
            self.run_command(cmd, "user-add", "fake")

        # wrong command, wrong criteria
        with pytest.raises(errors.NotFound):
            self.run_command(cmd, "fake", "fake")

        # too many args
        with pytest.raises(errors.MaxArgumentError):
            self.run_command(cmd, "arg1", "arg2", "arg3")


class TestOutputFindAndShowCommand(XMLRPC_test):
    """Test functionality of the ipa output-{find,show} command"""
    def run_command(self, command, *args, **options):
        cmd = api.Command[command]
        cmd_result = cmd(*args, **options)
        return cmd_result

    def test_output_find(self):
        """Test output-find command"""
        cmd = "output_find"
        # right command without criteria
        result = self.run_command(cmd, "user-add")
        assert len(result['result']) != 0, result
        assert result['result'][0]['name'] == 'summary', result
        assert result['result'][0]['doc'] == \
            'User-friendly description of action performed', result

        # right command, right criteria
        criteria = u'result'
        result = self.run_command(cmd, "user-add", criteria)
        assert len(result['result']) == 1, result
        assert criteria in result['result'][0]['name'].lower(), result

        # right command, wrong criteria
        result = self.run_command(cmd, "user-add", "fake")
        assert len(result['result']) == 0, result

        # wrong command, wrong criteria
        result = self.run_command(cmd, "fake", "fake")
        assert len(result['result']) == 0, result

        # too many args
        with pytest.raises(errors.MaxArgumentError):
            self.run_command(cmd, "arg1", "arg2", "arg3")

    def test_output_show(self):
        """Test output-show command"""

        # right command, right criteria
        criteria = "value"
        cmd = "output_show"
        result = self.run_command(cmd, "user-add", criteria)
        assert len(result['result']) != 0, result
        assert criteria in result['result']['name'].lower(), result
        assert result['result']['doc'] == \
            "The primary_key value of the entry, e.g. 'jdoe' for a user", result

        # right command without criteria
        with pytest.raises(errors.RequirementError):
            self.run_command(cmd, "user-add")

        # right command, wrong criteria
        with pytest.raises(errors.NotFound):
            self.run_command(cmd, "user-add", "fake")

        # wrong command, wrong criteria
        with pytest.raises(errors.NotFound):
            self.run_command(cmd, "fake", "fake")

        # too many args
        with pytest.raises(errors.MaxArgumentError):
            self.run_command(cmd, "arg1", "arg2", "arg3")


class TestSchemaCommand(XMLRPC_test):
    """Test functionality of the ipa schema Command(no cli)"""
    expected_keys = {
        "classes", "commands", "fingerprint", "topics", "ttl", "version"
    }

    def run_command(self, command, *args, **options):
        cmd = api.Command[command]
        cmd_result = cmd(*args, **options)
        return cmd_result

    def test_schema_no_args(self):
        """Test schema command without any args"""
        cmd_result = self.run_command("schema")
        result = cmd_result["result"]
        assert result.keys() == self.expected_keys

    def test_schema_known_valid_fp(self):
        """Test schema command with valid fingerprint"""
        # first, fetch current FP to reuse it
        cmd_result = self.run_command("schema")
        result = cmd_result["result"]
        fp_valid = result["fingerprint"]

        with pytest.raises(errors.SchemaUpToDate):
            self.run_command("schema", known_fingerprints=(fp_valid,))

    def test_schema_known_wrong_fp(self):
        """Test schema command with wrong fingerprint"""
        fp_wrong = "wrong FP"
        cmd_result = self.run_command("schema", known_fingerprints=(fp_wrong,))
        result = cmd_result["result"]
        assert result.keys() == self.expected_keys

    def test_schema_too_many_args(self):
        """Test schema with too many args"""
        with pytest.raises(errors.ZeroArgumentError):
            self.run_command("schema", "arg1")


class TestCommandCommand(XMLRPC_test):
    """Test functionality of the ipa 'command' command"""
    expected_keys = {
        "doc",
        "full_name",
        "name",
        "topic_topic",
        "version",
    }

    def run_command(self, command, *args, **options):
        cmd = api.Command[command]
        cmd_result = cmd(*args, **options)
        return cmd_result

    def test_command_find_all(self):
        """Test command-find without any args"""
        cmd_result = self.run_command("command_find")
        result = cmd_result["result"]
        assert len(result) != 0, result
        for item in result:
            assert self.expected_keys.issubset(item.keys()), item

    def test_command_find_existent_command(self):
        """Test 'command' with existent command as arg"""
        criteria = "user_add"
        cmd_result = self.run_command("command_find", criteria)
        result = cmd_result["result"]
        assert len(result) != 0, result
        for item in result:
            assert self.expected_keys.issubset(item.keys()), item
            name = item["name"].lower()
            doc = item.get("doc", "").lower()
            assert criteria in name or criteria in doc, item

    def test_command_find_nonexistent_command(self):
        """Test command-find with nonexistent command as arg"""
        cmd_result = self.run_command("command_find", "nonextentcommand")
        result = cmd_result["result"]
        assert len(result) == 0, result

    def test_command_find_too_many_args(self):
        """Test command-find with too many args"""
        with pytest.raises(errors.MaxArgumentError):
            self.run_command("command_find", "arg1", "arg2")

    def test_command_show_no_args(self):
        """Test command-show without args"""
        with pytest.raises(errors.RequirementError):
            self.run_command("command_show")

    def test_command_show_existent_command(self):
        """Test command-show with existent command as arg"""
        criteria = "user_add"
        cmd_result = self.run_command("command_show", criteria)
        result = cmd_result["result"]
        assert self.expected_keys.issubset(result.keys()), result
        assert result["name"] == criteria

    def test_command_show_nonexistent_command(self):
        """Test command-show with nonexistent command as arg"""
        with pytest.raises(errors.NotFound):
            self.run_command("command_show", "nonextentcommand")

    def test_command_show_too_many_args(self):
        """Test command-show with too many args"""
        with pytest.raises(errors.MaxArgumentError):
            self.run_command("command_show", "arg1", "arg2")

    def test_command_defaults_no_args(self):
        """Test command_defaults without args"""
        with pytest.raises(errors.RequirementError):
            self.run_command("command_defaults")

    def test_command_defaults_existent_command(self):
        """Test command_defaults with existent command as arg"""
        criteria = "user_add"
        cmd_result = self.run_command("command_defaults", criteria)
        # 9c19dd350: do not validate unrequested params in command_defaults
        result = cmd_result["result"]
        assert len(result) == 0, result

    def test_command_defaults_existent_command_params(self):
        """Test command_defaults with existent command as arg with params"""
        criteria = "user_add"
        params = ["all"]
        cmd_result = self.run_command(
            "command_defaults", criteria, params=params
        )
        result = cmd_result["result"]
        assert len(result) == len(params), result
        assert isinstance(result["all"], bool)

    def test_command_defaults_existent_command_several_params(self):
        """
        Test command_defaults with existent command as arg with several params
        """
        criteria = "user_add"
        params = ["all", "raw"]
        cmd_result = self.run_command(
            "command_defaults", criteria, params=params
        )
        result = cmd_result["result"]
        assert len(result) == len(params), result
        assert isinstance(result["all"], bool), result
        assert isinstance(result["raw"], bool), result

    def test_command_defaults_existent_command_kw(self):
        """Test command_defaults with existent command as arg with kw"""
        criteria = "dnszone_add"
        params = ["idnsname"]
        kw = {"name_from_ip": "127.0.0.1"}
        cmd_result = self.run_command(
            "command_defaults", criteria, params=params
        )
        result = cmd_result["result"]
        assert len(result) == 0, result

        cmd_result = self.run_command(
            "command_defaults", criteria, params=params, kw=kw
        )
        result = cmd_result["result"]
        assert len(result) == len(params), result
        assert isinstance(result["idnsname"], DNSName)

    def test_command_defaults_nonexistent_command(self):
        """Test command-show with nonexistent command as arg"""
        with pytest.raises(errors.NotFound):
            self.run_command("command_defaults", "nonextentcommand")

    def test_command_defaults_too_many_args(self):
        """Test command-show with too many args"""
        with pytest.raises(errors.MaxArgumentError):
            self.run_command("command_defaults", "arg1", "arg2")


class TestClassCommand(XMLRPC_test):
    """Test functionality of the ipa 'class' command"""
    expected_keys = {
        "name",
        "full_name",
        "version",
    }

    def run_command(self, command, *args, **options):
        cmd = api.Command[command]
        cmd_result = cmd(*args, **options)
        return cmd_result

    def test_class_find_all(self):
        """Test class-find without any args"""
        cmd_result = self.run_command("class_find")
        result = cmd_result["result"]
        assert len(result) != 0, result
        for item in result:
            assert item.keys() == self.expected_keys, item

    def test_class_find_existent_class(self):
        """Test class-find with existent class as arg"""
        criteria = "user"
        cmd_result = self.run_command("class_find", criteria)
        result = cmd_result["result"]
        assert len(result) != 0, result
        for item in result:
            assert item.keys() == self.expected_keys, item
            name = item["name"].lower()
            doc = item.get("doc", "").lower()
            assert criteria in name or criteria in doc, item

    def test_class_find_nonexistent_class(self):
        """Test class-find with nonexistent class as arg"""
        cmd_result = self.run_command("class_find", "nonextentclass")
        result = cmd_result["result"]
        assert len(result) == 0, result

    def test_class_find_too_many_args(self):
        """Test class-find with too many args"""
        with pytest.raises(errors.MaxArgumentError):
            self.run_command("class_find", "arg1", "arg2")

    def test_class_show_no_args(self):
        """Test class-show without args"""
        with pytest.raises(errors.RequirementError):
            self.run_command("class_show")

    def test_class_show_existent_class(self):
        """Test class-show with existent class as arg"""
        criteria = "user"
        cmd_result = self.run_command("class_show", criteria)
        result = cmd_result["result"]
        assert result.keys() == self.expected_keys, result
        assert result["name"] == criteria

    def test_class_show_nonexistent_class(self):
        """Test class-show with nonexistent class as arg"""
        with pytest.raises(errors.NotFound):
            self.run_command("class_show", "nonextentclass")

    def test_class_show_too_many_args(self):
        """Test class-show with too many args"""
        with pytest.raises(errors.MaxArgumentError):
            self.run_command("class_show", "arg1", "arg2")


class TestTopicCommand(XMLRPC_test):
    """Test functionality of the ipa 'topic' command"""
    expected_keys = {
        "name",
        "full_name",
        "version",
        "doc",
    }

    def run_command(self, command, *args, **options):
        cmd = api.Command[command]
        cmd_result = cmd(*args, **options)
        return cmd_result

    def test_topic_find_all(self):
        """Test topic-find without any args"""
        cmd_result = self.run_command("topic_find")
        result = cmd_result["result"]
        assert len(result) != 0, result
        for item in result:
            assert self.expected_keys.issubset(item.keys()), item

    def test_topic_find_existent_topic(self):
        """Test topic-find with existent topic as arg"""
        criteria = "user"
        cmd_result = self.run_command("topic_find", criteria)
        result = cmd_result["result"]
        assert len(result) != 0, result
        for item in result:
            assert self.expected_keys.issubset(item.keys()), item
            name = item["name"].lower()
            doc = item.get("doc", "").lower()
            assert criteria in name or criteria in doc, item

    def test_topic_find_nonexistent_topic(self):
        """Test topic-find with nonexistent topic as arg"""
        cmd_result = self.run_command("topic_find", "nonextenttopic")
        result = cmd_result["result"]
        assert len(result) == 0, result

    def test_topic_find_too_many_args(self):
        """Test topic-find with too many args"""
        with pytest.raises(errors.MaxArgumentError):
            self.run_command("topic_find", "arg1", "arg2")

    def test_topic_show_no_args(self):
        """Test topic-show without args"""
        with pytest.raises(errors.RequirementError):
            self.run_command("topic_show")

    def test_topic_show_existent_topic(self):
        """Test topic-show with existent topic as arg"""
        criteria = "user"
        cmd_result = self.run_command("topic_show", criteria)
        result = cmd_result["result"]
        assert self.expected_keys.issubset(result.keys()), result
        assert result["name"] == criteria

    def test_topic_show_nonexistent_topic(self):
        """Test topic-show with nonexistent topic as arg"""
        with pytest.raises(errors.NotFound):
            self.run_command("topic_show", "nonextenttopic")

    def test_topic_show_too_many_args(self):
        """Test topic-show with too many args"""
        with pytest.raises(errors.MaxArgumentError):
            self.run_command("topic_show", "arg1", "arg2")