kitchen-sparkleformation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92ae337395999426b1a24e36f5b4e6f8902de8ba
+  data.tar.gz: 0b581f423224aaa77e2ab0759e01a327bb17d5f9
+SHA512:
+  metadata.gz: dbc1291477d25c3ebeaae2a714d57ce2d32c372eda6e5de763830022ee77e3dd14b43edc32afa9a22e93d32c31bec0c84def1aacb9feb844454c25271f2ff2a3
+  data.tar.gz: 4a2e32b7f48d23c947b2caa2c181aaa043bb5a686d9a8ca828dab71e92830c47385e63e9637e77e9ad225777a27cffa2078077be85ac0096f2e4f7b5f3570f5c

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    kitchen-sparkleformation (0.1)
+      aws-sdk (>= 2, < 3)
+      sparkle_formation (>= 3, < 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    attribute_struct (0.3.4)
+      bogo (>= 0.1.31, < 0.3.0)
+    aws-sdk (2.9.14)
+      aws-sdk-resources (= 2.9.14)
+    aws-sdk-core (2.9.14)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.9.14)
+      aws-sdk-core (= 2.9.14)
+    aws-sigv4 (1.0.0)
+    bogo (0.2.8)
+      hashie
+      multi_json
+    hashie (3.5.5)
+    jmespath (1.3.1)
+    multi_json (1.12.1)
+    sparkle_formation (3.0.20)
+      attribute_struct (>= 0.3.0, < 0.5)
+      bogo
+      multi_json
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  kitchen-sparkleformation!
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -0,0 +1,59 @@
+# SparkleFormation driver for test-kitchen
+
+## Installation
+
+Put this in your Gemfile:
+```ruby
+gem 'kitchen-sparkleformation', git: 'https://github.com/devkid/kitchen-sparkleformation'
+```
+
+and run:
+```
+$ bundle
+```
+
+## Usage
+
+`.kitchen.yml` configuration:
+
+```yaml
+driver:
+  name: sparkleformation
+  stack_name: kitchen-test
+  stack_name_random_suffix: true
+  sparkle_packs:
+    - some_sparkle_pack
+  sparkle_template: my_template_name
+  upload_template: true
+  s3_region: us-west-1
+  s3_bucket: some-bucket
+  s3_path: cloudformation/kitchen-tmp
+  cf_params:
+    some_parameter: some_value
+  cf_options:
+    :disable_rollback: true
+```
+
+## Configuration
+
+| Option                     | Description                                                                                                                                                                           | Default Value        | Required?                        |
+|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|----------------------------------|
+| `stack_name`               | The name of the CloudFormation stack to create.                                                                                                                                       |                      | yes                              |
+| `stack_name_random_suffix` | If true, append a random suffix string to the given stack name.                                                                                                                       | `false`              |                                  |
+| `sparkle_path`             | The path to a directory containing your SparkleFormation template files.                                                                                                              | `'sparkleformation'` |                                  |
+| `sparkle_template`         | The name of the SparkleFormation template to use.                                                                                                                                     |                      | yes                              |
+| `sparkle_state`            | A hash of compile time parameters that are passed to SparkleFormation.                                                                                                                | `{}`                 |                                  |
+| `sparkle_packs`            | Array of SparklePacks to load before compiling the template.                                                                                                                          | `[]`                 |                                  |
+| `upload_template`          | If true, upload the template to S3. Requires `s3_region`, `s3_bucket`.                                                                                                                | `false`              | `true` if using nested templates |
+| `s3_region`                | Region of given S3 bucket.                                                                                                                                                            |                      | if `upload_template` is true     |
+| `s3_bucket`                | Name of an S3 bucket where templates are uploaded to.                                                                                                                                 |                      | if `upload_template` is true     |
+| `s3_path`                  | Path in the S3 bucket where templates are uploaded to.                                                                                                                                |                      | if `upload_template` is true     |
+| `hostname_output`          | Extract the hostname of an instance from the value of the given output.                                                                                                               |                      | no                               |
+| `hostname_resource`        | The stack resource to use to extract the hostname from.                                                                                                                               |                      | no                               |
+| `hostname_attribute`       | The attribute of a the given stack resource to extract the hostname from. Can be `'<physical_resource_id>'` to use the Physical ID of the given stack resource (e.g. Route53 record). |                      | no                               |
+| `cf_params`                | Runtime parameters to pass to CloudFormation stack.                                                                                                                                   | `{}`                 | no                               |
+| `cf_options`               | Additional options to pass to CloudFormation stack creation. See [here](http://docs.aws.amazon.com/sdkforruby/api/Aws/CloudFormation/Client.html#create_stack-instance_method).       | `{}`                 | no                               |
+
+If neither `hostname_output` nor `hostname_resource` is given, the first EC2 instance in the stack is used to extract the hostname.
+
+If `hostname_attribute` is set to something other than `'<physical_resource_id>'`, the given `hostname_resource` must be an EC2 instance. See [here](http://docs.aws.amazon.com/sdkforruby/api/Aws/EC2/Client.html#describe_instances-instance_method) for a list of available attributes. By default, `private_ip_address` is used.

data/kitchen-sparkleformation.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name = 'kitchen-sparkleformation'
+  s.version = "0.1.0"
+  s.licenses = %w(GPL-2.0)
+  s.homepage = 'https://github.com/devkid/kitchen-sparkleformation'
+  s.summary = 'Kitchen driver for SparkleFormation / CloudFormation'
+  s.description = 'Kitchen driver for creating CloudFormation stacks using SparkleFormation templates'
+  s.authors = ['Alfred Krohmer']
+  s.email = 'devkid@gmx.net'
+  s.files = %w(README.md kitchen-sparkleformation.gemspec Gemfile Gemfile.lock) + Dir['lib/**/*']
+  s.add_runtime_dependency 'sparkle_formation', '>= 3', '< 4'
+  s.add_runtime_dependency 'aws-sdk', '>= 2', '< 3'
+end

data/lib/kitchen/driver/sparkleformation.rb

@@ -0,0 +1,184 @@
+require 'aws-sdk'
+require 'sparkle_formation'
+require 'securerandom'
+
+module Kitchen
+  module Driver
+    class Sparkleformation < Kitchen::Driver::Base
+      default_config :stack_name_random_suffix, false
+      default_config :sparkle_path, 'sparkleformation'
+      default_config :sparkle_state, {}
+      default_config :sparkle_packs, []
+      default_config :upload_template, false
+      default_config :cf_options, {}
+      default_config :cf_params, {}
+      default_config :hostname_output, nil
+      default_config :hostname_resource, nil
+      default_config :hostname_attribute, nil
+
+      def initialize(config)
+        init_config config
+        @cf = Aws::CloudFormation::Client.new
+      end
+
+      def create(state)
+        unless state[:stack_id].nil?
+          # will fail if the stack does not exist:
+          @stack_desc = @cf.describe_stacks(stack_name: state[:stack_id]).stacks.first
+
+          case @stack_desc.stack_status
+          when 'CREATE_IN_PROGRESS'
+            @cf.wait_until :stack_create_complete, stack_name: state[:stack_id]
+          when 'CREATE_COMPLETE'
+          else
+            raise "Invalid stack state: #{@stack_desc.stack_status}"
+          end
+
+          if state[:hostname].nil?
+            state[:hostname] = hostname(state[:stack_id])
+          end
+
+          return
+        end
+
+        # generate stack name
+        @stack_name = config[:stack_name]
+        if config[:stack_name_random_suffix]
+          @stack_name << "-#{SecureRandom.hex(6)}"
+        end
+
+        json = generate_cloudformation_template
+
+        if config[:upload_template]
+          url = upload_template @stack_name, json
+        end
+
+        # build options for call to create_stack
+        stack_options = {
+          stack_name:   @stack_name,
+          parameters:   config[:cf_params].map { |k, v| { parameter_key: SparkleFormation.camel(k), parameter_value: v } }
+        }
+        if config[:upload_template]
+          stack_options[:template_url] = url
+        else
+          stack_options[:template_body] = json.to_json
+        end
+        stack_options.merge! config[:cf_options]
+
+        info 'Triggering CloudFormation stack creation'
+        state[:stack_id] = @cf.create_stack(stack_options).stack_id
+
+        info "Waiting for stack #{state[:stack_id]} to reach state CREATE_COMPLETE..."
+        @cf.wait_until :stack_create_complete, stack_name: state[:stack_id]
+        info 'Stack creation finished'
+
+        state[:hostname] = hostname(state[:stack_id])
+      end
+
+      def destroy(state)
+        return if state[:stack_id].nil?
+
+        info 'Triggering CloudFormation stack deletion'
+        @cf.delete_stack stack_name: state[:stack_id]
+
+        info 'Waiting for stack to reach state DELETE_COMPLETE...'
+        @cf.wait_until :stack_delete_complete, stack_name: state[:stack_id]
+
+        info 'Stack deletion finished'
+      end
+
+      private
+
+      def generate_cloudformation_template
+        info 'Generating CloudFormation template'
+
+        SparkleFormation.sparkle_path = config[:sparkle_path]
+
+        formation                     = SparkleFormation.compile(config[:sparkle_template], :sparkle)
+        config[:sparkle_packs].each do |pack|
+          require pack
+          formation.sparkle.add_sparkle SparkleFormation::SparklePack.new name: pack
+        end
+        formation.compile state: config[:sparkle_state]
+
+        # nesting
+        formation.apply_nesting do |stack_name, nested_stack_sfn, original_stack_resource|
+          unless config[:upload_template]
+            raise 'Nested stacks require template upload'
+          end
+
+          info "Generating nested stack template for #{stack_name}"
+          dump = nested_stack_sfn.compile.dump!
+
+          url = upload_template "#{@stack_name}-#{stack_name}", dump
+
+          # update original stack
+          original_stack_resource.properties.delete!(:stack)
+          original_stack_resource.properties.set!('TemplateURL', url)
+        end
+
+        formation.dump
+      end
+
+      def upload_template(stack_name, json)
+        raise 's3_region not given' if config[:s3_region].nil?
+        raise 's3_bucket not given' if config[:s3_bucket].nil?
+        path = "#{config[:s3_path]}/#{stack_name}.json"
+        info "Uploading CloudFormation template to s3://#{config[:s3_bucket]}/#{path}"
+        s3_client = Aws::S3::Client.new(region: config[:s3_region])
+        bucket = Aws::S3::Resource.new(client: s3_client).bucket(config[:s3_bucket])
+        bucket.put_object(
+          key:  path,
+          body: json.to_json
+        ).public_url
+      end
+
+      def stack_resources(stack_id)
+        resources  = []
+        next_token = nil
+        loop do
+          response  = @cf.list_stack_resources(stack_name: stack_id, next_token: next_token)
+          resources += response.stack_resource_summaries
+          break if (next_token = response.next_token).nil?
+        end
+        resources
+      end
+
+      def hostname(stack_id)
+        unless config[:hostname_output].nil?
+          @stack_desc ||= @cf.describe_stacks(stack_name: state[:stack_id]).stacks.first
+          output = @stack_desc.outputs.find { |o| o.output_key == config[:hostname_output] }
+          raise "Output »#{config[:hostname_output]}« not found in stack" if output.nil?
+          return output.output_value
+        end
+
+        resources = stack_resources stack_id
+
+        if config[:hostname_resource].nil?
+          resource = resources.find { |r| r.resource_type == 'AWS::EC2::Instance' }
+          raise 'Stack does not contain an EC2 instance' if resource.nil?
+        else
+          resource = resources.find { |r| r.logical_resource_id == config[:hostname_resource] }
+          raise "Resource »#{config[:hostname_resource]}« not found in stack" if resource.nil?
+        end
+
+        if config[:hostname_attribute] == '<physical_resource_id>'
+          return resource.physical_resource_id
+        end
+
+        unless resource.resource_type == 'AWS::EC2::Instance'
+          raise "Resource »#{config[:hostname_resource]}« is not of type AWS::EC2::Instance"
+        end
+
+        ec2 = Aws::EC2::Client.new
+        instance = ec2.describe_instances(instance_ids: [resource.physical_resource_id]).reservations.first.instances.first
+
+        if config[:hostname_attribute].nil?
+          instance.private_ip_address
+        else
+          instance.send(config[:hostname_attribute].to_sym)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-sparkleformation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alfred Krohmer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sparkle_formation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Kitchen driver for creating CloudFormation stacks using SparkleFormation
+  templates
+email: devkid@gmx.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- kitchen-sparkleformation.gemspec
+- lib/kitchen/driver/sparkleformation.rb
+homepage: https://github.com/devkid/kitchen-sparkleformation
+licenses:
+- GPL-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Kitchen driver for SparkleFormation / CloudFormation
+test_files: []