sfn 3.0.12 → 3.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 844e08d945b817d040cd227631e30a62bb2bc591
-  data.tar.gz: a0b766931a02119319fa21c1b1e9158706ec2320
+  metadata.gz: d86015ce1785c5da228500177b6b6520a7157ff3
+  data.tar.gz: 595dea3bfa80bac4cc4f351310309749fbe9a62e
 SHA512:
-  metadata.gz: 1fcb7c461101e3c7de5e253e4e024c3cbcd05c41277ae258e325f696a4dc88c10e74d491ea932be375075e43e7587409402c7147d7aa78f235f1348fb9d800b5
-  data.tar.gz: f5944d0b75b1356a5467ca6180ccecd68e5661f888982726f13d1dad7b3f8e98ffbac0fd78ac267a18c7192c87749adb70e4c2137c0cd5e75488970b78dbcf22
+  metadata.gz: 7c2fe1e37172359fddb155d4a9dd2a185de4534be1a9403bb348a6c0380301eb27a1e878c53855eea7815ce57cb4a93986fd52509b77de54d9ea5871c5adb667
+  data.tar.gz: b418420b239d1944b300a645b9310e948c7f74310d31fafee687eacad0dfede58a54b1c9319efe6f1d458834a9127dbe16cc4cafb9e1693aa7a9414c1f8cc3bb

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v3.0.14
+* [fix] Compile time parameter merging (#211)
+
 # v3.0.12
 * [feature] New linting foundation and `lint` command (#208)
 

data/bin/command-config-generator

@@ -14,7 +14,7 @@ file = File.open(File.join(File.dirname(__FILE__), '..', 'docs', 'command-config
 file.puts <<-EOS
 ---
 title: "Commands and configuration"
-weight: 3
+weight: 6
 anchors:
 EOS
 

data/docs/callbacks.md

@@ -1,6 +1,6 @@
 ---
 title: "Callbacks"
-weight: 4
+weight: 7
 anchors:
   - title: "Enabling Callbacks"
     url: "#enabling-callbacks"

data/docs/command-config.md

@@ -1,6 +1,6 @@
 ---
 title: "Commands and configuration"
-weight: 3
+weight: 6
 anchors:
   - title: "Conf Command"
     url: "#conf-command"
@@ -24,6 +24,8 @@ anchors:
     url: "#init-command"
   - title: "Inspect Command"
     url: "#inspect-command"
+  - title: "Lint Command"
+    url: "#lint-command"
   - title: "List Command"
     url: "#list-command"
   - title: "Print Command"
@@ -887,6 +889,93 @@ $ sfn inspect
 | | Valid | `TrueClass`, `FalseClass` |
 | | Default | |
 
+## Lint Command
+
+~~~
+$ sfn lint
+~~~
+
+| Option | Attribute | Value
+|--------|-----------|------
+| `--apply-nesting` | Description | Apply stack nesting |
+| | Valid | `String`, `Symbol` |
+| | Default | "deep"|
+| `--base-directory` | Description | Path to root of of templates directory |
+| | Valid | `String` |
+| | Default | |
+| `--compile-parameters` | Description | Pass template compile time parameters directly |
+| | Valid | `Bogo::Smash` |
+| | Default | |
+| `--config` | Description | Configuration file path |
+| | Valid | `String` |
+| | Default | |
+| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
+| | Valid | `Bogo::Smash` |
+| | Default | |
+| `--debug` | Description | Enable debug output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
+| `--defaults` | Description | Automatically accept default values |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
+| `--disabled-rule-set` | Description | Disable rule set from being applied |
+| | Valid | `String` |
+| | Default | |
+| `--enabled-rule-set` | Description | Only apply this rule set |
+| | Valid | `String` |
+| | Default | |
+| `--file` | Description | Path to template file |
+| | Valid | `String` |
+| | Default | |
+| `--file-path-prompt` | Description | Enable interactive prompt for template path discovery |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
+| `--ignore-parameters` | Description | Parameters to ignore during modifications |
+| | Valid | `String` |
+| | Default | |
+| `--interactive-parameters` | Description | Prompt for template parameters |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
+| `--lint-directory` | Description | Directory containing lint rule sets |
+| | Valid | `String` |
+| | Default | |
+| `--local-rule-sets-only` | Description | Only apply rule sets provided by lint directory |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | false|
+| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
+| | Valid | `String` |
+| | Default | |
+| `--nesting-prefix` | Description | File name prefix for storing template in bucket |
+| | Valid | `String` |
+| | Default | |
+| `--no-base-directory` | Description | Unset any value used for the template root directory path |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
+| `--poll` | Description | Poll stack events on modification actions |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
+| `--print-only` | Description | Print the resulting stack template |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
+| `--processing` | Description | Call the unicorns and explode the glitter bombs |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
+| `--sparkle-pack` | Description | Load SparklePack gem |
+| | Valid | `String` |
+| | Default | |
+| `--translate` | Description | Translate generated template to given provider |
+| | Valid | `String` |
+| | Default | |
+| `--translate-chunk` | Description | Chunk length for serialization |
+| | Valid | `Integer` |
+| | Default | |
+| `--upload-root-template` | Description | Upload root template to storage bucket |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
+| `--yes` | Description | Automatically accept any requests for confirmation |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
+
 ## List Command
 
 ~~~

data/docs/lint.md

@@ -1,25 +1,113 @@
 ---
 title: "Lint"
-weight: 5
+weight: 8
+anchors:
+  - title: "Lint Framework"
+    url: "#lint-framework"
+  - title: "Composition"
+    url: "#composition"
+  - title: "Usage"
+    url: "#usage"
 ---
 
 ## Lint
 
-The lint framework built within the sfn tool utilizes the JMESPath query language
+The lint framework built within the sfn tool utilizes the [JMESPath][jmespath] query language
 for identifying patterns and apply validation rules.
 
-### Lint RuleSets
+### Lint Framework
 
-#### Local
+A rule set is a named collection of rules to be applied to a template. Each rule
+is composed of one or more definitions. A rule passes only if _all_ definitions
+can be successfully applied. Linting related classes:
 
-Create rule sets using the generator. Each file must contain a single
-lint rule set. Below is a simple rule set used to flag non-AWS type
-resources:
+* `Sfn::Lint::RuleSet`
+* `Sfn::Lint::Rule`
+* `Sfn::Lint::Definition`
+
+### Composition
+
+#### Long Form
+
+##### `Sfn::Lint::Definition`
+
+Definitions define a search expression to be applied to a given template. The search
+expression is a [JMESPath compatible query expression][jmespath-expr]. The matches
+of the search expression are then processed. If the results are valid, a `true` result
+is expected. If the results are invalid, a `false` value is expected, or an `Array<String>`
+value is expected which provides the list of invalid items.
 
 ~~~ruby
-# tests/lint/resource_type_check.rb
+Sfn::Lint::Definition.new('Resources.[*][0][*].Type') do |matches, template|
+  unless(search.nil?)
+    result = search.find_all{|i| !i.start_with?('AWS')}
+    result.empty? ? true : result
+  else
+    true
+  end
+end
+~~~
+
+The processing block is provided two arguments. The first is the match result of the
+search expression. The second is the full template `Hash` that is being processed.
+
+##### `Sfn::Lint::Rule`
+
+Rules are composed of definitions. When a rule is applied to a template it will only
+pass if _all_ definitions are successfully applied. A rule also includes a failure
+message to provide user context of the failure.
+
+~~~ruby
+definition = Sfn::Lint::Definition.new('Resources.[*][0][*].Type') do |matches, template|
+  unless(search.nil?)
+    result = search.find_all{|i| !i.start_with?('AWS')}
+    result.empty? ? true : result
+  else
+    true
+  end
+end
+
+Sfn::Lint::Rule.new(
+  :aws_resources_only,
+  [definition],
+  'All types must be within AWS root namespace'
+)
+~~~
+
+##### `Sfn::Lint::RuleSet`
+
+A rule set is a named collection of rules. It allows logically grouping related
+rules together. Rule sets are the entry point of linting actions on templates. Once
+a rule set has been created, it must then be registered to be made available.
+
+~~~ruby
+definition = Sfn::Lint::Definition.new('Resources.[*][0][*].Type') do |matches, template|
+  unless(search.nil?)
+    result = search.find_all{|i| !i.start_with?('AWS')}
+    result.empty? ? true : result
+  else
+    true
+  end
+end
+
+rule = Sfn::Lint::Rule.new(
+  :aws_resources_only,
+  [definition],
+  'All types must be within AWS root namespace'
+)
+
+rule_set = Sfn::Lint::RuleSet.new(:aws_rules, [rule])
+Sfn::Lint::RuleSet.register(rule_set)
+~~~
 
-RuleSet.build(:test) do
+#### Short Form
+
+Rule sets can also be created using a generator which reduces the amount of effort required
+for composition. The same rule set defined above can be created using the `RuleSet.build`
+generator:
+
+~~~ruby
+rule_set = Sfn::Lint::RuleSet.build(:aws_rules) do
   rule :aws_resources_only do
     definition 'Resources.[*][0][*].Type' do |search|
       unless(search.nil?)
@@ -33,15 +121,41 @@ RuleSet.build(:test) do
     fail_message 'All types must be within AWS root namespace'
   end
 end
+
+Sfn::Lint::RuleSet.register(rule_set)
+~~~
+
+### Usage
+
+Linting functionality is available via the `lint` command. The only requirement of the `lint`
+command is a template provided by the `--file` flag:
+
+~~~
+$ sfn lint --file my-template
+~~~
+
+By default all registered rule sets applicable to the template will be applied. Rule sets can
+be disabled by name to prevent them from being applied:
+
 ~~~
+$ sfn lint --file my-template --disable-rule-set aws_rules
+~~~
+
+or you can explicitly specify what rule sets should be applied:
 
-#### Library
+~~~
+$ sfn lint --file my-template --enable-rule-set aws_rules
+~~~
 
-When a rule set is defined within a library, it must use the full constant namespace and
-must register to allow access to the rule set:
+#### Local rule sets
+
+Rule sets can be created for a local project. These rule sets are kept within a directory, and
+should be defined as a single rule set per file. For example, having a directory `tests/lint`
+the rule set can be created:
 
 ~~~ruby
-my_ruleset = Sfn::Lint::RuleSet.build(:test) do
+# tests/lint/resource_type_check.rb
+RuleSet.build(:aws_rules) do
   rule :aws_resources_only do
     definition 'Resources.[*][0][*].Type' do |search|
       unless(search.nil?)
@@ -55,18 +169,20 @@ my_ruleset = Sfn::Lint::RuleSet.build(:test) do
     fail_message 'All types must be within AWS root namespace'
   end
 end
-Sfn::Lint::RuleSet.register(my_ruleset)
 ~~~
 
-### Usage
+To include the local rule sets the target directory must be provided:
 
-By default `sfn` will apply any registered rule sets that are defined for the target provider.
-
-#### Local
+~~~
+$ sfn lint --file my-template --lint-directory tests/lint
+~~~
 
-Provide a template and lint directory to the `lint` command. For example,
-if lint rule sets are defined within `tests/lint`:
+and if _only_ local rule sets should be applied, it is possible to disable all registered
+rule sets:
 
 ~~~
-$ sfn lint --file my-template --lint-directory tests/lint
+$ sfn lint --file my-template --lint-directory tests/lint --local-rule-sets-only
 ~~~
+
+[jmespath]: http://jmespath.org/
+[jmespath-expr]: http://jmespath.org/specification.html

data/docs/sparkle-packs.md

@@ -1,6 +1,6 @@
 ---
 title: "SparklePacks"
-weight: 4
+weight: 6
 anchors:
   - title: "Enabling SparklePacks"
     url: "#enabling-sparklepacks"

data/lib/sfn/command_module/template.rb

@@ -166,14 +166,7 @@ module Sfn
             config[:template]
           elsif(config[:file])
             if(config[:processing])
-              compile_state = config.fetch(:compile_parameters, Smash.new)
-              compile_state.keys.each do |cs_key|
-                if(cs_key.to_s.start_with?(arguments.first.to_s))
-                  cli_provided = compile_state.delete(cs_key.to_s.sub("#{arguments.first.to_s}__", ''))
-                  compile_state[cs_key].deep_merge!(cli_provided)
-                end
-              end
-              ui.debug "Merged compile parameters - #{compile_state}"
+              compile_state = merge_compile_time_parameters
               sf = SparkleFormation.compile(config[:file], :sparkle)
               if(name_args.first)
                 sf.name = name_args.first
@@ -234,6 +227,27 @@ module Sfn
           end
         end
 
+        # Merge parameters provided directly via configuration into
+        # core parameter set
+        def merge_compile_time_parameters
+          compile_state = config.fetch(:compile_parameters, Smash.new)
+          compile_state.keys.each do |cs_key|
+            if(cs_key.to_s.start_with?("#{arguments.first}__"))
+              cli_provided = compile_state.delete(cs_key.to_s.sub("#{arguments.first.to_s}__", ''))
+              if(cli_provided)
+                compile_state[cs_key].deep_merge!(cli_provided)
+              end
+            end
+          end
+          compile_state.keys.each do |cs_key|
+            unless(cs_key.start_with?("#{arguments.first}__"))
+              compile_state["#{arguments.first}__#{cs_key}"] = compile_state.delete(cs_key)
+            end
+          end
+          ui.debug "Merged compile parameters - #{compile_state}"
+          compile_state
+        end
+
         # Force user friendly error if nesting bucket is not set within configuration
         def validate_nesting_bucket!
           if(config[:nesting_bucket].to_s.empty?)

data/lib/sfn/config/lint.rb

@@ -21,7 +21,8 @@ module Sfn
       )
       attribute(
         :local_rule_sets_only, [TrueClass, FalseClass],
-        :description => 'Only apply rule sets provided by lint directory'
+        :description => 'Only apply rule sets provided by lint directory',
+        :default => false
       )
     end
   end

data/lib/sfn/config/validate.rb

@@ -83,7 +83,7 @@ module Sfn
             v.split(',').each do |item_pair|
               key, value = item_pair.split(/[=:]/, 2)
               key = key.split('__')
-              key = [key.pop, key.map{|x| Bogo::Utility.camel(x)}.join('__')].reverse
+              key = [key.pop, key.join('__')].reverse
               result.set(*key, value)
             end
             result

data/lib/sfn/version.rb

@@ -1,4 +1,4 @@
 module Sfn
   # Current library version
-  VERSION = Gem::Version.new('3.0.12')
+  VERSION = Gem::Version.new('3.0.14')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sfn
 version: !ruby/object:Gem::Version
-  version: 3.0.12
+  version: 3.0.14
 platform: ruby
 authors:
 - Chris Roberts