zypper 0.2.2 → 0.3.0

data/CHANGELOG

@@ -1,3 +1,11 @@
+0.3.0
+-----
+* Extended testsuites
+* Project moved to openSUSE/rubygem-zypper at GitHub
+* Using Nori (with Nokogiri) to parse the XML output
+* Speedup improvements
+* New Package::updates method
+
 0.2.2
 -----
 * Fixed last_exit_status method and thus all methods returning boolean

data/README.markdown

@@ -121,8 +121,8 @@ zypper.repositories.all
 
 # returns
 [
-  { "enabled"=>"1", "autorefresh"=>"1", "name"=>"SLES11-SP1-x68_64", "url"=>["http://repo/URI"],
-    "type"=>"rpm-md", "alias"=>"repository_alias", "gpgcheck"=>"1" },
+  { "enabled"=>true, "autorefresh"=>true, "name"=>"SLES11-SP1-x68_64", "url"=>["http://repo/URI"],
+    "type"=>"rpm-md", "alias"=>"repository_alias", "gpgcheck"=>true },
   { ... },
   ...
 ]
@@ -329,6 +329,26 @@ zypper.package.installed?(:package => 'package')
 true or false
 ```
 
+#### Package Updates ####
+
+Returns list of packages that could be updated (with higher version available).
+
+```ruby
+zypper.packages.updates
+
+# returns e.g.
+[
+  ...
+  {:source=>{:url=>"http://download.opensuse.org/update/12.1/", :alias=>"openSUSE_12.1_Updates"},
+   :summary=>"Utilities to query and test DNS  ", :license=>nil, :description=>"This package
+   includes the utilities host, dig, and nslookup used to\ntest and query the Domain Name System
+   (DNS).  The Berkeley Internet\nName Domain (BIND) DNS server is found in the package named bind.",
+   :edition=>"9.8.3P1-4.14.1", :name=>"bind-utils", :kind=>"package", :arch=>"x86_64"
+  },
+  ...
+]
+```
+
 ### Patches ###
 
 You can access the patches class either with

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/lib/zypper/package.rb

@@ -1,8 +1,7 @@
-require 'zypper/utils'
+require 'zypper/update'
 
 class Zypper
-  class Package
-    include ZypperUtils
+  class Package < Update
 
     class Status
       INSTALLED = :installed
@@ -63,6 +62,11 @@ class Zypper
       find(options.merge(:status => Status::AVAILABLE))
     end
 
+    # Finds all package updates
+    def updates(options = {})
+      find_updates(options.merge(:type => :package))
+    end
+
     private
 
     def status(status)
@@ -71,30 +75,29 @@ class Zypper
       raise "Unknown package status '#{status}'"
     end
 
-    # SLE11 zypper doesn't support XML output for packages
-    # FIXME: merge with 'convert_patches'
+    # SLE11 zypper doesn't support XML output for packages yet
     def convert_packages(packages)
       out = []
-      table_index = 0
+      table_header_lines = 3
       package = {}
 
-      packages.split("\n").each {|line|
-        table_index = table_index + 1
-        # Skip the first two - table header
-        next if table_index < 3
+      for line in packages.split("\n")
+        # Skip the table header
+        if table_header_lines > 0
+          table_header_lines = table_header_lines - 1
+          next
+        end
 
-        line.gsub!(/ +\| +/, '|')
-        line.gsub!(/^ +/, '')
-        line.gsub!(/ +$/, '')
-        package = line.split '|'
+        line.strip!
+        package = line.split(%r{ *\| *})
 
-        out.push(
+        out << {
           :status  => status(package[0]),
           :name    => package[1],
           :summary => package[2],
           :type    => package[3]
-        )
-      }
+        }
+      end
 
       out
     end

data/lib/zypper/patch.rb

@@ -1,11 +1,12 @@
-require 'zypper/utils'
+require 'zypper/update'
 
 class Zypper
-  class Patch
+  class Patch < Update
+
     class Status
-      NEEDED         = 'Needed'
-      INSTALLED      = 'Installed'
-      NOT_APPLICABLE = 'Not Applicable'
+      NEEDED         = 'needed'
+      INSTALLED      = 'applied'
+      NOT_APPLICABLE = 'not-needed'
     end
 
     class Category
@@ -15,9 +16,8 @@ class Zypper
       OPTIONAL    = 'optional'
     end
 
-    include ZypperUtils
-
-    FILTER_OPTIONS = [:repository, :name, :version, :category, :status]
+    FILTER_OPTIONS = [:name, :edition, :arch, :category, :status, :pkgmanager,
+                      :restart, :interactive, :repository_url, :repository_alias]
 
     # Lists all patches
     #
@@ -27,18 +27,14 @@ class Zypper
     #        Logical AND is always applied for all the options present
     #
     # @example
-    #   all(:status => 'Installed')
+    #   find(:status => Zypper::Patch::Status::INSTALLED)
     def find(options = {})
-      additional_options = {:quiet => true}
-
-      if (run(build_command('patches', options.merge(additional_options))))
-        apply_filters(convert_patches(last_message), options)
-      end
+      apply_filters(find_updates(options.merge(:type => :patch)), options)
     end
 
     # Lists all known patches
     def all(options = {})
-      find
+      find(options)
     end
 
     # All applicable patches
@@ -64,47 +60,27 @@ class Zypper
 
     private
 
-    # Current libzypp doesn't support XML output for patches
-    def convert_patches(patches)
-      out = []
-      table_index = 0
-      patch = {}
-
-      patches.split("\n").each {|line|
-        table_index = table_index + 1
-        # Skip the first two - table header
-        next if table_index < 3
-
-        line.gsub!(/ +\| +/, '|')
-        line.gsub!(/^ +/, '')
-        line.gsub!(/ +$/, '')
-        patch = line.split '|'
-
-        out.push(
-          :repository => patch[0],
-          :name       => patch[1],
-          :version    => patch[2],
-          :category   => patch[3],
-          :status     => patch[4]
-        )
-      }
-
-      out
-    end
-
     # Filters patches according to given parameters
     #
     # @param (Array) patches
-    # @param (Hash)  filters criteria, possible keys are :repository, :name, :version, :category and :status
+    # @param (Hash)  filters criteria, possible keys are :name, :edition, :arch, :category, :status,
+    #                :pkgmanager, :restart, :interactive, :repository_url, :repository_alias
     #
     # @example
-    #   apply_patch_filters(patches, { :status => 'Needed' })
-    #   apply_patch_filters(patches, { :version' => '1887', :repository => 'SLES11-SP1-Update' })
+    #   apply_patch_filters(patches, { :status => 'needed' })
+    #   apply_patch_filters(patches, { :edition => '1887', ... })
     def apply_filters(patches = [], filters = {})
       filters.each {|filter_key, filter_value|
         raise "Unknown filter parameter '#{filter_key}'" unless FILTER_OPTIONS.include? filter_key
 
-        patches = patches.select{|patch| patch[filter_key] == filter_value}
+        case filter_key
+          when :repository_url
+            patches = patches.select{|patch| patch[:source][:url] == filter_value}
+          when :repository_alias
+            patches = patches.select{|patch| patch[:source][:alias] == filter_value}
+          else
+            patches = patches.select{|patch| patch[filter_key] == filter_value}
+        end
       }
       patches
     end

data/lib/zypper/repository.rb

@@ -15,7 +15,7 @@ class Zypper
     # Lists all known repositories
     def all(options = {})
       out = xml_run build_command('repos', options.merge(:get => XML_COMMANDS_GET))
-      out.fetch('repo-list', []).fetch(0, {}).fetch('repo', [])
+      convert_output(out.fetch(:stream, {}).fetch(:repo_list, {}).fetch(:repo, []), :repo)
     end
 
     # Adds a new repository defined by options

data/lib/zypper/service.rb

@@ -12,7 +12,7 @@ class Zypper
     # Lists all known services
     def all(options = {})
       out = xml_run build_command('services', options.merge(:get => XML_COMMANDS_GET))
-      out.fetch('service-list', []).fetch(0, {}).fetch('service', [])
+      convert_output(out.fetch(:stream, {}).fetch(:service_list, {}).fetch(:service, []), :service)
     end
 
   end

data/lib/zypper/update.rb

@@ -0,0 +1,25 @@
+require 'zypper/utils'
+
+class Zypper
+  class Update
+    include ZypperUtils
+
+    KNOWN_TYPES = [:patch, :package, :pattern, :product]
+
+    DEFALUT_TYPE = :patch
+
+    # Lists all known updates
+    def find_updates(options = {})
+      options[:type] = DEFALUT_TYPE if options[:type].nil?
+      # FIXME: check allowed types
+
+      additional_options = {:quiet => true, :get => XML_COMMANDS_GET, :type => options[:type].to_s}
+
+      out = xml_run build_command('list-updates', options.merge(additional_options))
+
+      convert_output(out.fetch(:stream, {}).fetch(:update_status, {}).fetch(:update_list, {}).fetch(:update, []), options[:type])
+      # FIXME: implement filters
+    end
+
+  end
+end

data/lib/zypper/utils.rb

@@ -2,12 +2,57 @@ module ZypperUtils
   require 'rubygems'
   require 'shellwords'
   require 'popen4'
-  require 'xmlsimple'
+  require 'nori'
 
   require 'zypper/config'
 
   XML_COMMANDS_GET = 'xml'
 
+  PARAMS_FOR_TYPES = {
+    :patch => [
+      # ['attribute_key', :type_to_convert_to],
+      [:interactive, :boolean],
+      [:pkgmanager, :boolean],
+      [:restart, :boolean],
+    ],
+    :repo => [
+      [:autorefresh, :boolean],
+      [:gpgcheck, :boolean],
+      [:enabled, :boolean],
+    ],
+    :service => [
+      [:autorefresh, :boolean],
+      [:enabled, :boolean],
+      # Treat :repo entry as :repo subitem
+      [:repo, :subitem],
+    ],
+  }
+
+  Nori.parser = :nokogiri
+  Nori.advanced_typecasting = false
+
+  ATTRIBUTE_STARTS_WITH = '@'[0]
+
+  tag_to_sym = {}
+
+  Nori.configure do |config|
+    config.convert_tags_to { |tag|
+      if (tag_to_sym.has_key?(tag))
+        tag_to_sym[tag]
+      else
+        old_tag = tag.dup
+
+        if (tag[0] == ATTRIBUTE_STARTS_WITH)
+          # cut the '@' from the beginning of the string
+          tag.slice!(0)
+        end
+
+        tag_to_sym.store(old_tag, tag.to_sym)
+        tag_to_sym[old_tag]
+      end
+    }
+  end
+
   # Only getters are public
   attr_reader :last_message, :last_error_message, :last_exit_status, :config
 
@@ -99,53 +144,53 @@ module ZypperUtils
   # Returns string of command options depending on a given zypper command
   # combined with provided options
   def zypper_command_options(zypper_action, options = {})
-    ret_options = []
-
-    # Additional command-line options for a command
-    if options[:cmd_options]
-      ret_options = options[:cmd_options]
-    end
+    ret_options = options.fetch(:cmd_options, [])
 
     case zypper_action
       when 'refresh'
-        ret_options = [
+        ret_options = ret_options | [
           options[:force] ? '--force' : '',
           options[:force_build] ? '--force-build' : '',
         ]
       when 'addrepo'
-        ret_options = [
+        ret_options = ret_options | [
           config.refresh_repo? ? '--refresh':'',
           options[:url],
           options[:alias],
         ]
       when 'removerepo'
-        ret_options = [
+        ret_options = ret_options | [
           options[:alias],
         ]
       when 'install'
-        ret_options = [
+        ret_options = ret_options | [
           config.auto_agree_with_licenses? ? '--auto-agree-with-licenses' : '',
           escape_items(options[:packages]),
         ]
       when 'remove'
-        ret_options = [
+        ret_options = ret_options | [
           escape_items(options[:packages]),
         ]
       when 'version'
-        ret_options = [
+        ret_options = ret_options | [
           '--version',
         ]
       when 'info'
-        ret_options = [
+        ret_options = ret_options | [
           escape(options[:package]),
         ]
       when 'search'
-        ret_options = [
+        ret_options = ret_options | [
           options[:status] == Zypper::Package::Status::INSTALLED ? '--installed-only' : '',
           options[:status] == Zypper::Package::Status::AVAILABLE ? '--uninstalled-only' : '',
 
           options[:name] ? '--match-exact ' + escape(options[:name]) : '',
         ]
+      when 'list-updates'
+        ret_options = ret_options | [
+          !options[:type].nil? ? "--type #{escape(options[:type])}" : '',
+          '--all',
+        ]
     end
 
     ret_options.join(' ')
@@ -164,14 +209,7 @@ module ZypperUtils
 
   def xml_run(command)
     xml = run(command, {:get => XML_COMMANDS_GET})
-    out = XmlSimple.xml_in(xml)
-
-    if !out["message"].nil?
-      errors = out["message"].select{|hash| hash["type"] == "error"}
-      self.last_error = errors.collect{|hash| hash["content"]}.join("\n")
-    end
-
-    out
+    Nori.parse xml
   end
 
   # Runs a command given as argument and returns the full output
@@ -191,4 +229,60 @@ module ZypperUtils
     end
   end
 
+  # Whatever it gets, returns an Array
+  # Sometimes even with the only Array item if not got an Array
+  def return_array ret
+    if ret.kind_of? Array
+      ret
+    else
+      [ret]
+    end
+  end
+
+  def convert_output(parsed_stream, type)
+    out = []
+
+    params = PARAMS_FOR_TYPES.fetch(type, [])
+
+    for item in return_array(parsed_stream)
+      one_item = item
+
+      params.each do |param|
+        one_item[param[0]] = convert_entry(item[param[0]], param[0], param[1])
+      end
+
+      out << one_item
+    end
+
+    out
+  end
+
+  def convert_entry(entry, key, to_type = nil)
+    return entry unless to_type
+
+    case to_type
+      when :boolean
+        Boolean(entry)
+      when :subitem
+        convert_output(entry, key)
+      else
+        entry
+    end
+  end
+
+  def boolean_nocache(string)
+    return false unless string
+    return true if string == true || string =~ (/(true|t|yes|y|1)$/i)
+    return false if string == false || string.nil? || string =~ (/(false|f|no|n|0)$/i)
+    raise ArgumentError.new("invalid value for Boolean: '#{string}'")
+  end
+
+  @@boolean_cache = {}
+
+  def Boolean(string)
+    return @@boolean_cache[string] if @@boolean_cache.has_key?(string)
+
+    @@boolean_cache[string] = boolean_nocache(string)
+    @@boolean_cache[string]
+  end
 end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Lukas Ocilka
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-26 00:00:00 Z
+date: 2012-07-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: popen4
@@ -32,7 +32,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: xml-simple
+  name: nori
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -46,7 +46,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: mocha
+  name: nokogiri
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -57,10 +57,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: mocha
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -73,10 +73,26 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: |-
   Library for accessing zypper functions such as searching and
-  installing packages, adding and removing repositories and services. Supports
-  calling zypper in changed root (both with local zypper and zypper in chroot).
+  installing packages, adding and removing repositories and services, filtering
+  and applying patches.
+  Supports calling zypper in changed root (both with local zypper and zypper in
+  chroot).
 email: lukas.ocilka@gmail.com
 executables: []
 
@@ -90,6 +106,7 @@ files:
 - lib/zypper/repository.rb
 - lib/zypper/utils.rb
 - lib/zypper/package.rb
+- lib/zypper/update.rb
 - lib/zypper/patch.rb
 - lib/zypper/service.rb
 - lib/zypper/version.rb
@@ -97,7 +114,7 @@ files:
 - CHANGELOG
 - README.markdown
 - VERSION
-homepage: https://github.com/kobliha/zypper
+homepage: https://github.com/openSUSE/rubygem-zypper
 licenses: 
 - MIT
 post_install_message: