constancy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72ea5278404520809d073eab084fe0a33f71221e
+  data.tar.gz: 8345a952b62e73266a2266045adb5a7bcdc9a99f
+SHA512:
+  metadata.gz: f89c7c2246deed0012d258e8e5b3d8903332d68f8bfad49e74915a74eebabc68b604e8cef9d382d2bddce24316575dde0f73cefb62b41800cb0b3e869bbc9f85
+  data.tar.gz: 697665d664aef7b355ba2975d0edb0c87a2cde795dee4b1cca346ac69feff10832b51bb8fa75e88714fb35591eebf1476272b10a8bcf11360a4d6953da5e0fe5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Instructure, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,198 @@
+# constancy
+
+Constancy provides simple filesystem-to-Consul KV synchronization.
+
+## Basic Usage
+
+Run `constancy check` to see what differences exist, and `constancy push` to
+synchronize the changes.
+
+    $ constancy check
+    =====================================================================================
+    myapp-private
+    local:consul/private => consul:dc1:private/myapp
+      Keys scanned: 37
+    No changes to make for this sync target.
+
+    =====================================================================================
+    myapp-config
+    local:consul/config => consul:dc1:config/myapp
+      Keys scanned: 80
+
+    UPDATE config/myapp/prod/ip-whitelist.json
+    -------------------------------------------------------------------------------------
+    -["10.8.0.0/16"]
+    +["10.8.0.0/16","10.9.10.0/24"]
+    -------------------------------------------------------------------------------------
+
+    Keys to update: 1
+    ~ config/myapp/prod/ip-whitelist.json
+
+You can also limit your command to specific synchronization targets by using
+the `--target` flag:
+
+    $ constancy push --target myapp-config
+    =====================================================================================
+    myapp-config
+    local:consul/config => consul:dc1:config/myapp
+      Keys scanned: 80
+
+    UPDATE config/myapp/prod/ip-whitelist.json
+    -------------------------------------------------------------------------------------
+    -["10.8.0.0/16"]
+    +["10.8.0.0/16","10.9.10.0/24"]
+    -------------------------------------------------------------------------------------
+
+    Keys to update: 1
+    ~ config/myapp/prod/ip-whitelist.json
+
+    Do you want to push these changes?
+      Enter 'yes' to continue: yes
+
+    UPDATE config/myapp/prod/ip-whitelist.json   OK
+
+Run `constancy --help` for additional options and commands.
+
+
+## Configuration
+
+Constancy will automatically configure itself using the first `constancy.yml`
+file it comes across when searching backwards through the directory tree from
+the current working directory. So, typically you may wish to place the config
+file in the root of your git repository or the base directory of your config
+file tree.
+
+You can also specify a config file using the `--config <filename>` command line
+argument.
+
+
+### Configuration file structure
+
+The configuration file is a Hash represented in YAML format with three possible
+top-level keys: `constancy`, `consul`, and `sync`. The `constancy` section sets
+global defaults and app options. The `consul` section specifies the URL to the
+Consul REST API endpoint. And the `sync` section lists the directories and
+Consul prefixes you wish to synchronize. Only the `sync` section is strictly
+required. An example `constancy.yml` is below including explanatory comments:
+
+    # constancy.yml
+
+    constancy:
+      # verbose - defaults to `false`
+      #   Set this to `true` for more verbose output.
+      verbose: false
+
+      # chomp - defaults to `true`
+      #   Automatically runs `chomp` on the strings read in from files to
+      #   eliminate a single trailing newline character (commonly inserted
+      #   by text editors). Set to `false` to disable this by default for
+      #   all sync targets (it can be overridden on a per-target basis).
+      chomp: true
+
+      # delete - defaults to `false`
+      #   Set this to `true` to make the default for all sync targets to
+      #   delete any keys found in Consul that do not have a corresponding
+      #   file on disk. By default, extraneous remote keys will be ignored.
+      #   If `verbose` is set to `true` the extraneous keys will be named
+      #   in the output.
+      delete: false
+
+      # color - defaults to `true`
+      #   Set this to `false` to disable colorized output (eg when running
+      #   with an automated tool).
+      color: true
+
+    consul:
+      # url - defaults to `http://localhost:8500`
+      #   The REST API endpoint for the Consul agent.
+      url: http://localhost:8500
+
+      # datacenter - defaults to nil
+      #   Set this to change the default datacenter for sync targets to
+      #   something other than the datacenter of the Consul agent.
+      datacenter: dc1
+
+    sync:
+      # sync is an array of hashes of sync target configurations
+      #   Fields:
+      #     name - The arbitrary friendly name of the sync target. Only
+      #       required if you wish to target specific sync targets using
+      #       the `--target` CLI flag.
+      #     prefix - (required) The Consul KV prefix to synchronize to.
+      #     datacenter - The Consul datacenter to synchronize to. If not
+      #       specified, the `datacenter` setting in the `consul` section
+      #       will be used. If that is also not specified, the sync will
+      #       happen with the local datacenter of the Consul agent.
+      #     path - (required) The relative filesystem path to the directory
+      #       containing the files with content to synchronize to Consul.
+      #       This path is calculated relative to the directory containing
+      #       the configuration file.
+      #     delete - Whether or not to delete remote keys that do not exist
+      #       in the local filesystem. This inherits the setting from the
+      #       `constancy` section, or if not specified, defaults to `false`.
+      #     chomp - Whether or not to chomp a single newline character off
+      #       the contents of local files before synchronizing to Consul.
+      #       This inherits the setting from the `constancy` section, or if
+      #       not specified, defaults to `true`.
+      #     exclude - An array of Consul KV paths to exclude from the
+      #       sync process. These exclusions will be noted in output if the
+      #       verbose mode is in effect, otherwise they will be silently
+      #       ignored. At this time there is no provision for specifying
+      #       prefixes or patterns. Each key must be fully and explicitly
+      #       specified.
+      - name: myapp-config
+        prefix: config/myapp
+        datacenter: dc1
+        path: consul/config
+        exclude:
+          - config/myapp/beta/cowboy-yolo
+          - config/myapp/prod/cowboy-yolo
+      - name: myapp-private
+        prefix: private/myapp
+        datacenter: dc1
+        path: consul/private
+        delete: true
+
+You can run `constancy config` to get a summary of the defined configuration
+and to double-check config syntax.
+
+
+### Environment configuration
+
+Constancy may be partially configured using environment variables:
+* `CONSTANCY_VERBOSE` - set this variable to any value to enable verbose mode
+* `CONSUL_HTTP_TOKEN` or `CONSUL_TOKEN` - use one of these variables (priority
+  is given to `CONSUL_HTTP_TOKEN`) to set an explicit Consul token to use when
+  interacting with the API. Otherwise, by default the agent's `acl_token`
+  setting is used implicitly.
+
+
+## Automation
+
+For version 0.1, Constancy does not fully support running non-interactively.
+This is primarily to ensure human observation of any changes being made while
+the software matures. Later versions will allow for full automation.
+
+
+## Roadmap
+
+Constancy is very new software. There's more to be done. Some ideas:
+
+* Pattern- and prefix-based exclusions
+* Other commands to assist in managing Consul KV sets
+* Automation support for running non-interactively
+* Git awareness (branches, commit state, etc)
+* Automated tests
+* Logging of changes to files, syslog, other services
+* Allowing other means of providing a Consul token
+
+
+## Contributing
+
+I'm happy to accept suggestions, bug reports, and pull requests through Github.
+
+
+## License
+
+This software is public domain. No rights are reserved. See LICENSE for more
+information.

data/bin/constancy

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+#
+# This software is public domain. No rights are reserved. See LICENSE for more information.
+#
+
+require 'constancy/cli'
+
+Constancy::CLI.run

data/constancy.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/constancy/version.rb'
+
+Gem::Specification.new do |s|
+  s.name = 'constancy'
+  s.version = Constancy::VERSION
+  s.authors = ['David Adams']
+  s.email = 'daveadams@gmail.com'
+  s.date = Time.now.strftime('%Y-%m-%d')
+  s.license = 'CC0'
+  s.homepage = 'https://github.com/daveadams/constancy'
+  s.required_ruby_version = '>=2.4.0'
+
+  s.summary = 'Simple filesystem-to-Consul KV synchronization'
+  s.description =
+    'Syncs content from the filesystem to the Consul KV store.'
+
+  s.require_paths = ['lib']
+  s.files = Dir["lib/**/*.rb"] + [
+    'bin/constancy',
+    'README.md',
+    'LICENSE',
+    'constancy.gemspec'
+  ]
+  s.bindir = 'bin'
+  s.executables = ['constancy']
+
+  s.add_dependency 'imperium', '~>0.3'
+  s.add_dependency 'diffy', '~>3.2'
+end

data/lib/constancy.rb

@@ -0,0 +1,72 @@
+# This software is public domain. No rights are reserved. See LICENSE for more information.
+
+require 'yaml'
+require 'imperium'
+
+require 'constancy/version'
+require 'constancy/config'
+require 'constancy/sync_target'
+
+class Constancy
+  class << self
+    @@config = nil
+
+    def config
+      @@config ||= Constancy::Config.new
+    end
+
+    def configure(path: nil, targets: nil)
+      @@config = Constancy::Config.new(path: path, targets: targets)
+    end
+
+    def configured?
+      not @@config.nil?
+    end
+  end
+
+  class Util
+    class << self
+      # https://stackoverflow.com/questions/9647997/converting-a-nested-hash-into-a-flat-hash
+      def flatten_hash(h,f=[],g={})
+        return g.update({ f=>h }) unless h.is_a? Hash
+        h.each { |k,r| flatten_hash(r,f+[k],g) }
+        g
+      end
+    end
+  end
+end
+
+# monkeypatch String for colors
+class String
+  def colorize(s,e=0)
+    Constancy.config.color? ? "\e[#{s}m#{self}\e[#{e}m" : self
+  end
+
+  def red
+    colorize(31)
+  end
+
+  def green
+    colorize(32)
+  end
+
+  def blue
+    colorize(34)
+  end
+
+  def magenta
+    colorize(35)
+  end
+
+  def cyan
+    colorize(36)
+  end
+
+  def gray
+    colorize(37)
+  end
+
+  def bold
+    colorize(1,22)
+  end
+end

data/lib/constancy/cli.rb

@@ -0,0 +1,129 @@
+# This software is public domain. No rights are reserved. See LICENSE for more information.
+
+require 'constancy'
+require 'diffy'
+require 'constancy/cli/check_command'
+require 'constancy/cli/push_command'
+require 'constancy/cli/config_command'
+
+class Constancy
+  class CLI
+    class << self
+      attr_accessor :command, :cli_mode, :config_file, :extra_args, :targets
+
+      def parse_args(args)
+        self.print_usage if args.count < 1
+        self.command = nil
+        self.config_file = nil
+        self.extra_args = []
+        self.cli_mode = :command
+
+        while arg = args.shift
+          case arg
+          when "--help"
+            self.cli_mode = :help
+
+          when "--config"
+            self.config_file = args.shift
+
+          when "--target"
+            self.targets = (args.shift||'').split(",")
+
+          when /^-/
+            # additional option, maybe for the command
+            self.extra_args << arg
+
+          else
+            if self.command.nil?
+              # if command is not set, this is probably the command
+              self.command = arg
+            else
+              # otherwise, pass it thru to the child command
+              self.extra_args << arg
+            end
+          end
+        end
+      end
+
+      def print_usage
+        STDERR.puts <<USAGE
+Usage:
+  #{File.basename($0)} <command> [options]
+
+Commands:
+  check        Print a summary of changes to be made
+  push         Push changes from filesystem to Consul
+  config       Print a summary of the active configuration
+
+General options:
+  --help           Print help for the given command
+  --config <file>  Use the specified config file
+  --target <tgt>   Only apply to the specified target name or names (comma-separated)
+
+USAGE
+        exit 1
+      end
+
+      def configure
+        return if Constancy.configured?
+
+        begin
+          Constancy.configure(path: self.config_file, targets: self.targets)
+
+        rescue Constancy::ConfigFileNotFound
+          if self.config_file.nil?
+            STDERR.puts "constancy: ERROR: No configuration file found"
+          else
+            STDERR.puts "constancy: ERROR: Configuration file '#{self.config_file}' was not found"
+          end
+          exit 1
+
+        rescue Constancy::ConfigFileInvalid => e
+          if self.config_file.nil?
+            STDERR.puts "constancy: ERROR: Configuration file is invalid:"
+          else
+            STDERR.puts "constancy: ERROR: Configuration file '#{self.config_file}' is invalid:"
+          end
+          STDERR.puts "  #{e}"
+          exit 1
+        end
+
+        if Constancy.config.sync_targets.count < 1
+          if self.targets.nil?
+            STDERR.puts "constancy: WARNING: No sync targets are defined"
+          else
+            STDERR.puts "constancy: WARNING: No sync targets were found that matched the specified list"
+          end
+        end
+      end
+
+      def run
+        self.parse_args(ARGV)
+
+        case self.cli_mode
+        when :help
+          # TODO: per-command help
+          self.print_usage
+
+        when :command
+          case self.command
+          when 'check'      then Constancy::CLI::CheckCommand.run
+          when 'push'       then Constancy::CLI::PushCommand.run
+          when 'config'     then Constancy::CLI::ConfigCommand.run
+          when nil          then self.print_usage
+
+          else
+            STDERR.puts "constancy: ERROR: unknown command '#{self.command}'"
+            STDERR.puts
+            self.print_usage
+          end
+
+        else
+          STDERR.puts "constancy: ERROR: unknown CLI mode '#{self.cli_mode}'"
+          exit 1
+
+        end
+      end
+    end
+  end
+end

data/lib/constancy/cli/check_command.rb

@@ -0,0 +1,21 @@
+# This software is public domain. No rights are reserved. See LICENSE for more information.
+
+class Constancy
+  class CLI
+    class CheckCommand
+      class << self
+        def run
+          Constancy::CLI.configure
+
+          Constancy.config.sync_targets.each do |target|
+            target.print_report
+            if not target.any_changes?
+              puts "No changes to make for this sync target."
+            end
+            puts
+          end
+        end
+      end
+    end
+  end
+end

data/lib/constancy/cli/config_command.rb

@@ -0,0 +1,44 @@
+# This software is public domain. No rights are reserved. See LICENSE for more information.
+
+class Constancy
+  class CLI
+    class ConfigCommand
+      class << self
+        def run
+          Constancy::CLI.configure
+
+          puts "Config file: #{Constancy.config.config_file}"
+          puts " Consul URL: #{Constancy.config.consul.url}"
+          puts "    Verbose: #{Constancy.config.verbose?.to_s.bold}"
+          puts
+          puts "Sync target defaults:"
+          puts "  Chomp trailing newlines from local files: #{Constancy.config.chomp?.to_s.bold}"
+          puts "  Delete remote keys with no local file: #{Constancy.config.delete?.to_s.bold}"
+          puts
+          puts "Sync targets:"
+
+          Constancy.config.sync_targets.each do |target|
+            if target.name
+              puts "* #{target.name.bold}"
+              print ' '
+            else
+              print '*'
+            end
+            puts " Datacenter: #{target.datacenter}"
+            puts "   File path: #{target.path}"
+            puts "      Prefix: #{target.prefix}"
+            puts "   Autochomp? #{target.chomp?}"
+            puts "      Delete? #{target.delete?}"
+            if not target.exclude.empty?
+              puts "  Exclusions:"
+              target.exclude.each do |exclusion|
+                puts "    - #{exclusion}"
+              end
+            end
+            puts
+          end
+        end
+      end
+    end
+  end
+end

data/lib/constancy/cli/push_command.rb

@@ -0,0 +1,74 @@
+# This software is public domain. No rights are reserved. See LICENSE for more information.
+
+class Constancy
+  class CLI
+    class PushCommand
+      class << self
+        def run
+          Constancy::CLI.configure
+          STDOUT.sync = true
+
+          Constancy.config.sync_targets.each do |target|
+            target.print_report
+
+            if not target.any_changes?
+              puts
+              puts "Everything is in sync. No changes need to be made to this sync target."
+              next
+            end
+
+            puts
+            puts "Do you want to push these changes?"
+            print "  Enter '" + "yes".bold + "' to continue: "
+            answer = gets.chomp
+
+            if answer.downcase != "yes"
+              puts
+              puts "Push cancelled. No changes will be made to this sync target."
+              next
+            end
+
+            puts
+            target.items_to_change.each do |item|
+              case item[:op]
+              when :create
+                print "CREATE".bold.green + " " + item[:consul_key]
+                resp = target.consul.put(item[:consul_key], item[:local_content], dc: target.datacenter)
+                if resp.success?
+                  puts "   OK".bold
+                else
+                  puts "   ERROR".bold.red
+                end
+
+              when :update
+                print "UPDATE".bold.blue + " " + item[:consul_key]
+                resp = target.consul.put(item[:consul_key], item[:local_content], dc: target.datacenter)
+                if resp.success?
+                  puts "   OK".bold
+                else
+                  puts "   ERROR".bold.red
+                end
+
+              when :delete
+                print "DELETE".bold.red + " " + item[:consul_key]
+                resp = target.consul.delete(item[:consul_key], dc: target.datacenter)
+                if resp.success?
+                  puts "   OK".bold
+                else
+                  puts "   ERROR".bold.red
+                end
+
+              else
+                if Constancy.config.verbose?
+                  STDERR.puts "constancy: WARNING: unexpected operation '#{item[:op]}' for #{item[:consul_key]}"
+                  next
+                end
+
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/constancy/config.rb

@@ -0,0 +1,161 @@
+# This software is public domain. No rights are reserved. See LICENSE for more information.
+
+class Constancy
+  class ConfigFileNotFound < RuntimeError; end
+  class ConfigFileInvalid < RuntimeError; end
+
+  class Config
+    CONFIG_FILENAMES = %w( constancy.yml )
+    VALID_CONFIG_KEYS = %w( sync consul constancy )
+    VALID_CONSUL_CONFIG_KEYS = %w( url datacenter )
+    VALID_CONSTANCY_CONFIG_KEYS = %w( verbose chomp delete color )
+    DEFAULT_CONSUL_URL = "http://localhost:8500"
+
+    attr_accessor :config_file, :base_dir, :consul, :sync_targets, :target_whitelist
+
+    class << self
+      # discover the nearest config file
+      def discover(dir: nil)
+        dir ||= Dir.pwd
+
+        CONFIG_FILENAMES.each do |filename|
+          full_path = File.join(dir, filename)
+          if File.exist?(full_path)
+            return full_path
+          end
+        end
+
+        dir == "/" ? nil : self.discover(dir: File.dirname(dir))
+      end
+    end
+
+    def initialize(path: nil, targets: nil)
+      if path.nil? or File.directory?(path)
+        self.config_file = Constancy::Config.discover(dir: path)
+      elsif File.exist?(path)
+        self.config_file = path
+      else
+        raise Constancy::ConfigFileNotFound.new
+      end
+
+      if self.config_file.nil? or not File.exist?(self.config_file) or not File.readable?(self.config_file)
+        raise Constancy::ConfigFileNotFound.new
+      end
+
+      self.config_file = File.expand_path(self.config_file)
+      self.base_dir = File.dirname(self.config_file)
+      self.target_whitelist = targets
+      parse!
+    end
+
+    def verbose?
+      @is_verbose
+    end
+
+    def chomp?
+      @do_chomp
+    end
+
+    def delete?
+      @do_delete
+    end
+
+    def color?
+      @use_color
+    end
+
+    private
+
+    def parse!
+      raw = {}
+      begin
+        raw = YAML.load(File.read(self.config_file))
+      rescue
+        raise Constancy::ConfigFileInvalid.new("Unable to parse config file as YAML")
+      end
+
+      if raw.is_a? FalseClass
+        # this generally means an empty config file
+        raw = {}
+      end
+
+      if not raw.is_a? Hash
+        raise Constancy::ConfigFileInvalid.new("Config file must form a hash")
+      end
+
+      if (raw.keys - Constancy::Config::VALID_CONFIG_KEYS) != []
+        raise Constancy::ConfigFileInvalid.new("Only the following keys are valid at the top level of the config: #{Constancy::Config::VALID_CONFIG_KEYS.join(", ")}")
+      end
+
+      raw['consul'] ||= {}
+      if not raw['consul'].is_a? Hash
+        raise Constancy::ConfigFileInvalid.new("'consul' must be a hash")
+      end
+
+      if (raw['consul'].keys - Constancy::Config::VALID_CONSUL_CONFIG_KEYS) != []
+        raise Constancy::ConfigFileInvalid.new("Only the following keys are valid in the consul config: #{Constancy::Config::VALID_CONSUL_CONFIG_KEYS.join(", ")}")
+      end
+
+      consul_url = raw['consul']['url'] || Constancy::Config::DEFAULT_CONSUL_URL
+      consul_token = ENV['CONSUL_HTTP_TOKEN'] || ENV['CONSUL_TOKEN']
+      self.consul = Imperium::Configuration.new(url: consul_url, token: consul_token)
+
+      raw['constancy'] ||= {}
+      if not raw['constancy'].is_a? Hash
+        raise Constancy::ConfigFileInvalid.new("'constancy' must be a hash")
+      end
+
+      if (raw['constancy'].keys - Constancy::Config::VALID_CONSTANCY_CONFIG_KEYS) != []
+        raise Constancy::ConfigFileInvalid.new("Only the following keys are valid in the 'constancy' config block: #{Constancy::Config::VALID_CONSTANCY_CONFIG_KEYS.join(", ")}")
+      end
+
+      # verbose: default false
+      @is_verbose = raw['constancy']['verbose'] ? true : false
+      if ENV['CONSTANCY_VERBOSE']
+        @is_verbose = true
+      end
+
+      # chomp: default true
+      if raw['constancy'].has_key?('chomp')
+        @do_chomp = raw['constancy']['chomp'] ? true : false
+      else
+        @do_chomp = true
+      end
+
+      # delete: default false
+      @do_delete = raw['constancy']['delete'] ? true : false
+
+      raw['sync'] ||= []
+      if not raw['sync'].is_a? Array
+        raise Constancy::ConfigFileInvalid.new("'sync' must be an array")
+      end
+
+      # color: default true
+      if raw['constancy'].has_key?('color')
+        @use_color = raw['constancy']['color'] ? true : false
+      else
+        @use_color = true
+      end
+
+      self.sync_targets = []
+      raw['sync'].each do |target|
+        if target.is_a? Hash
+          target['datacenter'] ||= raw['consul']['datacenter']
+          target['chomp'] ||= self.chomp?
+          target['delete'] ||= self.delete?
+        end
+
+        if not self.target_whitelist.nil?
+          # unnamed targets cannot be whitelisted
+          next if target['name'].nil?
+
+          # named targets must be on the whitelist
+          next if not self.target_whitelist.include?(target['name'])
+        end
+
+        self.sync_targets << Constancy::SyncTarget.new(config: target, imperium_config: self.consul)
+      end
+
+    end
+  end
+end

data/lib/constancy/sync_target.rb

@@ -0,0 +1,259 @@
+# This software is public domain. No rights are reserved. See LICENSE for more information.
+
+class Constancy
+  class SyncTarget
+    VALID_CONFIG_KEYS = %w( name datacenter prefix path exclude chomp delete )
+    attr_accessor :name, :datacenter, :prefix, :path, :exclude, :consul
+
+    REQUIRED_CONFIG_KEYS = %w( prefix )
+
+    def initialize(config:, imperium_config:)
+      if not config.is_a? Hash
+        raise Constancy::ConfigFileInvalid.new("Sync target entries must be specified as hashes")
+      end
+
+      if (config.keys - Constancy::SyncTarget::VALID_CONFIG_KEYS) != []
+        raise Constancy::ConfigFileInvalid.new("Only the following keys are valid in a sync target entry: #{Constancy::SyncTarget::VALID_CONFIG_KEYS.join(", ")}")
+      end
+
+      if (Constancy::SyncTarget::REQUIRED_CONFIG_KEYS - config.keys) != []
+        raise Constancy::ConfigFileInvalid.new("The following keys are required for a sync target entry: #{Constancy::SyncTarget::REQUIRED_CONFIG_KEYS.join(", ")}")
+      end
+
+      self.datacenter = config['datacenter']
+      self.prefix = config['prefix']
+      self.path = config['path'] || config['prefix']
+      self.name = config['name']
+      self.exclude = config['exclude'] || []
+      if config.has_key?('chomp')
+        @do_chomp = config['chomp'] ? true : false
+      end
+      if config.has_key?('delete')
+        @do_delete = config['delete'] ? true : false
+      else
+        @do_delete = false
+      end
+
+      self.consul = Imperium::KV.new(imperium_config)
+    end
+
+    def chomp?
+      @do_chomp
+    end
+
+    def delete?
+      @do_delete
+    end
+
+    def description
+      "#{self.name.nil? ? '' : self.name.bold + "\n"}#{'local'.blue}:#{self.path} => #{'consul'.cyan}:#{self.datacenter.green}:#{self.prefix}"
+    end
+
+    def clear_cache
+      @base_dir = nil
+      @local_files = nil
+      @local_items = nil
+      @remote_items = nil
+    end
+
+    def base_dir
+      @base_dir ||= File.join(Constancy.config.base_dir, self.path)
+    end
+
+    def local_files
+      @local_files ||= Dir["#{self.base_dir}/**/*"].select { |f| File.file?(f) }
+    end
+
+    def local_items
+      return @local_items if not @local_items.nil?
+      @local_items = {}
+
+      self.local_files.each do |local_file|
+        @local_items[local_file.sub(%r{^#{self.base_dir}/?}, '')] = if self.chomp?
+                                                                      File.read(local_file).chomp
+                                                                    else
+                                                                      File.read(local_file)
+                                                                    end
+      end
+
+      @local_items
+    end
+
+    def remote_items
+      return @remote_items if not @remote_items.nil?
+      @remote_items = {}
+
+      resp = self.consul.get(self.prefix, :recurse, dc: self.datacenter)
+
+      Constancy::Util.flatten_hash(resp.values).each_pair do |key, value|
+        @remote_items[key.join("/")] = value
+      end
+
+      @remote_items
+    end
+
+    def diff
+      local = self.local_items
+      remote = self.remote_items
+      all_keys = (local.keys + remote.keys).sort.uniq
+
+      all_keys.collect do |key|
+        excluded = false
+        op = :noop
+        if remote.has_key?(key) and not local.has_key?(key)
+          if self.delete?
+            op = :delete
+          else
+            op = :ignore
+          end
+        elsif local.has_key?(key) and not remote.has_key?(key)
+          op = :create
+        else
+          if remote[key] == local[key]
+            op = :noop
+          else
+            op = :update
+          end
+        end
+
+        consul_key = [self.prefix, key].compact.join("/")
+
+        if self.exclude.include?(key) or self.exclude.include?(consul_key)
+          op = :ignore
+          excluded = true
+        end
+
+        {
+          :op => op,
+          :excluded => excluded,
+          :relative_path => key,
+          :filename => File.join(self.base_dir, key),
+          :consul_key => consul_key,
+          :local_content => local[key],
+          :remote_content => remote[key],
+        }
+      end
+    end
+
+    def items_to_delete
+      self.diff.select { |d| d[:op] == :delete }
+    end
+
+    def items_to_update
+      self.diff.select { |d| d[:op] == :update }
+    end
+
+    def items_to_create
+      self.diff.select { |d| d[:op] == :create }
+    end
+
+    def items_to_ignore
+      self.diff.select { |d| d[:op] == :ignore }
+    end
+
+    def items_to_exclude
+      self.diff.select { |d| d[:op] == :ignore and d[:excluded] == true }
+    end
+
+    def items_to_noop
+      self.diff.select { |d| d[:op] == :noop }
+    end
+
+    def items_to_change
+      self.diff.select { |d| [:delete, :update, :create].include?(d[:op]) }
+    end
+
+    def any_changes?
+      self.items_to_change.count > 0
+    end
+
+    def print_report
+      puts '='*85
+      puts self.description
+
+      puts "  Keys scanned: #{self.diff.count}"
+      if Constancy.config.verbose?
+        puts "  Keys ignored: #{self.items_to_ignore.count}"
+        puts "  Keys in sync: #{self.items_to_noop.count}"
+      end
+
+      puts if self.any_changes?
+
+      self.diff.each do |item|
+        case item[:op]
+        when :create
+          puts "CREATE".bold.green + " #{item[:consul_key]}"
+          puts '-'*85
+          # simulate diff but without complaints about line endings
+          item[:local_content].each_line do |line|
+            puts "+#{line.chomp}".green
+          end
+          puts '-'*85
+
+        when :update
+          puts "UPDATE".bold + " #{item[:consul_key]}"
+          puts '-'*85
+          puts Diffy::Diff.new(item[:remote_content], item[:local_content]).to_s(:color)
+          puts '-'*85
+
+        when :delete
+          if self.delete?
+            puts "DELETE".bold.red + " #{item[:consul_key]}"
+            puts '-'*85
+            # simulate diff but without complaints about line endings
+            item[:remote_content].each_line do |line|
+              puts "-#{line.chomp}".red
+            end
+            puts '-'*85
+          else
+            if Constancy.config.verbose?
+              puts "IGNORE".bold + " #{item[:consul_key]}"
+            end
+          end
+
+        when :ignore
+          if Constancy.config.verbose?
+            puts "IGNORE".bold + " #{item[:consul_key]}"
+          end
+
+        when :noop
+          if Constancy.config.verbose?
+            puts "NO-OP!".bold + " #{item[:consul_key]}"
+          end
+
+        else
+          if Constancy.config.verbose?
+            STDERR.puts "WARNING: unexpected operation '#{item[:op]}' for #{item[:consul_key]}"
+          end
+
+        end
+      end
+
+      if self.items_to_create.count > 0
+        puts
+        puts "Keys to create: #{self.items_to_create.count}".bold
+        self.items_to_create.each do |item|
+          puts "+ #{item[:consul_key]}".green
+        end
+      end
+
+      if self.items_to_update.count > 0
+        puts
+        puts "Keys to update: #{self.items_to_update.count}".bold
+        self.items_to_update.each do |item|
+          puts "~ #{item[:consul_key]}".blue
+        end
+      end
+
+      if self.delete?
+        if self.items_to_delete.count > 0
+          puts
+          puts "Keys to delete: #{self.items_to_delete.count}".bold
+          self.items_to_delete.each do |item|
+            puts "- #{item[:consul_key]}".red
+          end
+        end
+      end
+    end
+  end
+end

data/lib/constancy/version.rb

@@ -0,0 +1,5 @@
+# This software is public domain. No rights are reserved. See LICENSE for more information.
+
+class Constancy
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: constancy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Adams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: imperium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Syncs content from the filesystem to the Consul KV store.
+email: daveadams@gmail.com
+executables:
+- constancy
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/constancy
+- constancy.gemspec
+- lib/constancy.rb
+- lib/constancy/cli.rb
+- lib/constancy/cli/check_command.rb
+- lib/constancy/cli/config_command.rb
+- lib/constancy/cli/push_command.rb
+- lib/constancy/config.rb
+- lib/constancy/sync_target.rb
+- lib/constancy/version.rb
+homepage: https://github.com/daveadams/constancy
+licenses:
+- CC0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Simple filesystem-to-Consul KV synchronization
+test_files: []