constancy 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95dfa86b6395376d98383dccb8aaf492a34bea246f8fda4b084144f3bc95e297
-  data.tar.gz: 233a2fcf66cdce878d38cb25f49404c30381c6fe6d9c202e704978fa743303fb
+  metadata.gz: 3119c8dc521f42f974a1f708273026eb49f59c19e25867408aae150dc83261ac
+  data.tar.gz: f6c729bfd5bbf17e29ecd21570076dcf212ae5af999b5f5d89f629216d1c33b0
 SHA512:
-  metadata.gz: '09a3aa2bab4129d27abf9bc6f404fbeed92ef754a1a11876422cbbe8bbbc2127eec94c73d1feb4103ae082a56a5c498daccb5e604f31525f70dc0ef7796e76a8'
-  data.tar.gz: d884c7212d308784b756a3f2900a6658cfc7c766584b7c7f236191f89649e997e0c2d46c2f370e3f8cd6be76f5ff537b32c5ac03019be20697dbd93af1116206
+  metadata.gz: 1928aead12f4a255cc9e8595d3c024b115a30b950fdcefe5df3ab50d35b122ba8340ed7a95f4db15a36b04f8b8f124d10e00467000088d78a1e6e88e72d0c3e0
+  data.tar.gz: f1d991706a3e0883bf2b22f9e53588a1c6472a55376fb424c5ead455a5c704d99bc6966d378deda7d07c648c606941fb5499fa23affd837104e4e1e513362265

data/README.md

@@ -1,11 +1,12 @@
 # constancy
 
-Constancy provides simple filesystem-to-Consul KV synchronization.
+Constancy is a simple, straightforward CLI tool for synchronizing data from the
+filesystem to the Consul KV store and vice-versa.
 
 ## Basic Usage
 
 Run `constancy check` to see what differences exist, and `constancy push` to
-synchronize the changes.
+synchronize the changes from the filesystem to Consul.
 
     $ constancy check
     =====================================================================================
@@ -53,6 +54,16 @@ the `--target` flag:
 
 Run `constancy --help` for additional options and commands.
 
+## Pull Mode
+
+Constancy can also sync _from_ Consul to the local filesystem. This can be
+particularly useful for seeding a git repo with the current contents of a Consul
+KV database.
+
+Run `constancy check --pull` to get a summary of changes, and `constancy pull`
+to actually sync the changes to the local filesystem. Additional arguments such
+as `--target <name>` work in pull mode as well.
+
 
 ## Configuration
 
@@ -142,14 +153,20 @@ required. An example `constancy.yml` is below including explanatory comments:
       #       required if you wish to target specific sync targets using
       #       the `--target` CLI flag.
       #     prefix - (required) The Consul KV prefix to synchronize to.
+      #     type - (default: "dir") The type of local file storage. Either
+      #       'dir' to indicate a directory tree of files corresponding to
+      #       Consul keys; or 'file' to indicate a single YAML file with a
+      #       map of relative key paths to values.
       #     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.
+      #     path - (required) The relative filesystem path to either the
+      #       directory containing the files with content to synchronize
+      #       to Consul if this sync target has type=dir, or the local file
+      #       containing a hash of remote keys if this sync target has
+      #       type=file. 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`.
@@ -172,13 +189,67 @@ required. An example `constancy.yml` is below including explanatory comments:
           - config/myapp/prod/cowboy-yolo
       - name: myapp-private
         prefix: private/myapp
+        type: dir
         datacenter: dc1
         path: consul/private
         delete: true
+      - name: yourapp-config
+        prefix: config/yourapp
+        type: file
+        datacenter: dc1
+        path: consul/yourapp.yml
+        delete: true
 
 You can run `constancy config` to get a summary of the defined configuration
 and to double-check config syntax.
 
+### File sync targets
+
+When using `type: file` for a sync target (see example above), the local path
+should be a YAML (or JSON) file containing a hash of relative key paths to the
+contents of those keys. So for example, given this configuration:
+
+    sync:
+      - name: config
+        prefix: config/yourapp
+        type: file
+        datacenter: dc1
+        path: yourapp.yml
+
+If the file `yourapp.yml` has the following content:
+
+    ---
+    prod/dbname: yourapp
+    prod/message: |
+      Hello, world. This is a multiline message.
+      I hope you like it.
+      Thanks,
+      YourApp
+    prod/app/config.json: |
+      {
+        "port": 8080,
+        "listen": "0.0.0.0",
+        "enabled": true
+      }
+
+Then `constancy push` will attempt to create and/or update the following keys
+with the corresponding content from `yourapp.yml`:
+
+    config/yourapp/prod/dbname
+    config/yourapp/prod/message
+    config/yourapp/prod/app/config.json
+
+Likewise, a `constancy pull` operation will work in reverse, and pull values
+from any keys under `config/yourapp/` into the file `yourapp.yml`, overwriting
+whatever values are there.
+
+Note that JSON is also supported for this file for `push` operations, given that
+YAML parsers will correctly parse JSON. However, `constancy pull` will only
+write out YAML in the current version.
+
+Also important to note that any comments in the YAML file will be lost on a
+`pull` operation that updates a file sync target.
+
 
 ### Dynamic configuration
 
@@ -216,18 +287,17 @@ Constancy may be partially configured using environment variables:
 
 ## Roadmap
 
-Constancy is very new software. There's more to be done. Some ideas:
+Constancy is relatively new software. There's more to be done. Some ideas, which
+may or may not ever be implemented:
 
+* Using CAS to verify the key has not changed in the interim before updating/deleting
+* Automation support for running non-interactively
 * Pattern- and prefix-based exclusions
+* Logging of changes to files, syslog, other services
 * 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
-* Pull mode to sync from Consul to local filesystem
-* Using CAS to verify the key has not changed in the interim before updating/deleting
 * Submitting changes in batches using transactions
-* Optional expansion of YAML or JSON files into multiple keys
 
 
 ## Contributing

data/constancy.gemspec

@@ -27,4 +27,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'imperium', '~>0.3'
   s.add_dependency 'diffy', '~>3.2'
   s.add_dependency 'vault', '~>0.12'
+
+  s.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/constancy.rb

@@ -1,14 +1,19 @@
 # This software is public domain. No rights are reserved. See LICENSE for more information.
 
 require 'erb'
-require 'yaml'
 require 'imperium'
+require 'fileutils'
+require 'ostruct'
+require 'yaml'
 
 require 'constancy/version'
 require 'constancy/config'
+require 'constancy/diff'
 require 'constancy/sync_target'
 
 class Constancy
+  class InternalError < RuntimeError; end
+
   class << self
     @@config = nil
 
@@ -37,8 +42,13 @@ class Constancy
   end
 end
 
-# monkeypatch String for colors
+# monkeypatch String for display prettiness
 class String
+  # trim_path replaces the HOME directory on an absolute path with '~'
+  def trim_path
+    self.sub(%r(^#{ENV['HOME']}), '~')
+  end
+
   def colorize(s,e=0)
     Constancy.config.color? ? "\e[#{s}m#{self}\e[#{e}m" : self
   end

data/lib/constancy/cli.rb

@@ -4,6 +4,7 @@ require 'constancy'
 require 'diffy'
 require 'constancy/cli/check_command'
 require 'constancy/cli/push_command'
+require 'constancy/cli/pull_command'
 require 'constancy/cli/config_command'
 
 class Constancy
@@ -53,6 +54,7 @@ Usage:
 Commands:
   check        Print a summary of changes to be made
   push         Push changes from filesystem to Consul
+  pull         Pull changes from Consul to filesystem
   config       Print a summary of the active configuration
 
 General options:
@@ -60,6 +62,9 @@ General options:
   --config <file>  Use the specified config file
   --target <tgt>   Only apply to the specified target name or names (comma-separated)
 
+Options for 'check' command:
+  --pull       Perform dry run in pull mode
+
 USAGE
         exit 1
       end
@@ -116,8 +121,9 @@ USAGE
 
         when :command
           case self.command
-          when 'check'      then Constancy::CLI::CheckCommand.run
+          when 'check'      then Constancy::CLI::CheckCommand.run(self.extra_args)
           when 'push'       then Constancy::CLI::PushCommand.run
+          when 'pull'       then Constancy::CLI::PullCommand.run
           when 'config'     then Constancy::CLI::ConfigCommand.run
           when nil          then self.print_usage
 

data/lib/constancy/cli/check_command.rb

@@ -4,12 +4,19 @@ class Constancy
   class CLI
     class CheckCommand
       class << self
-        def run
+        def run(args)
           Constancy::CLI.configure
 
+          mode = if args.include?("--pull")
+                   :pull
+                 else
+                   :push
+                 end
+
           Constancy.config.sync_targets.each do |target|
-            target.print_report
-            if not target.any_changes?
+            diff = target.diff(mode)
+            diff.print_report
+            if not diff.any_changes?
               puts "No changes to make for this sync target."
             end
             puts

data/lib/constancy/cli/config_command.rb

@@ -36,7 +36,8 @@ class Constancy
               print '*'
             end
             puts " Datacenter: #{target.datacenter}"
-            puts "   File path: #{target.path}"
+            puts "  Local type: #{target.type == :dir ? 'Directory' : 'Single file'}"
+            puts "   #{target.type == :dir ? " Dir" : "File"} path: #{target.path}"
             puts "      Prefix: #{target.prefix}"
             puts "   Autochomp? #{target.chomp?}"
             puts "      Delete? #{target.delete?}"

data/lib/constancy/cli/pull_command.rb

@@ -0,0 +1,128 @@
+# This software is public domain. No rights are reserved. See LICENSE for more information.
+
+class Constancy
+  class CLI
+    class PullCommand
+      class << self
+        def run
+          Constancy::CLI.configure
+          STDOUT.sync = true
+
+          Constancy.config.sync_targets.each do |target|
+            diff = target.diff(:pull)
+
+            diff.print_report
+
+            if not diff.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 pull these changes?"
+            print "  Enter '" + "yes".bold + "' to continue: "
+            answer = gets.chomp
+
+            if answer.downcase != "yes"
+              puts
+              puts "Pull cancelled. No changes will be made to this sync target."
+              next
+            end
+
+            puts
+            case target.type
+            when :dir then self.pull_dir(diff)
+            when :file then self.pull_file(diff)
+            end
+          end
+        end
+
+        def pull_dir(diff)
+          diff.items_to_change.each do |item|
+            case item.op
+            when :create
+              print "CREATE".bold.green + " " + item.display_filename
+              begin
+                FileUtils.mkdir_p(File.dirname(item.filename))
+                # attempt to write atomically-ish
+                tmpfile = item.filename + ".constancy-tmp"
+                File.open(tmpfile, "w") do |f|
+                  f.write(item.remote_content)
+                end
+                FileUtils.move(tmpfile, item.filename)
+                puts "   OK".bold
+              rescue => e
+                puts "   ERROR".bold.red
+                puts "  #{e}"
+              end
+
+            when :update
+              print "UPDATE".bold.blue + " " + item.display_filename
+              begin
+                # attempt to write atomically-ish
+                tmpfile = item.filename + ".constancy-tmp"
+                File.open(tmpfile, "w") do |f|
+                  f.write(item.remote_content)
+                end
+                FileUtils.move(tmpfile, item.filename)
+                puts "   OK".bold
+              rescue => e
+                puts "   ERROR".bold.red
+                puts "  #{e}"
+              end
+
+            when :delete
+              print "DELETE".bold.red + " " + item.display_filename
+              begin
+                File.unlink(item.filename)
+                puts "   OK".bold
+              rescue => e
+                puts "   ERROR".bold.red
+                puts "  #{e}"
+              end
+
+            else
+              if Constancy.config.verbose?
+                STDERR.puts "constancy: WARNING: unexpected operation '#{item.op}' for #{item.display_filename}"
+                next
+              end
+
+            end
+          end
+        end
+
+        def pull_file(diff)
+          # build and write the file
+          filename_list = diff.items_to_change.collect(&:filename).uniq
+          if filename_list.length != 1
+            raise Constancy::InternalError.new("Multiple filenames found for a 'file' type sync target. Something has gone wrong.")
+          end
+          filename = filename_list.first
+          display_filename = filename.trim_path
+
+          if File.exist?(filename)
+            print "UPDATE".bold.blue + " " + display_filename
+          else
+            print "CREATE".bold.green + " " + display_filename
+          end
+
+          begin
+            FileUtils.mkdir_p(File.dirname(filename))
+            # attempt to write atomically-ish
+            tmpfile = filename + ".constancy-tmp"
+            File.open(tmpfile, "w") do |f|
+              f.write(diff.final_items.to_yaml)
+            end
+            FileUtils.move(tmpfile, filename)
+            puts "   OK".bold
+          rescue => e
+            puts "   ERROR".bold.red
+            puts "  #{e}"
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/constancy/cli/push_command.rb

@@ -9,9 +9,11 @@ class Constancy
           STDOUT.sync = true
 
           Constancy.config.sync_targets.each do |target|
-            target.print_report
+            diff = target.diff(:push)
 
-            if not target.any_changes?
+            diff.print_report
+
+            if not diff.any_changes?
               puts
               puts "Everything is in sync. No changes need to be made to this sync target."
               next
@@ -29,11 +31,11 @@ class Constancy
             end
 
             puts
-            target.items_to_change.each do |item|
-              case item[:op]
+            diff.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)
+                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
@@ -41,8 +43,8 @@ class Constancy
                 end
 
               when :update
-                print "UPDATE".bold.blue + " " + item[:consul_key]
-                resp = target.consul.put(item[:consul_key], item[:local_content], dc: target.datacenter)
+                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
@@ -50,8 +52,8 @@ class Constancy
                 end
 
               when :delete
-                print "DELETE".bold.red + " " + item[:consul_key]
-                resp = target.consul.delete(item[:consul_key], dc: target.datacenter)
+                print "DELETE".bold.red + " " + item.consul_key
+                resp = target.consul.delete(item.consul_key, dc: target.datacenter)
                 if resp.success?
                   puts "   OK".bold
                 else
@@ -60,7 +62,7 @@ class Constancy
 
               else
                 if Constancy.config.verbose?
-                  STDERR.puts "constancy: WARNING: unexpected operation '#{item[:op]}' for #{item[:consul_key]}"
+                  STDERR.puts "constancy: WARNING: unexpected operation '#{item.op}' for #{item.consul_key}"
                   next
                 end
 

data/lib/constancy/config.rb

@@ -251,7 +251,7 @@ class Constancy
           next if not self.target_whitelist.include?(target['name'])
         end
 
-        self.sync_targets << Constancy::SyncTarget.new(config: target, imperium_config: self.consul)
+        self.sync_targets << Constancy::SyncTarget.new(config: target, imperium_config: self.consul, base_dir: self.base_dir)
       end
 
     end

data/lib/constancy/diff.rb

@@ -0,0 +1,209 @@
+# This software is public domain. No rights are reserved. See LICENSE for more information.
+
+class Constancy
+  class Diff
+    def initialize(target:, local:, remote:, mode:)
+      @target = target
+      @local = local
+      @remote = remote
+      @mode = mode
+
+      @all_keys = (@local.keys + @remote.keys).sort.uniq
+
+      @diff =
+        @all_keys.collect do |key|
+          excluded = false
+          op = :noop
+          if @remote.has_key?(key) and not @local.has_key?(key)
+            case @mode
+            when :push
+              op = @target.delete? ? :delete : :ignore
+            when :pull
+              op = :create
+            end
+          elsif @local.has_key?(key) and not @remote.has_key?(key)
+            case @mode
+            when :push
+              op = :create
+            when :pull
+              op = @target.delete? ? :delete : :ignore
+            end
+          else
+            if @remote[key] == @local[key]
+              op = :noop
+            else
+              op = :update
+            end
+          end
+
+          consul_key = [@target.prefix, key].compact.join("/")
+
+          if @target.exclude.include?(key) or @target.exclude.include?(consul_key)
+            op = :ignore
+            excluded = true
+          end
+
+          filename =
+            case @target.type
+            when :dir then File.join(@target.base_path, key)
+            when :file then @target.base_path
+            end
+
+          display_filename =
+            case @target.type
+            when :dir then File.join(@target.base_path, key).trim_path
+            when :file then "#{@target.base_path.trim_path}#{':'.gray}#{key.cyan}"
+            end
+
+          OpenStruct.new(
+            op: op,
+            excluded: excluded,
+            relative_path: key,
+            filename: filename,
+            display_filename: display_filename,
+            consul_key: consul_key,
+            local_content: @local[key],
+            remote_content: @remote[key],
+          )
+        end
+    end
+
+    def items_to_delete
+      @diff.select { |d| d.op == :delete }
+    end
+
+    def items_to_update
+      @diff.select { |d| d.op == :update }
+    end
+
+    def items_to_create
+      @diff.select { |d| d.op == :create }
+    end
+
+    def items_to_ignore
+      @diff.select { |d| d.op == :ignore }
+    end
+
+    def items_to_exclude
+      @diff.select { |d| d.op == :ignore and d.excluded == true }
+    end
+
+    def items_to_noop
+      @diff.select { |d| d.op == :noop }
+    end
+
+    def items_to_change
+      @diff.select { |d| [:delete, :update, :create].include?(d.op) }
+    end
+
+    def final_items
+      case @mode
+      when :push then @local
+      when :pull then @remote
+      end
+    end
+
+    def any_changes?
+      self.items_to_change.count > 0
+    end
+
+    def print_report
+      puts '='*85
+      puts @target.description(@mode)
+
+      puts "  Keys scanned: #{@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?
+
+      from_content_key, to_content_key, to_path_key, to_type_display_name =
+        case @mode
+        when :push then [:local_content, :remote_content, :consul_key, "Keys"]
+        when :pull
+          case @target.type
+          when :dir then [:remote_content, :local_content, :display_filename, "Files"]
+          when :file then [:remote_content, :local_content, :display_filename, "File entries"]
+          end
+        end
+
+      @diff.each do |item|
+        case item.op
+        when :create
+          puts "CREATE".bold.green + " #{item[to_path_key]}"
+          puts '-'*85
+          # simulate diff but without complaints about line endings
+          item[from_content_key].each_line do |line|
+            puts "+#{line.chomp}".green
+          end
+          puts '-'*85
+
+        when :update
+          puts "UPDATE".bold + " #{item[to_path_key]}"
+          puts '-'*85
+          puts Diffy::Diff.new(item[to_content_key], item[from_content_key]).to_s(:color)
+          puts '-'*85
+
+        when :delete
+          if @target.delete?
+            puts "DELETE".bold.red + " #{item[to_path_key]}"
+            puts '-'*85
+            # simulate diff but without complaints about line endings
+            item[to_content_key].each_line do |line|
+              puts "-#{line.chomp}".red
+            end
+            puts '-'*85
+          else
+            if Constancy.config.verbose?
+              puts "IGNORE".bold + " #{item[to_path_key]}"
+            end
+          end
+
+        when :ignore
+          if Constancy.config.verbose?
+            puts "IGNORE".bold + " #{item[to_path_key]}"
+          end
+
+        when :noop
+          if Constancy.config.verbose?
+            puts "NO-OP!".bold + " #{item[to_path_key]}"
+          end
+
+        else
+          if Constancy.config.verbose?
+            STDERR.puts "WARNING: unexpected operation '#{item.op}' for #{item[to_path_key]}"
+          end
+
+        end
+      end
+
+      if self.items_to_create.count > 0
+        puts
+        puts "#{to_type_display_name} to create: #{self.items_to_create.count}".bold
+        self.items_to_create.each do |item|
+          puts "+ #{item[to_path_key]}".green
+        end
+      end
+
+      if self.items_to_update.count > 0
+        puts
+        puts "#{to_type_display_name} to update: #{self.items_to_update.count}".bold
+        self.items_to_update.each do |item|
+          puts "~ #{item[to_path_key]}".blue
+        end
+      end
+
+      if @target.delete?
+        if self.items_to_delete.count > 0
+          puts
+          puts "#{to_type_display_name} to delete: #{self.items_to_delete.count}".bold
+          self.items_to_delete.each do |item|
+            puts "- #{item[to_path_key]}".red
+          end
+        end
+      end
+    end
+  end
+end

data/lib/constancy/sync_target.rb

@@ -2,12 +2,14 @@
 
 class Constancy
   class SyncTarget
-    VALID_CONFIG_KEYS = %w( name datacenter prefix path exclude chomp delete )
-    attr_accessor :name, :datacenter, :prefix, :path, :exclude, :consul
+    VALID_CONFIG_KEYS = %w( name type datacenter prefix path exclude chomp delete )
+    attr_accessor :name, :type, :datacenter, :prefix, :path, :exclude, :consul
 
     REQUIRED_CONFIG_KEYS = %w( prefix )
+    VALID_TYPES = [ :dir, :file ]
+    DEFAULT_TYPE = :dir
 
-    def initialize(config:, imperium_config:)
+    def initialize(config:, imperium_config:, base_dir:)
       if not config.is_a? Hash
         raise Constancy::ConfigFileInvalid.new("Sync target entries must be specified as hashes")
       end
@@ -17,13 +19,23 @@ class Constancy
       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(", ")}")
+        raise Constancy::ConfigFileInvalid.new("The following keys are required in a sync target entry: #{Constancy::SyncTarget::REQUIRED_CONFIG_KEYS.join(", ")}")
       end
 
+      @base_dir = base_dir
       self.datacenter = config['datacenter']
       self.prefix = config['prefix']
       self.path = config['path'] || config['prefix']
       self.name = config['name']
+      self.type = (config['type'] || Constancy::SyncTarget::DEFAULT_TYPE).to_sym
+      unless Constancy::SyncTarget::VALID_TYPES.include?(self.type)
+        raise Constancy::ConfigFileInvalid.new("Sync target '#{self.name || self.path}' has type '#{self.type}'. But only the following types are valid: #{Constancy::SyncTarget::VALID_TYPES.collect(&:to_s).join(", ")}")
+      end
+
+      if self.type == :file and File.directory?(self.base_path)
+        raise Constancy::ConfigFileInvalid.new("Sync target '#{self.name || self.path}' has type 'file', but path '#{self.path}' is a directory.")
+      end
+
       self.exclude = config['exclude'] || []
       if config.has_key?('chomp')
         @do_chomp = config['chomp'] ? true : false
@@ -45,36 +57,49 @@ class Constancy
       @do_delete
     end
 
-    def description
-      "#{self.name.nil? ? '' : self.name.bold + "\n"}#{'local'.blue}:#{self.path} => #{'consul'.cyan}:#{self.datacenter.green}:#{self.prefix}"
+    def description(mode = :push)
+      if mode == :pull
+        "#{self.name.nil? ? '' : self.name.bold + "\n"}#{'consul'.cyan}:#{self.datacenter.green}:#{self.prefix} => #{'local'.blue}:#{self.path}"
+      else
+        "#{self.name.nil? ? '' : self.name.bold + "\n"}#{'local'.blue}:#{self.path} => #{'consul'.cyan}:#{self.datacenter.green}:#{self.prefix}"
+      end
     end
 
     def clear_cache
-      @base_dir = nil
+      @base_path = nil
       @local_files = nil
       @local_items = nil
       @remote_items = nil
     end
 
-    def base_dir
-      @base_dir ||= File.join(Constancy.config.base_dir, self.path)
+    def base_path
+      @base_path ||= File.join(@base_dir, self.path)
     end
 
     def local_files
       # see https://stackoverflow.com/questions/357754/can-i-traverse-symlinked-directories-in-ruby-with-a-glob
-      @local_files ||= Dir["#{self.base_dir}/**{,/*/**}/*"].select { |f| File.file?(f) }
+      @local_files ||= Dir["#{self.base_path}/**{,/*/**}/*"].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.force_encoding(Encoding::ASCII_8BIT)
-                                                                    else
-                                                                      File.read(local_file).force_encoding(Encoding::ASCII_8BIT)
-                                                                    end
+      case self.type
+      when :dir
+        self.local_files.each do |local_file|
+          @local_items[local_file.sub(%r{^#{self.base_path}/?}, '')] =
+            if self.chomp?
+              File.read(local_file).chomp.force_encoding(Encoding::ASCII_8BIT)
+            else
+              File.read(local_file).force_encoding(Encoding::ASCII_8BIT)
+            end
+        end
+
+      when :file
+        if File.exist?(self.base_path)
+          @local_items = YAML.load_file(self.base_path)
+        end
       end
 
       @local_items
@@ -94,168 +119,8 @@ class Constancy
       @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
+    def diff(mode)
+      Constancy::Diff.new(target: self, local: self.local_items, remote: self.remote_items, mode: mode)
     end
   end
 end

data/lib/constancy/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: constancy
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - David Adams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-25 00:00:00.000000000 Z
+date: 2019-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: imperium
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Syncs content from the filesystem to the Consul KV store.
 email: daveadams@gmail.com
 executables:
@@ -67,8 +81,10 @@ files:
 - lib/constancy/cli.rb
 - lib/constancy/cli/check_command.rb
 - lib/constancy/cli/config_command.rb
+- lib/constancy/cli/pull_command.rb
 - lib/constancy/cli/push_command.rb
 - lib/constancy/config.rb
+- lib/constancy/diff.rb
 - lib/constancy/sync_target.rb
 - lib/constancy/version.rb
 homepage: https://github.com/daveadams/constancy