summaryrefslogtreecommitdiffstats
path: root/test/integration/targets/argspec/tasks/main.yml
blob: 6e8ec054fe063fb5a8d6b1f2513648f491c965dc (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
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
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
- argspec:
    required: value
    required_one_of_one: value

- argspec:
    required_one_of_one: value
  register: argspec_required_fail
  ignore_errors: true

- argspec:
    required: value
    required_one_of_two: value

- argspec:
    required: value
  register: argspec_required_one_of_fail
  ignore_errors: true

- argspec:
    required: value
    required_one_of_two: value
    required_by_one: value
    required_by_two: value
    required_by_three: value

- argspec:
    required: value
    required_one_of_two: value
    required_by_one: value
    required_by_two: value
  register: argspec_required_by_fail
  ignore_errors: true

- argspec:
    state: absent
    required: value
    required_one_of_one: value

- argspec:
    state: present
    required: value
    required_one_of_one: value
  register: argspec_required_if_fail
  ignore_errors: true

- argspec:
    state: present
    path: foo
    required: value
    required_one_of_one: value

- argspec:
    state: present
    content: foo
    required: value
    required_one_of_one: value

- argspec:
    state: present
    content: foo
    path: foo
    required: value
    required_one_of_one: value
  register: argspec_mutually_exclusive_fail
  ignore_errors: true

- argspec:
    mapping:
      foo: bar
    required: value
    required_one_of_one: value
  register: argspec_good_mapping

- argspec:
    mapping: foo=bar
    required: value
    required_one_of_one: value
  register: argspec_good_mapping_kv

- argspec:
    mapping: !!str '{"foo": "bar"}'
    required: value
    required_one_of_one: value
  register: argspec_good_mapping_json

- argspec:
    mapping: !!str '{"foo": False}'
    required: value
    required_one_of_one: value
  register: argspec_good_mapping_dict_repr

- argspec:
    mapping: foo
    required: value
    required_one_of_one: value
  register: argspec_bad_mapping_string
  ignore_errors: true

- argspec:
    mapping: 1
    required: value
    required_one_of_one: value
  register: argspec_bad_mapping_int
  ignore_errors: true

- argspec:
    mapping:
      - foo
      - bar
    required: value
    required_one_of_one: value
  register: argspec_bad_mapping_list
  ignore_errors: true

- argspec:
    required_together:
      - thing: foo
        other: bar
        another: baz
    required: value
    required_one_of_one: value

- argspec:
    required_together:
      - another: baz
    required: value
    required_one_of_one: value

- argspec:
    required_together:
      - thing: foo
    required: value
    required_one_of_one: value
  register: argspec_required_together_fail
  ignore_errors: true

- argspec:
    required_together:
      - thing: foo
        other: bar
    required: value
    required_one_of_one: value

- argspec:
    required_if:
      - thing: bar
    required: value
    required_one_of_one: value

- argspec:
    required_if:
      - thing: foo
        other: bar
    required: value
    required_one_of_one: value

- argspec:
    required_if:
      - thing: foo
    required: value
    required_one_of_one: value
  register: argspec_required_if_fail_2
  ignore_errors: true

- argspec:
    required_one_of:
      - thing: foo
        other: bar
    required: value
    required_one_of_one: value

- argspec:
    required_one_of:
      - {}
    required: value
    required_one_of_one: value
  register: argspec_required_one_of_fail_2
  ignore_errors: true

- argspec:
    required_by:
      - thing: foo
        other: bar
    required: value
    required_one_of_one: value

- argspec:
    required_by:
      - thing: foo
    required: value
    required_one_of_one: value
  register: argspec_required_by_fail_2
  ignore_errors: true

- argspec:
    json: !!str '{"foo": "bar"}'
    required: value
    required_one_of_one: value
  register: argspec_good_json_string

- argspec:
    json:
      foo: bar
    required: value
    required_one_of_one: value
  register: argspec_good_json_dict

- argspec:
    json: 1
    required: value
    required_one_of_one: value
  register: argspec_bad_json
  ignore_errors: true

- argspec:
    fail_on_missing_params:
      - needed_param
    needed_param: whatever
    required: value
    required_one_of_one: value

- argspec:
    fail_on_missing_params:
      - needed_param
    required: value
    required_one_of_one: value
  register: argspec_fail_on_missing_params_bad
  ignore_errors: true

- argspec:
    required_together_one: foo
    required_together_two: bar
    required: value
    required_one_of_one: value

- argspec:
    required_together_one: foo
    required: value
    required_one_of_one: value
  register: argspec_fail_required_together_2
  ignore_errors: true

- argspec:
    suboptions_list_no_elements:
      - thing: foo
    required: value
    required_one_of_one: value
  register: argspec_suboptions_list_no_elements

- argspec:
    choices_with_strings_like_bools: on
    required: value
    required_one_of_one: value
  register: argspec_choices_with_strings_like_bools_true

- argspec:
    choices_with_strings_like_bools: 'on'
    required: value
    required_one_of_one: value
  register: argspec_choices_with_strings_like_bools_true_bool

- argspec:
    choices_with_strings_like_bools: off
    required: value
    required_one_of_one: value
  register: argspec_choices_with_strings_like_bools_false

- argspec:
    required: value
    required_one_of_one: value
    choices: foo

- argspec:
    required: value
    required_one_of_one: value
    choices: baz
  register: argspec_choices_bad_choice
  ignore_errors: true

- argspec:
    required: value
    required_one_of_one: value
    list_choices:
      - bar
      - baz

- argspec:
    required: value
    required_one_of_one: value
    list_choices:
      - bar
      - baz
      - qux
  register: argspec_list_choices_bad_choice
  ignore_errors: true

- argspec:
    required: value
    required_one_of_one: value
    primary: foo
  register: argspec_aliases_primary

- argspec:
    required: value
    required_one_of_one: value
    alias: foo
  register: argspec_aliases_alias

- argspec:
    required: value
    required_one_of_one: value
    primary: foo
    alias: foo
  register: argspec_aliases_both

- argspec:
    required: value
    required_one_of_one: value
    primary: foo
    alias: bar
  register: argspec_aliases_both_different

- command: >-
    ansible localhost -m argspec
    -a 'required=value required_one_of_one=value primary=foo alias=bar'
  environment:
    ANSIBLE_LIBRARY: '{{ role_path }}/library'
  register: argspec_aliases_both_warning

- command: ansible localhost -m import_role -a 'role=argspec tasks_from=password_no_log.yml'
  register: argspec_password_no_log

- argspec:
    required: value
    required_one_of_one: value
    int: 1

- argspec:
    required: value
    required_one_of_one: value
    int: foo
  register: argspec_int_invalid
  ignore_errors: true

- argspec:
    required: value
    required_one_of_one: value
  register: argspec_apply_defaults_not_specified

- argspec:
    required: value
    required_one_of_one: value
    apply_defaults: ~
  register: argspec_apply_defaults_none

- argspec:
    required: value
    required_one_of_one: value
    apply_defaults: {}
  register: argspec_apply_defaults_empty

- argspec:
    required: value
    required_one_of_one: value
    apply_defaults:
      foo: bar
  register: argspec_apply_defaults_one

- argspec:
    required: value
    required_one_of_one: value
    deprecation_aliases_version: value
  register: deprecation_alias_version

- argspec:
    required: value
    required_one_of_one: value
    deprecation_aliases_date: value
  register: deprecation_alias_date

- argspec:
    required: value
    required_one_of_one: value
    deprecation_param_version: value
  register: deprecation_param_version

- argspec:
    required: value
    required_one_of_one: value
    deprecation_param_date: value
  register: deprecation_param_date

- argspec:
    required: value
    required_one_of_one: value
    subdeprecation:
      deprecation_aliases_version: value
  register: sub_deprecation_alias_version

- argspec:
    required: value
    required_one_of_one: value
    subdeprecation:
      deprecation_aliases_date: value
  register: sub_deprecation_alias_date

- argspec:
    required: value
    required_one_of_one: value
    subdeprecation:
      deprecation_param_version: value
  register: sub_deprecation_param_version

- argspec:
    required: value
    required_one_of_one: value
    subdeprecation:
      deprecation_param_date: value
  register: sub_deprecation_param_date

- argspec:
    required: value
    required_one_of_one: value
    subdeprecation_alias:
      deprecation_aliases_version: value
  register: subalias_deprecation_alias_version

- argspec:
    required: value
    required_one_of_one: value
    subdeprecation_alias:
      deprecation_aliases_date: value
  register: subalias_deprecation_alias_date

- argspec:
    required: value
    required_one_of_one: value
    subdeprecation_alias:
      deprecation_param_version: value
  register: subalias_deprecation_param_version

- argspec:
    required: value
    required_one_of_one: value
    subdeprecation_alias:
      deprecation_param_date: value
  register: subalias_deprecation_param_date

- argspec:
    required: value
    required_one_of_one: value
    subdeprecation_list:
      - deprecation_aliases_version: value
  register: sublist_deprecation_alias_version

- argspec:
    required: value
    required_one_of_one: value
    subdeprecation_list:
      - deprecation_aliases_date: value
  register: sublist_deprecation_alias_date

- argspec:
    required: value
    required_one_of_one: value
    subdeprecation_list:
      - deprecation_param_version: value
  register: sublist_deprecation_param_version

- argspec:
    required: value
    required_one_of_one: value
    subdeprecation_list:
      - deprecation_param_date: value
  register: sublist_deprecation_param_date

- argspec:
    required: value
    required_one_of_one: value
    apply_defaults:
      bar_alias1: foo
      bar_alias2: baz
  register: alias_warning_dict

- argspec:
    required: value
    required_one_of_one: value
    required_one_of:
      - other: foo
        other_alias: bar
  register: alias_warning_listdict

- assert:
    that:
      - argspec_required_fail is failed

      - argspec_required_one_of_fail is failed

      - argspec_required_by_fail is failed

      - argspec_required_if_fail is failed

      - argspec_mutually_exclusive_fail is failed

      - argspec_good_mapping is successful
      - >-
        argspec_good_mapping.mapping == {'foo': 'bar'}
      - argspec_good_mapping_json is successful
      - >-
        argspec_good_mapping_json.mapping == {'foo': 'bar'}
      - argspec_good_mapping_dict_repr is successful
      - >-
        argspec_good_mapping_dict_repr.mapping == {'foo': False}
      - argspec_good_mapping_kv is successful
      - >-
        argspec_good_mapping_kv.mapping == {'foo': 'bar'}
      - argspec_bad_mapping_string is failed
      - argspec_bad_mapping_int is failed
      - argspec_bad_mapping_list is failed

      - argspec_required_together_fail is failed

      - argspec_required_if_fail_2 is failed

      - argspec_required_one_of_fail_2 is failed

      - argspec_required_by_fail_2 is failed

      - argspec_good_json_string is successful
      - >-
        argspec_good_json_string.json == '{"foo": "bar"}'
      - argspec_good_json_dict is successful
      - >-
        argspec_good_json_dict.json == '{"foo": "bar"}'
      - argspec_bad_json is failed

      - argspec_fail_on_missing_params_bad is failed

      - argspec_fail_required_together_2 is failed

      - >-
        argspec_suboptions_list_no_elements.suboptions_list_no_elements.0 == {'thing': 'foo'}

      - argspec_choices_with_strings_like_bools_true.choices_with_strings_like_bools == 'on'
      - argspec_choices_with_strings_like_bools_true_bool.choices_with_strings_like_bools == 'on'
      - argspec_choices_with_strings_like_bools_false.choices_with_strings_like_bools == 'off'

      - argspec_choices_bad_choice is failed

      - argspec_list_choices_bad_choice is failed

      - argspec_aliases_primary.primary == 'foo'
      - argspec_aliases_primary.alias is undefined
      - argspec_aliases_alias.primary == 'foo'
      - argspec_aliases_alias.alias == 'foo'
      - argspec_aliases_both.primary == 'foo'
      - argspec_aliases_both.alias == 'foo'
      - argspec_aliases_both_different.primary == 'bar'
      - argspec_aliases_both_different.alias == 'bar'
      - '"[WARNING]: Both option primary and its alias alias are set." in argspec_aliases_both_warning.stderr'

      - '"Module did not set no_log for maybe_password" in argspec_password_no_log.stderr'
      - '"Module did not set no_log for password" not in argspec_password_no_log.stderr'
      - '"Module did not set no_log for not_a_password" not in argspec_password_no_log.stderr'
      - argspec_password_no_log.stdout|regex_findall('VALUE_SPECIFIED_IN_NO_LOG_PARAMETER')|length == 1

      - argspec_int_invalid is failed

      - "argspec_apply_defaults_not_specified.apply_defaults == {'foo': none, 'bar': 'baz'}"
      - "argspec_apply_defaults_none.apply_defaults == {'foo': none, 'bar': 'baz'}"
      - "argspec_apply_defaults_empty.apply_defaults == {'foo': none, 'bar': 'baz'}"
      - "argspec_apply_defaults_one.apply_defaults == {'foo': 'bar', 'bar': 'baz'}"

      - deprecation_alias_version.deprecations | length == 1
      - deprecation_alias_version.deprecations[0].msg == "Alias 'deprecation_aliases_version' is deprecated. See the module docs for more information"
      - deprecation_alias_version.deprecations[0].collection_name == 'foo.bar'
      - deprecation_alias_version.deprecations[0].version == '2.0.0'
      - "'date' not in deprecation_alias_version.deprecations[0]"
      - deprecation_alias_date.deprecations | length == 1
      - deprecation_alias_date.deprecations[0].msg == "Alias 'deprecation_aliases_date' is deprecated. See the module docs for more information"
      - deprecation_alias_date.deprecations[0].collection_name == 'foo.bar'
      - deprecation_alias_date.deprecations[0].date == '2023-01-01'
      - "'version' not in deprecation_alias_date.deprecations[0]"
      - deprecation_param_version.deprecations | length == 1
      - deprecation_param_version.deprecations[0].msg == "Param 'deprecation_param_version' is deprecated. See the module docs for more information"
      - deprecation_param_version.deprecations[0].collection_name == 'foo.bar'
      - deprecation_param_version.deprecations[0].version == '2.0.0'
      - "'date' not in deprecation_param_version.deprecations[0]"
      - deprecation_param_date.deprecations | length == 1
      - deprecation_param_date.deprecations[0].msg == "Param 'deprecation_param_date' is deprecated. See the module docs for more information"
      - deprecation_param_date.deprecations[0].collection_name == 'foo.bar'
      - deprecation_param_date.deprecations[0].date == '2023-01-01'
      - "'version' not in deprecation_param_date.deprecations[0]"

      - sub_deprecation_alias_version.deprecations | length == 1
      - sub_deprecation_alias_version.deprecations[0].msg == "Alias 'subdeprecation.deprecation_aliases_version' is deprecated. See the module docs for more information"
      - sub_deprecation_alias_version.deprecations[0].collection_name == 'foo.bar'
      - sub_deprecation_alias_version.deprecations[0].version == '2.0.0'
      - "'date' not in sub_deprecation_alias_version.deprecations[0]"
      - sub_deprecation_alias_date.deprecations | length == 1
      - sub_deprecation_alias_date.deprecations[0].msg == "Alias 'subdeprecation.deprecation_aliases_date' is deprecated. See the module docs for more information"
      - sub_deprecation_alias_date.deprecations[0].collection_name == 'foo.bar'
      - sub_deprecation_alias_date.deprecations[0].date == '2023-01-01'
      - "'version' not in sub_deprecation_alias_date.deprecations[0]"
      - sub_deprecation_param_version.deprecations | length == 1
      - sub_deprecation_param_version.deprecations[0].msg == "Param 'subdeprecation[\"deprecation_param_version\"]' is deprecated. See the module docs for more information"
      - sub_deprecation_param_version.deprecations[0].collection_name == 'foo.bar'
      - sub_deprecation_param_version.deprecations[0].version == '2.0.0'
      - "'date' not in sub_deprecation_param_version.deprecations[0]"
      - sub_deprecation_param_date.deprecations | length == 1
      - sub_deprecation_param_date.deprecations[0].msg == "Param 'subdeprecation[\"deprecation_param_date\"]' is deprecated. See the module docs for more information"
      - sub_deprecation_param_date.deprecations[0].collection_name == 'foo.bar'
      - sub_deprecation_param_date.deprecations[0].date == '2023-01-01'
      - "'version' not in sub_deprecation_param_date.deprecations[0]"

      - subalias_deprecation_alias_version.deprecations | length == 1
      - subalias_deprecation_alias_version.deprecations[0].msg == "Alias 'subdeprecation.deprecation_aliases_version' is deprecated. See the module docs for more information"
      - subalias_deprecation_alias_version.deprecations[0].collection_name == 'foo.bar'
      - subalias_deprecation_alias_version.deprecations[0].version == '2.0.0'
      - "'date' not in subalias_deprecation_alias_version.deprecations[0]"
      - subalias_deprecation_alias_date.deprecations | length == 1
      - subalias_deprecation_alias_date.deprecations[0].msg == "Alias 'subdeprecation.deprecation_aliases_date' is deprecated. See the module docs for more information"
      - subalias_deprecation_alias_date.deprecations[0].collection_name == 'foo.bar'
      - subalias_deprecation_alias_date.deprecations[0].date == '2023-01-01'
      - "'version' not in subalias_deprecation_alias_date.deprecations[0]"
      - subalias_deprecation_param_version.deprecations | length == 1
      - subalias_deprecation_param_version.deprecations[0].msg == "Param 'subdeprecation[\"deprecation_param_version\"]' is deprecated. See the module docs for more information"
      - subalias_deprecation_param_version.deprecations[0].collection_name == 'foo.bar'
      - subalias_deprecation_param_version.deprecations[0].version == '2.0.0'
      - "'date' not in subalias_deprecation_param_version.deprecations[0]"
      - subalias_deprecation_param_date.deprecations | length == 1
      - subalias_deprecation_param_date.deprecations[0].msg == "Param 'subdeprecation[\"deprecation_param_date\"]' is deprecated. See the module docs for more information"
      - subalias_deprecation_param_date.deprecations[0].collection_name == 'foo.bar'
      - subalias_deprecation_param_date.deprecations[0].date == '2023-01-01'
      - "'version' not in subalias_deprecation_param_date.deprecations[0]"

      - sublist_deprecation_alias_version.deprecations | length == 1
      - sublist_deprecation_alias_version.deprecations[0].msg == "Alias 'subdeprecation_list[0].deprecation_aliases_version' is deprecated. See the module docs for more information"
      - sublist_deprecation_alias_version.deprecations[0].collection_name == 'foo.bar'
      - sublist_deprecation_alias_version.deprecations[0].version == '2.0.0'
      - "'date' not in sublist_deprecation_alias_version.deprecations[0]"
      - sublist_deprecation_alias_date.deprecations | length == 1
      - sublist_deprecation_alias_date.deprecations[0].msg == "Alias 'subdeprecation_list[0].deprecation_aliases_date' is deprecated. See the module docs for more information"
      - sublist_deprecation_alias_date.deprecations[0].collection_name == 'foo.bar'
      - sublist_deprecation_alias_date.deprecations[0].date == '2023-01-01'
      - "'version' not in sublist_deprecation_alias_date.deprecations[0]"
      - sublist_deprecation_param_version.deprecations | length == 1
      - sublist_deprecation_param_version.deprecations[0].msg == "Param 'subdeprecation_list[\"deprecation_param_version\"]' is deprecated. See the module docs for more information"
      - sublist_deprecation_param_version.deprecations[0].collection_name == 'foo.bar'
      - sublist_deprecation_param_version.deprecations[0].version == '2.0.0'
      - "'date' not in sublist_deprecation_param_version.deprecations[0]"
      - sublist_deprecation_param_date.deprecations | length == 1
      - sublist_deprecation_param_date.deprecations[0].msg == "Param 'subdeprecation_list[\"deprecation_param_date\"]' is deprecated. See the module docs for more information"
      - sublist_deprecation_param_date.deprecations[0].collection_name == 'foo.bar'
      - sublist_deprecation_param_date.deprecations[0].date == '2023-01-01'
      - "'version' not in sublist_deprecation_param_date.deprecations[0]"

      - "'Both option apply_defaults.bar and its alias apply_defaults.bar_alias2 are set.' in alias_warning_dict.warnings"
      - "'Both option required_one_of[0].other and its alias required_one_of[0].other_alias are set.' in alias_warning_listdict.warnings"