bora 1.6.0 → 1.7.0

data/lib/bora/cfn/stack_status.rb

@@ -2,15 +2,12 @@ require 'bora/cfn/status'
 
 class Bora
   module Cfn
-
     class StackStatus
-      DOES_NOT_EXIST_MESSAGE = "Stack does not exist"
+      DOES_NOT_EXIST_MESSAGE = 'Stack does not exist'.freeze
 
       def initialize(underlying_stack)
         @stack = underlying_stack
-        if @stack
-          @status = Status.new(@stack.stack_status)
-        end
+        @status = Status.new(@stack.stack_status) if @stack
       end
 
       def exists?
@@ -23,13 +20,12 @@ class Bora
 
       def to_s
         if @stack
-          status_reason = @stack.stack_status_reason ? " - #{@stack.stack_status_reason}" : ""
+          status_reason = @stack.stack_status_reason ? " - #{@stack.stack_status_reason}" : ''
           "#{@stack.stack_name} - #{@status}#{status_reason}"
         else
           DOES_NOT_EXIST_MESSAGE
         end
       end
     end
-
   end
 end

data/lib/bora/cfn/status.rb

@@ -8,15 +8,15 @@ class Bora
       end
 
       def success?
-        @status.end_with?("_COMPLETE") && !@status.include?("ROLLBACK")
+        @status.end_with?('_COMPLETE') && !@status.include?('ROLLBACK')
       end
 
       def failure?
-        @status.end_with?("FAILED") || @status.include?("ROLLBACK")
+        @status.end_with?('FAILED') || @status.include?('ROLLBACK')
       end
 
       def deleted?
-        @status == "DELETE_COMPLETE"
+        @status == 'DELETE_COMPLETE'
       end
 
       def complete?
@@ -27,17 +27,14 @@ class Bora
         @status.colorize(color)
       end
 
-
       private
 
       def color
-        case
-          when success?; :green
-          when failure?; :red
-          else; :yellow;
+        if success? then :green
+        elsif failure? then :red
+        else; :yellow
         end
       end
     end
-
   end
 end

data/lib/bora/cli.rb

@@ -1,101 +1,103 @@
-require "thor"
-require "bora"
-require "bora/cli_base"
-require "bora/cli_change_set"
+require 'thor'
+require 'bora'
+require 'bora/cli_base'
+require 'bora/cli_change_set'
 
 class Bora
   class Cli < CliBase
-
-    class_option :file,
+    class_option(
+      :file,
       type: :string,
       aliases: :f,
       default: Bora::DEFAULT_CONFIG_FILE,
-      desc: "The Bora config file to use"
-
-    class_option :region,
+      desc: 'The Bora config file to use'
+    )
+    class_option(
+      :region,
       type: :string,
       aliases: :r,
       default: nil,
-      desc: "The region to use for the stack operation. Overrides any regions specified in the Bora config file."
-
-    class_option "cfn-stack-name",
+      desc: 'The region to use for the stack operation. Overrides any regions specified in the Bora config file.'
+    )
+    class_option(
+      'cfn-stack-name',
       type: :string,
       aliases: :n,
       default: nil,
-      desc: "The name to give the stack in CloudFormation. Overrides any CFN stack name setting in the Bora config file."
+      desc: 'The name to give the stack in CloudFormation. Overrides any CFN stack name setting in the Bora config file.'
+    )
 
-    desc "list", "Lists the available stacks"
+    desc 'list', 'Lists the available stacks'
     def list
       templates = bora(options.file).templates
-      stacks = templates.collect { |t| t.stacks }.flatten
-      stack_names = stacks.collect { |s| s.stack_name }
+      stacks = templates.collect(&:stacks).flatten
+      stack_names = stacks.collect(&:stack_name)
       puts stack_names.join("\n")
     end
 
-    desc "apply STACK_NAME", "Creates or updates the stack"
+    desc 'apply STACK_NAME', 'Creates or updates the stack'
     option :params, type: :array, aliases: :p, desc: "Parameters to be passed to the template, eg: --params 'instance_type=t2.micro'"
-    option :pretty, type: :boolean, default: false, desc: "Send pretty (formatted) JSON to AWS (only works for cfndsl templates)"
+    option :pretty, type: :boolean, default: false, desc: 'Send pretty (formatted) JSON to AWS (only works for cfndsl templates)'
     def apply(stack_name)
       stack(options.file, stack_name).apply(params, options.pretty)
     end
 
-    desc "delete STACK_NAME", "Deletes the stack"
+    desc 'delete STACK_NAME', 'Deletes the stack'
     def delete(stack_name)
       stack(options.file, stack_name).delete
     end
 
-    desc "diff STACK_NAME", "Diffs the new template with the stack's current template"
+    desc 'diff STACK_NAME', "Diffs the new template with the stack's current template"
     option :params, type: :array, aliases: :p, desc: "Parameters to be passed to the template, eg: --params 'instance_type=t2.micro'"
-    option :context, type: :numeric, aliases: :c, default: 3, desc: "Number of lines of context to show around the differences"
+    option :context, type: :numeric, aliases: :c, default: 3, desc: 'Number of lines of context to show around the differences'
     def diff(stack_name)
       stack(options.file, stack_name).diff(params, options.context)
     end
 
-    desc "events STACK_NAME", "Outputs the latest events from the stack"
+    desc 'events STACK_NAME', 'Outputs the latest events from the stack'
     def events(stack_name)
       stack(options.file, stack_name).events
     end
 
-    desc "outputs STACK_NAME", "Shows the outputs from the stack"
+    desc 'outputs STACK_NAME', 'Shows the outputs from the stack'
     def outputs(stack_name)
       stack(options.file, stack_name).outputs
     end
 
-    desc "parameters STACK_NAME", "Shows the parameters from the stack"
+    desc 'parameters STACK_NAME', 'Shows the parameters from the stack'
     def parameters(stack_name)
       stack(options.file, stack_name).parameters
     end
 
-    desc "recreate STACK_NAME", "Recreates (deletes then creates) the stack"
+    desc 'recreate STACK_NAME', 'Recreates (deletes then creates) the stack'
     option :params, type: :array, aliases: :p, desc: "Parameters to be passed to the template, eg: --params 'instance_type=t2.micro'"
     def recreate(stack_name)
       stack(options.file, stack_name).recreate(params)
     end
 
-    desc "show STACK_NAME", "Shows the new template for stack"
+    desc 'show STACK_NAME', 'Shows the new template for stack'
     option :params, type: :array, aliases: :p, desc: "Parameters to be passed to the template, eg: --params 'instance_type=t2.micro'"
     def show(stack_name)
       stack(options.file, stack_name).show(params)
     end
 
-    desc "show_current STACK_NAME", "Shows the current template for the stack"
+    desc 'show_current STACK_NAME', 'Shows the current template for the stack'
     def show_current(stack_name)
       stack(options.file, stack_name).show_current
     end
 
-    desc "status STACK_NAME", "Displays the current status of the stack"
+    desc 'status STACK_NAME', 'Displays the current status of the stack'
     def status(stack_name)
       stack(options.file, stack_name).status
     end
 
-    desc "validate STACK_NAME", "Checks the stack's template for validity"
+    desc 'validate STACK_NAME', "Checks the stack's template for validity"
     option :params, type: :array, aliases: :p, desc: "Parameters to be passed to the template, eg: --params 'instance_type=t2.micro'"
     def validate(stack_name)
       stack(options.file, stack_name).validate(params)
     end
 
-    desc "changeset SUBCOMMAND ...ARGS", "Manage CloudFormation change sets"
-    subcommand "changeset", CliChangeSet
-
+    desc 'changeset SUBCOMMAND ...ARGS', 'Manage CloudFormation change sets'
+    subcommand 'changeset', CliChangeSet
   end
 end

data/lib/bora/cli_base.rb

@@ -1,11 +1,11 @@
-require "thor"
+require 'thor'
 
 class Bora
   class CliBase < Thor
     # Fix for incorrect subcommand help. See https://github.com/erikhuda/thor/issues/261
-    def self.banner(command, namespace = nil, subcommand = false)
+    def self.banner(command, _namespace = nil, subcommand = false)
       subcommand = subcommand_prefix
-      subcommand_str = subcommand ? " #{subcommand}" : ""
+      subcommand_str = subcommand ? " #{subcommand}" : ''
       "#{basename}#{subcommand_str} #{command.usage}"
     end
 
@@ -16,15 +16,15 @@ class Bora
     no_commands do
       def stack(config_file, stack_name)
         region = options.region
-        cfn_stack_name = options["cfn-stack-name"]
+        cfn_stack_name = options['cfn-stack-name']
 
         override_config = {}
-        override_config["default_region"] = region if region
-        override_config["cfn_stack_name"] = cfn_stack_name if cfn_stack_name
+        override_config['default_region'] = region if region
+        override_config['cfn_stack_name'] = cfn_stack_name if cfn_stack_name
 
         bora = bora(config_file, override_config)
         stack = bora.stack(stack_name)
-        if !stack
+        unless stack
           STDERR.puts "Could not find stack #{stack_name}"
           exit(1)
         end
@@ -36,7 +36,7 @@ class Bora
       end
 
       def params
-        options.params ? Hash[options.params.map { |param| param.split("=", 2) }] : {}
+        options.params ? Hash[options.params.map { |param| param.split('=', 2) }] : {}
       end
     end
   end

data/lib/bora/cli_change_set.rb

@@ -1,40 +1,39 @@
-require "thor"
+require 'thor'
 require 'thor/group'
 
 class Bora
   class CliChangeSet < CliBase
     # Fix for incorrect subcommand help. See https://github.com/erikhuda/thor/issues/261
     def self.subcommand_prefix
-      "changeset"
+      'changeset'
     end
 
-    desc "create STACK_NAME CHANGE_SET_NAME", "Creates a change set"
+    desc 'create STACK_NAME CHANGE_SET_NAME', 'Creates a change set'
     option :params, type: :array, aliases: :p, desc: "Parameters to be passed to the template, eg: --params 'instance_type=t2.micro'"
-    option :description, type: :string, aliases: :d, desc: "A description for this change set"
-    option :pretty, type: :boolean, default: false, desc: "Send pretty (formatted) JSON to AWS (only works for cfndsl templates)"
+    option :description, type: :string, aliases: :d, desc: 'A description for this change set'
+    option :pretty, type: :boolean, default: false, desc: 'Send pretty (formatted) JSON to AWS (only works for cfndsl templates)'
     def create(stack_name, change_set_name)
       stack(options.file, stack_name).create_change_set(change_set_name, options.description, params, options.pretty)
     end
 
-    desc "list STACK_NAME", "Lists all change sets for stack STACK_NAME"
+    desc 'list STACK_NAME', 'Lists all change sets for stack STACK_NAME'
     def list(stack_name)
       stack(options.file, stack_name).list_change_sets
     end
 
-    desc "show STACK_NAME CHANGE_SET_NAME", "Shows the details of the named change set"
+    desc 'show STACK_NAME CHANGE_SET_NAME', 'Shows the details of the named change set'
     def show(stack_name, change_set_name)
       stack(options.file, stack_name).describe_change_set(change_set_name)
     end
 
-    desc "delete STACK_NAME CHANGE_SET_NAME", "Deletes the named change set"
+    desc 'delete STACK_NAME CHANGE_SET_NAME', 'Deletes the named change set'
     def delete(stack_name, change_set_name)
       stack(options.file, stack_name).delete_change_set(change_set_name)
     end
 
-    desc "apply STACK_NAME CHANGE_SET_NAME", "Executes the named change set"
+    desc 'apply STACK_NAME CHANGE_SET_NAME', 'Executes the named change set'
     def apply(stack_name, change_set_name)
       stack(options.file, stack_name).execute_change_set(change_set_name)
     end
-
   end
 end

data/lib/bora/parameter_resolver.rb

@@ -5,7 +5,10 @@ class Bora
   class ParameterResolver
     UnresolvedSubstitutionError = Class.new(StandardError)
 
-    PLACEHOLDER_REGEX = /\${[^}]+}/
+    # Regular expression that can match placeholders nested to two levels.
+    # For example it will match: "${foo-${bar}}".
+    # See https://stackoverflow.com/questions/17759004/how-to-match-string-within-parentheses-nested-in-java
+    PLACEHOLDER_REGEX = /\${([^{}]*|{[^{}]*})*}/
 
     def initialize(stack)
       @stack = stack
@@ -20,7 +23,7 @@ class Bora
         placeholders_were_substituted = false
         params.each do |k, v|
           resolved_value = process_param_substitutions(v, params)
-          unresolved_placeholders_still_remain ||= has_unresolved_placeholder?(resolved_value)
+          unresolved_placeholders_still_remain ||= unresolved_placeholder?(resolved_value)
           placeholders_were_substituted ||= resolved_value != v
           params[k] = resolved_value
         end
@@ -31,13 +34,18 @@ class Bora
       params
     end
 
-
     private
 
     def process_param_substitutions(val, params)
       result = val
       if val.is_a? String
         result = val.gsub(PLACEHOLDER_REGEX) do |placeholder|
+          # Handle nested substitutions, like "${foo-${bar}}
+          if unresolved_placeholder?(placeholder)
+            placeholder_contents = placeholder[2..-2]
+            placeholder = "${#{process_param_substitutions(placeholder_contents, params)}}"
+          end
+
           process_placeholder(placeholder, params)
         end
       elsif val.is_a? Array
@@ -53,7 +61,7 @@ class Bora
       if !uri.scheme
         # This token refers to another parameter, rather than a resolver
         value_to_substitute = params[uri.path]
-        return !value_to_substitute || has_unresolved_placeholder?(value_to_substitute) ? placeholder : value_to_substitute
+        return !value_to_substitute || unresolved_placeholder?(value_to_substitute) ? placeholder : value_to_substitute
       else
         # This token needs to be resolved by a resolver
         resolver_name = uri.scheme
@@ -62,14 +70,14 @@ class Bora
       end
     end
 
-    def has_unresolved_placeholder?(val)
+    def unresolved_placeholder?(val)
       result = false
       if val.is_a? String
         result = val =~ PLACEHOLDER_REGEX
       elsif val.is_a? Array
-        result = val.find { |i| has_unresolved_placeholder?(i) }
+        result = val.find { |i| unresolved_placeholder?(i) }
       elsif val.is_a? Hash
-        result = val.find { |_, v| has_unresolved_placeholder?(v) }
+        result = val.find { |_, v| unresolved_placeholder?(v) }
       end
       result
     end
@@ -79,15 +87,14 @@ class Bora
 
       # Support for legacy CFN substitutions without a scheme, eg: ${stack/outputs/foo}.
       # Will be removed in next breaking version.
-      if !uri.scheme && uri.path && uri.path.count("/") == 2
+      if !uri.scheme && uri.path && uri.path.count('/') == 2
         uri = URI("cfn://#{s}")
       end
       uri
     end
 
     def unresolved_placeholders_as_string(params)
-      params.select { |k, v| has_unresolved_placeholder?(v) }.to_a.map { |k, v| "#{k}: #{v}" }.join("\n")
+      params.select { |_k, v| unresolved_placeholder?(v) }.to_a.map { |k, v| "#{k}: #{v}" }.join("\n")
     end
-
   end
 end

data/lib/bora/parameter_resolver_loader.rb

@@ -3,7 +3,7 @@ class Bora
     ResolverNotFound = Class.new(StandardError)
 
     def load_resolver(name)
-      resolver_class = name.split("_").reject(&:empty?).map { |s| s.capitalize }.join
+      resolver_class = name.split('_').reject(&:empty?).map(&:capitalize).join
       class_name = "Bora::Resolver::#{resolver_class}"
       begin
         resolver_class = Kernel.const_get(class_name)
@@ -14,7 +14,6 @@ class Bora
       resolver_class
     end
 
-
     private
 
     def require_resolver_file(name)
@@ -25,7 +24,5 @@ class Bora
         raise ResolverNotFound, "Could not find resolver for '#{name}'. Expected to find it at '#{require_path}'"
       end
     end
-
-
   end
 end

data/lib/bora/resolver/ami.rb

@@ -21,7 +21,6 @@ class Bora
           owners << 'self'
         end
 
-
         ec2 = Aws::EC2::Client.new(region: @stack.region)
         begin
           images = ec2.describe_images(

data/lib/bora/resolver/cfn.rb

@@ -14,22 +14,22 @@ class Bora
 
       def resolve(uri)
         stack_name = uri.host
-        section, name = uri.path.split("/").reject(&:empty?)
+        section, name = uri.path.split('/').reject(&:empty?)
         if !stack_name || !section || !name || section != 'outputs'
           raise InvalidParameter, "Invalid parameter substitution: #{uri}"
         end
 
-        stack_name, uri_region = stack_name.split(".")
+        stack_name, uri_region = stack_name.split('.')
         region = uri_region || @stack.region
 
         param_stack = @stack_cache[stack_name] || Bora::Cfn::Stack.new(stack_name, region)
-        if !param_stack.exists?
+        unless param_stack.exists?
           raise StackDoesNotExist, "Output #{name} not found in stack #{stack_name} as the stack does not exist"
         end
 
         outputs = param_stack.outputs || []
         matching_output = outputs.find { |output| output.key == name }
-        if !matching_output
+        unless matching_output
           raise ValueNotFound, "Output #{name} not found in stack #{stack_name}"
         end
 

data/lib/bora/resolver/credstash.rb

@@ -1,5 +1,6 @@
 require 'aws-sdk'
 require 'bora/cfn/stack'
+require 'English'
 
 class Bora
   module Resolver
@@ -11,31 +12,30 @@ class Bora
       end
 
       def resolve(uri)
-        raise InvalidParameter, "Invalid credstash parameter #{uri}: no credstash key" if !uri.path
+        raise InvalidParameter, "Invalid credstash parameter #{uri}: no credstash key" unless uri.path
         key = uri.path[1..-1]
         raise InvalidParameter, "Invalid credstash parameter #{uri}: no credstash key" if !key || key.empty?
         region = resolve_region(uri, @stack)
         context = parse_key_context(uri)
         output = `credstash --region #{region} get #{key}#{context}`
-        exit_code = $?
-        raise NotFound, output if exit_code.exitstatus != 0
+        # exit_code = $?
+        raise NotFound, output unless $CHILD_STATUS.success?
         output.rstrip
       end
 
-
       private
 
       def resolve_region(uri, stack)
         region = uri.host || stack.region
+        region
       end
 
       def parse_key_context(uri)
-        return "" if !uri.query
-        query = URI::decode_www_form(uri.query).to_h
-        context_params = query.map { |k,v| "#{k}=#{v}" }.join(" ")
+        return '' unless uri.query
+        query = URI.decode_www_form(uri.query).to_h
+        context_params = query.map { |k, v| "#{k}=#{v}" }.join(' ')
         " #{context_params}"
       end
-
     end
   end
 end