miasma-aws 0.3.12 → 0.3.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 136015ad26078a11d453df779c7116887ca4198d5f1c7901d5f3f20a9dcb1bf3
-  data.tar.gz: 149a662fb85e2dacd67427b92192732af6031a7ab23f893f351a093360403d30
+  metadata.gz: d0662f315f3d9820571a2dd60fee0f737bd98aaef9594c1c957b93b3523dd7c3
+  data.tar.gz: 2a16d55b282bb0deeba025bebdcd82d635fd4a2ef28e81977be9d07223cbc076
 SHA512:
-  metadata.gz: 300f29b1dacc60e70f6da191d32844a539e000e7fe9754dd07424b4b832dd1201ee2750768b40efd0aca6dbfe072fe94fcc0442b19492e98f6a777d5fd65eb17
-  data.tar.gz: e7b1c007d3d54b4147d83c3ac0975f2c26fe1593067e4c7d1a8a52ea697644f1351de7e6fc10583cecc8d651b59cb130804246ebd1a2e95fc81d317c7991787d
+  metadata.gz: 8238b361d641eb8618e1897586e653089021997c85c89f40ca4fe1c722f41e0acf64d92df414add3bf091e2f65a06bb56f3982db31f8b3ccde286df29a3ac6a0
+  data.tar.gz: 2fd7f3cc11114d0c83fee457aeebb93085849f8976583cf4f9e1d081289363d006e976cc2dc4f84b5dd659541c3664ca16764ec6855f99e3ab9ad1d883820c63

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.3.14
+* [feature] Add orchestration stack planning support (#46)
+
 # v0.3.12
 * [enhancement] Add support for defaulting to `AWS_` env vars
 * [fix] Properly parse AWS configuration/credentials file

data/lib/miasma-aws/version.rb

@@ -1,4 +1,4 @@
 module MiasmaAws
   # Current library version
-  VERSION = Gem::Version.new("0.3.12")
+  VERSION = Gem::Version.new("0.3.14")
 end

data/lib/miasma/contrib/aws.rb

@@ -419,21 +419,35 @@ module Miasma
         def custom_setup(creds)
           cred_file = load_aws_file(aws_credentials_file)
           config_file = load_aws_file(aws_config_file)
-          file_creds = Smash.new.tap do |fc|
-            (config_file.keys + cred_file.keys).uniq.reverse.each do |k|
-              fc[k] = config_file.fetch(k, Smash.new).merge(
-                cred_file.fetch(k, Smash.new)
-              )
-            end
+          profile = creds[:aws_profile_name]
+          profile_list = [profile].compact
+          new_config_creds = Smash.new
+          while profile
+            new_config_creds = config_file.fetch(profile, Smash.new).merge(
+              new_config_creds
+            )
+            profile = new_config_creds.delete(:source_profile)
+            profile_list << profile
           end
+          new_config_creds = config_file.fetch(:default, Smash.new).merge(
+            new_config_creds
+          )
           profile = creds[:aws_profile_name]
           new_creds = Smash.new
-          while profile
-            new_creds = file_creds.fetch(profile, Smash.new).merge(new_creds)
+          profile_list.each do |profile|
+            new_creds = cred_file.fetch(profile, Smash.new).merge(
+              new_creds
+            )
             profile = new_creds.delete(:source_profile)
           end
-          new_creds = file_creds.fetch(:default, Smash.new).merge(new_creds)
-          creds.replace(new_creds.merge(creds))
+          new_creds = cred_file.fetch(:default, Smash.new).merge(
+            new_creds
+          )
+          new_creds = new_creds.merge(new_config_creds)
+          new_creds.each_pair do |key, value|
+            creds[key] = value if creds[key].nil?
+          end
+          creds.replace(new_creds)
           if creds[:aws_iam_instance_profile]
             self.class.const_get(:ECS_TASK_PROFILE_PATH).nil? ?
               load_instance_credentials!(creds) :

data/lib/miasma/contrib/aws/compute.rb

@@ -24,7 +24,6 @@ module Miasma
           "stopped" => :stopped,
         ).to_smash(:freeze)
 
-        # @todo catch bad lookup and clear model
         def server_reload(server)
           result = request(
             :method => :post,
@@ -68,7 +67,7 @@ module Miasma
               },
             )
           else
-            raise "this doesn't even exist"
+            raise Error::ModelPersistError.new("Server is not persisted")
           end
         end
 
@@ -101,7 +100,7 @@ module Miasma
               },
             )
           else
-            raise "WAT DO I DO!?"
+            raise Error::ModelPersistError.new("Server is not persisted")
           end
         end
 

data/lib/miasma/contrib/aws/orchestration.rb

@@ -148,30 +148,7 @@ module Miasma
         # @param stack [Models::Orchestration::Stack]
         # @return [Models::Orchestration::Stack]
         def stack_save(stack)
-          params = Smash.new("StackName" => stack.name)
-          if stack.dirty?(:parameters)
-            initial_parameters = stack.data[:parameters] || {}
-          else
-            initial_parameters = {}
-          end
-          (stack.parameters || {}).each_with_index do |pair, idx|
-            params["Parameters.member.#{idx + 1}.ParameterKey"] = pair.first
-            if initial_parameters[pair.first] == pair.last
-              params["Parameters.member.#{idx + 1}.UsePreviousValue"] = true
-            else
-              params["Parameters.member.#{idx + 1}.ParameterValue"] = pair.last
-            end
-          end
-          (stack.capabilities || []).each_with_index do |cap, idx|
-            params["Capabilities.member.#{idx + 1}"] = cap
-          end
-          (stack.notification_topics || []).each_with_index do |topic, idx|
-            params["NotificationARNs.member.#{idx + 1}"] = topic
-          end
-          (stack.tags || {}).each_with_index do |tag, idx|
-            params["Tags.member.#{idx + 1}.Key"] = tag.first
-            params["Tags.member.#{idx + 1}.Value"] = tag.last
-          end
+          params = common_stack_params(stack)
           if stack.custom[:stack_policy_body]
             params["StackPolicyBody"] = MultiJson.dump(stack.custom[:stack_policy_body])
           end
@@ -184,13 +161,6 @@ module Miasma
           if stack.on_failure
             params["OnFailure"] = stack.on_failure == "nothing" ? "DO_NOTHING" : stack.on_failure.upcase
           end
-          if stack.template_url
-            params["TemplateURL"] = stack.template_url
-          elsif !stack.dirty?(:template) && stack.persisted?
-            params["UsePreviousTemplate"] = true
-          else
-            params["TemplateBody"] = MultiJson.dump(stack.template)
-          end
           if stack.persisted?
             result = request(
               :path => "/",
@@ -216,6 +186,252 @@ module Miasma
           end
         end
 
+        # Generate a new stack plan from the API
+        #
+        # @param stack [Models::Orchestration::Stack]
+        # @return [Models::Orchestration::Stack]
+        # @todo Needs to include the rolearn and resourcetypes
+        #       at some point but more thought on how to integrate
+        def stack_plan(stack)
+          params = common_stack_params(stack)
+          plan_name = changeset_name(stack)
+          result = request(
+            :path => "/",
+            :method => :post,
+            :form => params.merge(Smash.new(
+              "Action" => "CreateChangeSet",
+              "ChangeSetName" => plan_name,
+              "StackName" => stack.name,
+              "ChangeSetType" => stack.persisted? ? "UPDATE" : "CREATE",
+            )),
+          )
+          stack.reload
+          # Ensure we have the same plan name in use after reload
+          stack.custom = stack.custom.dup
+          stack.custom[:plan_name] = plan_name
+          stack.plan
+        end
+
+        # Load the plan for the stack
+        #
+        # @param stack [Models::Orchestration::Stack]
+        # @return [Models::Orchestration::Stack::Plan]
+        def stack_plan_load(stack)
+          if stack.attributes[:plan]
+            plan = stack.attributes[:plan]
+          else
+            plan = Stack::Plan.new(stack, name: changeset_name(stack))
+          end
+          if stack.custom[:plan_name]
+            if stack.custom[:plan_name] != plan.name
+              plan.name = stack.custom[:plan_name]
+            else
+              plan.name = changeset_name(stack)
+            end
+          end
+          result = nil
+          Bogo::Retry.build(:linear, max_attempts: 10, wait_interval: 5, ui: Bogo::Ui.new) do
+            begin
+              result = request(
+                :path => "/",
+                :method => :post,
+                :form => Smash.new(
+                  "Action" => "DescribeChangeSet",
+                  "ChangeSetName" => plan.name,
+                  "StackName" => stack.name,
+                ),
+              )
+            rescue Error::ApiError::RequestError => e
+              # Plan does not exist
+              if e.response.code == 404
+                return nil
+              end
+              # Stack does not exist
+              if e.response.code == 400 && e.message.include?("ValidationError: Stack")
+                return nil
+              end
+              raise
+            end
+            status = result.get(:body, "DescribeChangeSetResponse", "DescribeChangeSetResult", "ExecutionStatus")
+            if status != "AVAILABLE"
+              raise "Plan execution is not yet available"
+            end
+          end.run!
+          res = result.get(:body, "DescribeChangeSetResponse", "DescribeChangeSetResult")
+          plan.id = res["ChangeSetId"]
+          plan.name = res["ChangeSetName"]
+          plan.custom = {
+            :execution_status => res["ExecutionStatus"],
+            :stack_name => res["StackName"],
+            :stack_id => res["StackId"],
+            :status => res["Status"],
+          }
+          plan.state = res["ExecutionStatus"].downcase.to_sym
+          plan.parameters = Smash[
+            [res.get("Parameters", "member")].compact.flatten.map { |param|
+              [param["ParameterKey"], param["ParameterValue"]]
+            }
+          ]
+          plan.created_at = res["CreationTime"]
+          plan.template = stack_plan_template(plan, :processed)
+          items = {:add => [], :replace => [], :remove => [], :unknown => [], :interrupt => []}
+          [res.get("Changes", "member")].compact.flatten.each do |chng|
+            if chng["Type"] == "Resource"
+              item_diffs = []
+              [chng.get("ResourceChange", "Details", "member")].compact.flatten.each do |d|
+                item_path = [
+                  d.get("Target", "Attribute"),
+                  d.get("Target", "Name"),
+                ].compact
+                original_value = stack.template.get("Resources", chng.get("ResourceChange", "LogicalResourceId"), *item_path)
+                if original_value.is_a?(Hash) && (stack.parameters || {}).key?(original_value["Ref"])
+                  original_value = stack.parameters[original_value["Ref"]]
+                end
+                new_value = plan.template.get("Resources", chng.get("ResourceChange", "LogicalResourceId"), *item_path)
+                if new_value.is_a?(Hash) && plan.parameters.key?(new_value["Ref"])
+                  new_value = plan.parameters[new_value["Ref"]]
+                end
+                diff = Stack::Plan::Diff.new(
+                  :name => item_path.join("."),
+                  :current => original_value.inspect,
+                  :proposed => new_value.inspect,
+                )
+
+                unless item_diffs.detect { |d| d.name == diff.name && d.current == diff.current && d.proposed == diff.proposed }
+                  item_diffs << diff
+                end
+              end
+              type = case chng.get("ResourceChange", "Action").to_s.downcase
+                     when "add"
+                       :add
+                     when "modify"
+                       chng.get("ResourceChange", "Replacement") == "True" ?
+                         :replace : :interrupt
+                     when "remove"
+                       :remove
+                     else
+                       :unknown
+                     end
+              items[type] << Stack::Plan::Item.new(
+                :name => chng.get("ResourceChange", "LogicalResourceId"),
+                :type => chng.get("ResourceChange", "ResourceType"),
+                :diffs => item_diffs.sort_by(&:name),
+              )
+            end
+          end.compact
+          items.each do |type, list|
+            plan.send("#{type}=", list.sort_by(&:name))
+          end
+          if plan.custom[:stack_id]
+            stack.id = plan.custom[:stack_id]
+            stack.valid_state
+          end
+          stack.plan = plan.valid_state
+        end
+
+        def stack_plan_template(plan, state)
+          result = request(
+            :path => "/",
+            :method => :post,
+            :form => Smash.new(
+              "Action" => "GetTemplate",
+              "ChangeSetName" => plan.id,
+              "TemplateStage" => state.to_s.capitalize,
+            ),
+          )
+          MultiJson.load(result.get(:body, "GetTemplateResponse", "GetTemplateResult", "TemplateBody")).to_smash
+        end
+
+        # Delete the plan attached to the stack
+        #
+        # @param stack [Models::Orchestration::Stack]
+        # @return [Models::Orchestration::Stack]
+        def stack_plan_destroy(stack)
+          request(
+            :path => "/",
+            :method => :post,
+            :form => Smash.new(
+              "Action" => "DeleteChangeSet",
+              "ChangeSetName" => stack.plan.id,
+              "StackName" => stack.name,
+            ),
+          )
+          stack.plan = nil
+          stack.valid_state
+        end
+
+        # Apply the plan attached to the stack
+        #
+        # @param stack [Model::Orchestration::Stack]
+        # @return [Model::Orchestration::Stack]
+        def stack_plan_execute(stack)
+          request(
+            :path => "/",
+            :method => :post,
+            :form => Smash.new(
+              "Action" => "ExecuteChangeSet",
+              "ChangeSetName" => stack.plan.id,
+              "StackName" => stack.name,
+            ),
+          )
+          stack.reload
+        end
+
+        # Reload the plan
+        #
+        # @param plan [Model::Orchestration::Stack::Plan]
+        # @return [Model::Orchestration::Stack::Plan]
+        def stack_plan_reload(plan)
+          if plan.stack.plan == plan
+            stack_plan_load(plan.stack)
+          else
+            stack = Stack.new(self,
+                              id: plan.custom[:stack_id],
+                              name: plan.custom[:stack_name])
+            stack.dirty[:plan] = plan
+            stack_plan_load(stack)
+          end
+        end
+
+        # Load all plans associated to given stack
+        #
+        # @param stack [Models::Orchestration::Stack]
+        # @return [Array<Models::Orchestration::Stack::Plan>]
+        def stack_plan_all(stack)
+          all_result_pages(nil, :body,
+                           "ListChangeSetsResponse", "ListChangeSetsResult",
+                           "Summaries", "member") do |options|
+            request(
+              :method => :post,
+              :path => "/",
+              :form => options.merge(
+                Smash.new(
+                  "Action" => "ListChangeSets",
+                  "StackName" => stack.id || stack.name,
+                )
+              ),
+            )
+          end.map do |res|
+            stack = Stack.new(self,
+                              id: res["StackId"],
+                              name: res["StackName"])
+            stack.custom = {:plan_name => res["ChangeSetName"],
+                            :plan_id => res["ChangeSetId"]}
+            stack.plan
+          end
+        end
+
+        # Generate changeset name given stack. This
+        # is a unique name for miasma and ensures only
+        # one changeset is used/persisted for miasma
+        # interactions.
+        #
+        # @param stack [Models::Orchestration::Stack]
+        # @return [String]
+        def changeset_name(stack)
+          stack.custom.fetch(:plan_name, "miasma-changeset-#{stack.name}")
+        end
+
         # Reload the stack data from the API
         #
         # @param stack [Models::Orchestration::Stack]
@@ -270,9 +486,8 @@ module Miasma
                 "StackName" => stack.id,
               ),
             )
-            MultiJson.load(
-              result.get(:body, "GetTemplateResponse", "GetTemplateResult", "TemplateBody")
-            ).to_smash
+            template = result.get(:body, "GetTemplateResponse", "GetTemplateResult", "TemplateBody")
+            template.nil? ? Smash.new : MultiJson.load(template)
           else
             Smash.new
           end
@@ -436,6 +651,47 @@ module Miasma
           event.stack.events.reload
           event.stack.events.get(event.id)
         end
+
+        # Common parameters used for stack creation/update
+        # requests. This is currently shared between stack
+        # creation and plan creation
+        #
+        # @param stack [Model::Orchestration::Stack]
+        # @return [Smash]
+        def common_stack_params(stack)
+          params = Smash.new("StackName" => stack.name)
+          if stack.dirty?(:parameters)
+            initial_parameters = stack.data[:parameters] || {}
+          else
+            initial_parameters = {}
+          end
+          (stack.parameters || {}).each_with_index do |pair, idx|
+            params["Parameters.member.#{idx + 1}.ParameterKey"] = pair.first
+            if initial_parameters[pair.first] == pair.last
+              params["Parameters.member.#{idx + 1}.UsePreviousValue"] = true
+            else
+              params["Parameters.member.#{idx + 1}.ParameterValue"] = pair.last
+            end
+          end
+          (stack.capabilities || []).each_with_index do |cap, idx|
+            params["Capabilities.member.#{idx + 1}"] = cap
+          end
+          (stack.notification_topics || []).each_with_index do |topic, idx|
+            params["NotificationARNs.member.#{idx + 1}"] = topic
+          end
+          (stack.tags || {}).each_with_index do |tag, idx|
+            params["Tags.member.#{idx + 1}.Key"] = tag.first
+            params["Tags.member.#{idx + 1}.Value"] = tag.last
+          end
+          if stack.template_url
+            params["TemplateURL"] = stack.template_url
+          elsif !stack.dirty?(:template) && stack.persisted?
+            params["UsePreviousTemplate"] = true
+          else
+            params["TemplateBody"] = MultiJson.dump(stack.template)
+          end
+          params
+        end
       end
     end
   end

data/miasma-aws.gemspec

@@ -1,24 +1,24 @@
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
-require 'miasma-aws/version'
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + "/lib/"
+require "miasma-aws/version"
 Gem::Specification.new do |s|
-  s.name = 'miasma-aws'
+  s.name = "miasma-aws"
   s.version = MiasmaAws::VERSION.version
-  s.summary = 'Smoggy AWS API'
-  s.author = 'Chris Roberts'
-  s.email = 'code@chrisroberts.org'
-  s.homepage = 'https://github.com/miasma-rb/miasma-aws'
-  s.description = 'Smoggy AWS API'
-  s.license = 'Apache 2.0'
-  s.require_path = 'lib'
-  s.add_runtime_dependency 'miasma', '>= 0.3.1', '< 0.5'
-  s.add_development_dependency 'rake', '~> 10'
-  s.add_development_dependency 'pry'
-  s.add_development_dependency 'vcr'
-  s.add_development_dependency 'mocha'
-  s.add_development_dependency 'webmock', '~> 1.23.0'
-  s.add_development_dependency 'minitest'
-  s.add_development_dependency 'minitest-vcr'
-  s.add_development_dependency 'rufo'
-  s.add_development_dependency 'rspec', '~> 3.5'
-  s.files = Dir['lib/**/*'] + %w(miasma-aws.gemspec README.md CHANGELOG.md LICENSE)
+  s.summary = "Smoggy AWS API"
+  s.author = "Chris Roberts"
+  s.email = "code@chrisroberts.org"
+  s.homepage = "https://github.com/miasma-rb/miasma-aws"
+  s.description = "Smoggy AWS API"
+  s.license = "Apache 2.0"
+  s.require_path = "lib"
+  s.add_runtime_dependency "miasma", ">= 0.3.3", "< 0.5"
+  s.add_development_dependency "rake", "~> 10"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "vcr"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "webmock", "~> 1.23.0"
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "minitest-vcr"
+  s.add_development_dependency "rufo", "~> 0.3.0"
+  s.add_development_dependency "rspec", "~> 3.5"
+  s.files = Dir["lib/**/*"] + %w(miasma-aws.gemspec README.md CHANGELOG.md LICENSE)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: miasma-aws
 version: !ruby/object:Gem::Version
-  version: 0.3.12
+  version: 0.3.14
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-15 00:00:00.000000000 Z
+date: 2018-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: miasma
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.5'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.5'
@@ -132,16 +132,16 @@ dependencies:
   name: rufo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement