sfn-parameters 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6402872602c46b70bbb1ce840268256a6a8c7a1e097093478603e5926a907c48
-  data.tar.gz: e49e01025280eedd43e763a4f0069c4df68b468ebfb75a540a672917aa6befba
+  metadata.gz: ae546fd5056dfb22342cebe0403c7347cdd5e280666f178fbd7fbe6d32b10636
+  data.tar.gz: 35e0c98b0fdb9594d2f36233f0bb7c63a7fd8a46124365a600cdbc8e7f689683
 SHA512:
-  metadata.gz: 885f6c47c742135a80f27f81d761def19675ecf12411b58f490fb627f2ee4378be903ef04c95ddb9e59ae2accc3283bc915ce98de0636c063d100526093d4675
-  data.tar.gz: 3b341192e654d45aeac09a8221096ece01b76db70e02e7ae342f0ebc5e4adaa9780341c835f713cfc6ac4023b68908487e1cd3a42283d5c52a0f75eee1f95178
+  metadata.gz: 719f2ea18bf3cba78c0a2134683385bde3d415ed2afec9e886ee40ce823e9e23bb7e0fe499b027c79e36dd38b0e36cd21d48e85c56b421fa65d7f984616d6685
+  data.tar.gz: bfaa545962f8e8701b417924eb8ad1b596aac7572d8adea47a85b364657018fdf74937eedf3c5b7fae23d018da74b6dd30346e9b44e29a0d524fed094fa28421

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.3.0
+* Add support for custom Resolvers (#20)
+
 # v0.2.6
 * Support all valid format types in show subcommand (#14)
 * Apply parameters for all commands (#17)

data/README.md

@@ -244,6 +244,80 @@ $ sfn parameters show my-test-stack
 
 _NOTE: Full paths can also be used when defining parameters file._
 
+## Extending functionality (Resolvers)
+
+Parameters can be fetched from remote locations using Resolvers. Resolvers
+allow parameter values to be dynamically loaded via customized implementations.
+
+### Resolver usage
+
+Parameter values will be loaded via a resolver when the value of the
+parameter is a hash which includes a `resolver` key. The `resolver` key
+identifies the name of the resolver which should be loaded. For example:
+
+~~~json
+{
+  "parameters": {
+    "stack_creator": {
+      "resolver": "my_resolver",
+      "custom_key": "custom_value"
+    }
+  }
+}
+~~~
+
+This will create an instance of the `MyResolver` class and will then
+call the `MyResolver#resolve` with the value `{"custom_key" => "custom_value"}`.
+
+If the value to resolve is not a complex value, the configuration can
+be reduced to a single key/value pair where the key is the name of the
+resolver, and the value is the value to be resolved. This would look like:
+
+~~~json
+{
+  "parameters": {
+    "stack_creator": {
+      "my_resolver": "custom_value"
+    }
+  }
+}
+~~~
+
+This will create an instance of the `MyResolver` class and will then
+call the `MyResolver#resolve` with the value `"custom_value"`.
+
+### Resolver implementation
+
+New resolvers can be created by subclassing the `SfnParameters::Resolver`
+class and implementing a `#resolve` method. An optional `#setup` method
+is available for setting up the instance. This is called during instance
+creation and has the entire sfn configuration available via the `#config`
+method.
+
+~~~ruby
+require "sfn-parameters"
+
+class MyResolver < SfnParameters::Resolver
+  def setup
+    # any custom setup
+  end
+
+  def resolve(value)
+    if value["custom_key"] == "custom_value"
+      "spox"
+    else
+      "unknown"
+    end
+  end
+end
+~~~
+
+### Resolvers
+
+List of known resolvers for sfn-parameters:
+
+*
+
 # Info
 
 * Repository: https://github.com/sparkleformation/sfn-parameters

data/Rakefile

@@ -0,0 +1,47 @@
+require "bundler/setup"
+require "rake/testtask"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = "--pattern test/rspecs/**{,/*/**}/*_rspec.rb"
+end
+
+namespace :rufo do
+  desc "Validate Ruby file formatting"
+  task :validate => [] do
+    base_path = File.dirname(__FILE__)
+    [
+      File.join(base_path, "lib"),
+      File.join(base_path, "test"),
+    ].each do |path|
+      if !system("rufo -c #{path}")
+        $stderr.puts "Files in #{path} directory require formatting!"
+        $stderr.puts "  - Run `rake rufo:fmt`"
+        exit -1
+      end
+    end
+  end
+
+  desc "Format Ruby files in this project"
+  task :fmt => [] do
+    base_path = File.dirname(__FILE__)
+    [
+      File.join(base_path, "lib"),
+      File.join(base_path, "test"),
+    ].each do |path|
+      $stdout.puts "Formatting files in #{path} directory..."
+      system("rufo #{path}")
+      if $?.exitstatus != 0 && $?.exitstatus != 3
+        $stderr.puts "ERROR: Formatting files in #{path} failed!"
+        exit -1
+      end
+    end
+    $stdout.puts " -> File formatting complete!"
+  end
+end
+
+desc "Run all tests"
+task :default => [] do
+  Rake::Task["rufo:validate"].invoke
+  Rake::Task[:spec].invoke
+end

data/lib/sfn-parameters.rb

@@ -1,12 +1,13 @@
-require 'sfn'
+require "sfn"
 
 module SfnParameters
-  autoload :Safe, 'sfn-parameters/safe'
-  autoload :Utils, 'sfn-parameters/utils'
+  autoload :Resolver, "sfn-parameters/resolver"
+  autoload :Safe, "sfn-parameters/safe"
+  autoload :Utils, "sfn-parameters/utils"
 end
 
-require 'sfn-parameters/version'
-require 'sfn-parameters/infrastructure'
-require 'sfn-parameters/stacks'
-require 'sfn-parameters/config'
-require 'sfn-parameters/command'
+require "sfn-parameters/version"
+require "sfn-parameters/infrastructure"
+require "sfn-parameters/stacks"
+require "sfn-parameters/config"
+require "sfn-parameters/command"

data/lib/sfn-parameters/config.rb

@@ -1,4 +1,4 @@
-require 'sfn-parameters'
+require "sfn-parameters"
 
 module Sfn
   class Config

data/lib/sfn-parameters/infrastructure.rb

@@ -4,6 +4,7 @@ module Sfn
   class Callback
     # Auto load stack parameters for infrastructure pattern
     class ParametersInfrastructure < Callback
+      include Bogo::Memoization
       include Sfn::Utils::JSON
       include SfnParameters::Utils
 
@@ -36,7 +37,8 @@ module Sfn
         root_path = config.fetch(:sfn_parameters, :directory, "infrastructure")
         isolation_name = config.fetch(
           :sfn_parameters, :destination,
-          ENV.fetch("SFN_PARAMETERS_DESTINATION", "default"))
+          ENV.fetch("SFN_PARAMETERS_DESTINATION", "default")
+        )
         paths = Dir.glob(File.join(root_path, "#{isolation_name}{#{VALID_EXTENSIONS.join(",")}}")).map(&:to_s)
         if paths.size > 1
           raise ArgumentError.new "Multiple parameter file matches encountered! (#{paths.join(", ")})"
@@ -58,18 +60,18 @@ module Sfn
         end
         hash.fetch(:parameters, {}).each do |key, value|
           key = [*path, key].compact.map(&:to_s).join("__")
-          if current_value = config[:parameters][key]
+          if current_value = config.get(:parameters, key)
             ui.debug "Not setting template parameter `#{key}`. Already set within config. (`#{current_value}`)"
           else
-            config[:parameters][key] = value
+            config.set(:parameters, key, resolve(value))
           end
         end
         hash.fetch(:compile_parameters, {}).each do |key, value|
           key = [*path, key].compact.map(&:to_s).join("__")
-          if current_value = config[:compile_parameters][key]
+          if current_value = config.get(:compile_parameters, key)
             ui.debug "Not setting compile time parameter `#{key}`. Already set within config. (`#{current_value}`)"
           else
-            config[:compile_parameters][key] = value
+            config.set(:compile_parameters, key, resolve(value))
           end
         end
         hash.fetch(:stacks, {}).each do |key, value|
@@ -77,13 +79,64 @@ module Sfn
         end
         hash.fetch(:mappings, {}).each do |key, value|
           value = [*path, Bogo::Utility.camel(value)].compact.map(&:to_s).join("__")
-          config[:apply_mapping][key] = value
+          config.set(:apply_mapping, key, value)
         end
         hash.fetch(:apply_stacks, []).each do |s_name|
           config[:apply_stack] << s_name
         end
+        config[:apply_stack].uniq!
         true
       end
+
+      # Load value via resolver if defined
+      #
+      # @param value [Object]
+      # @return [Object]
+      def resolve(value)
+        resolver, value = extract_resolver_information(value)
+        if resolver
+          resolver.resolve(value)
+        else
+          value
+        end
+      end
+
+      # Extract resolver name and data from value object
+      #
+      # @param value [Object]
+      # @return [Resolver, Object]
+      def extract_resolver_information(value)
+        if value.is_a?(Hash)
+          if value.size == 1
+            begin
+              r_name, val = value.to_a.flatten
+              resolver = load_resolver(Bogo::Utility.camel(r_name))
+              return resolver, val
+            rescue NameError
+              return nil, value
+            end
+          elsif value.to_smash.key?(:resolver)
+            val = value.to_smash
+            r_name = val.delete(:resolver)
+            resolver = load_resolver(Bogo::Utility.camel(r_name))
+            return resolver, val
+          else
+            return nil, value
+          end
+        end
+        return nil, value
+      end
+
+      # Load given resolver
+      #
+      # @param resolver_name [String]
+      # @return [Resolver]
+      def load_resolver(resolver_name)
+        memoize(resolver_name) do
+          klass = SfnParameters::Resolver.detect_resolver(resolver_name)
+          klass.new(config)
+        end
+      end
     end
   end
 end

data/lib/sfn-parameters/resolver.rb

@@ -0,0 +1,68 @@
+require "sfn-parameters"
+
+module SfnParameters
+  # Parameter resolver
+  class Resolver
+    @@resolvers = {}
+
+    # :nodoc:
+    # Used only for testing
+    def self.reset!
+      @@resolvers.clear
+    end
+
+    # :nodoc:
+    def self.inherited(klass)
+      if klass.name.nil?
+        raise ArgumentError.new("Unnamed classes are not supported")
+      end
+      klass_key = Bogo::Utility.snake(klass.name).gsub("::", "_")
+      @@resolvers[klass_key] = klass
+    end
+
+    # @return [Array<Resolver>]
+    def self.resolvers
+      @@resolvers.values
+    end
+
+    # Find resolver that matches given name
+    #
+    # @param name [String] resolver identifier name
+    # @return [Resolver] resolver class
+    # @raises [NameError]
+    def self.detect_resolver(name)
+      name = Bogo::Utility.snake(name).gsub("::", "_")
+      @@resolvers.each do |klass_name, klass|
+        return klass if klass_name.end_with?(name)
+      end
+      raise NameError.new("Unknown resolver requested `#{name}` - #{resolvers}")
+    end
+
+    # @return [Hash] sfn config
+    attr_reader :config
+
+    # Resolver initialization. It is provided
+    # the configuration from sfn to allow for
+    # any required customizations
+    #
+    # @param config [Hash] sfn config
+    # @return [self]
+    def initialize(config)
+      @config = config
+      setup
+    end
+
+    # Run any required setup for the resolver
+    def setup; end
+
+    # Resolve the given value. Value will be
+    # a Hash type but should be validated
+    # locally
+    #
+    # @param value [Hash]
+    # @return [Object]
+    def resolve(value)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/sfn-parameters/safe.rb

@@ -1,10 +1,9 @@
-require 'sfn-parameters'
+require "sfn-parameters"
 
 module SfnParameters
   # Safe storage
   class Safe
-
-    autoload :Ssl, 'sfn-parameters/safe/ssl'
+    autoload :Ssl, "sfn-parameters/safe/ssl"
 
     # @return [Hash] safe configuration
     attr_reader :arguments
@@ -13,7 +12,7 @@ module SfnParameters
     #
     # @param args [Hash]
     # @return [self]
-    def initialize(args={})
+    def initialize(args = {})
       @arguments = args.to_smash
     end
 
@@ -40,17 +39,15 @@ module SfnParameters
       # @param args [Hash] arguments for safe instance
       # @option args [String] :type type of safe
       # @return [Safe]
-      def build(args={})
+      def build(args = {})
         args = args.to_smash
-        type = Bogo::Utility.camel(args.fetch(:type, 'ssl'))
-        if(const_defined?(type))
+        type = Bogo::Utility.camel(args.fetch(:type, "ssl"))
+        if const_defined?(type)
           const_get(type).new(args)
         else
           raise ArgumentError.new "Unknown safe type provided `#{type}`."
         end
       end
-
     end
-
   end
 end

data/lib/sfn-parameters/safe/ssl.rb

@@ -1,4 +1,4 @@
-require 'sfn-parameters'
+require "sfn-parameters"
 
 module SfnParameters
   # Safe storage
@@ -8,11 +8,11 @@ module SfnParameters
     class Ssl < Safe
 
       # Default cipher
-      DEFAULT_CIPHER='AES-256-CBC'
+      DEFAULT_CIPHER = "AES-256-CBC"
       # Maximum computation iteration length
-      CRYPT_ITER=10000
+      CRYPT_ITER = 10000
       # Default length of generated key
-      CRYPT_KEY_LENGTH=32
+      CRYPT_KEY_LENGTH = 32
 
       # Create OpenSSL backed safe
       #
@@ -25,11 +25,11 @@ module SfnParameters
       # @return [self]
       def initialize(*_)
         super
-        unless(arguments[:salt])
+        unless arguments[:salt]
           arguments[:salt] = OpenSSL::Random.random_bytes(16)
         end
-        unless(arguments[:key])
-          raise ArgumentError.new 'Required `:key` argument unset for `Safe::Ssl`!'
+        unless arguments[:key]
+          raise ArgumentError.new "Required `:key` argument unset for `Safe::Ssl`!"
         end
       end
 
@@ -47,7 +47,7 @@ module SfnParameters
           :cipher => arguments.fetch(:cipher, DEFAULT_CIPHER),
           :content => Base64.urlsafe_encode64(result),
           :salt => Base64.urlsafe_encode64(arguments[:salt]),
-          :sfn_parameters_lock => Bogo::Utility.snake(self.class.name.split('::').last)
+          :sfn_parameters_lock => Bogo::Utility.snake(self.class.name.split("::").last),
         )
       end
 
@@ -60,6 +60,11 @@ module SfnParameters
       # @return [String]
       def unlock(value)
         value = value.to_smash
+        [:content, :iv, :salt].each do |key|
+          unless value[key]
+            raise ArgumentError.new("Missing required information `#{key}`")
+          end
+        end
         o_cipher = arguments[:cipher]
         arguments[:cipher] = value[:cipher] if value[:cipher]
         cipher = build(
@@ -78,7 +83,7 @@ module SfnParameters
       # @param iv [String] initialization vector
       # @param salt [String] random value
       # @return [OpenSSL::Cipher]
-      def build(salt=nil, iv=nil)
+      def build(salt = nil, iv = nil)
         cipher = OpenSSL::Cipher.new(arguments[:cipher] || DEFAULT_CIPHER)
         iv ? cipher.decrypt : cipher.encrypt
         key = OpenSSL::PKCS5.pbkdf2_hmac_sha1(
@@ -91,7 +96,6 @@ module SfnParameters
         cipher.key = key
         cipher
       end
-
     end
   end
 end

data/lib/sfn-parameters/stacks.rb

@@ -14,7 +14,7 @@ module Sfn
         paths = Dir.glob(File.join(root_path, "#{stack_name}{#{VALID_EXTENSIONS.join(",")}}")).map(&:to_s)
         if paths.size > 1
           raise ArgumentError.new "Multiple parameter file matches encountered! (#{paths.join(", ")})"
-        elsif (paths.empty?)
+        elsif paths.empty?
           Smash.new
         else
           unlock_content(Bogo::Config.new(paths.first).data)

data/lib/sfn-parameters/utils.rb

@@ -1,4 +1,4 @@
-require 'sfn-parameters'
+require "sfn-parameters"
 
 module SfnParameters
   # Common helper methods
@@ -23,7 +23,7 @@ module SfnParameters
     # @return [Hash] unlocked content
     def unlock_content(content)
       content = content.to_smash
-      if(content[:sfn_parameters_lock])
+      if content[:sfn_parameters_lock]
         safe = SfnParameters::Safe.build(
           config.fetch(:sfn_parameters, :safe, Smash.new)
         )
@@ -32,6 +32,5 @@ module SfnParameters
         content
       end
     end
-
   end
 end

data/lib/sfn-parameters/version.rb

@@ -1,3 +1,3 @@
 module SfnParameters
-  VERSION = Gem::Version.new("0.2.6")
+  VERSION = Gem::Version.new("0.3.0")
 end

data/sfn-parameters.gemspec

@@ -1,15 +1,18 @@
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
-require 'sfn-parameters/version'
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + "/lib/"
+require "sfn-parameters/version"
 Gem::Specification.new do |s|
-  s.name = 'sfn-parameters'
+  s.name = "sfn-parameters"
   s.version = SfnParameters::VERSION.version
-  s.summary = 'SparkleFormation Parameters Callback'
-  s.author = 'Chris Roberts'
-  s.email = 'code@chrisroberts.org'
-  s.homepage = 'http://github.com/sparkleformation/sfn-parameters'
-  s.description = 'SparkleFormation Parameters Callback'
-  s.license = 'Apache-2.0'
-  s.require_path = 'lib'
-  s.add_dependency 'sfn', '>= 3.0', '< 4.0'
-  s.files = Dir['{lib,bin,docs}/**/*'] + %w(sfn-parameters.gemspec README.md CHANGELOG.md LICENSE)
+  s.summary = "SparkleFormation Parameters Callback"
+  s.author = "Chris Roberts"
+  s.email = "code@chrisroberts.org"
+  s.homepage = "http://github.com/sparkleformation/sfn-parameters"
+  s.description = "SparkleFormation Parameters Callback"
+  s.license = "Apache-2.0"
+  s.require_path = "lib"
+  s.add_runtime_dependency "sfn", ">= 3.0", "< 4.0"
+  s.add_development_dependency "rake", "~> 10"
+  s.add_development_dependency "rspec", "~> 3.5"
+  s.add_development_dependency "rufo", "~> 0.3.0"
+  s.files = Dir["{lib,bin,docs}/**/*"] + %w(sfn-parameters.gemspec README.md CHANGELOG.md LICENSE Rakefile)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfn-parameters
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-22 00:00:00.000000000 Z
+date: 2018-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sfn
@@ -30,6 +30,48 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rufo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 description: SparkleFormation Parameters Callback
 email: code@chrisroberts.org
 executables: []
@@ -39,10 +81,12 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- Rakefile
 - lib/sfn-parameters.rb
 - lib/sfn-parameters/command.rb
 - lib/sfn-parameters/config.rb
 - lib/sfn-parameters/infrastructure.rb
+- lib/sfn-parameters/resolver.rb
 - lib/sfn-parameters/safe.rb
 - lib/sfn-parameters/safe/ssl.rb
 - lib/sfn-parameters/stacks.rb