Fixing broken tests and updating all tests to (attempt) to use describe/context blocks for readability

1 files changed, 95 insertions, 118 deletions

diff --git a/spec/unit/knife/data_bag_from_file_spec.rb b/spec/unit/knife/data_bag_from_file_spec.rb
index 1ad6b4712c..150ad42148 100644
--- a/spec/unit/knife/data_bag_from_file_spec.rb
+++ b/spec/unit/knife/data_bag_from_file_spec.rb
@@ -26,79 +26,95 @@ Chef::Knife::DataBagFromFile.load_deps
 
 describe Chef::Knife::DataBagFromFile do
   before :each do
-    Chef::Config[:node_name]  = "webmonkey.example.com"
-    @knife = Chef::Knife::DataBagFromFile.new
-    @rest = double("Chef::REST")
-    @knife.stub(:rest).and_return(@rest)
-    @stdout = StringIO.new
-    @knife.ui.stub(:stdout).and_return(@stdout)
-    @tmp_dir = Dir.mktmpdir
-    @db_folder = File.join(@tmp_dir, 'data_bags', 'bag_name')
-    FileUtils.mkdir_p(@db_folder)
-    @db_file = Tempfile.new(["data_bag_from_file_test", ".json"], @db_folder)
-    @db_file2 = Tempfile.new(["data_bag_from_file_test2", ".json"], @db_folder)
-    @db_folder2 = File.join(@tmp_dir, 'data_bags', 'bag_name2')
-    FileUtils.mkdir_p(@db_folder2)
-    @db_file3 = Tempfile.new(["data_bag_from_file_test3", ".json"], @db_folder2)
-    @plain_data = {
-        "id" => "item_name",
-        "greeting" => "hello",
-        "nested" => { "a1" => [1, 2, 3], "a2" => { "b1" => true }}
-    }
-    @db_file.write(@plain_data.to_json)
-    @db_file.flush
-    @knife.instance_variable_set(:@name_args, ['bag_name', @db_file.path])
+    Chef::Config[:node_name] = "webmonkey.example.com"
+    FileUtils.mkdir_p([db_folder, db_folder2])
+    db_file.write(plain_data.to_json)
+    db_file.flush
+    knife.name_args = [bag_name, db_file.path]
+    allow(knife).to receive(:config).and_return(config)
   end
 
   # We have to explicitly clean up Tempfile on Windows because it said so.
   after :each do
-    @db_file.close
-    @db_file2.close
-    @db_file3.close
-    FileUtils.rm_rf(@db_folder)
-    FileUtils.rm_rf(@db_folder2)
-    FileUtils.remove_entry_secure @tmp_dir
+    db_file.close
+    db_file2.close
+    db_file3.close
+    FileUtils.rm_rf(db_folder)
+    FileUtils.rm_rf(db_folder2)
+    FileUtils.remove_entry_secure tmp_dir
   end
 
+  let(:knife) do
+    k = Chef::Knife::DataBagFromFile.new
+    allow(k).to receive(:rest).and_return(rest)
+    allow(k.ui).to receive(:stdout).and_return(stdout)
+    k
+  end
+
+  let(:tmp_dir) { Dir.mktmpdir }
+  let(:db_folder) { File.join(tmp_dir, data_bags_path, bag_name) }
+  let(:db_file) { Tempfile.new(["data_bag_from_file_test", ".json"], db_folder) }
+  let(:db_file2) { Tempfile.new(["data_bag_from_file_test2", ".json"], db_folder) }
+  let(:db_folder2) { File.join(tmp_dir, data_bags_path, bag_name2) }
+  let(:db_file3) { Tempfile.new(["data_bag_from_file_test3", ".json"], db_folder2) }
+
+  def plain_bag(b = bag_name)
+    data_bag = double("Chef::DataBagItem")
+    expect(data_bag).to receive(:data_bag).with(b)
+    expect(data_bag).to receive(:raw_data=).with(plain_data)
+    expect(data_bag).to receive(:save)
+    expect(data_bag).to receive(:data_bag)
+    expect(data_bag).to receive(:id)
+    data_bag
+  end
+  let(:data_bags_path) { "data_bags" }
+  let(:plain_data) { {
+      "id" => "item_name",
+      "greeting" => "hello",
+      "nested" => { "a1" => [1, 2, 3], "a2" => { "b1" => true }}
+  } }
+
+  let(:rest) { double("Chef::REST") }
+  let(:stdout) { StringIO.new }
+
+  let(:bag_name) { "sudoing_admins" }
+  let(:bag_name2) { "sudoing_admins2" }
+  let(:item_name) { "ME" }
+
+  let(:secret) { "abc123SECRET" }
+
+  let(:config) { {} }
+
   it "loads from a file and saves" do
-    @knife.loader.should_receive(:load_from).with("data_bags", 'bag_name', @db_file.path).and_return(@plain_data)
-    dbag = Chef::DataBagItem.new
-    Chef::DataBagItem.stub(:new).and_return(dbag)
-    dbag.should_receive(:save)
-    @knife.run
-
-    dbag.data_bag.should == 'bag_name'
-    dbag.raw_data.should == @plain_data
+    expect(knife.loader).to receive(:load_from).with(data_bags_path, bag_name, db_file.path).and_return(plain_data)
+    expect(Chef::DataBagItem).to receive(:new).and_return(plain_bag)
+
+    knife.run
   end
 
-  it "loads all from a mutiple files and saves" do
-    @knife.name_args = [ 'bag_name', @db_file.path, @db_file2.path ]
-    @knife.loader.should_receive(:load_from).with("data_bags", 'bag_name', @db_file.path).and_return(@plain_data)
-    @knife.loader.should_receive(:load_from).with("data_bags", 'bag_name', @db_file2.path).and_return(@plain_data)
-    dbag = Chef::DataBagItem.new
-    Chef::DataBagItem.stub(:new).and_return(dbag)
-    dbag.should_receive(:save).twice
-    @knife.run
-
-    dbag.data_bag.should == 'bag_name'
-    dbag.raw_data.should == @plain_data
+  it "loads all from multiple files and saves" do
+    knife.name_args = [ bag_name, db_file.path, db_file2.path ]
+    expect(knife.loader).to receive(:load_from).with(data_bags_path, bag_name, db_file.path).and_return(plain_data)
+    expect(knife.loader).to receive(:load_from).with(data_bags_path, bag_name, db_file2.path).and_return(plain_data)
+    expect(Chef::DataBagItem).to receive(:new).twice.and_return(plain_bag, plain_bag)
+
+    knife.run
   end
 
   it "loads all from a folder and saves" do
-    @knife.name_args = [ 'bag_name', @db_folder ]
-    @knife.loader.should_receive(:load_from).with("data_bags", 'bag_name', @db_file.path).and_return(@plain_data)
-    @knife.loader.should_receive(:load_from).with("data_bags", 'bag_name', @db_file2.path).and_return(@plain_data)
-    dbag = Chef::DataBagItem.new
-    Chef::DataBagItem.stub(:new).and_return(dbag)
-    dbag.should_receive(:save).twice
-    @knife.run
+    knife.name_args = [ bag_name, db_folder ]
+    expect(knife.loader).to receive(:load_from).with(data_bags_path, bag_name, db_file.path).and_return(plain_data)
+    expect(knife.loader).to receive(:load_from).with(data_bags_path, bag_name, db_file2.path).and_return(plain_data)
+    expect(Chef::DataBagItem).to receive(:new).twice.and_return(plain_bag, plain_bag)
+
+    knife.run
   end
 
   describe "loading all data bags" do
 
     before do
       @pwd = Dir.pwd
-      Dir.chdir(@tmp_dir)
+      Dir.chdir(tmp_dir)
     end
 
     after do
@@ -106,88 +122,49 @@ describe Chef::Knife::DataBagFromFile do
     end
 
     it "loads all data bags when -a or --all options is provided" do
-      @knife.name_args = []
-      @knife.stub(:config).and_return({:all => true})
-      @knife.loader.should_receive(:load_from).with("data_bags", "bag_name", File.basename(@db_file.path)).
-        and_return(@plain_data)
-      @knife.loader.should_receive(:load_from).with("data_bags", "bag_name", File.basename(@db_file2.path)).
-        and_return(@plain_data)
-      @knife.loader.should_receive(:load_from).with("data_bags", "bag_name2", File.basename(@db_file3.path)).
-        and_return(@plain_data)
-      dbag = Chef::DataBagItem.new
-      Chef::DataBagItem.stub(:new).and_return(dbag)
-      dbag.should_receive(:save).exactly(3).times
-      @knife.run
+      knife.name_args = []
+      config[:all] = true
+      expect(knife.loader).to receive(:load_from).with(data_bags_path, bag_name, File.basename(db_file.path)).and_return(plain_data)
+      expect(knife.loader).to receive(:load_from).with(data_bags_path, bag_name, File.basename(db_file2.path)).and_return(plain_data)
+      expect(knife.loader).to receive(:load_from).with(data_bags_path, bag_name2, File.basename(db_file3.path)).and_return(plain_data)
+      expect(Chef::DataBagItem).to receive(:new).exactly(3).times.and_return(plain_bag, plain_bag, plain_bag(bag_name2))
+
+      knife.run
     end
 
     it "loads all data bags items when -a or --all options is provided" do
-      @knife.name_args = ["bag_name2"]
-      @knife.stub(:config).and_return({:all => true})
-      @knife.loader.should_receive(:load_from).with("data_bags", "bag_name2", File.basename(@db_file3.path)).
-        and_return(@plain_data)
-      dbag = Chef::DataBagItem.new
-      Chef::DataBagItem.stub(:new).and_return(dbag)
-      dbag.should_receive(:save)
-      @knife.run
-      dbag.data_bag.should == 'bag_name2'
-      dbag.raw_data.should == @plain_data
+      knife.name_args = [bag_name2]
+      config[:all] = true
+      expect(knife.loader).to receive(:load_from).with(data_bags_path, bag_name2, File.basename(db_file3.path)).and_return(plain_data)
+      expect(Chef::DataBagItem).to receive(:new).and_return(plain_bag(bag_name2))
+
+      knife.run
     end
 
   end
 
   describe "encrypted data bag items" do
     before(:each) do
-      @secret = "abc123SECRET"
-      @enc_data = Chef::EncryptedDataBagItem.encrypt_data_bag_item(@plain_data,
-                                                                   @secret)
-
-      # Random IV is used each time the data bag item is encrypted, so values
-      # will not be equal if we re-encrypt.
-      Chef::EncryptedDataBagItem.should_receive(:encrypt_data_bag_item).and_return(@enc_data)
-
-      @secret_file = Tempfile.new("encrypted_data_bag_secret_file_test")
-      @secret_file.puts(@secret)
-      @secret_file.flush
-    end
-
-    after do
-      @secret_file.close
-      @secret_file.unlink
+      expect(knife).to receive(:encryption_secret_provided?).and_return(true)
+      expect(knife).to receive(:read_secret).and_return(secret)
+      # TODO this should return encrypted data
+      expect(Chef::EncryptedDataBagItem).to receive(:encrypt_data_bag_item).with(plain_data, secret).and_return(plain_data)
     end
 
     it "encrypts values when given --secret" do
-      @knife.stub(:config).and_return({:secret => @secret})
-
-      @knife.loader.should_receive(:load_from).with("data_bags", "bag_name", @db_file.path).and_return(@plain_data)
-      dbag = Chef::DataBagItem.new
-      Chef::DataBagItem.stub(:new).and_return(dbag)
-      dbag.should_receive(:save)
-      @knife.run
-      dbag.data_bag.should == 'bag_name'
-      dbag.raw_data.should == @enc_data
-    end
-
-    it "encrypts values when given --secret_file" do
-      @knife.stub(:config).and_return({:secret_file => @secret_file.path})
+      expect(knife.loader).to receive(:load_from).with(data_bags_path, bag_name, db_file.path).and_return(plain_data)
+      expect(Chef::DataBagItem).to receive(:new).and_return(plain_bag)
 
-      @knife.loader.stub(:load_from).with("data_bags", 'bag_name', @db_file.path).and_return(@plain_data)
-      dbag = Chef::DataBagItem.new
-      Chef::DataBagItem.stub(:new).and_return(dbag)
-      dbag.should_receive(:save)
-      @knife.run
-      dbag.data_bag.should == 'bag_name'
-      dbag.raw_data.should == @enc_data
+      knife.run
     end
 
   end
 
   describe "command line parsing" do
     it "prints help if given no arguments" do
-      @knife.instance_variable_set(:@name_args, [])
-      lambda { @knife.run }.should raise_error(SystemExit)
-      help_text = "knife data bag from file BAG FILE|FOLDER [FILE|FOLDER..] (options)"
-      help_text_regex = Regexp.new("^#{Regexp.escape(help_text)}")
-      @stdout.string.should match(help_text_regex)
+      knife.name_args = [bag_name]
+      expect {knife.run}.to exit_with_code(1)
+      expect(stdout.string).to start_with("knife data bag from file BAG FILE|FOLDER [FILE|FOLDER..] (options)")
     end
   end