logstash-filter-xml 4.0.4 → 4.1.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 48d192d6eb1b89b10086ab925c20d7dc2021f69a
4
- data.tar.gz: 7a2d056ced5e862af70d0ca5d82089555429fd07
2
+ SHA256:
3
+ metadata.gz: 6219dbfef9c7bd16f8407575325b90a2348c8003a3b1b131e9ef659fdf559cf8
4
+ data.tar.gz: d24834789afc1f58c9f12c4e37f7c792308ec8bf781ac8bf30f5abfb85f97e91
5
5
  SHA512:
6
- metadata.gz: 0ab449cbd32f539a78313df6a40d70a2cab59ca841a495eae3eec6315752659e949ccc4918a9fe3696ed12635cf4023e2c4e018c093553ca8d0ab91206a34641
7
- data.tar.gz: 56ff743a7b0f44f1d17ec2b7479eed2173f585b6e868f1919b8baf73c4609e0446941fbc8908b76df22ca30f3218175618742aead24e70d451b2dff31de30f18
6
+ metadata.gz: f91a615ab60c1910cab4752ef8f2dc37a1dfa7f3fb364f837c39bd271d5131541d608cbfe9cdf2d32a8369efa2dc6bfc76a1720dc5426cee3b42bc2d3c09fa34
7
+ data.tar.gz: 50372739d44fffeef3df70ce87eb973b40cc0b903c658b067aea48adc61b5937345b73cf21c4f241c17ae5cc7d901b455fcb053ee65f2eb242cfdaca24cad4e1
@@ -1,3 +1,18 @@
1
+ ## 4.1.1
2
+ - Fix: exceptions thrown while handling events no longer crash the pipeline [#73](https://github.com/logstash-plugins/logstash-filter-xml/pull/73)
3
+
4
+ ## 4.1.0
5
+ - Feat: added parser_options for more control over XML parsing [#68](https://github.com/logstash-plugins/logstash-filter-xml/pull/68)
6
+
7
+ ## 4.0.7
8
+ - Fixed creation of empty arrays when xpath failed [#59](https://github.com/logstash-plugins/logstash-filter-xml/pull/59)
9
+
10
+ ## 4.0.6
11
+ - Fixed force_array behavior with nested elements [#57](https://github.com/logstash-plugins/logstash-filter-xml/pull/57)
12
+
13
+ ## 4.0.5
14
+ - Update gemspec summary
15
+
1
16
  ## 4.0.4
2
17
  - Fix some documentation issues
3
18
 
data/LICENSE CHANGED
@@ -1,13 +1,202 @@
1
- Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
2
1
 
3
- Licensed under the Apache License, Version 2.0 (the "License");
4
- you may not use this file except in compliance with the License.
5
- You may obtain a copy of the License at
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
6
5
 
7
- http://www.apache.org/licenses/LICENSE-2.0
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
7
 
9
- Unless required by applicable law or agreed to in writing, software
10
- distributed under the License is distributed on an "AS IS" BASIS,
11
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- See the License for the specific language governing permissions and
13
- limitations under the License.
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2020 Elastic and contributors
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -34,6 +34,7 @@ This plugin supports the following configuration options plus the <
34
34
  | <<plugins-{type}s-{plugin}-force_array>> |<<boolean,boolean>>|No
35
35
  | <<plugins-{type}s-{plugin}-force_content>> |<<boolean,boolean>>|No
36
36
  | <<plugins-{type}s-{plugin}-namespaces>> |<<hash,hash>>|No
37
+ | <<plugins-{type}s-{plugin}-parser_options>> |<<string,string>>|No
37
38
  | <<plugins-{type}s-{plugin}-remove_namespaces>> |<<boolean,boolean>>|No
38
39
  | <<plugins-{type}s-{plugin}-source>> |<<string,string>>|Yes
39
40
  | <<plugins-{type}s-{plugin}-store_xml>> |<<boolean,boolean>>|No
@@ -87,6 +88,17 @@ filter {
87
88
  }
88
89
  }
89
90
 
91
+ [id="plugins-{type}s-{plugin}-parser_options"]
92
+ ===== `parser_options`
93
+
94
+ * Value type is <<string,string>>
95
+ * There is no default value for this setting.
96
+
97
+ Setting XML parser options allows for more control of the parsing process.
98
+ By default the parser is not strict and thus accepts some invalid content.
99
+ Currently supported options are:
100
+
101
+ - `strict` - forces the parser to fail early instead of accumulating errors when content is not valid xml.
90
102
 
91
103
  [id="plugins-{type}s-{plugin}-remove_namespaces"]
92
104
  ===== `remove_namespaces`
@@ -58,6 +58,13 @@ class LogStash::Filters::Xml < LogStash::Filters::Base
58
58
  #
59
59
  config :xpath, :validate => :hash, :default => {}
60
60
 
61
+ # Supported XML parsing options are 'strict', 'no_error' and 'no_warning'.
62
+ # - strict mode turns on strict parsing rules (non-compliant xml will fail)
63
+ # - no_error and no_warning can be used to suppress errors/warnings
64
+ config :parse_options, :validate => :string
65
+ # NOTE: technically we support more but we purposefully do not document those.
66
+ # e.g. setting "strict|recover" will not turn on strict as they're conflicting
67
+
61
68
  # By default the filter will store the whole parsed XML in the destination
62
69
  # field as described above. Setting this to false will prevent that.
63
70
  config :store_xml, :validate => :boolean, :default => true
@@ -110,6 +117,7 @@ class LogStash::Filters::Xml < LogStash::Filters::Base
110
117
  :error => "When the 'store_xml' configuration option is true, 'target' must also be set"
111
118
  )
112
119
  end
120
+ xml_parse_options # validates parse_options => ...
113
121
  end
114
122
 
115
123
  def filter(event)
@@ -141,11 +149,13 @@ class LogStash::Filters::Xml < LogStash::Filters::Base
141
149
 
142
150
  if @xpath
143
151
  begin
144
- doc = Nokogiri::XML(value, nil, value.encoding.to_s)
152
+ doc = Nokogiri::XML::Document.parse(value, nil, value.encoding.to_s, xml_parse_options)
145
153
  rescue => e
146
154
  event.tag(XMLPARSEFAILURE_TAG)
147
155
  @logger.warn("Error parsing xml", :source => @source, :value => value, :exception => e, :backtrace => e.backtrace)
148
156
  return
157
+ else
158
+ doc.errors.any? && @logger.debug? && @logger.debug("Parsed xml with #{doc.errors.size} errors")
149
159
  end
150
160
  doc.remove_namespaces! if @remove_namespaces
151
161
 
@@ -156,21 +166,24 @@ class LogStash::Filters::Xml < LogStash::Filters::Base
156
166
  # String instead of a NodeSet. We normalize that here.
157
167
  normalized_nodeset = nodeset.kind_of?(Nokogiri::XML::NodeSet) ? nodeset : [nodeset]
158
168
 
169
+ # Initialize empty resultset
170
+ data = []
171
+
159
172
  normalized_nodeset.each do |value|
160
173
  # some XPath functions return empty arrays as string
161
- # TODO: (colin) the return statement here feels like a bug and should probably be a next ?
162
- return if value.is_a?(Array) && value.length == 0
174
+ next if value.is_a?(Array) && value.length == 0
163
175
 
164
176
  if value
165
177
  matched = true
166
- # TODO: (colin) this can probably be optimized to avoid the Event get/set at every loop iteration anf
167
- # the array should probably be created once, filled in the loop and set at after the loop but the return
168
- # statement above screws this strategy and is likely a bug anyway so I will not touch this until I can
169
- # deep a big deeper and verify there is a sufficient test harness to refactor this.
170
- data = event.get(xpath_dest) || []
171
178
  data << value.to_s
172
- event.set(xpath_dest, data)
173
179
  end
180
+
181
+ end
182
+ # set the destination attribute, if it's an array with a bigger size than one, leave as is. otherwise make it a string. added force_array param to provide same functionality as writing it in an xml target
183
+ if data.size == 1 && !@force_array
184
+ event.set(xpath_dest, data[0])
185
+ else
186
+ event.set(xpath_dest, data) unless data.nil? || data.empty?
174
187
  end
175
188
  end
176
189
  end
@@ -190,5 +203,35 @@ class LogStash::Filters::Xml < LogStash::Filters::Base
190
203
 
191
204
  filter_matched(event) if matched
192
205
  @logger.debug? && @logger.debug("Event after xml filter", :event => event)
206
+ rescue => e
207
+ event.tag(XMLPARSEFAILURE_TAG)
208
+
209
+ log_payload = { :exception => e.message, :source => @source }
210
+ log_payload[:value] = value unless value.nil?
211
+ log_payload[:backtrace] = e.backtrace if @logger.debug?
212
+
213
+ @logger.warn("XML Parse Error", log_payload)
193
214
  end
215
+
216
+ private
217
+
218
+ def xml_parse_options
219
+ return Nokogiri::XML::ParseOptions::DEFAULT_XML unless @parse_options # (RECOVER | NONET)
220
+ @xml_parse_options ||= begin
221
+ parse_options = @parse_options.split(/,|\|/).map do |opt|
222
+ name = opt.strip.tr('_', '').upcase
223
+ if name.empty?
224
+ nil
225
+ else
226
+ begin
227
+ Nokogiri::XML::ParseOptions.const_get(name)
228
+ rescue NameError
229
+ raise LogStash::ConfigurationError, "unsupported parse option: #{opt.inspect}"
230
+ end
231
+ end
232
+ end
233
+ parse_options.compact.inject(0, :|) # e.g. NOERROR | NOWARNING
234
+ end
235
+ end
236
+
194
237
  end
@@ -1,9 +1,9 @@
1
1
  Gem::Specification.new do |s|
2
2
 
3
3
  s.name = 'logstash-filter-xml'
4
- s.version = '4.0.4'
4
+ s.version = '4.1.1'
5
5
  s.licenses = ['Apache License (2.0)']
6
- s.summary = "Takes a field that contains XML and expands it into an actual datastructure."
6
+ s.summary = "Parses XML into fields"
7
7
  s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
8
8
  s.authors = ["Elastic"]
9
9
  s.email = 'info@elastic.co'
@@ -25,5 +25,6 @@ Gem::Specification.new do |s|
25
25
  s.add_runtime_dependency 'xml-simple'
26
26
 
27
27
  s.add_development_dependency 'logstash-devutils'
28
+ s.add_development_dependency 'insist'
28
29
  end
29
30
 
@@ -1,5 +1,6 @@
1
1
  # encoding: utf-8
2
2
  require "logstash/devutils/rspec/spec_helper"
3
+ require "insist"
3
4
  require "logstash/filters/xml"
4
5
 
5
6
  describe LogStash::Filters::Xml do
@@ -310,6 +311,26 @@ describe LogStash::Filters::Xml do
310
311
  end
311
312
  end
312
313
 
314
+ describe "parse disabling forcing with nested elements" do
315
+ config <<-CONFIG
316
+ filter {
317
+ xml {
318
+ source => "xmldata"
319
+ store_xml => "false"
320
+ force_array => "false"
321
+ xpath => [
322
+ "/element/field1/text()", "field1"
323
+ ]
324
+ }
325
+ }
326
+ CONFIG
327
+
328
+ # Single value
329
+ sample("xmldata" => '<element><field1>bbb</field1><field2>789</field2><field3>e3f<field3></element>') do
330
+ insist { subject.get("field1") } == "bbb"
331
+ end
332
+ end
333
+
313
334
  context "Using suppress_empty option" do
314
335
  describe "suppress_empty => false" do
315
336
  config <<-CONFIG
@@ -381,5 +402,124 @@ describe LogStash::Filters::Xml do
381
402
  insist { subject.get("data") } == { 'x' => { 'content' => 'text1' }, 'y' => { 'a' => '2', 'content' => 'text2' } }
382
403
  end
383
404
  end
405
+ describe "does not set empty array event on failed xpath" do
406
+ config <<-CONFIG
407
+ filter {
408
+ xml {
409
+ source => "xmldata"
410
+ target => "data"
411
+ xpath => [ "//foo/text()","xpath_field" ]
412
+ }
413
+ }
414
+ CONFIG
415
+
416
+ sample("raw" => '<foobar></foobar>') do
417
+ insist { subject.get("tags") }.nil?
418
+ insist { subject.get("xpath_field")}.nil?
419
+ end
420
+ end
421
+ end
422
+
423
+ describe "parsing invalid xml" do
424
+ subject { described_class.new(options) }
425
+ let(:options) { ({ 'source' => 'xmldata', 'store_xml' => false }) }
426
+ let(:xmldata) { "<xml> <sample attr='foo' attr=\"bar\"> <invalid> </sample> </xml>" }
427
+ let(:event) { LogStash::Event.new(data) }
428
+ let(:data) { { "xmldata" => xmldata } }
429
+
430
+ before { subject.register }
431
+ after { subject.close }
432
+
433
+ it 'does not fail (by default)' do
434
+ subject.filter(event)
435
+ expect( event.get("tags") ).to be nil
436
+ end
437
+
438
+ context 'strict option' do
439
+ let(:options) { super.merge({ 'parse_options' => 'strict' }) }
440
+
441
+ it 'does fail parsing' do
442
+ subject.filter(event)
443
+ expect( event.get("tags") ).to_not be nil
444
+ expect( event.get("tags") ).to include '_xmlparsefailure'
445
+ end
446
+ end
447
+ end
448
+
449
+
450
+ describe 'when an exception is thrown in XML#filter' do
451
+ let(:logger_stub) { double('Logger').as_null_object }
452
+ before(:each) do
453
+ allow_any_instance_of(described_class).to receive(:logger).and_return(logger_stub)
454
+ end
455
+
456
+ subject(:xml_filter_plugin) { described_class.new(options).tap(&:register) }
457
+ let(:options) { ({ 'source' => 'xmldata', 'store_xml' => true, 'target' => 'decoded' }) }
458
+ let(:xmldata) { '<xml><sample attr="foo"></sample></xml>' }
459
+ let(:event) { LogStash::Event.new(data) }
460
+ let(:data) { { "xmldata" => xmldata } }
461
+
462
+ after { xml_filter_plugin.close }
463
+
464
+ # In order to test how we handle and propagate exceptions, we inject an
465
+ # intentional failure when `filter_matched` is called, and parse an XML
466
+ # that would not otherwise fail.
467
+ before(:each) do
468
+ expect(xml_filter_plugin).to receive(:filter_matched) { |_| fail('intentional') }
469
+ end
470
+
471
+ it 'does not propagate the exception' do
472
+ expect{ xml_filter_plugin.filter(event) }.to_not raise_error
473
+ end
474
+
475
+ it 'emits the event with an error tag' do
476
+ xml_filter_plugin.filter(event)
477
+
478
+ expect(event.get("tags")).to_not be nil
479
+ expect(event.get('tags')).to include '_xmlparsefailure'
480
+ end
481
+
482
+ it 'logs a helpful message' do
483
+ xml_filter_plugin.filter(event)
484
+
485
+ expect(logger_stub).to have_received(:warn) do |message, metadata|
486
+ expect(message).to include('XML Parse Error')
487
+ expect(metadata).to include(:value)
488
+ expect(metadata).to include(:source)
489
+ end
490
+ end
491
+ end
492
+
493
+ describe "parse_options" do
494
+ subject { described_class.new(options) }
495
+ let(:options) { ({ 'source' => 'xmldata', 'store_xml' => false, 'parse_options' => parse_options }) }
496
+
497
+ context 'strict (supported option)' do
498
+ let(:parse_options) { 'strict' }
499
+
500
+ it 'registers filter' do
501
+ subject.register
502
+ expect( subject.send(:xml_parse_options) ).
503
+ to eql Nokogiri::XML::ParseOptions::STRICT
504
+ end
505
+ end
506
+
507
+ context 'valid' do
508
+ let(:parse_options) { 'no_error,NOWARNING' }
509
+
510
+ it 'registers filter' do
511
+ subject.register
512
+ expect( subject.send(:xml_parse_options) ).
513
+ to eql Nokogiri::XML::ParseOptions::NOERROR | Nokogiri::XML::ParseOptions::NOWARNING
514
+ end
515
+ end
516
+
517
+ context 'invalid' do
518
+ let(:parse_options) { 'strict,invalid0' }
519
+
520
+ it 'fails to register' do
521
+ expect { subject.register }.to raise_error(LogStash::ConfigurationError, 'unsupported parse option: "invalid0"')
522
+ end
523
+ end
384
524
  end
385
525
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: logstash-filter-xml
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.0.4
4
+ version: 4.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Elastic
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-08-15 00:00:00.000000000 Z
11
+ date: 2020-06-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  requirement: !ruby/object:Gem::Requirement
@@ -72,7 +72,23 @@ dependencies:
72
72
  - - ">="
73
73
  - !ruby/object:Gem::Version
74
74
  version: '0'
75
- description: This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program
75
+ - !ruby/object:Gem::Dependency
76
+ requirement: !ruby/object:Gem::Requirement
77
+ requirements:
78
+ - - ">="
79
+ - !ruby/object:Gem::Version
80
+ version: '0'
81
+ name: insist
82
+ prerelease: false
83
+ type: :development
84
+ version_requirements: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: '0'
89
+ description: This gem is a Logstash plugin required to be installed on top of the
90
+ Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
91
+ gem is not a stand-alone program
76
92
  email: info@elastic.co
77
93
  executables: []
78
94
  extensions: []
@@ -110,9 +126,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
110
126
  version: '0'
111
127
  requirements: []
112
128
  rubyforge_project:
113
- rubygems_version: 2.4.8
129
+ rubygems_version: 2.6.13
114
130
  signing_key:
115
131
  specification_version: 4
116
- summary: Takes a field that contains XML and expands it into an actual datastructure.
132
+ summary: Parses XML into fields
117
133
  test_files:
118
134
  - spec/filters/xml_spec.rb