rhn_satellite 0.0.4

data/lib/rhn_satellite/connection/handler.rb

@@ -0,0 +1,116 @@
+module RhnSatellite
+    module Connection
+        class Handler
+            
+            include RhnSatellite::Common::Debug
+            
+            class << self
+                attr_accessor :default_hostname,:default_username, :default_password, :default_timeout
+                
+                def instance_for(identifier,hostname=nil,username=nil,password=nil,timeout=nil,https=true)
+                    instances[identifier] ||= Handler.new(
+                        hostname||default_hostname,
+                        username||default_username,
+                        password||default_password,
+                        timeout||default_timeout,
+                        https
+                    )
+                end
+                
+                def reset_instance(identifier)
+                    instances.delete(identifier)
+                end
+                
+                def reset_all
+                  @instances = {}
+                end
+
+                private
+                def instances
+                    @instances ||= {}
+                end
+            end
+            
+            def initialize(hostname,username=nil,password=nil,timeout=30,https=true)
+                @hostname = hostname
+                @username = username
+                @password = password
+                @timeout = timeout
+                @https = https
+            end
+            
+            def login(duration=nil)
+                @auth_token ||= make_call('auth.login', *[@username, @password, duration].compact)
+            end
+            
+            def logout
+                make_call('auth.logout',@auth_token) if @auth_token
+                true
+            ensure
+                @auth_token = nil
+            end
+            
+            
+            # Makes a remote call.
+            def make_call(*args)
+                raise "No connection established on #{@hostname}." unless connected?
+                
+                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
+            
+            def connected?
+                !connection.nil?
+            end
+
+            def connect
+                debug("Connecting to #{url}")
+                @connection = XMLRPC::Client.new2(url,nil,@timeout)
+            end
+            
+            def disconnect
+                @connection = nil
+            end
+
+            def default_call(cmd,*args)
+              in_transaction(true) {|token| make_call(cmd,token,*args) }
+            end
+            
+            private                
+            def begin_transaction
+                connect
+            end
+            # Ends a transaction and disconnects.
+            def end_transaction
+                @connection = @auth_token = @version = nil
+            end
+            
+            def connection
+                @connection
+            end
+            
+            def url
+                @url ||= "#{@https ? 'https' : 'http'}://#{@hostname}#{api_path}"
+            end
+            
+            def api_path
+               "/rpc/api" 
+            end
+            
+        end
+    end
+end

data/lib/rhn_satellite/package.rb

@@ -0,0 +1,15 @@
+module RhnSatellite
+  class Package < RhnSatellite::Connection::Base
+    class << self
+      def details(package_id)
+        base.default_call('package.getDetails',package_id.to_i)
+      end
+
+      def exists?(package_id)
+        !details(package_id).nil?
+      rescue XMLRPC::FaultException
+        false
+      end
+    end
+  end
+end

data/lib/rhn_satellite/system.rb

@@ -0,0 +1,83 @@
+module RhnSatellite
+  class System < RhnSatellite::Connection::Base
+    collection 'system.listUserSystems'
+    class << self
+
+      def active_systems
+        base.default_call('system.listActiveSystems').to_a
+      end
+      
+      def details(system_id)
+        base.default_call('system.getDetails',system_id.to_i)
+      end
+      
+      def online?(server_name)
+       !(system = get(server_name)).nil? && \
+        !(sysdetails = details(system['id'])).nil? && \
+          (sysdetails['osa_status'] == 'online')
+      end
+      
+      def active?(server_name)
+        active_systems.any?{|system| system["name"] =~ /#{server_name}$/ }
+      end
+      
+      def relevant_erratas(system_id)
+        base.default_call('system.getRelevantErrata',system_id).to_a
+      end
+
+      def latest_available_packages(system_ids)
+        base.default_call('system.listLatestAvailablePackages',system_ids).to_a
+      end
+
+      def latest_installable_packages(system_id)
+        base.default_call('system.listLatestInstallablePackages',system_id).to_a
+      end
+      
+      def latest_upgradable_packages(system_id)
+        base.default_call('system.listLatestUpgradablePackages',system_id).to_a
+      end
+      
+      def uptodate?(system_id)
+        latest_upgradable_packages(system_id).empty? && relevant_erratas(system_id).empty?
+      end
+
+      def subscribed_base_channel(system_id)
+        base.default_call('system.getSubscribedBaseChannel',system_id.to_i)
+      end
+      def set_base_channel(system_id,channel_label)
+        base.default_call('system.setBaseChannel',system_id.to_i,channel_label)
+      end
+      def subscribable_base_channels(system_id)
+        base.default_call('system.listSubscribableBaseChannels',system_id.to_i)
+      end
+
+      def subscribed_child_channels(system_id)
+        base.default_call('system.listSubscribedChildChannels',system_id.to_i)
+      end
+      def set_child_channels(system_id,child_channel_labels)
+        base.default_call('system.setChildChannels',system_id.to_i,child_channel_labels)
+      end
+      def subscribable_child_channels(system_id)
+        base.default_call('system.listSubscribableChildChannels',system_id.to_i)
+      end
+
+      def schedule_apply_errata(system_ids,errata_ids,earliest_occurence=nil)
+        base.default_call(
+          'system.scheduleApplyErrata',
+          *([
+              [*system_ids].collect{|i| i.to_i },
+              [*errata_ids].collect{|i| i.to_i },
+              RhnSatellite::Common::Misc.gen_date_time(earliest_occurence)
+            ].compact))
+      end
+
+      def schedule_reboot(system_id,earliest_occurence='now')
+        base.default_call('system.scheduleReboot',system_id.to_i,RhnSatellite::Common::Misc.gen_date_time(earliest_occurence))
+      end
+
+      def schedule_package_install(system_id,package_ids,earliest_occurence='now')
+        base.default_call('system.schedulePackageInstall',system_id.to_i,package_ids,RhnSatellite::Common::Misc.gen_date_time(earliest_occurence))
+      end
+    end
+  end
+end

data/lib/rhn_satellite/systemgroup.rb

@@ -0,0 +1,34 @@
+module RhnSatellite
+  class Systemgroup < RhnSatellite::Connection::Base
+    collection 'systemgroup.listAllGroups'
+    
+    class << self
+      def delete(group_name)
+        base.default_call('systemgroup.delete',group_name)
+      end
+      
+      def create(group_name, description)
+        base.default_call('systemgroup.create',group_name,description)
+      end
+      
+      def systems(group_name)
+        base.default_call('systemgroup.listSystems',group_name)
+      end
+      
+      # if group is not valid an XMLRPC::FaultException is raised
+      def systems_safe(group_name)
+        systems(group_name)
+      rescue XMLRPC::FaultException
+        []
+      end
+      
+      def remove_systems(group_name,system_ids)
+        base.default_call('systemgroup.addOrRemoveSystems',group_name,system_ids,false)
+      end
+      
+      def add_systems(group_name,system_ids)
+        base.default_call('systemgroup.addOrRemoveSystems',group_name,system_ids,true)
+      end
+    end
+  end
+end

data/rhn_satellite.gemspec

@@ -0,0 +1,87 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rhn_satellite}
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["duritong"]
+  s.date = %q{2012-01-05}
+  s.description = %q{It provides an easy way to interact with a RedHat Satellite API.}
+  s.email = %q{peter.meier@immerda.ch}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/rhn_satellite.rb",
+    "lib/rhn_satellite/activation_key.rb",
+    "lib/rhn_satellite/api.rb",
+    "lib/rhn_satellite/channel.rb",
+    "lib/rhn_satellite/channel_access.rb",
+    "lib/rhn_satellite/channel_software.rb",
+    "lib/rhn_satellite/common/collection.rb",
+    "lib/rhn_satellite/common/debug.rb",
+    "lib/rhn_satellite/common/misc.rb",
+    "lib/rhn_satellite/connection/base.rb",
+    "lib/rhn_satellite/connection/handler.rb",
+    "lib/rhn_satellite/package.rb",
+    "lib/rhn_satellite/system.rb",
+    "lib/rhn_satellite/systemgroup.rb",
+    "rhn_satellite.gemspec",
+    "spec/spec.opts",
+    "spec/spec_helper.rb",
+    "spec/unit/rhn_satellite/activation_key_spec.rb",
+    "spec/unit/rhn_satellite/api_spec.rb",
+    "spec/unit/rhn_satellite/channel_access_spec.rb",
+    "spec/unit/rhn_satellite/channel_software_spec.rb",
+    "spec/unit/rhn_satellite/channel_spec.rb",
+    "spec/unit/rhn_satellite/common/debug_spec.rb",
+    "spec/unit/rhn_satellite/common/misc_spec.rb",
+    "spec/unit/rhn_satellite/connection/base_spec.rb",
+    "spec/unit/rhn_satellite/connection/handler_spec.rb",
+    "spec/unit/rhn_satellite/package_spec.rb",
+    "spec/unit/rhn_satellite/system_spec.rb",
+    "spec/unit/rhn_satellite/systemgroup_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/duritong/ruby-rhn_satellite}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{RhnSatellite is a ruby api to the RedHat Satellite}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.9.10"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<mocha>, ["~> 0.9.10"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<mocha>, ["~> 0.9.10"])
+  end
+end
+

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'rhn_satellite'
+
+# Requires supporting files with custom matchers and macros, etc,
+# # in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

data/spec/unit/rhn_satellite/activation_key_spec.rb

@@ -0,0 +1,58 @@
+#! /usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe RhnSatellite::ActivationKey do
+  before(:each) { RhnSatellite::ActivationKey.reset }
+  
+  describe ".all" do
+    before(:each) do
+      conn = Object.new
+      conn.stubs(:call)
+      
+      XMLRPC::Client.stubs(:new2).returns(conn)
+      
+      RhnSatellite::ActivationKey.username = 'user'
+      RhnSatellite::ActivationKey.password = 'pwd'
+      RhnSatellite::Connection::Handler.any_instance.expects(:make_call).with("auth.login",'user','pwd').returns("token")
+      RhnSatellite::Connection::Handler.any_instance.expects(:make_call).with("auth.logout",'token')
+    end
+    it "logins and returns a bunch of activation keys" do
+      RhnSatellite::Connection::Handler.any_instance.expects(:make_call).with("activationkey.listActivationKeys","token").returns(["123","234"])
+
+      RhnSatellite::ActivationKey.all.should eql(["123","234"])
+    end
+    
+    it "returns an empty array on an empty answer" do
+      RhnSatellite::Connection::Handler.any_instance.expects(:make_call).with("activationkey.listActivationKeys","token").returns(nil)
+
+      RhnSatellite::ActivationKey.all.should eql([])      
+    end
+    
+    it "iterates the items over the block" do
+      RhnSatellite::Connection::Handler.any_instance.expects(:make_call).with("activationkey.listActivationKeys","token").returns(["123","234"])
+      RhnSatellite::ActivationKey.all{|i| ["123","234"].include?(i).should be_true }.should eql(["123","234"])
+    end
+    describe ".get" do
+      context "with keys" do
+        before :each do
+          RhnSatellite::Connection::Handler.any_instance.expects(:make_call).with('activationkey.listActivationKeys',"token").returns([{'name' => "123"},{'name' => "234"}])
+        end
+        it "finds a key in all keys" do
+          RhnSatellite::ActivationKey.get('123').should eql({'name' => '123'})
+        end
+
+        it "returns nil on an non-existant key" do
+          RhnSatellite::ActivationKey.get('12333').should eql(nil)
+        end
+      end
+      context "without any keys" do
+        before :each do
+          RhnSatellite::Connection::Handler.any_instance.expects(:make_call).with('activationkey.listActivationKeys',"token").returns([])
+        end
+        it "returns nil" do
+          RhnSatellite::ActivationKey.get('12333').should eql(nil)
+        end
+      end
+    end
+  end
+end

data/spec/unit/rhn_satellite/api_spec.rb

@@ -0,0 +1,94 @@
+#! /usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe RhnSatellite::Api do
+  before(:each) { RhnSatellite::Api.reset }
+  
+  {:api_version => "getVersion", :satellite_version => "systemVersion" }.each do |m,cmd|
+    describe ".#{m.to_s}" do
+      it "gets the version and disconnects by default" do
+        conn = Object.new
+        conn.stubs(:call)
+        
+        XMLRPC::Client.expects(:new2).returns(conn)
+        RhnSatellite::Connection::Handler.any_instance.expects(:make_call).with("api.#{cmd}").returns("2.0")
+        
+        RhnSatellite::Api.send(m).should eql("2.0")
+        RhnSatellite::Api.send(:base).connected?.should eql(false)
+      end
+      
+      it "caches the version" do
+        conn = Object.new
+        conn.stubs(:call)
+        
+        XMLRPC::Client.expects(:new2).returns(conn)
+        RhnSatellite::Connection::Handler.any_instance.expects(:make_call).with("api.#{cmd}").once.returns("2.0")
+        
+        RhnSatellite::Api.send(m).should eql("2.0")
+        RhnSatellite::Api.send(m).should eql("2.0")
+        RhnSatellite::Api.send(:base).connected?.should eql(false)
+      end
+      
+      it "does not disconnect if told so" do
+        conn = Object.new
+        conn.stubs(:call)
+        
+        XMLRPC::Client.expects(:new2).returns(conn)
+        RhnSatellite::Connection::Handler.any_instance.expects(:make_call).with("api.#{cmd}").returns("2.0")
+        
+        RhnSatellite::Connection::Handler.any_instance.expects(:disconnect).never
+        
+        RhnSatellite::Api.send(m,false).should eql("2.0")
+        RhnSatellite::Api.send(:base).connected?.should eql(true)
+      end
+    end
+  end
+  describe ".reset" do
+    it "resets the versions" do
+      conn = Object.new
+      conn.stubs(:call)
+      
+      XMLRPC::Client.stubs(:new2).returns(conn)
+      RhnSatellite::Connection::Handler.any_instance.expects(:make_call).with("api.getVersion").returns("2.0")
+      RhnSatellite::Connection::Handler.any_instance.expects(:make_call).with("api.systemVersion").returns("2.0")
+      
+      RhnSatellite::Api.api_version.should eql("2.0")
+      RhnSatellite::Api.satellite_version.should eql("2.0")
+      
+      RhnSatellite::Api.reset
+      
+      RhnSatellite::Api.instance_variable_get("@api_version").should be_nil
+      RhnSatellite::Api.instance_variable_get("@satellite_version").should be_nil
+    end
+  end
+  
+  describe ".test_connection" do
+    it "runs a test login and logout" do
+      conn = Object.new
+      conn.stubs(:call)
+      
+      XMLRPC::Client.stubs(:new2).returns(conn)
+      
+      RhnSatellite::Api.username = 'user'
+      RhnSatellite::Api.password = 'pwd'
+      RhnSatellite::Connection::Handler.any_instance.expects(:make_call).with("auth.login",'user','pwd').returns("token")
+      RhnSatellite::Connection::Handler.any_instance.expects(:make_call).with("auth.logout",'token')
+      
+      RhnSatellite::Api.test_connection.should eql(true)
+    end
+
+    it "runs a test login and logout with a dediacted user and pwd" do
+      conn = Object.new
+      conn.stubs(:call)
+      
+      XMLRPC::Client.stubs(:new2).returns(conn)
+      
+      RhnSatellite::Api.username = 'user'
+      RhnSatellite::Api.password = 'pwd'
+      RhnSatellite::Connection::Handler.any_instance.expects(:make_call).with("auth.login",'user2','pwd2').returns("token")
+      RhnSatellite::Connection::Handler.any_instance.expects(:make_call).with("auth.logout",'token')
+      
+      RhnSatellite::Api.test_connection('user2','pwd2').should eql(true)
+    end
+  end
+end