logstash-mixin-validator_support 1.0.1-java → 1.1.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5e8b335df368ec737d61dcb43db27b9876979758c615b69ade06865a973e8b8
-  data.tar.gz: b8668657d6af8402ed487f959750d03d49156d22f52304b4c463a8a7e0d1214f
+  metadata.gz: d4d92360f385e48ab2bd2b76d890fb2adb0fe23d0d93bbfb3e342396f3541b69
+  data.tar.gz: ae728708dc2ec8e9ef0781633f607ef5edb3b5621ae403ea94f9d1526f129214
 SHA512:
-  metadata.gz: 48b38367a6d71c35ad0fa8d65c898e01f13ef54c8e018259c01d7b620b43398d421735b853699b813af40630f60730a1ad34fc83ba1b57ea2d277781e5a2056e
-  data.tar.gz: a6953c1504f89a087df7b9ffd890c8dc8db21cca1665eafed30c39d514c763315d77733637d0dc7a0fb710f25aec2c47da929c04e82f844588b6e9ceed8afc6d
+  metadata.gz: 7f08e80456c929b66a6451d7d84beb44a12b3b4b10894e961a834f3548e564f21b22bef80b0145f739208988503329039f9cb0a18cc2016f3cd769900b966559
+  data.tar.gz: 46fcfc6f9f888c9ab3962b540334b0e5347ac7154ef4c553e875986ce712cdf193f8c28774fe05c7f04e014b79c92258f389ac6b1960d0b36b7be9ed6e335e59

data/CHANGELOG.md

@@ -1,3 +1,8 @@
-# v1.0.0
+## 1.1.0
+  - Introduces `:required_host_optional_port` validator [#4](https://github.com/logstash-plugins/logstash-mixin-validator_support/pull/4)
 
- - Introduces plugin parameter validation adapters, including initial backport for `:field_reference` validator.
+## 1.0.2
+  - Fix: '' value behavior in `field_reference` validator [#2](https://github.com/logstash-plugins/logstash-mixin-validator_support/pull/2)
+
+## 1.0.1
+  - Introduces plugin parameter validation adapters, including initial backport for `:field_reference` validator.

data/lib/logstash/plugin_mixins/validator_support/field_reference_validation_adapter.rb

@@ -16,10 +16,11 @@ module LogStash
 
       FieldReferenceValidationAdapter = NamedValidationAdapter.new(:field_reference) do |value|
         break ValidationResult.failure("Expected exactly one field reference, got `#{value.inspect}`") unless value.kind_of?(Array) && value.size <= 1
-        break ValidationResult.success(nil) if value.empty? || value.first.nil?
 
         candidate = value.first
 
+        break ValidationResult.success(nil) if value.empty? || candidate.nil? || candidate.empty?
+
         break ValidationResult.failure("Expected a valid field reference, got `#{candidate.inspect}`") unless field_reference_pattern =~ candidate
 
         break ValidationResult.success(candidate)

data/lib/logstash/plugin_mixins/validator_support/required_host_optional_port_validation_adapter.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require 'logstash/plugin_mixins/validator_support'
+
+require 'resolv'
+
+module LogStash
+  module PluginMixins
+    module ValidatorSupport
+
+
+      # rely on Resolv's IPv4#create and IPv6#create to validate IP addresses, but first regex to avoid most exceptions
+      is_valid_ipv4 = ->(candidate) { Resolv::IPv4::Regex.match?(candidate) && Resolv::IPv4.create(candidate) rescue false}
+      is_valid_ipv6 = ->(candidate) { Resolv::IPv6::Regex.match?(candidate) && Resolv::IPv6.create(candidate) rescue false}
+
+      is_valid_hostname = ->(candidate) { (%r{\A([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}\Z}i).match?(candidate) }
+
+      # the normalized tuple from valid values
+      host_port_pair = Struct.new(:host, :port)
+
+      expectation_desc = "required-host optional-port pair"
+
+      port_range = Range.new(0,65535)
+
+      ##
+      # When included into a Logstash plugin, adds a valiador named `required_host_optional_port`, which expects
+      # exactly one string matching a required host, optionally followed by a colon and a port number, and coerces
+      # valid values into a value with `host` and `port` attributes.
+      # When specifying an IPv6 address, it MUST be enclosed in square-brackets, and the address itself (without
+      # brackets) will be made available in the coerced value's `host` attribute
+      RequiredHostOptionalPortValidationAdapter = NamedValidationAdapter.new(:required_host_optional_port) do |value|
+        break ValidationResult.failure("Expected exactly one #{expectation_desc}, got `#{value.inspect}`") unless value.kind_of?(Array) && value.size <= 1
+
+        candidate = value.first
+
+        break ValidationResult.failure("Expected a valid #{expectation_desc}, got `#{candidate.inspect}`") unless candidate.kind_of?(String) && !candidate.empty?
+
+        # optional port
+        candidate_host, candidate_port = candidate.split(%r{\:(?=\d{1,5}\z)},2)
+        port = candidate_port&.to_i
+
+        break ValidationResult.failure("Expected a port in #{port_range.inspect}, got `#{port}`") if port && !port_range.include?(port)
+
+        # bracket-wrapped ipv6
+        if candidate_host.start_with?('[') && candidate_host.end_with?(']')
+          candidate_host = candidate_host[1...-1]
+          break ValidationResult.success(host_port_pair.new(candidate_host, port)) if is_valid_ipv6[candidate_host]
+        else
+          # ipv4 or hostname
+          break ValidationResult.success(host_port_pair.new(candidate_host, port)) if is_valid_ipv4[candidate_host]
+          break ValidationResult.success(host_port_pair.new(candidate_host, port)) if is_valid_hostname[candidate_host]
+        end
+
+        break ValidationResult.failure("Expected a valid #{expectation_desc}, got `#{candidate.inspect}`")
+      end
+    end
+  end
+end

data/spec/logstash/plugin_mixins/validator_support/field_reference_validation_adapter_spec.rb

@@ -28,6 +28,16 @@ describe LogStash::PluginMixins::ValidatorSupport::FieldReferenceValidationAdapt
       end
     end
 
+    context "valid input `''`" do
+      # failed in version 1.0.x which was not compatible with LS 7.x behavior
+      it 'correctly reports the value as valid' do
+        is_valid_result, coerced_or_error = described_class.validate ['']
+
+        expect(is_valid_result).to be true
+        expect(coerced_or_error).to be nil
+      end
+    end
+
     [
       ['link[0]'],
       ['][N\\//\\L][D'],

data/spec/logstash/plugin_mixins/validator_support/required_host_optional_port_validation_adapter_spec.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+require 'logstash/plugin_mixins/validator_support/required_host_optional_port_validation_adapter'
+
+describe LogStash::PluginMixins::ValidatorSupport::RequiredHostOptionalPortValidationAdapter do
+
+  it 'is an instance of NamedValidationAdapter' do
+    expect(described_class).to be_a_kind_of LogStash::PluginMixins::ValidatorSupport::NamedValidationAdapter
+  end
+
+  context '#validate' do
+    {
+      "127.0.0.1:1234" => {:host => "127.0.0.1", :port => 1234},
+      "82.31.1.3:9800" => {:host => "82.31.1.3", :port => 9800},
+      "foo.com:1234"   => {:host => "foo.com",   :port => 1234},
+      "foo-bar-domain.com:9800" => {:host => "foo-bar-domain.com", :port => 9800},
+      "[::1]:1234" => {:host => "::1", :port => 1234},
+      "[2001:db8:3333:4444:5555:6666:7777:8888]:9800" => {:host => "2001:db8:3333:4444:5555:6666:7777:8888", :port => 9800},
+      "[2001:db8:3333::7777:8888]:9800" => {:host => "2001:db8:3333::7777:8888", :port => 9800},
+      "[::ffff:93.184.216.34]:1023" => {:host => "::ffff:93.184.216.34", :port => 1023},
+
+      "127.0.0.1" => {:host => "127.0.0.1", :port => nil},
+      "82.31.1.3" => {:host => "82.31.1.3", :port => nil},
+      "foo.com"   => {:host => "foo.com",   :port => nil},
+      "foo-bar-domain.com" => {:host => "foo-bar-domain.com", :port => nil},
+      "[::1]" => {:host => "::1", :port => nil},
+      "[2001:db8:3333:4444:5555:6666:7777:8888]" => {:host => "2001:db8:3333:4444:5555:6666:7777:8888", :port => nil},
+      "[2001:db8:3333::7777:8888]" => {:host => "2001:db8:3333::7777:8888", :port => nil},
+      "[::ffff:93.184.216.34]" => {:host => "::ffff:93.184.216.34", :port => nil},
+    }.each do |candidate, expected_result|
+      context "valid input `#{candidate.inspect}`" do
+        it "coerces the result to a host/port struct `#{expected_result}`" do
+          is_valid_result, coerced_or_error = described_class.validate([candidate])
+          failure = is_valid_result ? nil : coerced_or_error
+          coerced = is_valid_result ? coerced_or_error : nil
+
+          aggregate_failures do
+            expect(is_valid_result).to be true
+            expect(failure).to be_nil # makes spec failure output useful
+          end
+          expect(coerced).to have_attributes(expected_result.to_h)
+        end
+      end
+    end
+
+    [
+      "not an address",
+      "http://example.com:1234",
+      "tcp://example.com",
+      "http://example.com:1234/v1/this",
+      "",
+      ":1234", # port without host
+      "::1", # bare ipv6
+      "2001:db8:3333:4444:5555:6666:7777:8888",
+      "2001:db8:3333::7777:8888",
+      "[1:2:3:4:5:6::7:8:9:a:b:c]", # invalid compressed hex ipv6 form
+      "[::ffff:258.512.768.999]", # invalid compressed hex4dec ipv6 form
+      "example.com:98000",
+    ].each do |candidate|
+      context "invalid input `#{candidate.inspect}`" do
+        it "reports the input as invalid" do
+          is_valid_result, coerced_or_error = described_class.validate([candidate])
+          failure = is_valid_result ? nil : coerced_or_error
+          coerced = is_valid_result ? coerced_or_error : nil
+
+          aggregate_failures do
+            expect(is_valid_result).to be false
+            expect(coerced).to be_nil # makes spec failure output useful
+          end
+          expect(failure).to_not be_nil
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-mixin-validator_support
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-15 00:00:00.000000000 Z
+date: 2023-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,9 @@ files:
 - README.md
 - lib/logstash/plugin_mixins/validator_support.rb
 - lib/logstash/plugin_mixins/validator_support/field_reference_validation_adapter.rb
+- lib/logstash/plugin_mixins/validator_support/required_host_optional_port_validation_adapter.rb
 - spec/logstash/plugin_mixins/validator_support/field_reference_validation_adapter_spec.rb
+- spec/logstash/plugin_mixins/validator_support/required_host_optional_port_validation_adapter_spec.rb
 - spec/logstash/plugin_mixins/validator_support_spec.rb
 homepage: https://github.com/logstash-plugins/logstash-mixin-validator_support
 licenses:
@@ -87,12 +89,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.11
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Support for the plugin parameter validations introduced in recent releases
   of Logstash, for plugins wishing to use them on older Logstashes
 test_files:
 - spec/logstash/plugin_mixins/validator_support/field_reference_validation_adapter_spec.rb
+- spec/logstash/plugin_mixins/validator_support/required_host_optional_port_validation_adapter_spec.rb
 - spec/logstash/plugin_mixins/validator_support_spec.rb