File: test_parser.rb

package info (click to toggle)
ruby-cri 2.15.12-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 384 kB
  • sloc: ruby: 2,776; makefile: 11
file content (523 lines) | stat: -rw-r--r-- 17,794 bytes parent folder | download | duplicates (3)
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
# frozen_string_literal: true

require 'helper'

module Cri
  class ParserTestCase < Cri::TestCase
    def test_parse_without_options
      input = %w[foo bar baz]
      opt_defns = []

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({}, parser.options)
      assert_equal(%w[foo bar baz], parser.gen_argument_list.to_a)
    end

    def test_parse_with_invalid_option
      input = %w[foo -x]
      opt_defns = []

      assert_raises(Cri::Parser::IllegalOptionError) do
        Cri::Parser.new(input, opt_defns, [], false).run
      end
    end

    def test_parse_with_unused_options
      input = %w[foo]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :forbidden },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert(!parser.options[:aaa])
    end

    def test_parse_with_long_valueless_option
      input = %w[foo --aaa bar]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :forbidden },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert(parser.options[:aaa])
      assert_equal(%w[foo bar], parser.gen_argument_list.to_a)
    end

    def test_parse_with_long_valueful_option
      input = %w[foo --aaa xxx bar]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :required },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({ aaa: 'xxx' }, parser.options)
      assert_equal(%w[foo bar], parser.gen_argument_list.to_a)
    end

    def test_parse_with_long_valueful_equalsign_option
      input = %w[foo --aaa=xxx bar]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :required },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({ aaa: 'xxx' }, parser.options)
      assert_equal(%w[foo bar], parser.gen_argument_list.to_a)
    end

    def test_parse_with_long_valueful_option_with_missing_value
      input = %w[foo --aaa]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :required },
      ].map { |hash| make_opt_defn(hash) }

      assert_raises(Cri::Parser::OptionRequiresAnArgumentError) do
        Cri::Parser.new(input, opt_defns, [], false).run
      end
    end

    def test_parse_with_two_long_valueful_options
      input = %w[foo --all --port 2]
      opt_defns = [
        { long: 'all',  short: 'a', argument: :required },
        { long: 'port', short: 'p', argument: :required },
      ].map { |hash| make_opt_defn(hash) }

      assert_raises(Cri::Parser::OptionRequiresAnArgumentError) do
        Cri::Parser.new(input, opt_defns, [], false).run
      end
    end

    def test_parse_with_long_valueless_option_with_optional_value
      input = %w[foo --aaa]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :optional },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert(parser.options[:aaa])
      assert_equal(['foo'], parser.gen_argument_list.to_a)
    end

    def test_parse_with_long_valueful_option_with_optional_value
      input = %w[foo --aaa xxx]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :optional },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({ aaa: 'xxx' }, parser.options)
      assert_equal(['foo'], parser.gen_argument_list.to_a)
    end

    def test_parse_with_long_valueless_option_with_optional_value_and_more_options
      input = %w[foo --aaa -b -c]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :optional  },
        { long: 'bbb', short: 'b', argument: :forbidden },
        { long: 'ccc', short: 'c', argument: :forbidden },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert(parser.options[:aaa])
      assert(parser.options[:bbb])
      assert(parser.options[:ccc])
      assert_equal(['foo'], parser.gen_argument_list.to_a)
    end

    def test_parse_with_short_valueless_options
      input = %w[foo -a bar]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :forbidden },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert(parser.options[:aaa])
      assert_equal(%w[foo bar], parser.gen_argument_list.to_a)
    end

    def test_parse_with_short_valueful_option_with_missing_value
      input = %w[foo -a]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :required },
      ].map { |hash| make_opt_defn(hash) }

      assert_raises(Cri::Parser::OptionRequiresAnArgumentError) do
        Cri::Parser.new(input, opt_defns, [], false).run
      end
    end

    def test_parse_with_short_combined_valueless_options
      input = %w[foo -abc bar]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :forbidden },
        { long: 'bbb', short: 'b', argument: :forbidden },
        { long: 'ccc', short: 'c', argument: :forbidden },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert(parser.options[:aaa])
      assert(parser.options[:bbb])
      assert(parser.options[:ccc])
      assert_equal(%w[foo bar], parser.gen_argument_list.to_a)
    end

    def test_parse_with_short_combined_valueful_options_with_missing_value
      input = %w[foo -abc bar qux]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :required  },
        { long: 'bbb', short: 'b', argument: :forbidden },
        { long: 'ccc', short: 'c', argument: :forbidden },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal('bar', parser.options[:aaa])
      assert(parser.options[:bbb])
      assert(parser.options[:ccc])
      assert_equal(%w[foo qux], parser.gen_argument_list.to_a)
    end

    def test_parse_with_two_short_valueful_options
      input = %w[foo -a -p 2]
      opt_defns = [
        { long: 'all',  short: 'a', argument: :required },
        { long: 'port', short: 'p', argument: :required },
      ].map { |hash| make_opt_defn(hash) }

      assert_raises(Cri::Parser::OptionRequiresAnArgumentError) do
        Cri::Parser.new(input, opt_defns, [], false).run
      end
    end

    def test_parse_with_short_valueless_option_with_optional_value
      input = %w[foo -a]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :optional },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert(parser.options[:aaa])
      assert_equal(['foo'], parser.gen_argument_list.to_a)
    end

    def test_parse_with_short_valueful_option_with_optional_value
      input = %w[foo -a xxx]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :optional },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({ aaa: 'xxx' }, parser.options)
      assert_equal(['foo'], parser.gen_argument_list.to_a)
    end

    def test_parse_with_short_valueless_option_with_optional_value_and_more_options
      input = %w[foo -a -b -c]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :optional  },
        { long: 'bbb', short: 'b', argument: :forbidden },
        { long: 'ccc', short: 'c', argument: :forbidden },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert(parser.options[:aaa])
      assert(parser.options[:bbb])
      assert(parser.options[:ccc])
      assert_equal(['foo'], parser.gen_argument_list.to_a)
    end

    def test_parse_with_single_hyphen
      input = %w[foo - bar]
      opt_defns = []

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({}, parser.options)
      assert_equal(['foo', '-', 'bar'], parser.gen_argument_list.to_a)
    end

    def test_parse_with_end_marker
      input = %w[foo bar -- -x --yyy -abc]
      opt_defns = []

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({}, parser.options)
      assert_equal(['foo', 'bar', '-x', '--yyy', '-abc'], parser.gen_argument_list.to_a)
    end

    def test_parse_with_end_marker_between_option_key_and_value
      input = %w[foo --aaa -- zzz]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :required },
      ].map { |hash| make_opt_defn(hash) }

      assert_raises(Cri::Parser::OptionRequiresAnArgumentError) do
        Cri::Parser.new(input, opt_defns, [], false).run
      end
    end

    def test_parse_with_multiple_options
      input = %w[foo -o test -o test2 -v -v -v]
      opt_defns = [
        { long: 'long', short: 'o', argument: :required, multiple: true },
        { long: 'verbose', short: 'v', multiple: true },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal(%w[test test2], parser.options[:long])
      assert_equal(3, parser.options[:verbose].size)
    end

    def test_parse_with_default_required_no_value
      input = %w[foo -a]
      opt_defns = [
        { long: 'animal', short: 'a', argument: :required, default: 'donkey' },
      ].map { |hash| make_opt_defn(hash) }

      assert_raises(Cri::Parser::OptionRequiresAnArgumentError) do
        Cri::Parser.new(input, opt_defns, [], false).run
      end
    end

    def test_parse_with_default_required_value
      input = %w[foo -a giraffe]
      opt_defns = [
        { long: 'animal', short: 'a', argument: :required, default: 'donkey' },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({ animal: 'giraffe' }, parser.options)
      assert_equal(['foo'], parser.gen_argument_list.to_a)
    end

    def test_parse_with_default_optional_no_value
      input = %w[foo -a]
      opt_defns = [
        { long: 'animal', short: 'a', argument: :optional, default: 'donkey' },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({ animal: 'donkey' }, parser.options)
      assert_equal(['foo'], parser.gen_argument_list.to_a)
    end

    def test_parse_with_default_optional_value
      input = %w[foo -a giraffe]
      opt_defns = [
        { long: 'animal', short: 'a', argument: :optional, default: 'donkey' },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({ animal: 'giraffe' }, parser.options)
      assert_equal(['foo'], parser.gen_argument_list.to_a)
    end

    def test_parse_with_default_optional_value_and_arg
      input = %w[foo -a gi raffe]
      opt_defns = [
        { long: 'animal', short: 'a', argument: :optional, default: 'donkey' },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({ animal: 'gi' }, parser.options)
      assert_equal(%w[foo raffe], parser.gen_argument_list.to_a)
    end

    def test_parse_with_combined_required_options
      input = %w[foo -abc xxx yyy zzz]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :forbidden },
        { long: 'bbb', short: 'b', argument: :required },
        { long: 'ccc', short: 'c', argument: :required },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({ aaa: true, bbb: 'xxx', ccc: 'yyy' }, parser.options)
      assert_equal(%w[foo zzz], parser.gen_argument_list.to_a)
    end

    def test_parse_with_combined_optional_options
      input = %w[foo -abc xxx yyy zzz]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :forbidden },
        { long: 'bbb', short: 'b', argument: :optional },
        { long: 'ccc', short: 'c', argument: :required },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({ aaa: true, bbb: 'xxx', ccc: 'yyy' }, parser.options)
      assert_equal(%w[foo zzz], parser.gen_argument_list.to_a)
    end

    def test_parse_with_combined_optional_options_with_missing_value
      input = %w[foo -abc xxx]
      opt_defns = [
        { long: 'aaa', short: 'a', argument: :forbidden },
        { long: 'bbb', short: 'b', argument: :required },
        { long: 'ccc', short: 'c', argument: :optional, default: 'c default' },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({ aaa: true, bbb: 'xxx', ccc: 'c default' }, parser.options)
      assert_equal(%w[foo], parser.gen_argument_list.to_a)
    end

    def test_parse_with_transform_proc
      input = %w[--port 123]
      opt_defns = [
        { long: 'port', short: 'p', argument: :required, transform: ->(x) { Integer(x) } },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({ port: 123 }, parser.options)
      assert_equal([], parser.gen_argument_list.to_a)
    end

    def test_parse_with_transform_method
      input = %w[--port 123]
      opt_defns = [
        { long: 'port', short: 'p', argument: :required, transform: method(:Integer) },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({ port: 123 }, parser.options)
      assert_equal([], parser.gen_argument_list.to_a)
    end

    def test_parse_with_transform_object
      port = Class.new do
        def call(str)
          Integer(str)
        end
      end.new

      input = %w[--port 123]
      opt_defns = [
        { long: 'port', short: 'p', argument: :required, transform: port },
      ].map { |hash| make_opt_defn(hash) }

      parser = Cri::Parser.new(input, opt_defns, [], false).run

      assert_equal({ port: 123 }, parser.options)
      assert_equal([], parser.gen_argument_list.to_a)
    end

    def test_parse_with_transform_exception
      input = %w[--port one_hundred_and_twenty_three]
      opt_defns = [
        { long: 'port', short: 'p', argument: :required, transform: method(:Integer) },
      ].map { |hash| make_opt_defn(hash) }

      exception = assert_raises(Cri::Parser::IllegalOptionValueError) do
        Cri::Parser.new(input, opt_defns, [], false).run
      end
      assert_equal('invalid value "one_hundred_and_twenty_three" for --port option', exception.message)
    end

    def test_parse_with_param_defns
      input       = %w[localhost]
      param_defns = [
        { name: 'host', transform: nil },
      ].map { |hash| Cri::ParamDefinition.new(**hash) }

      parser = Cri::Parser.new(input, [], param_defns, false).run
      assert_equal({}, parser.options)
      assert_equal('localhost', parser.gen_argument_list[0])
      assert_equal('localhost', parser.gen_argument_list[:host])
    end

    def test_parse_with_param_defns_too_few_args
      input       = []
      param_defns = [
        { name: 'host', transform: nil },
      ].map { |hash| Cri::ParamDefinition.new(**hash) }

      parser = Cri::Parser.new(input, [], param_defns, false).run
      exception = assert_raises(Cri::ArgumentList::ArgumentCountMismatchError) do
        parser.gen_argument_list
      end
      assert_equal('incorrect number of arguments given: expected 1, but got 0', exception.message)
    end

    def test_parse_with_param_defns_too_many_args
      input       = %w[localhost oink]
      param_defns = [
        { name: 'host', transform: nil },
      ].map { |hash| Cri::ParamDefinition.new(**hash) }

      parser = Cri::Parser.new(input, [], param_defns, false).run
      exception = assert_raises(Cri::ArgumentList::ArgumentCountMismatchError) do
        parser.gen_argument_list
      end
      assert_equal('incorrect number of arguments given: expected 1, but got 2', exception.message)
    end

    def test_parse_with_param_defns_invalid_key
      input       = %w[localhost]
      param_defns = [
        { name: 'host', transform: nil },
      ].map { |hash| Cri::ParamDefinition.new(**hash) }

      parser = Cri::Parser.new(input, [], param_defns, false).run

      exception = assert_raises(ArgumentError) do
        parser.gen_argument_list['oink']
      end
      assert_equal('argument lists can be indexed using a Symbol or an Integer, but not a String', exception.message)
    end

    def test_parse_with_param_defns_two_params
      input       = %w[localhost example.com]
      param_defns = [
        { name: 'source', transform: nil },
        { name: 'target', transform: nil },
      ].map { |hash| Cri::ParamDefinition.new(**hash) }

      parser = Cri::Parser.new(input, [], param_defns, false).run
      assert_equal({}, parser.options)
      assert_equal('localhost', parser.gen_argument_list[0])
      assert_equal('localhost', parser.gen_argument_list[:source])
      assert_equal('example.com', parser.gen_argument_list[1])
      assert_equal('example.com', parser.gen_argument_list[:target])
    end

    def make_opt_defn(hash)
      Cri::OptionDefinition.new(
        short: hash.fetch(:short, nil),
        long: hash.fetch(:long, nil),
        desc: hash.fetch(:desc, nil),
        argument: hash.fetch(:argument, nil),
        multiple: hash.fetch(:multiple, nil),
        block: hash.fetch(:block, nil),
        hidden: hash.fetch(:hidden, nil),
        default: hash.fetch(:default, nil),
        transform: hash.fetch(:transform, nil),
      )
    end
  end
end