chemtrail 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e54ce07e90240967020fa7a8dc856b944338f78e
-  data.tar.gz: 132975f191f9df48d66606e27648852cb29a8608
+  metadata.gz: 0b457fc52081b5875c31d1d124429aa6d438b31a
+  data.tar.gz: 77706788871003cba5307760765b907f986a80e4
 SHA512:
-  metadata.gz: 0cd2a647db49fb8ecef0863955670ea9dadbec2087e68a561376fbd2c4ca5ea3e55eb883fa404a8d17e2f1b180c5dfbc12d49e42b6d1f5d87e88bdf37f541c25
-  data.tar.gz: 22f400b9b20b389bec87ba1951f374cb37cd16a5c72359c8debe4913db6d7528cd3106477fb9ea659873cee5d270d06bd9a18d757a6e6155f2dbf57a73a078d0
+  metadata.gz: cf6193b91a72aeafb284aa0c928c599a04796379af5d90005fa67caed9b5283f442eb076bf0dd22acbb4f773bb151f505975ac82e095ab7a9f39a3d9bfc8ff7b
+  data.tar.gz: d81f93f39b399601bfd3cb96f1bef9314df9e4360f327651a36b9baae7f4635ec11a6c5542fd68d890d88cd894823fad0e7d8d0ad9172d47c7dcb477c14e2a11

data/README.md

@@ -33,6 +33,20 @@ Or install it yourself as:
 Usage
 -----
 
+See the `examples/` directory for examples of subclassing and testing templates.
+
+Listing all available templates in `lib/templates`:
+
+    $ chemtrail list
+
+Listing templates in a different path:
+
+    $ chemtrail list --path lib/taco/panic
+
+Building a template:
+
+    $ chemtrail build crazy:cat:pants
+
 
 Contributing
 ------------

data/bin/chemtrail

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 lib = File.expand_path("../../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "chemtrail"
 require "chemtrail/cli"
 Chemtrail::Cli.start

data/examples/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/examples/Guardfile

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/examples/lib/templates/config/mappings.yml

@@ -0,0 +1,53 @@
+AWSNATAMI:
+  us-east-1:
+    AMI: ami-c6699baf
+  us-west-2:
+    AMI: ami-52ff7262
+  us-west-1:
+    AMI: ami-3bcc9e7e
+  eu-west-1:
+    AMI: ami-0b5b6c7f
+  ap-southeast-1:
+    AMI: ami-02eb9350
+  ap-southeast-2:
+    AMI: ami-ab990e91
+  ap-northeast-1:
+    AMI: ami-14d86d15
+  sa-east-1:
+    AMI: ami-0439e619
+
+AWSInstanceType2Arch:
+  t1.micro:
+    Arch: "64"
+  m1.small:
+    Arch: "64"
+  m1.medium:
+    Arch: "64"
+  m1.large:
+    Arch: "64"
+  m1.xlarge:
+    Arch: "64"
+  m2.xlarge:
+    Arch: "64"
+  m2.2xlarge:
+    Arch: "64"
+  m2.4xlarge:
+    Arch: "64"
+  c1.medium:
+    Arch: "64"
+  c1.xlarge:
+    Arch: "64"
+  cc1.4xlarge:
+    Arch: 64Cluster
+  cc2.8xlarge:
+    Arch: 64Cluster
+  cg1.4xlarge:
+    Arch: 64GPU
+
+SubnetConfig:
+  VPC:
+    CIDR: 10.0.0.0/16
+  Public:
+    CIDR: 10.0.0.0/24
+  Private:
+    CIDR: 10.0.1.0/24

data/examples/lib/templates/config/parameters.yml

@@ -0,0 +1,18 @@
+NATInstanceType:
+  Default: m1.small
+  Description: NAT Device EC2 instance type
+  ConstraintDescription: must be a valid EC2 instance type.
+  AllowedValues:
+    - t1.micro
+    - m1.small
+    - m1.medium
+    - m1.large
+    - m1.xlarge
+    - m2.xlarge
+    - m2.2xlarge
+    - m2.4xlarge
+    - c1.medium
+    - c1.xlarge
+    - cc1.4xlarge
+    - cc2.8xlarge
+    - cg1.4xlarge

data/examples/lib/templates/opsworks_vpc_template.rb

@@ -0,0 +1,44 @@
+require "chemtrail"
+require "yaml"
+
+class OpsworksVpc < Chemtrail::Template
+  def description
+    <<-DESCRIPTION.strip.gsub!(/\s+/, ' ')
+      Sample template showing how to create a VPC environment for AWS OpsWorks.
+      The stack contains 2 subnets: the first subnet is public and contains the
+      load balancer, a NAT device for internet access from the private subnet.
+      The second subnet is private.
+
+      You will be billed for the AWS resources used if you create a stack from
+      this template.
+      DESCRIPTION
+  end
+
+  def parameters
+    [
+      Chemtrail::Parameter.new("NATInstanceType", "String", parameters_config["NATInstanceType"])
+    ]
+  end
+
+  def mappings
+    [
+      Chemtrail::Mapping.new("AWSNATAMI", mappings_config["AWSNATAMI"]),
+      Chemtrail::Mapping.new("AWSInstanceType2Arch", mappings_config["AWSInstanceType2Arch"]),
+      Chemtrail::Mapping.new("SubnetConfig", mappings_config["SubnetConfig"])
+    ]
+  end
+
+  protected
+
+  def parameters_config
+    @parameters_config ||= YAML.load_file(File.expand_path("../config/parameters.yml", __FILE__))
+  end
+
+  def mappings_config
+    @mappings_config ||= YAML.load_file(File.expand_path("../config/mappings.yml", __FILE__))
+  end
+
+  def resources_config
+    @resources_config ||= YAML.load_file(File.expand_path("../config/resources.yml", __FILE__))
+  end
+end

data/examples/spec/lib/templates/opsworks_vpc_template_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe OpsworksVpc do
+  subject(:template) { OpsworksVpc.new }
+
+  its(:description) { should include("VPC environment for AWS OpsWorks") }
+
+  describe "#parameters" do
+    it { should have_parameter("NATInstanceType").with_type("String") }
+
+    it { should have_field("Default").with_value("m1.small").on("NATInstanceType") }
+    it { should have_field("AllowedValues").including("t1.micro").on("NATInstanceType") }
+    it { should have_field("ConstraintDescription").including("valid EC2 instance").on("NATInstanceType") }
+  end
+
+  describe "#mappings" do
+    it { should have_mapping("AWSNATAMI") }
+    it { should have_mapping("AWSInstanceType2Arch") }
+    it { should have_mapping("SubnetConfig") }
+
+    it { should have_mapping_key("us-east-1").including("AMI" => "ami-c6699baf").on("AWSNATAMI") }
+    it { should have_mapping_key("m1.medium").including("Arch" => "64").on("AWSInstanceType2Arch") }
+    it { should have_mapping_key("VPC").including("CIDR" => "10.0.0.0/16").on("SubnetConfig") }
+    it { should have_mapping_key("Public").including("CIDR" => "10.0.0.0/24").on("SubnetConfig") }
+    it { should have_mapping_key("Private").including("CIDR" => "10.0.1.0/24").on("SubnetConfig") }
+  end
+
+  describe "#resources" do
+  end
+end

data/examples/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$:<< File.expand_path("../../../lib", __FILE__)
+
+require "chemtrail"
+require "chemtrail/rspec"
+
+Dir.glob(File.expand_path("../../lib/templates/**/*_template.rb", __FILE__)).each { |t| require t }
+
+RSpec.configure do |config|
+  config.include Chemtrail::RSpec
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end
+

data/lib/chemtrail/cli.rb

@@ -1,5 +1,6 @@
 require "thor"
 require "json"
+require "chemtrail"
 
 class Chemtrail::Cli < Thor
   default_task :list

data/lib/chemtrail/mapping.rb

@@ -3,8 +3,9 @@ require "chemtrail/reference_presenter"
 class Chemtrail::Mapping
   attr_reader :id
 
-  def initialize(id)
+  def initialize(id, entries = nil)
     @id = id
+    @entries = entries
   end
 
   def entries

data/lib/chemtrail/parameter.rb

@@ -1,14 +1,14 @@
 class Chemtrail::Parameter
   attr_reader :id, :type
 
-  def initialize(id, type, specifications = {})
+  def initialize(id, type, fields = {})
     @id = id
     @type = type
-    @specifications = specifications
+    @fields = fields
   end
 
-  def specifications
-    @specifications ||= {}
+  def fields
+    @fields ||= {}
   end
 
   def to_reference
@@ -21,7 +21,7 @@ class Chemtrail::Parameter
     {
       id => {
         "Type" => type
-      }.merge(specifications)
+      }.merge(fields)
     }
   end
 end

data/lib/chemtrail/rspec.rb

@@ -0,0 +1,131 @@
+require "chemtrail"
+require "rspec/expectations"
+
+module Chemtrail::RSpec
+  extend RSpec::Matchers::DSL
+
+  matcher :have_parameter do |parameter_id|
+    define_method :parameter_for do |actual|
+      actual.parameters.detect { |param| param.id == parameter_id }
+    end
+
+    define_method :matches_type? do |actual|
+      @type.nil? || parameter_for(actual).type == @type
+    end
+
+    match do |actual|
+      !parameter_for(actual).nil? && matches_type?(actual)
+    end
+
+    chain :with_type do |type|
+      @type = type
+    end
+
+    failure_message_for_should do |actual|
+      if parameter = parameter_for(actual)
+        %(expected parameter #{parameter_id.inspect} to have type #{@type.inspect}, but got #{parameter.type.inspect})
+      else
+        %(expected to find parameter #{parameter_id.inspect}, but got nothing)
+      end
+    end
+  end
+
+  matcher :have_field do |field_name|
+    define_method :parameter_for do |actual|
+      actual.parameters.detect { |p| p.id == @parameter_id }
+    end
+
+    define_method :field_for do |parameter|
+      parameter.fields[field_name]
+    end
+
+    define_method :matches_value? do |field|
+      if @value
+        field == @value
+      elsif @included_value
+        field.include?(@included_value)
+      else
+        true
+      end
+    end
+
+    match do |actual|
+      parameter = parameter_for(actual)
+      field = field_for(parameter)
+      !parameter.nil? && !field.nil? && matches_value?(field)
+    end
+
+    chain :on do |parameter_id|
+      @parameter_id = parameter_id
+    end
+
+    chain :with_value do |value|
+      @value = value
+    end
+
+    chain :including do |value|
+      @included_value = value
+    end
+
+    failure_message_for_should do |actual|
+      if parameter = parameter_for(actual)
+        if field = field_for(parameter)
+          expected_field = @value || @included_value
+          %(expected parameter #{@parameter_id.inspect} field #{field_name.inspect} to have value #{expected_field.inspect}, but got #{field.inspect})
+        else
+          %(expected parameter #{@parameter_id.inspect} to have type #{field_name.inspect})
+        end
+      else
+        %(expected to find parameter #{@parameter_id.inspect}, but got nothing)
+      end
+    end
+  end
+
+  matcher :have_mapping do |expected|
+    match { |actual| actual.mappings.any? { |m| m.id == expected } }
+  end
+
+  matcher :have_mapping_key do |entry_name|
+    define_method :mapping_for do |actual|
+      actual.mappings.detect { |m| m.id == @mapping_id }
+    end
+
+    define_method :entry_for do |mapping|
+      mapping.entries[entry_name]
+    end
+
+    define_method :matches_value? do |entry|
+      if @included_value
+        entry.values_at(*@included_value.keys) == @included_value.values
+      else
+        true
+      end
+    end
+
+    match do |actual|
+      mapping = mapping_for(actual)
+      entry = entry_for(mapping)
+      !mapping.nil? && !entry.nil? && matches_value?(entry)
+    end
+
+    chain :on do |mapping_id|
+      @mapping_id = mapping_id
+    end
+
+    chain :including do |value|
+      @included_value = value
+    end
+
+    failure_message_for_should do |actual|
+      if mapping = mapping_for(actual)
+        if entry = entry_for(mapping)
+          %(expected mapping #{@mapping_id.inspect} field #{entry_name.inspect} to have value #{@included_value.inspect}, but got #{entry.inspect})
+        else
+          %(expected mapping #{@mapping_id.inspect} to have type #{entry_name.inspect})
+        end
+      else
+        %(expected to find mapping #{@mapping_id.inspect}, but got nothing)
+      end
+    end
+  end
+end

data/lib/chemtrail/version.rb

@@ -1,3 +1,3 @@
 module Chemtrail
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/lib/chemtrail/cli_spec.rb

@@ -5,8 +5,9 @@ describe Chemtrail::Cli do
 
   describe "#list" do
     it "lists available templates" do
-      Kernel.should_receive(:puts).with("tacos")
-      cli.list
+      got_tacos = false
+      Kernel.stub(:puts) { |string| got_tacos ||= (string == "tacos") }
+      expect { cli.list }.to change{ got_tacos }.to(true)
     end
   end
 

data/spec/lib/chemtrail/mapping_spec.rb

@@ -5,13 +5,19 @@ describe Chemtrail::Mapping do
 
   describe "#to_hash" do
     context "when there are no entries" do
-      its(:to_hash) { should have_key "atlas" }
+      its(:to_hash) { should == {"atlas" => {}} }
     end
 
     context "when an entry has been added" do
-      before { mapping.entries["teeth"] = {} }
+      before { mapping.entries[:teeth] = {} }
 
-      specify { mapping.to_hash["atlas"].should have_key "teeth" }
+      specify { mapping.to_hash["atlas"].should == {teeth: {}} }
+    end
+
+    context "when an entry is passed into the initializer" do
+      subject(:mapping) { Chemtrail::Mapping.new("atlas", charles: {}) }
+
+      specify { mapping.to_hash["atlas"].should == {charles: {}} }
     end
   end
 

data/spec/lib/chemtrail/parameter_spec.rb

@@ -3,15 +3,15 @@ require "spec_helper"
 describe Chemtrail::Parameter do
   subject(:parameter) { Chemtrail::Parameter.new("parmesan", "String") }
 
-  describe "#specifications" do
-    context "when there are no specifications" do
-      its(:specifications) { should be_empty }
+  describe "#fields" do
+    context "when there are no fields" do
+      its(:fields) { should be_empty }
     end
 
     context "when a specification has been passed into the initializer" do
       subject(:parameter) { Chemtrail::Parameter.new("parmesan", "String", ok: "great") }
 
-      its(:specifications) { should == {ok: "great"} }
+      its(:fields) { should == {ok: "great"} }
     end
   end
 
@@ -24,7 +24,7 @@ describe Chemtrail::Parameter do
     specify { parameter.to_hash["parmesan"].should include("Type" => "String") }
 
     context "when there is a specification" do
-      before { parameter.specifications[:ducks] = "amazing" }
+      before { parameter.fields[:ducks] = "amazing" }
 
       specify { parameter.to_hash["parmesan"].should include(ducks: "amazing") }
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chemtrail
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Doc Ritezel
@@ -99,6 +99,13 @@ files:
 - README.md
 - bin/chemtrail
 - chemtrail.gemspec
+- examples/.rspec
+- examples/Guardfile
+- examples/lib/templates/config/mappings.yml
+- examples/lib/templates/config/parameters.yml
+- examples/lib/templates/opsworks_vpc_template.rb
+- examples/spec/lib/templates/opsworks_vpc_template_spec.rb
+- examples/spec/spec_helper.rb
 - lib/chemtrail.rb
 - lib/chemtrail/class_name_inflector.rb
 - lib/chemtrail/cli.rb
@@ -109,6 +116,7 @@ files:
 - lib/chemtrail/property_list.rb
 - lib/chemtrail/reference_presenter.rb
 - lib/chemtrail/resource.rb
+- lib/chemtrail/rspec.rb
 - lib/chemtrail/section_presenter.rb
 - lib/chemtrail/template.rb
 - lib/chemtrail/version.rb