bora 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac9d90b2d54df77a725e4a46b058487d8d9f7b8a
-  data.tar.gz: fae956da14fb179a49272ac1bdbcb38819c16126
+  metadata.gz: 741e43489dd8279e5b9a2fa73068bd45bbfcc7de
+  data.tar.gz: 708c036c31038bec8dc57a61541af3065f4bf2c9
 SHA512:
-  metadata.gz: 7197598d07836d355d9f3b26686bcb282585ea31597c77da5d6a60e4d6fc2cec353211c95e150866131a93fedf346b2574e0ef894e5c04176ad7dcdf39032fa6
-  data.tar.gz: a0bcdd446b1107014fc8f17e12c4d03b227ed3a57856fc54d18d55711b7b8e10dc135cc4fad7f1653d823bc1b0ff99827c455db44e887a4845e423986b739ae9
+  metadata.gz: 85b831a26bb9876db1a32a00238b1d489582a5f87adcb105d5103414d1274d175f53bc8123287a603a811e0f43ee2e336b0704e71107d85698507cbd84e176ac
+  data.tar.gz: 957e597af2294f73976630840ef64dbcdb2f078ea2085b39e0aa9d4d2e9950168ac7c292b1aa67fc9d394ee52abcade685573070d7e7ff419c7a5fda6349eb11

data/README.md

@@ -102,7 +102,7 @@ templates:
         # If you don't supply this, the name will be the template
         # name concatenated with the stack name as defined in this file,
         # eg: "app-prod".
-        stack_name: prod-application-stack
+        cfn_stack_name: prod-application-stack
 
         # Optional. Default region for this stack.
         # Overrides "default_region" at the template level.
@@ -219,6 +219,17 @@ There are a number of resolvers that come with Bora (documented below),
 or you can write your own.
 
 
+### Parameter Lookup
+Any substitution that does not specify a "scheme" is treated as a reference to another parameter value.
+For example:
+
+```yaml
+params:
+  domain: example.com
+  url: http://${domain}/foo
+```
+
+
 ### Stack Output Lookup
 
 You can look up outputs from stacks in the same region.
@@ -280,6 +291,30 @@ $ rake web-uat:apply[instance_type=t2.micro,ami=ami-11032472]
 ```
 
 
+## Creating Multiple Instances of a Stack
+Sometimes it can be useful to create multiple instances of a single stack.
+For example, you may define a single "qa" stack with all the settings for a testing environment.
+Then you might want to stand up this stack multiple times so you can have multiple testing environments,
+eg "qa1", "qa2", etc.
+
+Bora makes this possible by allowing you to override the name of the stack that gets created in CloudFormation.
+For example:
+
+```bash
+$ bora apply web-qa --cfn-stack-name "web-qa-1"
+$ bora apply web-qa --cfn-stack-name "web-qa-2"
+```
+
+Remember that if you use this functionality you must remember to pass in the stack name to *every* command or you will get unexepected results.
+
+```bash
+$ bora outputs web-qa --cfn-stack-name "web-qa-1"
+```
+
+Work is underway to improve how Bora handles this use case.
+If this is of interest to you, please have a look at the [GitHub issue](https://github.com/ampedandwired/bora/issues/10) for this functionality.
+
+
 ## Related Projects
 The following projects provided inspiration for Bora:
 * [CfnDsl](https://github.com/stevenjack/cfndsl) - A Ruby DSL for CloudFormation templates

data/lib/bora/cli.rb

@@ -15,6 +15,12 @@ class Bora
       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",
+      type: :string,
+      aliases: :c,
+      default: nil,
+      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"
     def list
       templates = bora(options.file).templates
@@ -84,7 +90,12 @@ class Bora
 
     def stack(config_file, stack_name)
       region = options.region
-      override_config = region ? {"default_region" => region} : {}
+      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
+
       bora = bora(config_file, override_config)
       stack = bora.stack(stack_name)
       if !stack

data/lib/bora/parameter_resolver.rb

@@ -3,6 +3,10 @@ require 'bora/parameter_resolver_loader'
 
 class Bora
   class ParameterResolver
+    UnresolvedSubstitutionError = Class.new(StandardError)
+
+    PLACEHOLDER_REGEX = /\${[^}]+}/
+
     def initialize(stack)
       @stack = stack
       @loader = ParameterResolverLoader.new
@@ -10,26 +14,49 @@ class Bora
     end
 
     def resolve(params)
-      params.map { |k, v| [k, process_param_substitutions(v)] }.to_h
+      unresolved_placeholders_still_remain = true
+      while unresolved_placeholders_still_remain
+        unresolved_placeholders_still_remain = false
+        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)
+          placeholders_were_substituted ||= resolved_value != v
+          params[k] = resolved_value
+        end
+        if unresolved_placeholders_still_remain && !placeholders_were_substituted
+          raise UnresolvedSubstitutionError, "Parameter substitutions could not be resolved:\n#{unresolved_placeholders_as_string(params)}"
+        end
+      end
+      params
     end
 
 
     private
 
-    def process_param_substitutions(val)
+    def process_param_substitutions(val, params)
       return val unless val.is_a? String
-      old_val = nil
-      while old_val != val
-        old_val = val
-        val = val.sub(/\${[^}]+}/) do |m|
-          token = m[2..-2]
-          uri = parse_uri(token)
-          resolver_name = uri.scheme
-          resolver = @resolver_cache[resolver_name] || @loader.load_resolver(resolver_name).new(@stack)
-          resolver.resolve(uri)
-        end
+      val.gsub(PLACEHOLDER_REGEX) do |placeholder|
+        process_placeholder(placeholder, params)
+      end
+    end
+
+    def process_placeholder(placeholder, params)
+      uri = parse_uri(placeholder[2..-2])
+      if !uri.scheme
+        # This token refers to another parameter, rather than a resolver
+        value_to_substitute = params[uri.path]
+        !value_to_substitute || has_unresolved_placeholder?(value_to_substitute) ? placeholder : value_to_substitute
+      else
+        # This token needs to be resolved by a resolver
+        resolver_name = uri.scheme
+        resolver = @resolver_cache[resolver_name] || @loader.load_resolver(resolver_name).new(@stack)
+        resolver.resolve(uri)
       end
-      val
+    end
+
+    def has_unresolved_placeholder?(val)
+      val =~ PLACEHOLDER_REGEX
     end
 
     def parse_uri(s)
@@ -40,9 +67,12 @@ class Bora
       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")
+    end
+
   end
 end

data/lib/bora/stack.rb

@@ -18,7 +18,10 @@ class Bora
 
     def initialize(stack_name, template_file, stack_config)
       @stack_name = stack_name
-      @cfn_stack_name = stack_config['stack_name'] || @stack_name
+      @cfn_stack_name = stack_config['cfn_stack_name'] || stack_config['stack_name'] || @stack_name
+      if stack_config['stack_name']
+        puts "DEPRECATED: The 'stack_name' setting is deprecated. Please use 'cfn_stack_name' instead."
+      end
       @template_file = template_file
       @stack_config = stack_config
       @region = @stack_config['default_region']

data/lib/bora/template.rb

@@ -2,16 +2,20 @@ require 'bora/stack'
 
 class Bora
   class Template
+    # These are properties that you can define on the template, but which can also be defined in the stack
     INHERITABLE_PROPERTIES = ["capabilities", "default_region"]
 
+    # These are properties that can be passed in from the command line to override what's defined inthe stack
+    OVERRIDABLE_PROPERTIES = ["cfn_stack_name"]
+
     def initialize(template_name, template_config, override_config = {})
       @template_name = template_name
       @template_config = template_config
       @stacks = {}
       template_config['stacks'].each do |stack_name, stack_config|
         stack_name = "#{template_name}-#{stack_name}"
-        stack_config = resolve_stack_config(template_config, stack_config, override_config)
-        @stacks[stack_name] = Stack.new(stack_name, template_config['template_file'], stack_config)
+        resolved_config = resolve_stack_config(template_config, stack_config, override_config)
+        @stacks[stack_name] = Stack.new(stack_name, template_config['template_file'], resolved_config)
       end
     end
 
@@ -31,12 +35,16 @@ class Bora
     private
 
     def resolve_stack_config(template_config, stack_config, override_config)
-      inheritable_properties(template_config).merge(stack_config).merge(inheritable_properties(override_config))
+      inheritable_properties(template_config).merge(stack_config).merge(overridable_properties(override_config))
     end
 
     def inheritable_properties(config)
       config.select { |k| INHERITABLE_PROPERTIES.include?(k) }
     end
 
+    def overridable_properties(config)
+      config.select { |k| INHERITABLE_PROPERTIES.include?(k) || OVERRIDABLE_PROPERTIES.include?(k) }
+    end
+
   end
 end

data/lib/bora/version.rb

@@ -1,3 +1,3 @@
 class Bora
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bora
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Charles Blaxland
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-12 00:00:00.000000000 Z
+date: 2016-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk