Merge pull request #958 from elastic/native-type-to-strings

Native type to strings

Author: tylerjl

CHANGELOG.md

@@ -3,6 +3,7 @@
 #### Features
 
 #### Fixes
+* REST-based resources are now coerced to string values to uniformly compare user defined values and Elasticsearch API responses.
 * Resolve deprecation warnings related to use of the deprecated is_array() function.
 
 ## 6.3.0 (June 18, 2018)

lib/puppet/provider/elasticsearch_index/ruby.rb

@@ -2,15 +2,15 @@
 
 require 'puppet/provider/elastic_rest'
 
-require 'puppet_x/elastic/deep_to_i'
+require 'puppet_x/elastic/deep_to_s'
 
 Puppet::Type.type(:elasticsearch_index).provide(
   :ruby,
   :parent => Puppet::Provider::ElasticREST,
   :metadata => :settings,
   :metadata_pipeline => [
     lambda { |data| data['settings'] },
-    lambda { |data| Puppet_X::Elastic.deep_to_i data }
+    lambda { |data| Puppet_X::Elastic.deep_to_s data }
   ],
   :api_uri => '_settings',
   :api_discovery_uri => '_all',

lib/puppet/provider/elasticsearch_license/shield.rb

@@ -6,7 +6,7 @@
   :parent => Puppet::Provider::ElasticREST,
   :metadata => :content,
   :metadata_pipeline => [
-    lambda { |data| Puppet_X::Elastic.deep_to_i data }
+    lambda { |data| Puppet_X::Elastic.deep_to_s data }
   ],
   :api_uri => '_license',
   :query_string => {

lib/puppet/provider/elasticsearch_license/x-pack.rb

@@ -8,7 +8,7 @@
   :parent => Puppet::Provider::ElasticREST,
   :metadata => :content,
   :metadata_pipeline => [
-    lambda { |data| Puppet_X::Elastic.deep_to_i data }
+    lambda { |data| Puppet_X::Elastic.deep_to_s data }
   ],
   :api_uri => '_xpack/license',
   :query_string => {

lib/puppet/provider/elasticsearch_template/ruby.rb

@@ -2,15 +2,15 @@
 
 require 'puppet/provider/elastic_rest'
 
-require 'puppet_x/elastic/deep_to_i'
+require 'puppet_x/elastic/deep_to_s'
 
 Puppet::Type.type(:elasticsearch_template).provide(
   :ruby,
   :parent => Puppet::Provider::ElasticREST,
   :api_uri => '_template',
   :metadata => :content,
   :metadata_pipeline => [
-    lambda { |data| Puppet_X::Elastic.deep_to_i data }
+    lambda { |data| Puppet_X::Elastic.deep_to_s data }
   ]
 ) do
   desc 'A REST API based provider to manage Elasticsearch templates.'

lib/puppet/type/elasticsearch_index.rb

@@ -1,8 +1,7 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..'))
 
 require 'puppet_x/elastic/asymmetric_compare'
-require 'puppet_x/elastic/deep_to_i'
-require 'puppet_x/elastic/deep_implode'
+require 'puppet_x/elastic/deep_to_s'
 require 'puppet_x/elastic/elasticsearch_rest_resource'
 
 Puppet::Type.newtype(:elasticsearch_index) do
@@ -24,7 +23,7 @@ def insync?(is)
     end
 
     munge do |value|
-      Puppet_X::Elastic.deep_to_i(value)
+      Puppet_X::Elastic.deep_to_s(value)
     end
 
     validate do |value|

lib/puppet/type/elasticsearch_license.rb

@@ -1,8 +1,7 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..'))
 
 require 'puppet_x/elastic/asymmetric_compare'
-require 'puppet_x/elastic/deep_to_i'
-require 'puppet_x/elastic/deep_implode'
+require 'puppet_x/elastic/deep_to_s'
 require 'puppet_x/elastic/elasticsearch_rest_resource'
 
 Puppet::Type.newtype(:elasticsearch_license) do
@@ -46,7 +45,7 @@ def should_to_s(newvalue)
     end
 
     munge do |value|
-      Puppet_X::Elastic.deep_to_i(value)
+      Puppet_X::Elastic.deep_to_s(value)
     end
   end
 end # of newtype

lib/puppet/type/elasticsearch_pipeline.rb

@@ -1,7 +1,6 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..'))
 
-require 'puppet_x/elastic/deep_to_i'
-require 'puppet_x/elastic/deep_implode'
+require 'puppet_x/elastic/deep_to_s'
 require 'puppet_x/elastic/elasticsearch_rest_resource'
 
 Puppet::Type.newtype(:elasticsearch_pipeline) do
@@ -23,7 +22,7 @@
     end
 
     munge do |value|
-      Puppet_X::Elastic.deep_to_i(value)
+      Puppet_X::Elastic.deep_to_s(value)
     end
   end
 end # of newtype

lib/puppet/type/elasticsearch_template.rb

@@ -4,7 +4,7 @@
 require 'puppet/file_serving/metadata'
 
 require 'puppet_x/elastic/deep_implode'
-require 'puppet_x/elastic/deep_to_i'
+require 'puppet_x/elastic/deep_to_s'
 require 'puppet_x/elastic/elasticsearch_rest_resource'
 
 Puppet::Type.newtype(:elasticsearch_template) do
@@ -32,15 +32,14 @@
       # `in` and `should` states consistent if the user hasn't
       # provided any.
       #
-      # We use deep_to_i to ensure any numeric values are properly
-      # parsed, whether from user-defined resources or when reading
-      # from the API.
+      # We use deep_to_s to normalize hash values to strings, whether from
+      # user-defined resources or when reading from the API.
       #
       # We also need to fully qualify index settings, since users
       # can define those with the index json key absent, but the API
       # always fully qualifies them.
-      { 'order' => 0, 'aliases' => {}, 'mappings' => {} }.merge(
-        Puppet_X::Elastic.deep_to_i(
+      { 'order' => '0', 'aliases' => {}, 'mappings' => {} }.merge(
+        Puppet_X::Elastic.deep_to_s(
           value.tap do |val|
             if val.key? 'settings'
               val['settings']['index'] = {} unless val['settings'].key? 'index'

lib/puppet_x/elastic/deep_to_s.rb

@@ -0,0 +1,20 @@
+module Puppet_X
+  # Custom Elastic functions
+  module Elastic
+    # When given a hash, this method recurses deeply into all values to convert
+    # any that aren't data structures into strings. This is necessary when
+    # comparing results from Elasticsearch API calls, because values like
+    # integers and booleans are in string form.
+    def self.deep_to_s(obj)
+      if obj.is_a? Array
+        obj.map { |element| deep_to_s(element) }
+      elsif obj.is_a? Hash
+        obj.merge(obj) { |_key, val| deep_to_s(val) }
+      elsif (not obj.is_a? String) and obj.respond_to? :to_s
+        obj.to_s
+      else
+        obj
+      end
+    end
+  end # of Elastic
+end # of Puppet_X