consul-templaterb 1.32.1 → 1.33.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c45366cab4f4e92c620ccd80d1263afd031b3b26163630e7969d1dd68c7136e
-  data.tar.gz: 89c565116147e7e9ae610dad3bbfb378f0ccdfaaf0ccf1f7738f257264ee7517
+  metadata.gz: f55651aacf74759dde1f529be4cb482568b0272067b5b208ff4268828cbfce6b
+  data.tar.gz: f22a2c679bcaf2a79a1d70f2d375d1707a5a2e58ae99f9186f10d97615b24303
 SHA512:
-  metadata.gz: 322c5a2ba771c67090b06a87dcf01d9977846d665423bc5dbeda38188343d94f94b78c35fa7ebdac7936e2180eab91dc60f4c66cdf9fcd660605133ca6eca07e
-  data.tar.gz: a08fa814f2b7b9ec2ca5e6a5ee7a18fcfbbd74602cafa6cc9ae24f1ca664621f746824dab7664fcac29f270590c7a7c8939b993c92013174eaf2c94f1117a517
+  metadata.gz: 1b10810197fc2c882d09723203d47c62f6aaed2a94cd463a939e4b9ab34b75c0e3c2f8b2c702bc999dd5e37bd86d1b727f17268f7029b66f0ac75211843340ba
+  data.tar.gz: cbbec34b47aa8230846ff21dbeb247928519d65f058cded7cf29f76df225fa8148bcb99d3d842e1951a782c992e355b37628b83505c5dd705831d1b7ce49ac6f

data/CHANGELOG.md

@@ -1,6 +1,27 @@
 # CHANGELOG
 
-## 1.31.1 (Jan 28, 2021)
+## 1.31.2 (Aug 04 2022)
+
+BUG FIX:
+
+* URL encode service and KV names when calling the http API
+
+## 1.31.1 (Feb 281 2022)
+
+BUG FIX:
+
+* Correctly identify endpoints
+
+## 1.33.0 (Nov 22, 2021)
+
+IMPROVEMENTS:
+
+* Validate ssl peers
+* Allow to stream log lines
+* [CONSUL-UI] Display services with no port definition
+* Hide opts in logs by default
+
+## 1.32.1 (Jan 28, 2021)
 
 IMPROVEMENTS:
 

data/README.md

@@ -207,6 +207,11 @@ It means that you can call consul-templaterb with `*.erb` arguments, the shell
 will then substitute all files and render it by removing the `.erb` extension as
 if the `--template my_file.ext.erb:myfile.ext` was used.
 
+If the program is run in an automatic context, it could be useful to stream
+logs instead of the default interactive log version which erase last log line.
+To configure this behavior, set the `STREAM_LOG` environment variable to any
+value.
+
 ### Generate multiple templates
 
 In the same way as consul-template, consul-templaterb supports multiple templates and executing
@@ -287,7 +292,7 @@ If you want to test it quickly, you might try with (assuming your consul agent i
 `http://localhost:8500`):
 
 ```shell
-$ be bin/consul-templaterb -c 'http://localhost:8500' samples/*.html.erb
+$ bundle exec bin/consul-templaterb -c 'http://localhost:8500' samples/*.html.erb
 [...]
 ```
 

data/TemplateAPI.md

@@ -380,6 +380,15 @@ Full example: [samples/consul_template.txt.erb](samples/consul_template.txt.erb)
 [List all the services of a given Node](https://www.consul.io/api/catalog.html#list-services-for-node) using its
 name or its ID. If DC is specified, will lookup for given node in another datacenter.
 
+The value returned might be nil (because the node does not exists).
+Thus, it might be safer to use the helper methods on the result:
+
+ * node('mynode').exists? -> true if node exists and result is not nil
+ * node('mynode').services() -> to get the hash of services defined for this node (return empty map if nodes does not exists)
+ * node('mynode').node() -> to get node information (empty map if node does not exists)
+
+ See also: https://github.com/criteo/consul-templaterb/issues/74
+
 ## checks_for_node(name, dc: nil, passing: false, tag: nil, [agent: consul_agent_address])
 
 [Find all the checks](https://www.consul.io/api/health.html#list-checks-for-node) of a given node name.

data/lib/consul/async/consul_endpoint.rb

@@ -265,7 +265,8 @@ module Consul
       def fetch
         options = {
           connect_timeout: 5, # default connection setup timeout
-          inactivity_timeout: conf.wait_duration + 1 + (conf.wait_duration / 16) # default connection inactivity (post-setup) timeout
+          inactivity_timeout: conf.wait_duration + 1 + (conf.wait_duration / 16), # default connection inactivity (post-setup) timeout
+          tls: { verify_peer: conf.tls_verify_peer }
         }
         unless conf.tls_cert_chain.nil?
           options[:tls] = {

data/lib/consul/async/consul_template.rb

@@ -31,7 +31,7 @@ module Consul
 
       def as_json(url, default_value, refresh_delay_secs: 10, **opts)
         conf = JSONConfiguration.new(url: url, min_duration: refresh_delay_secs, retry_on_non_diff: refresh_delay_secs, **opts)
-        endpoint_id = url + opts.to_json
+        endpoint_id = url + opts.hash.to_s
         @endp_manager.create_if_missing(url, {}, endpoint_id: endpoint_id) do
           if default_value.is_a?(Array)
             ConsulTemplateJSONArray.new(JSONEndpoint.new(conf, url, default_value))
@@ -132,7 +132,7 @@ module Consul
       def service(name, dc: nil, passing: false, tag: nil, agent: nil)
         raise 'You must specify a name for a service' if name.nil?
 
-        path = "/v1/health/service/#{name}"
+        path = '/v1/health/service/' + ERB::Util.url_encode(name.to_s)
         query_params = {}
         query_params[:dc] = dc if dc
         query_params[:passing] = passing if passing
@@ -144,7 +144,7 @@ module Consul
       def checks_for_service(name, dc: nil, passing: false, agent: nil)
         raise 'You must specify a name for a service' if name.nil?
 
-        path = "/v1/health/checks/#{name}"
+        path = '/v1/health/checks/' + ERB::Util.url_encode(name.to_s)
         query_params = {}
         query_params[:dc] = dc if dc
         query_params[:passing] = passing if passing
@@ -155,7 +155,7 @@ module Consul
       def checks_for_node(name, dc: nil, passing: false, agent: nil)
         raise 'You must specify a name for a service' if name.nil?
 
-        path = "/v1/health/node/#{name}"
+        path = '/v1/health/node/' + ERB::Util.url_encode(name.to_s)
         query_params = {}
         query_params[:dc] = dc if dc
         query_params[:passing] = passing if passing
@@ -184,10 +184,10 @@ module Consul
 
       # https://www.consul.io/api/catalog.html#list-services-for-node
       def node(name_or_id, dc: nil, agent: nil)
-        path = "/v1/catalog/node/#{name_or_id}"
+        path = '/v1/catalog/node/' + ERB::Util.url_encode(name_or_id.to_s)
         query_params = {}
         query_params[:dc] = dc if dc
-        create_if_missing(path, query_params, agent: agent) { ConsulTemplateNodes.new(ConsulEndpoint.new(consul_conf, path, true, query_params, '{}', agent)) }
+        create_if_missing(path, query_params, agent: agent) { ConsulTemplateNode.new(ConsulEndpoint.new(consul_conf, path, true, query_params, '{}', agent)) }
       end
 
       # https://www.consul.io/api/agent.html#read-configuration
@@ -247,7 +247,7 @@ module Consul
 
       # https://www.consul.io/api/kv.html#read-key
       def kv(name = nil, dc: nil, keys: nil, recurse: false, agent: nil)
-        path = "/v1/kv/#{name}"
+        path = '/v1/kv/' + ERB::Util.url_encode(name.to_s)
         query_params = {}
         query_params[:dc] = dc if dc
         query_params[:recurse] = recurse if recurse
@@ -400,8 +400,9 @@ module Consul
                             agent: nil, endpoint_id: nil)
         endpoint_id ||= begin
                           fqdn = path.dup
+                          fqdn = "#{agent}#{fqdn}"
                           query_params.each_pair do |k, v|
-                            fqdn = "#{agent}#{fqdn}&#{k}=#{v}"
+                            fqdn += "&#{k}=#{v}"
                           end
                           fqdn
                         end
@@ -628,6 +629,36 @@ module Consul
       end
     end
 
+    # Get information about a single node
+    class ConsulTemplateNode < ConsulTemplateAbstractMap
+      def initialize(consul_endpoint)
+        super(consul_endpoint)
+      end
+
+      def exists?
+        !result_delegate.nil?
+      end
+
+      def safe_get
+        if exists?
+          result_delegate
+        else
+          {
+            'Node': {},
+            'Services': {}
+          }
+        end
+      end
+
+      def node
+        safe_get['Node'] || {}
+      end
+
+      def services
+        safe_get['Services'] || {}
+      end
+    end
+
     # List of nodes of the whole cluster
     class ConsulTemplateNodes < ConsulTemplateAbstractArray
       def initialize(consul_endpoint)

data/lib/consul/async/debug.rb

@@ -26,7 +26,10 @@ module Consul
       end
 
       def self.print_info(msg)
+        return unless level > 1
+
         STDERR.print "[INFO] #{msg}" if level > 1
+        warn '' if ENV['LOG_STREAM']
       end
 
       def self.puts_debug(msg)
@@ -34,7 +37,10 @@ module Consul
       end
 
       def self.print_debug(msg)
-        STDERR.print "[DEBG] #{msg}" if level > 2
+        return unless level > 2
+
+        STDERR.print "[DEBG] #{msg}"
+        warn '' if ENV['LOG_STREAM']
       end
     end
   end

data/lib/consul/async/json_endpoint.rb

@@ -184,6 +184,7 @@ module Consul
 
       def fetch
         options = {
+          tls: { verify_peer: conf.tls_verify_peer },
           connect_timeout: 5, # default connection setup timeout
           inactivity_timeout: 60 # default connection inactivity (post-setup) timeout
         }

data/lib/consul/async/vault_endpoint.rb

@@ -230,6 +230,7 @@ module Consul
 
       def fetch
         options = {
+          tls: { verify_peer: conf.tls_verify_peer },
           connect_timeout: 5, # default connection setup timeout
           inactivity_timeout: 1 # default connection inactivity (post-setup) timeout
         }

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.32.1'.freeze
+    VERSION = '1.33.2'.freeze
   end
 end

data/samples/consul-ui/consul_services.json.erb

@@ -36,7 +36,7 @@
       @sort_consul_service_nodes.call(service(service_name)).each do |snode|
         tags_of_instance = snode['Service']['Tags'].sort
         if (instance_must_tag.nil? || tags_of_instance.include?(instance_must_tag)) && !tags_of_instance.include?(instance_exclude_tag)
-          the_backends << snode if snode['Service']['Port']
+          the_backends << snode
         end
       end
       # We add the backend ONLY if at least one valid instance does exists

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.32.1
+  version: 1.33.2
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-28 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -256,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Implementation of Consul template using Ruby and .erb templating language