aboutsummaryrefslogtreecommitdiffstats
path: root/test/yarp/yarp_test_helper.rb
blob: 0be0f51651f03b620e2a045e628dc5e8e6c8bfac (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
# frozen_string_literal: true

require "yarp"
require "ripper"
require "pp"
require "test/unit"
require "tempfile"

puts "Using YARP backend: #{YARP::BACKEND}" if ENV["YARP_FFI_BACKEND"]

module YARP
  module Assertions
    private

    def assert_equal_nodes(expected, actual, compare_location: true, parent: nil)
      assert_equal expected.class, actual.class

      case expected
      when Array
        assert_equal(
          expected.size,
          actual.size,
          -> { "Arrays were different sizes. Parent: #{parent.pretty_inspect}" }
        )

        expected.zip(actual).each do |(expected_element, actual_element)|
          assert_equal_nodes(
            expected_element,
            actual_element,
            compare_location: compare_location,
            parent: actual
          )
        end
      when YARP::SourceFileNode
        deconstructed_expected = expected.deconstruct_keys(nil)
        deconstructed_actual = actual.deconstruct_keys(nil)
        assert_equal deconstructed_expected.keys, deconstructed_actual.keys

        # Filepaths can be different if test suites were run
        # on different machines.
        # We accommodate for this by comparing the basenames,
        # and not the absolute filepaths
        assert_equal deconstructed_expected.except(:filepath), deconstructed_actual.except(:filepath)
        assert_equal File.basename(deconstructed_expected[:filepath]), File.basename(deconstructed_actual[:filepath])
      when YARP::Node
        deconstructed_expected = expected.deconstruct_keys(nil)
        deconstructed_actual = actual.deconstruct_keys(nil)
        assert_equal deconstructed_expected.keys, deconstructed_actual.keys

        deconstructed_expected.each_key do |key|
          assert_equal_nodes(
            deconstructed_expected[key],
            deconstructed_actual[key],
            compare_location: compare_location,
            parent: actual
          )
        end
      when YARP::Location
        assert_operator actual.start_offset, :<=, actual.end_offset, -> {
          "start_offset > end_offset for #{actual.inspect}, parent is #{parent.pretty_inspect}"
        }
        if compare_location
          assert_equal(
            expected.start_offset,
            actual.start_offset,
            -> { "Start locations were different. Parent: #{parent.pretty_inspect}" }
          )

          assert_equal(
            expected.end_offset,
            actual.end_offset,
            -> { "End locations were different. Parent: #{parent.pretty_inspect}" }
          )

        end
      else
        assert_equal expected, actual
      end
    end

    def assert_valid_locations(value, parent: nil)
      case value
      when Array
        value.each do |element|
          assert_valid_locations(element, parent: value)
        end
      when YARP::Node
        value.deconstruct_keys(nil).each_value do |field|
          assert_valid_locations(field, parent: value)
        end
      when YARP::Location
        assert_operator value.start_offset, :<=, value.end_offset, -> {
          "start_offset > end_offset for #{value.inspect}, parent is #{parent.pretty_inspect}"
        }
      end
    end
  end
end

Test::Unit::TestCase.include(YARP::Assertions)