consult 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 371b66af8be47b598b8ee428856c17d35864b5ba93b3bff8ad0852c4d403d2fe
-  data.tar.gz: ce70cfa1f22a21d6255ae2fd1a867b2950765ca5c3b8b3c4f8090aab8f0c28d1
+  metadata.gz: 4545a86745cdd4600995f4a162cf9c3378ea61083b3670166e2e8e94a9e6103a
+  data.tar.gz: f48258760913efbb7e44bf17c7b2ac14e4e38d9563c6cb1d4c3a94b7c7c37aed
 SHA512:
-  metadata.gz: f72c7410f792f22c1bdc4d095b9f2fb122943625f2be6876461f692acd378fbd4bce6ce14797fe387d59d8ffaaf827612b3a7fb908d880a07b2933dddf294d03
-  data.tar.gz: f19a08e8ec11f404c82c6344885c36cc9346d04fbdaa7de8fdb9ddb3fe7059d1cc4c7d4c472a2a2ad41a642a87e338b5aa49a4eff36b0a19cd795dc29b48ee9f
+  metadata.gz: 5fdb5ecc269d4ffd29fdef55fa315e7471089b8f68e897de6a2641415a5fb0f7bcdd56d05c7ccc7be0b58757076cd2b05f65727ebdc5c7efe32c9bfe33e36ec9
+  data.tar.gz: 991eca37d6a392c21bab7ca620ae64608d4b6313e0048f376c84fc627234675fb79990d6c151a327c8bb53fa07b47937cb0f2782f0dd4df91762139eca6fc989

data/.circleci/config.yml

@@ -0,0 +1,78 @@
+version: 2.1
+
+jobs:
+  test:
+    parameters:
+      ruby_version:
+        type: string
+
+    docker:
+      - image: circleci/ruby:<< parameters.ruby_version >>
+      - image: consul:1.3.0
+      - image: vault:0.11.3
+        environment:
+          - VAULT_DEV_ROOT_TOKEN_ID=94e1a9ed-5d72-5677-27ab-ebc485cca368
+          # - SKIP_SETCAP=skip
+        # cap_add:
+        #   - IPC_LOCK
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          name: restore gem cache
+          keys:
+            - v1-bundle-<< parameters.ruby_version >>-{{ .Branch }}-{{ checksum "consult.gemspec" }}
+            - v1-bundle-<< parameters.ruby_version >>-{{ .Branch }}-
+            - v1-bundle-<< parameters.ruby_version >>-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle check --path ./vendor/bundle || bundle install --jobs=3 --retry=3 --path vendor/bundle
+            bundle clean
+
+      - save_cache:
+          name: save gem cache
+          paths:
+            - ./vendor/bundle
+          key: v1-bundle-<< parameters.ruby_version >>-{{ .Branch }}-{{ checksum "consult.gemspec" }}
+
+      - run:
+          name: setup fixture data
+          command: |
+            ./spec/support/populate_consul.sh
+
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec.xml \
+              --format progress \
+              $TEST_FILES
+
+      - store_test_results:
+          path: /tmp/test-results
+
+      - store_artifacts:
+          path: ./coverage
+          destination: coverage
+
+workflows:
+  test_supported_ruby_versions:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              ruby_version:
+                - '2.5'
+                - '2.7'

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+#### Unreleased
+
+#### 0.10.0
+
+* Switch from Travis to CircleCI, and set up testing for multiple Ruby versions ([#25](https://github.com/veracross/consult/pull/25) & [#34](https://github.com/veracross/consult/pull/34))
+* Improve development on Windows ([#21](https://github.com/veracross/consult/pull/21))
+* Normalize string encodings to UTF-8 ([#22](https://github.com/veracross/consult/pull/22))
+* Remove dependency on ActiveSupport ([#27](https://github.com/veracross/consult/pull/27))
+
+#### 0.9.0
+
+* Add a CLI to render templates on demand ([#20](https://github.com/veracross/consult/pull/20))
+
+#### 0.8.2
+
+* Use `X-Consul-Token` header for Consul authentication. See the [Consul docs](https://www.consul.io/api/index.html#authentication) for details. ([#19](https://github.com/veracross/consult/pull/19))
+
+#### 0.8.1
+
+* Obey template location order as specified in consult's config
+
 #### 0.8.0
 
 * Add support for multiple sources for a single template ([#14](https://github.com/veracross/consult/pull/14))

data/README.md

@@ -3,7 +3,7 @@
 Generate configuration and secrets for Rails apps automatically from [Consul](https://github.com/hashicorp/consul) & [Vault](https://github.com/hashicorp/vault).
 
 [![Gem Version](https://badge.fury.io/rb/consult.svg)](https://badge.fury.io/rb/consult)
-[![Build Status](https://travis-ci.org/veracross/consult.svg?branch=master)](https://travis-ci.org/veracross/consult)
+[![CircleCI](https://circleci.com/gh/veracross/consult/tree/master.svg?style=svg)](https://circleci.com/gh/veracross/consult/tree/master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/d7b048b7edd9f27c83b9/maintainability)](https://codeclimate.com/github/veracross/consult/maintainability)
 
 ## Background
@@ -14,8 +14,6 @@ We use Consul Template for server level configuration, but application level con
 
 With Consult the process is the same in all environments.
 
-This gem is considered _beta_. At Veracross, we are just beginning to use it in staging environments.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -40,6 +38,16 @@ Pre-existing copies of files generated by Consult (such as `secrets.yml`, `datab
 
 If this gem is included in a Rails, the templates will render on Rails boot. Configuration or credential changes can be picked up by restarting your app.
 
+### CLI
+
+Render templates on demand with the CLI. By default, this will bypass template TTLs to force rendering and provide verbose output. See `consult --help` for options.
+
+```bash
+$ bundle exec consult
+Consult: Rendered my_config
+Consult: Rendered secrets
+```
+
 ### Configuration
 
 ```yaml
@@ -289,7 +297,7 @@ production:
 Then reference secrets in your app with `Rails.application.secrets`.
 
 ```ruby
-# config/intiializers/rollbar.rb
+# config/initializers/rollbar.rb
 Rollbar.configure do |config|
   config.access_token = Rails.application.secrets.rollbar_token
 end

data/bin/consult

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/consult/cli'
+
+cli = Consult::CLI.instance
+cli.parse
+cli.render

data/consult.gemspec

@@ -20,20 +20,19 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = 'bin'
+  spec.executables   = ['consult']
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '> 4', '< 6'
   spec.add_dependency 'diplomat', '~> 2.0.2'
   spec.add_dependency 'vault', '>= 0.10.0', '< 1.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-rspec'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4.1'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'
 end

data/docker-compose.yml

@@ -1,11 +1,11 @@
 version: '3'
 services:
   consul:
-    image: consul:1.2.3
+    image: consul:1.3.0
     ports:
       - "8500:8500"
   vault:
-    image: vault:0.11.1
+    image: vault:0.11.3
     environment:
       - VAULT_DEV_ROOT_TOKEN_ID=94e1a9ed-5d72-5677-27ab-ebc485cca368
     cap_add:

data/lib/consult.rb

@@ -2,7 +2,6 @@
 
 require 'pathname'
 require 'yaml'
-require 'active_support/core_ext/hash'
 require 'erb'
 require 'vault'
 require 'diplomat'
@@ -10,6 +9,7 @@ require 'diplomat'
 require 'consult/version'
 require 'consult/utilities'
 require 'consult/template'
+require_relative './support/hash_extensions'
 
 module Consult
   @config = {}
@@ -18,16 +18,18 @@ module Consult
   CONSUL_DISK_TOKEN = Pathname.new("#{Dir.home}/.consul-token").freeze
 
   class << self
-    attr_reader :config, :templates
-    def load(config_dir: nil)
+    attr_reader :config, :templates, :force_render
+
+    def load(config_dir: nil, force_render: false, verbose: nil)
       root directory: config_dir
       yaml = root.join('config', 'consult.yml')
 
-      @all_config = yaml.exist? ? YAML.safe_load(ERB.new(yaml.read).result, [], [], true).to_h : {}
-      @all_config.deep_symbolize_keys!
+      @all_config = yaml.exist? ? YAML.safe_load(ERB.new(yaml.read).result, [], [], true, symbolize_names: true).to_h : {}
 
       @config = @all_config[:shared].to_h.deep_merge @all_config[env&.to_sym].to_h
-      @templates = @config[:templates]&.map { |name, config| Template.new(name, config) } || []
+      @templates = @config[:templates]&.map { |name, config| Template.new(name, config.merge(verbose: verbose)) } || []
+
+      @force_render = force_render
 
       configure_consul
       configure_vault
@@ -40,7 +42,9 @@ module Consult
       # Additionally: prefer env vars over explicit config
       configured_address = @config[:consul].delete(:address)
       @config[:consul][:url] = ENV['CONSUL_HTTP_ADDR'] || configured_address || @config[:consul][:url]
-      @config[:consul][:acl_token] = consul_token
+      # If a consul token exists, treat it as special
+      # See https://github.com/WeAreFarmGeek/diplomat/pull/160
+      (@config[:consul][:options] ||= {}).merge!(headers: {'X-Consul-Token' => consul_token}) if consul_token.to_s.length > 0
 
       Diplomat.configure do |c|
         @config[:consul].each do |opt, val|
@@ -69,7 +73,7 @@ module Consult
 
     # Return only the templates that are relevant for the current environment
     def active_templates
-      templates.select(&:should_render?)
+      force_render ? templates : templates.select(&:should_render?)
     end
 
     # Render templates.
@@ -82,7 +86,7 @@ module Consult
     def consul_token
       ENV['CONSUL_HTTP_TOKEN'] ||
         @config[:consul].delete(:token) ||
-        @config[:consul][:acl_token] ||
+        @config[:consul].delete(:acl_token) ||
         (CONSUL_DISK_TOKEN.exist? ? CONSUL_DISK_TOKEN.read.chomp : nil)
     end
   end

data/lib/consult/cli.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+$stdout.sync = true
+
+require 'singleton'
+require 'optparse'
+
+require_relative '../consult'
+
+module Consult
+  class CLI
+    include Singleton
+
+    attr_reader :opts
+
+    def parse(args = ARGV)
+      @opts = parse_options(args)
+      Consult.load @opts
+    end
+
+    def render
+      Consult.render!
+    end
+
+    def parse_options(argv)
+      opts = {
+        config_dir: Dir.pwd,
+        force_render: true,
+        verbose: true
+      }
+
+      @parser = OptionParser.new do |o|
+        o.on '-d', '--directory=DIR', 'Path to directory containing the config directory' do |arg|
+          opts[:config_dir] = arg
+        end
+
+        o.on '-f', '--[no-]force', TrueClass, 'Ignore template TTLs and force rendering' do |arg|
+          opts[:force_render] = arg
+        end
+
+        o.on '-v', '--quiet', FalseClass, 'Silence output' do |arg|
+          opts[:verbose] = arg
+        end
+      end
+
+      @parser.on_tail "-h", "--help", "Show help" do
+        puts @parser
+        exit 1
+      end
+
+      @parser.parse! argv
+      opts
+    end
+  end
+end

data/lib/consult/template.rb

@@ -7,6 +7,8 @@ module Consult
     include Utilities
     include TemplateFunctions
 
+    LOCATIONS = %i[path paths consul_key consul_keys]
+
     attr_reader :name, :config
 
     def initialize(name, config)
@@ -19,7 +21,8 @@ module Consult
       renderer = ERB.new(contents, nil, '-')
       result = renderer.result(binding)
 
-      File.open(dest, 'w') { |f| f << result } if save
+      File.open(dest, 'wb') { |f| f << result } if save
+      puts "Consult: Rendered #{name}" if verbose?
       result
     rescue StandardError => e
       STDERR.puts "Error rendering template: #{name}"
@@ -53,23 +56,31 @@ module Consult
       dest.mtime < (Time.now - @config[:ttl].to_i)
     end
 
+    def verbose?
+      @config[:verbose]
+    end
+
+    def ordered_locations
+      @config.keys & LOCATIONS
+    end
+
     private
 
     # Concatenate all the source templates together, in the order provided
-    # Disk contents go first
     def contents
-      disk_contents + consul_contents
+      ordered_locations.map do |location|
+        location.to_s.start_with?('consul') ? consul_contents(location) : disk_contents(location)
+      end.join
     end
 
-    def consul_contents
-      [@config[:consul_key], @config[:consul_keys]].compact.flatten.map do |key|
-        Diplomat::Kv.get(key, options: nil, not_found: :return, found: :return)
+    def consul_contents(location)
+      [@config[location]].compact.flatten.map do |key|
+        Diplomat::Kv.get(key, options: nil, not_found: :return, found: :return).force_encoding 'utf-8'
       end.join
     end
 
-    # Concatenate all the source templates together, in the order provided
-    def disk_contents
-      [path, paths].compact.flatten.map do |file_path|
+    def disk_contents(location)
+      [public_send(location)].compact.flatten.map do |file_path|
         File.read file_path, encoding: 'utf-8'
       end.join
     end

data/lib/consult/version.rb

@@ -1,3 +1,3 @@
 module Consult
-  VERSION = '0.8.0'
+  VERSION = '0.10.0'
 end

data/lib/support/hash_extensions.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# ActiveSupport's corresponding methods
+#  - https://github.com/rails/rails/tree/master/activesupport/lib/active_support/core_ext/hash
+module HashExtension
+  def deep_merge(other_hash, &block)
+    merge(other_hash) do |key, this_val, other_val|
+      if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+        this_val.deep_merge other_val, &block
+      elsif block_given?
+        block.call key, this_val, other_val
+      else
+        other_val
+      end
+    end
+  end
+end
+
+Hash.send(:include, HashExtension)

metadata

@@ -1,35 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: consult
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Jeff Fraser
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2018-10-10 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
 - !ruby/object:Gem::Dependency
   name: diplomat
   requirement: !ruby/object:Gem::Requirement
@@ -68,18 +48,18 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -93,7 +73,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -107,7 +87,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -121,7 +101,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -135,58 +115,60 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.16.1
 description: Manage consul/vault backed template files in Ruby.
 email:
 - jeff.fraser@veracross.com
-executables: []
+executables:
+- consult
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -195,21 +177,24 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/consult
 - bin/setup
 - consult.gemspec
 - docker-compose.yml
 - lib/consult.rb
+- lib/consult/cli.rb
 - lib/consult/rails/engine.rb
 - lib/consult/template.rb
 - lib/consult/template_functions.rb
 - lib/consult/utilities.rb
 - lib/consult/version.rb
+- lib/support/hash_extensions.rb
 homepage: https://github.com/veracross/consult
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -224,9 +209,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.7.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Manage consul/vault backed template files in Ruby.
 test_files: []

data/.travis.yml

@@ -1,15 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5
-  - 2.4
-  - 2.3
-
-services:
-  - docker
-
-before_install:
-  - gem install bundler -v 1.16.2
-  - docker-compose --version
-  - docker-compose up -d
-  - docker ps