mkstack 1.0.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa22c1f1c57234678eefa866bc219909dc00334d91d6d4daf70be9762233d51c
-  data.tar.gz: c5a1f8095d6b34d467fafd443fbc9605b206a42ef70e65f47ec9290ed8783ca3
+  metadata.gz: 156c6f1b2ce583f7723c9943105e5a56b27959cad2dcd3cab914065806d5371b
+  data.tar.gz: d994eee79d71b74e2a635059ed1a4ba47cf93d518e3606421a567f6b92bd53ff
 SHA512:
-  metadata.gz: b0a0588f47fbc38f7efddb0175afbfacb7d40604a41094a9bc705a26fc6edc154c00bc9f2146e1a19d3326d1d7bfdbb2a6f2de9918a5f8a67ca11e06e202d286
-  data.tar.gz: b23350d9abe01bb969d9dbf617d7025f5572481e526b37a7632a6ec8fb46c7a64aebb92266166105bfd55ffd73f5187b642620d04bdf4ede746ceeb99bf696ee
+  metadata.gz: ab4040c5feb8d08e926c58c36ffc9c6f7f70f17c433992cfbb4b227cabf03802ad1f0139fde972847037bf466877f5d6a212f44136e4aa7709135345c7c34550
+  data.tar.gz: f09c970148652460c653672016f60f97feae0df146fa487be7d942ea7f98a8470ed4af47467b864b020bc19d0ef42df65295377cc0ee61bf0aa0563e6cb6f61b

data/bin/mkstack

@@ -1,8 +1,10 @@
-#!/usr/local/bin/ruby
+#!/usr/bin/env ruby
 
 require "logger"
 require "optparse"
-require "mkstack"
+require_relative "../lib/mkstack"
+
+version = "1.2.0"
 
 
 ##################################################
@@ -15,12 +17,11 @@ $logger.formatter = proc { |s, d, p, m|
   "[%s] %5s [%5s] - %s\n" % [ d.strftime("%Y-%m-%d %H:%M:%S"), s, caller(4, 1).first.split(":")[1], m ]
 }
 
-
 # Default options
 options = {}
 options[:erb] = true
 options[:format] = "json"
-
+options[:erb_argv] = []
 
 # Command line options
 opts = OptionParser.new do |p|
@@ -30,13 +31,14 @@ opts = OptionParser.new do |p|
 
   # Help
   p.on("-h", "--help", "Display this message") { puts opts ; exit }
+  p.on("--version", "Show version") { puts version ; exit }
   p.separator(" ")
 
   # Verbosity
   p.on("-d", "--debug",   "Show debug messages")         { $logger.level = Logger::DEBUG }
   p.on("-v", "--verbose", "Be verbose")                  { $logger.level = Logger::INFO }
   p.on("-q", "--quiet",   "Only show errors")            { $logger.level = Logger::ERROR }
-  p.on("-s", "--silient", "Don't show any log messages") { $logger.level = Logger::FATAL }
+  p.on("-s", "--silent",  "Don't show any log messages") { $logger.level = Logger::FATAL }
   p.separator(" ")
 
   # Output
@@ -49,18 +51,35 @@ opts = OptionParser.new do |p|
   # Operations
   p.on("--erb", "--[no-]erb", "Perform ERB processing (default is true)") { |x| options[:erb] = x }
   p.on("--validate", "Call ValidateTemplate after merging") { options[:validate] = true }
+  p.separator(" ")
+
+  # ERB options
+  p.on("---", "Marks end of mkstack options") { p.terminate("---") }
+  p.on("%s Remaining arguments are available to ERB as an Array argv" % [ desc_padding ])
 end
 
-files = opts.parse!.uniq
-opts.parse "--help" if files.count == 0
+# Separate files from ERB arguments
+args = opts.parse!
 
-template = MkStack::Template.new(options[:format])
+if args.index("---")
+  files = args[0..(args.index("---") - 1)]
+  options[:erb_argv] = args[(args.index("---") + 1)..nil]
+else
+  files = args
+end
 
+# At least one file is required
+files.uniq!
+opts.parse "--help" if ((files.count == 0) or (files[0].eql?("---")))
 
 # Merge files
+template = MkStack::Template.new(options[:format], options[:erb_argv])
+
 files.each do |file|
   begin
-    Dir.chdir(File.dirname(file)) { template.merge(File.basename(file), options[:erb]) }
+    Dir.chdir(File.dirname(file)) {
+      template.merge(File.basename(file), options[:erb])
+    }
   rescue KeyError => e
     $logger.warn { "#{file}: already parsed" }
   rescue Exception => e
@@ -68,7 +87,6 @@ files.each do |file|
   end
 end
 
-
 # Check limits
 $logger.debug { "Checking limits" }
 
@@ -79,19 +97,17 @@ end
 $logger.warn { "At least one Resources member must be defined" } if template["Resources"].length == 0
 $logger.warn { "Template too large (#{template.length} > #{template.limit})" } if template.exceeds_limit?
 
-
 # Validate template
 if options[:validate] then
   begin
     $logger.info { "Validating #{template.format} template" }
 
-    $logger.debug { template.validate }
+    template.validate
   rescue Exception => e
     $logger.error { e.message }
   end
 end
 
-
 # Save template
 if options[:save] then
   begin

data/lib/mkstack.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require_relative "mkstack/template"
 
 =begin rdoc
@@ -5,9 +6,10 @@ require_relative "mkstack/template"
 Merge multiple CloudFormation template files into a single template.
 Each file may be in either JSON or YAML format.
 
-Get started with <i>template = MkStack::Template.new</i>
+Get started with <i>template = MkStack::Template.new</i>, or use the
+command line tool <i>mkstack</i>.
 
-== ERB
+= ERB
 
 By default all files are run through an ERB (Embedded RuBy) processor.
  
@@ -62,7 +64,9 @@ tags defined in one file to be referenced in subsequent files.
       "sg": {
         "Type" : "AWS::EC2::SecurityGroup",
         "Properties" : {
-          "GroupDescription" : { "Fn::Sub" : "Security Group for ${application}" }
+          "GroupDescription" : {
+               "Fn::Sub" : "Security Group for ${application}"
+          }
           <%= tags_json %>
         }
       }
@@ -71,10 +75,39 @@ tags defined in one file to be referenced in subsequent files.
 
 Note that foo.yaml is processed <i>before</i> bar.json.
 
-== See Also
+= Command line tool
+
+  Usage: mkstack [ options ] file1 [ file2... ]
+      -h, --help                       Display this message
+
+      -d, --debug                      Show debug messages
+      -v, --verbose                    Be verbose
+      -q, --quiet                      Only show errors
+      -s, --silent                     Don't show any log messages
+
+      -o, --output=FILE                Print final template to FILE
+                                       Use '-' for stdout
+      -f, --format=FORMAT              Print as FORMAT
+                                       Supported formats: json (default), yaml
+
+          ‐‐erb, --[no-]erb            Perform ERB processing (default is true)
+          ‐‐validate                   Call ValidateTemplate after merging
+
+          ‐‐‐                          Marks end of mkstack options
+                                       Remaining arguments are available to ERB as Array argv
+
+== Passing arguments to ERB
+
+Any command line arguments following "---" are added to an Array
+called <b>argv</b>, which can be referenced in your ERB code.
+
+=== foo.yaml
+
+  <% puts "#{argv.class} with #{argv.length} items: #{argv}" %>
+=====
+  $ mkstack foo.yaml --- a 2 test
+  Array with 3 items: ["a", "2", "test"]
 
-  MkStack::Template
-  MkStack::Section
 =end
 
 module MkStack

data/lib/mkstack/template.rb

@@ -5,25 +5,49 @@ require "json"
 require "yaml"
 
 module MkStack
+  ##################################################
+  # A class to represent undefined local tags.
+  #
+  # CloudFormation uses <b>!</b> to denote the YAML short form of
+  # intrinsic functions, which is the same prefix YAML uses for local
+  # tags.  The default handler strips undefined local tags, leaving
+  # just the value.
+  #
+  # Loading a YAML file will force the output to be in YAML format.
+
+  class IntrinsicShort
+    def init_with(coder)
+      @coder = coder
+    end
+
+    def encode_with(coder)
+      coder.tag = @coder.tag
+
+      coder.map = @coder.map if @coder.type == :map
+      coder.scalar = @coder.scalar if @coder.type == :scalar
+      coder.seq = @coder.seq if @coder.type == :seq
+    end
+  end
+
   ##################################################
   # A CloudFormation template
   class Template
     attr_reader :sections, :limit, :format
 
-    def initialize(format = "json")
+    def initialize(format = "json", argv = nil)
       @format = format
 
       @sections = {
         "AWSTemplateFormatVersion" => Section.new("AWSTemplateFormatVersion", String, nil),
         "Description" => Section.new("Description", String, 1024),
 
-        "Conditions"  => Section.new("Conditions",  Hash, nil),
-        "Mappings"    => Section.new("Mappings",    Hash, 100),
-        "Metadata"    => Section.new("Metadata",    Hash, nil),
-        "Outputs"     => Section.new("Outputs",     Hash, 60),
-        "Parameters"  => Section.new("Parameters",  Hash, 60),
-        "Resources"   => Section.new("Resources",   Hash, nil),
-        "Transforms"  => Section.new("Transforms",  Hash, nil),
+        "Conditions" => Section.new("Conditions", Hash, nil),
+        "Mappings"   => Section.new("Mappings",   Hash, 200),
+        "Metadata"   => Section.new("Metadata",   Hash, nil),
+        "Outputs"    => Section.new("Outputs",    Hash, 200),
+        "Parameters" => Section.new("Parameters", Hash, 200),
+        "Resources"  => Section.new("Resources",  Hash, 500),
+        "Transform"  => Section.new("Transform",  Hash, nil),
       }
       @limit = 51200
 
@@ -34,10 +58,6 @@ module MkStack
       # every time we load a file.  This allows ERB code in one file to
       # be referenced in another.
       @binding = binding
-
-      # See add_domain_types
-      @yaml_domain = "mlfs.org,2019"
-      @global_tag = "tag:#{@yaml_domain}:"
     end
 
     # Shorthand accessor for template sections
@@ -60,8 +80,9 @@ module MkStack
         cfn = JSON.load(contents)
       rescue Exception => e
         # Try YAML
-        add_domain_types
-        cfn = YAML.load(contents)
+        add_tags
+        cfn = YAML.safe_load(contents, [IntrinsicShort])
+        @format = "yaml"
       end
 
       # Merge sections that are present in the file
@@ -90,9 +111,7 @@ module MkStack
       when "json"
         to_hash.to_json
       when "yaml"
-        # Strip enclosing quotes around tags and revert tags to their short form
-        # And keep Psych from splitting "long" lines
-        to_hash.to_yaml({ line_width: -1 }).gsub(/"(#{@global_tag}[^"]+?)"/, '\1').gsub("#{@global_tag}", "!")
+        to_hash.to_yaml({ line_width: -1 }) # Keep Psych from splitting "long" lines
       else
         to_hash
       end
@@ -127,20 +146,9 @@ module MkStack
 
 
     #########################
-    # Define YAML domains to handle CloudFormation intrinsic
-    # functions.
-    #
-    # CloudFormation uses <b>!</b> to denote the YAML short form of
-    # intrinsic functions, which is the same prefix YAML uses for
-    # local tags.  The default handler strips undefined local tags,
-    # leaving just the value.
-    #
-    # This puts the tags back, but in global tag format.  The global
-    # tag prefix is converted back to <b>!</b> on output.
-    #
-    # Using the short form will force the output to be in YAML format.
-    def add_domain_types
-      functions = [
+    # List of intrinsic functions that look like undefined local tags
+    def add_tags
+      [
         "Base64",
         "Cidr",
         "FindInMap",
@@ -157,21 +165,9 @@ module MkStack
         "If",
         "Not",
         "Or",
-      ].each do |function|
-        YAML::add_domain_type(@yaml_domain, function) do |type, val|
-          @format = "yaml"
-          "#{type} #{val}"
-        end
-      end
-
-      # The syntax for !Sub requires double-quotes around Strings
-      functions = [
         "Sub",
       ].each do |function|
-        YAML::add_domain_type(@yaml_domain, function) do |type, val|
-          @format = "yaml"
-          val.is_a?(String)? "#{type} \"#{val}\"" : "#{type} #{val}"
-        end
+        YAML::add_tag("!#{function}", IntrinsicShort)
       end
     end
   end

data/mkstack.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name	= "mkstack"
-  s.version	= "1.0.0"
+  s.version	= "1.2.1"
   s.summary	= "Merge multiple CloudFormation template files into a single template"
   s.description	= <<-EOF
 Merge multiple CloudFormation template files into a single template.  Each file may be in either JSON or YAML format.  By default all files are run through an ERB (Embedded RuBy) processor.

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: mkstack
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Andy Rosen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIEOjCCAqKgAwIBAgIBATANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBphanIv
-  REM9Y29ycC9EQz1tbGZzL0RDPW9yZzAeFw0xOTA1MDEwMjIwNTBaFw0yMDA0MzAw
-  MjIwNTBaMCUxIzAhBgNVBAMMGmFqci9EQz1jb3JwL0RDPW1sZnMvREM9b3JnMIIB
+  MIID/jCCAmagAwIBAgIBAjANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBphanIv
+  REM9Y29ycC9EQz1tbGZzL0RDPW9yZzAeFw0yMDA2MjMyMjA0MDdaFw0yMTA2MjMy
+  MjA0MDdaMCUxIzAhBgNVBAMMGmFqci9EQz1jb3JwL0RDPW1sZnMvREM9b3JnMIIB
   ojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAqQ2xCUJ4wY8WujSzYd3OGTbj
   JDMeU44pXOTLc49Rs8ydukGfd0YBvYMzifmiVRj6depGx2+Ln28Y2mT6IB+zHq8X
   s1lrMdFCReztJjQ7OYS16YcZ6pmLkYClnHN3VNqayk1lQEJGCr8aawMeroSB01om
@@ -21,20 +21,19 @@ cert_chain:
   JbnFW7mFQGtBpfh8zY8OCQ76Aw8cb5bEIPTI+Hd4FoJLPKnexTI28endSLigOUCF
   76kLOiVOVOjdqZ8vEdSgWVugEAzIC30xW5b8yD6N7GdT7n3ktgoZu7jZMUW3D6PQ
   wS6BaABVsXbeVtFrzK2tQ65EwLfRluRLTfbnQ7qvMIYCwC3Ib9DTMLavCiOot1vc
-  RBWXIrDex0tt3EN0dDIxP9O+7ciDgM4zPe6BvaF/AgMBAAGjdTBzMAkGA1UdEwQC
-  MAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBRDowzw+kmcX6FV7T9BkQsUgmzLZjAc
-  BgNVHREEFTATgRFhanJAY29ycC5tbGZzLm9yZzAcBgNVHRIEFTATgRFhanJAY29y
-  cC5tbGZzLm9yZzANBgkqhkiG9w0BAQsFAAOCAYEAbbgfVpRCtujGFRHNYLWnq/iQ
-  vGtNs265jQKdq3SZ5HIsPP4RdiknOk2Q0BP4GDkXOhadtuuqeCVlJUczcrCKiKuP
-  Vu7iOQKpOq9bafhjvTpRPZL7uXDu0lwBrDyL9PGouBBsijTtGCc/A8cu/2HVoX+Z
-  X1pqmuJqVlgXp9ktbzPBeIdaFFT+9WzIzWCJ73oBYNZ1EP/4CRKIlmRCWzBGZtu6
-  QqNypgW/OCQVRcJGZ99myNQO5/EImQp1py6iHymkdCx2RMsdTUpcm3gUl4XaFd4J
-  pQ1HNcDdD3UCSDqlPpv2nVpOV4u1s3yojIHt0RcVXhSzqGHgmXNjKDIP0zokFBKx
-  NigI/5A3vv9PplxXMatOeirqPqDY5F4Aim4t2Dn+d+9OiPADkIBwuIuwwgRmcWhE
-  E2DV+ftSSpAT1zeHEZXx6BsvJVwtXq1kMDYibgB4lTU4lq1oHrx2x+PO2cukHlom
-  4cVT/heohjMDtNBaDMVsTjTxtNq6oi/pvyLqBGmQ
+  RBWXIrDex0tt3EN0dDIxP9O+7ciDgM4zPe6BvaF/AgMBAAGjOTA3MAkGA1UdEwQC
+  MAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBRDowzw+kmcX6FV7T9BkQsUgmzLZjAN
+  BgkqhkiG9w0BAQsFAAOCAYEAAmnuLwfJOuo9JlIMPCArwX0wIZcuKJ1Ms5S9RpTT
+  MYqNwa52//SCZ5VG0bZknXNgHGs1qm4kHekxOVjjjdawVHQFZvDJJxblSvj1OTe0
+  J4OF7hiWldeUE7ezeHDpzcVpGkHBGYCPkLBPyjMkRwlZpgth9DVO7FP3mV9SMHyP
+  x1/55FYk0A62NgXSzmLghePC+trYllv54YURP4/R8RYnZPZNf5MFMjF94BoWGFzQ
+  9BKJ+1DbdAVwCMSWEcGOkw5euwofwf6PpvLlmhB9pM+acsjLJkaS/OU7v5/X0F6+
+  MkYSejwDmyV9/u/cPgStxlOOu4x7Ur2qOzfb8OEKMmautB7ZEdCivdG/Qa634dDq
+  dnrb3iC4VliJf0o5SVrYjRxBYn9WQV1eJaygRunfhVo9AqRPg+rcbkQ/XIWUQDeY
+  kLyoFawGT9fF6+lXyIT9XiaUzOCjQUJo94on5U601Y2GXB4Sa1oxLSBlEtkSwuD3
+  gMHlHdBRvoJurkVzYNWkN+Cz
   -----END CERTIFICATE-----
-date: 2019-05-02 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
@@ -54,7 +53,7 @@ description: 'Merge multiple CloudFormation template files into a single templat
   file may be in either JSON or YAML format.  By default all files are run through
   an ERB (Embedded RuBy) processor.
 
-'
+  '
 email:
 - ajr@corp.mlfs.org
 executables:
@@ -71,7 +70,7 @@ homepage: https://github.com/ajrosen/AWS/tree/master/mkstack
 licenses:
 - GPL-3.0+
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -86,9 +85,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Merge multiple CloudFormation template files into a single template
 test_files: []