cardtapp-cloudformation-ruby-dsl 0.0.1.pre.pre1

data/spec/spec_helper.rb

@@ -0,0 +1,161 @@
+require 'fileutils'
+require 'json'
+require 'open3'
+
+##
+# Error encapsulating information about a failed command
+class CommandError < StandardError
+  attr_reader :command, :status, :stderr
+
+  def initialize(command, status, stderr)
+    @command = command
+    @status = status
+    @stderr = stderr
+    super "FAILURE (#{status}) #{stderr}"
+  end
+end
+
+##
+# Helpers for dealing with pathing from specs
+module PathHelpers
+  ##
+  # Returns an absolute path for the specified path that
+  # is relative to the project root irregardless of where
+  # rspec/ruby is invoked
+  def from_project_root(relative_path)
+    source_dir = File.expand_path(File.dirname(__FILE__))
+    File.join(source_dir, "..", relative_path)
+  end
+end
+
+##
+# Mixin containing helper methods for working with
+# commands executed in a subshell
+module CommandHelpers
+  include PathHelpers
+
+  ##
+  # Logs the command that failed and raises an exception
+  # inlcuding status and stderr
+  def cmd_failed(command, status, stderr)
+    STDERR.puts("FAILURE executing #{command}")
+    raise CommandError.new(command, status, stderr)
+  end
+
+  ##
+  # execute a command within a specified directory and
+  # return results or yield them to a block if one is
+  # given to this method.  Results are an array of
+  # strings:
+  #
+  # [stdout, token1, token2, ..., tokenN]
+  #
+  # where stdout is the captured standard output and
+  # the tokens are the words extracted from the output.
+  #
+  # If the command has a non-zero  exit status, an
+  # exception is raised including the exit code
+  # and stderr.
+  #
+  # example call:
+  #   exec_cmd("ls", :within => "/")
+  def exec_cmd(cmd, opts={:within => "."})
+    exec_dir = from_project_root(opts[:within])
+    Dir.chdir(exec_dir) do
+      stdout, stderr, status = Open3.capture3(cmd)
+      results = stdout.split(" ").unshift(stdout)
+
+      cmd_failed(cmd, status, stderr) if status != 0
+      if (block_given?)
+        yield results
+      else
+        results
+      end
+    end
+  end
+end
+
+##
+# Mixin with helper methods for dealing with JSON generated
+# from cloudformation-ruby-dsl
+module JsonHelpers
+  ##
+  # Parse the json string, making sure to write all of it to
+  # STDERR if parsing fails to make it easier to troubleshoot
+  # failures in generated json.
+  def jsparse(json_string)
+    begin
+      JSON.parse(json_string)
+    rescue StandardError => e
+      STDERR.puts "Error parsing JSON:"
+      STDERR.puts json_string
+      raise e
+    end
+  end
+end
+
+##
+# Mixin with helper methods for dealing with files generated
+# from a test/spec
+module FileHelpers
+  include PathHelpers
+
+  ##
+  # Delete a file from the spec/tmp directory
+  def delete_test_file(filename)
+    abs_path = File.join(from_project_root("spec/tmp"), filename)
+    FileUtils.rm(abs_path) if File.exist?(abs_path)
+  end
+
+  ##
+  # Write a file to the spec/tmp directory
+  def write_test_file(filename, contents)
+    dest_dir = from_project_root("spec/tmp")
+    dest_file = File.join(dest_dir, filename)
+
+    FileUtils.mkdir_p(dest_dir)
+    File.open(dest_file, "w") { |f| f.write(contents) }
+    dest_file
+  end
+end
+
+##
+# Mixin to assist in using aws cli for validating results of
+# cloudformation-ruby-dsl
+module AwsHelpers
+  include CommandHelpers
+
+  ##
+  # Validate a cloudformation template within the spec/tmp directory
+  # using aws cli
+  def validate_cfn_template(template_name)
+    template_path = File.join(from_project_root("spec/tmp"), template_name)
+    command = validation_command(template_path)
+    exec_cmd(command) do |output|
+      begin
+        JSON.parse(output.first)
+      rescue JSON::ParserError
+        STDERR.puts "ERROR parsing output of: #{command}"
+        raise
+      end
+    end
+  end
+
+  def profile
+    ENV["AWS_PROFILE"] || "default"
+  end
+
+  def region
+    ENV["AWS_REGION"] || "us-east-1"
+  end
+
+  private
+
+  def validation_command(template_path)
+    return <<-EOF
+      aws cloudformation validate-template --template-body file://#{template_path} \
+                                           --region #{region} \
+                                           --profile #{profile}
+    EOF
+  end
+end

data/spec/validation_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+RSpec.shared_examples "template acceptance validations" do
+  include CommandHelpers
+  include JsonHelpers
+  include FileHelpers
+  include AwsHelpers
+
+  it "should create a valid JSON template from the example ruby template" do
+    delete_test_file(json_template)
+    json = exec_cmd("./#{ruby_template} expand", :within => "examples").first
+    write_test_file(json_template, json)
+    validate_cfn_template(json_template)
+  end
+end
+
+describe "cloudformation-ruby-dsl" do
+  context "simplest template" do
+    let(:ruby_template) { "simple_template.rb" }
+    let(:json_template) { "simple_template.json" }
+
+    include_examples "template acceptance validations"
+  end
+
+  # TODO validate examples/cloudformation-ruby-script.rb
+end

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification
+name: cardtapp-cloudformation-ruby-dsl
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre.pre1
+platform: ruby
+authors:
+- Shawn Smith
+- Dave Barcelo
+- Morgan Fletcher
+- Csongor Gyuricza
+- Igor Polishchuk
+- Nathaniel Eliot
+- Jona Fenocchi
+- Tony Cui
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: detabulator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-cloudformation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !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: Ruby DSL library that provides a wrapper around the CloudFormation.
+email:
+- Shawn.Smith@bazaarvoice.com
+- Dave.Barcelo@bazaarvoice.com
+- Morgan.Fletcher@bazaarvoice.com
+- Csongor.Gyuricza@bazaarvoice.com
+- Igor.Polishchuk@bazaarvoice.com
+- Nathaniel.Eliot@bazaarvoice.com
+- Jona.Fenocchi@bazaarvoice.com
+- Tony.Cui@bazaarvoice.com
+executables:
+- cfntemplate-to-ruby
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- OWNERS
+- PULL_REQUEST_TEMPLATE.md
+- README.md
+- Rakefile
+- bin/cfntemplate-to-ruby
+- cloudformation-ruby-dsl.gemspec
+- docs/Contributing.md
+- docs/Releasing.md
+- examples/cloudformation-ruby-script.rb
+- examples/maps/domains.txt
+- examples/maps/map.json
+- examples/maps/map.rb
+- examples/maps/map.yaml
+- examples/maps/more_maps/map1.json
+- examples/maps/more_maps/map2.json
+- examples/maps/more_maps/map3.json
+- examples/maps/table.txt
+- examples/maps/vpc.txt
+- examples/simple_template.rb
+- examples/userdata.sh
+- initial_contributions.md
+- lib/cloudformation-ruby-dsl.rb
+- lib/cloudformation-ruby-dsl/cfntemplate.rb
+- lib/cloudformation-ruby-dsl/dsl.rb
+- lib/cloudformation-ruby-dsl/spotprice.rb
+- lib/cloudformation-ruby-dsl/table.rb
+- lib/cloudformation-ruby-dsl/version.rb
+- spec/spec_helper.rb
+- spec/validation_spec.rb
+homepage: http://github.com/bazaarvoice/cloudformation-ruby-dsl
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- bin
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Ruby DSL library that provides a wrapper around the CloudFormation.  Written
+  by [Bazaarvoice](http://www.bazaarvoice.com).
+test_files:
+- spec/spec_helper.rb
+- spec/validation_spec.rb