miasma-aws 0.3.22 → 0.3.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52b34565420604144ef097dabea4e434e2f413af448c3cd5041abeb6a3aab3f3
-  data.tar.gz: e2de941c5c78209ba8ee8c737f5c6b43113ce2251818e53e610bd2c688d4ed78
+  metadata.gz: 156fe688026787b3fb537197d4a39d88666b840920442f8be9d6eb4e9a8b6708
+  data.tar.gz: 4e46c9280237574c37b1178e17cb65398bd4dd682031cc8698f6ec98293f4fa0
 SHA512:
-  metadata.gz: 9eba4d31741db7cd4efa9277ab0b8c831bcf6081f56bd591e943f694084d26ab5adfbb8e130c755350c2dd052a9f059e46f8d32c75dfd26ac56432edf6509168
-  data.tar.gz: f89d2ca230d03b1bbc0745bab06e2dffc23828e785926e75bd604e1784777c8c831feef8bf03077852e17383ebff9b7680c8245f6f26ea3da56b0bd04125cdb5
+  metadata.gz: c97d6b839d0310e1f4a28c10d7624b479c01245b289a0c224a06e7e6b8afa57a542b40b1d4d163da21e56a61940c660f7bed4fe42dbbbfab4de83e03e1087207
+  data.tar.gz: 8447055c12cef4ed6847887ed76f3244e7d0e63b7bd0db361168e2e7544fd12de6b2786ccad7ee91c52949558a35717933c8c6df71b4333f29ebb0a593228ef0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.3.24
+* [enhancement] Add logging output to generic and orchestration
+* [fix] Attribute access for sts update check
+
 # v0.3.22
 * [fix] Resolve configuration loading issues (#58)
 * [enhancement] Update token refresh to within 10m of expiry (#59)

data/lib/miasma-aws/version.rb

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

data/lib/miasma/contrib/aws.rb

@@ -56,6 +56,8 @@ module Miasma
 
       # HMAC helper class
       class Hmac
+        include Bogo::Logger::Helpers
+        logger_name("aws.hmac")
 
         # @return [OpenSSL::Digest]
         attr_reader :digest
@@ -82,6 +84,7 @@ module Miasma
         # @param content [String] content to digest
         # @return [String] hashed result
         def hexdigest_of(content)
+          logger.debug("generating hexdigest for `#{content.inspect}`")
           digest << content
           hash = digest.hexdigest
           digest.reset
@@ -94,11 +97,17 @@ module Miasma
         # @param key_override [Object]
         # @return [Object] signature
         def sign(data, key_override = nil)
-          s_key = key_override || key
+          logger.debug("signing data `#{data.inspect}`")
+          s_key = key
+          if key_override
+            logger.debug("using key override for signing")
+            s_key = key_override
+          end
           if s_key.nil?
-            raise ArgumentError.new("No key provided for signing data")
+            logger.error("no key provided to sign")
+            raise ArgumentError, "No key provided for signing data"
           end
-          result = OpenSSL::HMAC.digest(digest, key_override || key, data.to_s)
+          result = OpenSSL::HMAC.digest(digest, s_key, data.to_s)
           digest.reset
           result
         end
@@ -109,6 +118,7 @@ module Miasma
         # @param key_override [Object]
         # @return [String] hex encoded signature
         def hex_sign(data, key_override = nil)
+          logger.debug("hex signing data `#{data.inspect}`")
           result = OpenSSL::HMAC.hexdigest(digest, key_override || key, data)
           digest.reset
           result
@@ -120,7 +130,7 @@ module Miasma
 
         # Create new instance
         def initialize(*args)
-          raise NotImplementedError.new "This class should not be used directly!"
+          raise NotImplementedError, "This class should not be used directly!"
         end
 
         # Generate the signature
@@ -146,6 +156,8 @@ module Miasma
 
       # AWS signature version 4
       class SignatureV4 < Signature
+        include Bogo::Logger::Helpers
+        logger_name("aws.signature4")
 
         # @return [Hmac]
         attr_reader :hmac
@@ -201,6 +213,7 @@ module Miasma
             opts.merge(:body => "UNSIGNED-PAYLOAD")
           )
           params = opts[:params].merge("X-Amz-Signature" => signature)
+          logger.debug("url generation parameters `#{params.inspect}`")
           "https://#{opts[:headers]["Host"]}/#{path}?#{canonical_query(params)}"
         end
 
@@ -219,6 +232,7 @@ module Miasma
               can_req = build_canonical_request(http_method, path, opts)
             ),
           ].join("\n")
+          logger.debug("generating signature for `#{to_sign.inspect}`")
           signature = sign_request(to_sign)
         end
 
@@ -240,7 +254,9 @@ module Miasma
               )
             )
           )
-          hmac.hex_sign(request, key)
+          signature = hmac.hex_sign(request, key)
+          logger.debug("generated signature `#{signature.inspect}`")
+          signature
         end
 
         # @return [String] signature algorithm
@@ -405,6 +421,7 @@ module Miasma
         # @return [Api]
         def api_for(type)
           memoize(type) do
+            logger.debug("building API for type `#{type}`")
             creds = attributes.dup
             creds.delete(:aws_host)
             Miasma.api(
@@ -423,6 +440,7 @@ module Miasma
         # @param creds [Hash]
         # @return [TrueClass]
         def custom_setup(creds)
+          logger.debug("running custom setup configuration updates")
           cred_file = load_aws_file(creds.fetch(
             :aws_credentials_file, aws_credentials_file
           ))
@@ -434,6 +452,7 @@ module Miasma
           profile_list = [profile].compact
           new_config_creds = Smash.new
           while profile
+            logger.debug("loading aws configuration profile: #{profile}")
             new_config_creds = config_file.fetch(profile, Smash.new).merge(
               new_config_creds
             )
@@ -446,6 +465,7 @@ module Miasma
           # Load any configuration available from the creds file
           new_creds = Smash.new
           profile_list.each do |profile|
+            logger.debug("loading aws credentials profile: #{profile}")
             new_creds = cred_file.fetch(profile, Smash.new).merge(
               new_creds
             )
@@ -475,6 +495,7 @@ module Miasma
         # @param creds [Hash]
         # @return [TrueClass]
         def after_setup(creds)
+          logger.debug("running after setup configuration updates")
           skip = self.class.attributes.keys.map(&:to_s)
           creds.each do |k, v|
             k = k.to_s
@@ -489,6 +510,7 @@ module Miasma
         # @param creds [Hash]
         # @return [TrueClass]
         def load_instance_credentials!(creds)
+          logger.debug("loading instance credentials")
           role = HTTP.get(
             [
               self.class.const_get(:INSTANCE_PROFILE_HOST),
@@ -506,7 +528,8 @@ module Miasma
           unless data.is_a?(Hash)
             begin
               data = MultiJson.load(data.to_s)
-            rescue MultiJson::ParseError
+            rescue MultiJson::ParseError => err
+              logger.debug("failed to parse instance credentials - #{err}")
               data = {}
             end
           end
@@ -522,6 +545,7 @@ module Miasma
         # @param creds [Hash]
         # @return [TrueClass]
         def load_ecs_credentials!(creds)
+          logger.debug("loading ECS credentials")
           # As per docs ECS_TASK_PROFILE_PATH is defined as
           # /credential_provider_version/credentials?id=task_UUID
           # where AWS fills in the version and UUID.
@@ -535,7 +559,8 @@ module Miasma
           unless data.is_a?(Hash)
             begin
               data = MultiJson.load(data.to_s)
-            rescue MultiJson::ParseError
+            rescue MultiJson::ParseError => err
+              logger.debug("failed to parse ECS credentials - #{err}")
               data = {}
             end
           end
@@ -564,6 +589,7 @@ module Miasma
         #
         # @return [String]
         def get_region
+          logger.debug("fetching region from meta-data service")
           az = HTTP.get(
             [
               self.class.const_get(:INSTANCE_PROFILE_HOST),
@@ -571,11 +597,13 @@ module Miasma
             ].join("/")
           ).body.to_s.strip
           az.sub!(/[a-zA-Z]+$/, "")
+          logger.debug("region from meta-data service: #{az}")
           az
         end
 
         def sts_mfa_session!(creds)
           if sts_mfa_session_update_required?(creds)
+            logger.debug("loading STS MFA session")
             sts = Miasma::Contrib::Aws::Api::Sts.new(
               :aws_access_key_id => creds[:aws_access_key_id],
               :aws_secret_access_key => creds[:aws_secret_access_key],
@@ -603,6 +631,7 @@ module Miasma
         # @return [TrueClass]
         def sts_assume_role!(creds)
           if sts_assume_role_update_required?(creds)
+            logger.debug("loading STS assume role")
             sts = Miasma::Contrib::Aws::Api::Sts.new(
               :aws_access_key_id => get_credential(:access_key_id, creds),
               :aws_secret_access_key => get_credential(:secret_access_key, creds),
@@ -630,6 +659,7 @@ module Miasma
         # @return [Smash]
         def load_aws_file(file_path)
           if File.exist?(file_path)
+            logger.debug("loading aws file @ #{file_path}")
             Smash.new.tap do |creds|
               key = :default
               File.readlines(file_path).each_with_index do |line, idx|
@@ -637,18 +667,16 @@ module Miasma
                 next if line.empty? || line.start_with?("#")
                 if line.start_with?("[")
                   unless line.end_with?("]")
-                    raise ArgumentError.new(
+                    raise ArgumentError,
                       "Failed to parse aws file! (#{file_path} line #{idx + 1})"
-                    )
                   end
                   key = line.tr("[]", "").strip.sub(/^profile /, "")
                   creds[key] = Smash.new
                 else
                   unless key
-                    raise ArgumentError.new(
+                    raise ArgumentError,
                       "Failed to parse aws file! (#{file_path} line #{idx + 1}) " \
                       "- No section defined!"
-                    )
                   end
                   line_args = line.split("=", 2).map(&:strip)
                   line_args.first.replace(
@@ -658,18 +686,16 @@ module Miasma
                   )
                   if line_args.last.start_with?('"')
                     unless line_args.last.end_with?('"')
-                      raise ArgumentError.new(
+                      raise ArgumentError,
                         "Failed to parse aws file! (#{file_path} line #{idx + 1})"
-                      )
                     end
                     line_args.last.replace(line_args.last[1..-2]) # NOTE: strip quoted values
                   end
                   begin
                     creds[key].merge!(Smash[*line_args])
                   rescue => e
-                    raise ArgumentError.new(
+                    raise ArgumentError,
                       "Failed to parse aws file! (#{file_path} line #{idx + 1})"
-                    )
                   end
                 end
               end
@@ -760,6 +786,7 @@ module Miasma
         # @param request_args [Array]
         # @return [HTTP::Response]
         def make_request(connection, http_method, request_args)
+          logger.debug("making #{http_method.to_s.upcase} request - #{request_args.inspect}")
           dest, options = request_args
           path = URI.parse(dest).path
           options = options ? options.to_smash : Smash.new
@@ -813,12 +840,12 @@ module Miasma
         # Check if STS attribute requires update
         #
         # @param key [String, Symbol] token key
-        # @param expiry_key [Time] expiry of token
+        # @param expiry_key [String, Symbol] expiry of token (Time instance)
         # @param args [Hash] overrides to check instead of instance values
         # @return [TrueClass, FalseClass]
         def sts_attribute_update_required?(key, expiry_key, args = {})
-          if args.fetch(key, attributes[key])
-            expiry = args.fetch(expiry_key, attributes[expiry_key])
+          if args.to_smash.fetch(key, attributes[key])
+            expiry = args.to_smash.fetch(expiry_key, attributes[expiry_key])
             expiry.nil? || expiry - self.class.const_get(:STS_TOKEN_EXPIRY_BUFFER) <= Time.now
           else
             false

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

@@ -6,6 +6,9 @@ module Miasma
       # AWS Orchestration API
       class Aws < Orchestration
 
+        include Bogo::Logger::Helpers
+        logger_name("aws.orchestration")
+
         # Extended stack model to provide AWS specific stack options
         class Stack < Orchestration::Stack
           attribute :stack_policy_body, Hash, :coerce => lambda { |v| MultiJson.load(v).to_smash }
@@ -26,7 +29,7 @@ module Miasma
           "DELETE_IN_PROGRESS", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED", "ROLLBACK_IN_PROGRESS",
           "UPDATE_COMPLETE", "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_IN_PROGRESS",
           "UPDATE_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_ROLLBACK_FAILED",
-          "UPDATE_ROLLBACK_IN_PROGRESS",
+          "UPDATE_ROLLBACK_IN_PROGRESS", "REVIEW_IN_PROGRESS",
         ].map(&:freeze).freeze
 
         include Contrib::AwsApiCore::ApiCommon
@@ -59,10 +62,16 @@ module Miasma
         def load_stack_data(stack = nil)
           d_params = Smash.new("Action" => "DescribeStacks")
           l_params = Smash.new("Action" => "ListStacks")
-          STACK_STATES.each_with_index do |state, idx|
-            l_params["StackStatusFilter.member.#{idx + 1}"] = state.to_s.upcase
-          end
+          # TODO: Disable state filtering so we get entire list of defined
+          #       stacks. Allowing filtering would be ideal but need a generic
+          #       way to pass it through. This current filter setup imposes
+          #       list restrictions when new states are added that is less than
+          #       ideal
+          # STACK_STATES.each_with_index do |state, idx|
+          #   l_params["StackStatusFilter.member.#{idx + 1}"] = state.to_s.upcase
+          # end
           if stack
+            logger.debug("loading stack information for `#{stack.id}`")
             d_params["StackName"] = stack.id
             descriptions = all_result_pages(nil, :body,
                                             "DescribeStacksResponse", "DescribeStacksResult",
@@ -74,6 +83,7 @@ module Miasma
               )
             end
           else
+            logger.debug("loading stack listing information")
             lists = all_result_pages(nil, :body,
                                      "ListStacksResponse", "ListStacksResult",
                                      "StackSummaries", "member") do |options|
@@ -140,6 +150,8 @@ module Miasma
                 :stack_policy_url => stk["StackPolicyURL"],
               ),
             ).valid_state
+            logger.debug("loaded stack information `#{new_stack.inspect}`")
+            new_stack
           end
         end
 
@@ -148,6 +160,7 @@ module Miasma
         # @param stack [Models::Orchestration::Stack]
         # @return [Models::Orchestration::Stack]
         def stack_save(stack)
+          logger.debug("saving stack information `#{stack.inspect}`")
           params = common_stack_params(stack)
           if stack.custom[:stack_policy_body]
             params["StackPolicyBody"] = MultiJson.dump(stack.custom[:stack_policy_body])
@@ -193,8 +206,16 @@ module Miasma
         # @todo Needs to include the rolearn and resourcetypes
         #       at some point but more thought on how to integrate
         def stack_plan(stack)
+          logger.debug("generating plan for stack `#{stack.id}`")
           params = common_stack_params(stack)
           plan_name = changeset_name(stack)
+          if stack.persisted? && stack.state != :unknown
+            logger.debug("plan will update stack")
+            changeset_type = "UPDATE"
+          else
+            logger.debug("plan will create stack")
+            changeset_type = "CREATE"
+          end
           result = request(
             :path => "/",
             :method => :post,
@@ -202,7 +223,7 @@ module Miasma
               "Action" => "CreateChangeSet",
               "ChangeSetName" => plan_name,
               "StackName" => stack.name,
-              "ChangeSetType" => stack.persisted? ? "UPDATE" : "CREATE",
+              "ChangeSetType" => changeset_type,
             )),
           )
           stack.reload
@@ -229,6 +250,7 @@ module Miasma
               plan.name = changeset_name(stack)
             end
           end
+          logger.debug("loading plan `#{plan.name}` for stack `#{stack.id}`")
           result = nil
           Bogo::Retry.build(:linear, max_attempts: 10, wait_interval: 5, ui: Bogo::Ui.new) do
             begin
@@ -244,16 +266,19 @@ module Miasma
             rescue Error::ApiError::RequestError => e
               # Plan does not exist
               if e.response.code == 404
+                logger.warn("plan `#{plan.name}` does not exist for stack `#{stack.id}`")
                 return nil
               end
               # Stack does not exist
               if e.response.code == 400 && e.message.include?("ValidationError: Stack")
+                logger.warn("stack `#{stack.id}` does not exist")
                 return nil
               end
               raise
             end
             status = result.get(:body, "DescribeChangeSetResponse", "DescribeChangeSetResult", "ExecutionStatus")
             if status != "AVAILABLE"
+              logger.debug("plan `#{plan.name}` is not available (status: `#{status}`)")
               raise "Plan execution is not yet available"
             end
           end.run!
@@ -326,10 +351,12 @@ module Miasma
             stack.id = plan.custom[:stack_id]
             stack.valid_state
           end
+          logger.debug("plan `#{plan.name}` loaded for stack `#{stack.id}` - `#{plan.inspect}`")
           stack.plan = plan.valid_state
         end
 
         def stack_plan_template(plan, state)
+          logger.debug("loading template for plan `#{plan.name}`")
           result = request(
             :path => "/",
             :method => :post,
@@ -347,6 +374,7 @@ module Miasma
         # @param stack [Models::Orchestration::Stack]
         # @return [Models::Orchestration::Stack]
         def stack_plan_destroy(stack)
+          logger.debug("deleting plan `#{stack.plan.id}` for stack `#{stack.id}`")
           request(
             :path => "/",
             :method => :post,
@@ -365,6 +393,7 @@ module Miasma
         # @param stack [Model::Orchestration::Stack]
         # @return [Model::Orchestration::Stack]
         def stack_plan_execute(stack)
+          logger.debug("applying plan `#{stack.plan.id}` to stack `#{stack.id}`")
           request(
             :path => "/",
             :method => :post,
@@ -382,6 +411,7 @@ module Miasma
         # @param plan [Model::Orchestration::Stack::Plan]
         # @return [Model::Orchestration::Stack::Plan]
         def stack_plan_reload(plan)
+          logger.debug("reloading plan `#{plan.id}`")
           if plan.stack.plan == plan
             stack_plan_load(plan.stack)
           else
@@ -398,6 +428,7 @@ module Miasma
         # @param stack [Models::Orchestration::Stack]
         # @return [Array<Models::Orchestration::Stack::Plan>]
         def stack_plan_all(stack)
+          logger.debug("loading all plans for stack `#{stack.id}`")
           all_result_pages(nil, :body,
                            "ListChangeSetsResponse", "ListChangeSetsResult",
                            "Summaries", "member") do |options|
@@ -437,6 +468,7 @@ module Miasma
         # @param stack [Models::Orchestration::Stack]
         # @return [Models::Orchestration::Stack]
         def stack_reload(stack)
+          logger.debug("reloading stack `#{stack.id}`")
           if stack.persisted?
             ustack = Stack.new(self)
             ustack.id = stack.id
@@ -458,6 +490,7 @@ module Miasma
         # @return [TrueClass, FalseClass]
         def stack_destroy(stack)
           if stack.persisted?
+            logger.debug("deleting stack `#{stack.id}`")
             request(
               :method => :post,
               :path => "/",
@@ -468,6 +501,7 @@ module Miasma
             )
             true
           else
+            logger.debug("stack not persisted. delete is no-op `#{stack.name}`")
             false
           end
         end
@@ -478,6 +512,7 @@ module Miasma
         # @return [Smash] stack template
         def stack_template_load(stack)
           if stack.persisted?
+            logger.debug("loading template for stack `#{stack.id}`")
             result = request(
               :method => :post,
               :path => "/",
@@ -489,6 +524,7 @@ module Miasma
             template = result.get(:body, "GetTemplateResponse", "GetTemplateResult", "TemplateBody")
             template.nil? ? Smash.new : MultiJson.load(template)
           else
+            logger.debug("no template for non-persisted stack `#{stack.name}`")
             Smash.new
           end
         end
@@ -513,6 +549,7 @@ module Miasma
             )
             nil
           rescue Error::ApiError::RequestError => e
+            logger.error("template validate error - #{e.response.body}")
             MultiXml.parse(e.response.body.to_s).to_smash.get(
               "ErrorResponse", "Error", "Message"
             )

data/miasma-aws.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   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_runtime_dependency "miasma", ">= 0.3.5", "< 0.5"
   s.add_development_dependency "rake", "~> 10"
   s.add_development_dependency "pry"
   s.add_development_dependency "vcr"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: miasma-aws
 version: !ruby/object:Gem::Version
-  version: 0.3.22
+  version: 0.3.24
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-22 00:00:00.000000000 Z
+date: 2018-12-08 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.3
+        version: 0.3.5
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.5'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.3
+        version: 0.3.5
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.5'