Updates enforce notes rubocop rule to add notes to modules that are missing notes

Author: cgranleese-r7

lib/msf/core/constants.rb

@@ -55,6 +55,8 @@ module Msf
 # Stability traits
 #
 
+# Module stability is unknown.
+UNKNOWN_STABILITY = 'unknown-stability'
 # Module should not crash the service.
 CRASH_SAFE             = 'crash-safe'
 # Module may crash the service, but the service restarts.
@@ -74,6 +76,8 @@ module Msf
 # Side-effect traits
 #
 
+# Module side effects are unknown.
+UNKNOWN_SIDE_EFFECTS = 'unknown-side-effects'
 # Modules leaves a payload or a dropper on the target machine.
 ARTIFACTS_ON_DISK = 'artifacts-on-disk'
 # Module modifies some configuration setting on the target machine.
@@ -95,6 +99,8 @@ module Msf
 # Reliability
 #
 
+# Module reliability is unknown.
+UNKNOWN_RELIABILITY = 'unknown-reliability'
 # The module tends to fail to get a session on the first attempt.
 FIRST_ATTEMPT_FAIL = 'first-attempt-fail'
 # The module is expected to get a shell every time it runs.

lib/rubocop/cop/lint/module_enforce_notes.rb

@@ -4,6 +4,7 @@ module RuboCop
   module Cop
     module Lint
       class ModuleEnforceNotes < Base
+        extend AutoCorrector
 
         NO_NOTES_MSG = 'Module is missing the Notes section which must include Stability, Reliability and SideEffects] - https://docs.metasploit.com/docs/development/developing-modules/module-metadata/definition-of-module-reliability-side-effects-and-stability.html'
         MISSING_KEY_MSG = 'Module is missing %s from the Notes section - https://docs.metasploit.com/docs/development/developing-modules/module-metadata/definition-of-module-reliability-side-effects-and-stability.html'
@@ -36,12 +37,32 @@ def on_def(node)
           if notes_present
             check_for_required_keys(notes)
           else
-            add_offense(last_key || hash, message: NO_NOTES_MSG)
+            add_offense(last_key || hash, message: NO_NOTES_MSG) do |corrector|
+              insert_notes_autocorrect(corrector, hash)
+            end
           end
         end
 
         private
 
+        def insert_notes_autocorrect(corrector, hash)
+          last_pair = hash.pairs.last
+          indent_width = last_pair.loc.expression.column
+          indent = ' ' * indent_width
+          corrector.insert_after(last_pair.loc.expression, notes_formatted(indent))
+        end
+
+        def notes_formatted(indent)
+          <<~EOF.strip
+            ,
+            #{indent}'Notes' => {
+            #{indent}  'Reliability' => UNKNOWN_RELIABILITY,
+            #{indent}  'Stability' => UNKNOWN_STABILITY,
+            #{indent}  'SideEffects' => UNKNOWN_SIDE_EFFECTS
+            #{indent}}
+          EOF
+        end
+
         def check_for_required_keys(notes)
           last_key = nil
           keys_present = []