cobbler 2.0.0

data/README.rdoc

@@ -0,0 +1,87 @@
+= ruby-cobbler
+
+Ruby bindings for interacting with Cobbler.
+
+These bindings were once part of the official cobbler repository. They were
+written by Darryl L. Pierce <dpierce@redhat.com>. However, they got stalled to
+work for cobbler 1.x and no further development was done. Also
+this version was missing a lot of features, like creating various objects etc.
+
+So I took over the development and while the work was done to get it working
+with a more recent cobbler version, but also to add the various missing
+features, the development of cobbler by RedHat stopped and the people continuing
+the work on cobbler decided to drop the ruby gem.
+So I decided to publish that gem on its own, but still keep it under the same
+License as Darryl L. Pierce <dpierce@redhat.com> published it originally.
+
+It is used to talk to a cobbler installation that ships with the latest RedHat
+Satellite and have tested with that.
+It is still a work in progress, but it is used, to create systems, delete systems,
+create and/or import repositories, sync repositories, work with the task engine,
+and so on.
+
+WARNING: It is possible that it does not work with a current cobbler version as
+the author does currently not have access to such an installation nor is any
+work planned to do so.
+Just give it a shot with a newer cobbler and if things don't work: pull requests
+are welcomed! See below.
+
+== USAGE
+
+To use the code, you must install the ruby gem named "cobbler" and then
+require 'cobbler' in your application. 
+
+Minimally you need to provide a server name for your Cobbler machine using:
+
+Cobbler::Base.hostname = my.cobbler.server
+
+If you intend to modify data on the Cobbler server, you'll need to also provide
+a username and password that has authorization:
+
+Cobbler::Base.username = username
+Cobbler::Base.password = password
+
+== Examples
+
+You'll find a few working examples in `examples/`
+
+An example on how to import a distribution is:
+
+    Cobbler::Base.hostname = localhost
+    Cobbler::Base.username = cobbler
+    Cobbler::Base.password = cobbler     
+    log_id = Cobbler::Base.import("/mnt/centos6.iso",'centos6','x86_64', 'breed' => 'redhat')
+    while (event = Cobbler::Base.events[log_id])[2] == 'running' do
+      puts "Current state is: #{event[2]} - #{event.inspect}"
+      sleep 60
+    end
+    puts "Import event: #{event.inspect}"
+    puts "All distros:"
+    Cobbler::Distro.find { |distro| puts "\"#{distro.name}\" is a breed of \"#{distro.breed}\"."}
+
+
+== CONFIGURATION
+
+By default, Cobbler::Base will load the file $SEARCHPATH/config/cobbler.yml,
+if it exists, and use that information for talking to Cobbler. To override 
+where this file lives, set the COBBLER_ENV environment variable *before* 
+requiring the 'cobbler' file. 
+
+However, these values can be overridden afterward by changing the fields in 
+Cobbler::Base directly.
+
+== Contributing to cobbler
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 duritong. See COPYING for
+further details.
+

data/Rakefile

@@ -0,0 +1,75 @@
+# Copyright (C) 2008 Red Hat, Inc.
+# Written by Darryl L. Pierce <dpierce@redhat.com>
+# Extended 2012 by duritong <peter.meier@immerda.ch>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 2 of the License.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA  02110-1301, USA.  A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+
+require 'jeweler'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+require 'cobbler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docgem.rubygems.org/read/chapter/20 for more options
+  gem.name = 'cobbler'
+  gem.version = "2.0.0"
+  gem.author = 'duritong'
+  gem.email = 'peter.meier@immerda.ch'
+  gem.homepage = 'http://github.com/duritong/ruby-cobbler/'
+  gem.platform = Gem::Platform::RUBY
+  gem.summary = 'An interface for interacting with a Cobbler server.'
+  gem.license = 'GPLv2'
+  gem.description = <<EOF
+  Provides Ruby bindings to interact with a Cobbler server.
+EOF
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+gem 'rdoc'
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = '2.0.0'
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "iuid #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/TODO

@@ -0,0 +1,6 @@
+This is a list of features to be developed in future.
+
+* Rewrite examples to fit the new style
+
+* Add hierarchical relationships, so that a Profile will load it's 
+  Distro, a System will load it's Profile, etc.

data/config/cobbler.yml

@@ -0,0 +1,5 @@
+# Cobbler connection details
+
+hostname: localhost
+username: cobbler
+password: cobbler

data/examples/example_distros.rb

@@ -0,0 +1,119 @@
+#
+# example_version.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/>.
+#
+
+base = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+$LOAD_PATH << File.join(base, "lib")
+$LOAD_PATH << File.join(base, "examples")
+
+require 'utils'
+Cobbler::Examples::Utils.enhance(Cobbler::Distro)
+
+require 'getoptlong'
+
+opts = GetoptLong.new(
+  ['--show',    '-s', GetoptLong::REQUIRED_ARGUMENT ],
+  ['--list',    '-l', GetoptLong::NO_ARGUMENT],
+  ['--create',  '-c', GetoptLong::REQUIRED_ARGUMENT ],
+  ['--remove',  '-r', GetoptLong::REQUIRED_ARGUMENT ],
+  ['--testrun', '-t', GetoptLong::REQUIRED_ARGUMENT ]
+)
+
+def list
+    puts "All distros:"
+    Cobbler::Distro.find { |distro| puts "\"#{distro.name}\" is a breed of \"#{distro.breed}\"."}
+end
+
+def show(name)
+  puts "Finding the distro named \"#{name}\""
+    
+  if (distro = Cobbler::Distro.find_one(name))
+    puts "#{distro.name} exists, and is a breed of #{distro.breed}."
+    puts "Kernel: #{distro.kernel} - Initrd: #{distro.initrd}"
+  else
+    puts "No such distro"
+  end
+end
+
+def create(name)
+    existing_distro = Cobbler::Distro.find.first
+    unless existing_distro
+        puts "No existing distro found to copy data from... -> abort!"
+        exit 1
+    end
+    distro = Cobbler::Distro.new
+    distro.name = name
+    distro.breed = existing_distro.breed
+    distro.kernel = existing_distro.kernel
+    distro.initrd = existing_distro.initrd
+    distro.arch = existing_distro.arch
+    distro.save
+    
+    puts "Distro #{name} saved!"
+end
+
+def remove(name)
+    if (distro=Cobbler::Distro.find_one(name))
+        distro.remove
+        puts "Distro #{name} successfully removed!"
+    else
+        puts "No such distro named #{name} found! -> abort!"
+        exit 1
+    end
+end
+
+def testrun(name)
+    puts "Distros at the beginning"
+    puts "------------------------"
+    list
+    puts
+    puts "Create distro #{name}"
+    puts "---------------------"
+    create(name)
+    puts
+    puts "All distros after creating #{name}"
+    puts "----------------------------------"
+    list
+    puts
+    puts "Display distro #{name}"
+    puts "----------------------"
+    show(name)
+    puts
+    puts "Remove distro #{name}"
+    puts "---------------------"
+    remove(name)
+    puts
+    puts "Distros at the end"
+    puts "------------------"
+    list
+end
+
+opts.each do |opt, arg|
+  case opt
+    when '--show' then show(arg)
+    when '--list' then list
+    when '--create' then create(arg)
+    when '--remove' then remove(arg)
+    when '--testrun' then testrun(arg)
+  end
+  exit 0
+end

data/examples/example_version.rb

@@ -0,0 +1,31 @@
+#
+# example_distros.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/>.
+#
+
+base = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+$LOAD_PATH << File.join(base, "lib")
+$LOAD_PATH << File.join(base, "examples")
+
+require 'utils'
+Cobbler::Examples::Utils.enhance
+
+puts "Cobbler version: #{Cobbler::Base.remote_version}"

data/examples/utils.rb

@@ -0,0 +1,44 @@
+#
+# cli.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 'cobbler'
+require 'yaml'
+
+module Cobbler
+    module Examples
+        module Utils
+            def self.enhance(clazz=Cobbler::Base)
+                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'])
+                    clazz.hostname = yml['hostname']
+                    clazz.username = yml['username']
+                    clazz.password = yml['password']
+                    clazz.debug_enabled = yml['debug']||false
+                else
+                    puts "Can't load configuration file (#{config}) with all necessary parameters. Either fix the yaml file or point COBBLER_YML to an appropriate file."
+                    exit 1
+                end
+            end
+        end
+    end
+end

data/lib/cobbler/base.rb

@@ -0,0 +1,128 @@
+#
+# base.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 'cobbler/common/debug'
+require 'cobbler/connection/handling'
+require 'cobbler/connection/common'
+require 'cobbler/common/lifecycle'
+require 'cobbler/common/finders'
+
+# +Base+ represents a type of item on the Cobbler server.
+#
+# Child classes can define fields that will be retrieved from Cobbler by
+# using the +cobbler_field+ method. For example:
+#
+#   class System < Base
+#       cobbler_lifecycle :find_all => 'get_systems'
+#       cobbler_field :name
+#       cobbler_collection :owners, :type => 'String', :packing => :hash
+#   end
+#
+# declares a class named System that contains two fields and a class-level
+# method.
+#
+# The first field, "name", is a simple property. It will be retrieved from
+# the value "name" in the remote definition for a system, identifyed by the
+# +:owner+ argument.
+#
+# The second field, "owners", is similarly retrieved from a property also
+# named "owners" in the remote definition. However, this property is a
+# collection: in this case, it is an array of definitions itself. The
+# +:type+ argument identifies what the +local+ class type is that will be
+# used to represent each element in the collection.
+#
+# A +cobbler_collection+ is packed in one of two ways: either as an array
+# of values or as a hash of keys and associated values. These are defined by
+# the +:packing+ argument with the values +Array+ and +Hash+, respectively.
+#
+# The +cobbler_lifecycle+ method allows for declaring different methods for
+# retrieving remote instances of the class. +cobbler_lifecycle+ also declares
+# automatically the various API methods if they aren't overwritten.
+# These methods are (defaults are shown for an item called Model):
+#
+# +find_one+ - to find a single instance (get_model)
+# +find_all+ - to find all instances (get_models)
+# +remove+   - to remove an instance (remove_model)
+# +handle+   - to obtain the handle for this item (get_model_handle)
+# +save+     - to store an item (save_model)
+# +new+      - to create a new item (new_model)
+# +modify+   - to modify an existing model (modfiy_model)
+#
+module Cobbler
+    class Base
+        
+        def initialize(defs = {},new_record = true)
+            if new_record
+                @user_definitions = defs
+            else
+                @definitions = defs
+            end
+        end
+        
+        include Cobbler::Common::Debug
+        include Cobbler::Connection::Handling
+        include Cobbler::Connection::Common
+        
+        include Cobbler::Common::Lifecycle
+        include Cobbler::Common::Finders
+
+        # Save an item on the remote cobbler server
+        # This will first lookup if the item already exists on the remote server
+        # and use its handle store the attributes. Otherwise a new item is created.
+        def save
+            unless [ :handle, :new, :modify, :save ].all?{|method| api_methods[method] }
+                raise "Not all necessary api methods are defined to process this action!"            
+            end
+            entry = self.class.find_one(name)
+            self.class.in_transaction(true) do |token|
+                if entry
+                    entryid = self.class.make_call(api_methods[:handle],name,token) 
+                else
+                    entryid = self.class.make_call(api_methods[:new],token)
+                    self.class.make_call(api_methods[:modify],entryid,'name', name, token)
+                end
+                
+                cobbler_record_fields.each do |field|
+                    field_s = field.to_s
+                    if !locked_fields.include?(field) && user_definitions.has_key?(field_s)
+                        self.class.make_call(api_methods[:modify],entryid,field_s, user_definitions[field_s], token)
+                    end
+                end
+                
+                cobbler_collections_store_callbacks.each do |callback|
+                    send(callback,entryid,token)
+                end
+                
+                self.class.make_call(api_methods[:save],entryid,token)
+            end
+        end
+        
+        # delete the item on the cobbler server
+        def remove
+            raise "Not all necessary api methods are defined to process this action!" unless api_methods[:remove]
+            self.class.in_transaction(true) do |token|
+                self.class.make_call(api_methods[:remove],name,token)
+            end
+        end
+    end
+end

data/lib/cobbler/common/debug.rb

@@ -0,0 +1,59 @@
+#
+# debug.rb
+#
+# Copyright (C) 2008,2009 Red Hat, Inc.
+# Written by Darryl L. Pierce <dpierce@redhat.com>
+# 2.0 Work by Marcel Härry <haerry@puzzle.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/>.
+#
+
+# +Debug+ provides a basic debugging infrastructure.
+module Cobbler
+    module Common
+        module Debug
+            def self.included(base)
+                base.extend(ClassMethods)
+            end
+            
+            def debug(msg)
+                self.class.debug(msg)
+            end
+            
+            module ClassMethods
+                def debug_enabled
+                    @debug_enabled ||= false
+                end
+                
+                def debug_enabled=(enable)
+                    @debug_enabled = enable
+                end
+                
+                def output=(output)
+                    @output = output
+                end
+                
+                def output
+                    @output ||= STDOUT
+                end
+                
+                def debug(msg)
+                    output.puts msg if @debug_enabled
+                end
+            end
+        end
+    end
+end

data/lib/cobbler/common/finders.rb

@@ -0,0 +1,55 @@
+#
+# finders.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/>.
+#
+
+# +Finders+ provides the basic 2 finder methods to query a cobbler server
+#
+# +find_one+ to fetch exactly one item based on its name
+# +find+ to find all items, takes a block to work with the fetched items
+module Cobbler
+    module Common
+        module Finders
+            def self.included(base)
+                base.extend(ClassMethods)
+            end
+            
+            module ClassMethods
+                def find(&block)
+                    raise "No idea how to fetch a list of myself, as no find_all method is defined" unless api_methods[:find_all]
+                    result = []
+                    in_transaction { make_call(api_methods[:find_all]) }.to_a.each do |record|
+                        c_record = new(record,false)
+                        result << c_record
+                        yield(c_record) if block_given?
+                    end
+                    return result
+                end
+                
+                def find_one(name)
+                    raise "No idea how to fetch myself, as no find_one method is defined" unless api_methods[:find_one]
+                    properties = in_transaction { make_call(api_methods[:find_one],name) }
+                    valid_properties?(properties) ? new(properties,false) : nil
+                end
+            end
+        end
+    end
+end