sfn 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb52f9ec870e82eaf0e32aaba64f4c4ea05badf8
-  data.tar.gz: 54939ef76128913964444beb09d72d8c4c4b1447
+  metadata.gz: 1d4a0525d2165a404b2a131f9b1edb470fd2b5b3
+  data.tar.gz: c6640282596fb6f2770b05a3dd8e7a60f6e26312
 SHA512:
-  metadata.gz: 6727eeb62882084fab9f4207f2ccea58160155a16410c6051ff1970e35a70702af087020c972c1c5d40941a5c5917a4fe0b3f5e8351f11aa70574b85ba1d830e
-  data.tar.gz: c7390a1b826f92b231e0b2d6df9f97258a9381824d5e6826d58496ee5044b7c5e9d322f77da7f8c0e878c98ffcfb72c888ef73186826453ad8419628823832ca
+  metadata.gz: 3e30c1d2a4470fe271c4bcd6a8dc6affe57fd9d101b68bb19a27ce604f8b54c5515879a1b231c3e8504da639a347504b0c46ba5faa6f23624233840d86ae547e
+  data.tar.gz: 95995a16cc8cb71cae4dc732a9b13833d1c9e16b7d0a55a78e2c2fd660c7668de86c7ecdd1366f961e497e138d2371abae75c0a827fa4d89584fdae33d30a70f

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v2.0.0
+* [enhancement] Move to SparkleFormation 2.0
+* [enhancement] Add more credential content to configuration file generator
+* [feature] Run Bundler.require if Bundler is detected (#97)
+* [enhancement] Extract provider specific details for abstracts (#98)
+* [enhancement] Add `nesting_prefix` to customize nested template storage path (#99)
+* [fix] Properly display substack planning information
+* [fix] Force minimum width on list columns to prevent bunching on no content
+
 # v1.2.0
 * [fix] Always require packs when loading
 * [fix] Prevent stale output display on update

data/bin/sfn

@@ -3,6 +3,10 @@
 require 'bogo-cli'
 require 'sfn'
 
+if(defined?(Bundler))
+  Bundler.require
+end
+
 Bogo::Cli::Setup.define do
 
   on :v, :version, 'Print version ' do

data/docs/configuration.md

@@ -6,6 +6,8 @@ anchors:
     url: "#sfn-based"
   - title: "knife-based"
     url: "#knife-based"
+  - title: "Generate sfn configuration"
+    url: "#generate-sfn-configuration"
   - title: "configuration-options"
     url: "#configuration-options"
 ---
@@ -34,6 +36,20 @@ Supported formats:
 The configuration is contained within a file named
 `.sfn`.
 
+#### Generate sfn configuration
+
+The `sfn` command provides a `conf` subcommand. By
+default this command will display current local
+configuration values. It can also be used to generate
+an initial configuration file which can then be
+customized:
+
+~~~
+$ sfn conf --generate
+~~~
+
+This will create a new `.sfn` file in the working directory.
+
 ### `knife`-based
 
 The `sfn` application includes a plugin for the
@@ -73,6 +89,10 @@ $ knife sparkleformation --help
 |                            | Valid         | `String`
 |                            | Default       | none
 |----------------------------|---------------|---------------------------------------------------------------
+| `nesting_prefix`           | Description   | Prefix to prepend to template file name within object store
+|                            | Valid         | `String`
+|                            | Default       | none
+|----------------------------|---------------|---------------------------------------------------------------
 | `sparkle_pack`             | Description   | SparklePacks to load
 |                            | Valid         | `Array<String>`
 |                            | Default       | none

data/lib/sfn.rb

@@ -1,6 +1,7 @@
 require 'sfn/version'
 require 'miasma'
 require 'bogo'
+require 'sparkle_formation'
 
 module Sfn
 

data/lib/sfn/command/conf.rb

@@ -59,8 +59,12 @@ module Sfn
 # options, please see:
 # http://www.sparkleformation.io/docs/sfn/configuration.html
 Configuration.new do
+  #   Set style of stack nesting
   apply_nesting 'deep'
+  #   Enable processing of SparkleFormation templates
   processing true
+  #   Provider specific options used when creating
+  #   new stacks. Options defined here are AWS specific.
   options do
     on_failure 'nothing'
     notification_topics []
@@ -69,14 +73,50 @@ Configuration.new do
       creator ENV['USER']
     end
   end
+  #   Name of bucket in object store to hold nested
+  #   stack templates
   # nesting_bucket 'BUCKET_NAME'
+  #   Prefix used on generated template path prior to storage
+  #   in the object store
+  # nesting_prefix 'nested-templates'
+  #   Remote provider credentials
   credentials do
+    #  Remote provider name (:aws, :azure, :open_stack, :rackspace)
     provider :aws
+    #  AWS credentials information
     aws_access_key_id ENV['AWS_ACCESS_KEY_ID']
     aws_secret_access_key ENV['AWS_SECRET_ACCESS_KEY']
     aws_region ENV['AWS_REGION']
     aws_bucket_region ENV['AWS_REGION']
     # aws_sts_role_arn ENV['AWS_STS_ROLE_ARN']
+    #  Eucalyptus related additions
+    # api_endpoint ENV['EUCA_ENDPOINT']
+    # euca_compat 'path'
+    # ssl_enabled false
+    #  Azure credentials information
+    azure_tenant_id ENV['AZURE_TENANT_ID']
+    azure_client_id ENV['AZURE_CLIENT_ID']
+    azure_subscription_id ENV['AZURE_SUBSCRIPTION_ID']
+    azure_client_secret ENV['AZURE_CLIENT_ID']
+    azure_region ENV['AZURE_REGION']
+    azure_blob_account_name ENV['AZURE_BLOB_ACCOUNT_NAME']
+    azure_blob_secret_key ENV['AZURE_BLOB_SECRET_KEY']
+    #  Defaults to "miasma-orchestration-templates"
+    azure_root_orchestration_container ENV['AZURE_ROOT_ORCHESTRATION_CONTAINER']
+    #  OpenStack credentials information
+    open_stack_identity_url ENV['OPENSTACK_IDENTITY_URL']
+    open_stack_username ENV['OPENSTACK_USERNAME']
+    open_stack_user_id ENV['OPENSTACK_USER_ID']
+    open_stack_password ENV['OPENSTACK_PASSWORD']
+    open_stack_token ENV['OPENSTACK_TOKEN']
+    open_stack_region ENV['OPENSTACK_REGION']
+    open_stack_tenant_name ENV['OPENSTACK_TENANT_NAME']
+    open_stack_domain ENV['OPENSTACK_DOMAIN']
+    open_stack_project ENV['OPENSTACK_PROJECT']
+    #  Rackspace credentials information
+    rackspace_api_key ENV['RACKSPACE_API_KEY']
+    rackspace_username ENV['RACKSPACE_USERNAME']
+    rackspace_region ENV['RACKSPACE_REGION']
   end
 end
 EOF

data/lib/sfn/command/create.rb

@@ -14,6 +14,10 @@ module Sfn
       def execute!
         name_required!
         name = name_args.first
+
+        # NOTE: Always disable plans on create
+        config[:plan] = false
+
         if(config[:template])
           file = config[:template]
         else
@@ -78,7 +82,7 @@ module Sfn
                 namespace.const_get(:Describe).new({:outputs => true}, [name]).execute!
               else
                 ui.fatal "Create of new stack #{ui.color(name, :bold)}: #{ui.color('FAILED', :red, :bold)}"
-                raise
+                raise 'Stack did not reach a successful completion state.'
               end
             else
               ui.warn 'Stack state polling has been disabled.'

data/lib/sfn/command/events.rb

@@ -26,7 +26,9 @@ module Sfn
                 events = get_events
                 row(:header => true) do
                   allowed_attributes.each do |attr|
-                    column attr.split('_').map(&:capitalize).join(' '), :width => ((val = events.map{|e| e[attr].to_s.length}.push(attr.length).max + 2) > 70 ? 70 : val)
+                    width_val = events.map{|e| e[attr].to_s.length}.push(attr.length).max + 2
+                    width_val = width_val > 70 ? 70 : width_val < 20 ? 20 : width_val
+                    column attr.split('_').map(&:capitalize).join(' '), :width => width_val
                   end
                 end
                 events.each do |event|

data/lib/sfn/command/list.rb

@@ -13,8 +13,11 @@ module Sfn
           table(:border => false) do
             stacks = get_stacks
             row(:header => true) do
+
               allowed_attributes.each do |attr|
-                column attr.split('_').map(&:capitalize).join(' '), :width => (stacks.map{|s| s[attr].to_s.length}.max || 20) + 2
+                width_val = stacks.map{|e| e[attr].to_s.length}.push(attr.length).max + 2
+                width_val = width_val > 70 ? 70 : width_val < 20 ? 20 : width_val
+                column attr.split('_').map(&:capitalize).join(' '), :width => width_val
               end
             end
             get_stacks.each do |stack|

data/lib/sfn/command/update.rb

@@ -106,7 +106,7 @@ module Sfn
 
             if(config[:plan])
               stack.parameters = original_parameters
-              plan = Planner::Aws.new(ui, config, arguments, stack)
+              plan = build_planner(stack)
               if(plan)
                 result = plan.generate_plan(stack.template, config_root_parameters)
                 display_plan_information(result)
@@ -126,7 +126,7 @@ module Sfn
                   namespace.const_get(:Describe).new({:outputs => true}, [name]).execute!
                 else
                   ui.fatal "Update of stack #{ui.color(name, :bold)}: #{ui.color('FAILED', :red, :bold)}"
-                  raise
+                  raise 'Stack did not reach a successful update completion state.'
                 end
               else
                 ui.warn 'Stack state polling has been disabled.'
@@ -146,9 +146,8 @@ module Sfn
 
       def build_planner(stack)
         klass_name = stack.api.class.to_s.split('::').last
-        klass = Planner.const_get(klass_name)
-        if(klass)
-          klass.new(ui, config, arguments, stack)
+        if(Planner.const_defined?(klass_name))
+          Planner.const_get(klass_name).new(ui, config, arguments, stack)
         else
           warn "Failed to build planner for current provider. No provider implemented. (`#{klass_name}`)"
           nil
@@ -168,7 +167,8 @@ module Sfn
         said_any_things = false
         unless(info[:stacks].empty?)
           info[:stacks].each do |s_name, s_info|
-            said_any_things ||= print_plan_result(s_info, [*names, s_name].compact)
+            result = print_plan_result(s_info, [*names, s_name].compact)
+            said_any_things ||= result
           end
         end
         unless(names.flatten.compact.empty?)

data/lib/sfn/command_module/base.rb

@@ -29,9 +29,9 @@ module Sfn
               )
               result.connection.data[:stack_types] = (
                 [
-                  result.connection.class.const_get(:RESOURCE_MAPPING).detect do |klass, info|
+                  (result.connection.class.const_get(:RESOURCE_MAPPING).detect do |klass, info|
                     info[:api] == :orchestration
-                  end.first
+                  end || []).first
                 ] + custom_stack_types
               ).compact.uniq
               retry_config = config.fetch(:retry,

data/lib/sfn/command_module/stack.rb

@@ -12,6 +12,10 @@ module Sfn
         UNPACK_NAME_JOINER = '-sfn-'
         # maximum number of attempts to get valid parameter value
         MAX_PARAMETER_ATTEMPTS = 5
+        # Template parameter locations
+        TEMPLATE_PARAMETER_LOCATIONS = ['Parameters', 'parameters']
+        # Template parameter default value locations
+        TEMPLATE_PARAMETER_DEFAULTS = ['Default', 'defaultValue', 'default']
 
         # Apply any defined remote stacks
         #
@@ -120,7 +124,9 @@ module Sfn
             stack_parameters = stack_parameters.nil? ? Smash.new : stack_parameters._dump
           else
             parameter_prefix = []
-            stack_parameters = sparkle.fetch('Parameters', Smash.new)
+            stack_parameters = TEMPLATE_PARAMETER_LOCATIONS.map do |loc_key|
+              sparkle[loc_key]
+            end.compact.first || Smash.new
           end
           unless(stack_parameters.empty?)
             if(config.get(:parameter).is_a?(Array))
@@ -175,7 +181,7 @@ module Sfn
                 attempt += 1
                 default = config[:parameters].fetch(
                   ns_k, current_parameters.fetch(
-                    k, v['Default']
+                    k, TEMPLATE_PARAMETER_DEFAULTS.map{|loc_key| v[loc_key]}.compact.first
                   )
                 )
                 if(config[:interactive_parameters])

data/lib/sfn/command_module/template.rb

@@ -90,7 +90,7 @@ module Sfn
               begin
                 SparkleFormation::Sparkle.new(:name => sparkle_name)
               rescue ArgumentError
-                ui.fatal "Failed to properly setup sparkle pack `#{sparkle_pack}`. Check implementation."
+                ui.fatal "Failed to properly setup sparkle pack `#{sparkle_name}`. Check implementation."
                 raise
               end
             end
@@ -236,34 +236,41 @@ module Sfn
         def process_nested_stack_deep(sf, c_stack=nil)
           sf.apply_nesting(:deep) do |stack_name, stack, resource|
             run_callbacks_for(:template, :stack_name => stack_name, :sparkle_stack => stack)
-            stack_definition = stack.compile.dump!
+
             stack_resource = resource._dump
 
             if(stack.parent)
-              current_parameters = stack.parent.compile.dump!.to_smash.fetch('Resources', stack_name, 'Properties', 'Parameters', Smash.new)
+              current_parameters = stack.parent.compile.resources.set!(stack_name).properties.parameters
+              current_parameters = current_parameters.nil? ? Smash.new : current_parameters._dump
             else
               current_parameters = Smash.new
             end
             current_stack = c_stack ? c_stack.nested_stacks.detect{|s| s.data[:logical_id] == stack_name} : nil
             if(current_stack && current_stack.data[:parent_stack])
-              current_parameters.merge!(current_stack.data[:parent_stack].template.fetch('Resources', stack_name, 'Properties', 'Parameters', Smash.new))
+              current_parameters.merge!(
+                current_stack.data[:parent_stack].template.fetch(
+                  'Resources', stack_name, 'Properties', 'Parameters', current_stack.data[:parent_stack].template.fetch(
+                    'resources', stack_name, 'properties', 'parameters', Smash.new
+                  )
+                )
+              )
             end
-            full_stack_name = stack.root_path.map(&:name).map(&:to_s).join('_')
+            full_stack_name = [
+              config[:nesting_prefix],
+              stack.root_path.map(&:name).map(&:to_s).join('_')
+            ].compact.join('/')
             unless(config[:print_only])
               result = Smash.new(
-                'Parameters' => populate_parameters!(stack,
+                :parameters => populate_parameters!(stack,
                   :stack => current_stack,
                   :current_parameters => current_parameters
                 )
               )
-              unless(config[:plan])
-                resource.properties.delete!(:stack)
-              else
-                (stack_definition['Resources'] || {}).each do |_, info|
-                  if(valid_stack_types.include?(info['Type']))
-                    info['Properties'].delete('Stack')
-                  end
-                end
+              hold_stack = resource.properties.delete!(:stack)
+              stack_definition = stack.compile.dump!
+
+              if(config[:plan])
+                resource.properties.stack hold_stack
               end
               bucket = provider.connection.api_for(:storage).buckets.get(
                 config[:nesting_bucket]
@@ -276,21 +283,61 @@ module Sfn
               file.content_type = 'text/json'
               file.body = MultiJson.dump(Sfn::Utils::StackParameterScrubber.scrub!(stack_definition))
               file.save
-              url = URI.parse(file.url)
               result.merge!(
-                'TemplateURL' => "#{url.scheme}://#{url.host}#{url.path}"
+                :url => file.url
               )
             else
               result = Smash.new(
-                'TemplateURL' => "http://example.com/bucket/#{full_stack_name}.json"
+                :url => "http://example.com/bucket/#{full_stack_name}.json"
               )
             end
-            result.each do |k,v|
+            format_nested_stack_results(resource._self.provider, result).each do |k,v|
               resource.properties.set!(k, v)
             end
           end
         end
 
+        # Update the nested stack information for specific provider
+        #
+        # @param provider [Symbol]
+        # @param results [Hash]
+        # @return [Hash]
+        def format_nested_stack_results(provider, results)
+          case provider
+          when :aws
+            if(results[:parameters])
+              results['Parameters'] = results.delete(:parameters)
+            end
+            if(results[:url])
+              url = URI.parse(results.delete(:url))
+              results['TemplateURL'] = "#{url.scheme}://#{url.host}#{url.path}"
+            end
+            results
+          when :heat, :rackspace
+            results[:template] = results.delete(:url)
+            results
+          when :azure
+            if(results[:parameters])
+              results[:parameters] = Smash[
+                results[:parameters].map do |key, value|
+                  [key,
+                    value.is_a?(Hash) ? value : Smash.new(:value => value)]
+                end
+              ]
+            end
+            if(results[:url])
+              results[:templateLink] = Smash.new(
+                :uri => results.delete(:url),
+                :contentVersion => '1.0.0.0'
+              )
+            end
+            results[:mode] = 'Incremental'
+            results
+          else
+            raise "Unknown stack provider value given! `#{provider}`"
+          end
+        end
+
         # Apply template translation
         #
         # @param template [Hash]

data/lib/sfn/config/validate.rb

@@ -55,6 +55,11 @@ module Sfn
         :description => 'Bucket to use for storing nested stack templates',
         :short_flag => 'N'
       )
+      attribute(
+        :nesting_prefix, String,
+        :description => 'File name prefix for storing template in bucket',
+        :short_flag => 'Y'
+      )
       attribute(
         :print_only, [TrueClass, FalseClass],
         :description => 'Print the resulting stack template',

data/lib/sfn/monkey_patch/stack.rb

@@ -18,7 +18,7 @@ module Sfn
       def status_ends_with?(*args)
         stat = status.to_s.downcase
         !!args.map(&:to_s).map(&:downcase).detect do |suffix|
-          stat.end_with?(suffix)
+          stat.end_with?(suffix) || state.to_s.end_with?(suffix)
         end
       end
 
@@ -29,7 +29,7 @@ module Sfn
       def status_starts_with?(*args)
         stat = status.to_s.downcase
         !!args.map(&:to_s).map(&:downcase).detect do |prefix|
-          stat.start_with?(prefix)
+          stat.start_with?(prefix) || state.to_s.start_with?(prefix)
         end
       end
 

data/lib/sfn/version.rb

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

data/sfn.gemspec

@@ -10,27 +10,16 @@ Gem::Specification.new do |s|
   s.description = 'SparkleFormation CLI'
   s.license = 'Apache-2.0'
   s.require_path = 'lib'
-  s.add_dependency 'bogo-cli', '~> 0.1.21'
-  s.add_dependency 'miasma', '~> 0.2.27'
-  s.add_dependency 'miasma-aws', '~> 0.1.16'
-  s.add_dependency 'net-ssh'
-  s.add_dependency 'sparkle_formation', '~> 1.1'
-  s.add_dependency 'hashdiff', '~> 0.2.2'
+  s.add_runtime_dependency 'bogo-cli', '~> 0.1.21'
+  s.add_runtime_dependency 'miasma', '~> 0.2.27'
+  s.add_runtime_dependency 'miasma-aws', '~> 0.2.0'
+  s.add_runtime_dependency 'miasma-azure', '~> 0.1.0'
+  s.add_runtime_dependency 'net-ssh'
+  s.add_runtime_dependency 'sparkle_formation', '~> 2.0'
+  s.add_runtime_dependency 'hashdiff', '~> 0.2.2'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'mocha'
   s.executables << 'sfn'
   s.files = Dir['{lib,bin,docs}/**/*'] + %w(sfn.gemspec README.md CHANGELOG.md LICENSE)
-  s.post_install_message = <<-EOF
-
-This is an install of the sfn gem from the 1.0 release tree. If you
-are upgrading from a pre-1.0 version, please review the CHANGELOG and
-test your environment _before_ continuing on!
-
-* https://github.com/sparkleformation/sfn/blob/master/CHANGELOG.md
-
-Happy stacking!
-
-EOF
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfn
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-05 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bogo-cli
@@ -44,14 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: miasma-azure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: hashdiff
   requirement: !ruby/object:Gem::Requirement
@@ -233,16 +247,7 @@ homepage: http://github.com/sparkleformation/sfn
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: |2+
-
-  This is an install of the sfn gem from the 1.0 release tree. If you
-  are upgrading from a pre-1.0 version, please review the CHANGELOG and
-  test your environment _before_ continuing on!
-
-  * https://github.com/sparkleformation/sfn/blob/master/CHANGELOG.md
-
-  Happy stacking!
-
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib