From 1ec6884bfadb9cb013c4e285dca32c9e42529100 Mon Sep 17 00:00:00 2001
From: James Lee <egypt@metasploit.com>
Date: Thu, 25 Apr 2013 10:24:36 -0500
Subject: [PATCH] Use before(:each) instead of :all

Fixes deprecation warnings in newer rspec like these

  WARNING: subject accessed in a `before(:all)` hook at:
    /metasploit-framework/spec/lib/rex/post/meterpreter/packet_spec.rb:455:in `block (3 levels) in <top (required)>'

  This is deprecated behavior that will not be supported in RSpec 3.

Also switches to using named subjects for easier reading.
---
 spec/lib/rex/post/meterpreter/packet_spec.rb | 246 ++++++++++---------
 1 file changed, 124 insertions(+), 122 deletions(-)

diff --git a/spec/lib/rex/post/meterpreter/packet_spec.rb b/spec/lib/rex/post/meterpreter/packet_spec.rb
index c05078c88f..20e5634f24 100644
--- a/spec/lib/rex/post/meterpreter/packet_spec.rb
+++ b/spec/lib/rex/post/meterpreter/packet_spec.rb
@@ -1,7 +1,7 @@
 require 'rex/post/meterpreter/packet'
 
 describe Rex::Post::Meterpreter::Tlv do
-  subject{
+  subject(:tlv) {
     Rex::Post::Meterpreter::Tlv.new(
       Rex::Post::Meterpreter::TLV_TYPE_STRING,
       "test"
@@ -9,208 +9,210 @@ describe Rex::Post::Meterpreter::Tlv do
   }
 
   it "should respond to type" do
-    subject.should respond_to :type
+    tlv.should respond_to :type
   end
 
   it "should respond to value" do
-    subject.should respond_to :value
+    tlv.should respond_to :value
   end
 
   it "should respond to compress" do
-    subject.should respond_to :compress
+    tlv.should respond_to :compress
   end
 
   it "should respond to inspect" do
-    subject.should respond_to :inspect
+    tlv.should respond_to :inspect
   end
 
   it "should respond to meta_type?" do
-    subject.should respond_to :meta_type?
+    tlv.should respond_to :meta_type?
   end
 
   it "should respond to type?" do
-    subject.should respond_to :type?
-  end  
+    tlv.should respond_to :type?
+  end
 
   it "should respond to value?" do
-    subject.should respond_to :value?
+    tlv.should respond_to :value?
   end
 
   it "should respond to to_r" do
-    subject.should respond_to :to_r
+    tlv.should respond_to :to_r
   end
 
   it "should respond to from_r" do
-    subject.should respond_to :from_r
+    tlv.should respond_to :from_r
   end
 
   context "A String TLV" do
     it "should return the correct TLV type" do
-      subject.type.should == Rex::Post::Meterpreter::TLV_TYPE_STRING
+      tlv.type.should == Rex::Post::Meterpreter::TLV_TYPE_STRING
     end
 
     it "should return the correct value" do
-      subject.value.should == "test"
+      tlv.value.should == "test"
     end
 
     context "#type?" do
       it "should return true for STRING" do
-        subject.type?(Rex::Post::Meterpreter::TLV_TYPE_STRING).should == true
+        tlv.type?(Rex::Post::Meterpreter::TLV_TYPE_STRING).should == true
       end
 
       it "should return false for UINT" do
-        subject.type?(Rex::Post::Meterpreter::TLV_TYPE_UINT).should == false
+        tlv.type?(Rex::Post::Meterpreter::TLV_TYPE_UINT).should == false
       end
     end
 
     context "#value?" do
       it "should return true for the correct value" do
-        subject.value?("test").should == true
+        tlv.value?("test").should == true
       end
 
       it "should return false for an incorrect value" do
-        subject.value?("fake").should == false
+        tlv.value?("fake").should == false
       end
     end
 
     context "#inspect" do
       it "should return a string representation of the TLV" do
         tlv_to_s = "#<Rex::Post::Meterpreter::Tlv type=STRING          meta=STRING     value=\"test\">"
-        subject.inspect.should == tlv_to_s
+        tlv.inspect.should == tlv_to_s
       end
     end
 
     context "#to_r" do
       it "should return the raw bytes of the TLV to send over the wire" do
         tlv_bytes = "\x00\x00\x00\r\x00\x01\x00\ntest\x00"
-        subject.to_r.should == tlv_bytes
+        tlv.to_r.should == tlv_bytes
       end
     end
 
     context "#from_r" do
       it "should adjust the tlv attributes from the given raw bytes" do
-        subject.from_r("\x00\x00\x00\r\x00\x01\x00\ntes2\x00")
-        subject.value.should == "tes2"
+        tlv.from_r("\x00\x00\x00\r\x00\x01\x00\ntes2\x00")
+        tlv.value.should == "tes2"
       end
     end
   end
 
   context "A Method TLV" do
-    subject{
+    subject(:tlv) {
       Rex::Post::Meterpreter::Tlv.new(
         Rex::Post::Meterpreter::TLV_TYPE_METHOD,
         "test"
       )
     }
     it "should have a meta type of String" do
-      subject.meta_type?(Rex::Post::Meterpreter::TLV_META_TYPE_STRING).should == true
+      tlv.meta_type?(Rex::Post::Meterpreter::TLV_META_TYPE_STRING).should == true
     end
 
     it "should show the correct type and meta type in inspect" do
       tlv_to_s = "#<Rex::Post::Meterpreter::Tlv type=METHOD          meta=STRING     value=\"test\">"
-      subject.inspect.should == tlv_to_s
+      tlv.inspect.should == tlv_to_s
     end
   end
 
   context "A String TLV with a number value" do
-    subject{Rex::Post::Meterpreter::Tlv.new(Rex::Post::Meterpreter::TLV_TYPE_STRING,5)}
+    subject(:tlv) {
+      Rex::Post::Meterpreter::Tlv.new(Rex::Post::Meterpreter::TLV_TYPE_STRING,5)
+    }
     it "should return the string version of the number" do
-      subject.value.should == "5"
+      tlv.value.should == "5"
     end
   end
 
 end
 
 describe Rex::Post::Meterpreter::GroupTlv do
-  subject{
+  subject(:group_tlv) {
     Rex::Post::Meterpreter::GroupTlv.new(
       Rex::Post::Meterpreter::TLV_TYPE_CHANNEL_DATA_GROUP
     )
   }
 
   it "should respond to tlvs" do
-    subject.should respond_to :tlvs
+    group_tlv.should respond_to :tlvs
   end
 
   it "should respond to each" do
-    subject.should respond_to :each
+    group_tlv.should respond_to :each
   end
 
   it "should respond to each_tlv" do
-    subject.should respond_to :each_tlv
+    group_tlv.should respond_to :each_tlv
   end
 
   it "should respond to each_with_index" do
-    subject.should respond_to :each_with_index
+    group_tlv.should respond_to :each_with_index
   end
 
   it "should respond to each_tlv_with_index" do
-    subject.should respond_to :each_tlv_with_index
+    group_tlv.should respond_to :each_tlv_with_index
   end
 
   it "should respond to get_tlvs" do
-    subject.should respond_to :get_tlvs
+    group_tlv.should respond_to :get_tlvs
   end
 
   it "should respond to add_tlv" do
-    subject.should respond_to :add_tlv
+    group_tlv.should respond_to :add_tlv
   end
 
   it "should respond to add_tlvs" do
-    subject.should respond_to :add_tlvs
+    group_tlv.should respond_to :add_tlvs
   end
 
   it "should respond to get_tlv" do
-    subject.should respond_to :get_tlv
+    group_tlv.should respond_to :get_tlv
   end
 
   it "should respond to get_tlv_value" do
-    subject.should respond_to :get_tlv_value
+    group_tlv.should respond_to :get_tlv_value
   end
 
   it "should respond to get_tlv_values" do
-    subject.should respond_to :get_tlv_values
+    group_tlv.should respond_to :get_tlv_values
   end
 
   it "should respond to has_tlv?" do
-    subject.should respond_to :has_tlv?
+    group_tlv.should respond_to :has_tlv?
   end
 
   it "should respond to reset" do
-    subject.should respond_to :reset
+    group_tlv.should respond_to :reset
   end
 
   it "should respond to to_r" do
-    subject.should respond_to :to_r
+    group_tlv.should respond_to :to_r
   end
 
   it "should respond to from_r" do
-    subject.should respond_to :from_r
+    group_tlv.should respond_to :from_r
   end
 
   it "should return an empty array for tlvs by default" do
-    subject.tlvs.should == []
+    group_tlv.tlvs.should == []
   end
 
   context "#add_tlv" do
     it "should add to the tlvs array when given basic tlv paramaters" do
-      subject.add_tlv(Rex::Post::Meterpreter::TLV_TYPE_STRING,"test")
-      subject.tlvs.first.type.should == Rex::Post::Meterpreter::TLV_TYPE_STRING
-      subject.tlvs.first.value.should == "test"
+      group_tlv.add_tlv(Rex::Post::Meterpreter::TLV_TYPE_STRING,"test")
+      group_tlv.tlvs.first.type.should == Rex::Post::Meterpreter::TLV_TYPE_STRING
+      group_tlv.tlvs.first.value.should == "test"
     end
 
     it  "should replace any existing TLV of the same type when the replace flag is set to true" do
-      subject.add_tlv(Rex::Post::Meterpreter::TLV_TYPE_STRING,"test")
-      subject.add_tlv(Rex::Post::Meterpreter::TLV_TYPE_STRING,"test2", true)
-      subject.tlvs.count.should == 1
-      subject.tlvs.first.value.should == "test2"
+      group_tlv.add_tlv(Rex::Post::Meterpreter::TLV_TYPE_STRING,"test")
+      group_tlv.add_tlv(Rex::Post::Meterpreter::TLV_TYPE_STRING,"test2", true)
+      group_tlv.tlvs.count.should == 1
+      group_tlv.tlvs.first.value.should == "test2"
     end
 
     it "should add both if replace is set to false" do
-      subject.add_tlv(Rex::Post::Meterpreter::TLV_TYPE_STRING,"test")
-      subject.add_tlv(Rex::Post::Meterpreter::TLV_TYPE_STRING,"test2", false)
-      subject.tlvs.first.value.should == "test"
-      subject.tlvs.last.value.should == "test2"
+      group_tlv.add_tlv(Rex::Post::Meterpreter::TLV_TYPE_STRING,"test")
+      group_tlv.add_tlv(Rex::Post::Meterpreter::TLV_TYPE_STRING,"test2", false)
+      group_tlv.tlvs.first.value.should == "test"
+      group_tlv.tlvs.last.value.should == "test2"
     end
   end
 
@@ -220,20 +222,20 @@ describe Rex::Post::Meterpreter::GroupTlv do
         {'type' => Rex::Post::Meterpreter::TLV_TYPE_STRING, 'value' => "test"},
         {'type' => Rex::Post::Meterpreter::TLV_TYPE_STRING, 'value' => "test2"}
       ]
-      subject.add_tlvs(tlv_array)
-      subject.tlvs.count.should == 2
-      subject.tlvs.first.value.should == "test"
-      subject.tlvs.last.value.should == "test2"
+      group_tlv.add_tlvs(tlv_array)
+      group_tlv.tlvs.count.should == 2
+      group_tlv.tlvs.first.value.should == "test"
+      group_tlv.tlvs.last.value.should == "test2"
     end
 
     it "should raise an error when given something other than nil or an array" do
       pending "RM #7598"
-      subject.add_tlvs("bad value").should raise_error
+      group_tlv.add_tlvs("bad value").should raise_error
     end
 
     it "should raise an error when given an array of objects other than hashes" do
       pending "RM #7598"
-      subject.add_tlvs([1,2,3]).should raise_error
+      group_tlv.add_tlvs([1,2,3]).should raise_error
     end
 
     it "should raise an error when any of the hashes are missing a key" do
@@ -242,119 +244,119 @@ describe Rex::Post::Meterpreter::GroupTlv do
         {:type => Rex::Post::Meterpreter::TLV_TYPE_STRING, :value => "test"},
         {:type => Rex::Post::Meterpreter::TLV_TYPE_STRING}
       ]
-      subject.add_tlvs(tlv_array).should raise_error
+      group_tlv.add_tlvs(tlv_array).should raise_error
     end
   end
 
   context "with TLVs added" do
     before(:each) do
-      subject.reset
+      group_tlv.reset
       tlv_array = [
         {'type' => Rex::Post::Meterpreter::TLV_TYPE_STRING, 'value' => "test"},
         {'type' => Rex::Post::Meterpreter::TLV_TYPE_STRING, 'value' => "test2"},
         {'type' => Rex::Post::Meterpreter::TLV_TYPE_UINT, 'value' => 5}
       ]
-      subject.add_tlvs(tlv_array)
+      group_tlv.add_tlvs(tlv_array)
       @raw_group =  "\x00\x00\x00/@\x00\x005\x00\x00\x00\r\x00\x01\x00\ntest\x00\x00\x00\x00\x0E\x00\x01\x00\ntest2\x00\x00\x00\x00\f\x00\x02\x00\v\x00\x00\x00\x05"
     end
 
     it "should empty the array of TLV when reset is called" do
-      subject.reset
-      subject.tlvs.should == []
+      group_tlv.reset
+      group_tlv.tlvs.should == []
     end
 
     it "should convert to raw bytes when to_r is called" do
-      subject.to_r.should == @raw_group
+      group_tlv.to_r.should == @raw_group
     end
 
 
     context "#from_r" do
       it "should build the TLV group when given the propper raw bytes" do
-        subject.reset 
-        subject.from_r( @raw_group)
-        subject.tlvs[0].inspect.should == "#<Rex::Post::Meterpreter::Tlv type=STRING          meta=STRING     value=\"test\">"
-        subject.tlvs[1].inspect.should == "#<Rex::Post::Meterpreter::Tlv type=STRING          meta=STRING     value=\"test2\">"
-        subject.tlvs[2].inspect.should == "#<Rex::Post::Meterpreter::Tlv type=UINT            meta=INT        value=5>"
+        group_tlv.reset
+        group_tlv.from_r( @raw_group)
+        group_tlv.tlvs[0].inspect.should == "#<Rex::Post::Meterpreter::Tlv type=STRING          meta=STRING     value=\"test\">"
+        group_tlv.tlvs[1].inspect.should == "#<Rex::Post::Meterpreter::Tlv type=STRING          meta=STRING     value=\"test2\">"
+        group_tlv.tlvs[2].inspect.should == "#<Rex::Post::Meterpreter::Tlv type=UINT            meta=INT        value=5>"
       end
     end
 
 
     context "#get_tlvs" do
       it "should return all TLVs of the supplied type" do
-        tlvs = subject.get_tlvs(Rex::Post::Meterpreter::TLV_TYPE_STRING)
+        tlvs = group_tlv.get_tlvs(Rex::Post::Meterpreter::TLV_TYPE_STRING)
         tlvs.count.should == 2
         tlvs.first.value.should == "test"
         tlvs.last.value.should == "test2"
       end
 
       it "should return all TLVs when supplied the ANY TLV type" do
-        tlvs = subject.get_tlvs(Rex::Post::Meterpreter::TLV_TYPE_ANY)
-        tlvs.count.should == subject.tlvs.count
+        tlvs = group_tlv.get_tlvs(Rex::Post::Meterpreter::TLV_TYPE_ANY)
+        tlvs.count.should == group_tlv.tlvs.count
       end
 
       it "should return an empty array for a TLV type that isn't present" do
-        subject.get_tlvs(Rex::Post::Meterpreter::TLV_TYPE_BOOL).should == []
+        group_tlv.get_tlvs(Rex::Post::Meterpreter::TLV_TYPE_BOOL).should == []
       end
 
       it "should return an empty array for a nonexistant TLV type" do
-        subject.get_tlvs(55555555).should == []
+        group_tlv.get_tlvs(55555555).should == []
       end
     end
 
     context "#get_tlv" do
       it "should return the first TLV of the specified type by default" do
-        subject.get_tlv(Rex::Post::Meterpreter::TLV_TYPE_STRING).should == subject.tlvs.first
-        subject.get_tlv(Rex::Post::Meterpreter::TLV_TYPE_UINT).should == subject.tlvs.last
+        group_tlv.get_tlv(Rex::Post::Meterpreter::TLV_TYPE_STRING).should == group_tlv.tlvs.first
+        group_tlv.get_tlv(Rex::Post::Meterpreter::TLV_TYPE_UINT).should == group_tlv.tlvs.last
       end
 
       it "should return the correct TLV of the specified type for the given index" do
-        subject.get_tlv(Rex::Post::Meterpreter::TLV_TYPE_STRING,1).should == subject.tlvs[1]
+        group_tlv.get_tlv(Rex::Post::Meterpreter::TLV_TYPE_STRING,1).should == group_tlv.tlvs[1]
       end
 
       it "should return nil if given an out of bounds index" do
-        subject.get_tlv(Rex::Post::Meterpreter::TLV_TYPE_STRING,5).should == nil
+        group_tlv.get_tlv(Rex::Post::Meterpreter::TLV_TYPE_STRING,5).should == nil
       end
 
       it "should return nil if given a non-present TLV type" do
-        subject.get_tlv(Rex::Post::Meterpreter::TLV_TYPE_BOOL).should == nil
+        group_tlv.get_tlv(Rex::Post::Meterpreter::TLV_TYPE_BOOL).should == nil
       end
     end
 
     context "#get_tlv_value" do
       it "should return the value of the first TLV with the given type" do
-        subject.get_tlv_value(Rex::Post::Meterpreter::TLV_TYPE_STRING).should == subject.tlvs.first.value
+        group_tlv.get_tlv_value(Rex::Post::Meterpreter::TLV_TYPE_STRING).should == group_tlv.tlvs.first.value
       end
 
       it "should return the correct TLV value of the specified type for the given index" do
-        subject.get_tlv_value(Rex::Post::Meterpreter::TLV_TYPE_STRING,1).should == subject.tlvs[1].value
+        group_tlv.get_tlv_value(Rex::Post::Meterpreter::TLV_TYPE_STRING,1).should == group_tlv.tlvs[1].value
       end
 
       it "should return nil if given an out of bounds index" do
-        subject.get_tlv_value(Rex::Post::Meterpreter::TLV_TYPE_STRING,5).should == nil
+        group_tlv.get_tlv_value(Rex::Post::Meterpreter::TLV_TYPE_STRING,5).should == nil
       end
 
       it "should return nil if given a non-present TLV type" do
-        subject.get_tlv_value(Rex::Post::Meterpreter::TLV_TYPE_BOOL).should == nil
+        group_tlv.get_tlv_value(Rex::Post::Meterpreter::TLV_TYPE_BOOL).should == nil
       end
     end
 
     context "#get_tlv_values" do
       it "should return an array of values for the designated TLV types" do
-        subject.get_tlv_values(Rex::Post::Meterpreter::TLV_TYPE_STRING).should == ["test", "test2"]
+        group_tlv.get_tlv_values(Rex::Post::Meterpreter::TLV_TYPE_STRING).should == ["test", "test2"]
       end
 
       it "should return an empty array for a non-present TLV type" do
-        subject.get_tlv_values(Rex::Post::Meterpreter::TLV_TYPE_BOOL).should == []
+        group_tlv.get_tlv_values(Rex::Post::Meterpreter::TLV_TYPE_BOOL).should == []
       end
     end
 
     context "#has_tlv?" do
       it "should return true if the TLV Type is present" do
-        subject.has_tlv?(Rex::Post::Meterpreter::TLV_TYPE_STRING).should == true
+        group_tlv.has_tlv?(Rex::Post::Meterpreter::TLV_TYPE_STRING).should == true
       end
 
       it "should return false if the TLV type is not present" do
-        subject.has_tlv?(Rex::Post::Meterpreter::TLV_TYPE_BOOL).should == false
+        group_tlv.has_tlv?(Rex::Post::Meterpreter::TLV_TYPE_BOOL).should == false
       end
     end
   end
@@ -362,69 +364,69 @@ end
 
 describe Rex::Post::Meterpreter::Packet do
   context "Request Packet" do
-    subject{
+    subject(:packet) {
       Rex::Post::Meterpreter::Packet.new(
-        Rex::Post::Meterpreter::PACKET_TYPE_REQUEST, 
+        Rex::Post::Meterpreter::PACKET_TYPE_REQUEST,
         "test_method"
       )
     }
 
     it "should respond to created_at" do
-      subject.should respond_to :created_at
+      packet.should respond_to :created_at
     end
 
     it "should respond to response?" do
-      subject.should respond_to :response?
+      packet.should respond_to :response?
     end
 
     it "should respond to method?" do
-      subject.should respond_to :method?
+      packet.should respond_to :method?
     end
 
     it "should respond to method" do
-      subject.should respond_to :method
+      packet.should respond_to :method
     end
 
     it "should respond to result?" do
-      subject.should respond_to :result?
+      packet.should respond_to :result?
     end
 
     it "should respond to result=" do
-      subject.should respond_to :result=
+      packet.should respond_to :result=
     end
 
     it "should respond to result" do
-      subject.should respond_to :result
+      packet.should respond_to :result
     end
 
     it "should respond to rid" do
-      subject.should respond_to :rid
+      packet.should respond_to :rid
     end
 
     it "should return false for response?" do
-      subject.response?.should == false
+      packet.response?.should == false
     end
 
     it "should evaluate the method correctly" do
-      subject.method?("test_method").should == true
-      subject.method?("blah").should == false
+      packet.method?("test_method").should == true
+      packet.method?("blah").should == false
     end
 
     it "should accept new methods" do
-      subject.method= "test_method2"
-      subject.method?("test_method2").should == true
+      packet.method= "test_method2"
+      packet.method?("test_method2").should == true
     end
 
     it "should return the correct method" do
-      subject.method.should == "test_method"
+      packet.method.should == "test_method"
     end
 
     it "should not have a result" do
-      subject.result.should == nil
+      packet.result.should == nil
     end
 
     it "should return a valid request id" do
-      subject.rid.should =~ /\A\d{32}\Z/
+      packet.rid.should =~ /\A\d{32}\Z/
     end
 
     it "should be created when Packet.create_request is called" do
@@ -435,38 +437,38 @@ describe Rex::Post::Meterpreter::Packet do
     end
 
     it "should return the correct raw byte form of the packet" do
-      rid = subject.rid
-      meth = subject.method
-      raw = subject.to_r
-      subject.from_r(raw)
-      subject.rid.should == rid
-      subject.method.should == meth
+      rid = packet.rid
+      meth = packet.method
+      raw = packet.to_r
+      packet.from_r(raw)
+      packet.rid.should == rid
+      packet.method.should == meth
     end
   end
 
   context "a response packet" do
-    subject{
+    subject(:packet) {
       Rex::Post::Meterpreter::Packet.new(
-        Rex::Post::Meterpreter::PACKET_TYPE_RESPONSE, 
+        Rex::Post::Meterpreter::PACKET_TYPE_RESPONSE,
         "test_method"
       )
     }
-    before(:all) do
-      subject.add_tlv(Rex::Post::Meterpreter::TLV_TYPE_RESULT, "a-ok")
+    before(:each) do
+      packet.add_tlv(Rex::Post::Meterpreter::TLV_TYPE_RESULT, "a-ok")
     end
 
     it "should return the correct result" do
-      subject.result.should == "a-ok"
+      packet.result.should == "a-ok"
     end
 
     it "should evaluate result correctly" do
-      subject.result?("a-ok").should == true
-      subject.result?("5by5").should == false
+      packet.result?("a-ok").should == true
+      packet.result?("5by5").should == false
     end
 
     it "should accept a new result" do
-      subject.result= "test2"
-      subject.result.should == "test2"
+      packet.result = "test2"
+      packet.result.should == "test2"
     end
 
     it "should be created when Packet.create_response is called" do