cfn-nag 0.4.29 → 0.4.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '011839ee5d19c5990b7fb7b28a87b961336cf98a35a3a7fa5792e01e5d9470cc'
-  data.tar.gz: b04751c2b454226955d2b6aac10ee005338c9a5cb2aa0f3c34bfd5ca216138b6
+  metadata.gz: f82f950358452ac63aa12bde592b60ec9c45e07ab2b21e6c90afa744dc8b372a
+  data.tar.gz: cd9c81ca1dbda0f07f426dc11364b2325bfcdbaf699623551d5badaf34784bfc
 SHA512:
-  metadata.gz: 98a9ffb0a8d6888eabf60416c88e1ad05626eacf0bf279a05ac973f7140702eec5cc9915acf2464176e1bb43bbccc8decac5dac048a62b6ae95e5fc16f196de8
-  data.tar.gz: 2c16cc585f3d22f7912d32d38202fe67297ab3c10927f4f5e329384fa0916052cf633027349fbc92db9be496959f0f9346eee423886f8ceef95ab1f3a2e324a8
+  metadata.gz: 9895244d3c78061c3e8547870675eeb1327d3080bb384da07a05feae3819c04475226c7b889594bafdf80981719e8c3a89802966bfba6827098b5a5798c68296
+  data.tar.gz: eb4fcda99303bdea8ea44f3e7e54889eed6a4f1e0a9c20a8e7d2f08006e01812452c37662c193838aceda3784729f2bf98db559277e9fa2eda3290eeb4db0a9d

data/lib/cfn-nag/cfn_nag.rb

@@ -4,7 +4,9 @@ require_relative 'custom_rule_loader'
 require_relative 'rule_registry'
 require_relative 'violation_filtering'
 require_relative 'template_discovery'
+require_relative 'result_view/stdout_results'
 require_relative 'result_view/simple_stdout_results'
+require_relative 'result_view/colored_stdout_results'
 require_relative 'result_view/json_results'
 require 'cfn-model'
 
@@ -142,6 +144,7 @@ class CfnNag
 
   def results_renderer(output_format)
     registry = {
+      'colortxt' => ColoredStdoutResults,
       'txt' => SimpleStdoutResults,
       'json' => JsonResults
     }

data/lib/cfn-nag/cfn_nag_executor.rb

@@ -69,9 +69,9 @@ class CfnNagExecutor
   end
 
   def validate_options(opts)
-    unless opts[:output_format].nil? || %w[txt json].include?(opts[:output_format])
+    unless opts[:output_format].nil? || %w[colortxt txt json].include?(opts[:output_format])
       Trollop.die(:output_format,
-                  'Must be txt or json')
+                  'Must be colortxt, txt, or json')
     end
   end
 

data/lib/cfn-nag/cli_options.rb

@@ -79,9 +79,9 @@ class Options
           required: false,
           default: false
       opt :output_format,
-          'Format of results: [txt, json]',
+          'Format of results: [txt, json, colortxt]',
           type: :string,
-          default: 'txt'
+          default: 'colortxt'
     end
   end
 
@@ -104,9 +104,9 @@ class Options
           type: :string,
           required: true
       opt :output_format,
-          'Format of results: [txt, json]',
+          'Format of results: [txt, json, colortxt]',
           type: :string,
-          default: 'txt'
+          default: 'colortxt'
       opt :debug,
           'Enable debug output',
           type: :boolean,

data/lib/cfn-nag/result_view/colored_stdout_results.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'cfn-nag/violation'
+require 'colorize'
+
+# Print results to STDOUT with ANSI color codes
+class ColoredStdoutResults < StdoutResults
+  private
+
+  # rubocop:disable Metrics/AbcSize
+  def message(message_type:,
+              color:,
+              message:,
+              logical_resource_ids: nil,
+              line_numbers: [])
+
+    logical_resource_ids = nil if logical_resource_ids == []
+
+    60.times { print '-' }
+    puts
+    puts "| #{message_type.upcase}".send(color)
+    puts '|'.send(color)
+    puts "| Resources: #{logical_resource_ids}".send(color) unless logical_resource_ids.nil?
+    puts "| Line Numbers: #{line_numbers}".send(color) unless line_numbers.empty?
+    puts '|'.send(color) unless line_numbers.empty? && logical_resource_ids.nil?
+    puts "| #{message}".send(color)
+  end
+  # rubocop:enable Metrics/AbcSize
+end

data/lib/cfn-nag/result_view/simple_stdout_results.rb

@@ -1,50 +1,15 @@
 # frozen_string_literal: true
 
 require 'cfn-nag/violation'
-require 'colorize'
 
 # Print results to STDOUT
-class SimpleStdoutResults
-  def message_violations(violations)
-    violations.each do |violation|
-      color = violation.type == 'FAIL' ? :red : :yellow
-
-      message message_type: "#{violation.type} #{violation.id}",
-              color: color,
-              message: violation.message,
-              logical_resource_ids: violation.logical_resource_ids,
-              line_numbers: violation.line_numbers
-    end
-  end
-
-  def print_failures(violations)
-    puts "\nFailures count: #{Violation.count_failures(violations)}"
-  end
-
-  def print_warnings(violations)
-    puts "Warnings count: #{Violation.count_warnings(violations)}"
-  end
-
-  def render(results)
-    results.each do |result|
-      60.times { print '-' }
-      puts "\n" + result[:filename]
-      60.times { print '-' }
-
-      violations = result[:file_results][:violations]
-
-      message_violations violations
-      print_failures violations
-      print_warnings violations
-    end
-  end
-
+class SimpleStdoutResults < StdoutResults
   private
 
-  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Lint/UnusedMethodArgument
   def message(message_type:,
-              color:,
               message:,
+              color:,
               logical_resource_ids: nil,
               line_numbers: [])
 
@@ -52,16 +17,12 @@ class SimpleStdoutResults
 
     60.times { print '-' }
     puts
-    puts "| #{message_type.upcase}".send(color)
-    puts '|'.send(color)
-    puts "| Resources: #{logical_resource_ids}".send(color) unless logical_resource_ids.nil?
-    puts "| Line Numbers: #{line_numbers}".send(color) unless line_numbers.empty?
-    puts '|'.send(color) unless line_numbers.empty? && logical_resource_ids.nil?
-    puts "| #{message}".send(color)
-  end
-  # rubocop:enable Metrics/AbcSize
-
-  def indent_multiline_string_with_prefix(prefix, multiline_string)
-    prefix + ' ' + multiline_string.gsub(/\n/, "\n#{prefix} ")
+    puts "| #{message_type.upcase}"
+    puts '|'
+    puts "| Resources: #{logical_resource_ids}" unless logical_resource_ids.nil?
+    puts "| Line Numbers: #{line_numbers}" unless line_numbers.empty?
+    puts '|' unless line_numbers.empty? && logical_resource_ids.nil?
+    puts "| #{message}"
   end
+  # rubocop:enable Lint/UnusedMethodArgument
 end

data/lib/cfn-nag/result_view/stdout_results.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'cfn-nag/violation'
+require 'colorize'
+
+# Print results to STDOUT
+class StdoutResults
+  def message_violations(violations)
+    violations.each do |violation|
+      color = violation.type == 'FAIL' ? :red : :yellow
+
+      message message_type: "#{violation.type} #{violation.id}",
+              color: color,
+              message: violation.message,
+              logical_resource_ids: violation.logical_resource_ids,
+              line_numbers: violation.line_numbers
+    end
+  end
+
+  def print_failures(violations)
+    puts "\nFailures count: #{Violation.count_failures(violations)}"
+  end
+
+  def print_warnings(violations)
+    puts "Warnings count: #{Violation.count_warnings(violations)}"
+  end
+
+  def render(results)
+    results.each do |result|
+      60.times { print '-' }
+      puts "\n" + result[:filename]
+      60.times { print '-' }
+
+      violations = result[:file_results][:violations]
+
+      message_violations violations
+      print_failures violations
+      print_warnings violations
+    end
+  end
+
+  private
+
+  def message
+    raise 'Must be implemented in subclass!'
+  end
+
+  def indent_multiline_string_with_prefix(prefix, multiline_string)
+    prefix + ' ' + multiline_string.gsub(/\n/, "\n#{prefix} ")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfn-nag
 version: !ruby/object:Gem::Version
-  version: 0.4.29
+  version: 0.4.30
 platform: ruby
 authors:
 - Eric Kascic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-05 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -246,9 +246,11 @@ files:
 - lib/cfn-nag/jmes_path_discovery.rb
 - lib/cfn-nag/jmes_path_evaluator.rb
 - lib/cfn-nag/profile_loader.rb
+- lib/cfn-nag/result_view/colored_stdout_results.rb
 - lib/cfn-nag/result_view/json_results.rb
 - lib/cfn-nag/result_view/rules_view.rb
 - lib/cfn-nag/result_view/simple_stdout_results.rb
+- lib/cfn-nag/result_view/stdout_results.rb
 - lib/cfn-nag/rule_definition.rb
 - lib/cfn-nag/rule_dumper.rb
 - lib/cfn-nag/rule_id_set.rb