cobbler 2.0.0

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'pathname'
+dir = Pathname.new(__FILE__).parent
+$LOAD_PATH.unshift(File.join(dir,'lib'))
+require 'cobbler'
+gem 'rspec', '~> 2.5.0'
+require 'mocha'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end
+
+def with_real_cobbler(calzz,&blk)
+    unless ENV['NO_REAL_COBBLER'] == '1'
+        config = (ENV['COBBLER_YML'] || File.expand_path(File.join(File.dirname(__FILE__),'..','config','cobbler.yml')))
+        if File.exist?(config) && (yml = YAML::load(File.open(config))) && (yml['hostname'] && yml['username'] && yml['password'])
+            yield(yml)
+        else
+            puts "No cobbler data found."
+        end
+    end
+end

data/spec/unit/cobbler/base_spec.rb

@@ -0,0 +1,194 @@
+#! /usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+class BaseTest < Cobbler::Base
+    cobbler_field :name
+    cobbler_field :locked_field, :locked => true
+    cobbler_field :saveable_field
+end
+
+class Unremovable < Cobbler::Base
+    cobbler_lifecycle :remove => false
+end
+
+class Unsaveable1 < Cobbler::Base
+    cobbler_lifecycle :handle => false
+end
+
+class Unsaveable2 < Cobbler::Base
+    cobbler_lifecycle :modify => false
+end
+
+class Unsaveable3 < Cobbler::Base
+    cobbler_lifecycle :new => false, :save => false
+end
+
+class CollTest1 < Cobbler::Base
+    cobbler_field :name
+    cobbler_collection :coll1
+end
+class CollTest2 < Cobbler::Base
+    cobbler_field :name
+    cobbler_collection :coll2, :store => :store_coll2
+    
+    def store_coll2
+        coll2.to_a.each do |item|
+            #do something
+        end
+    end
+end
+
+describe Cobbler::Base do
+    
+    [:remove, :save ].each do |method|
+        it "should provide a method to #{method} the item" do
+            test = BaseTest.new
+            test.should respond_to(method)
+        end
+    end
+    
+    describe "when initializing" do
+        it "should add the fields to the user fields" do
+            test = BaseTest.new({'name' => 1, 'b' => 2})
+            test.definitions.keys.should be_empty
+            test.user_definitions.keys.should_not be_empty
+            test.user_definitions.keys.should include('name')
+            test.user_definitions.keys.should include('b')
+            test.name.should == 1
+        end
+        
+        it "should add the fields to the old definitions if it's an old record" do
+            test = BaseTest.new({:a => 1, :b => 2},false)
+            test.definitions.keys.should_not be_empty
+            test.definitions.keys.should include(:a)
+            test.definitions.keys.should include(:b)
+            test.user_definitions.keys.should be_empty
+        end
+    end
+    
+    describe "when removing an item" do
+        it "should raise an exception if we have no api_method to remove the item" do
+            lambda { Unremovable.new.remove }.should raise_error(Exception)
+        end
+        
+        it "should call the remove api_method for the item" do
+            test = BaseTest.new({'name' => 'foo'})
+            test.name.should == 'foo'
+            connection = Object.new
+            BaseTest.expects(:login).returns('muh')
+            BaseTest.expects(:logout)
+            BaseTest.expects(:connect).returns(connection)
+            BaseTest.expects(:make_call).with(test.api_methods[:remove],test.name,'muh')
+            test.remove
+        end
+    end
+
+    describe "when trying to save an item" do
+        it "should raise an exception if we have no api_method to save and/or update the item" do
+            [Unsaveable1,Unsaveable2,Unsaveable3].each do |klass|
+                lambda { klass.new.save }.should raise_error(Exception)
+            end
+        end
+    end
+    describe "when saving an existing item" do
+        before(:each) do
+            @test1 = BaseTest.new({'name' => 'foo','locked_field' => '1', 'saveable_field' => 2},false)
+            BaseTest.expects(:connect).returns(Object.new)
+            BaseTest.expects(:login).returns('muh')
+            BaseTest.expects(:logout)
+            BaseTest.expects(:find_one).with('foo').returns('entry')
+            BaseTest.expects(:make_call).with('get_base_test_handle','foo','muh').returns('id')
+            BaseTest.expects(:make_call).with('save_base_test','id','muh')
+        end
+        it "should store no fields on a unchanged record" do
+            [:name,:locked_field,:saveable_field].each do |field|
+                BaseTest.expects(:make_call).with('modify_base_test','id',"#{field}",@test1.send(field),'muh').never
+            end
+            @test1.save
+        end
+        
+        it "should only store changed fields" do
+            @test1.saveable_field = 3
+            [:name,:locked_field].each do |field|
+                BaseTest.expects(:make_call).with('modify_base_test','id',"#{field}",@test1.send(field),'muh').never
+            end
+            BaseTest.expects(:make_call).with('modify_base_test','id',"saveable_field",3,'muh')
+            @test1.save
+        end
+        
+        it "should store no locked fields" do
+            @test1.locked_field = 'foobar'
+            [:name,:locked_field,:saveable_field].each do |field|
+                BaseTest.expects(:make_call).with('modify_base_test','id',"#{field}",@test1.send(field),'muh').never
+            end
+            @test1.save            
+        end
+    end
+    
+    describe "when saving a not yet existing item" do
+        before(:each) do
+            @test1 = BaseTest.new({'name' => 'foo','locked_field' => '1', 'saveable_field' => 2},false)
+            BaseTest.expects(:connect).returns(Object.new)
+            BaseTest.expects(:find_one).with('foo').returns(nil)
+            BaseTest.expects(:login).returns('muh')
+            BaseTest.expects(:logout)
+            BaseTest.expects(:make_call).with('new_base_test','muh').returns('id')
+            BaseTest.expects(:make_call).with('modify_base_test','id',"name",@test1.name,'muh')
+            BaseTest.expects(:make_call).with('save_base_test','id','muh')
+        end
+        it "should store no fields on a unchanged record" do
+            [:name,:locked_field,:saveable_field].each do |field|
+                BaseTest.expects(:make_call).with('modify_base_test','id',"#{field}",@test1.send(field),'muh').never
+            end
+            @test1.save
+        end
+        
+        it "should only store changed fields" do
+            @test1.saveable_field = 3
+            [:name,:locked_field].each do |field|
+                BaseTest.expects(:make_call).with('modify_base_test','id',"#{field}",@test1.send(field),'muh').never
+            end
+            BaseTest.expects(:make_call).with('modify_base_test','id',"saveable_field",3,'muh')
+            @test1.save
+        end
+        
+        it "should store no locked fields" do
+            @test1.locked_field = 'foobar'
+            [:name,:locked_field,:saveable_field].each do |field|
+                BaseTest.expects(:make_call).with('modify_base_test','id',"#{field}",@test1.send(field),'muh').never
+            end
+            @test1.save            
+        end        
+    end
+    
+    describe "when saving an item with collections" do
+        it "should store a normal collection as a normal field" do
+            @test1 = CollTest1.new({'name' => 'foo'},false)
+            @test1.coll1 = [1,2]
+            CollTest1.expects(:connect).returns(Object.new)
+            CollTest1.expects(:find_one).with('foo').returns(nil)
+            CollTest1.expects(:login).returns('muh')
+            CollTest1.expects(:logout)
+            CollTest1.expects(:make_call).with('new_coll_test1','muh').returns('id')
+            CollTest1.expects(:make_call).with('modify_coll_test1','id',"name",@test1.name,'muh')
+            CollTest1.expects(:make_call).with('modify_coll_test1','id',"coll1",[1,2],'muh')
+            CollTest1.expects(:make_call).with('save_coll_test1','id','muh')
+            @test1.save
+        end
+        
+        it "should call the store methods for a special storeable field" do
+            @test1 = CollTest2.new({'name' => 'foo'},false)
+            @test1.coll2 = [1,2]
+            CollTest2.expects(:connect).returns(Object.new)
+            CollTest2.expects(:find_one).with('foo').returns(nil)
+            CollTest2.expects(:login).returns('muh')
+            CollTest2.expects(:logout)
+            CollTest2.expects(:make_call).with('new_coll_test2','muh').returns('id')
+            CollTest2.expects(:make_call).with('modify_coll_test2','id',"name",@test1.name,'muh')
+            @test1.expects(:store_coll2)
+            CollTest2.expects(:make_call).with('save_coll_test2','id','muh')
+            @test1.save
+        end
+    end
+    
+end

data/spec/unit/cobbler/common/debug_spec.rb

@@ -0,0 +1,44 @@
+#! /usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+class TestDebug
+    include Cobbler::Common::Debug
+end
+
+describe Cobbler::Common::Debug do
+    
+    it "should provide a way to set and query a debug flag" do
+        TestDebug.should respond_to(:debug_enabled)
+        TestDebug.should respond_to(:debug_enabled=)
+    end
+
+    it "should provide a way to set and query an output engine" do
+        TestDebug.should respond_to(:output)
+        TestDebug.should respond_to(:output=)
+    end    
+    
+    it "should provide a method to print debug messages on class and instance level" do
+        TestDebug.should respond_to(:debug)
+        TestDebug.new.should respond_to(:debug)
+    end
+    
+    it "should not have debugging enabled by default" do
+        TestDebug.debug_enabled.should == false
+    end
+    
+    it "should not print out a debug message if the debug flag is not set" do
+        output = Object.new
+        output.expects(:puts).with('foo').never
+        TestDebug.output = output
+        TestDebug.debug('foo')
+    end
+
+    it "should print out a debug message if the debug flag is set" do
+        TestDebug.debug_enabled = true
+        output = Object.new
+        output.expects(:puts).with('foo').once
+        TestDebug.output = output
+        TestDebug.debug('foo')
+    end
+
+end

data/spec/unit/cobbler/common/finders_spec.rb

@@ -0,0 +1,101 @@
+#! /usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+class TestFinder
+    
+    def initialize(a,b)
+        
+    end
+    
+    include Cobbler::Common::Debug
+    include Cobbler::Connection::Handling
+    include Cobbler::Common::Lifecycle    
+    include Cobbler::Common::Finders
+end
+
+describe Cobbler::Common::Finders do
+    it "should provide a way to find all" do
+        TestFinder.should respond_to(:find)
+    end
+    it "should provide a way to find one" do
+        TestFinder.should respond_to(:find_one)
+    end
+    
+    describe "lookup" do
+        it "should raise an exception if we don't know how to lookup all" do
+            api_methods = Object.new
+            api_methods.stubs(:[]).with(:find_all).returns(nil)
+            TestFinder.stubs(:api_methods).returns(api_methods)
+            lambda{ TestFinder.find_all }.should raise_error(Exception)
+        end
+        
+        it "should raise an exception if we don't know how to lookup an item" do
+            api_methods = Object.new
+            api_methods.stubs(:[]).with(:find_one).returns(nil)
+            TestFinder.stubs(:api_methods).returns(api_methods)
+            lambda{ TestFinder.find_one('foo') }.should raise_error(Exception)
+        end
+        
+        it "should use the :find_one api_method to lookup an item" do
+            TestFinder.api_methods[:find_one] = 'find_one'
+            connection = Object.new
+            TestFinder.expects(:connect).returns(connection)
+            TestFinder.stubs(:make_call).with('find_one','foo').returns({})
+            item = TestFinder.find_one('foo')
+            item.should be_nil
+        end
+        
+        it "should return nil if api returns '~'" do
+            TestFinder.api_methods[:find_one] = 'find_one'
+            connection = Object.new
+            TestFinder.expects(:connect).returns(connection)
+            TestFinder.stubs(:make_call).with('find_one','foo').returns('~')
+            item = TestFinder.find_one('foo')
+            item.should be_nil
+        end        
+        
+        describe "is unsuccessful" do
+            it "should return an empty array if nothing is found" do
+                TestFinder.stubs(:in_transaction).returns([])
+                TestFinder.find.should be_empty
+            end
+            it "should return nil if nothing is found" do
+                TestFinder.stubs(:in_transaction).returns({})
+                TestFinder.find_one('foo').should be_nil
+            end
+        end
+        
+        describe "successfully all items" do
+            before(:each) do
+                TestFinder.stubs(:in_transaction).returns([1,2])
+            end
+            it "should return an array of Objects of itself if something is found" do
+                items = TestFinder.find
+                items.should have(2).items
+                items.first.should be_a(TestFinder)
+                items.last.should be_a(TestFinder)
+            end
+            
+            it "should pass each found item to the passed block but return the found items" do
+                items = TestFinder.find do |item|
+                    item.should be_a(TestFinder)
+                end
+                items.should have(2).items
+                items.first.should be_a(TestFinder)
+                items.last.should be_a(TestFinder)                
+            end
+        end
+        
+        describe "successfully one item" do
+            it "should return an item" do
+                TestFinder.stubs(:in_transaction).returns({:a => 1})
+                TestFinder.find_one('foo').should be_a(TestFinder)
+            end
+            
+            it "should return nil if nothing is found" do
+                TestFinder.stubs(:in_transaction).returns({})
+                TestFinder.find_one('foo').should be_nil
+            end
+        end
+    end
+end

data/spec/unit/cobbler/common/lifecycle_spec.rb

@@ -0,0 +1,192 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+class TestLifecycle
+    
+    def initialize(a=nil,b=nil)
+        @definitions = Hash.new(a)
+    end
+    
+    include Cobbler::Common::Debug
+    include Cobbler::Connection::Handling
+    include Cobbler::Common::Lifecycle
+    
+    cobbler_field :name
+    cobbler_field :foo, :locked => true
+    cobbler_field :findme, :findable => 'find_me'
+    cobbler_field :super_field, :locked => true, :findable => 'find_super'
+    
+    cobbler_fields :foo1, :foo2
+    
+    cobbler_collection :coll1
+    cobbler_collection :coll2, :packing => Hash
+    cobbler_collection :coll3, :store => :foobar
+end
+
+class TestLifecycle2
+    def initialize(a,b); end
+    include Cobbler::Common::Debug    
+    include Cobbler::Connection::Handling
+    include Cobbler::Common::Lifecycle
+    cobbler_field :name, :locked => false, :findable => false
+    cobbler_lifecycle :find_all => 'foobar', :find_one => false
+end
+
+describe Cobbler::Common::Lifecycle do
+    
+    it "should provide a bunch of api_methods for that object" do
+        TestLifecycle.api_methods.keys.should_not be_empty
+    end
+    
+    [ :find_all, :find_one, :handle, :remove, :save, :new, :modify].each do |method|
+        it "should provide an api_method for #{method} and be derived from the classname" do
+            TestLifecycle.api_methods[method].should_not be_nil
+            TestLifecycle.api_methods[method].should =~ /test_lifecycle/
+        end
+    end
+    
+    describe "defining lifecycle" do
+        it "should provide a way to define a lifecycle" do
+            TestLifecycle.should respond_to(:cobbler_lifecycle)
+        end
+        
+        it "should set the api_method according to the one we defined" do
+            TestLifecycle2.api_methods[:find_all].should == 'foobar'
+            TestLifecycle2.api_methods[:find_one].should be_false
+        end
+        
+        [ :handle, :remove, :save, :new, :modify].each do |method|
+            it "should define method #{method}" do
+                TestLifecycle2.api_methods[method].should_not be_nil
+                TestLifecycle2.api_methods[method].should =~ /test_lifecycle/
+            end
+            
+        end
+    end
+    
+    describe "define a cobbler field" do
+        it "should provide a way to define a cobbler field" do
+            TestLifecycle.should respond_to(:cobbler_field)
+        end
+        
+        it "should provide a way to define multiple cobbler fields" do
+            TestLifecycle.should respond_to(:cobbler_fields)
+        end
+        
+        it "should add this field to the record fields" do
+            TestLifecycle.cobbler_record_fields.should include(:name)
+        end
+        
+        it "should add the name field as findable" do
+            TestLifecycle.should respond_to(:find_by_name)
+        end
+
+        it "should lock the name field" do
+            TestLifecycle.locked_fields.should include(:name)
+        end
+
+        it "should not add the name field as findable if we mark it" do
+            TestLifecycle2.should_not respond_to(:find_by_name)
+        end
+
+        it "should lock the name field" do
+            TestLifecycle2.locked_fields.should_not include(:name)
+        end        
+        
+        it "should be available as getter and setter on an instance" do
+            test = TestLifecycle.new
+            test.should respond_to(:name)
+            test.should respond_to(:name=)
+        end
+        
+        it "should handle cobbler_fields over to cobbler_field" do
+            test = TestLifecycle.new
+            [:foo1,:foo2].each do |field|
+                test.should respond_to(field)
+                test.should respond_to(:"#{field}=")
+                TestLifecycle.cobbler_record_fields.should include(field)
+            end
+        end
+        
+        it "should be possible to mark that field as locked" do
+            TestLifecycle.locked_fields.should include(:foo)
+            TestLifecycle.locked_fields.should include(:super_field)
+        end
+        
+        it "should be possible to mark a field as findable" do
+            TestLifecycle.should respond_to(:find_by_findme)
+            TestLifecycle.should respond_to(:find_by_super_field)
+        end
+        
+        describe "which is findable" do
+            before(:each) do
+                connection = Object.new
+                TestLifecycle.expects(:connect).returns(connection)
+            end
+
+            it "should lookup that field" do
+                TestLifecycle.expects(:make_call).with('get_test_lifecycle','foo').returns('a')
+                item = TestLifecycle.find_by_name('foo')
+                item.should be_a(TestLifecycle)
+            end
+            it "should lookup the field with the appropriate api method" do
+                TestLifecycle.expects(:make_call).with('find_super','foo').returns('a')
+                item = TestLifecycle.find_by_super_field('foo')
+                item.should be_a(TestLifecycle)
+            end
+            
+            it "should return nil if nothing is found" do
+                TestLifecycle.expects(:make_call).with('get_test_lifecycle','foo').returns(nil)
+                TestLifecycle.find_by_name('foo').should be_nil
+            end
+        end
+    end
+    describe "define a cobbler collection" do
+        it "should provide a way to define a cobbler collection" do
+            TestLifecycle.should respond_to(:cobbler_collection)
+        end
+        
+        it "should provide accessor and setter for a collection" do
+            TestLifecycle.new.should respond_to(:coll1)
+            TestLifecycle.new.should respond_to(:coll1=)
+        end
+        
+        it "should add the collection to the fields" do
+            TestLifecycle.cobbler_record_fields.should include(:coll1)
+            TestLifecycle.cobbler_record_fields.should include(:coll2)
+        end
+        
+        it "should set a default type to be an array" do
+            TestLifecycle.new.coll1.should be_a(Array)
+        end
+
+        it "should be possible to set packing as Hash" do
+            TestLifecycle.new.coll2.should be_a(Hash)
+        end
+        
+        it "should be possible to define a special store callback" do
+            TestLifecycle.cobbler_record_fields.should_not include(:coll3)
+            TestLifecycle.cobbler_collections_store_callbacks.should include(:foobar)
+        end
+    end
+    
+    describe "assigning new values" do
+        it "should not be added to the original definitions" do
+            test = TestLifecycle.new
+            test.name = 'foo'
+            test.name.should == 'foo'
+            test.definitions['name'].should_not == 'foo'
+            test.user_definitions['name'].should == 'foo'
+        end
+        
+        it "should always be added to the user_definitions if it as collection" do
+            test = TestLifecycle.new
+            test.coll1.should == []
+            test.coll1 = [1,2]
+            test.coll1.should == [1,2]
+            test.user_definitions['coll1'].should == [1,2]
+            test.coll1 << 3
+            test.coll1 == [1,2,3]
+        end
+    end
+    
+end

data/spec/unit/cobbler/connection/common_spec.rb

@@ -0,0 +1,59 @@
+#! /usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+class TestConnection
+    include Cobbler::Common::Debug
+    include Cobbler::Connection::Handling
+    include Cobbler::Connection::Common
+end
+
+describe Cobbler::Connection::Common do
+    it "should provide a method to test a connection" do
+        TestConnection.should respond_to(:test_connection)
+    end
+    
+    it "should provide a method to start a sync" do
+        TestConnection.should respond_to(:sync)
+    end
+    
+    describe "testing a connection" do
+        
+        before(:each) do
+            connection = Object.new
+            TestConnection.expects(:connect).returns(connection)
+        end
+        
+        it "should return false if login fails" do
+            TestConnection.expects(:login).returns(nil)
+            TestConnection.test_connection.should be_false
+        end
+        it "should return true if login succeeds and logout" do
+            TestConnection.expects(:login).returns("true")
+            TestConnection.expects(:logout)
+            TestConnection.test_connection.should be_true
+        end
+    end
+    
+    with_real_cobbler(TestConnection) do |cobbler_yml|
+        describe "testing a real connection" do
+            before(:each) do
+                TestConnection.hostname = yml['hostname']
+                TestConnection.username = yml['username']
+                TestConnection.password = yml['password']
+            end
+            
+            it "should "
+        end
+    end
+    
+    describe "syncing a cobbler" do
+        it "should send the sync command" do
+            connection = 
+            TestConnection.expects(:connect).returns(Object.new)
+            TestConnection.expects(:login).returns('foobar')
+            TestConnection.expects(:logout)
+            TestConnection.expects(:make_call).with('sync','foobar')
+            TestConnection.sync
+        end
+    end
+end