cfndsl 0.15.0 → 1.0.0

data/lib/cfndsl/aws/types.rb

@@ -1,12 +1,14 @@
-require 'cfndsl/types'
+# frozen_string_literal: true
+
+require_relative '../jsonable'
+require_relative '../types'
 
 module CfnDsl
   module AWS
     # Cloud Formation Types
     module Types
-      TYPE_PREFIX = 'aws'.freeze
       class Type < JSONable; end
-      include CfnDsl::Types
+      include CfnDsl::Types # This include triggers loading and patching of the global specification
     end
   end
 end

data/lib/cfndsl/cfnlego.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'erb'
+require 'net/http'
+require 'uri'
+require_relative 'cfnlego/cloudformation'
+require_relative 'cfnlego/resource'
+require_relative 'specification'
+
+# Cfnlego
+module Cfnlego
+  def self.resources
+    @resources ||= CfnDsl::Specification.load_file.resources
+  end
+
+  def self.run(options)
+    resources =
+      options[:resources].each_with_object([]) do |r, list|
+        /(.*),(.*)/.match(r) do |m|
+          type = m[1]
+          name = m[2]
+          list << Cfnlego::Resource.new(type, name)
+        end
+      end
+
+    begin
+      return Cfnlego::CloudFormation.new(resources).render
+    rescue RuntimeError => e
+      warn "Error: #{e.message}"
+    end
+    nil
+  end
+end

data/lib/{cfnlego → cfndsl/cfnlego}/cloudformation.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # Cfnlego
 module Cfnlego
   # CloudFormation
   class CloudFormation
-    TEMPLATE = "#{File.dirname(__FILE__)}/cloudformation.erb".freeze
+    TEMPLATE = "#{File.dirname(__FILE__)}/cloudformation.erb"
 
     attr_reader :resources
 

data/lib/{cfnlego → cfndsl/cfnlego}/resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'net/http'
 require 'uri'
@@ -24,14 +26,9 @@ module  Cfnlego
     private
 
     def definition
-      content = Cfnlego.fetch_resource_content
-      datainput = JSON.parse(content)
-      data = datainput['ResourceTypes']
-      begin
-        @definition ||= data[@type]
-      rescue
-        raise "unknown #{@type}, no matching definition found"
-      end
+      @definition ||= Cfnlego.resources[@type]
+    rescue StandardError
+      raise "unknown #{@type}, no matching definition found"
     end
   end
 end

data/lib/cfndsl/cloudformation.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require_relative 'globals'
+require_relative 'external_parameters'
+require_relative 'aws/cloud_formation_template'
+
+# CfnDsl
+module CfnDsl
+  # This function handles the eval of the template file and returns the
+  # results. It does this with a ruby "eval", but it builds up a customized
+  # binding environment before it calls eval. The environment can be
+  # customized by passing a list of customizations in the extras parameter.
+  #
+  # These customizations are expressed as an array of pairs of
+  # (type,filename). They are evaluated in the order they appear in the
+  # extras array. The types are as follows
+  #
+  # :yaml - the second element is treated as a file name, which is loaded
+  #         as a yaml file. The yaml file should contain a top level
+  #         dictionary. Each of the keys of the top level dictionary is
+  #         used as a local variable in the evalation context.
+  #
+  # :json - the second element is treated as a file name, which is loaded
+  #         as a json file. The yaml file should contain a top level
+  #         dictionary. Each of the keys of the top level dictionary is
+  #         used as a local variable in the evalation context.
+  #
+  # :raw  - the second element is treated as a ruby statement and is
+  #         evaluated in the binding context, similar to the contents of
+  #         a ruby file.
+  #
+  # Note that the order is important, as later extra sections can overwrite
+  # or even undo things that were done by earlier sections.
+
+  def self.eval_file_with_extras(filename, extras = [], logstream = nil)
+    b = binding
+    params = CfnDsl::ExternalParameters.refresh!
+    extras.each do |type, file|
+      case type
+      when :yaml, :json
+        klass_name = type.to_s.upcase
+        logstream.puts("Loading #{klass_name} file #{file}") if logstream
+        params.load_file file
+      when :raw
+        file_parts = file.split('=')
+        if file_parts[1].downcase == 'true'
+          params.set_param(file_parts[0], true)
+        elsif file_parts[1].downcase == 'false'
+          params.set_param(file_parts[0], false)
+        else
+          params.set_param(*file.split('='))
+        end
+      end
+    end
+
+    logstream.puts("Loading template file #{filename}") if logstream
+    b.eval(File.read(filename), filename)
+  end
+
+  # Syntactic Sugar for embedded ruby usage
+  # @example
+  # require `cfndsl`
+  #
+  # class Builder
+  #    include CfnDsl::CloudFormation
+  #
+  #    def build_template()
+  #       template = CloudFormation('ANewTemplate')
+  #       a_param = template.Parameter('AParam')
+  #       a_param.Type('String')
+  #       return template
+  #    end
+  #
+  #    def map_instance_type(instance_type)
+  #      # logic to auto convert instance types to latest available etc..
+  #      FnFindInMap("InstanceTypeConversion",Ref('AWS::Region'),instance_type)
+  #    end
+  #
+  #    # templates can be passed around to other methods/classes
+  #    def add_instance(template, instance_type)
+  #      ec2 = template.EC2_Instance(:myInstance)
+  #      ec2.InstanceType(map_instance_type(instance_type))
+  #      # Alteratively with DSL block syntax
+  #      this = self  # declare block is eval for the model instance so need to keep a reference
+  #      template.declare do
+  #        EC2_Instance(:myInstance) do
+  #           InstanceType this.map_instance_type(instance_type)
+  #        end
+  #      end
+  #   end
+  #
+  #   def generate(template,pretty: false)
+  #      valid = template.validate
+  #      pretty ? valid.to_json : JSON.pretty_generate(valid)
+  #   end
+  # end
+  #
+  module CloudFormation
+    # Include all the fun JSONABLE stuff and Fn* functions so you can use them
+    # in local methods
+    include Functions
+
+    def CloudFormation(description = nil, &block)
+      CloudFormationTemplate.new(description, &block)
+    end
+  end
+end
+
+# Main function to build and validate
+# @return [CfnDsl::CloudFormationTemplate]
+# @raise [CfnDsl::Error] if the block does not generate a valid template
+def CloudFormation(description = nil, &block)
+  CfnDsl::CloudFormationTemplate.new(description).declare(&block).validate
+end

data/lib/cfndsl/conditions.rb

@@ -1,4 +1,6 @@
-require 'cfndsl/jsonable'
+# frozen_string_literal: true
+
+require_relative 'jsonable'
 
 module CfnDsl
   # Handles condition objects
@@ -11,5 +13,15 @@ module CfnDsl
     def initialize(value)
       @value = value
     end
+
+    # For when Condition is used inside Fn::And, Fn::Or, Fn::Not
+    def condition_refs
+      case @value
+      when String, Symbol
+        [@value.to_s]
+      else
+        []
+      end
+    end
   end
 end

data/lib/cfndsl/creation_policy.rb

@@ -1,4 +1,6 @@
-require 'cfndsl/jsonable'
+# frozen_string_literal: true
+
+require_relative 'jsonable'
 
 module CfnDsl
   # Handles creation policy objects for Resources

data/lib/cfndsl/deep_merge.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'globals'
+require_relative '../deep_merge/deep_merge' unless CfnDsl.disable_deep_merge?

data/lib/cfndsl/external_parameters.rb

@@ -1,3 +1,9 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'json'
+require_relative 'deep_merge'
+
 module CfnDsl
   # Handles all external parameters
   class ExternalParameters
@@ -27,16 +33,16 @@ module CfnDsl
       @parameters = self.class.defaults.clone
     end
 
-    def set_param(k, v)
-      parameters[k.to_sym] = v
+    def set_param(key, val)
+      parameters[key.to_sym] = val
     end
 
-    def merge_param(x)
-      parameters.deep_merge!(x)
+    def merge_param(xray)
+      parameters.deep_merge!(xray)
     end
 
-    def get_param(k)
-      parameters[k.to_sym]
+    def get_param(key)
+      parameters[key.to_sym]
     end
     alias [] get_param
 
@@ -44,13 +50,6 @@ module CfnDsl
       parameters
     end
 
-    def add_to_binding(bind, logstream)
-      parameters.each_pair do |key, val|
-        logstream.puts("Setting local variable #{key} to #{val}") if logstream
-        bind.eval "#{key} = #{val.inspect}"
-      end
-    end
-
     def load_file(fname)
       format = File.extname fname
       case format

data/lib/cfndsl/globals.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'version'
+
 # Global variables to adjust CfnDsl behavior
 module CfnDsl
-  module_function
-
-  def disable_binding
-    @disable_binding = true
+  class Error < StandardError
   end
 
-  def disable_binding?
-    @disable_binding
-  end
+  module_function
+
+  AWS_SPECIFICATION_URL = 'https://d1uauaxba7bl26.cloudfront.net/%<version>s/gzip/CloudFormationResourceSpecification.json'
+  LOCAL_SPEC_FILE = File.expand_path('aws/resource_specification.json', __dir__)
 
   def disable_deep_merge
     @disable_deep_merge = true
@@ -18,13 +20,52 @@ module CfnDsl
     @disable_deep_merge
   end
 
+  def specification_file=(file)
+    raise Error, "Specification #{file} does not exist" unless File.exist?(file)
+
+    @specification_file = file
+  end
+
+  # @overload specification_file()
+  # @return [String] the specification file name
+  # @overload specification_file(file)
+  # @deprecated Use specification_file= to override the specification file
   def specification_file(file = nil)
-    @specification_file = file if file
-    @specification_file ||= File.join(ENV['HOME'], '.cfndsl/resource_specification.json')
+    self.specification_file = file if file
+    @specification_file ||= user_specification_file
+    @specification_file = LOCAL_SPEC_FILE unless File.exist?(@specification_file)
     @specification_file
   end
 
+  def user_specification_file
+    File.join(ENV['HOME'], '.cfndsl/resource_specification.json')
+  end
+
+  def update_specification_file(file: user_specification_file, version: nil)
+    require 'open-uri'
+    version ||= 'latest'
+    FileUtils.mkdir_p File.dirname(file)
+    url = format(AWS_SPECIFICATION_URL, version: version)
+    content = URI.parse(url).open.read
+    version = JSON.parse(content)['ResourceSpecificationVersion'] if version == 'latest'
+    File.open(file, 'w') { |f| f.puts content }
+    { file: file, version: version, url: url }
+  rescue StandardError
+    raise "Failed updating specification file #{file} from #{url}"
+  end
+
+  def additional_specs(*specs)
+    @additional_specs ||= Dir[File.expand_path('aws/patches/*.spec.json', __dir__)]
+    @additional_specs.concat(specs.flatten)
+  end
+
+  def specification_patches(*patches)
+    # TODO: This is not capturing all the files in patches dir!
+    @patches ||= Dir[File.expand_path('aws/patches/*patch.json', __dir__)]
+    @patches.concat(patches.flatten)
+  end
+
   def reserved_items
-    %w[Resource Parameter Output].freeze
+    %w[Resource Rule Parameter Output].freeze
   end
 end

data/lib/cfndsl/json_serialisable_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CfnDsl
   # JSONSerialisableObject
   module JSONSerialisableObject
@@ -5,8 +7,8 @@ module CfnDsl
       @value
     end
 
-    def to_json(*a)
-      as_json.to_json(*a)
+    def to_json(*args)
+      as_json.to_json(*args)
     end
   end
 end

data/lib/cfndsl/jsonable.rb

@@ -1,6 +1,8 @@
-require 'cfndsl/errors'
-require 'cfndsl/ref_check'
-require 'cfndsl/json_serialisable_object'
+# frozen_string_literal: true
+
+require_relative 'ref_check'
+require_relative 'json_serialisable_object'
+require_relative 'external_parameters'
 
 module CfnDsl
   # These functions are available anywhere inside
@@ -23,7 +25,7 @@ module CfnDsl
 
     # Equivalent to the CloudFormation template built in function Fn::GetAtt
     def FnGetAtt(logical_resource, attribute)
-      Fn.new('GetAtt', [logical_resource, attribute])
+      Fn.new('GetAtt', [logical_resource, attribute], [logical_resource])
     end
 
     # Equivalent to the CloudFormation template built in function Fn::GetAZs
@@ -43,9 +45,8 @@ module CfnDsl
 
     # Equivalent to the CloudFormation template built in function Fn::And
     def FnAnd(array)
-      if !array || array.count < 2 || array.count > 10
-        raise 'The array passed to Fn::And must have at least 2 elements and no more than 10'
-      end
+      raise 'The array passed to Fn::And must have at least 2 elements and no more than 10' if !array || array.count < 2 || array.count > 10
+
       Fn.new('And', array)
     end
 
@@ -56,7 +57,7 @@ module CfnDsl
 
     # Equivalent to the Cloudformation template built in function Fn::If
     def FnIf(condition_name, true_value, false_value)
-      Fn.new('If', [condition_name, true_value, false_value])
+      Fn.new('If', [condition_name, true_value, false_value], [], [condition_name])
     end
 
     # Equivalent to the Cloudformation template built in function Fn::Not
@@ -70,9 +71,8 @@ module CfnDsl
 
     # Equivalent to the CloudFormation template built in function Fn::Or
     def FnOr(array)
-      if !array || array.count < 2 || array.count > 10
-        raise 'The array passed to Fn::Or must have at least 2 elements and no more than 10'
-      end
+      raise 'The array passed to Fn::Or must have at least 2 elements and no more than 10' if !array || array.count < 2 || array.count > 10
+
       Fn.new('Or', array)
     end
 
@@ -82,13 +82,20 @@ module CfnDsl
     end
 
     # Equivalent to the CloudFormation template built in function Fn::Sub
+    FN_SUB_SCANNER = /\$\{([^!}]*)\}/.freeze
+
     def FnSub(string, substitutions = nil)
       raise ArgumentError, 'The first argument passed to Fn::Sub must be a string' unless string.is_a? String
+
+      refs = string.scan(FN_SUB_SCANNER).map(&:first)
+
       if substitutions
         raise ArgumentError, 'The second argument passed to Fn::Sub must be a Hash' unless substitutions.is_a? Hash
-        Fn.new('Sub', [string, substitutions])
+
+        refs -= substitutions.keys.map(&:to_s)
+        Fn.new('Sub', [string, substitutions], refs)
       else
-        Fn.new('Sub', string)
+        Fn.new('Sub', string, refs)
       end
     end
 
@@ -97,55 +104,11 @@ module CfnDsl
       Fn.new('ImportValue', value)
     end
 
-    # DEPRECATED
-    # Usage
-    #  FnFormat('This is a %0. It is 100%% %1', 'test', 'effective')
-    # or
-    #  FnFormat('This is a %{test}. It is 100%% %{effective}',
-    #            :test => 'test",
-    #            :effective => 'effective')
-    #
-    # These will each generate a call to Fn::Join that when
-    # evaluated will produce the string "This is a test. It is 100%
-    # effective."
-    #
-    # Think of this as %0, %1, etc in the format string being replaced by the
-    # corresponding arguments given after the format string. '%%' is replaced
-    # by the '%' character.
-    #
-    # The actual Fn::Join call corresponding to the above FnFormat call would be
-    # {"Fn::Join": ["",["This is a ","test",". It is 100","%"," ","effective"]]}
-    #
-    # If no arguments are given, or if a hash is given and the format
-    # variable name does not exist in the hash, it is used as a Ref
-    # to an existing resource or parameter.
-    #
-    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
-    def FnFormat(string, *arguments)
-      warn '`FnFormat` is deprecated and will be removed a future release. Use `FnSub` instead'
-      array = []
-
-      if arguments.empty? || (arguments.length == 1 && arguments[0].instance_of?(Hash))
-        hash = arguments[0] || {}
-        string.scan(/(.*?)(?:%(%|\{([\w:]+)\})|\z)/m) do |x, y, z|
-          array.push x if x && !x.empty?
-
-          next unless y
-
-          array.push(y == '%' ? '%' : (hash[z] || hash[z.to_sym] || Ref(z)))
-        end
-      else
-        string.scan(/(.*?)(?:%(%|\d+)|\z)/m) do |x, y|
-          array.push x if x && !x.empty?
-
-          next unless y
-
-          array.push(y == '%' ? '%' : arguments[y.to_i])
-        end
-      end
-      Fn.new('Join', ['', array])
+    # Equivalent to the CloudFormation template built in function Fn::Cidr
+    def FnCidr(ipblock, count, sizemask)
+      Fn.new('Cidr', [ipblock, count, sizemask])
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+    # rubocop:enable
   end
 
   # This is the base class for just about everything useful in the
@@ -170,6 +133,7 @@ module CfnDsl
     # Instance variables that begin with two underscores have one of
     # them removed.
     def as_json(_options = {})
+      check_names
       hash = {}
       instance_variables.each do |var|
         name = var[1..-1]
@@ -187,8 +151,8 @@ module CfnDsl
       hash
     end
 
-    def to_json(*a)
-      as_json.to_json(*a)
+    def to_json(*args)
+      as_json.to_json(*args)
     end
 
     def ref_children
@@ -197,15 +161,30 @@ module CfnDsl
 
     def declare(&block)
       instance_eval(&block) if block_given?
+      self
+    end
+
+    private
+
+    def check_names
+      return if instance_variable_get('@Resources').nil?
+
+      instance_variable_get('@Resources').keys.each do |name|
+        next unless name !~ /\A\p{Alnum}+\z/
+
+        warn "Resource name: #{name} is invalid"
+        exit 1
+      end
     end
   end
 
   # Handles all of the Fn:: objects
   class Fn < JSONable
-    def initialize(function, argument, refs = [])
+    def initialize(function, argument, refs = [], condition_refs = [])
       @function = function
       @argument = argument
       @_refs = refs
+      @_condition_refs = condition_refs
     end
 
     def as_json(_options = {})
@@ -214,16 +193,20 @@ module CfnDsl
       hash
     end
 
-    def to_json(*a)
-      as_json.to_json(*a)
+    def to_json(*args)
+      as_json.to_json(*args)
     end
 
-    def references
+    def all_refs
       @_refs
     end
 
+    def condition_refs
+      @_condition_refs
+    end
+
     def ref_children
-      [@argument]
+      [@argument].flatten
     end
   end