File: discover_tests_test.rb

package info (click to toggle)
ruby-ruby-lsp 0.26.7-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 27,676 kB
  • sloc: ruby: 35,294; javascript: 29; sh: 7; makefile: 4
file content (996 lines) | stat: -rw-r--r-- 28,943 bytes parent folder | download
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
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
# typed: true
# frozen_string_literal: true

require "test_helper"

module RubyLsp
  class DiscoverTestsTest < Minitest::Test
    def test_minitest
      source = File.read("test/fixtures/minitest_tests.rb")

      with_minitest_test(source) do |items|
        assert_equal(["Test", "AnotherTest"], items.map { |i| i[:label] })
        assert_equal(
          [
            "test_public",
            "test_public_command",
            "test_another_public",
            "test_public_vcall",
            "test_with_q?",
          ],
          items[0][:children].map { |i| i[:label] },
        )
        assert_equal(["test_public", "test_public_2"], items[1][:children].map { |i| i[:label] })
        assert_all_items_tagged_with(items, :minitest)
      end
    end

    def test_minitest_with_nested_classes_and_modules
      source = File.read("test/fixtures/minitest_nested_classes_and_modules.rb")

      with_minitest_test(source) do |items|
        assert_equal(
          [
            "Foo::FooTest",
            "Foo::Bar::BarTest",
            "Foo::Baz::BazTest",
            "Foo::Bar::FooBarTest",
            "Foo::Bar::FooBar::Test",
          ],
          items.map { |i| i[:label] },
        )

        assert_equal(["test_foo", "test_foo_2"], items[0][:children].map { |i| i[:label] })
        assert_equal(["test_bar", "Foo::Bar::BarTest::Baz::BazTest"], items[1][:children].map { |i| i[:label] })
        assert_equal(["test_baz", "test_baz_2"], items[1][:children][1][:children].map { |i| i[:label] })
        assert_equal(["test_baz"], items[2][:children].map { |i| i[:label] })
        assert_equal(["test_foo_bar", "test_foo_bar_2"], items[3][:children].map { |i| i[:label] })
        assert_equal(["test_foo_bar_baz"], items[4][:children].map { |i| i[:label] })
        assert_all_items_tagged_with(items, :minitest)
      end
    end

    def test_complex_nested_example
      source = <<~RUBY
        module First
          class MyTest < Minitest::Test
            def test_something; end

            class Random
              class NestedTest < Minitest::Test
                def test_something_else; end
              end
            end
          end
        end
      RUBY

      with_minitest_test(source) do |items|
        assert_equal(["First::MyTest"], items.map { |i| i[:id] })
        assert_equal(
          [
            "First::MyTest#test_something",
            "First::MyTest::Random::NestedTest",
          ],
          items[0][:children].map { |i| i[:id] },
        )
        assert_equal(
          ["First::MyTest::Random::NestedTest#test_something_else"],
          items[0][:children][1][:children].map { |i| i[:id] },
        )
        assert_all_items_tagged_with(items, :minitest)
      end
    end

    def test_minitest_with_dynamic_constant_path
      source = File.read("test/fixtures/minitest_with_dynamic_constant_path.rb")

      with_minitest_test(source) do |items|
        assert_equal(
          [
            "<dynamic_reference>::Baz::Test",
            "<dynamic_reference>::Baz::SomeOtherTest",
          ],
          items.map { |i| i[:label] },
        )

        assert_equal(
          ["test_something", "test_something_else", "<dynamic_reference>::Baz::Test::NestedTest"],
          items[0][:children].map { |i| i[:label] },
        )
        assert_equal(
          ["test_nested"],
          items[0][:children][2][:children].map { |i| i[:label] },
        )
        assert_equal(["test_stuff", "test_other_stuff"], items[1][:children].map { |i| i[:label] })
        assert_all_items_tagged_with(items, :minitest)
      end
    end

    def test_test_unit_cases
      source = <<~RUBY
        module Foo
          class MyTest < Test::Unit::TestCase
            def test_something; end

            private

            def test_should_not_be_included; end

            class NestedTest < Test::Unit::TestCase
              def test_hello; end
            end
          end
        end
      RUBY

      with_test_unit(source) do |items|
        assert_equal(["Foo::MyTest"], items.map { |i| i[:label] })
        assert_equal(["test_something", "Foo::MyTest::NestedTest"], items[0][:children].map { |i| i[:label] })
        assert_equal(["test_hello"], items[0][:children][1][:children].map { |i| i[:label] })
        assert_all_items_tagged_with(items, :test_unit)
      end
    end

    def test_collects_code_lenses
      source = <<~RUBY
        module Foo
          class MyTest < Test::Unit::TestCase
            def test_something; end

            def test_something_else; end
          end
        end
      RUBY

      with_server(source, URI::Generic.from_path(path: "/test/foo_test.rb")) do |server, uri|
        server.global_state.index.index_single(URI("/other_file.rb"), <<~RUBY)
          module Test
            module Unit
              class TestCase; end
            end
          end
        RUBY

        server.global_state.stubs(:enabled_feature?).returns(true)

        server.process_message(id: 1, method: "textDocument/codeLens", params: {
          textDocument: { uri: uri },
        })

        # Discard the indexing log message
        server.pop_response
        items = get_response(server)
        assert_equal(9, items.length)

        # MyTest
        assert_equal("run_test", items[0].data[:kind])
        assert_equal(
          { start: { line: 1, character: 2 }, end: { line: 1, character: 3 } },
          JSON.parse(items[0].range.to_json, symbolize_names: true),
        )
        assert_equal("run_test_in_terminal", items[1].data[:kind])
        assert_equal(
          { start: { line: 1, character: 2 }, end: { line: 1, character: 3 } },
          JSON.parse(items[1].range.to_json, symbolize_names: true),
        )
        assert_equal("debug_test", items[2].data[:kind])
        assert_equal(
          { start: { line: 1, character: 2 }, end: { line: 1, character: 3 } },
          JSON.parse(items[2].range.to_json, symbolize_names: true),
        )

        # test_something
        assert_equal("run_test", items[3].data[:kind])
        assert_equal(
          { start: { line: 2, character: 4 }, end: { line: 2, character: 5 } },
          JSON.parse(items[3].range.to_json, symbolize_names: true),
        )
        assert_equal("run_test_in_terminal", items[4].data[:kind])
        assert_equal(
          { start: { line: 2, character: 4 }, end: { line: 2, character: 5 } },
          JSON.parse(items[4].range.to_json, symbolize_names: true),
        )
        assert_equal("debug_test", items[5].data[:kind])
        assert_equal(
          { start: { line: 2, character: 4 }, end: { line: 2, character: 5 } },
          JSON.parse(items[5].range.to_json, symbolize_names: true),
        )

        # test_something_else
        assert_equal("run_test", items[6].data[:kind])
        assert_equal(
          { start: { line: 4, character: 4 }, end: { line: 4, character: 5 } },
          JSON.parse(items[6].range.to_json, symbolize_names: true),
        )
        assert_equal("run_test_in_terminal", items[7].data[:kind])
        assert_equal(
          { start: { line: 4, character: 4 }, end: { line: 4, character: 5 } },
          JSON.parse(items[7].range.to_json, symbolize_names: true),
        )
        assert_equal("debug_test", items[8].data[:kind])
        assert_equal(
          { start: { line: 4, character: 4 }, end: { line: 4, character: 5 } },
          JSON.parse(items[8].range.to_json, symbolize_names: true),
        )
      end
    end

    def test_does_not_collect_code_lenses_when_disabled
      source = <<~RUBY
        module Foo
          class MyTest < Test::Unit::TestCase
            def test_something; end

            def test_something_else; end
          end
        end
      RUBY

      with_server(source, URI::Generic.from_path(path: "/test/foo_test.rb")) do |server, uri|
        server.global_state.index.index_single(URI("/other_file.rb"), <<~RUBY)
          module Test
            module Unit
              class TestCase; end
            end
          end
        RUBY

        state = server.global_state
        state.stubs(:enabled_feature?).returns(true)
        state.apply_options({
          initializationOptions: {
            featuresConfiguration: {
              codeLens: {
                enableTestCodeLens: false,
              },
            },
          },
        })

        server.process_message(id: 1, method: "textDocument/codeLens", params: {
          textDocument: { uri: uri },
        })

        # Discard the indexing log message
        server.pop_response
        items = get_response(server)
        assert_empty(items)
      end
    end

    def test_does_not_collect_code_lenses_for_files_not_matching_path_convention
      source = <<~RUBY
        module Foo
          class MyTest < Test::Unit::TestCase
            def test_something; end

            def test_something_else; end
          end
        end
      RUBY

      with_server(source, URI::Generic.from_path(path: "/tests/something.rb")) do |server, uri|
        server.global_state.index.index_single(URI("/other_file.rb"), <<~RUBY)
          module Test
            module Unit
              class TestCase; end
            end
          end
        RUBY

        server.global_state.stubs(:enabled_feature?).returns(true)

        server.process_message(id: 1, method: "textDocument/codeLens", params: {
          textDocument: { uri: uri },
        })

        # Discard the indexing log message
        server.pop_response
        items = get_response(server)
        assert_empty(items)
      end
    end

    def test_ignores_minitest_tests_that_extend_active_support_declarative
      source = <<~RUBY
        class MyTest < ActiveSupport::TestCase
          def test_something; end
        end
      RUBY

      with_active_support_declarative_tests(source) do |items|
        assert_empty(items)
      end
    end

    def test_dynamic_constant_in_minitest_tests
      source = <<~RUBY
        module var::Namespace
          class MyTest < Minitest::Test
            def test_something; end
            def do_something; end
          end
        end

        module Foo
          class var::OtherTest < Minitest::Test
            def test_something; end
          end
        end
      RUBY

      with_minitest_test(source) do |items|
        assert_equal(
          ["<dynamic_reference>::Namespace::MyTest", "Foo::<dynamic_reference>::OtherTest"],
          items.map { |i| i[:label] },
        )
        assert_equal(["test_something"], items[0][:children].map { |i| i[:label] })
        assert_equal(["test_something"], items[1][:children].map { |i| i[:label] })
        assert_all_items_tagged_with(items, :minitest)
      end
    end

    def test_dynamic_constant_in_test_unit_tests
      source = <<~RUBY
        module var::Namespace
          class MyTest < Test::Unit::TestCase
            def test_something; end

            def do_something; end
          end
        end

        module Foo
          class var::OtherTest < Test::Unit::TestCase
            def test_something; end
          end
        end
      RUBY

      with_minitest_test(source) do |items|
        assert_equal(
          ["<dynamic_reference>::Namespace::MyTest", "Foo::<dynamic_reference>::OtherTest"],
          items.map { |i| i[:label] },
        )
        assert_equal(["test_something"], items[0][:children].map { |i| i[:label] })
        assert_equal(["test_something"], items[1][:children].map { |i| i[:label] })
        assert_all_items_tagged_with(items, :test_unit)
      end
    end

    def test_files_are_indexed_lazily_if_needed
      path = File.join(Dir.pwd, "lib", "foo.rb")
      File.write(path, <<~RUBY)
        class FooTest < Test::Unit::TestCase
          def test_something; end
        end
      RUBY

      begin
        with_server do |server, uri|
          server.global_state.index.index_single(uri, <<~RUBY)
            module Test
              module Unit
                class TestCase; end
              end
            end
          RUBY

          server.process_message(
            id: 1,
            method: "rubyLsp/discoverTests",
            params: { textDocument: { uri: URI::Generic.from_path(path: path) } },
          )

          items = get_response(server)
          assert_equal(
            ["FooTest"],
            items.map { |i| i[:label] },
          )
          assert_equal(["test_something"], items[0][:children].map { |i| i[:label] })
          assert_all_items_tagged_with(items, :test_unit)
        end
      ensure
        FileUtils.rm(path)
      end
    end

    def test_does_not_raise_on_duplicate_test_ids
      source = <<~RUBY
        module Foo
          class MyTest < Test::Unit::TestCase
            def test_something; end

            # This one gets picked
            def test_something; end
          end
        end
      RUBY

      with_test_unit(source) do |items|
        assert_equal(["Foo::MyTest"], items.map { |i| i[:label] })

        children = items[0][:children]
        assert_equal(1, children.length)

        test_something = children[0]
        assert_equal(5, test_something[:range].start.line)
        assert_all_items_tagged_with(items, :test_unit)
      end
    end

    def test_discovers_top_level_specs
      source = File.read("test/fixtures/minitest_spec_simple.rb")

      with_minitest_spec_configured(source) do |items|
        assert_equal(["BogusSpec"], items.map { |i| i[:label] })
        assert_all_items_tagged_with(items, :minitest)
      end
    end

    def test_anonymous_examples
      source = <<~RUBY
        class BogusSpec < Minitest::Spec
          it do
            assert true
          end
        end
      RUBY

      with_minitest_spec_configured(source) do |items|
        examples = items[0][:children]
        assert_equal(
          ["BogusSpec#test_0001_anonymous"],
          examples.map { |i| i[:id] },
        )
      end
    end

    def test_discovers_nested_specs
      source = File.read("test/fixtures/minitest_spec_nested.rb")

      with_minitest_spec_configured(source) do |items|
        top_level_specs = items[0][:children]
        assert_equal(
          ["BogusSpec::First Spec"],
          top_level_specs.map { |i| i[:id] },
        )

        nested_specs = top_level_specs[0][:children]
        assert_equal(
          [
            "BogusSpec::First Spec#test_0004_test one",
            "BogusSpec::First Spec#test_0008_test two",
            "BogusSpec::First Spec#test_0012_test three",
          ],
          nested_specs.map { |i| i[:id] },
        )
        assert_all_items_tagged_with(items, :minitest)
      end
    end

    def test_discovers_specs_without_class
      source = File.read("test/fixtures/minitest_spec_tests.rb")

      with_minitest_spec_configured(source) do |items|
        top_level_specs = items
        assert_equal(
          ["Foo", "Foo::Bar", "Baz"],
          top_level_specs.map { |i| i[:id] },
        )

        nested_specs = top_level_specs[0][:children]
        assert_equal(
          ["Foo#test_0001_it_level_one", "Foo::nested", "Foo#test_0013_it_level_one_again"],
          nested_specs.map { |i| i[:id] },
        )
        assert_all_items_tagged_with(items, :minitest)
      end
    end

    def test_discovers_dynamic_spec_names
      source = File.read("test/fixtures/minitest_spec_dynamic_name.rb")

      with_minitest_spec_configured(source) do |items|
        nested_specs = items[0][:children][0][:children]
        assert_equal(
          ["BogusSpec::First Spec#test_0004_dynamic_name"],
          nested_specs.map { |i| i[:id] },
        )
        assert_all_items_tagged_with(items, :minitest)
      end
    end

    def test_handles_empty_specs
      source = File.read("test/fixtures/minitest_spec_simple.rb")

      with_minitest_spec_configured(source) do |items|
        nested_specs = items[0][:children][0][:children]
        assert_empty(nested_specs)
        assert_all_items_tagged_with(items, :minitest)
      end
    end

    def test_handles_mixed_testing_styles_in_single_file
      source = <<~RUBY
        class FooSpec < Minitest::Spec
          it "does something" do
          end

          def test_also_valid; end
        end
      RUBY

      with_minitest_spec_configured(source) do |items|
        assert_equal(["FooSpec"], items.map { |i| i[:id] })
        assert_equal(
          [
            "FooSpec#test_0001_does something",
            "FooSpec#test_also_valid",
          ],
          items[0][:children].map { |i| i[:id] },
        )
        assert_all_items_tagged_with(items, :minitest)
      end
    end

    def test_handles_specs_with_classes_inside
      source = <<~RUBY
        class FooSpec < Minitest::Spec
          class Bar; end

          it "does something" do
          end
        end

        describe "BazSpec" do
          it "does something" do
          end
        end
      RUBY

      with_minitest_spec_configured(source) do |items|
        assert_equal(["FooSpec", "BazSpec"], items.map { |i| i[:id] })
        assert_equal(
          ["FooSpec#test_0003_does something"],
          items[0][:children].map { |i| i[:id] },
        )
        assert_equal(
          ["BazSpec#test_0008_does something"],
          items[1][:children].map { |i| i[:id] },
        )
        assert_all_items_tagged_with(items, :minitest)
      end
    end

    def test_complex_spec_case
      source = <<~RUBY
        module First
          module Second
            module Third
              class MySpec < Minitest::Spec
                describe "when something is true" do
                  describe "and other thing is false" do
                    it "does what's expected" do
                      assert(true)
                    end
                  end

                  class NestedSpec < Minitest::Spec
                    it "does something else" do
                      assert(true)
                    end
                  end
                end
              end
            end
          end
        end
      RUBY

      with_minitest_spec_configured(source) do |items|
        top_class = "First::Second::Third::MySpec"
        assert_equal([top_class], items.map { |i| i[:id] })
        assert_equal(
          [
            "#{top_class}::when something is true",
            "#{top_class}::NestedSpec",
          ],
          items[0][:children].map { |i| i[:id] },
        )
        assert_equal(
          [
            "#{top_class}::when something is true::and other thing is false",
          ],
          items[0][:children][0][:children].map { |i| i[:id] },
        )
        assert_equal(
          [
            "#{top_class}::NestedSpec#test_0012_does something else",
          ],
          items[0][:children][1][:children].map { |i| i[:id] },
        )
        assert_equal(
          [
            "#{top_class}::when something is true::and other thing is false#test_0006_does what's expected",
          ],
          items[0][:children][0][:children][0][:children].map { |i| i[:id] },
        )

        assert_all_items_tagged_with(items, :minitest)
      end
    end

    def test_discover_tests_addons
      source = <<~RUBY
        class MyTest
          test "should do something" do
          end

          test "should do something else" do
          end
        end
      RUBY

      begin
        create_test_discovery_addon

        with_server(source) do |server, uri|
          server.process_message({
            id: 1,
            method: "rubyLsp/discoverTests",
            params: { textDocument: { uri: uri } },
          })

          response = pop_result(server)

          assert_instance_of(RubyLsp::Result, response)
          items = response.response

          test_classes = items.map { |i| i[:label] }
          assert_equal(["MyTest"], test_classes)

          test_methods = items[0][:children].map { |i| i[:label] }
          assert_equal(["should do something", "should do something else"], test_methods)
        end
      ensure
        RubyLsp::Addon.addon_classes.clear
      end
    end

    def test_ignores_methods_that_look_like_tests_in_other_namespaces
      source = <<~RUBY
        class MyTest < Minitest::Test
          def test_something; end

          module Foo
            def test_something_else; end
          end

          class Bar
            def test_other_thing; end
          end
        end
      RUBY

      with_minitest_test(source) do |items|
        assert_equal(["MyTest"], items.map { |i| i[:id] })
        assert_equal(
          ["MyTest#test_something"],
          items.dig(0, :children).map { |i| i[:id] },
        )
      end
    end

    def test_spec_ignores_methods_that_look_like_tests_in_other_namespaces
      source = <<~RUBY
        class MySpec < Minitest::Spec
          it "should do something" do
          end

          module Foo
            def test_something_else; end

            it "should do something else" do
            end
          end

          class Bar
            def test_other_thing; end

            it "another ignored call" do
            end
          end
        end
      RUBY

      with_minitest_spec_configured(source) do |items|
        assert_equal(["MySpec"], items.map { |i| i[:id] })
        assert_equal(
          ["MySpec#test_0001_should do something"],
          items.dig(0, :children).map { |i| i[:id] },
        )
      end
    end

    def test_spec_using_describe_ignores_methods_that_look_like_tests_in_other_namespaces
      source = <<~RUBY
        describe "MySpec" do
          it "should do something" do
          end

          module Foo
            def test_something_else; end

            it "should do something else" do
            end
          end

          class Bar
            def test_other_thing; end

            it "another ignored call" do
            end
          end
        end
      RUBY

      with_minitest_spec_configured(source) do |items|
        assert_equal(["MySpec"], items.map { |i| i[:id] })
        assert_equal(
          ["MySpec#test_0001_should do something"],
          items.dig(0, :children).map { |i| i[:id] },
        )
      end
    end

    def test_spec_using_describe_with_additional_descriptions
      source = <<~RUBY
        describe(Foo, :extra_1, :extra_2) do
          describe("#some_method") do
            it("does something") do
              assert(true)
            end
          end
        end
      RUBY

      with_minitest_spec_configured(source) do |items|
        assert_equal(["Foo::extra_1::extra_2"], items.map { |i| i[:id] })
        assert_equal(
          ["Foo::extra_1::extra_2::#some_method"],
          items.dig(0, :children).map { |i| i[:id] },
        )
        assert_equal(
          ["Foo::extra_1::extra_2::#some_method#test_0002_does something"],
          items.dig(0, :children).dig(0, :children).map { |i| i[:id] },
        )
      end
    end

    def test_can_discover_tests_even_if_parent_class_was_not_indexed
      source = <<~RUBY
        class MyTest < Minitest::Test
          def test_something; end
        end
      RUBY

      with_server(source) do |server, uri|
        server.process_message(id: 1, method: "rubyLsp/discoverTests", params: {
          textDocument: { uri: uri },
        })

        items = get_response(server)

        assert_equal(
          ["MyTest"],
          items.map { |i| i[:id] },
        )
        assert_equal(["MyTest#test_something"], items[0][:children].map { |i| i[:id] })
        assert_all_items_tagged_with(items, :minitest)
      end
    end

    def test_specs_defined_inside_modules
      source = <<~RUBY
        module MyNamespace
          describe "this thing" do
            it "does something" do
            end
          end

          module OtherNamespace
            describe "other test" do
              it "does something else" do
              end
            end
          end
        end
      RUBY

      with_minitest_spec_configured(source) do |items|
        assert_equal(["this thing", "other test"], items.map { |i| i[:id] })
        assert_equal(
          ["this thing#test_0002_does something"],
          items.dig(0, :children).map { |i| i[:id] },
        )
        assert_equal(
          ["other test#test_0008_does something else"],
          items.dig(1, :children).map { |i| i[:id] },
        )
      end
    end

    private

    def create_test_discovery_addon
      Class.new(RubyLsp::Addon) do
        def create_discover_tests_listener(response_builder, dispatcher, uri)
          klass = Class.new do
            include RubyLsp::Requests::Support::Common

            def initialize(response_builder, dispatcher, uri)
              @response_builder = response_builder
              @uri = uri
              @current_class = nil
              dispatcher.register(self, :on_call_node_enter, :on_class_node_enter)
            end

            def on_class_node_enter(node)
              range = self #: as untyped # rubocop:disable Style/RedundantSelf
                .range_from_node(node)
              class_name = node.constant_path.slice

              if class_name == "MyTest"
                @current_class = RubyLsp::Requests::Support::TestItem.new(
                  class_name,
                  class_name,
                  @uri,
                  range,
                  framework: :custom_addon,
                )

                @response_builder.add(@current_class)
              end
            end

            def on_call_node_enter(node)
              range = self #: as untyped # rubocop:disable Style/RedundantSelf
                .range_from_node(node)
              arguments = node.arguments&.arguments
              first_arg = arguments&.first
              return unless first_arg.is_a?(Prism::StringNode)

              test_name = first_arg.content

              @current_class.add(RubyLsp::Requests::Support::TestItem.new(
                "#{@current_class.id}##{test_name}",
                test_name,
                @uri,
                range,
                framework: :custom_addon,
              ))
            end
          end

          klass.new(response_builder, dispatcher, uri)
        end

        def activate; end

        def deactivate; end

        def name; end

        def version
          "0.1.0"
        end
      end
    end

    def assert_all_items_tagged_with(items, tag)
      items.each do |item|
        assert_includes(item[:tags], "framework:#{tag}")
        children = item[:children]
        assert_all_items_tagged_with(children, tag) unless children.empty?
      end
    end

    def with_minitest_test(source, &block)
      with_server(source) do |server, uri|
        server.global_state.index.index_single(uri, <<~RUBY)
          module Minitest
            class Test; end
          end
        RUBY

        server.process_message(id: 1, method: "rubyLsp/discoverTests", params: {
          textDocument: { uri: uri },
        })

        items = get_response(server)

        yield items
      end
    end

    def with_test_unit(source, &block)
      with_server(source) do |server, uri|
        server.global_state.index.index_single(uri, <<~RUBY)
          module Test
            module Unit
              class TestCase; end
            end
          end
        RUBY

        server.process_message(id: 1, method: "rubyLsp/discoverTests", params: {
          textDocument: { uri: uri },
        })

        items = get_response(server)

        yield items
      end
    end

    def with_active_support_declarative_tests(source, &block)
      with_server(source) do |server, uri|
        server.global_state.index.index_single(uri, <<~RUBY)
          module Minitest
            class Test; end
          end

          module ActiveSupport
            module Testing
              module Declarative
              end
            end

            class TestCase < Minitest::Test
              extend Testing::Declarative
            end
          end
        RUBY

        server.process_message(id: 1, method: "rubyLsp/discoverTests", params: {
          textDocument: { uri: uri },
        })

        items = get_response(server)

        yield items
      end
    end

    def with_minitest_spec_configured(source, &block)
      with_server(source) do |server, uri|
        server.global_state.index.index_single(uri, <<~RUBY)
          module Minitest
            class Test; end
            class Spec < Test; end
          end
        RUBY

        server.process_message(id: 1, method: "rubyLsp/discoverTests", params: {
          textDocument: { uri: uri },
        })

        items = get_response(server)

        yield items
      end
    end

    def get_response(server)
      result = server.pop_response

      if result.is_a?(Error)
        flunk(result.message)
      end

      result.response
    end
  end
end