stemcell 0.5.0 → 0.6.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YWQxNmQ0NDdkNGMzZmRlMzVhOTMzNzJjODFlMDIyZTFkZjUyY2RiNA==
+  data.tar.gz: !binary |-
+    Y2RmNDdjNDZjNzIxNDIyNWE1MWNlMDZmZWM3ZWYxZjA2NzVjYWI0Nw==
+SHA512:
+  metadata.gz: !binary |-
+    NmRjOGQwOGVhMjFiZDZiNDVhZWQ3OGE2YTczOTU5MjhhOWNmZTdkYTIzYzYw
+    OGJmZGExMzM2YmRhMWQ0YTVjZTAzYjJmOTA2N2U2YTEyMGE1OTBmNGM1ODUz
+    YjU4N2EyMzFjNmE4ZDNjYTMwYTg1NGQ5MWNiOTRlNzUwZGQ0MTA=
+  data.tar.gz: !binary |-
+    OGY3NzRhYjY0ZTc1OGI2N2RmN2FlZWEwMGUxYmY1NjU0YWZmMjc0N2YyYWRi
+    ZjZmZTc1NGQ2OTRkYWNmMjUxM2JiOWRmZGRkNzg2ZGNlN2JkOTg5MjAyYzA4
+    MDI5YzQ4NzgxYmEzNmJlNjAzN2ZmNTExMTM1N2E5ZTU5NmQ3NDc=

data/Gemfile

@@ -2,3 +2,9 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in stemcell.gemspec
 gemspec
+
+group :test do
+  gem 'rspec', '~> 2.14.1'
+  gem 'rspec-instafail', '~> 0.2.4'
+  gem 'simplecov', :require => false
+end

data/Gemfile.lock

@@ -34,6 +34,7 @@ GEM
       rest-client (>= 1.0.4, < 1.7.0)
       yajl-ruby (~> 1.1)
     colored (1.2)
+    diff-lcs (1.2.5)
     erubis (2.7.0)
     highline (1.6.19)
     ipaddress (0.8.0)
@@ -45,6 +46,7 @@ GEM
     mixlib-config (1.1.2)
     mixlib-log (1.6.0)
     mixlib-shellout (1.1.0)
+    multi_json (1.8.2)
     net-ssh (2.7.0)
     net-ssh-gateway (1.2.0)
       net-ssh (>= 2.6.5)
@@ -62,6 +64,19 @@ GEM
       yajl-ruby
     rest-client (1.6.7)
       mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-instafail (0.2.4)
+    rspec-mocks (2.14.4)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
     systemu (2.5.2)
     trollop (2.0)
     uuidtools (2.1.4)
@@ -71,4 +86,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  rspec (~> 2.14.1)
+  rspec-instafail (~> 0.2.4)
+  simplecov
   stemcell!

data/lib/stemcell/command_line.rb

@@ -70,12 +70,12 @@ module Stemcell
 
     def initialize_launcher
       @launcher = MetadataLauncher.new(:chef_root => chef_root)
-    rescue NoTemplateError
+    rescue MissingMetadataConfigError
       puts "Couldn't find `stemcell.json` in the local chef repo.".red
       puts "You must specify the root of the local checkout of your chef " \
            "respository by using the --local-chef-root options or " \
            "setting the LOCAL_CHEF_ROOT environment variable."
-    rescue TemplateParseError => e
+    rescue MetadataConfigParseError => e
       error "Couldn't parse the `stemcell.json` file: #{e.message}"
     end
 

data/lib/stemcell/errors.rb

@@ -2,8 +2,9 @@ module Stemcell
   # This is the class from which all stemcell errors descend.
   class Error < StandardError; end
 
-  class NoTemplateError < Error; end
-  class TemplateParseError < Error; end
+  class MissingMetadataConfigError < Error; end
+  class MetadataConfigParseError < Error; end
+
   class RoleExpansionError < Error; end
   class EmptyRoleError < Error; end
 

data/lib/stemcell/metadata_source/chef_repository.rb

@@ -0,0 +1,55 @@
+require 'chef'
+
+module Stemcell
+  class MetadataSource
+
+    class ChefRepository
+      include Chef::Mixin::DeepMerge
+
+      attr_reader :chef_root
+
+      # Search for instance metadata in the following role attributes, with
+      # priority given to the keys at the head.
+      METADATA_ATTRIBUTES = [
+        :instance_metadata,
+        :stemcell
+      ]
+
+      def initialize(chef_root)
+        @chef_root = chef_root
+        if chef_root.nil?
+          raise ArgumentError, "You must specify a chef repository"
+        end
+
+        configure_chef
+      end
+
+      # This method will return nil if the role has no stemcell metdata.
+      def metadata_for_role(chef_role, chef_environment)
+        default_attrs, override_attrs = expand_role(chef_role, chef_environment)
+        merged_attrs = deep_merge!(override_attrs, default_attrs)
+        METADATA_ATTRIBUTES.inject(nil) { |r, key| r || merged_attrs[key] }
+      end
+
+      private
+
+      def configure_chef
+        Chef::Config[:cookbook_path] = File.join(chef_root, 'cookbooks')
+        Chef::Config[:data_bag_path] = File.join(chef_root, 'data_bags')
+        Chef::Config[:role_path]     = File.join(chef_root, 'roles')
+      end
+
+      def expand_role(chef_role, chef_environment)
+        run_list = Chef::RunList.new
+        run_list << "role[#{chef_role}]"
+
+        expansion = run_list.expand(chef_environment, 'disk')
+        raise RoleExpansionError if expansion.errors?
+
+        [expansion.default_attrs, expansion.override_attrs]
+      end
+
+    end
+
+  end
+end

data/lib/stemcell/metadata_source/configuration.rb

@@ -0,0 +1,77 @@
+require 'json'
+
+module Stemcell
+  class MetadataSource
+
+    class Configuration
+      attr_reader :config_path
+
+      attr_reader :all_options
+      attr_reader :default_options
+      attr_reader :backing_store_options
+      attr_reader :availability_zones
+
+      def initialize(config_path)
+        @config_path = config_path
+        if config_path.nil?
+          raise ArgumentError, "You must specify a configuration file"
+        end
+
+        read_configuration
+        validate_configutation
+      end
+
+      def options_for_backing_store(backing_store)
+        options = backing_store_options[backing_store]
+        raise UnknownBackingStoreError.new(backing_store) if options.nil?
+        options
+      end
+
+      def random_az_for_region(region)
+        (availability_zones[region] || []).sample
+      end
+
+      private
+
+      def read_configuration
+        begin
+          @all_options = JSON.parse(File.read(config_path))
+        rescue Errno::ENOENT
+          raise Stemcell::MissingMetadataConfigError
+        rescue => e
+          raise Stemcell::MetadataConfigParseError, e.message
+        end
+
+        @default_options       = @all_options['defaults']
+        @backing_store_options = @all_options['backing_store']
+        @availability_zones    = @all_options['availability_zones']
+      end
+
+      def validate_configutation
+        errors = []
+
+        if default_options.nil?
+          errors << "missing required section 'defaults'; " \
+                    "should be a hash containing default launch options"
+        end
+
+        if backing_store_options.nil? || backing_store_options.empty?
+          errors << "missing or empty section 'backing_store'"
+          errors << "'backing_store' should be a hash from " \
+                    "store type (like 'ebs') => hash of options for that store"
+        end
+
+        if availability_zones.nil?
+          errors << "missing or empty section 'availability_zones'"
+          errors << "'availability_zones' should be a hash from " \
+                    "region name => list of allowed zones in that region"
+        end
+
+        unless errors.empty?
+          raise Stemcell::MetadataConfigParseError, errors.join("; ")
+        end
+      end
+    end
+
+  end
+end

data/lib/stemcell/metadata_source.rb

@@ -1,10 +1,18 @@
-require 'chef'
-require 'json'
+require 'stemcell/metadata_source/chef_repository'
+require 'stemcell/metadata_source/configuration'
 
 module Stemcell
   class MetadataSource
+    include Chef::Mixin::DeepMerge
+
     attr_reader :chef_root
-    attr_reader :default_options
+    attr_reader :config_filename
+
+    attr_reader :config
+    attr_reader :chef_repo
+
+    DEFAULT_CONFIG_FILENAME = 'stemcell.json'
+    DEFAULT_BACKING_STORE = 'instance_store'
 
     DEFAULT_OPTIONS = {
       'chef_environment' => 'production',
@@ -14,23 +22,23 @@ module Stemcell
       'instance_domain_name' => '',
     }
 
-    # Search for instance metadata in the following role attributes, with
-    # priority given to the keys at the head.
-    METADATA_ATTRIBUTES = [
-      :instance_metadata,
-      :stemcell
-    ]
-
-    def initialize(chef_root)
+    def initialize(chef_root, config_filename=DEFAULT_CONFIG_FILENAME)
       @chef_root = chef_root
+      @config_filename = config_filename
 
-      raise ArgumentError, "You must specify a chef root" unless chef_root
+      if chef_root.nil?
+        raise ArgumentError, "You must specify a chef repository"
+      end
+      if config_filename.nil?
+        raise ArgumentError, "You must specify a configuration file"
+      end
 
-      template_options = read_template
-      @default_options = DEFAULT_OPTIONS.merge(template_options['defaults'])
+      @config = Configuration.new(File.join(chef_root, config_filename))
+      @chef_repo = ChefRepository.new(chef_root)
+    end
 
-      @all_backing_store_options = template_options['backing_store']
-      @all_azs_by_region = template_options['availability_zones']
+    def default_options
+      DEFAULT_OPTIONS.merge(config.default_options)
     end
 
     def expand_role(role, environment, override_options={}, options={})
@@ -38,104 +46,49 @@ module Stemcell
       raise ArgumentError, "Missing chef environment" unless environment
       allow_empty_roles = options.fetch(:allow_empty_roles, false)
 
-      role_options = expand_role_options(role, environment)
+      # Step 1: Expand the role metadata
+
+      role_options = chef_repo.metadata_for_role(role, environment)
       role_empty   = role_options.nil? || role_options.empty?
 
       raise EmptyRoleError if !allow_empty_roles && role_empty
 
-      backing_store_options =
-        expand_backing_store_options(
-            default_options,
-            role_options,
-            override_options
-          )
-
-      # Merge all the options together in priority order
-      merged_options = default_options.dup
-      merged_options.deep_merge!(backing_store_options)
-      merged_options.deep_merge!(role_options) if role_options
-      merged_options.deep_merge!(override_options)
-
-      # Add the AZ if not specified
-      if (region = merged_options['region'])
-        merged_options['availability_zone'] ||= random_az_in_region(region)
-      end
+      # Step 2: Determine the backing store from available options.
 
-      # The chef environment and role used to expand the runlist takes
-      # priority over all other options.
-      merged_options['chef_environment'] = environment
-      merged_options['chef_role']        = role
+      # This is determined distinctly from the merge sequence below because
+      # the backing store options must be available to the operation.
 
-      merged_options
-    end
+      backing_store   = override_options['backing_store']
+      backing_store ||= role_options.to_hash['backing_store'] if role_options
+      backing_store ||= config.default_options['backing_store']
+      backing_store ||= DEFAULT_BACKING_STORE
 
-    private
+      # Step 3: Retrieve the backing store options from the defaults.
 
-    def read_template
-      begin
-        template_path = File.join(chef_root, 'stemcell.json')
-        template_options = JSON.parse(IO.read(template_path))
-      rescue Errno::ENOENT
-        raise NoTemplateError
-      rescue => e
-        raise TemplateParseError, e.message
-      end
+      backing_store_options = config.options_for_backing_store(backing_store)
+      backing_store_options['backing_store'] = backing_store
 
-      errors = []
-      unless template_options.include?('defaults')
-        errors << 'missing required section "defaults"; should be a hash containing default launch options'
-      end
+      # Step 4: Merge the options together in priority order.
 
-      if template_options['availability_zones'].nil?
-        errors << 'missing or empty section "availability zones"'
-        errors << '"availability_zones" should be a hash from region name => list of allowed zones in that region'
-      end
+      merged_options = DEFAULT_OPTIONS.dup
+      merged_options.merge!(config.default_options)
+      merged_options.merge!(backing_store_options)
+      merged_options.merge!(role_options.to_hash) if role_options
+      merged_options.merge!(override_options)
 
-      if template_options['backing_store'].nil? or template_options['backing_store'].empty?
-        errors << 'missing or empty section "backing_store"'
-        errors << '"backing_store" should be a hash from store type (like "ebs") => hash of options for that store'
-      end
+      # Step 5: If no availability zone was specified, select one at random.
 
-      unless errors.empty?
-        raise TemplateParseError, errors.join("; ")
+      if merged_options['availability_zone'].nil? && merged_options['region']
+        merged_options['availability_zone'] ||=
+          config.random_az_for_region(merged_options['region'])
       end
 
-       return template_options
-    end
-
-    def expand_role_options(chef_role, chef_environment)
-      Chef::Config[:role_path] = File.join(chef_root, 'roles')
-      Chef::Config[:data_bag_path] = File.join(chef_root, 'data_bags')
-
-      run_list = Chef::RunList.new
-      run_list << "role[#{chef_role}]"
-
-      expansion = run_list.expand(chef_environment, 'disk')
-      raise RoleExpansionError if expansion.errors?
-
-      default_attrs = expansion.default_attrs
-      override_attrs = expansion.override_attrs
+      # Step 6: Mandate that the environment and role were as specified.
 
-      merged_attrs = default_attrs.merge(override_attrs)
-      METADATA_ATTRIBUTES.inject(nil) { |r, key| r || merged_attrs[key] }
-    end
-
-    def expand_backing_store_options(default_opts, role_opts, override_opts)
-      backing_store   = override_opts['backing_store']
-      backing_store ||= role_opts.to_hash['backing_store'] if role_opts
-      backing_store ||= default_opts['backing_store']
-      backing_store ||= 'instance_store'
-
-      backing_store_options = @all_backing_store_options[backing_store]
-      if backing_store_options.nil?
-        raise Stemcell::UnknownBackingStoreError.new(backing_store)
-      end
-      backing_store_options
-    end
+      merged_options['chef_environment'] = environment
+      merged_options['chef_role'] = role
 
-    def random_az_in_region(region)
-      possible_azs = @all_azs_by_region[region] || []
-      possible_azs.sample
+      merged_options
     end
   end
 end

data/lib/stemcell/version.rb

@@ -1,3 +1,3 @@
 module Stemcell
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/stemcell.rb

@@ -1,6 +1,4 @@
-require 'stemcell/utility'
 require 'stemcell/errors'
-
 require 'stemcell/command_line'
 require 'stemcell/option_parser'
 require 'stemcell/launcher'

data/spec/fixtures/chef_repo/roles/unit-inherit-base.rb

@@ -0,0 +1,20 @@
+name 'unit-inherit-base'
+description 'unit-inherit-base'
+
+default_attributes({
+  'instance_metadata' => {
+    'instance_type' => 'm1.xlarge',
+    'security_groups' => [
+      'all',
+      'base',
+    ],
+    'tags' => {
+      'tag1' => 'tag1_value_base',
+      'tag2' => 'tag2_value',
+    },
+  },
+})
+
+run_list(
+  "role[unit-inherit-base]",
+)

data/spec/fixtures/chef_repo/roles/unit-inherit-both.rb

@@ -0,0 +1,36 @@
+name 'unit-inherit-both'
+description 'unit-inherit-both'
+
+default_attributes({
+  'instance_metadata' => {
+    'instance_type' => 'c1.xlarge',
+    'security_groups' => [
+      'all',
+      'default',
+    ],
+    'tags' => {
+      'tag1' => 'tag1_value_default',
+      'tag3' => 'tag3_value_default',
+      'tag4' => 'tag4_value',
+    },
+  },
+})
+
+override_attributes({
+  'instance_metadata' => {
+    'instance_type' => 'm3.xlarge',
+    'security_groups' => [
+      'all',
+      'override',
+    ],
+    'tags' => {
+      'tag1' => 'tag1_value_override',
+      'tag3' => 'tag3_value_override',
+      'tag5' => 'tag5_value',
+    },
+  },
+})
+
+run_list(
+  "role[unit-inherit-base]",
+)

data/spec/fixtures/chef_repo/roles/unit-inherit-default.rb

@@ -0,0 +1,21 @@
+name 'unit-inherit-default'
+description 'unit-inherit-default'
+
+default_attributes({
+  'instance_metadata' => {
+    'instance_type' => 'c1.xlarge',
+    'security_groups' => [
+      'all',
+      'default',
+    ],
+    'tags' => {
+      'tag1' => 'tag1_value_default',
+      'tag3' => 'tag3_value_default',
+      'tag4' => 'tag4_value',
+    },
+  },
+})
+
+run_list(
+  "role[unit-inherit-base]",
+)

data/spec/fixtures/chef_repo/roles/unit-inherit-none.rb

@@ -0,0 +1,6 @@
+name 'unit-inherit-none'
+description 'unit-inherit-none'
+
+run_list(
+  "role[unit-inherit-base]",
+)

data/spec/fixtures/chef_repo/roles/unit-inherit-override.rb

@@ -0,0 +1,21 @@
+name 'unit-inherit-override'
+description 'unit-inherit-override'
+
+override_attributes({
+  'instance_metadata' => {
+    'instance_type' => 'm3.xlarge',
+    'security_groups' => [
+      'all',
+      'override',
+    ],
+    'tags' => {
+      'tag1' => 'tag1_value_override',
+      'tag3' => 'tag3_value_override',
+      'tag5' => 'tag5_value',
+    },
+  },
+})
+
+run_list(
+  "role[unit-inherit-base]",
+)

data/spec/fixtures/chef_repo/roles/unit-simple-both.rb

@@ -0,0 +1,29 @@
+name 'unit-simple-both'
+description 'unit-simple-both'
+
+default_attributes({
+  'instance_metadata' => {
+    'instance_type' => 'c1.xlarge',
+    'security_groups' => [
+      'all',
+      'default'
+    ],
+    'tags' => {
+      'tag1' => 'tag1_value_default',
+      'tag2' => 'tag2_value',
+    },
+  },
+})
+
+override_attributes({
+  'instance_metadata' => {
+    'instance_type' => 'm3.xlarge',
+    'security_groups' => [
+      'override'
+    ],
+    'tags' => {
+      'tag1' => 'tag1_value_override',
+      'tag3' => 'tag3_value',
+    },
+  },
+})

data/spec/fixtures/chef_repo/roles/unit-simple-default.rb

@@ -0,0 +1,16 @@
+name 'unit-simple-default'
+description 'unit-simple-default'
+
+default_attributes({
+  'instance_metadata' => {
+    'instance_type' => 'c1.xlarge',
+    'security_groups' => [
+      'all',
+      'default'
+    ],
+    'tags' => {
+      'tag1' => 'tag1_value_default',
+      'tag2' => 'tag2_value',
+    },
+  },
+})

data/spec/fixtures/chef_repo/roles/unit-simple-none.rb

@@ -0,0 +1,2 @@
+name 'unit-simple-none'
+description 'unit-simple-none'

data/spec/fixtures/chef_repo/roles/unit-simple-override.rb

@@ -0,0 +1,16 @@
+name 'unit-simple-override'
+description 'unit-simple-override'
+
+override_attributes({
+  'instance_metadata' => {
+    'instance_type' => 'm3.xlarge',
+    'security_groups' => [
+      'all',
+      'override'
+    ],
+    'tags' => {
+      'tag1' => 'tag1_value_override',
+      'tag3' => 'tag3_value',
+    },
+  },
+})

data/spec/fixtures/chef_repo/roles-expected-metadata/unit-inherit-both.json

@@ -0,0 +1,16 @@
+{
+  "instance_type": "m3.xlarge",
+  "security_groups": [
+    "all",
+    "base",
+    "default",
+    "override"
+  ],
+  "tags": {
+    "tag1": "tag1_value_override",
+    "tag2": "tag2_value",
+    "tag3": "tag3_value_override",
+    "tag4": "tag4_value",
+    "tag5": "tag5_value"
+  }
+}

data/spec/fixtures/chef_repo/roles-expected-metadata/unit-inherit-default.json

@@ -0,0 +1,14 @@
+{
+  "instance_type": "c1.xlarge",
+  "security_groups": [
+    "all",
+    "base",
+    "default"
+  ],
+  "tags": {
+    "tag1": "tag1_value_default",
+    "tag2": "tag2_value",
+    "tag3": "tag3_value_default",
+    "tag4": "tag4_value"
+  }
+}

data/spec/fixtures/chef_repo/roles-expected-metadata/unit-inherit-none.json

@@ -0,0 +1,11 @@
+{
+  "instance_type": "m1.xlarge",
+  "security_groups": [
+    "all",
+    "base"
+  ],
+  "tags": {
+    "tag1": "tag1_value_base",
+    "tag2": "tag2_value"
+  }
+}

data/spec/fixtures/chef_repo/roles-expected-metadata/unit-inherit-override.json

@@ -0,0 +1,14 @@
+{
+  "instance_type": "m3.xlarge",
+  "security_groups": [
+    "all",
+    "base",
+    "override"
+  ],
+  "tags": {
+    "tag1": "tag1_value_override",
+    "tag2": "tag2_value",
+    "tag3": "tag3_value_override",
+    "tag5": "tag5_value"
+  }
+}