cfhighlander 0.7.0.alpha.1544216666 → 0.8.0.alpha.1550191162

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82637e017954b006eaffddbb6b2358a7416e625823f1a5ca1c13e2e363945f86
-  data.tar.gz: 5fca2570d5d86a16989c079b790e02e15d7cc10cfad7f9584316edd27ad8f466
+  metadata.gz: d104f29b677e85d2bc647c37b07afcb0d7dc085e97d03845a5e6fefb197ac36c
+  data.tar.gz: 440af326438f2ea24845afc1eda9dfe938509c5b7140580a4e46e2a7fbd351ee
 SHA512:
-  metadata.gz: fca8e6e40cfb6730fa4bba2d084cc2645732fce96f0314537380197f7e9165be5c55f80e1b8915cbc3901b050d8d18fc0b9bd234c4d52063a041836b45666cb8
-  data.tar.gz: be3db85a83ccefb1373a36353584fc1e148878ab6c95822a11b8295bc12e8db8e38164d8302f211498e8f640984ebaffcd509a45c7fc1afdc184cb0015d2e019
+  metadata.gz: b6df11c0ee32110b5b4157caee01343e6f3ca3bb744bb373bc85118ca015ce5c45a26cda164b691b287e10ee36e1ba2e1b1be35f1dc24bfbdd6d116e47231797
+  data.tar.gz: 5af50e51cc21cea03f6ed502ff9d37e0e2199dd1bd43ff3cfd676182b709c4c83e75af5fae2ecdd4ceb13851a0b0d4fc50eabef149ac6bd793d65cf1b6f0e3f5

data/README.md

@@ -77,7 +77,7 @@ end
 
 ```
 
-... compile the template with ... 
+... compile the template with ...
 
 ```shell
 cfcompile application
@@ -120,8 +120,8 @@ used in conjuction with ECS Cluster
 - [rds-postgres](https://github.com/theonestack/hl-component-rds-postgres) - RDS Component for Postgres engine
 - [aurora-mysql](https://github.com/theonestack/hl-component-aurora-mysql) - Aurora component for MySQL engine
 - [aurora-postgres](https://github.com/theonestack/hl-component-aurora-postgres) - Aurora component for Postgres engine
-- [elasticache-memcache](https://github.com/theonestack/hl-component-elasticache-memcache) - Aws Elasticache - Memcache engine 
-- [elasticache-memcache](https://github.com/theonestack/hl-component-elasticache-redis) - Aws Elasticache - Redis engine 
+- [elasticache-memcache](https://github.com/theonestack/hl-component-elasticache-memcache) - Aws Elasticache - Memcache engine
+- [elasticache-memcache](https://github.com/theonestack/hl-component-elasticache-redis) - Aws Elasticache - Redis engine
 - [asg](https://github.com/theonestack/hl-component-asg) - AutoScalingGroup component
 - [cognito](https://github.com/theonestack/hl-component-cognito) - Cognito user pools, custom domain names and clients
 
@@ -134,7 +134,7 @@ From shell, command below will generate cloudformation for given component in `o
 cfcompile component_name
 ```
 
-Or from outer cfhighlander template, just pull component using `Component` DSL statement 
+Or from outer cfhighlander template, just pull component using `Component` DSL statement
 
 ```ruby
 CfhighlanderTemplate do
@@ -264,9 +264,9 @@ via CLI (`--dstbucket`, `--dstprefix`, `-v`). Default distribution bucket and pr
 for more details on this statements. Version defaults to `latest` if not explicitly given using `-v` switch
 
 If no distribution options is given using mentioned CLI options or DSL statements,
-bucket will be automatically created for you. Bucket name defaults to 
+bucket will be automatically created for you. Bucket name defaults to
 `$ACCOUNT.$REGION.cfhighlander.templates`, with `/published-templates`
-prefix. 
+prefix.
 
 *cfpublish* command will give you quick launch CloudFirmation stack URL to assist
 you in creating your stack:
@@ -710,7 +710,7 @@ This is also default render mode - if no render mode is specified `Substack` wil
 
 `Inline` - places all defined resources from inner component in outer component cloudformation template. Resources,
 Outputs, Conditions, Parameters and Mappings are all inlined - please note that some of the template elements may be renamed in this
-process in order to assure unique names. 
+process in order to assure unique names.
 
 There are some limitations when using inline components - Inlined component parameters, having values as outputs from another component (inlined or not)
 can't be referenced in component conditions. However, conditions referencing mapping values or parameters passed as mapping values,
@@ -722,13 +722,13 @@ are allowed.
 by referencing Zone Name (rather than ZoneId), meaning there is no explicit dependency between the resources. When both components
 are rendered as substack, implicit dependency is created if there is at least one output from component A passed as parameter
 to component B. Rendering components inlined removes this implicitly defined dependency, as a consequence stack deletion or creation
-may be halted, as record set is being created/deleted before prior the record set. 
+may be halted, as record set is being created/deleted before prior the record set.
 
 **`WARNING`** Be aware of [resource, condition, parameter, output and mapping limits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) on a single template
 when rendering inner components inlined.
 
 **`EXAMPLE`** All of the VPC resources will be rendered in outer component template, while bastion
-will be referenced as substack in example below. 
+will be referenced as substack in example below.
 
 ```ruby
 CfhighlanderTemplate do
@@ -760,6 +760,58 @@ available in cfhighlander templates of all components.
 `CFHIGHLANDER_WORKDIR` - defaults to $PWD, determines location of 'out' folder where all of the
 generated files are placed
 
-`CFHIGHLANDER_AWS_RETRY_LIMIT` - defaults to 10. Number of retries for AWS SDK before giving up. 
+`CFHIGHLANDER_AWS_RETRY_LIMIT` - defaults to 10. Number of retries for AWS SDK before giving up.
 AWS SDK uses exponential backoff to make the API calls
- 
+
+
+
+## Testing components
+
+Tests are designed for testing different configuration options on components.
+They can be defined as `my_test.test.yaml` files in the `tests/` directory.
+Each test file represents a single test configuration which is then compiled
+and validated against AWS cloudformation api.
+
+### Metadata
+
+test metadata needs to defined as bellow with at least a `name:`. Other key:values are for documentation.
+
+```yaml
+test_metadata:
+  type: config
+  name: queues with config overrides
+  description: Create 2 queues with name and override available config
+```
+
+### Running Test
+
+```bash
+$ cfhighlander cftest [component] [options]
+```
+
+```bash
+Usage:
+  cfhighlander cftest component[@version] -f, --format=FORMAT
+
+Options:
+  -d, [--directory=DIRECTORY]        # Tests directory
+                                     # Default: tests
+  -t, [--tests=one two three]        # Point to specific test files using the relative path
+      [--dstbucket=DSTBUCKET]        # Distribution S3 bucket
+      [--dstprefix=DSTPREFIX]        # Distribution S3 prefix
+  -f, --format=FORMAT                # CloudFormation templates output format
+                                     # Default: yaml
+                                     # Possible values: yaml, json
+      [--validate], [--no-validate]  # Optionally validate template
+                                     # Default: true
+  -q, [--quiet], [--no-quiet]        # Silently agree on user prompts (e.g. Package lambda command)
+                                     # Default: true
+  -r, [--report=REPORT]              # report output format in reports directory
+                                     # Possible values: json, xml
+
+Test Highlander component with test case config
+```
+
+### Reports
+
+By default test will print the output to stdout. You can output to a file with a format of xml or json using the `-r` option

data/bin/cfhighlander.rb

@@ -10,16 +10,24 @@
 require 'thor'
 require 'rubygems'
 require 'aws-sdk-core'
+require_relative '../lib/cfhighlander.version'
 require_relative '../lib/cfhighlander.compiler'
 require_relative '../lib/cfhighlander.factory'
 require_relative '../lib/cfhighlander.publisher'
 require_relative '../lib/cfhighlander.validator'
+require_relative '../lib/cfhighlander.tests'
 require_relative '../hl_ext/aws_helper'
 
 class HighlanderCli < Thor
 
   package_name "cfhighlander"
 
+  map %w[--version -v] => :__print_version
+  desc "--version, -v", "print the version"
+  def __print_version
+    puts Cfhighlander::VERSION
+  end
+
   desc 'configcompile component[@version]', 'Compile Highlander components configuration'
 
   def configcompile(template_name)
@@ -121,7 +129,7 @@ class HighlanderCli < Thor
 
   def cfpublish(component_name)
     compiler = cfcompile(component_name, true)
-    publisher = Cfhighlander::Publisher::ComponentPublisher.new(compiler.component, false)
+    publisher = Cfhighlander::Publisher::ComponentPublisher.new(compiler.component, false, options[:format])
     publisher.publishFiles(compiler.cfn_template_paths + compiler.lambda_src_paths)
 
     puts "\n\nUse following url to launch CloudFormation stack\n\n#{publisher.getLaunchStackUrl}\n\n"
@@ -152,14 +160,116 @@ class HighlanderCli < Thor
     component.distribution_prefix = distribution_prefix unless distribution_prefix.nil?
     component.load
 
-    publisher = Cfhighlander::Publisher::ComponentPublisher.new(component, true)
+    publisher = Cfhighlander::Publisher::ComponentPublisher.new(component, true, 'yaml')
     publisher.publishComponent
   end
 
+  desc 'cftest component[@version]', 'Test Highlander component with test case config'
+  method_option :directory, :type => :string, :required => false, :default => 'tests', :aliases => "-d",
+      :desc => 'Tests directory'
+  method_option :tests, :type => :array, :required => false, :aliases => "-t",
+      :desc => 'Point to specific test files using the relative path'
+  method_option :dstbucket, :type => :string, :required => false, :default => nil,
+      :desc => 'Distribution S3 bucket'
+  method_option :dstprefix, :type => :string, :required => false, :default => nil,
+      :desc => 'Distribution S3 prefix'
+  method_option :format, :type => :string, :required => true, :default => 'yaml', :aliases => "-f",
+      :enum => %w(yaml json), :desc => 'CloudFormation templates output format'
+  method_option :validate, :type => :boolean, :default => true,
+      :desc => 'Optionally validate template'
+  method_option :quiet, :type => :boolean, :default => true, :aliases => '-q',
+      :desc => 'Silently agree on user prompts (e.g. Package lambda command)'
+  method_option :report, :type => :string, :aliases => '-r', :enum => ['json','xml'],
+      :desc => 'report output format in reports directory'
+
+  def cftest(component_name = nil, autogenerate_dist = false)
+
+    tests_start = Time.now
+
+    if component_name.nil?
+      candidates = Dir["*.cfhighlander.rb"]
+      if candidates.size == 0
+        self.help('cftest')
+        exit -1
+      else
+        component_name = candidates[0].gsub('.cfhighlander.rb','')
+      end
+    end
+
+    tests = CfHighlander::Tests.new(component_name,options)
+    tests.timestamp = Time.now.strftime('%Y-%m-%dT%H:%M:%S.%L%z')
+    tests.get_cases
+
+    tests.cases.each do |test|
+      test_name = test[:metadata]['name']
+      component = build_component(options, component_name, test[:config])
+      failure = false
+
+      if component.highlander_dsl.distribution_bucket.nil? or component.highlander_dsl.distribution_prefix.nil?
+        component.distribution_bucket="#{aws_account_id()}.#{aws_current_region()}.cfhighlander.templates" if component.distribution_bucket.nil?
+        component.distribution_prefix="published-templates/#{component.name}" if component.distribution_prefix.nil?
+        puts "INFO: Reloading component, as auto-generated distribution settings  are being applied..."
+        component.load
+      end if autogenerate_dist
+
+      # compile cloud formation
+      component_compiler = Cfhighlander::Compiler::ComponentCompiler.new(component)
+      component_compiler.cfn_output_location = "#{ENV['CFHIGHLANDER_WORKDIR']}/out/tests/#{test_name.gsub(' ','_')}"
+      component_compiler.silent_mode = options[:quiet]
+      out_format = options[:format]
+
+      start = Time.now
+      begin
+        component_compiler.compileCloudFormation out_format
+      rescue => e
+        failure = {message: e.message, type: 'Cfhighlander::Compiler::ComponentCompiler'}
+      end
+      finish = Time.now
+
+      tests.report << {
+        name: test_name,
+        test: test[:file],
+        type: 'compile',
+        failure: failure,
+        time: (finish - start).to_s
+      }
+      next if failure
+
+      if options[:validate]
+        start = Time.now
+        begin
+          component_validator = Cfhighlander::Cloudformation::Validator.new(component)
+          component_validator.validate(component_compiler.cfn_template_paths, out_format)
+        rescue Aws::CloudFormation::Errors::ValidationError => e
+          failure = {message: e.message, type: 'Cfhighlander::Cloudformation::Validator'}
+        end
+        finish = Time.now
+      end
+
+      tests.report << {
+        name: test_name,
+        test: test[:file],
+        type: 'Validation',
+        failure: failure,
+        time: (finish - start).to_s
+      }
+
+      component_compiler
+    end
+
+    tests_finish = Time.now
+    tests.time = (tests_finish - tests_start)
+
+    tests.generate_report(options[:report]) if options[:report]
+    tests.print_results
+    exit tests.exit_code
+
+  end
+
 end
 
 # build component from passed cli options
-def build_component(options, template_name)
+def build_component(options, template_name, config=nil)
 
   component_version = options[:version]
   distribution_bucket = options[:dstbucket]
@@ -169,6 +279,7 @@ def build_component(options, template_name)
   component_loader = Cfhighlander::Factory::ComponentFactory.new
   component = component_loader.loadComponentFromTemplate(template_name)
   component.version = component_version unless component_version.nil?
+  component.config = config unless config.nil?
   component.distribution_bucket = distribution_bucket unless distribution_bucket.nil?
   component.distribution_prefix = distribution_prefix unless distribution_prefix.nil?
   component.load

data/lib/cfhighlander.compiler.rb

@@ -89,7 +89,8 @@ module Cfhighlander
         cfn_template = renderer.result(OpenStruct.new({
             'dsl' => dsl,
             'component_cfndsl' => component_cfndsl,
-            'component_requires' => (@@global_extensions_paths + @component.cfndsl_ext_files)
+            'component_requires' => (@@global_extensions_paths + @component.cfndsl_ext_files),
+            'distribution_format' => out_format
         }).instance_eval {binding})
 
         # write to output file
@@ -129,7 +130,7 @@ module Cfhighlander
         dsl = @component.highlander_dsl
 
         # create out dir if not there
-        @cfn_output_location = "#{@workdir}/out/#{format}"
+        @cfn_output_location = "#{@workdir}/out/#{format}" if @cfn_output_location.nil?
         output_dir = @cfn_output_location
         FileUtils.mkdir_p(output_dir) unless Dir.exist?(output_dir)
 

data/lib/cfhighlander.dsl.template.rb

@@ -522,4 +522,4 @@ end
 def HighlanderComponent(&block)
   STDERR.puts("DEPRECATED: #{@template.template_name}: use CfhighlanderTemplate instead of HighlanderComponent")
   CfhighlanderTemplate(&block)
-end
+end

data/lib/cfhighlander.publisher.rb

@@ -7,9 +7,10 @@ module Cfhighlander
 
     class ComponentPublisher
 
-      def initialize(component, cleanup)
+      def initialize(component, cleanup, template_format)
         @component = component
         @cleanup_destination = cleanup
+        @template_format = template_format
       end
 
       def publishComponent
@@ -44,7 +45,7 @@ module Cfhighlander
         template_url = "https://#{@component.highlander_dsl.distribution_bucket}.s3.amazonaws.com/"
         template_url += @component.highlander_dsl.distribution_prefix + "/"
         template_url += @component.highlander_dsl.version
-        template_url += "/#{@component.name}.compiled.yaml"
+        template_url += "/#{@component.name}.compiled.#{@template_format}"
         return template_url
       end
 

data/lib/cfhighlander.tests.rb

@@ -0,0 +1,114 @@
+require 'yaml'
+require 'json'
+
+module CfHighlander
+  class Tests
+
+    attr_accessor :cases,
+      :report,
+      :exit_code,
+      :report_path,
+      :time,
+      :timestamp
+
+    def initialize(component_name,options)
+      @component_name = component_name
+      @tests_dir = options[:directory]
+      @test_files = options[:tests] || Dir["#{@tests_dir}/*.test.yaml"]
+      @report_path = "reports"
+      @debug = false
+      @cases = []
+      @report = []
+      @time = nil
+      @timestamp = nil
+      @exit_code = 0
+    end
+
+    def get_cases
+      @test_files.each do |file|
+        test_case = load_test_case(file)
+        @cases << { metadata: test_case['test_metadata'], file: file, config: test_case }
+      end
+    end
+
+    def load_test_case(file)
+      begin
+        YAML.load(File.read(file))
+      rescue Errno::ENOENT => e
+        abort "No test file found for #{file}"
+      end
+    end
+
+    def print_results
+      failures = @report.select { |k,v| k[:failure] }
+      puts "\n\s\s============================"
+      puts "\s\s#    CfHighlander Tests    #"
+      puts "\s\s============================\n\n"
+      puts "\s\sPass: #{cases.size - failures.size}"
+      puts "\s\sFail: #{failures.size}"
+      puts "\s\sTime: #{@time}\n\n"
+
+      if failures.any?
+        @exit_code = 1
+        puts "\s\s=========Failures========="
+        failures.each do |failure|
+          puts "\s\sName: #{failure[:name]}"
+          puts "\s\sTest: #{failure[:test]}"
+          puts "\s\sType: #{failure[:type]}"
+          puts "\s\sMessage: #{failure[:failure][:message]}"
+          puts "\s\s-------------------------"
+        end
+      end
+    end
+
+
+    def report_dir
+      FileUtils.mkdir_p(@report_path) unless Dir.exist?(@report_path)
+    end
+
+    def generate_report(type)
+      report_dir
+      failures = @report.select { |k,v| k[:message] }
+      report = {}
+      report[:component] = @component_name
+      report[:tests] = cases.size.to_s
+      report[:pass] = (cases.size - failures.size).to_s
+      report[:failures] = failures.size.to_s
+      report[:time] = @time.to_s
+      report[:timestamp] = @timestamp.to_s
+      report[:testcases] = @report
+      case type
+      when 'json'
+        report_json(report)
+      when 'xml'
+        report_xml(report)
+      end
+    end
+
+    def report_xml(report)
+      testsuite = report.map { |k,v| "#{k}=\"#{v}\"" if k != :testcases }
+      File.open("reports/report.xml","w") do |f|
+        f.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")
+        f.write("<testsuite #{testsuite.join(' ')}>\n")
+        report[:testcases].each do |test|
+          testcase = test.map { |k,v| "#{k}=\"#{v}\"" if k != :failure }
+          if test[:failure]
+            f.write("\t<testcase #{testcase.join(' ')}>\n")
+            f.write("\t\t<failure message=\"#{test[:failure][:message]}\" type=\"#{test[:failure][:type]}\"/>\n")
+            f.write("\t</testcase>\n")
+          else
+            f.write("\t<testcase #{testcase.join(' ')}/>\n")
+          end
+        end
+        f.write("</testsuite>")
+      end
+    end
+
+    def report_json(report)
+      File.open("reports/report.json","w") do |f|
+        f.write(JSON.pretty_generate(report))
+      end
+    end
+
+  end
+end

data/lib/cfhighlander.version.rb

@@ -0,0 +1,3 @@
+module Cfhighlander
+  VERSION="0.8.0".freeze
+end

data/templates/cfndsl.component.template.erb

@@ -68,4 +68,11 @@ CloudFormation do
 <% for @condition in dsl.conditions %>    Condition('<%= @condition.name %>', <%= @condition.expression %>)
 <% end %>
     Description '<%= dsl.description %>'
+
+    Output('CfTemplateUrl') {
+        Value("<%=dsl.distribute_url%>/<%=dsl.name%>.compiled.<%=distribution_format%>")
+    }
+    Output('CfTemplateVersion') {
+        Value("<%=dsl.version%>")
+    }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfhighlander
 version: !ruby/object:Gem::Version
-  version: 0.7.0.alpha.1544216666
+  version: 0.8.0.alpha.1550191162
 platform: ruby
 authors:
 - Nikola Tosic
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-07 00:00:00.000000000 Z
+date: 2019-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -273,7 +273,9 @@ files:
 - lib/cfhighlander.model.component.rb
 - lib/cfhighlander.model.templatemeta.rb
 - lib/cfhighlander.publisher.rb
+- lib/cfhighlander.tests.rb
 - lib/cfhighlander.validator.rb
+- lib/cfhighlander.version.rb
 - lib/util/cloudformation.util.rb
 - lib/util/debug.util.rb
 - lib/util/zip.util.rb
@@ -297,8 +299,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: DSL on top of cfndsl. Manage libraries of cloudformation components