cfndsl 0.17.5 → 1.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56d40841f56346fda76c7dcde85f56dac170f079fdd9e1d3b28a8490156b5270
-  data.tar.gz: 0e3d020906e298b19a8ad0997aa5a212e95b562d0c03d28a985f805d6aa46af7
+  metadata.gz: 84bb2754062bcfe3c1e94d9416c7a1ef31110422e092ed272bd9acf205801588
+  data.tar.gz: 582d059bd1bc0735b72379b55109d90e99ceb712811d488bbf7093de473fdd58
 SHA512:
-  metadata.gz: 0be26c030a243009ed13706ffa296174b04241752e46e32b804a2ad81e6d4bcf096a9903f4115f083228493f7a99acf55af7377fa1c1fe127298e894d7e4b752
-  data.tar.gz: 8a420860e7ea49557a9b69ee15f132c4ebfcebd5d67eb8651d825fb9be49670f8bf7bb1311d40ba640b5c6ebca30612662b94ab48abcde487ffd9bbdfc23ee44
+  metadata.gz: d82c1dab6b7a6ed165e57b24848e5d497b9d34c8208ecac944c76a12ac02801edb762d00bd099a68d7dccc218428ad10b07190c1ab292354b12b4fe747e21491
+  data.tar.gz: 1d91a0eda349c5fdfbca5c4bbd824468c7239b949f1b60c068490a69a659459e4dce64db0d7e0e5987f3d778873932481ae1ad2cc406771aafd2a51c206bfd12

data/.gitignore

@@ -5,5 +5,6 @@ tmp/
 coverage/
 *.swp
 *.swo
+.idea/
 vendor
 .bundle

data/.rubocop.yml

@@ -21,14 +21,14 @@ Naming/VariableName:
 Naming/MethodName:
   Enabled: false
 
-# Because of the way FnFormat was developed
-Style/FormatStringToken:
-  Enabled: false
-
 # Lone String
 Lint/Void:
   Enabled: false
 
+Style/SafeNavigation:
+  Enabled: false
+
 AllCops:
+  TargetRubyVersion: 2.3
   Exclude:
     - 'tmp/**/*'

data/.travis.yml

@@ -1,7 +1,12 @@
 language: ruby
 rvm:
-- 2.3.3
+- 2.4
+- 2.5
+- 2.6
 sudo: false
+before_install:
+  - gem update --system
+  - gem install bundler
 deploy:
   provider: rubygems
   api_key:

data/CHANGELOG.md

@@ -1,36 +1,7 @@
 # Change Log
 
-## [0.17.5](https://github.com/cfndsl/cfndsl/tree/0.17.5) (2019-12-27)
-[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v1.0.0.pre.1...0.17.5)
-
-**Fixed bugs:**
-
-- VPCZoneIdentifier is always an array - 1.0.0.pre [\#428](https://github.com/cfndsl/cfndsl/issues/428)
-
-**Closed issues:**
-
-- Where should we define custom helper methods? [\#433](https://github.com/cfndsl/cfndsl/issues/433)
-- undefined method `EC2\_LaunchTemplate' for \#\<CfnDsl::CloudFormationTemplate:...\> \(NoMethodError\) [\#431](https://github.com/cfndsl/cfndsl/issues/431)
-- cfndsl fails with "uninitialized constant CfnDsl::AWS::Types::AWSWAFv2IPSetTag \(NameError\)" [\#430](https://github.com/cfndsl/cfndsl/issues/430)
-
-**Merged pull requests:**
-
-- add tag types to new WAFv2, as AWS are not explicitly defining them in the spec [\#435](https://github.com/cfndsl/cfndsl/pull/435) ([gergnz](https://github.com/gergnz))
-
-## [v1.0.0.pre.1](https://github.com/cfndsl/cfndsl/tree/v1.0.0.pre.1) (2019-10-27)
-[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v1.0.0.pre.2...v1.0.0.pre.1)
-
-## [v1.0.0.pre.2](https://github.com/cfndsl/cfndsl/tree/v1.0.0.pre.2) (2019-10-27)
-[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v0.17.4...v1.0.0.pre.2)
-
-**Merged pull requests:**
-
-- 1.0.0 pre rake and spec [\#427](https://github.com/cfndsl/cfndsl/pull/427) ([lwoggardner](https://github.com/lwoggardner))
-- 1.0.0.pre merge fix403 [\#426](https://github.com/cfndsl/cfndsl/pull/426) ([lwoggardner](https://github.com/lwoggardner))
-- 1.0.0.pre merge with master  [\#425](https://github.com/cfndsl/cfndsl/pull/425) ([lwoggardner](https://github.com/lwoggardner))
-
-## [v0.17.4](https://github.com/cfndsl/cfndsl/tree/v0.17.4) (2019-10-06)
-[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v0.17.3...v0.17.4)
+## [0.17.4](https://github.com/cfndsl/cfndsl/tree/0.17.4) (2019-10-06)
+[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v0.17.3...0.17.4)
 
 **Closed issues:**
 
@@ -132,7 +103,7 @@
 - handle simple resource types [\#397](https://github.com/cfndsl/cfndsl/pull/397) ([gergnz](https://github.com/gergnz))
 
 ## [v0.16.10](https://github.com/cfndsl/cfndsl/tree/v0.16.10) (2019-02-13)
-[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v0.16.9...v0.16.10)
+[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v1.0.0.pre...v0.16.10)
 
 **Implemented enhancements:**
 
@@ -142,26 +113,53 @@
 
 - confirm we are using gzip download of cloudfomration specification. [\#394](https://github.com/cfndsl/cfndsl/issues/394)
 - support a version for cfndsl -u [\#393](https://github.com/cfndsl/cfndsl/issues/393)
+
+## [v1.0.0.pre](https://github.com/cfndsl/cfndsl/tree/v1.0.0.pre) (2019-01-19)
+[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v0.17.pre.6...v1.0.0.pre)
+
+**Closed issues:**
+
 - 'require': cannot load such file -- hana \(0.17.pre.5\) [\#387](https://github.com/cfndsl/cfndsl/issues/387)
 
+## [v0.17.pre.6](https://github.com/cfndsl/cfndsl/tree/v0.17.pre.6) (2018-12-10)
+[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v0.17.pre.5...v0.17.pre.6)
+
+## [v0.17.pre.5](https://github.com/cfndsl/cfndsl/tree/v0.17.pre.5) (2018-12-09)
+[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v0.17.pre.4...v0.17.pre.5)
+
+## [v0.17.pre.4](https://github.com/cfndsl/cfndsl/tree/v0.17.pre.4) (2018-12-09)
+[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v0.17.pre.3...v0.17.pre.4)
+
+## [v0.17.pre.3](https://github.com/cfndsl/cfndsl/tree/v0.17.pre.3) (2018-12-09)
+[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v0.17.pre.2...v0.17.pre.3)
+
 **Merged pull requests:**
 
 - implement json patch for patches and pull in patches from CDK [\#386](https://github.com/cfndsl/cfndsl/pull/386) ([gergnz](https://github.com/gergnz))
 
+## [v0.17.pre.2](https://github.com/cfndsl/cfndsl/tree/v0.17.pre.2) (2018-12-09)
+[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v0.16.9...v0.17.pre.2)
+
 ## [v0.16.9](https://github.com/cfndsl/cfndsl/tree/v0.16.9) (2018-12-07)
-[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v0.16.8...v0.16.9)
+[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v0.17-pre...v0.16.9)
 
 **Closed issues:**
 
 - uninitialized constant CfnDsl::AWS::Types::Map [\#382](https://github.com/cfndsl/cfndsl/issues/382)
 - Can't get -D option to work [\#360](https://github.com/cfndsl/cfndsl/issues/360)
-- rubocop 0.50.0 errors [\#347](https://github.com/cfndsl/cfndsl/issues/347)
 - CFN schema [\#264](https://github.com/cfndsl/cfndsl/issues/264)
 
 **Merged pull requests:**
 
 - fix \#382, add Map primitive type [\#383](https://github.com/cfndsl/cfndsl/pull/383) ([gergnz](https://github.com/gergnz))
 
+## [v0.17-pre](https://github.com/cfndsl/cfndsl/tree/v0.17-pre) (2018-12-03)
+[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v0.16.8...v0.17-pre)
+
+**Closed issues:**
+
+- rubocop 0.50.0 errors [\#347](https://github.com/cfndsl/cfndsl/issues/347)
+
 ## [v0.16.8](https://github.com/cfndsl/cfndsl/tree/v0.16.8) (2018-11-21)
 [Full Changelog](https://github.com/cfndsl/cfndsl/compare/v0.16.7...v0.16.8)
 

data/README.md

@@ -24,7 +24,7 @@ templates by running ruby.
 
 ## Getting Started
 
-ruby version > 2.3.0 is required to run cfndsl, you should look at using rbenv example for installing with rbenv
+ruby version > 2.4 is required to run cfndsl, you should look at using rbenv example for installing with rbenv
 
     rbenv exec gem install cfndsl
 
@@ -38,7 +38,7 @@ Update the the cloudformation specification to the latest version.
 
 or update to a specific version
 
-    cfndsl -u 2.21.0
+    cfndsl -u 7.1.0
 
 Now write a template in the dsl
 
@@ -442,13 +442,11 @@ The cfndsl command line program now accepts some command line options.
 Usage: cfndsl [options] FILE
     -o, --output FILE                Write output to file
     -y, --yaml FILE                  Import yaml file as local variables
-    -r, --ruby FILE                  Evaluate ruby file before template
     -j, --json FILE                  Import json file as local variables
     -p, --pretty                     Pretty-format output JSON
     -f, --format FORMAT              Specify the output format (JSON default)
     -D, --define "VARIABLE=VALUE"    Directly set local VARIABLE as VALUE
     -v, --verbose                    Turn on verbose ouptut
-    -b, --disable-binding            Disable binding configuration
     -m, --disable-deep-merge         Disable deep merging of yaml
     -s, --specification-file FILE    Location of Cloudformation Resource Specification file
     -u [VERSION],                    Update the Resource Specification file to latest, or specific version
@@ -569,38 +567,87 @@ would generate a template with 5 instances declared.
 Specifying multiple -y options will default deep_merge all the yaml in the order specified.
 You can disable this with -m.
 
-Finally, the -r option gives you the opportunity to execute some
-arbitrary ruby code in the evaluation context before the cloudformation
-template is evaluated (this is not available if `--disable-binding` is used).
-
 ### Rake task
 Simply add the following to your `Rakefile`:
 
 ```ruby
 require 'cfndsl/rake_task'
 
-CfnDsl::RakeTask.new do |t|
-  t.cfndsl_opts = {
-    verbose: true,
-    files: [{
-      filename: 'templates/application.rb',
-      output: 'application.json'
-    }],
-    extras: [
-      [ :yaml, 'templates/default_params.yml' ]
-    ]
-  }
+namespace(:cfndsl) do
+  CfnDsl::RakeTask.new do |t|
+    # Use a custom specification file
+    t.specification(file: 'tmp/cloudformation_resources.json')
+
+    desc 'Generate CloudFormation Json'
+    t.json(name: :json, files: FileList.new('sample/*.rb'), pathmap: 'tmp/%f.json')
+    
+    # Generate yaml output, loading an extra file that matches the source file
+    t.yaml(name: :yaml, files: 'sample/t1.rb', pathmap: 'tmp/%f.yaml', extras: '%X.yaml')
+  end
 end
 ```
 
 And then use rake to generate the cloudformation:
 
 ```bash
-$ bin/rake generate
+$ bin/rake cfndsl:generate
+```
+
+### Embedded Ruby
+```ruby
+
+# Optionally before requiring 'cfndsl' set global options
+require `cfndsl/globals`
+CfnDsl.specification_file(file) # Override location of json spec file 
+CfnDsl.disable_deep_merge       # Prevent monkey patching of Hash with deep merge capabilities
+
+require `cfndsl`
+
+# As a function that takes a block of DSL
+template = CloudFormation do
+  # Some CfnDsl
+end
+puts JSON.pretty_generate(template.validate)
+
+# As a class that is a template
+class MyTemplate < CfnDsl::CloudFormationTemplate  
+  def initialize 
+    super do
+      # Base DSL
+    end  
+  end
+  
+  def instance(logical_id)
+    this = self
+    EC2_Instance(logical_id) do
+      self.class.name # << 'CfnDsl::ResourceDefinition' not 'MyTemplate' !
+      InstanceType this.instance_type  
+    end 
+  end
+   
+  #do not make this private! 
+  def instance_type
+    't3.large'      
+  end
+end
+
+# As a builder class
+class Builder
+  include CfnDsl::CloudFormation
+
+  def model
+    this = self # the DSL blocks are executed via instance_eval
+    ref_param = Ref('param')  # and other Fn::*
+    template = CloudFormation do
+      # Some DSL
+    end
+    template.validate.to_json
+  end
+end
 ```
 
 ### Generating CloudFormation resources from cfndsl
-By supplying the -g paramater you are now able to generate cloudformation resources for supported objects, for a list of supported resources run cfndsl -l
+By supplying the -g parameter you are now able to generate cloudformation resources for supported objects, for a list of supported resources run cfndsl -l
 
 Example
 ```bash

data/Rakefile

@@ -6,6 +6,7 @@ require 'cfndsl/version'
 require 'rubocop/rake_task'
 require 'yamllint/rake_task'
 require 'github_changelog_generator/task'
+require 'cfndsl/rake_task'
 
 RSpec::Core::RakeTask.new
 RuboCop::RakeTask.new
@@ -18,16 +19,37 @@ end
 
 YamlLint::RakeTask.new do |t|
   t.paths = %w[
-    lib/cfndsl/aws/types.yaml
-    lib/cfndsl/os/types.yaml
     sample/t1.yaml
     .travis.yml
     .rubocop.yml
   ]
 end
 
-task default: %i[spec rubocop yamllint]
+task default: %i[clean spec rubocop yamllint samples:generate]
 
+# Test our own rake task and samples
+
+directory 'tmp'
+
+namespace :samples do
+  source_files = FileList.new('sample/*.rb') { |fl| fl.exclude('**/circular.rb') }
+
+  CfnDsl::RakeTask.new do |t|
+    t.specification(file: 'tmp/cloudformation_resources.json')
+    desc 'Generate CloudFormation Json'
+    t.json(name: :json, files: source_files, pathmap: 'tmp/%f.json', pretty: true, extras: FileList.new('sample/*.yaml'))
+    t.yaml(name: :yaml, files: 'sample/t1.rb', pathmap: 'tmp/%f.yaml', extras: '%X.yaml')
+  end
+end
+
+CLEAN.add 'tmp/*.rb.{json,yaml}', 'tmp/cloudformation_resources.json'
+
+CfnDsl::RakeTask.new do |t|
+  desc 'Update Embedded Cloudformation specification'
+  t.specification(name: :update_cfn_spec, file: CfnDsl::LOCAL_SPEC_FILE, version: 'latest')
+end
+
+# TODO: Bump should ensure we have the latest upstream resource spec
 task :bump, :type do |_, args|
   type = args[:type].downcase
   version_path = 'lib/cfndsl/version.rb'

data/TODO.md

@@ -0,0 +1,18 @@
+# 1.0.0 Release Changes
+
+## Prepare for Machine Ingestable Types
+
+## ~~Remove OS Heat Support~~
+
+## Remove Ruby/Constant Interpolation
+
+## ~~Better Ruby Api~~
+
+## 100% Test Coverage
+
+## Use Ruby Contracts for Resource Validation
+
+## Style Guide/Wiki/README/Examples Update
+
+## Fully implement ExternalParameters as a Mash
+

data/UPGRADING.md

@@ -0,0 +1,22 @@
+# Major version upgrades
+
+## 0.x to 1.x
+
+### Deprecations
+
+* FnFormat => FnSub
+* addTag => add_tag
+* checkRefs => check_refs
+* Ruby versions < 2.4
+* Legacy cfndsl resource specification files
+
+### Validation
+
+* Tighter validation including for null values and cyclic references in Resources, Outputs, Rules and Conditions
+* Tighter definition of duplicates. eg. Route must be EC2_Route because another service now has a Route resource.
+* Requires the specification file to exist at the time it is explicitly set with CfnDsl.specification_file=
+
+#### Spec version 
+
+The AWS cloudformation spec will be regularly updated on every release
+

data/cfndsl.gemspec

@@ -16,11 +16,11 @@ Gem::Specification.new do |s|
   s.license               = 'MIT'
   s.test_files            = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths         = ['lib']
+  s.bindir                = 'exe'
   s.required_ruby_version = '~> 2.3'
 
   s.executables << 'cfndsl'
 
-  s.add_development_dependency 'bundler', '~> 2.1'
-
-  s.post_install_message = "'addTag' is now deprecated in favour of 'add_tag'. 'addTag' will be removed in the next major version."
+  s.add_development_dependency 'bundler', '~> 2.0'
+  s.add_runtime_dependency 'hana', '~> 1.3'
 end

data/exe/cfndsl

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'cfndsl/runner'
+CfnDsl::Runner.invoke!

data/lib/cfndsl.rb

@@ -1,118 +1,4 @@
 # frozen_string_literal: true
 
-require 'forwardable'
-require 'json'
-
-require 'deep_merge/deep_merge'
-require 'cfndsl/globals'
-require 'cfndsl/module'
-require 'cfndsl/errors'
-require 'cfndsl/ref_check'
-require 'cfndsl/jsonable'
-require 'cfndsl/properties'
-require 'cfndsl/update_policy'
-require 'cfndsl/creation_policy'
-require 'cfndsl/conditions'
-require 'cfndsl/mappings'
-require 'cfndsl/resources'
-require 'cfndsl/rules'
-require 'cfndsl/parameters'
-require 'cfndsl/outputs'
-require 'cfndsl/patches'
-require 'cfndsl/specification'
-require 'cfndsl/aws/cloud_formation_template'
-require 'cfndsl/os/heat_template'
-require 'cfndsl/external_parameters'
-require 'cfndsl/version'
-
-# 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.
-  #
-  # :ruby - the second element is treated as a file name which is evaluated
-  #         as a ruby file. Any assigments (or other binding affecting
-  #         side effects) will persist into the context where the template
-  #         is evaluated
-  #
-  # :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.
-
-  # rubocop:disable all
-  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
-        params.add_to_binding(b, logstream) unless disable_binding?
-      when :ruby
-        if disable_binding?
-          logstream.puts("Interpreting Ruby files was disabled. #{file} will not be read") if logstream
-        else
-          logstream.puts("Running ruby file #{file}") if logstream
-          b.eval(File.read(file), file)
-        end
-      when :raw
-        file_parts = file.split("=")
-        params.set_param(file_parts[0],file_parts[1..-1].join("="))
-        unless disable_binding?
-          logstream.puts("Running raw ruby code #{file}") if logstream
-          b.eval(file, 'raw code')
-        end
-      end
-    end
-
-    logstream.puts("Loading template file #{filename}") if logstream
-    b.eval(File.read(filename), filename)
-  end
-end
-
-def CloudFormation(&block)
-  x = CfnDsl::CloudFormationTemplate.new
-  x.declare(&block)
-  invalid_references = x.check_refs
-  if invalid_references
-    abort invalid_references.join("\n")
-  elsif CfnDsl::Errors.errors?
-    abort CfnDsl::Errors.errors.join("\n")
-  else
-    return x
-  end
-end
-
-def Heat(&block)
-  x = CfnDsl::HeatTemplate.new
-  x.declare(&block)
-  invalid_references = x.check_refs
-  if invalid_references
-    abort invalid_references.join("\n")
-  elsif CfnDsl::Errors.errors?
-    abort CfnDsl::Errors.errors.join("\n")
-  else
-    return x
-  end
-end
+require_relative 'cfndsl/cloudformation'
+require_relative 'cfndsl/cfnlego'