sfn 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d4a0525d2165a404b2a131f9b1edb470fd2b5b3
-  data.tar.gz: c6640282596fb6f2770b05a3dd8e7a60f6e26312
+  metadata.gz: 9a4ad3f22ad49a059e19e7573ead7e8009934564
+  data.tar.gz: d144714e3d5428c9d2955a1a87a7268055435768
 SHA512:
-  metadata.gz: 3e30c1d2a4470fe271c4bcd6a8dc6affe57fd9d101b68bb19a27ce604f8b54c5515879a1b231c3e8504da639a347504b0c46ba5faa6f23624233840d86ae547e
-  data.tar.gz: 95995a16cc8cb71cae4dc732a9b13833d1c9e16b7d0a55a78e2c2fd660c7668de86c7ecdd1366f961e497e138d2371abae75c0a827fa4d89584fdae33d30a70f
+  metadata.gz: ac2e1b2f887e4608cb4e137c5f61f203b5cd2fff885284a7efd97b8d5a2929e8d19f28259a41f1691080033c378b5891b792957725ecce4b540b36d0e7fe36f9
+  data.tar.gz: c3c7c73efd1e4e65a8671abacb4fd1b1be0d38661b1bd28dc990c1954702b4d4864a233e59b24a4be63941278b5ecb61615e8e157e18137595e637e62a282a1d

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# v2.0.2
+* [task] Remove deprecated capabilities flag (#106)
+* [feature] Add `init` command for project initialization (#107)
+* [enhancement] Add `debug` config option to enable UI debug output (#108)
+* [fix] Fix hash type coerce of strings provided via CLI (#109)
+* [enhancement] Support template parameter processing for supported providers (#110)
+
 # v2.0.0
 * [enhancement] Move to SparkleFormation 2.0
 * [enhancement] Add more credential content to configuration file generator

data/bin/sfn

@@ -4,7 +4,11 @@ require 'bogo-cli'
 require 'sfn'
 
 if(defined?(Bundler))
-  Bundler.require
+  begin
+    Bundler.require
+  rescue Bundler::GemfileNotFound
+    # ignore load error
+  end
 end
 
 Bogo::Cli::Setup.define do

data/lib/sfn/command.rb

@@ -14,6 +14,7 @@ module Sfn
     autoload :Events, 'sfn/command/events'
     autoload :Export, 'sfn/command/export'
     autoload :Import, 'sfn/command/import'
+    autoload :Init, 'sfn/command/init'
     autoload :Inspect, 'sfn/command/inspect'
     autoload :List, 'sfn/command/list'
     autoload :Print, 'sfn/command/print'

data/lib/sfn/command/init.rb

@@ -0,0 +1,57 @@
+require 'sfn'
+require 'fileutils'
+
+module Sfn
+  class Command
+    # Init command
+    class Init < Command
+
+      include Sfn::CommandModule::Base
+
+      INIT_DIRECTORIES = [
+        'sparkleformation/dynamics',
+        'sparkleformation/components',
+        'sparkleformation/registry'
+      ]
+
+      # Run the init command to initialize new project
+      def execute!
+        unless(name_args.size == 1)
+          raise ArgumentError.new 'Please provide path argument only for project initialization'
+        else
+          path = name_args.first
+        end
+        if(File.file?(path))
+          raise "Cannot create project directory. Given path is a file. (`#{path}`)"
+        end
+        if(File.directory?(path))
+          ui.warn "Project directory already exists at given path. (`#{path}`)"
+          ui.confirm 'Overwrite existing files?'
+        end
+        run_action 'Creating base project directories' do
+          INIT_DIRECTORIES.each do |new_dir|
+            FileUtils.mkdir_p(File.join(path, new_dir))
+          end
+          nil
+        end
+        run_action 'Creating project bundle' do
+          File.open(File.join(path, 'Gemfile'), 'w') do |file|
+            file.puts "source 'https://rubygems.org'\n\ngem 'sfn'"
+          end
+          nil
+        end
+        ui.info 'Generating .sfn configuration file'
+        Dir.chdir(path) do
+          Conf.new({:generate => true}, []).execute!
+        end
+        ui.info 'Installing project bundle'
+        Dir.chdir(path) do
+          Bundler.clean_system('bundle install')
+        end
+        ui.info 'Project initialization complete!'
+        ui.puts "  Project path -> #{File.expand_path(path)}"
+      end
+
+    end
+  end
+end

data/lib/sfn/command_module/base.rb

@@ -55,9 +55,9 @@ module Sfn
         # @param e [Exception]
         # @param args [String] extra strings to output
         def _debug(e, *args)
-          if(config[:verbose])
+          if(config[:verbose] || config[:debug])
             ui.fatal "Exception information: #{e.class}: #{e.message}"
-            if(ENV['DEBUG'])
+            if(ENV['DEBUG'] || config[:debug])
               puts "#{e.backtrace.join("\n")}\n"
               if(e.is_a?(Miasma::Error::ApiError))
                 ui.fatal "Response body: #{e.response.body.to_s.inspect}"

data/lib/sfn/command_module/template.rb

@@ -276,7 +276,7 @@ module Sfn
                 config[:nesting_bucket]
               )
               unless(bucket)
-                raise "Failed to locate configured bucket for stack template storage (#{bucket})!"
+                raise "Failed to locate configured bucket for stack template storage (#{config[:nesting_bucket]})!"
               end
               file = bucket.files.build
               file.name = "#{full_stack_name}.json"

data/lib/sfn/config.rb

@@ -19,7 +19,11 @@ module Sfn
           info[:coerce] = lambda do |v|
             case v
             when String
-              Smash[v.split(',').map{|x| v.split(/[=:]/, 2)}]
+              Smash[
+                v.split(',').map do |item_pair|
+                  item_pair.split(/[=:]/, 2)
+                end
+              ]
             when Hash
               v.to_smash
             else
@@ -45,6 +49,7 @@ module Sfn
     autoload :Events, 'sfn/config/events'
     autoload :Export, 'sfn/config/export'
     autoload :Import, 'sfn/config/import'
+    autoload :Init, 'sfn/config/init'
     autoload :Inspect, 'sfn/config/inspect'
     autoload :List, 'sfn/config/list'
     autoload :Print, 'sfn/config/print'
@@ -91,6 +96,11 @@ module Sfn
       :description => 'Automatically accept any requests for confirmation',
       :short_flag => 'y'
     )
+    attribute(
+      :debug, [TrueClass, FalseClass],
+      :description => 'Enable debug output',
+      :short_flag => 'u'
+    )
 
     attribute :conf, Conf, :coerce => proc{|v| Conf.new(v)}
     attribute :create, Create, :coerce => proc{|v| Create.new(v)}

data/lib/sfn/config/create.rb

@@ -16,12 +16,6 @@ module Sfn
         :description => 'Rollback stack on failure',
         :short_flag => 'O'
       )
-      attribute(
-        :capabilities, String,
-        :multiple => true,
-        :description => 'Capabilities to allow the stack',
-        :short_flag => 'B'
-      )
       attribute(
         :options, Smash,
         :description => 'Extra options to apply to the API call',

data/lib/sfn/config/init.rb

@@ -0,0 +1,10 @@
+require 'sfn'
+
+module Sfn
+  class Config
+    # Init command configuration
+    class Init < Config
+
+    end
+  end
+end

data/lib/sfn/utils/debug.rb

@@ -10,7 +10,9 @@ module Sfn
         #
         # @param msg [String]
         def debug(msg)
-          puts "<SparkleFormation>: #{msg}" if ENV['DEBUG']
+          if(ENV['DEBUG'] || (respond_to?(:config) && config[:debug]))
+            puts "<sfn - debug>: #{msg}"
+          end
         end
       end
 

data/lib/sfn/utils/stack_parameter_validator.rb

@@ -9,6 +9,31 @@ module Sfn
 
         include Bogo::AnimalStrings
 
+        # HOT parameter mapping
+        HEAT_CONSTRAINT_MAP = {
+          'MaxLength' => [:length, :max],
+          'MinLength' => [:length, :min],
+          'MaxValue' => [:range, :max],
+          'MinValue' => [:range, :min],
+          'AllowedValues' => [:allowed_values],
+          'AllowedPattern' => [:allowed_pattern]
+        }
+
+        # Parameter mapping identifier and content
+        PARAMETER_DEFINITION_MAP = {
+          'constraints' => HEAT_CONSTRAINT_MAP
+        }
+
+        # Supported parameter validations
+        PARAMETER_VALIDATIONS = [
+          'allowed_values',
+          'allowed_pattern',
+          'max_length',
+          'min_length',
+          'max_value',
+          'min_value'
+        ]
+
         # Validate a parameters
         #
         # @param value [Object] value for parameter
@@ -22,10 +47,14 @@ module Sfn
         # @return [TrueClass, Array<String>] true if valid. array of string errors if invalid
         def validate(value, parameter_definition)
           return [[:blank, 'Value cannot be blank']] if value.to_s.strip.empty?
-          result = %w(AllowedValues AllowedPattern MaxLength MinLength MaxValue MinValue).map do |key|
-            if(parameter_definition[key])
-              res = self.send(snake(key), value, parameter_definition)
-              res == true ? true : [snake(key), res]
+          parameter_definition = reformat_definition(parameter_definition)
+          result = PARAMETER_VALIDATIONS.map do |validator_key|
+            valid_key = parameter_definition.keys.detect do |pdef_key|
+              pdef_key.downcase.gsub('_', '') == validator_key.downcase.gsub('_', '')
+            end
+            if(valid_key)
+              res = self.send(validator_key, value, parameter_definition[valid_key])
+              res == true ? true : [validator_key, res]
             else
               true
             end
@@ -34,6 +63,27 @@ module Sfn
           result.empty? ? true : result
         end
 
+        # Reformat parameter definition with proper keys to allow
+        # validation for templates different parameter definition
+        # layout
+        #
+        # @param pdef [Hash]
+        # @return [Hash]
+        def reformat_definition(pdef)
+          new_def = pdef
+          PARAMETER_DEFINITION_MAP.each do |ident, mapping|
+            if(pdef[ident])
+              new_def = Smash.new
+              mapping.each do |new_key, current_path|
+                if(pdef.get(*current_path))
+                  new_def[new_key] = pdef.get(*current_path)
+                end
+              end
+            end
+          end
+          new_def
+        end
+
         # Parameter is within allowed values
         #
         # @param value [String]
@@ -41,10 +91,10 @@ module Sfn
         # @option pdef [Array<String>] 'AllowedValues'
         # @return [TrueClass, String]
         def allowed_values(value, pdef)
-          if(pdef['AllowedValues'].include?(value))
+          if(pdef.include?(value))
             true
           else
-            "Not an allowed value: #{pdef['AllowedValues'].join(', ')}"
+            "Not an allowed value: #{pdef.join(', ')}"
           end
         end
 
@@ -55,10 +105,10 @@ module Sfn
         # @option pdef [String] 'AllowedPattern'
         # @return [TrueClass, String]
         def allowed_pattern(value, pdef)
-          if(value.match(/#{pdef['AllowedPattern']}/))
+          if(value.match(/#{pdef}/))
             true
           else
-            "Not a valid pattern. Must match: #{pdef['AllowedPattern']}"
+            "Not a valid pattern. Must match: #{pdef}"
           end
         end
 
@@ -69,10 +119,10 @@ module Sfn
         # @option pdef [String] 'MaxLength'
         # @return [TrueClass, String]
         def max_length(value, pdef)
-          if(value.length <= pdef['MaxLength'].to_i)
+          if(value.length <= pdef.to_i)
             true
           else
-            "Value must not exceed #{pdef['MaxLength']} characters"
+            "Value must not exceed #{pdef} characters"
           end
         end
 
@@ -83,10 +133,10 @@ module Sfn
         # @option pdef [String] 'MinLength'
         # @return [TrueClass, String]
         def min_length(value, pdef)
-          if(value.length >= pdef['MinLength'].to_i)
+          if(value.length >= pdef.to_i)
             true
           else
-            "Value must be at least #{pdef['MinLength']} characters"
+            "Value must be at least #{pdef} characters"
           end
         end
 
@@ -97,10 +147,10 @@ module Sfn
         # @option pdef [String] 'MaxValue'
         # @return [TrueClass, String]
         def max_value(value, pdef)
-          if(value.to_i <= pdef['MaxValue'].to_i)
+          if(value.to_i <= pdef.to_i)
             true
           else
-            "Value must not be greater than #{pdef['MaxValue']}"
+            "Value must not be greater than #{pdef}"
           end
         end
 
@@ -111,10 +161,10 @@ module Sfn
         # @option pdef [String] 'MinValue'
         # @return [TrueClass, String]
         def min_value(value, pdef)
-          if(value.to_i >= pdef['MinValue'].to_i)
+          if(value.to_i >= pdef.to_i)
             true
           else
-            "Value must not be less than #{pdef['MinValue']}"
+            "Value must not be less than #{pdef}"
           end
         end
 

data/lib/sfn/version.rb

@@ -1,4 +1,4 @@
 module Sfn
   # Current library version
-  VERSION = Gem::Version.new('2.0.0')
+  VERSION = Gem::Version.new('2.0.2')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfn
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2016-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bogo-cli
@@ -200,6 +200,7 @@ files:
 - lib/sfn/command/events.rb
 - lib/sfn/command/export.rb
 - lib/sfn/command/import.rb
+- lib/sfn/command/init.rb
 - lib/sfn/command/inspect.rb
 - lib/sfn/command/list.rb
 - lib/sfn/command/print.rb
@@ -220,6 +221,7 @@ files:
 - lib/sfn/config/events.rb
 - lib/sfn/config/export.rb
 - lib/sfn/config/import.rb
+- lib/sfn/config/init.rb
 - lib/sfn/config/inspect.rb
 - lib/sfn/config/list.rb
 - lib/sfn/config/print.rb