stack_master 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8db962bf4169a452e81cee1d7ece124096742f13
-  data.tar.gz: 865423915902223abcf444b3431b8db49c6011a7
+  metadata.gz: ce12082b568677adbd824876ec9bdc2c64e399f8
+  data.tar.gz: 854fe4aa23253b1ae5eaec64b1f8ac6fbef97ac1
 SHA512:
-  metadata.gz: 79fa18d43b6e1b2db51f0376f481793b6604476cf4311e21505a3c9507569fa1834b5f036a782f679aa14cd5d7fbb2ca8811d846fed95a5e710b4d88b3893dd3
-  data.tar.gz: 1c9b305fcfae1a2705ade052e48f070468dcfe33852c2cc54ee153b3d6e9286e449f9d66c9d10e2cba2d2d54e4c65cf440af766366e03cae2e3735cf1da6299c
+  metadata.gz: 598cd004f968afdc315d4d5132e63d5c430180102b7d0ea6299163ce143ff0d5682dd0c13d84bd35e3044c981250750539624793f132bc8d9aed271475adf5b2
+  data.tar.gz: e395e0c8ea148cac6a14c82680463539d4143751e2f673323e6e8b7b221dcdaea6c3f2d1853fdb31afa773b774d33f4a55adf7d3cdaf23d3d528af2f64f71d79

data/.travis.yml

@@ -1,9 +1,11 @@
 language: ruby
-rvm:
-  - 2.1
-  - 2.2
-  - 2.3.1
-  - 2.4.0
+matrix:
+  include:
+    - rvm: 2.1.10
+      gemfile: spec/support/gemfiles/Gemfile.activesupport-4.0.0
+    - rvm: 2.2.7
+    - rvm: 2.3.4
+    - rvm: 2.4.1
 sudo: false
 script:
   - bundle exec rake spec features

data/README.md

@@ -155,6 +155,21 @@ A simple parameter file could look like this:
 key_name: myapp-us-east-1
 ```
 
+### Compile Time Parameters
+
+Compile time parameters can be used for [SparkleFormation](http://www.sparkleformation.io) templates. It conforms and 
+allows you to use the [Compile Time Parameters](http://www.sparkleformation.io/docs/sparkle_formation/compile-time-parameters.html) feature
+
+A simple example looks like this
+
+```
+vpc_cidr: 10.0.0.0/16
+compile_time_parameters:
+  subnet_cidrs:
+    - 10.0.0.0/28
+    - 10.0.2.0/28
+```
+
 Keys in parameter files are automatically converted to camel case.
 
 ## Parameter Resolvers

data/features/apply.feature

@@ -304,7 +304,6 @@ Feature: Apply command
       | Parameters diff: No changes                                                    |
     Then the exit status should be 0
 
-
   Scenario: Create a stack using a stack output resolver
     Given a file named "parameters/myapp_web.yml" with:
       """

data/features/apply_with_compile_time_parameters.feature

@@ -0,0 +1,93 @@
+Feature: Apply command with compile time parameters
+
+  Background:
+    Given a file named "stack_master.yml" with:
+    """
+          stacks:
+            us-east-1:
+              vpc:
+                template: vpc.rb
+          """
+    And a directory named "parameters"
+    And a file named "parameters/vpc.yml" with:
+    """
+          vpc_cidr: 10.200.2.0/23
+          compile_time_parameters:
+             private_subnet_cidrs:
+              - 10.0.0.0/32:ap-southeast-2
+              - 10.0.0.2/32:ap-southeast-1
+          """
+    And a directory named "templates"
+    And a file named "templates/vpc.rb" with:
+    """
+          SparkleFormation.new(
+              :vpc,
+              {
+                  compile_time_parameters: {
+                      private_subnet_cidrs: {
+                          type: :string,
+                          multiple: true
+                      }
+                  }
+              }
+          ) do
+
+            parameters.vpc_cidr do
+              type 'String'
+            end
+
+            resources.vpc do
+              type 'AWS::EC2::VPC'
+              properties do
+                cidr_block ref!(:vpc_cidr)
+              end
+            end
+
+            state!(:private_subnet_cidrs).each_with_index do |item, index|
+              private_subnet = item.split(':')
+              private_cidr = private_subnet[0]
+              private_az = private_subnet[1]
+              resources.set!("subnet_private_#{index}".to_sym) do
+                type 'AWS::EC2::Subnet'
+                properties do
+                  vpc_id ref!(:vpc)
+                  availability_zone private_az
+                  cidr_block private_cidr
+                end
+              end
+            end
+
+          end
+          """
+
+  Scenario: Run apply and create a new stack
+    Given I stub the following stack events:
+      | stack_id | event_id | stack_name | logical_resource_id | resource_status | resource_type              | timestamp           |
+      | 1        | 1        | vpc        | SubnetPrivate1      | CREATE_COMPLETE | AWS::EC2::Subnet           | 2020-10-29 00:00:00 |
+      | 1        | 1        | vpc        | SubnetPrivate0      | CREATE_COMPLETE | AWS::EC2::Subnet           | 2020-10-29 00:00:00 |
+      | 1        | 1        | vpc        | Vpc                 | CREATE_COMPLETE | AWS::EC2::VPC              | 2020-10-29 00:00:00 |
+      | 1        | 1        | vpc        | vpc                 | CREATE_COMPLETE | AWS::CloudFormation::Stack | 2020-10-29 00:00:00 |
+    When I run `stack_master apply us-east-1 vpc --trace`
+    And the output should contain all of these lines:
+      | +    "SubnetPrivate0": {                          |
+      | +      "Type": "AWS::EC2::Subnet",                |
+      | +      "Properties": {                            |
+      | +        "VpcId": {                               |
+      | +          "Ref": "Vpc"                           |
+      | +        },                                       |
+      | +        "AvailabilityZone": "ap-southeast-2",    |
+      | +        "CidrBlock": "10.0.0.0/32"               |
+      | +      }                                          |
+      | +    },                                           |
+      | +    "SubnetPrivate1": {                          |
+      | +      "Type": "AWS::EC2::Subnet",                |
+      | +      "Properties": {                            |
+      | +        "VpcId": {                               |
+      | +          "Ref": "Vpc"                           |
+      | +        },                                       |
+      | +        "AvailabilityZone": "ap-southeast-1",    |
+      | +        "CidrBlock": "10.0.0.2/32"               |
+      | +      }                                          |
+      | +    }                                            |
+    And the output should match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
+    Then the exit status should be 0

data/lib/stack_master/parameter_loader.rb

@@ -1,20 +1,49 @@
+require 'active_support/core_ext/object/deep_dup'
+
 module StackMaster
   class ParameterLoader
+
+    COMPILE_TIME_PARAMETERS_KEY = 'compile_time_parameters'
+
     def self.load(parameter_files)
-      StackMaster.debug "Searching for parameter files..."
-      parameter_files.reduce({}) do |hash, file_name|
-        parameters = if File.exists?(file_name)
-         StackMaster.debug "  #{file_name} found"
-          YAML.load(File.read(file_name)) || {}
-        else
-         StackMaster.debug "  #{file_name} not found"
-          {}
-        end
-        parameters.each do |key, value|
-          hash[key.camelize] = value
-        end
+      StackMaster.debug 'Searching for parameter files...'
+      parameter_files.reduce({template_parameters: {}, compile_time_parameters: {}}) do |hash, file_name|
+        parameters = load_parameters(file_name)
+        template_parameters = create_template_parameters(parameters)
+        compile_time_parameters = create_compile_time_parameters(parameters)
+
+        merge_and_camelize(hash[:template_parameters], template_parameters)
+        merge_and_camelize(hash[:compile_time_parameters], compile_time_parameters)
         hash
       end
+
     end
+
+    private
+
+    def self.load_parameters(file_name)
+      file_exists = File.exists?(file_name)
+      StackMaster.debug file_exists ? "  #{file_name} found" : "  #{file_name} not found"
+      file_exists ? load_file(file_name) : {}
+    end
+
+    def self.load_file(file_name)
+      YAML.load(File.read(file_name)) || {}
+    end
+
+    def self.create_template_parameters(parameters)
+      parameters.deep_dup.tap do |parameters_clone|
+        parameters_clone.delete(COMPILE_TIME_PARAMETERS_KEY) || parameters_clone.delete(COMPILE_TIME_PARAMETERS_KEY.camelize)
+      end
+    end
+
+    def self.create_compile_time_parameters(parameters)
+      (parameters[COMPILE_TIME_PARAMETERS_KEY] || parameters[COMPILE_TIME_PARAMETERS_KEY.camelize] || {}).deep_dup
+    end
+
+    def self.merge_and_camelize(hash, parameters)
+      parameters.each { |key, value| hash[key.camelize] = value }
+    end
+
   end
 end

data/lib/stack_master/sparkle_formation/compile_time/allowed_pattern_validator.rb

@@ -0,0 +1,35 @@
+require_relative 'value_validator'
+
+module StackMaster
+  module SparkleFormation
+    module CompileTime
+      class AllowedPatternValidator < ValueValidator
+
+        KEY = :allowed_pattern
+
+        def initialize(name, definition, parameter)
+          @name = name
+          @definition = definition
+          @parameter = parameter
+        end
+
+        private
+
+        def check_is_valid
+          return true unless @definition.key?(KEY)
+          invalid_values.empty?
+        end
+
+        def invalid_values
+          values = build_values(@definition, @parameter)
+          values.reject { |value| value.to_s.match(%r{#{@definition[KEY]}}) }
+        end
+
+        def create_error
+          "#{@name}:#{invalid_values} does not match #{KEY}:#{@definition[KEY]}"
+        end
+
+      end
+    end
+  end
+end

data/lib/stack_master/sparkle_formation/compile_time/allowed_values_validator.rb

@@ -0,0 +1,37 @@
+require_relative 'value_validator'
+
+module StackMaster
+  module SparkleFormation
+    module CompileTime
+      class AllowedValuesValidator < ValueValidator
+
+        KEY = :allowed_values
+
+        def initialize(name, definition, parameter)
+          @name = name
+          @definition = definition
+          @parameter = parameter
+        end
+
+        private
+
+        def check_is_valid
+          return true unless @definition.key?(KEY)
+          invalid_values.empty?
+        end
+
+        def invalid_values
+          values = build_values(@definition, @parameter)
+          values.reject do |value|
+            @definition[KEY].any? { |allowed_value| allowed_value.to_s == value.to_s}
+          end
+        end
+
+        def create_error
+          "#{@name}:#{invalid_values} is not in #{KEY}:#{@definition[KEY]}"
+        end
+
+      end
+    end
+  end
+end

data/lib/stack_master/sparkle_formation/compile_time/definitions_validator.rb

@@ -0,0 +1,33 @@
+require_relative 'value_validator'
+
+module StackMaster
+  module SparkleFormation
+    module CompileTime
+      class DefinitionsValidator
+
+        VALID_TYPES = [:string, :number]
+        def initialize(definitions)
+          @definitions = definitions
+        end
+
+        def validate
+          @definitions.each do|name, definition|
+            type = definition[:type]
+            raise ArgumentError.new "Unknown compile time parameter type: #{create_error(name, type)}" unless is_valid(type)
+          end
+        end
+
+        private
+
+        def is_valid(type)
+          VALID_TYPES.include? type
+        end
+
+        def create_error(name, type)
+          "#{name}:#{type} valid types are #{VALID_TYPES}"
+        end
+
+      end
+    end
+  end
+end

data/lib/stack_master/sparkle_formation/compile_time/empty_validator.rb

@@ -0,0 +1,32 @@
+require_relative 'value_validator'
+
+module StackMaster
+  module SparkleFormation
+    module CompileTime
+      class EmptyValidator < ValueValidator
+
+        def initialize(name, definition, parameter)
+          @name = name
+          @definition = definition
+          @parameter = parameter
+        end
+
+        private
+
+        def check_is_valid
+          !has_invalid_values?
+        end
+
+        def has_invalid_values?
+          values = build_values(@definition, @parameter)
+          values.include?(nil) || values.include?('')
+        end
+
+        def create_error
+          "#{@name} cannot contain empty parameters:#{@parameter.inspect}"
+        end
+
+      end
+    end
+  end
+end

data/lib/stack_master/sparkle_formation/compile_time/max_length_validator.rb

@@ -0,0 +1,36 @@
+require_relative 'value_validator'
+
+module StackMaster
+  module SparkleFormation
+    module CompileTime
+      class MaxLengthValidator < ValueValidator
+
+        KEY = :max_length
+
+        def initialize(name, definition, parameter)
+          @name = name
+          @definition = definition
+          @parameter = parameter
+        end
+
+        private
+
+        def check_is_valid
+          return true unless @definition[:type] == :string
+          return true unless @definition.key?(KEY)
+          invalid_values.empty?
+        end
+
+        def invalid_values
+          values = build_values(@definition, @parameter)
+          values.select { |values| values.length > @definition[KEY].to_i }
+        end
+
+        def create_error
+          "#{@name}:#{invalid_values} must not exceed #{KEY}:#{@definition[KEY]} characters"
+        end
+
+      end
+    end
+  end
+end

data/lib/stack_master/sparkle_formation/compile_time/max_size_validator.rb

@@ -0,0 +1,36 @@
+require_relative 'value_validator'
+
+module StackMaster
+  module SparkleFormation
+    module CompileTime
+      class MaxSizeValidator < ValueValidator
+
+        KEY = :max_size
+
+        def initialize(name, definition, parameter)
+          @name = name
+          @definition = definition
+          @parameter = parameter
+        end
+
+        private
+
+        def check_is_valid
+          return true unless @definition[:type] == :number
+          return true unless @definition.key?(KEY)
+          invalid_values.empty?
+        end
+
+        def invalid_values
+          values = build_values(@definition, @parameter)
+          values.select { |value| value.to_f > @definition[KEY].to_f }
+        end
+
+        def create_error
+          "#{@name}:#{invalid_values} must not be greater than #{KEY}:#{@definition[KEY]}"
+        end
+
+      end
+    end
+  end
+end

data/lib/stack_master/sparkle_formation/compile_time/min_length_validator.rb

@@ -0,0 +1,36 @@
+require_relative 'value_validator'
+
+module StackMaster
+  module SparkleFormation
+    module CompileTime
+      class MinLengthValidator < ValueValidator
+
+        KEY = :min_length
+
+        def initialize(name, definition, parameter)
+          @name = name
+          @definition = definition
+          @parameter = parameter
+        end
+
+        private
+
+        def check_is_valid
+          return true unless @definition[:type] == :string
+          return true unless @definition.key?(KEY)
+          invalid_values.empty?
+        end
+
+        def invalid_values
+          values = build_values(@definition, @parameter)
+          values.select { |value| value.length < @definition[KEY].to_i}
+        end
+
+        def create_error
+          "#{@name}:#{invalid_values} must be at least #{KEY}:#{@definition[KEY]} characters"
+        end
+
+      end
+    end
+  end
+end