Added some documentation and cleaned up unecessary TODOs. Added first round of specs for the new classes.

1 files changed, 217 insertions, 0 deletions

diff --git a/spec/unit/resource_collection/resource_set_spec.rb b/spec/unit/resource_collection/resource_set_spec.rb
new file mode 100644
index 0000000000..8a9c8aa80a
--- /dev/null
+++ b/spec/unit/resource_collection/resource_set_spec.rb
@@ -0,0 +1,217 @@
+#
+# Author:: Tyler Ball (<tball@getchef.com>)
+# Copyright:: Copyright (c) 2014 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+class Chef
+  class ResourceCollection
+    describe ResourceSet do
+      let(:subject) { ResourceSet.new }
+
+      let(:zen_master_name) { "Neo" }
+      let(:zen_master2_name) { "Morpheus" }
+      let(:zen_follower_name) { "Squid" }
+      let(:zen_master) {
+        r = Chef::Resource::ZenMaster.new(zen_master_name)
+        r
+      }
+      let(:zen_master2) {
+        r = Chef::Resource::ZenMaster.new(zen_master2_name)
+        r
+      }
+      let(:zen_follower) {
+        r = Chef::Resource::ZenFollower.new(zen_follower_name)
+        r
+      }
+
+      describe "initialize" do
+        it "should return a Chef::ResourceCollection" do
+          expect(subject).to be_instance_of(ResourceSet)
+        end
+      end
+
+      describe "keys" do
+        it "should return an empty list for an empty ResourceSet" do
+          expect(subject.keys).to eq([])
+        end
+
+        it "should return the keys for a non-empty ResourceSet" do
+          subject.insert_as(zen_master)
+          expect(subject.keys).to eq(["zen_master[Neo]"])
+        end
+
+        it "should return the keys for a non-empty ResourceSet with custom type and name" do
+          subject.insert_as(zen_master, "OtherResource", "other_resource")
+          expect(subject.keys).to eq(["OtherResource[other_resource]"])
+        end
+      end
+
+      describe "insert_as, lookup and find" do
+        # To validate insert_as you need lookup, and vice-versa - putting all tests in 1 context to avoid duplication
+        it "should accept only Chef::Resources" do
+          expect { subject.insert_as(zen_master) }.to_not raise_error
+          expect { subject.insert_as("string") }.to raise_error
+        end
+
+        it "should allow you to lookup resources by a default .to_s" do
+          subject.insert_as(zen_master)
+          expect(subject.lookup(zen_master.to_s)).to equal(zen_master)
+        end
+
+        it "should use a custom type and name to insert" do
+          subject.insert_as(zen_master, "OtherResource", "other_resource")
+          expect(subject.lookup("OtherResource[other_resource]")).to equal(zen_master)
+        end
+
+        it "should raise an exception if you send something strange to lookup" do
+          expect { subject.lookup(:symbol) }.to raise_error(ArgumentError)
+        end
+
+        it "should raise an exception if it cannot find a resource with lookup" do
+          expect { subject.lookup(zen_master.to_s) }.to raise_error(Chef::Exceptions::ResourceNotFound)
+        end
+
+        it "should find a resource by type symbol and name" do
+          subject.insert_as(zen_master)
+          expect(subject.find(:zen_master => zen_master_name)).to equal(zen_master)
+        end
+
+        it "should find a resource by type symbol and array of names" do
+          subject.insert_as(zen_master)
+          subject.insert_as(zen_master2)
+          check_by_names(subject.find(:zen_master => [zen_master_name,zen_master2_name]), zen_master_name, zen_master2_name)
+        end
+
+        it "should find a resource by type symbol and array of names with custom names" do
+          subject.insert_as(zen_master, :zzz, "name1")
+          subject.insert_as(zen_master2, :zzz, "name2")
+          check_by_names(subject.find( :zzz => ["name1","name2"]), zen_master_name, zen_master2_name)
+        end
+
+        it "should find resources of multiple kinds (:zen_master => a, :zen_follower => b)" do
+          subject.insert_as(zen_master)
+          subject.insert_as(zen_follower)
+          check_by_names(subject.find(:zen_master => [zen_master_name], :zen_follower => [zen_follower_name]),
+                         zen_master_name, zen_follower_name)
+        end
+
+        it "should find resources of multiple kinds (:zen_master => a, :zen_follower => b with custom names)" do
+          subject.insert_as(zen_master, :zzz, "name1")
+          subject.insert_as(zen_master2, :zzz, "name2")
+          subject.insert_as(zen_follower, :yyy, "name3")
+          check_by_names(subject.find(:zzz => ["name1","name2"], :yyy => ["name3"]),
+                         zen_master_name, zen_follower_name, zen_master2_name)
+        end
+
+        it "should find a resource by string zen_master[a]" do
+          subject.insert_as(zen_master)
+          expect(subject.find("zen_master[#{zen_master_name}]")).to eq(zen_master)
+        end
+
+        it "should find a resource by string zen_master[a] with custom names" do
+          subject.insert_as(zen_master, :zzz, "name1")
+          expect(subject.find("zzz[name1]")).to eq(zen_master)
+        end
+
+        it "should find resources by strings of zen_master[a,b]" do
+          subject.insert_as(zen_master)
+          subject.insert_as(zen_master2)
+          check_by_names(subject.find("zen_master[#{zen_master_name},#{zen_master2_name}]"),
+                         zen_master_name, zen_master2_name)
+        end
+
+        it "should find resources by strings of zen_master[a,b] with custom names" do
+          subject.insert_as(zen_master, :zzz, "name1")
+          subject.insert_as(zen_master2, :zzz, "name2")
+          check_by_names(subject.find("zzz[name1,name2]"),
+                         zen_master_name, zen_master2_name)
+        end
+
+        it "should find resources of multiple types by strings of zen_master[a]" do
+          subject.insert_as(zen_master)
+          subject.insert_as(zen_follower)
+          check_by_names(subject.find("zen_master[#{zen_master_name}]", "zen_follower[#{zen_follower_name}]"),
+                         zen_master_name, zen_follower_name)
+        end
+
+        it "should find resources of multiple types by strings of zen_master[a] with custom names" do
+          subject.insert_as(zen_master, :zzz, "name1")
+          subject.insert_as(zen_master2, :zzz, "name2")
+          subject.insert_as(zen_follower, :yyy, "name3")
+          check_by_names(subject.find("zzz[name1,name2]", "yyy[name3]"),
+                         zen_master_name, zen_follower_name,zen_master2_name)
+        end
+
+        it "should only keep the last copy when multiple instances of a Resource are inserted" do
+          subject.insert_as(zen_master)
+          expect(subject.find("zen_master[#{zen_master_name}]")).to eq(zen_master)
+          new_zm =zen_master.dup
+          new_zm.retries = 10
+          expect(new_zm).to_not eq(zen_master)
+          subject.insert_as(new_zm)
+          expect(subject.find("zen_master[#{zen_master_name}]")).to eq(new_zm)
+        end
+
+        it "should raise an exception if you pass a bad name to resources" do
+          expect { subject.find("michael jackson") }.to raise_error(ArgumentError)
+        end
+
+        it "should raise an exception if you pass something other than a string or hash to resource" do
+          expect { subject.find([Array.new]) }.to raise_error(ArgumentError)
+        end
+
+        it "raises an error when attempting to find a resource that does not exist" do
+          expect { subject.find("script[nonesuch]") }.to raise_error(Chef::Exceptions::ResourceNotFound)
+        end
+      end
+
+      describe "validate_lookup_spec!" do
+        it "accepts a string of the form 'resource_type[resource_name]'" do
+          expect(subject.validate_lookup_spec!("resource_type[resource_name]")).to be_true
+        end
+
+        it "accepts a single-element :resource_type => 'resource_name' Hash" do
+          expect(subject.validate_lookup_spec!(:service => "apache2")).to be_true
+        end
+
+        it "accepts a chef resource object" do
+          expect(subject.validate_lookup_spec!(zen_master)).to be_true
+        end
+
+        it "rejects a malformed query string" do
+          expect { subject.validate_lookup_spec!("resource_type[missing-end-bracket") }.to \
+            raise_error(Chef::Exceptions::InvalidResourceSpecification)
+        end
+
+        it "rejects an argument that is not a String, Hash, or Chef::Resource" do
+          expect { subject.validate_lookup_spec!(Object.new) }.to \
+            raise_error(Chef::Exceptions::InvalidResourceSpecification)
+        end
+
+      end
+
+      def check_by_names(results, *names)
+        expect(results.size).to eq(names.size)
+        names.each do |name|
+          expect(results.detect{|r| r.name == name}).to_not eq(nil)
+        end
+      end
+
+    end
+  end
+end