gapinc-cobbler 2.0.0

data/lib/cobbler/connection/handling.rb

@@ -0,0 +1,108 @@
+#
+# handling.rb
+#
+# Copyright (C) 2008,2009 Red Hat, Inc.
+# Written by Darryl L. Pierce <dpierce@redhat.com>
+# Extended 2012 by duritong <peter.meier@immerda.ch>
+#
+# This file is part of rubygem-cobbler.
+#
+# rubygem-cobbler is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 2.1 of the License, or
+# (at your option) any later version.
+#
+# rubygem-cobbler is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with rubygem-cobbler.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'xmlrpc/client'
+
+# +Handling+ provides common methods to handle the xmlrpc connection to the 
+# cobbler server
+module Cobbler
+    module Connection
+        module Handling
+            include Cobbler::Common::Debug
+            def self.included(base)
+                base.extend ClassMethods
+            end
+            
+            module ClassMethods
+                
+                # Set hostname, username, password for the Cobbler server, overriding any settings
+                # from cobbler.yml.
+                attr_accessor :hostname, :username, :password
+                
+                # Returns the version for the remote cobbler instance.
+                def remote_version
+                    connect unless connection
+                    @version ||= make_call("version")
+                end
+                
+                # Logs into the Cobbler server.
+                def login
+                    @auth_token ||= make_call('login', username, password)
+                end
+                
+                def logout
+                    make_call('logout',@auth_token)
+                    @auth_token = nil
+                end
+
+
+                # Makes a remote call.
+                def make_call(*args)
+                    raise Exception.new("No connection established on #{self.name}.") unless connection
+                    
+                    debug("Remote call: #{args.first} (#{args[1..-1].inspect})")
+                    result = connection.call(*args)
+                    debug("Result: #{result}\n")
+                    result
+                end
+
+                def in_transaction(do_login=false,&blk)
+                    begin
+                        begin_transaction
+                        token = do_login ? login : nil 
+                        result = yield(token)
+                        logout if do_login
+                    ensure
+                        end_transaction
+                    end
+                    result
+                end
+
+                protected
+                # Returns a connection to the Cobbler server.
+                def connect
+                    debug("Connecting to http://#{hostname}/cobbler_api")
+                    @connection = XMLRPC::Client.new2("http://#{hostname}/cobbler_api")
+                end
+                
+                private                
+                # Establishes a connection with the Cobbler system.
+                def begin_transaction
+                    @connection = connect
+                end
+                # Ends a transaction and disconnects.
+                def end_transaction
+                    @connection = @auth_token = @version = nil
+                end
+                
+                def connection
+                    @connection
+                end
+                
+                def valid_properties?(properties)
+                    properties && !properties.empty? && properties != '~'
+                end
+
+            end
+        end
+    end
+end

data/lib/cobbler/distro.rb

@@ -0,0 +1,32 @@
+#
+# distro.rb
+#
+# Copyright (C) 2008,2009 Red Hat, Inc.
+# Written by Darryl L. Pierce <dpierce@redhat.com>
+# Extended 2012 by duritong <peter.meier@immerda.ch>
+#
+# This file is part of rubygem-cobbler.
+#
+# rubygem-cobbler is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 2.1 of the License, or
+# (at your option) any later version.
+#
+# rubygem-cobbler is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with rubygem-cobbler.  If not, see <http://www.gnu.org/licenses/>.
+
+# +Distro+ represents a single distrobution within Cobbler.
+#
+module Cobbler
+    class Distro < Base
+        cobbler_fields :name, :kernel, :breed, :depth, :arch, :initrd,
+        :source_repos, :kernel_options, :parent, :ks_meta
+        
+        cobbler_collection :owners
+    end
+end

data/lib/cobbler/image.rb

@@ -0,0 +1,31 @@
+#
+# image.rb
+#
+# Copyright (C) 2008,2009 Red Hat, Inc.
+# Written by Darryl L. Pierce <dpierce@redhat.com>
+# Extended 2012 by duritong <peter.meier@immerda.ch>
+#
+# This file is part of rubygem-cobbler.
+#
+# rubygem-cobbler is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 2.1 of the License, or
+# (at your option) any later version.
+#
+# rubygem-cobbler is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with rubygem-cobbler.  If not, see <http://www.gnu.org/licenses/>.
+
+# +Image+ represents an image within Cobbler.
+#
+module Cobbler
+    class Image < Base
+        cobbler_fields :name, :owners, :depth, :virt_file_size,
+      :virt_path, :xml_file, :virt_bridge, :file, :parent,
+      :image_type, :virt_ram, :virt_auto_boot, :virt_cpus, :virt_type, :network_count
+    end
+end

data/lib/cobbler/profile.rb

@@ -0,0 +1,34 @@
+#
+# profile.rb
+#
+# Copyright (C) 2008,2009 Red Hat, Inc.
+# Written by Darryl L. Pierce <dpierce@redhat.com>
+# Extended 2012 by duritong <peter.meier@immerda.ch>
+#
+# This file is part of rubygem-cobbler.
+#
+# rubygem-cobbler is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 2.1 of the License, or
+# (at your option) any later version.
+#
+# rubygem-cobbler is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with rubygem-cobbler.  If not, see <http://www.gnu.org/licenses/>.
+
+# +Profile+ represents a single profile within Cobbler.
+#
+module Cobbler
+    class Profile < Base
+        cobbler_fields :name, :parent, :dhcp_tag, :depth, :virt_file_size,
+        :virt_path, :virt_type, :repos, :distro, :server, :virt_bridge,
+        :virt_ram, :virt_auto_boot, :kernel_options, :virt_cpus, :ks_meta,
+        :kickstart
+        
+        cobbler_collection :owners
+    end
+end

data/lib/cobbler/repo.rb

@@ -0,0 +1,33 @@
+#
+# repo.rb
+#
+# Copyright (C) 2008,2009 Red Hat, Inc.
+# Written by Darryl L. Pierce <dpierce@redhat.com>
+# Extended 2012 by duritong <peter.meier@immerda.ch>
+#
+# This file is part of rubygem-cobbler.
+#
+# rubygem-cobbler is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 2.1 of the License, or
+# (at your option) any later version.
+#
+# rubygem-cobbler is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with rubygem-cobbler.  If not, see <http://www.gnu.org/licenses/>.
+
+# +Repo+ represents a single repository within Cobbler.
+#
+module Cobbler
+    class Repo < Base
+        cobbler_fields :name, :arch, :breed, :comment, :keep_updated, :mirror,
+        :parent, :rpm_list, :createrepo_flags, :environment, :mirror_locally, :priority,
+        :yumopts
+        
+        cobbler_collection :owners
+    end
+end

data/lib/cobbler/system.rb

@@ -0,0 +1,45 @@
+#
+# system.rb
+#
+# Copyright (C) 2008,2009 Red Hat, Inc.
+# Written by Darryl L. Pierce <dpierce@redhat.com>
+# Extended 2012 by duritong <peter.meier@immerda.ch>
+#
+# This file is part of rubygem-cobbler.
+#
+# rubygem-cobbler is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 2.1 of the License, or
+# (at your option) any later version.
+#
+# rubygem-cobbler is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with rubygem-cobbler.  If not, see <http://www.gnu.org/licenses/>.
+
+# +System+ represents a system within Cobbler.
+#
+module Cobbler
+    class System < Base
+        cobbler_fields :name, :profile, :image, :kickstart, :netboot_enabled, :server, :virt_cpus,
+        :virt_file_size, :virt_path, :virt_ram, :virt_auto_boot, :virt_type, :gateway, :hostname
+        
+        cobbler_collection :kernel_options, :packing => :hash
+        cobbler_collection :ks_meta, :packing => :hash
+        cobbler_collection :owners
+        cobbler_collection :interfaces, :packing => :hash, :store => :store_interfaces
+        
+        def store_interfaces(sysid,token)
+            interfaces.each do |interface,values|
+                values2store = values.keys.inject({}) do |result,member|
+                    result["#{member.to_s.gsub(/_/,'')}-#{interface}"] = values[member] if values[member]
+                    result
+                end
+                self.class.make_call('modify_system',sysid,'modify_interface',values2store,token) unless values2store.empty?
+            end
+        end
+    end
+end

data/rubygem-cobbler.spec

@@ -0,0 +1,100 @@
+# Generated from cobbler-0.0.1.gem by gem2rpm -*- rpm-spec -*-
+%define ruby_sitelib %(ruby -rrbconfig -e "puts Config::CONFIG['sitelibdir']")
+%define gemdir %(ruby -rubygems -e 'puts Gem::dir' 2>/dev/null)
+%define gemname cobbler
+%define geminstdir %{gemdir}/gems/%{gemname}-%{version}
+%define installroot %{buildroot}%{geminstdir}
+
+Summary: 	An interface for interacting with a Cobbler server
+Name: 		rubygem-%{gemname}
+Version: 	2.0.0
+Release: 	1%{?dist}
+Group: 		Development/Languages
+License: 	LGPLv2+
+URL: 		https://github.com/duritong/ruby-cobbler
+Source0: 	https://rubygems.org/downloads/%{gemname}-%{version}.gem
+BuildRoot: 	%{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n)
+Requires: 	rubygems
+BuildRequires:  ruby-flexmock
+BuildRequires: 	rubygems
+BuildRequires:  rubygem-rake
+BuildArch: 	noarch
+Provides: 	rubygem(%{gemname}) = %{version}
+
+%description
+Provides Ruby bindings to interact with a Cobbler server.
+
+%prep
+
+%build
+
+%check 
+
+cd %{installroot}
+
+rake test
+
+%install
+rm -rf %{buildroot}
+mkdir -p %{buildroot}%{gemdir}
+gem install --local --install-dir %{buildroot}%{gemdir} --force %{SOURCE0}
+
+chmod +x %{installroot}/examples/*.rb
+
+%clean
+rm -rf %{buildroot}
+
+%files
+%defattr(-, root, root, -)
+%{gemdir}/gems/%{gemname}-%{version}/
+%{gemdir}/cache/%{gemname}-%{version}.gem
+%{gemdir}/specifications/%{gemname}-%{version}.gemspec
+
+%doc %{geminstdir}/COPYING 
+%doc %{geminstdir}/NEWS 
+%doc %{geminstdir}/README
+
+%{geminstdir}/config/cobbler.yml
+
+
+%changelog
+* Thu Jan 05 2012 duritong <peter.meier@immerda.ch> - 2.0.0-1
+- Fix all issues when API returns ~ on a nonexisting system
+- Add some missing fields to the System model
+- Remove unnecessary object abstraction for interfaces
+- Fix storing of interfaces
+- Rework connection handling
+- Rewrite to enable capabilities for all items and to work against 2.0  
+
+* Mon Sep 08 2008 Darryl Pierce <dpierce@redhat.com> - 0.1.0-1
+- First official build for Fedora.
+
+* Fri Sep 05 2008 Darryl Pierce <dpierce@redhat.com> - 0.0.2-4
+- Bad BuildRequires slipped into the last version.
+
+* Wed Sep 03 2008 Darryl Pierce <dpierce@redhat.com> - 0.0.2-3
+- Added a build requirement for rubygem-rake.
+
+* Tue Aug 26 2008 Darryl Pierce <dpierce@redhat.com> - 0.0.2-2
+- Fixed the licensing in each source module to show the code is released under
+  LGPLv2.1.
+- Added %check to the spec file to run tests prior to creating the RPM.
+
+* Thu Aug 21 2008 Darryl Pierce <dpierce@redhat.com> - 0.0.2-1
+- Added a call to update prior to saving or updating a system. If the update
+  fails, then an Exception is raised.
+
+* Wed Aug 13 2008 Darryl Pierce <dpierce@redhat.com> - 0.0.1-3
+- Added caching for the auth_token to prevent extraneous calls to login.
+- Reworked and refined how cobbler_collection fields are processed, adding 
+  support for both array and has properties.
+- Rewrote the documentation for Cobbler::Base to make it easier to understand
+  how to extend it to support other Cobbler types.
+- Refactored the examples to clean up the code.
+
+* Wed Aug 13 2008 Darryl Pierce <dpierce@redhat.com> - 0.0.1-2
+- Removed markup of cobbler.yml and a config file. Fixed a few small bugs 
+  in the code for using it as a gem.
+
+* Mon Aug 04 2008 Darryl Pierce <dpierce@redhat.com> - 0.0.1-1
+- Initial package

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--format
+s
+--colour
+--loadby
+mtime
+--backtrace

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