constancy 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3119c8dc521f42f974a1f708273026eb49f59c19e25867408aae150dc83261ac
-  data.tar.gz: f6c729bfd5bbf17e29ecd21570076dcf212ae5af999b5f5d89f629216d1c33b0
+  metadata.gz: d19ad8be143bf52f84efca8bcbec9b3883bba3b840ea77583179a41c03de514c
+  data.tar.gz: 6b403727f5ef73b943b09b33e127b701bf52b95fcfb287900a992198ae0cbbca
 SHA512:
-  metadata.gz: 1928aead12f4a255cc9e8595d3c024b115a30b950fdcefe5df3ab50d35b122ba8340ed7a95f4db15a36b04f8b8f124d10e00467000088d78a1e6e88e72d0c3e0
-  data.tar.gz: f1d991706a3e0883bf2b22f9e53588a1c6472a55376fb424c5ead455a5c704d99bc6966d378deda7d07c648c606941fb5499fa23affd837104e4e1e513362265
+  metadata.gz: 865d4c79c77a83070381ecc61e7cad153bc4c8d540907d15d6798437615171cd061b36816ef0e2327cc7419f6a1f24cb61388e225ffb1646943058025befef5d
+  data.tar.gz: f07b781b03b708fe48c3ff010efcfc2e2df652848561af8bd332651b21368c6454602d52d7058c2600e16ead78f50a9d305e932c724b0f9c2404b05454c9a005

data/README.md

@@ -222,33 +222,92 @@ 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
+      Thanks.
     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
+| `config/yourapp/prod/dbname` | `yourapp` |
+| `config/yourapp/prod/message` | `Hello, world. This is a multiline message.\nThanks.` |
+| `config/yourapp/prod/app/config.json` | `{\n  "port": 8080,\n  "enabled": true\n}` |
 
-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.
+In addition to specifying the entire relative path in each key, you may also
+reference paths via your file's YAML structure directly. For example:
 
-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.
+    ---
+    prod:
+      redis:
+        port: 6380
+        host: redis.example.com
+
+When pushed, this document will create and/or update the following keys:
+
+| `config/yourapp/prod/redis/port` | `6380` |
+| `config/yourapp/prod/redis/host` | `redis.example.com` |
+
+You may mix and match relative paths and document hierarchy to build paths as
+you would like. And you may also use the special key `_` to embed a value for
+a particular prefix while also nesting values underneath it. For example, given
+this local file target content:
+
+    ---
+    prod/postgres:
+      host: db.myproject.example.com
+      port: 10001
+
+    prod:
+      redis:
+        _: Embedded Value
+        port: 6380
+
+    prod/redis/host: cache.myproject.example.com
+
+This file target content would correspond to the following values, when pushed:
+
+| `config/yourapp/prod/postgres/host` | `db.myproject.example.com` |
+| `config/yourapp/prod/postgres/port` | `10001` |
+| `config/yourapp/prod/redis` | `Embedded Value` |
+| `config/yourapp/prod/redis/port` | `6380` |
+| `config/yourapp/prod/redis/host` | `cache.myproject.example.com` |
+
+A `constancy pull` operation against a file type target will work in reverse,
+and pull values from any keys under `config/yourapp/` into the file
+`yourapp.yml`, overwriting whatever values are there.
+
+**NOTE**: Values in local file targets are converted to strings before comparing
+with or uploading to the remote Consul server. However, because YAML parsing
+converts some values (such as `yes` or `no`) to boolean types, the effective
+value of a key with a value of a bare `yes` will be `true` when converted to a
+string. If you need the actual values `yes` or `no`, use quotes around the value
+to force the YAML parser to interpret it as a string.
+
+
+#### IMPORTANT NOTES ABOUT PULL MODE WITH FILE TARGETS
+
+Against a file target, the structure of the local file can vary in a number
+of ways while still producing the same remote structure. Thus, in pull mode,
+Constancy must necessarily choose one particular rendering format, and will not
+be able to retain the exact structure of the local file if you alternate push
+and pull operations.
+
+Specifically, the following caveats are important to note, when pulling a target
+to a local file:
+
+* The local file will be written out as YAML, even if it was originally
+  provided locally as a JSON file, and even if the extension is `.json`.
+
+* Any existing comments in the local file will be lost.
+
+* The document structure will be that of a flat hash will fully-specified
+  relative paths as the keys.
 
-Also important to note that any comments in the YAML file will be lost on a
-`pull` operation that updates a file sync target.
+Future versions of Constancy may provide options to modify the behavior for pull
+operations on a per-target basis. Pull requests are always welcome.
 
 
 ### Dynamic configuration
@@ -291,6 +350,7 @@ 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
+* Options for file target pull-mode rendering
 * Automation support for running non-interactively
 * Pattern- and prefix-based exclusions
 * Logging of changes to files, syslog, other services

data/lib/constancy/cli.rb

@@ -6,6 +6,7 @@ require 'constancy/cli/check_command'
 require 'constancy/cli/push_command'
 require 'constancy/cli/pull_command'
 require 'constancy/cli/config_command'
+require 'constancy/cli/targets_command'
 
 class Constancy
   class CLI
@@ -56,6 +57,7 @@ Commands:
   push         Push changes from filesystem to Consul
   pull         Pull changes from Consul to filesystem
   config       Print a summary of the active configuration
+  targets      List target names
 
 General options:
   --help           Print help for the given command
@@ -125,6 +127,7 @@ USAGE
           when 'push'       then Constancy::CLI::PushCommand.run
           when 'pull'       then Constancy::CLI::PullCommand.run
           when 'config'     then Constancy::CLI::ConfigCommand.run
+          when 'targets'    then Constancy::CLI::TargetsCommand.run
           when nil          then self.print_usage
 
           else

data/lib/constancy/cli/targets_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 TargetsCommand
+      class << self
+        def run
+          Constancy::CLI.configure(call_external_apis: false)
+
+          Constancy.config.sync_targets.each do |target|
+            if target.name
+              puts target.name
+            else
+              puts "[unnamed target] #{target.datacenter}:#{target.prefix}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/constancy/sync_target.rb

@@ -98,7 +98,7 @@ class Constancy
 
       when :file
         if File.exist?(self.base_path)
-          @local_items = YAML.load_file(self.base_path)
+          @local_items = flatten_hash(nil, YAML.load_file(self.base_path))
         end
       end
 
@@ -122,5 +122,26 @@ class Constancy
     def diff(mode)
       Constancy::Diff.new(target: self, local: self.local_items, remote: self.remote_items, mode: mode)
     end
+
+    private def flatten_hash(prefix, hash)
+      new_hash = {}
+
+      hash.each do |k, v|
+        if k == '_' && !prefix.nil?
+          new_key = prefix
+        else
+          new_key = [prefix, k].compact.join('/')
+        end
+
+        case v
+        when Hash
+          new_hash.merge!(flatten_hash(new_key, v))
+        else
+          new_hash[new_key] = v.to_s
+        end
+      end
+
+      new_hash
+    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.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: constancy
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - David Adams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-07 00:00:00.000000000 Z
+date: 2019-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: imperium
@@ -83,6 +83,7 @@ files:
 - lib/constancy/cli/config_command.rb
 - lib/constancy/cli/pull_command.rb
 - lib/constancy/cli/push_command.rb
+- lib/constancy/cli/targets_command.rb
 - lib/constancy/config.rb
 - lib/constancy/diff.rb
 - lib/constancy/sync_target.rb