cobbler 2.0.0

data/lib/cobbler/common/lifecycle.rb

@@ -0,0 +1,163 @@
+#
+# lifecycle.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/>.
+
+# +Lifecycle+ implements a default set of functionality that a cobbler item
+# can have.
+# Usually the +Lifecycle+ methods are used to define query functions and define
+# which fields of a cobbler item is exposed through the api.
+module Cobbler
+    module Common
+        module Lifecycle
+            def self.included(base)
+                base.extend ClassMethods
+            end
+            
+            def definitions
+                @definitions ||= {}
+            end
+            
+            def user_definitions
+                @user_definitions ||= {}
+            end
+            
+            def locked_fields
+                self.class.locked_fields
+            end
+            
+            def cobbler_record_fields
+                self.class.cobbler_record_fields
+            end
+            def cobbler_collections_store_callbacks
+                self.class.cobbler_collections_store_callbacks
+            end
+            
+            def api_methods
+                self.class.api_methods
+            end
+            
+            module ClassMethods
+                def api_methods
+                    return @api_methods if @api_methods
+                    model_name = self.name.gsub(/.*::/,'').underscore
+                    @api_methods = {
+                      :find_all => "get_#{model_name.pluralize}",
+                      :find_one => "get_#{model_name}",
+                      :handle => "get_#{model_name}_handle",
+                      :remove => "remove_#{model_name}",
+                      :save => "save_#{model_name}",
+                      :new => "new_#{model_name}",
+                      :modify => "modify_#{model_name}"
+                    }
+                end
+                
+                def cobbler_record_fields
+                    @cobbler_record_fields ||= []
+                end
+                
+                def locked_fields
+                    @locked_fields ||= []
+                end
+                
+                def cobbler_collections_store_callbacks
+                    @cobbler_collections_store_callbacks ||= []
+                end
+                
+                # Define/adjust all necessary lookup methods for a usual
+                # cobbler item.
+                #
+                def cobbler_lifecycle(lookup_methods={})
+                    api_methods.merge!(lookup_methods)
+                end
+                
+                # Allows for dynamically declaring fields that will come from
+                # Cobbler.
+                #
+                def cobbler_field(field,options={})
+                    # name is always locked and findable as this is a special field
+                    if field == :name
+                        options[:locked] = true if options[:locked] || options[:locked].nil?
+                        options[:findable] = api_methods[:find_one] if options[:findable] || options[:findable].nil? 
+                    end
+                    options.each do |key,value|
+                        case key
+                            when :findable then
+                            if value
+                                module_eval <<-"MEND"
+                                def self.find_by_#{field}(value)
+                                    properties = in_transaction{ make_call('#{value}',value) }
+                                    valid_properties?(properties) ? new(properties,false) : nil
+                                end
+                                MEND
+                            end
+                            when :locked then
+                            locked_fields << field if value
+                        end
+                    end
+                    
+                    module_eval("def #{field}() user_definitions['#{field}'] || definitions['#{field}']; end")
+                    module_eval("def #{field}=(val) user_definitions['#{field}'] = val; end")
+                    
+                    cobbler_record_fields << field
+                end
+                
+                # Declare many fields at once.
+                def cobbler_fields(*fields)
+                    fields.to_a.each {|field| cobbler_field field }
+                end
+                
+                # Allows a field to be defined as a collection of objects. The type for that
+                # other class must be provided.
+                #
+                def cobbler_collection(field, options={})
+                    classname = options[:type] || 'String'
+                    packing = options[:packing] ? options[:packing].to_s.classify : 'Array'
+                    
+                    packing_code = {
+              'Array' => "(definitions['#{field}']||[]).each{|value| new_value << #{classname}.new(value) }",
+              'Hash' => "(definitions['#{field}']||{}).each{|key,value| new_value[key] = #{classname}.new(value) }"
+                    }
+                    
+                    cobbler_collections_store_callbacks << options[:store] if options[:store]
+                    # unless we have a seperate store callback we store collections normally
+                    cobbler_record_fields << field unless options[:store]
+                    
+                    module_eval <<-"MEND"
+                    def #{field}
+                        if !user_definitions['#{field}'] && !definitions['#{field}'].is_a?(#{packing})
+                                                                                           new_value = #{packing}.new
+                                                                                           #{packing_code[packing]}
+                                                                                           definitions['#{field}'] = new_value
+                        end
+                        user_definitions['#{field}'] ||= definitions['#{field}']
+                        # return always the user_definitions as we might do operations on these objects, e.g. <<
+                        user_definitions['#{field}'] 
+                    end
+                    
+                    def #{field}=(value)
+                        user_definitions['#{field}'] = value
+                    end
+                    MEND
+                end        
+            end
+        end
+    end
+end

data/lib/cobbler/connection/common.rb

@@ -0,0 +1,79 @@
+#
+# common.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/>.
+
+# +Common+ provides common methods of the cobbler server exposed through the
+# api. 
+module Cobbler
+    module Connection
+        module Common
+            def self.included(base)
+                base.extend(ClassMethods)
+            end
+            
+            module ClassMethods
+                # tests a connections
+                def test_connection
+                    !in_transaction do
+                        result = login
+                        logout if result
+                        result
+                    end.nil?
+                end
+                
+                # start a sync on the cobbler server
+                def sync
+                    in_transaction(true) do |token|
+                        make_call('sync',token)
+                    end
+                end
+                
+                # get all events (for a certain user)
+                def events(for_user='')
+                    in_transaction do
+                        make_call('get_events',for_user)
+                    end
+                end
+                
+                # get the log for a certain event
+                def event_log(event_id)
+                    in_transaction do
+                        make_call('get_event_log',event_id)
+                    end
+                end
+                
+                # import a tree into cobbler
+                def import(path,name,arch,additional_options={})
+                    in_transaction(true) do |token|
+                        make_call('background_import',{'path' => path ,'name' => name , 'arch' => arch}.merge(additional_options),token)
+                    end
+                end
+                
+                # start syncing the following repositories.
+                def reposync(repos=[],tries=3)
+                    in_transaction(true) do |token|
+                        make_call('background_reposync',{'repos' => repos, 'tries' => tries},token)
+                    end
+                end
+            end
+        end
+    end
+end

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/lib/cobbler.rb

@@ -0,0 +1,35 @@
+#
+# cobbler.rb - Cobbler module declaration.
+#
+# 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 'active_support/inflector'
+require 'cobbler/base'
+require 'cobbler/distro'
+require 'cobbler/image'
+require 'cobbler/profile'
+require 'cobbler/repo'
+require 'cobbler/system'
+
+module Cobbler
+
+  VERSION = '2.0.0'
+
+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