cfn-nag 0.4.34 → 0.4.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6752cc3e3d3ce81e5c44cade95b3ce4e835f0e970ba569f7f22195263dc6b0b
-  data.tar.gz: e799f598d3801a0f08f245030f1d443c8833eb6a8c1908f8f68bf25bda5cf344
+  metadata.gz: 1cd3cda83224573532bebacc848e7faeae97f5b3a0a187dd3797239619303d38
+  data.tar.gz: '08d538e752ee13690d7deb5b5b3e8a6d8fb781b3d9e5f8df956e7123f9739cea'
 SHA512:
-  metadata.gz: ea387fb025d464da13af920f37b853bce0449aab6b36b64047f89dfea077d6e2cde28274189e94c0d7a69bc6510fccd579e52cc1123adb2fe0d4a885530ef36c
-  data.tar.gz: a4126ce6aa568a77319e3d8f1dd86469a382eff8bd6270dd2173b3e86df6d3768cbf411765c397991c79af0544f51d04069df5a1b27d0fb32418c91ef4630fb5
+  metadata.gz: 78154bc0b1f476d8331c8f1c0796d523b2315e208e89d409b2424639fbd567c1e2748125c1a1dfac41a8218d70a3d19036eb8b63a517e561a31f170b485c8757
+  data.tar.gz: 41069d603ec8833debf6bb5f79a73a7f86addf24837a79134b24e00978a536bbc7bb4d781b5848a5e24225232dc95635ece872f830f526ec1364b5826c7ff5ac

data/bin/cfn_nag_rules

@@ -14,6 +14,10 @@ opts = Trollop.options do
   opt :profile_path, 'Path to a profile file', type: :io,
                                                required: false,
                                                default: nil
+  opt :output_format,
+      'Format of results: [csv, json, txt]',
+      type: :string,
+      default: 'txt'
 end
 
 profile_definition = nil
@@ -22,6 +26,7 @@ unless opts[:profile_path].nil?
 end
 
 rule_dumper = CfnNagRuleDumper.new(profile_definition: profile_definition,
-                                   rule_directory: opts[:rule_directory])
+                                   rule_directory: opts[:rule_directory],
+                                   output_format: opts[:output_format])
 
 rule_dumper.dump_rules

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

@@ -1,13 +1,21 @@
 # frozen_string_literal: true
 
+require 'json'
+
 # View rules warnings/failings
 class RulesView
-  def emit(rule_registry, profile)
-    puts 'WARNING VIOLATIONS:'
-    emit_warnings rule_registry.warnings, profile
-    puts
-    puts 'FAILING VIOLATIONS:'
-    emit_failings rule_registry.failings, profile
+  def emit(rule_registry, profile, output_format: 'txt')
+    warnings = select_rules(rule_registry.warnings, profile)
+    failings = select_rules(rule_registry.failings, profile)
+    rules = failings + warnings
+    case output_format
+    when 'csv'
+      emit_csv(rules)
+    when 'json'
+      puts rules_to_json(rules)
+    when 'txt'
+      emit_txt(warnings, failings)
+    end
 
     if rule_registry.duplicate_ids?
       emit_duplicates(rule_registry.duplicate_ids)
@@ -17,6 +25,21 @@ class RulesView
 
   private
 
+  def emit_txt(warnings, failings)
+    output_pattern = '%<id>s %<message>s'
+    puts 'WARNING VIOLATIONS:'
+    emit_rules(warnings, output_pattern)
+    puts
+    puts 'FAILING VIOLATIONS:'
+    emit_rules(failings, output_pattern)
+  end
+
+  def emit_csv(rules)
+    output_pattern = '%<type>s,%<id>s,"%<message>s"'
+    puts 'Type,ID,Message'
+    emit_rules(rules, output_pattern)
+  end
+
   def emit_duplicates(duplicates)
     duplicates.each do |info|
       puts '------------------'.red
@@ -26,24 +49,27 @@ class RulesView
     end
   end
 
-  def emit_warnings(warnings, profile)
-    warnings.sort { |left, right| sort_id(left, right) }.each do |warning|
-      if profile.nil?
-        puts "#{warning.id} #{warning.message}"
-      elsif profile.contains_rule?(warning.id)
-        puts "#{warning.id} #{warning.message}"
-      end
+  def select_rules(rules, profile)
+    selected = if profile.nil?
+                 rules
+               else
+                 rules.select { |rule| profile.contains_rule?(rule.id) }
+               end
+    selected.sort { |left, right| sort_id(left, right) }
+  end
+
+  def emit_rules(rules, output_pattern)
+    rules.each do |rule|
+      puts format(output_pattern, id: rule.id, message: rule.message, type: rule.type)
     end
   end
 
-  def emit_failings(failings, profile)
-    failings.sort { |left, right| sort_id(left, right) }.each do |failing|
-      if profile.nil?
-        puts "#{failing.id} #{failing.message}"
-      elsif profile.contains_rule?(failing.id)
-        puts "#{failing.id} #{failing.message}"
-      end
+  def rules_to_json(rules)
+    rule_array = []
+    rules.each do |rule|
+      rule_array << rule.to_h
     end
+    puts JSON.pretty_generate(rule_array)
   end
 
   def sort_id(left, right)

data/lib/cfn-nag/rule_dumper.rb

@@ -6,9 +6,11 @@ require_relative 'result_view/rules_view'
 
 class CfnNagRuleDumper
   def initialize(profile_definition: nil,
-                 rule_directory: nil)
+                 rule_directory: nil,
+                 output_format: nil)
     @rule_directory = rule_directory
     @profile_definition = profile_definition
+    @output_format = output_format
   end
 
   def dump_rules
@@ -21,6 +23,6 @@ class CfnNagRuleDumper
                              .load(profile_definition: @profile_definition)
     end
 
-    RulesView.new.emit(rule_registry, profile)
+    RulesView.new.emit(rule_registry, profile, output_format: @output_format)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfn-nag
 version: !ruby/object:Gem::Version
-  version: 0.4.34
+  version: 0.4.35
 platform: ruby
 authors:
 - Eric Kascic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-19 00:00:00.000000000 Z
+date: 2019-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake