cfn-nag 0.8.9 → 0.8.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4a16eb5cda1347c3d70d1dba6c5408df9cc1eb6fd59ddf9ceab8bc35e4c2a1f
-  data.tar.gz: acf74edd1722eb6703cb9b3984c0c6656f154564fdb8e4ad758ce00c60a0d52c
+  metadata.gz: 40a08198632607ba6b27da6855a68dce9296ac85e7d5c0b511efd64297c24089
+  data.tar.gz: df6fb8ea0508ebff5ae8d5f74dd4e403294152adfcf43b306e426de33b12eec8
 SHA512:
-  metadata.gz: ce414a1ff11e5a981b410d6dd0f37ae8e677a333aafe66de03fd50cac3fb7d9edc46a229708950cfd03965d1b972f449308c7d241f6869d59159c889b4fc2ca2
-  data.tar.gz: 7ddefcb9485dd9283fca42013fdcf0975358ebb7026acdc6038e38d7438489b8a9367b866bbe7d79e2572907e02b90af212a89ca64a9eb23f7d7d4a6e568af00
+  metadata.gz: bc4b6426631b6777c2a77eb3c7be2fbf776ae1027675c9f420c558cbcc6e2682368889438e05e52a91b0709b06cd4bfcef46ea67d2b051d62b0bbc84b2e843a2
+  data.tar.gz: 69874dc93fee2a9f3aca39c2eef7b5d27f2d2805350792b5dcbb8e8b5ad0d9b4a97c97f98f7d15bf75d1588dfee0c6c31a2ad9a4962a6b834aa8babf9ae7cfaa

data/lib/cfn-nag/cfn_nag_config.rb

@@ -11,14 +11,16 @@ class CfnNagConfig
                  fail_on_warnings: false,
                  ignore_fatal: false,
                  rule_repository_definitions: [],
-                 rule_arguments: {})
+                 rule_arguments: {},
+                 rule_directory_recursive: false)
     @rule_directory = rule_directory
     @custom_rule_loader = CustomRuleLoader.new(
       rule_directory: rule_directory,
       allow_suppression: allow_suppression,
       print_suppression: print_suppression,
       isolate_custom_rule_exceptions: isolate_custom_rule_exceptions,
-      rule_repository_definitions: rule_repository_definitions
+      rule_repository_definitions: rule_repository_definitions,
+      rule_directory_recursive: rule_directory_recursive
     )
     @profile_definition = profile_definition
     @deny_list_definition = deny_list_definition

data/lib/cfn-nag/cfn_nag_executor.rb

@@ -130,7 +130,8 @@ class CfnNagExecutor
       fail_on_warnings: opts[:fail_on_warnings],
       rule_repository_definitions: @rule_repository_definitions,
       ignore_fatal: opts[:ignore_fatal],
-      rule_arguments: merge_rule_arguments(opts)
+      rule_arguments: merge_rule_arguments(opts),
+      rule_directory_recursive: opts[:rule_directory_recursive]
     )
   end
 

data/lib/cfn-nag/cli_options.rb

@@ -54,6 +54,11 @@ class Options
           type: :string,
           required: false,
           default: nil
+      opt :rule_directory_recursive,
+          'Recursively search extra rule directory',
+          type: :boolean,
+          required: false,
+          default: false
       opt :profile_path,
           'Path to a profile file',
           type: :string,

data/lib/cfn-nag/custom_rule_loader.rb

@@ -27,12 +27,14 @@ class CustomRuleLoader
                  allow_suppression: true,
                  print_suppression: false,
                  isolate_custom_rule_exceptions: false,
-                 rule_repository_definitions: [])
+                 rule_repository_definitions: [],
+                 rule_directory_recursive: false)
     @rule_directory = rule_directory
     @allow_suppression = allow_suppression
     @print_suppression = print_suppression
     @isolate_custom_rule_exceptions = isolate_custom_rule_exceptions
     @rule_repository_definitions = rule_repository_definitions
+    @rule_directory_recursive = rule_directory_recursive
     @registry = nil
   end
 
@@ -43,7 +45,8 @@ class CustomRuleLoader
   #
   def rule_definitions(force_refresh: false)
     if @registry.nil? || force_refresh
-      @registry = FileBasedRuleRepo.new(@rule_directory).discover_rules
+      @registry = FileBasedRuleRepo.new(@rule_directory,
+                                        rule_directory_recursive: @rule_directory_recursive).discover_rules
       @registry.merge! GemBasedRuleRepo.new.discover_rules
 
       @registry = RuleRepositoryLoader.new.merge(@registry, @rule_repository_definitions)

data/lib/cfn-nag/rule_repos/file_based_rule_repo.rb

@@ -8,8 +8,9 @@ require 'logging'
 # client's choosing
 #
 class FileBasedRuleRepo
-  def initialize(rule_directory)
+  def initialize(rule_directory, rule_directory_recursive: false)
     @rule_directory = rule_directory
+    @rule_directory_recursive = rule_directory_recursive
     validate_extra_rule_directory rule_directory
   end
 
@@ -19,7 +20,8 @@ class FileBasedRuleRepo
     # we look on the file system, and we load from the file system into a Class
     # that the runtime can refer back to later from the registry which is effectively
     # just a set of rule definitons
-    discover_rule_classes(@rule_directory).each do |rule_class|
+    discover_rule_classes(@rule_directory,
+                          rule_directory_recursive: @rule_directory_recursive).each do |rule_class|
       rule_registry.definition(rule_class)
     end
 
@@ -34,12 +36,18 @@ class FileBasedRuleRepo
     raise "Not a real directory #{rule_directory}"
   end
 
-  def discover_rule_filenames(rule_directory)
+  def locate_rule_files(rule_directory, rule_directory_recursive)
+    return Dir.glob(File.join(rule_directory, '**/*Rule.rb')).sort if rule_directory_recursive
+
+    Dir[File.join(rule_directory, '*Rule.rb')].sort
+  end
+
+  def discover_rule_filenames(rule_directory, rule_directory_recursive: false)
     rule_filenames = []
     unless rule_directory.nil?
-      rule_filenames += Dir[File.join(rule_directory, '*Rule.rb')].sort
+      rule_filenames += locate_rule_files(rule_directory, rule_directory_recursive)
     end
-    rule_filenames += Dir[File.join(__dir__, '..', 'custom_rules', '*Rule.rb')].sort
+    rule_filenames += locate_rule_files(File.join(__dir__, '..', 'custom_rules'), rule_directory_recursive)
 
     # Windows fix when running ruby from Command Prompt and not bash
     rule_filenames.reject! { |filename| filename =~ /_rule.rb$/ }
@@ -47,10 +55,13 @@ class FileBasedRuleRepo
     rule_filenames
   end
 
-  def discover_rule_classes(rule_directory)
+  def discover_rule_classes(rule_directory, rule_directory_recursive: false)
     rule_classes = []
 
-    rule_filenames = discover_rule_filenames(rule_directory)
+    rule_filenames = discover_rule_filenames(
+      rule_directory,
+      rule_directory_recursive: rule_directory_recursive
+    )
     rule_filenames.each do |rule_filename|
       require(File.absolute_path(rule_filename))
       rule_classname = File.basename(rule_filename, '.rb')

data/lib/cfn-nag/version.rb

@@ -2,5 +2,5 @@
 
 module CfnNagVersion
   # This is managed at release time via scripts/publish.sh
-  VERSION = '0.8.9'
+  VERSION = '0.8.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfn-nag
 version: !ruby/object:Gem::Version
-  version: 0.8.9
+  version: 0.8.10
 platform: ruby
 authors:
 - Eric Kascic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-03 00:00:00.000000000 Z
+date: 2022-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake