stack_master 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d31b69b485cf1a596a57888078b05db3d39b2371810b27c3ee99adff8511a99c
-  data.tar.gz: d20bcd9566689b3f81bdb3fcb78d2b6396ab1fa7766f47f8cb6d31f0bd0664a9
+  metadata.gz: 07d864d8296f8ef63b16a68d3989ad872bdccf74db2d3b83ce5091f6f9ccc8d2
+  data.tar.gz: 1ba9e5731843eb3c0c15142d17ec194850c46eee64eb3b272b9b74724def426f
 SHA512:
-  metadata.gz: 29bd9ff5a5b8f0277eb29afc04df6a20c2feabcad86672835572b0c50e03c7ad8785dd70bb28747e433b298476b2f388899bc9f1879df2999c1e2fc716a7687e
-  data.tar.gz: add78325db65cc03a46cd9870e4733b02e0d8c7eaa15652f7dd97b00413adb54a1f63b2e80d1f6fcf78a4b303d8c091829c74433a924c4dfc7c7897ca7711858
+  metadata.gz: 984b2b33aa71a12c5c6699308d6d801c721977b308083d93bb2e9e7e8a8d442e433c7a0cfe07a91a069091504351c186989c07df668fec445b4db0432ef1e05f
+  data.tar.gz: a3349cbe7a82af5a9a7e044ec9a840f25e0284ac6040514b2cc3ef64db540f8ce76185084d4db74b0aab0a2af835fbf60455315412b2d1242e00b24bc1fd426f

data/README.md

@@ -157,13 +157,15 @@ template_compilers:
 
 Parameters are loaded from multiple YAML files, merged from the following lookup paths from bottom to top:
 
-- parameters/[stack_name].yaml
-- parameters/[stack_name].yml
+- parameters/[underscored_stack_name].yaml
+- parameters/[underscored_stack_name].yml
 - parameters/[region]/[underscored_stack_name].yaml
 - parameters/[region]/[underscored_stack_name].yml
 - parameters/[region_alias]/[underscored_stack_name].yaml
 - parameters/[region_alias]/[underscored_stack_name].yml
 
+**Note:** The file names must be underscored, not hyphenated, even if the stack names are hyphenated.
+
 A simple parameter file could look like this:
 
 ```
@@ -679,6 +681,7 @@ stack_master events [region-or-alias] [stack-name] # Display events for a stack
 stack_master outputs [region-or-alias] [stack-name] # Display outputs for a stack
 stack_master resources [region-or-alias] [stack-name] # Display outputs for a stack
 stack_master status # Displays the status of each stack
+stack_master tidy # Find missing or extra templates or parameter files
 ```
 
 ## Applying updates

data/lib/stack_master.rb

@@ -63,6 +63,7 @@ module StackMaster
     autoload :Resources, 'stack_master/commands/resources'
     autoload :Delete, 'stack_master/commands/delete'
     autoload :Status, 'stack_master/commands/status'
+    autoload :Tidy, 'stack_master/commands/tidy'
   end
 
   module ParameterResolvers

data/lib/stack_master/cli.rb

@@ -169,6 +169,19 @@ module StackMaster
         end
       end
 
+      command :tidy do |c|
+        c.syntax = 'stack_master tidy'
+        c.summary = 'Try to identify extra & missing files.'
+        c.description = 'Cross references stack_master.yml with the template and parameter directories to identify extra or missing files.'
+        c.example 'description', 'Check for missing or extra files'
+        c.action do |args, options|
+          options.defaults config: default_config_file
+          say "Invalid arguments. stack_master tidy" and return unless args.size == 0
+          config = load_config(options.config)
+          StackMaster::Commands::Tidy.perform(config)
+        end
+      end
+
       command :delete do |c|
         c.syntax = 'stack_master delete [region] [stack_name]'
         c.summary = 'Delete an existing stack'

data/lib/stack_master/commands/tidy.rb

@@ -0,0 +1,68 @@
+module StackMaster
+  module Commands
+    class Tidy
+      include Command
+      include StackMaster::Commands::TerminalHelper
+
+      def initialize(config)
+        @config = config
+      end
+
+      def perform
+        used_templates = []
+        used_parameter_files = []
+
+        templates = Set.new(find_templates())
+        parameter_files = Set.new(find_parameter_files())
+
+        status = @config.stacks.each do |stack_definition|
+          parameter_files.subtract(stack_definition.parameter_files)
+          template = File.absolute_path(stack_definition.template_file_path)
+
+          if template
+            templates.delete(template)
+
+            if !File.exist?(template)
+              StackMaster.stdout.puts "Stack \"#{stack_definition.stack_name}\" in \"#{stack_definition.region}\" missing template \"#{rel_path(template)}\""
+            end
+          end
+        end
+
+        templates.each do |path|
+          StackMaster.stdout.puts "#{rel_path(path)}: no stack found for this template"
+        end
+
+        parameter_files.each do |path|
+          StackMaster.stdout.puts "#{rel_path(path)}: no stack found for this parameter file"
+        end
+      end
+
+      def rel_path(path)
+        Pathname.new(path).relative_path_from(Pathname.new(@config.base_dir))
+      end
+
+      def find_templates
+        # TODO: Inferring default template directory based on the behaviour in
+        # stack_definition.rb. For some configurations (eg, per-region
+        # template directories) this won't find the right directory.
+        template_dir = @config.template_dir || File.join(@config.base_dir, 'templates')
+
+        templates = Dir.glob(File.absolute_path(File.join(template_dir, '**', "*.{rb,yaml,yml,json}")))
+        dynamics_dir = File.join(template_dir, 'dynamics')
+
+        # Exclude sparkleformation dynamics
+        # TODO: Should this filter out anything with 'dynamics', not just the first
+        # subdirectory?
+        templates = templates.select do |path|
+          !path.start_with?(dynamics_dir)
+        end
+
+        templates
+      end
+
+      def find_parameter_files
+        Dir.glob(File.absolute_path(File.join(@config.base_dir, "parameters", "*.{yml,yaml}")))
+      end
+    end
+  end
+end

data/lib/stack_master/version.rb

@@ -1,3 +1,3 @@
 module StackMaster
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stack_master
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Steve Hodgkiss
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-22 00:00:00.000000000 Z
+date: 2020-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -309,16 +309,16 @@ dependencies:
   name: sparkle_formation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: table_print
   requirement: !ruby/object:Gem::Requirement
@@ -403,6 +403,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email:
 - steve@hodgkiss.me
@@ -432,6 +446,7 @@ files:
 - lib/stack_master/commands/resources.rb
 - lib/stack_master/commands/status.rb
 - lib/stack_master/commands/terminal_helper.rb
+- lib/stack_master/commands/tidy.rb
 - lib/stack_master/commands/validate.rb
 - lib/stack_master/config.rb
 - lib/stack_master/ctrl_c.rb
@@ -502,8 +517,8 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/envato/stack_master/issues
   changelog_uri: https://github.com/envato/stack_master/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/stack_master/2.0.1
-  source_code_uri: https://github.com/envato/stack_master/tree/v2.0.1
+  documentation_uri: https://www.rubydoc.info/gems/stack_master/2.1.0
+  source_code_uri: https://github.com/envato/stack_master/tree/v2.1.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -519,7 +534,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: StackMaster is a sure-footed way of creating, updating and keeping track