Extract 'untested payloads' shared context

MSP-11145

Detects if payloads are untested when using the 'payload can be
instantiated' shared examples.

spec/modules/payloads_spec.rb

@@ -3,45 +3,12 @@ require 'spec_helper'
 describe 'modules/payloads' do
   modules_pathname = Pathname.new(__FILE__).parent.parent.parent.join('modules')
 
+  include_context 'untested payloads', modules_pathname: modules_pathname
+
   #
   # Callbacks
   #
 
-  before(:all) do
-    @expected_ancestor_reference_name_set = Set.new
-    @actual_ancestor_reference_name_set = Set.new
-
-    payloads_pathname = modules_pathname.join('payloads')
-
-    Dir.glob(payloads_pathname.join('**', '*.rb')) do |expected_ancestor_path|
-      expected_ancestor_pathname = Pathname.new(expected_ancestor_path)
-      expected_ancestor_reference_pathname = expected_ancestor_pathname.relative_path_from(payloads_pathname)
-      expected_ancestor_reference_name = expected_ancestor_reference_pathname.to_path.gsub(/.rb$/, '')
-
-      @expected_ancestor_reference_name_set.add(expected_ancestor_reference_name)
-    end
-  end
-
-  after(:all) do
-    missing_ancestor_reference_name_set = @expected_ancestor_reference_name_set - @actual_ancestor_reference_name_set
-
-    untested_payloads_pathname = Pathname.new('log/untested-payloads.log')
-
-    if missing_ancestor_reference_name_set.empty?
-      if untested_payloads_pathname.exist?
-        untested_payloads_pathname.delete
-      end
-    else
-      untested_payloads_pathname.open('w') do |f|
-        missing_ancestor_reference_name_set.sort.each do |missing_ancestor_reference_name|
-          f.puts missing_ancestor_reference_name
-        end
-      end
-
-      $stderr.puts "Some payloads are untested.  See log/untested-payload.log for details."
-    end
-  end
-
   context 'aix/ppc/shell_bind_tcp' do
     it_should_behave_like 'payload can be instantiated',
                           ancestor_reference_names: [

spec/support/shared/contexts/untested_payloads.rb

@@ -0,0 +1,48 @@
+# Use along with `it_should_behave_like 'payload can be instantiated'` to detect if a payload under `:modules_pathname`
+# was not tested.  If any payloads are untested, an error will be written to stderr and the names of untested payloads
+# will be logged to `log/untested-payloads.log`.  This log is reset for run of context, so if there were previously
+# untested payloads and there aren't anymore, then `log/untested-payloads.log` will be deleted.
+#
+# @param options [Hash{Symbol => Pathname}]
+# @option options [Pathname] :modules_pathname Pathname of `modules` directory underwhich payloads are defined on the
+#   file system.
+shared_context 'untested payloads' do |options={}|
+  options.assert_valid_keys(:modules_pathname)
+
+  modules_pathname = options.fetch(:modules_pathname)
+
+  before(:all) do
+    @expected_ancestor_reference_name_set = Set.new
+    @actual_ancestor_reference_name_set = Set.new
+
+    payloads_pathname = modules_pathname.join('payloads')
+
+    Dir.glob(payloads_pathname.join('**', '*.rb')) do |expected_ancestor_path|
+      expected_ancestor_pathname = Pathname.new(expected_ancestor_path)
+      expected_ancestor_reference_pathname = expected_ancestor_pathname.relative_path_from(payloads_pathname)
+      expected_ancestor_reference_name = expected_ancestor_reference_pathname.to_path.gsub(/.rb$/, '')
+
+      @expected_ancestor_reference_name_set.add(expected_ancestor_reference_name)
+    end
+  end
+
+  after(:all) do
+    missing_ancestor_reference_name_set = @expected_ancestor_reference_name_set - @actual_ancestor_reference_name_set
+
+    untested_payloads_pathname = Pathname.new('log/untested-payloads.log')
+
+    if missing_ancestor_reference_name_set.empty?
+      if untested_payloads_pathname.exist?
+        untested_payloads_pathname.delete
+      end
+    else
+      untested_payloads_pathname.open('w') do |f|
+        missing_ancestor_reference_name_set.sort.each do |missing_ancestor_reference_name|
+          f.puts missing_ancestor_reference_name
+        end
+      end
+
+      $stderr.puts "Some payloads are untested.  See log/untested-payload.log for details."
+    end
+  end
+end