cfndsl-pipeline 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2916ce7032d93f6a62603e4f7e0f67d1387429245eda792ae5aaa8421736cbc
-  data.tar.gz: ef9800894ba6333955a3f1ab8bae3e4a2162a15c91a02049062267032a429224
+  metadata.gz: 5ac916d2749dd8f2515364b954dc62dc40e2d9d8242c930bfc0807ae702c2528
+  data.tar.gz: fb3f8cef4fa7cd04b13cca323835e3f1fbe226e5dc1d051c54627c980e3e186e
 SHA512:
-  metadata.gz: 37fad470245cc31ac95127c0af8316b0ecdb28aa54a23e67fe5e9740eabecdb34ae48a7def92277ec01f54204390490a11f1ac46e06620166dff0afffc81c528
-  data.tar.gz: 3a4a082fb5f433f84d0ac4605dc0ba53e0ab28645efccca3c8cd8e1a2d11b5c2bb411ca326df59066a75db974831828769a5166956e30a603b62c2f4801c67df
+  metadata.gz: ba4466092aede32b0161d0cb6dc10365dde94bd2ec31ba1a5c5c1f42dbc26cb8680c9eadf0758d525bb25428b9d99c8f5864fca88722b17c0a58a784cdfe39c5
+  data.tar.gz: 808e4b4a21329d741544a2241219a34449271607db408154f74a001509f9d682d1e736dfa7812b3795293450a36d6a499401ec44220653099aacb8ec825b2680

data/.rubocop.yml

@@ -11,11 +11,11 @@ Metrics/MethodLength:
   Max: 25
 
 # Due to our @Properties style instance names
-Style/VariableName:
+Naming/VariableName:
   Enabled: false
 
 # We are a DSL
-Style/MethodName:
+Naming/MethodName:
   Enabled: false
 
 # Lone String
@@ -26,7 +26,7 @@ AllCops:
   Exclude:
     - 'tmp/**/*'
     - 'examples/**/*'
-    - 'spec/*'
+    - 'spec/**/*'
     - Gemfile
     - Guardfile
     - Rakefile

data/Gemfile

@@ -1,6 +1,5 @@
 source "https://rubygems.org"
 repo_name = "cmaxwellau/cfndsl-pipeline"
-gem "rubocop", ">= 0.49.0"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 

data/bin/cfndsl_pipeline

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'optparse'
 require 'cfndsl-pipeline'
 
@@ -8,7 +10,7 @@ cli_options = {
 }
 
 pipe_options = CfnDslPipeline::Options.new
-
+# rubocop:disable Metrics/BlockLength
 op = OptionParser.new do |opts|
   opts.banner = USAGE
 
@@ -66,6 +68,7 @@ op = OptionParser.new do |opts|
     exit
   end
 end
+# rubocop:enable Metrics/BlockLength
 
 op.parse!
 
@@ -106,7 +109,7 @@ end
 cfndsl_extras = []
 ARGV.each do |arg|
   cfndsl_extras << [:yaml, arg]
-end if ARGV.length > 0
+end
 
 pipeline = CfnDslPipeline::Pipeline.new(cli_options[:output], pipe_options)
 pipeline.build(cli_options[:template], cfndsl_extras)

data/cfndsl-pipeline.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |s|
 
   s.executables << 'cfndsl_pipeline'
 
-  s.add_development_dependency "bundler", "~> 1.5"
+  s.add_development_dependency "bundler", "~> 2.0"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "cfndsl"

data/lib/cfndsl-pipeline.rb

@@ -1,5 +1,6 @@
-#!/usr/bin/env ruby
-#
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
 # The MIT License
 #
 # Copyright (c) 2019 Cam Maxwell (cameron.maxwell@gmail.com)
@@ -53,7 +54,7 @@ module CfnDslPipeline
 
     def build(input_filename, cfndsl_extras)
       abort "Input file #{input_filename} doesn't exist!" unless File.file?(input_filename)
-      self.input_filename = "#{input_filename}"
+      self.input_filename = input_filename.to_s
       self.base_name = File.basename(input_filename, '.*')
       self.output_filename = File.expand_path("#{output_dir}/#{base_name}.yaml")
       exec_cfndsl cfndsl_extras
@@ -63,3 +64,4 @@ module CfnDslPipeline
     end
   end
 end
+# rubocop:enable Naming/FileName

data/lib/cli_options.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'optparse'
 
@@ -19,6 +20,7 @@ module CfnDslPipeline
 
     # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/BlockLength
     def parse
       @op = OptionParser.new do |opts|
         opts.banner = USAGE
@@ -47,8 +49,8 @@ module CfnDslPipeline
           pipeline.validate_cfn_nag = false
         end
 
-        opts.on('--audit-rule-dir', 'cfn_nag audit custom rules directory') do
-          pipeline.cfn_nag[:rule_directory] = true
+        opts.on('--audit-rule-dir', 'cfn_nag audit custom rules directory') do |rule_dir|
+          pipeline.cfn_nag[:rule_directory] = rule_dir
         end
 
         opts.on('--audit-report', 'Save cfn_nag audit report') do
@@ -86,15 +88,17 @@ module CfnDslPipeline
 
       # first non-dash parameter is the mandatory input file
       @template = ARGV.pop
-
+      # rubocop:disable Style/MultilineIfModifier
       ARGV.each do |arg|
         @cfndsl_extras << [:yaml, arg]
-      end if ARGV.length > 0
+      end unless ARGV.empty?
+      # rubocop:enable Style/MultilineIfModifier
 
       pipeline
     end
     # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/BlockLength
 
     def fatal(msg)
       puts msg

data/lib/exec_cfn_nag.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'cfn-nag'
 require 'logging'
 require 'colorize'
 
 module CfnDslPipeline
-  # Add cfn_nag functions to pipeline
+  # Interface to cfn_nag auditing
   class Pipeline
     def exec_cfn_nag
       puts 'Auditing template with cfn-nag...'
@@ -22,23 +24,28 @@ module CfnDslPipeline
     end
 
     def display_report(result)
-      ColoredStdoutResults.new.render([
-        {
-          filename: "#{@base_name}",
-          file_results: result
-        }
-      ])
+      ColoredStdoutResults.new.render(
+        [
+          {
+            filename: @base_name.to_s,
+            file_results: result
+          }
+        ]
+      )
     end
 
     def save_report(result)
       return unless options.save_audit_report
+
       report_data = Capture.capture do
-        SimpleStdoutResults.new.render([
-          {
-            filename: "#{@base_name}",
-            file_results: result
-          }
-        ])
+        SimpleStdoutResults.new.render(
+          [
+            {
+              filename: @base_name.to_s,
+              file_results: result
+            }
+          ]
+        )
       end
       filename = "#{output_dir}/#{base_name}.audit"
       File.open(File.expand_path(filename), 'w').puts report_data['stdout']
@@ -46,9 +53,9 @@ module CfnDslPipeline
     end
 
     def show_summary(result)
-      if result[:failure_count] > 0
+      if result[:failure_count].positive?
         puts "Audit failed. #{result[:failure_count]} error(s) found     ( ಠ ʖ̯ ಠ)  ".red
-      elsif result[:violations].count > 0
+      elsif result[:violations].count.positive?
         puts "Audit passed with #{result[:warning_count]} warnings.     (._.)  ".yellow
       else
         puts 'Audit passed!        ヽ( ﾟヮﾟ)/      ヽ(´ー｀)ノ'.green

data/lib/exec_cfndsl.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require 'cfndsl'
 require 'cfndsl/globals'
 require 'cfndsl/version'
 
 module CfnDslPipeline
-  #
+  # Interface to cfndsl
   class Pipeline
     def exec_cfndsl(cfndsl_extras)
       puts 'Generating CloudFormation template...'
 
-      model = CfnDsl.eval_file_with_extras("#{@input_filename}", cfndsl_extras, (options.debug_cfndsl ? STDOUT : nil))
+      model = CfnDsl.eval_file_with_extras(@input_filename.to_s, cfndsl_extras, (options.debug_cfndsl ? STDOUT : nil))
       @template = JSON.parse(model.to_json).to_yaml
       File.open(@output_filename, 'w') do |file|
         file.puts @template

data/lib/exec_syntax.rb

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
+
 require 'aws-sdk-cloudformation'
 require 'aws-sdk-s3'
 require 'uuid'
 
 module CfnDslPipeline
-  #
+  # Interface to AWS SDK syntax checks
   class Pipeline
     attr_accessor :s3_client
 
     def initialize
       self.s3_client = Aws::S3::Client.new(region: aws_region)
     end
-    # rubocop:disable Metrics/AbcSize
+
     def exec_syntax_validation
       puts 'Validating template syntax...'
       if options.estimate_cost || (output_file.size > 51_200)
@@ -31,7 +32,6 @@ module CfnDslPipeline
       end
       save_syntax_report
     end
-    # rubocop:enable Metrics/AbcSize
 
     private
 
@@ -51,6 +51,7 @@ module CfnDslPipeline
 
     def save_syntax_report
       return unless options.save_syntax_report
+
       report_filename = "#{output_dir}/#{base_name}.report"
       puts "Syntax validation report written to #{report_filename}"
       File.open(File.expand_path(report_filename), 'w').puts syntax_report.to_hash.to_yaml
@@ -65,6 +66,7 @@ module CfnDslPipeline
 
     def estimate_cost(bucket, object_name)
       return unless options.estimate_cost
+
       puts 'Estimate cost of template...'
       client = Aws::CloudFormation::Client.new(region: options.aws_region)
       costing = client.estimate_template_cost(template_url: "https://#{bucket.url}/#{object_name}")
@@ -73,6 +75,7 @@ module CfnDslPipeline
 
     def s3_validate_syntax(bucket, object_name)
       return unless options.validate_syntax
+
       puts 'Validating template syntax in S3 Bucket...'
       client = Aws::CloudFormation::Client.new(region: options.aws_region)
       client.validate_template(template_url: "https://s3.amazonaws.com/#{bucket.url}/#{object_name}")

data/lib/monkey-patches/cfndsl_patch.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'cfndsl/globals'
 require 'cfndsl/version'
 require 'cfndsl/external_parameters'
@@ -13,7 +14,7 @@ HAS_MAPPED_TAGS = %w([CfnDsl::AWS::Types::AWS_Serverless_Function CfnDsl::AWS::T
 # Automatically add Parameters for Tag values
 CfnDsl::CloudFormationTemplate.class_eval do
   def initialize
-    return unless defined? external_parameters[:TagStandard]
+    return unless external_parameters&.fetch(:TagStandard) && external_parameters[:TagStandard].is_a?(Hash)
 
     # parameters for tagging standard
     external_parameters[:TagStandard].each do |param_name, props|
@@ -25,7 +26,7 @@ CfnDsl::CloudFormationTemplate.class_eval do
           send(key, props[key]) if props[key]
         end
       end
-    end if external_parameters[:TagStandard].is_a?(Hash)
+    end
   end
 end
 
@@ -48,9 +49,10 @@ module CfnDsl
 
     def fix_substitutions(val)
       return val unless defined? val.class.to_s.downcase
-      meth = "fix_#{val.class.to_s.downcase}"
 
+      meth = "fix_#{val.class.to_s.downcase}"
       return send(meth, val) if respond_to?(meth.to_sym)
+
       val
     end
 
@@ -79,6 +81,7 @@ module CfnDsl
     def apply_tag_standard
       return unless defined? external_parameters[:TagStandard]
       return unless external_parameters[:TagStandard].is_a?(Hash)
+
       apply_tags(external_parameters[:TagStandard]) if defined? self.Tag
       apply_tags_map(external_parameters[:TagStandard]) if HAS_MAPPED_TAGS.include? self.class.to_s
     end

data/lib/options.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
+
 require 'cfn-nag/custom_rule_loader'
 require 'cfn-nag/cfn_nag_config'
 
 module CfnDslPipeline
-  #
+  # Main pipeline options
   class Options
     attr_accessor :aws_region, :validation_bucket, :estimate_cost, :dump_deploy_params, :cfn_nag
     attr_accessor :validate_cfn_nag, :save_audit_report, :validate_syntax, :save_syntax_report, :validate_output

data/lib/params.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
+
 require 'shellwords'
 
 module CfnDslPipeline
-  #
+  # Dump stack parameters based on template
   class Pipeline
     def exec_dump_params
       param_filename = "#{output_dir}/#{base_name}.params"

data/lib/version.rb

@@ -1,4 +1,6 @@
-#
+# frozen_string_literal: true
+
+# set release version
 module CfnDslPipeline
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfndsl-pipeline
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Cam Maxwell
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -221,8 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.10
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Integrated build pipeline for building CloudFormation with CfnDsl