consul-templaterb 1.31.1 → 1.33.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5d188151cdf2f004d4993cc5620ad86ce8632e2de820ca6498d37ce8acbd4c9
-  data.tar.gz: 6469c2b6d1a9032bb16fdfbe53b062a2271e3a787dcc0f52bb0e749c081081e4
+  metadata.gz: 18c7c1fcf9c8e0685664f79da1b48f7e15dabdaa959ad12172f64313877f9551
+  data.tar.gz: d54d351404c5f76d7e08b502b1f905b9709a2666a6641ad7c24aa7d9b122e6a7
 SHA512:
-  metadata.gz: 498a5282930d98afe30840f8f167559783aafa7d17b9a902ff8950dac5727d8496c666d0dea01d10ac59cfe4e845ca5664ded482b16641d4723f3edd5fa9053a
-  data.tar.gz: a2526b83b9083275b6d1057948d80457f8ea4aede46201b15408fe331a329430d6785f8372339b8c2e139da2f1fe96c13a699d4b6c936f98d411c26b797413c2
+  metadata.gz: 29b61accf646ff4fe11946f2bafc37bd6dea31e50b9d6c01a0ded3c3c1992ae394060f1e0711136492170810c6fe5f7a25e1b06a3930d6218986f0acfee5ca34
+  data.tar.gz: 50ab860a1eb59c0c7b99e97eb3ed95edfcfd94452917c69a462145d5d9700c16790631010c8aa7950b17d601b095bb3b799b11d852d84c3b23a1f0150ee230b7

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # CHANGELOG
 
+## 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:
+
+* Switched to Github Actions (build)
+* No functional changes in GEM - Test release only
+
+## 1.32.0 (Jan 27, 2021)
+
+IMPROVEMENTS:
+
+* Use Ruby 2.7.2 in Travis build
+* [VAULT] Do not handle missing secret as a blocking exception ([#73](https://github.com/criteo/consul-templaterb/pull/73))
+
 ## 1.31.1 (Jan 25, 2021)
 
 IMPROVEMENTS:

data/README.md

@@ -1,6 +1,6 @@
 # consul-templaterb
 
-[![Build Status](https://api.travis-ci.org/criteo/consul-templaterb.svg?branch=master)](https://travis-ci.org/criteo/consul-templaterb)
+[![Build Status](https://github.com/criteo/consul-templaterb/workflows/Ruby/badge.svg?branch=master)](https://github.com/criteo/consul-templaterb/actions?query=branch%3Amaster)
 [![Gem Version](https://badge.fury.io/rb/consul-templaterb.svg)](http://github.com/criteo/consul-templaterb/releases)
 [![GEM Downloads](https://ruby-gem-downloads-badge.herokuapp.com/consul-templaterb?type=total&metric=true)](https://rubygems.org/gems/consul-templaterb)
 [![License](https://img.shields.io/badge/license-ApacheV2-yellowgreen.svg)](#license)
@@ -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))
@@ -187,7 +187,7 @@ module Consul
         path = "/v1/catalog/node/#{name_or_id}"
         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
@@ -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
         }
@@ -245,7 +246,7 @@ module Consul
           http = connection.send(http_method.downcase, build_request) # Under the hood: c.send('get', {stuff}) === c.get({stuff})
           http.callback do
             http_result = VaultHttpResponse.new(http.dup.freeze, default_value)
-            if enforce_json_200 && http.response_header.status != 200
+            if enforce_json_200 && ![200, 404].include?(http.response_header.status)
               _handle_error(http_result) { connection = EventMachine::HttpRequest.new(conf.base_url, options) }
             else
               @consecutive_errors = 0

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.31.1'.freeze
+    VERSION = '1.33.1'.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.31.1
+  version: 1.33.1
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2022-02-21 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.0.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Implementation of Consul template using Ruby and .erb templating language