sfn-serverspec 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b8afe3d9e73b49ff634ee667f86b20e64ee3d7b
-  data.tar.gz: d99d8bc34c182d9e732b62eb190035ca472195e7
+  metadata.gz: bf48b1b61f92b092cb89a41cb6b0caa476957476
+  data.tar.gz: 81ea86881c7572971cc7e5682afb3f8e3b030560
 SHA512:
-  metadata.gz: 9beffad9fb727f1fd25a4429d52ffe04b9859f4cfbd5c0c0c68d2da706f35fe7c7b03873f1642fa8d742670538e792c19b5caeb2e4f391db26899809ed8e48a4
-  data.tar.gz: 2271aac2052a33acd71c7cf9539fec2d26f9449c25af33636a4efb69d357f575c5242a22ff39096a7453f1b5103e3ae830e11123d1e34d99174855cd2c3a8b0c
+  metadata.gz: 263d927fff74bf6d55987810f67fef88676c59d3e4c51ab5f1559499681261aae1528d98720cd4434753ccd7c13fac884323e3f4d01c83ec8364e4c417bb2220
+  data.tar.gz: 162047b925f2745185f93a865a9592ced40b6ff33b8569f4af1bc7891b00751d140eb7074fc7e5ff76848e7d916b73862073fb76ae6d9f6e33af6a16718df355

data/CHANGELOG.md

@@ -1,2 +1,7 @@
+# v0.1.2
+* Use inherited bogo-ui instance for log messages
+* Fix incorrect scoping of methods on Sfn::Callback instead of Sfn::Callback::ServerspecValidator
+* Add sfn command for running on-demand validation of existing stack
+
 # v0.1.0
 * Initial release

data/README.md

@@ -64,6 +64,51 @@ The following configuration options specified at the resource level will overrid
 * `ssh_key_paths`
 * `ssh_key_passphrase`
 
+### On-demand validation
+
+Provided that you are using Bundler, this callback also adds a `serverspec` command to sfn, enabling on-demand validation of a running stack. You'll want to configure sfn-serverspec thusly:
+
+```ruby
+gem 'sfn-serverspec', :require => 'sfn-serverspec'
+```
+
+The `serverspec` command requires both a stack name and a template to use as the source of Serverspec configuration. The template may be provided via command line flag or interactive file path prompt:
+
+```
+$ bundle exec sfn serverspec example-stack -f sparkleformation/example.rb
+[Sfn]: Callback template serverspec_validator: starting
+[Sfn]: Callback template serverspec_validator: complete
+[Sfn]: Serverspec validating stack example-stack with template sparkleformation/example.rb:
+[Sfn]: Callback after_serverspec serverspec_validator: starting
+[Sfn]: Serverspec validating i-55836892 (10.101.100.15)
+
+base
+Port "22"
+should be listening
+
+hello world
+displays a custom message on the index page
+Port "80"
+should be listening
+
+Finished in 2.92 seconds (files took 10.49 seconds to load)
+3 examples, 0 failures
+
+[Sfn]: Serverspec validating i-52836895 (10.101.100.19)
+
+Port "22"
+should be listening
+
+hello world
+displays a custom message on the index page
+Port "80"
+should be listening
+
+Finished in 0.35415 seconds (files took 13.41 seconds to load)
+3 examples, 0 failures
+
+[Sfn]: Callback after_serverspec serverspec_validator: complete
+```
 
 ## Caveats
 
@@ -71,7 +116,7 @@ Providing `serverspec` configuration on compute resources works in a manner simi
 
 As of this writing, the callback only processes Serverspec configuration on `AWS::AutoScaling::AutoScalingGroup` and `AWS::EC2::Instance` resources.
 
-Non-compute resources with `serverspec` configuration will not be processed by this callback, and will probably cause a validation error when trying to validate or create a stack from the template.
+Non-compute resources with `serverspec` configuration will not be processed by this callback, and will probably yield a validation error when trying to validate or create a stack from the template.
 
 ## Info
 

data/lib/sfn-serverspec.rb

@@ -1,2 +1,4 @@
 require 'sfn-serverspec/version'
 require 'sfn-serverspec/validator'
+require 'sfn-serverspec/command/serverspec'
+require 'sfn-serverspec/config/serverspec'

data/lib/sfn-serverspec/command/serverspec.rb

@@ -0,0 +1,28 @@
+require 'sparkle_formation'
+require 'sfn'
+require 'sfn-serverspec/validator'
+
+module Sfn
+  class Command
+    # Validate command
+    class Serverspec < Command
+      include Sfn::CommandModule::Base
+      include Sfn::CommandModule::Template
+      include Sfn::CommandModule::Stack
+
+      def execute!
+        name_required!
+        stack_name = name_args.last
+        root_stack = stack(stack_name)
+
+        print_only_original = config[:print_only]
+        config[:print_only] = true
+        load_template_file
+        config[:print_only] = print_only_original
+        api_action!(api_stack: root_stack) do
+          ui.info "Serverspec validating stack #{ui.color(root_stack.name, :bold)} with template #{config[:file].sub(Dir.pwd, '').sub(%r{^/}, '')}:" # rubocop:disable LineLength
+        end
+      end
+    end
+  end
+end

data/lib/sfn-serverspec/config/serverspec.rb

@@ -0,0 +1,9 @@
+require 'sfn'
+
+module Sfn
+  class Config
+    # Serverspec command configuration
+    class Serverspec < Validate
+    end
+  end
+end

data/lib/sfn-serverspec/validator.rb

@@ -3,6 +3,7 @@ require 'net/ssh'
 require 'net/ssh/proxy/command'
 require 'rspec'
 require 'rspec/core/formatters/documentation_formatter'
+require 'bogo-config/configuration'
 require 'serverspec'
 require 'sfn'
 
@@ -10,7 +11,7 @@ module Sfn
   # This is an sfn callback
   class Callback
     # Validate stack resources against Serverspec assertions
-    class ServerspecValidator < Callback
+    class ServerspecValidator < Callback # rubocop:disable ClassLength
       # @return [Smash] cached policies
       attr_reader :policies
 
@@ -23,11 +24,6 @@ module Sfn
       end
 
       def after_create(*args)
-        log = Logger.new(STDOUT)
-        log.level = Logger.const_get(
-          config.fetch(:sfn_serverspec, :log_level, :info).to_s.upcase
-        )
-
         policies.each do |resource, r_config|
           resource_config = r_config.dump!.to_smash(:snake)
 
@@ -91,9 +87,9 @@ module Sfn
 
               spec_patterns = global_specs + resource_specs
 
-              log.debug "spec loading patterns: #{spec_patterns.inspect}"
-              log.debug "using SSH proxy commmand #{ssh_proxy_command}" unless ssh_proxy_command.nil?
-              log.info "running specs against #{target_host}"
+              ui.debug "spec loading patterns: #{spec_patterns.inspect}"
+              ui.debug "using SSH proxy commmand #{ssh_proxy_command}" unless ssh_proxy_command.nil?
+              ui.info "Serverspec validating #{instance.id} (#{target_host})"
 
               Specinfra.configuration.backend :ssh
               Specinfra.configuration.request_pty true
@@ -112,12 +108,12 @@ module Sfn
 
               unless ssh_proxy_command.nil?
                 connection_options[:proxy] = Net::SSH::Proxy::Command.new(ssh_proxy_command)
-                log.debug "using ssh proxy command: #{ssh_proxy_command}"
+                ui.debug "using ssh proxy command: #{ssh_proxy_command}"
               end
 
               unless ssh_key_paths.empty?
                 connection_options[:keys] = ssh_key_paths
-                log.debug "using ssh key paths #{connection_options[:keys]} exclusively"
+                ui.debug "using ssh key paths #{connection_options[:keys]} exclusively"
               end
 
               unless ssh_key_passphrase.nil?
@@ -129,45 +125,47 @@ module Sfn
               RSpec::Core::Runner.run(spec_patterns.map { |p| Dir.glob(p) })
 
             rescue => e
-              log.error "Something unexpected happened when running rspec: #{e.inspect}"
+              ui.error "Something unexpected happened when running rspec: #{e.inspect}"
             end
           end
         end
       end
-    end
 
-    COMPUTE_RESOURCE_TYPES = ['AWS::EC2::Instance', 'AWS::AutoScaling::AutoScalingGroup']
+      alias_method :after_serverspec, :after_create
 
-    # Generate policy for stack, collate policies in cache
-    #
-    # @return [nil]
-    def template(info)
-      compiled_stack = info[:sparkle_stack].compile
+      COMPUTE_RESOURCE_TYPES = ['AWS::EC2::Instance', 'AWS::AutoScaling::AutoScalingGroup']
 
-      compiled_stack.resources.keys!.each do |r|
-        r_object = compiled_stack.resources[r]
-        if COMPUTE_RESOURCE_TYPES.include?(r_object['Type']) && r_object['Serverspec']
-          @policies.set(r, r_object.delete!('Serverspec'))
+      # Generate policy for stack, collate policies in cache
+      #
+      # @return [nil]
+      def template(info)
+        compiled_stack = info[:sparkle_stack].compile
+
+        compiled_stack.resources.keys!.each do |r|
+          r_object = compiled_stack.resources[r]
+          if COMPUTE_RESOURCE_TYPES.include?(r_object['Type']) && r_object['Serverspec']
+            @policies.set(r, r_object.delete!('Serverspec'))
+          end
         end
       end
-    end
 
-    private
+      private
 
-    # look up stack resource by name, return array of expanded compute instances
-    #
-    # @param stack [Miasma::Models::Orchestration::Stack]
-    # @param name [String]
-    # @return [Array<Miasma::Models::Compute::Server>]
-    def expand_compute_resource(stack, name)
-      compute_resource = stack.resources.all.detect do |resource|
-        resource.logical_id == name
-      end
+      # look up stack resource by name, return array of expanded compute instances
+      #
+      # @param stack [Miasma::Models::Orchestration::Stack]
+      # @param name [String]
+      # @return [Array<Miasma::Models::Compute::Server>]
+      def expand_compute_resource(stack, name)
+        compute_resource = stack.resources.all.detect do |resource|
+          resource.logical_id == name
+        end
 
-      if compute_resource.within?(:compute, :server)
-        [compute_resource.instance.expand]
-      else
-        compute_resource.expand.servers.map(&:expand)
+        if compute_resource.within?(:compute, :servers)
+          [compute_resource.expand]
+        else
+          compute_resource.expand.servers.map(&:expand)
+        end
       end
     end
   end
@@ -176,7 +174,7 @@ end
 # Override the `#set` method provided by Serverspec to ensure any
 # `spec_helper.rb` files do not clobber our configuration setup
 
-alias :serverspec_set :set
+alias :serverspec_set :set # rubocop:disable Alias
 
 def set(*args)
   serverspec_set(args.first)

data/lib/sfn-serverspec/version.rb

@@ -1,5 +1,5 @@
 # SfnServerspec internal constants
 module SfnServerspec
   # Current version
-  VERSION = Gem::Version.new('0.1.0')
+  VERSION = Gem::Version.new('0.1.2')
 end

data/sfn-serverspec.gemspec

@@ -14,5 +14,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'serverspec', '~> 2.24'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rubocop', '~> 0.35.0'
+  s.add_development_dependency 'pry'
   s.files = Dir['{lib,bin,docs}/**/*'] + %w(sfn-serverspec.gemspec README.md CHANGELOG.md LICENSE)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfn-serverspec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Heavy Water Operations
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-30 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sfn
@@ -72,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.35.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Executes Serverspec assertions against stack compute resources
 email: support@heavywater.io
 executables: []
@@ -82,6 +96,8 @@ files:
 - LICENSE
 - README.md
 - lib/sfn-serverspec.rb
+- lib/sfn-serverspec/command/serverspec.rb
+- lib/sfn-serverspec/config/serverspec.rb
 - lib/sfn-serverspec/validator.rb
 - lib/sfn-serverspec/version.rb
 - sfn-serverspec.gemspec