cfndsl-pipeline 0.1.2 → 0.1.4

data/lib/options.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
+require 'cfn-nag/custom_rule_loader'
+require 'cfn-nag/cfn_nag_config'
 
 module CfnDslPipeline
+  #
   class Options
-    attr_accessor :aws_region, :validation_bucket, :save_audit_report, :validate_syntax, :save_syntax_report, :validate_cfn_nag, :validate_output, :estimate_cost, :dump_deploy_params, :cfn_nag, :debug_audit
-    def initialize()
-      self.aws_region         = 'ap-southeast-2'
+    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
+    attr_accessor :debug_audit, :debug_pipeline, :debug_cfndsl
+    def initialize
+      self.aws_region         = ENV['AWS_REGION'] || 'ap-southeast-2'
       self.validation_bucket  = ''
       self.validate_cfn_nag   = false
       self.validate_syntax    = false
@@ -12,6 +17,8 @@ module CfnDslPipeline
       self.save_syntax_report = false
       self.dump_deploy_params = false
       self.save_audit_report  = false
+      self.debug_pipeline     = false
+      self.debug_cfndsl       = false
       self.debug_audit        = false
       self.cfn_nag = CfnNagConfig.new(
         print_suppression: false,
@@ -20,4 +27,3 @@ module CfnDslPipeline
     end
   end
 end
-

data/lib/params.rb

@@ -2,14 +2,15 @@
 require 'shellwords'
 
 module CfnDslPipeline
+  #
   class Pipeline
-  	def exec_dump_params
-      param_filename = "#{self.output_dir}/#{self.base_name}.params"
+    def exec_dump_params
+      param_filename = "#{output_dir}/#{base_name}.params"
       puts "Deploy parameters written to #{param_filename}"
       param_file = File.open(File.expand_path(param_filename), 'w')
-      self.syntax_report['parameters'].each do | param |
-        param_file.puts "#{param['parameter_key']}=#{Shellwords.escape(param['default_value'])}"
+      syntax_report['parameters'].each do |param|
+        param_file.puts "#{param['parameter_key']}=#{param['default_value']}"
       end
     end
   end
-end  
+end

data/lib/version.rb

@@ -1,3 +1,4 @@
+#
 module CfnDslPipeline
-  VERSION = "0.1.2"
+  VERSION = '0.1.4'
 end

data/spec/cfndsl/pipeline_spec.rb

@@ -0,0 +1,11 @@
+require "cfndsl"
+
+RSpec.describe CfnDslPipeline do
+  it "has a version number" do
+    expect(CfnDslPipeline::VERSION).not_to be nil
+  end
+
+  it "does something useful" do
+    expect(true).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+require 'cfndsl'
+require 'cfndsl-pipeline'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfndsl-pipeline
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Cam Maxwell
@@ -14,86 +14,156 @@ dependencies:
   name: cfn-nag
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.35
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.35
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: cfndsl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.0
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.0
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.46.0
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.46.0
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: uuid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.9
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.9
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cfndsl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.49.0
 description: Integrated CfnDsl CloudFormation template generation pipeline that integrates
   cfn_nag, AWS template validation, and AWS template costing (where possible), and
   generated `aws cloudformation deploy` compatible parameters files
@@ -103,16 +173,35 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENCE
+- README.md
+- Rakefile
 - bin/cfndsl_pipeline
+- cfndsl-pipeline.gemspec
+- examples/common_definitions.yaml
+- examples/pipeline_multple_files.rb
+- examples/pipeline_single_file.rb
+- examples/s3bucket.rb
+- examples/s3bucket.yaml
+- examples/standard_tags.yaml
 - lib/cfndsl-pipeline.rb
-- lib/monkey_patches.rb
+- lib/cli_options.rb
+- lib/exec_cfn_nag.rb
+- lib/exec_cfndsl.rb
+- lib/exec_syntax.rb
+- lib/monkey-patches/cfndsl_patch.rb
+- lib/monkey-patches/stdout_capture.rb
 - lib/options.rb
 - lib/params.rb
-- lib/run-cfn_nag.rb
-- lib/run-cfndsl.rb
-- lib/run-syntax.rb
-- lib/stdout_capture.rb
 - lib/version.rb
+- spec/cfndsl/pipeline_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/cmaxwellau/cfndsl-pipeline.git
 licenses:
 - MIT

data/lib/run-cfn_nag.rb

@@ -1,38 +0,0 @@
-require 'cfn-nag'
-require 'colorize'
-
-module CfnDslPipeline
-
-  class Pipeline
-    def exec_cfn_nag
-      puts "Auditing template with cfn-nag..."
-      
-      CfnNagLogging.configure_logging({:debug => self.options.debug_audit})
-      cfn_nag = CfnNag.new(config: self.options.cfn_nag)
-      result = cfn_nag.audit(cloudformation_string: self.template)
-      if self.options.save_audit_report
-        audit_report = Capture.capture do
-          SimpleStdoutResults.new.render([{
-            filename: output_filename,
-            file_results: result
-          }])
-        end
-        audit_filename = "#{self.output_dir}/#{self.base_name}.audit"
-        File.open(File.expand_path(audit_filename), 'w').puts audit_report['stdout']
-        puts "Saved audit report to #{audit_filename}"
-        if result[:failure_count]>0
-          puts "Audit failed. #{result[:failure_count]} error(s) found     ( ಠ ʖ̯ ಠ)  ".red
-        elsif result[:violations].count>0
-          puts "Audit passed with #{result[:warning_count]} warnings.     (._.)  ".yellow
-        else
-          puts "Audit passed!        ヽ( ﾟヮﾟ)/      ヽ(´ー｀)ノ".green
-        end        
-      else
-        ColoredStdoutResults.new.render([{
-          filename: "cfn-nag results:",
-          file_results: result
-        }]) 
-      end
-    end
-  end
-end

data/lib/run-syntax.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-require 'aws-sdk-cloudformation'
-require 'aws-sdk-s3' 
-require 'uuid'
-
-
-module CfnDslPipeline
-  class Pipeline
-    attr_accessor :cfn_client, :s3_client
-
-    def initialize
-      self.cfn_client = Aws::CloudFormation::Client.new(region: self.aws_region)
-      self.s3_client = Aws::S3::Client.new(region: self.aws_region)
-    end
-
-    def exec_syntax_validation
-      print "Validating template syntax...\n"
-      if self.options.estimate_cost || (self.output_file.size > 51200)
-        puts "Filesize is greater than 51200, or cost estimation required. Validating via S3 bucket "
-        uuid = UUID.new
-        object_name = "#{uuid.generate}"
-
-        if self.options.validation_bucket
-          bucket_name = self.options.validation_bucket
-          puts "Using existing S3 bucket #{bucket_name}..."
-          bucket = self.s3_client.bucket(self.options.validation_bucket)
-        else
-          bucket_name = "arch-code-#{uuid.generate}"
-          puts "Creating temporary S3 bucket #{bucket_name}..."
-          bucket = self.s3_client.bucket(bucket_name)
-          bucket.create 
-        end
-        upload_template(bucket, object_name)
-
-        self.syntax_report = s3_validate_syntax(bucket, object_name)
-
-        if self.options.estimate_cost
-          estimate_cost(bucket_name, object_name)
-        end
-
-        if !self.options.validation_bucket
-          puts "Deleting temporary S3 bucket..."
-          bucket.delete! 
-        end
-
-      else 
-        self.syntax_report = local_validate_syntax
-      end
-
-      save_syntax_report if self.options.save_syntax_report
-
-    end
-
-    private
-    def save_syntax_report
-      report_filename = "#{self.output_dir}/#{self.base_name}.report"
-      puts "Syntax validation report written to #{report_filename}"
-      File.open(File.expand_path(report_filename), 'w').puts self.syntax_report.to_hash.to_yaml
-    end
-
-    def upload_template(bucket, object_name)
-      puts "Uploading template to temporary S3 bucket..."
-      object = bucket.object(object_name)
-      object.upload_file(self.output_file)
-      puts "  https://s3.amazonaws.com/#{bucket_name}/#{object_name}"
-    end
-
-    def estimate_cost(bucket, object_name)
-      puts "Estimate cost of template..."
-      client = Aws::CloudFormation::Client.new(region: self.options.aws_region)
-      costing = client.estimate_template_cost(template_url: "https://#{bucket.url}/#{object_name}")
-      puts "Cost Calculator URL is: #{costing.url}"
-    end
-
-    def s3_validate_syntax(bucket, object_name)
-      if self.options.validate_syntax
-        puts "Validating template syntax in S3 Bucket..."
-        client = Aws::CloudFormation::Client.new(region: self.options.aws_region)
-        client.validate_template(template_url: "https://s3.amazonaws.com/#{bucket.url}/#{object_name}")
-      end
-    end
-
-    def local_validate_syntax
-      puts "Validating template syntax locally..."
-      client = Aws::CloudFormation::Client.new(region: self.options.aws_region)
-      client.validate_template(template_body: self.template)
-    end
-  end
-end