cfndsl 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f1ea58c47151076ab3ac17d4b08f54cf3570fe8
-  data.tar.gz: 10efc2a3c4ac3a0bfe76a1a61548af07aaa7c727
+  metadata.gz: 17794b4c98827341ca1be479e9b41394e351bf0a
+  data.tar.gz: 96c8c7fb7868190f9e69268c9b0e331671c9ff92
 SHA512:
-  metadata.gz: eee1534678839520fdcb4b930cca135311dabf794b09760885ff60b5aab8a1984ac79f493467d90809913cae4a1ddd98143432c80958d027028f796397be1746
-  data.tar.gz: 1cd703f1dcf86a50ef64620c85735a537e7b9a00c75ac920c3cce121ae11630895027c06c96e6429f4455b9535a49431e769e61c55b0cc211eeb154b3573aa6b
+  metadata.gz: 140566d5b12c819b586e000deb5c1dca773bc2aecce051935fec314b9c72f3103e976afea2daf058fe61d9a8400e95e2b7ccd4ae7a6356c0239fac23ab287124
+  data.tar.gz: 354452707c917d0db1e41dc98fdddff6aa20f9ba35301a27dbfdd5af643c92e555542353a02142b5f7ea5c51bb3c76e10e1667cb7819ecd0e1501b5a5e743f10

data/.rubocop.yml

@@ -21,6 +21,10 @@ Style/VariableName:
 Style/MethodName:
   Enabled: false
 
+# Because of the way FnFormat was developed
+Style/FormatStringToken:
+  Enabled: false
+
 # Lone String
 Lint/Void:
   Enabled: false

data/CHANGELOG.md

@@ -1,7 +1,22 @@
 # Change Log
 
-## [0.13.1](https://github.com/stevenjack/cfndsl/tree/0.13.1) (2017-05-18)
-[Full Changelog](https://github.com/stevenjack/cfndsl/compare/v0.13.0...0.13.1)
+## [0.14.0](https://github.com/stevenjack/cfndsl/tree/0.14.0) (2017-06-15)
+[Full Changelog](https://github.com/stevenjack/cfndsl/compare/v0.13.1...0.14.0)
+
+**Implemented enhancements:**
+
+- Adding support for auto generating cloudformation resources [\#326](https://github.com/stevenjack/cfndsl/pull/326) ([elmobp](https://github.com/elmobp))
+
+**Closed issues:**
+
+- Error reading specification file on 0.13.0 [\#322](https://github.com/stevenjack/cfndsl/issues/322)
+
+**Merged pull requests:**
+
+- Modernize cfndsl executable [\#319](https://github.com/stevenjack/cfndsl/pull/319) ([kornypoet](https://github.com/kornypoet))
+
+## [v0.13.1](https://github.com/stevenjack/cfndsl/tree/v0.13.1) (2017-05-17)
+[Full Changelog](https://github.com/stevenjack/cfndsl/compare/v0.13.0...v0.13.1)
 
 **Implemented enhancements:**
 

data/README.md

@@ -434,6 +434,11 @@ Usage: cfndsl [options] FILE
     -D, --define "VARIABLE=VALUE"    Directly set local VARIABLE as VALUE
     -v, --verbose                    Turn on verbose ouptut
     -b, --disable-binding            Disable binding configuration
+    -g RESOURCE_TYPE,RESOURCE_LOGICAL_NAME,
+         --generate                   Add resource type and logical name    
+    -i, --indent TOKEN               Use TOKEN for indent character (default space)
+    -l, --list                       List supported resources
+    -c, --indent-count [COUNT]       Count of characters to use for indenting. (default: 2)
     -h, --help                       Display this screen
 ```
 
@@ -573,3 +578,21 @@ And then use rake to generate the cloudformation:
 ```bash
 $ bin/rake generate
 ```
+
+### Generating CloudFormation resources from cfndsl
+By supplying the -g paramater you are now able to generate cloudformation resources for support objects, for a list of supported resources run cfndsl -l
+
+Example
+```
+ cfndsl -g AWS::EC2::EIP,EIP
+require 'cfndsl'
+CloudFormation do
+  Description 'auto generated cloudformation cfndsl template'
+
+  EC2_EIP('EIP') do
+        Domain String # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-domain
+        InstanceId String # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-instanceid
+  end
+end
+```
+Many thanks to the base code from cfnlego to make this possible!

data/bin/cfndsl

@@ -6,8 +6,9 @@ require 'fileutils'
 require 'json'
 require 'open-uri'
 require 'optparse'
+require 'cfnlego'
 
-options = {}
+options = { resources: [] }
 
 optparse = OptionParser.new do |opts|
   Version = CfnDsl::VERSION
@@ -37,7 +38,8 @@ optparse = OptionParser.new do |opts|
   end
 
   opts.on('-f', '--format FORMAT', 'Specify the output format (JSON default)') do |format|
-    raise "Format #{format} not supported" unless format == 'json' || format == 'yaml'
+    types = %w[json yaml]
+    raise "Format #{format} not supported" unless types.include? format
     options[:outformat] = format
   end
 
@@ -62,6 +64,16 @@ optparse = OptionParser.new do |opts|
     options[:update_spec] = true
   end
 
+  opts.on('-g', '--generate RESOURCE_TYPE,RESOURCE_LOGICAL_NAME', 'Add resource type and logical name') do |r|
+    options[:lego] = true
+    options[:resources] << r
+  end
+
+  opts.on('-l', '--list', 'List supported resources') do
+    puts Cfnlego.Resources.sort
+    exit
+  end
+
   # This displays the help screen, all programs are
   # assumed to have this option.
   opts.on('-h', '--help', 'Display this screen') do
@@ -80,6 +92,11 @@ if options[:update_spec]
   STDERR.puts "Specification successfully written to #{CfnDsl.specification_file}"
 end
 
+if options[:lego]
+  puts Cfnlego.run(options)
+  exit
+end
+
 if ARGV.empty?
   if options[:update_spec]
     exit 0

data/lib/cfndsl/errors.rb

@@ -7,8 +7,8 @@ module CfnDsl
       if idx.nil?
         @errors.push(err + "\n" + caller.join("\n") + "\n")
       else
-        m = caller[idx].match(/^.*?:\d+:/)
-        err_loc = m ? m[0] : caller[idx]
+        m = caller(idx..idx).first.match(/^.*?:\d+:/)
+        err_loc = m ? m[0] : caller(idx..idx).first
 
         @errors.push(err_loc + ' ' + err + "\n")
       end

data/lib/cfndsl/version.rb

@@ -1,3 +1,3 @@
 module CfnDsl
-  VERSION = '0.13.1'.freeze
+  VERSION = '0.14.0'.freeze
 end

data/lib/cfnlego.rb

@@ -0,0 +1,42 @@
+require 'yaml'
+require 'erb'
+require 'cfnlego/cloudformation'
+require 'cfnlego/resource'
+require 'net/http'
+require 'uri'
+
+# Cfnlego
+module Cfnlego
+  def self.Resources
+    content = fetch_resource_content
+    supported_resources = JSON.parse(content)
+    resources = []
+    supported_resources['ResourceTypes'].each do |resource, _value|
+      resources << resource
+    end
+    resources
+  end
+
+  def self.fetch_resource_content
+    File.read(CfnDsl.specification_file)
+  end
+
+  def self.run(options)
+    # Constructure Resources
+    resources = []
+    options[:resources].each do |r|
+      /(.*),(.*)/.match(r) do |m|
+        type = m[1]
+        name = m[2]
+        resources << Cfnlego::Resource.new(type, name)
+      end
+    end
+
+    begin
+      return Cfnlego::CloudFormation.new(resources).render
+    rescue RuntimeError => e
+      $stderr.puts "Error: #{e.message}"
+    end
+    nil
+  end
+end

data/lib/cfnlego/cloudformation.erb

@@ -0,0 +1,21 @@
+require 'cfndsl'
+CloudFormation do
+  Description '<%= @description %>'
+<%- @resources.each do |r| -%>
+<% restype = r.type.split('::').delete_if{|i|i=='AWS'}
+    restype = restype.join('::').gsub('::', '_') %>
+  <%= restype %>('<%= r.name %>') do
+  <%- ps = r.properties -%>
+  <%- ps.keys.each do |p| -%>
+  <%- if !r.properties[p]['PrimitiveType'].nil?
+      type = r.properties[p]['PrimitiveType']
+     elsif r.properties[p]['Type'] == 'List'
+       type = '[List]'
+     else
+       type = r.properties[p]['Type']
+     end -%>
+    <%= p %> <%= type %> # <%= r.properties[p]['Documentation'] %>
+  <%- end -%>
+  end
+<% end -%>
+end

data/lib/cfnlego/cloudformation.rb

@@ -0,0 +1,19 @@
+# Cfnlego
+module Cfnlego
+  # CloudFormation
+  class CloudFormation
+    TEMPLATE = "#{File.dirname(__FILE__)}/cloudformation.erb".freeze
+
+    attr_reader :resources
+
+    def initialize(resources)
+      @description = 'auto generated cloudformation cfndsl template'
+      @resources   = resources
+    end
+
+    def render
+      erb = ERB.new(File.read(TEMPLATE), nil, '-')
+      erb.result(binding)
+    end
+  end
+end

data/lib/cfnlego/resource.rb

@@ -0,0 +1,37 @@
+require 'yaml'
+require 'net/http'
+require 'uri'
+
+# Cfnlego
+module  Cfnlego
+  # Resource
+  class Resource
+    attr_reader :type, :name
+
+    def initialize(type, name)
+      @type = type
+      @name = name
+    end
+
+    def attributes
+      definition['Attributes']
+    end
+
+    def properties
+      definition['Properties']
+    end
+
+    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
+    end
+  end
+end

data/spec/cli_spec.rb

@@ -15,6 +15,9 @@ describe 'cfndsl', type: :aruba do
           -b, --disable-binding            Disable binding configuration
           -s, --specification-file FILE    Location of Cloudformation Resource Specification file
           -u, --update-specification       Update the Cloudformation Resource Specification file
+          -g RESOURCE_TYPE,RESOURCE_LOGICAL_NAME,
+              --generate                   Add resource type and logical name
+          -l, --list                       List supported resources
           -h, --help                       Display this screen
     USAGE
   end

data/spec/generate_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+describe Cfnlego do
+  let(:template) { Cfnlego.run(resources: ['AWS::EC2::EIP,EIP']) }
+
+  context '#Export' do
+    it 'formats correctly' do
+      output = "require 'cfndsl'\nCloudFormation do\n  Description 'auto generated cloudformation cfndsl template'\n\n "
+      output << " EC2_EIP('EIP') do\n    Domain String "
+      output << '# http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-domain'
+      output << "\n    InstanceId String # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-instanceid"
+      output << "\n  end\nend\n"
+      expect(template).to eq output
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -13,6 +13,7 @@ require 'cfndsl/globals'
 CfnDsl.specification_file File.expand_path('../../lib/cfndsl/aws/resource_specification.json', __FILE__)
 # use local fixture for tests
 require 'cfndsl'
+require 'cfnlego'
 
 bindir = File.expand_path('../../bin', __FILE__)
 ENV['PATH'] = [ENV['PATH'], bindir].join(':')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfndsl
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Steven Jack
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-17 00:00:00.000000000 Z
+date: 2017-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,10 @@ files:
 - lib/cfndsl/types.rb
 - lib/cfndsl/update_policy.rb
 - lib/cfndsl/version.rb
+- lib/cfnlego.rb
+- lib/cfnlego/cloudformation.erb
+- lib/cfnlego/cloudformation.rb
+- lib/cfnlego/resource.rb
 - sample/autoscale.rb
 - sample/autoscale.template
 - sample/autoscale2.rb
@@ -106,6 +110,7 @@ files:
 - spec/fixtures/serverless-api.json
 - spec/fixtures/serverless-function.json
 - spec/fixtures/test.rb
+- spec/generate_spec.rb
 - spec/heat_template_spec.rb
 - spec/jsonable_spec.rb
 - spec/metadata_spec.rb
@@ -158,6 +163,7 @@ test_files:
 - spec/fixtures/serverless-api.json
 - spec/fixtures/serverless-function.json
 - spec/fixtures/test.rb
+- spec/generate_spec.rb
 - spec/heat_template_spec.rb
 - spec/jsonable_spec.rb
 - spec/metadata_spec.rb