aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport/test/xml_mini/xml_mini_engine_test.rb
blob: 5c4c28d9b71bb8e4acc82d26e5c437ecf760a43e (plain) (blame)
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
# frozen_string_literal: true

require "abstract_unit"
require "active_support/xml_mini"
require "active_support/core_ext/hash/conversions"

class XMLMiniEngineTest < ActiveSupport::TestCase
  def self.run_with_gem(gem_name)
    require gem_name
    yield
  rescue LoadError
    # Skip tests unless gem is available
  end

  def self.run_with_platform(platform_name)
    yield if RUBY_PLATFORM.include?(platform_name)
  end

  def self.inherited(base)
    base.include EngineTests
    super
  end

  def setup
    @default_backend = ActiveSupport::XmlMini.backend
    ActiveSupport::XmlMini.backend = engine
    super
  end

  def teardown
    ActiveSupport::XmlMini.backend = @default_backend
    super
  end

  module EngineTests
    def test_file_from_xml
      hash = Hash.from_xml(<<-eoxml)
        <blog>
          <logo type="file" name="logo.png" content_type="image/png">
          </logo>
        </blog>
      eoxml
      assert hash.key?("blog")
      assert hash["blog"].key?("logo")

      file = hash["blog"]["logo"]
      assert_equal "logo.png", file.original_filename
      assert_equal "image/png", file.content_type
    end

    def test_exception_thrown_on_expansion_attack
      assert_raise expansion_attack_error do
        Hash.from_xml(<<-eoxml)
          <?xml version="1.0" encoding="UTF-8"?>
          <!DOCTYPE member [
            <!ENTITY a "&b;&b;&b;&b;&b;&b;&b;&b;&b;&b;">
            <!ENTITY b "&c;&c;&c;&c;&c;&c;&c;&c;&c;&c;">
            <!ENTITY c "&d;&d;&d;&d;&d;&d;&d;&d;&d;&d;">
            <!ENTITY d "&e;&e;&e;&e;&e;&e;&e;&e;&e;&e;">
            <!ENTITY e "&f;&f;&f;&f;&f;&f;&f;&f;&f;&f;">
            <!ENTITY f "&g;&g;&g;&g;&g;&g;&g;&g;&g;&g;">
            <!ENTITY g "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx">
          ]>
          <member>
            &a;
          </member>
      eoxml
      end
    end

    def test_setting_backend
      assert_engine_class ActiveSupport::XmlMini.backend
    end

    def test_blank_returns_empty_hash
      assert_equal({}, ActiveSupport::XmlMini.parse(nil))
      assert_equal({}, ActiveSupport::XmlMini.parse(""))
    end

    def test_parse_from_frozen_string
      xml_string = "<root/>".freeze
      assert_equal({ "root" => {} }, ActiveSupport::XmlMini.parse(xml_string))
    end

    def test_array_type_makes_an_array
      assert_equal_rexml(<<-eoxml)
        <blog>
          <posts type="array">
            <post>a post</post>
            <post>another post</post>
          </posts>
        </blog>
      eoxml
    end

    def test_one_node_document_as_hash
      assert_equal_rexml(<<-eoxml)
        <products/>
      eoxml
    end

    def test_one_node_with_attributes_document_as_hash
      assert_equal_rexml(<<-eoxml)
        <products foo="bar"/>
      eoxml
    end

    def test_products_node_with_book_node_as_hash
      assert_equal_rexml(<<-eoxml)
        <products>
          <book name="awesome" id="12345" />
        </products>
      eoxml
    end

    def test_products_node_with_two_book_nodes_as_hash
      assert_equal_rexml(<<-eoxml)
        <products>
          <book name="awesome" id="12345" />
          <book name="america" id="67890" />
        </products>
      eoxml
    end

    def test_single_node_with_content_as_hash
      assert_equal_rexml(<<-eoxml)
        <products>
          hello world
        </products>
      eoxml
    end

    def test_children_with_children
      assert_equal_rexml(<<-eoxml)
        <root>
          <products>
            <book name="america" id="67890" />
          </products>
        </root>
      eoxml
    end

    def test_children_with_text
      assert_equal_rexml(<<-eoxml)
        <root>
          <products>
            hello everyone
          </products>
        </root>
      eoxml
    end

    def test_children_with_non_adjacent_text
      assert_equal_rexml(<<-eoxml)
        <root>
          good
          <products>
            hello everyone
          </products>
          morning
        </root>
      eoxml
    end

    def test_parse_from_io
      skip_unless_extended_engine

      assert_equal_rexml(StringIO.new(<<-eoxml))
        <root>
          good
          <products>
            hello everyone
          </products>
          morning
        </root>
      eoxml
    end

    def test_children_with_simple_cdata
      skip_unless_extended_engine

      assert_equal_rexml(<<-eoxml)
        <root>
          <products>
             <![CDATA[cdatablock]]>
          </products>
        </root>
      eoxml
    end

    def test_children_with_multiple_cdata
      skip_unless_extended_engine

      assert_equal_rexml(<<-eoxml)
        <root>
          <products>
             <![CDATA[cdatablock1]]><![CDATA[cdatablock2]]>
          </products>
        </root>
      eoxml
    end

    def test_children_with_text_and_cdata
      skip_unless_extended_engine

      assert_equal_rexml(<<-eoxml)
        <root>
          <products>
            hello <![CDATA[cdatablock]]>
            morning
          </products>
        </root>
      eoxml
    end

    def test_children_with_blank_text
      skip_unless_extended_engine

      assert_equal_rexml(<<-eoxml)
        <root>
          <products>   </products>
        </root>
      eoxml
    end

    def test_children_with_blank_text_and_attribute
      skip_unless_extended_engine

      assert_equal_rexml(<<-eoxml)
        <root>
          <products type="file">   </products>
        </root>
      eoxml
    end

    private
      def engine
        raise NotImplementedError
      end

      def assert_engine_class(actual)
        assert_equal ActiveSupport.const_get("XmlMini_#{engine}"), actual
      end

      def assert_equal_rexml(xml)
        parsed_xml = ActiveSupport::XmlMini.parse(xml)
        xml.rewind if xml.respond_to?(:rewind)
        hash = ActiveSupport::XmlMini.with_backend("REXML") { ActiveSupport::XmlMini.parse(xml) }
        assert_equal(hash, parsed_xml)
      end

      def expansion_attack_error
        raise NotImplementedError
      end

      def extended_engine?
        true
      end

      def skip_unless_extended_engine
        skip "#{engine} is not an extended engine" unless extended_engine?
      end
  end
end