enhancerepo 0.4.1 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '0286c73b863193259c5ff0c0bd832637144d4e11'
+  data.tar.gz: 00b9f1514ec31b3cf26b6b7d78bbe86e195c6008
+SHA512:
+  metadata.gz: 5a804dab6d6265dff84730925a4e89e6958bf1a5e8766c9a4bcfe4471c866e462f252e117913a76b329f219a12b1aa409177c5428630435e6639428617ce39d3
+  data.tar.gz: a98bbf20cddc4426a94c6d7fcca65b1cd8c00e8b5d41bcdc4a9af99f438c45e4dc8b6e4e524e48edcaa861ee7eedeb4b64bb7080c3ba31759cb030f541c02ba9

data/README.md

@@ -0,0 +1,27 @@
+
+# enhancerepo
+
+![reviving](https://img.shields.io/badge/stability-reviving-yellow.svg)
+![maintained](https://img.shields.io/maintenance/yes/2014.svg)
+[![Build Status](https://travis-ci.org/openSUSE/enhancerepo.svg?branch=master)](https://travis-ci.org/openSUSE/enhancerepo)
+
+* http://en.opensuse.org/Enhancerepo
+
+## Introduction
+
+Reference implementation for future rpmmd extensions.
+
+requires ruby-rpm.
+
+## TODO
+
+- [ ] give some love to rpm-ffi to supress warnings
+- [ ] cleanup rubocop issues (see .rubocop_todo.yml)
+- [ ] re-do rpm package
+- [ ] get rid of ActiveSupport
+- [ ] refactor CLI (may be subcommands)
+
+## Authors
+
+* Duncan Mac-Vicar P. <dmacvicar@suse.de>
+

data/bin/enhancerepo

@@ -1,4 +1,3 @@
 #!/usr/bin/env ruby
-$: << '../lib' 
-$: << 'lib'
-require 'enhance_repo/cli.rb'
+$LOAD_PATH.push(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'enhance_repo/cli'

data/lib/enhance_repo.rb

@@ -1,5 +1,7 @@
+# Encoding: utf-8
+
 #--
-# 
+#
 # enhancerepo is a rpm-md repository metadata tool.
 # Copyright (C) 2008, 2009 Novell Inc.
 # Author: Duncan Mac-Vicar P. <dmacvicar@suse.de>
@@ -22,15 +24,8 @@
 #
 #++
 #
-module EnhanceRepo
-  VERSION = "0.4.1"
-end
-
-lib = File.dirname(__FILE__)
-
-require File.join(lib, 'enhance_repo', 'logger.rb')
-require File.join(lib, 'enhance_repo', 'config_opts.rb')
-require File.join(lib, 'enhance_repo', 'rpm_md.rb')
-
-
-  
+require 'enhance_repo/version'
+require 'enhance_repo/logger'
+require 'enhance_repo/config_opts'
+require 'enhance_repo/rpm_md'
+require 'enhance_repo/array_arg'

data/lib/enhance_repo/array_arg.rb

@@ -0,0 +1,85 @@
+# Encoding: utf-8
+
+#--
+#
+# enhancerepo is a rpm-md repository metadata tool.
+# Copyright (C) 2008, 2009 Novell Inc.
+# Author: Duncan Mac-Vicar P. <dmacvicar@suse.de>
+#
+# 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; either version 2 of the License, or
+# (at your option) any later version.
+#
+# 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.
+#
+#++
+#
+module EnhanceRepo
+  # Helper class to turn an array like:
+  # ['a', 'b', '/foo/file.txt', 'd'] into an
+  # array containing the content of file.txt
+  # (each line) merged into the place of the
+  # file name
+  #
+  class ArrayArg
+    include Enumerable
+
+    # initialize the wrapper with an array
+    def initialize(array)
+      @array = array
+      @array ||= []
+      @expanded_cache = nil
+    end
+
+    # yields one element per line in
+    # the file
+    def expand_file(file)
+      ret = []
+      File.open(file) do |f|
+        f.each_line do |line|
+          stripped_line = line.strip
+          ret << stripped_line unless stripped_line.empty?
+        end
+      end
+      ret
+    end
+
+    # expand the wrapped array with fles
+    def expanded
+      return @expanded_cache if @expanded_cache
+      ret = []
+      @array.each do |element|
+        if File.exist?(element) && !File.directory?(element)
+          EnhanceRepo.logger.info "Expanding the content of file '#{element}'..."
+          ret += expand_file(element)
+        else
+          ret << element
+        end
+      end
+      @expanded_cache = ret
+      ret
+    end
+
+    # delegate other methods to the expanded array
+    def method_missing(method, *args)
+      each.to_a.send(method, *args)
+    end
+
+    # see Enumerable
+    def each
+      return enum_for(:each) unless block_given?
+      expanded.each { |x| yield x }
+      self
+    end
+  end
+end

data/lib/enhance_repo/cli.rb

@@ -1,5 +1,7 @@
+# Encoding: utf-8
+
 #--
-# 
+#
 # enhancerepo is a rpm-md repository metadata tool.
 # Copyright (C) 2008, 2009 Novell Inc.
 # Author: Duncan Mac-Vicar P. <dmacvicar@suse.de>
@@ -22,76 +24,14 @@
 #
 #++
 #
-require 'rubygems'
-require 'trollop'
-require 'enhance_repo'
 require 'pathname'
 require 'benchmark'
 require 'fileutils'
+require 'enhance_repo'
 
-EnhanceRepo::enable_logger
-
-opts = Trollop::options do
-  version "enhancerepo #{EnhanceRepo::VERSION}"
-  banner <<-EOS
-enhancerepo is a rpm-md metadata tool
-
-Usage:
-        enhancerepo [options] DIR
-
-        DIR: The repo base directory ( where repodata/ directory is located )
-EOS
-  opt :help, 'Show help'
-  opt :outputdir, 'Generate metadata to a different directory', :short => :o
-  opt :index, "Reindex the metadata and regenerates repomd.xml, even if nothing was changed using enhancerepo. Use this if you did manual changes to the metadata", :short => :x
-  opt :benchmark, 'Show benchmark statistics at the end'
-  
-  opt :primary, 'Add data from rpm files and generate primary.xml (EXPERIMENTAL)', :short => :p
-  opt :sign, 'Generates signature for the repository using key keyid', :short => :s, :type => :string
-  opt :updates, 'Add updates from *.updates files and generate updateinfo.xml', :short => :u
-  opt :generate_update, 'Generates an update from the given package list comparing package\'s last version changes', :type => :strings
-  opt :updates_base_dir, 'Looks for package also in <dir> Useful if you keep old packages in a different repos and updates in this one.', :type => :string
-  opt :split_updates, 'Splits current updateinfo.xml into update parts files in repoparts/'
-  opt :indent, 'Generate indented xml. Default: no', :short => :i
-  
-  opt :expire, 'Set repository expiration hint (Can be used to detect dead mirrors)', :type => :date, :short => :e
-  opt :repo_product, 'Adds product compatibility information', :type => :strings
-  opt :repo_keyword, 'Tags repository with keyword', :type => :strings
-
-  # === SUSE specific package data (susedata.xml)
-  
-  opt :eulas, 'Reads packagename.eula files and add the information to susedata.xml', :short => :l
-  opt :keywords, 'Reads packagename.keywords files and add keyword metadata to susedata.xml', :short => :k
-  opt :disk_usage, 'Reads rpm packages, generates disk usage information on susedata.xml', :short => :d
-
-  # Note: your .eula or .keywords file will be added to
-  # a package if it matches its name. If you want to add
-  # the attributes to a specific package, name the file
-  # name-version, name-version-release or
-  # name-version-release.arch
-
-  # === Package deltas support
-  opt :'create-deltas',
-      'Create [num] deltas for different versions of a package. If there is foo-1.rpm, foo-2.rpm, foo-3.rpm, foo-4.rpm num=1 will create a delta to go from version 3 to 4, while num=2 will create one from 2 to 4 too. This does not index the deltas. Use --deltas for that.', :default => 1
-  opt :deltas, 'Reads all *.delta.rpm files and add the information to deltainfo.xml. This indexes existing deltas, but won\'t create them. See --create-deltas for deltas creation.'
-
-  # === Product information support
-
-  opt :products, 'Reads release packages and generating product information in products.xml based on the information contained in the .prod files included in the packages.'
-
-  # other
-  opt :debug, 'Show debug information'
-end
+EnhanceRepo.enable_logger
 
-config = EnhanceRepo::ConfigOpts.new(opts)
-dir = ARGV.shift
-config.dir = Pathname.new(dir) if not dir.nil?
-
-# Check if dir is given
-if config.dir.nil?
-  EnhanceRepo.logger.fatal "Missing dir argument (try --help)"
-  exit 0
-end
+config = EnhanceRepo::ConfigOpts.instance.parse_args!
 
 repomd = EnhanceRepo::RpmMd::Repo.new(config)
 
@@ -109,42 +49,47 @@ time = Benchmark.measure do
     repomd.suseinfo.products.merge(config.repoproducts)
     repomd.suseinfo.keywords.merge(config.repokeywords)
 
-    repomd.susedata.add_eulas if config.eulas  
+    repomd.susedata.add_eulas if config.eulas
     repomd.susedata.add_keywords if config.keywords
     repomd.susedata.add_disk_usage if config.diskusage
 
-    if not config.generate_update.nil?
-      repomd.updateinfo.generate_update(config.generate_update, File.join(config.outputdir, 'repoparts') )
+    unless config.generate_update.nil?
+      repomd.updateinfo.generate_update(config.generate_update, File.join(config.outputdir, 'repoparts'))
     end
 
-    repomd.updateinfo.read_repoparts if config.updates  
-    repomd.updateinfo.split_updates(File.join(config.outputdir, 'repoparts')) if config.split_updates                                                                        
+    repomd.updateinfo.read_repoparts if config.updates
+    repomd.updateinfo.split_updates(File.join(config.outputdir, 'repoparts')) if config.split_updates
+
+    repomd.patterns.split_patterns(File.join(config.outputdir, 'repoparts')) if config.split_patterns
+    unless config.generate_patterns.nil?
+      repomd.patterns.generate_patterns(config.generate_patterns, File.join(config.outputdir, 'repoparts'))
+    end
+    repomd.patterns.read_repoparts if config.patterns || !config.generate_patterns.nil?
 
-    repomd.deltainfo.create_deltas(:outputdir => config.outputdir, :n => config.create_deltas) if config.create_deltas
+    repomd.deltainfo.create_deltas(outputdir: config.outputdir, n: config.create_deltas) if config.create_deltas
     repomd.deltainfo.add_deltas if config.deltas
 
     repomd.products.read_packages if config.products
 
     # add expiration date
-    repomd.suseinfo.expire = config.expire if not config.expire.nil?
+    repomd.suseinfo.expire = config.expire unless config.expire.nil?
 
     # index if requested
     repomd.index if config.index
-    
+
     # write the repository out
     repomd.write
 
     # perform signature of the repository
-    repomd.sign(config.signkey) if not config.signkey.nil?  
+    repomd.sign(config.signkey) unless config.signkey.nil?
   rescue Exception => excp
     EnhanceRepo.logger.fatal excp.message
-    if EnhanceRepo::enable_debug
+    if EnhanceRepo.enable_debug
       EnhanceRepo.logger.fatal excp.class
       EnhanceRepo.logger.fatal(excp.backtrace.join("\n"))
     else
-      EnhanceRepo.logger.info "Pass --debug for more information..."
+      EnhanceRepo.logger.info 'Pass --debug for more information...'
     end
   end
-
 end
 EnhanceRepo.logger.info(time) if config.benchmark

data/lib/enhance_repo/config_opts.rb

@@ -1,5 +1,7 @@
+# Encoding: utf-8
+
 #--
-# 
+#
 # enhancerepo is a rpm-md repository metadata tool.
 # Copyright (C) 2008, 2009 Novell Inc.
 # Author: Duncan Mac-Vicar P. <dmacvicar@suse.de>
@@ -22,16 +24,130 @@
 #
 #++
 #
+require 'digest'
 require 'set'
+require 'trollop'
+require 'enhance_repo/array_arg'
+require 'singleton'
 
 module EnhanceRepo
-  
   # Configuration class to hold the options
   # passed from the command line to the
   # components doing the work
   #
 
   class ConfigOpts
+    include Singleton
+    include Logger
+
+    def read_command_line
+      opts = Trollop.options do
+        version "enhancerepo #{EnhanceRepo::VERSION}"
+        banner <<-EOS
+enhancerepo is a rpm-md metadata tool
+
+Usage:
+        enhancerepo [options] DIR
+
+        DIR: The repo base directory ( where repodata/ directory is located )
+
+EOS
+        opt :help, 'Show help'
+        opt :outputdir, 'Generate metadata to a different directory',
+            short: :o, type: :string
+        opt :index, "Reindex the metadata and regenerates repomd.xml, '\
+            'even if nothing was changed using enhancerepo.'\
+            ' Use this if you did manual changes to the metadata",
+            short: :x
+        opt :benchmark, 'Show benchmark statistics at the end'
+
+        opt :primary, 'Add data from rpm files and generate primary.xml (EXPERIMENTAL)',
+            short: :p
+        opt :sign, 'Generates signature for the repository using key keyid',
+            short: :s, type: :string
+        opt :updates, 'Add updates from *.updates files and generate updateinfo.xml',
+            short: :u
+        opt :generate_update, 'Generates an update from the given package list'\
+            ' comparing package\'s last version changes',
+            type: :strings
+        opt :updates_base_dir, 'Looks for package also in <dir> Useful if you'\
+            ' keep old packages in a different repos and updates in this one.',
+            type: :string
+        opt :split_updates, 'Splits current updateinfo.xml into update parts'\
+            ' files in repoparts/'
+        opt :indent, 'Generate indented xml. Default: no',
+            short: :i
+
+        opt :expire, 'Set repository expiration hint (Can be used to detect dead mirrors)',
+            type: :date, short: :e
+        opt :repo_product, 'Adds product compatibility information',
+            type: :strings
+        opt :repo_keyword, 'Tags repository with keyword',
+            type: :strings
+
+        opt :digest_type, 'Algorithm used to compute the digests. Default SHA1',
+            type: :string
+
+        # === SUSE specific package data (susedata.xml)
+
+        opt :eulas,
+            'Reads packagename.eula files and add the information to susedata.xml',
+            short: :l
+        opt :keywords,
+            'Reads packagename.keywords files and add keyword metadata to susedata.xml',
+            short: :k
+        opt :disk_usage,
+            'Reads rpm packages, generates disk usage information on susedata.xml',
+            short: :d
+
+        # Note: your .eula or .keywords file will be added to
+        # a package if it matches its name. If you want to add
+        # the attributes to a specific package, name the file
+        # name-version, name-version-release or
+        # name-version-release.arch
+
+        # === Package deltas support
+        opt :'create-deltas',
+            'Create [num] deltas for different versions of a package.'\
+            ' If there is foo-1.rpm, foo-2.rpm, foo-3.rpm, '\
+            'foo-4.rpm num=1 will create a delta to go from'\
+            ' version 3 to 4, while num=2 will create one from'\
+            ' 2 to 4 too. This does not index the deltas.'\
+            ' Use --deltas for that.',
+            default: 1
+        opt :deltas,
+            'Reads all *.delta.rpm files and add the information'\
+            ' to deltainfo.xml. This indexes existing deltas, but'\
+            ' won\'t create them. See --create-deltas for deltas'\
+            'creation.'
+
+        # === Product information support
+
+        opt :products,
+            'Reads release packages and generating product'\
+            ' information in products.xml based on the information'\
+            ' contained in the .prod files included in the packages.'
+
+        # === Pattern information support
+
+        opt :patterns,
+            'Add patterns from pattern-*.xml files and generate'\
+            ' patterns.xml',
+            short: :P
+        opt :generate_patterns,
+            'Generate patterns.xml from the old style'\
+            ' pattern given as parameter to this option',
+            type: :strings
+        opt :split_patterns,
+            'Splits current patterns.xml into pattern'\
+            ' parts files in repoparts/'
+
+        # other
+        opt :debug, 'Show debug information'
+      end
+      opts
+    end
+
     attr_accessor :index
     attr_accessor :indent
     attr_accessor :repoproducts
@@ -59,40 +175,118 @@ module EnhanceRepo
     attr_accessor :products
 
     attr_accessor :benchmark
-    
+
+    attr_accessor :patterns
+    attr_accessor :generate_patterns
+    attr_accessor :split_patterns
+    attr_accessor :digest_name, :digest_class
+
     def outputdir
       return @dir if @outputdir.nil?
-      return @outputdir
+      @outputdir
+    end
 
+    def initialize
+      @digest_name, @digest_class = allocate_digest(nil)
     end
-    
-    def initialize(opts)
+
+    def parse_args!
       @repoproducts = Set.new
       @repokeywords = Set.new
+      opts = read_command_line
       read_opts(opts)
+
+      unless @dir
+        @dir = ARGV.shift
+        Trollop.die 'Need to specify target directory.' unless @dir
+      end
+
+      if !File.exist?(@dir) || !File.directory?(@dir)
+        Trollop.die "'#{@dir}' is not a valid directory."
+      end
+      if !File.directory?(File.join(@dir, 'repodata')) && !(opts[:primary] || opts[:help])
+        Trollop.die "'#{@dir}' is not a valid repository directory"
+      end
+      # dump
+      self
     end
-    
+
     def read_opts(opts)
       @index = opts[:index]
       @expire = opts[:expire]
       @primary = opts[:primary]
-      @repoproducts = @repoproducts.merge([*opts[:repo_products]])
-      @repokeywords = @repokeywords.merge([*opts[:repo_keywords]])
+      @repoproducts = @repoproducts.merge([*ArrayArg.new(opts[:repo_products])]) if opts[:repo_products]
+      @repokeywords = @repokeywords.merge([*ArrayArg.new(opts[:repo_keywords])]) if opts[:repo_keywords]
       @signkey = opts[:sign]
       @updates = opts[:updates]
       @split_updates = opts[:split_updates]
-      @generate_update = opts[:generate_update]
+      @generate_update = ArrayArg.new(opts[:generate_update]) if opts[:generate_update]
       @eulas = opts[:eulas]
       @keywords = opts[:keywords]
       @diskusage = opts[:disk_usage]
       @deltas = opts[:deltas]
       @create_deltas = opts[:create_deltas]
       @products = opts[:products]
-      @benchmark = opts[:benchmark]      
+      @benchmark = opts[:benchmark]
+      @patterns = opts[:patterns]
+      @split_patterns = opts[:split_patterns]
+      @generate_patterns = Array.new(opts[:generate_patterns]) if opts[:generate_patterns]
       @updatesbasedir = Pathname.new(opts[:updates_base_dir]) if opts[:updates_base_dir]
       @outputdir = Pathname.new(opts[:outputdir]) if opts[:outputdir]
-      @dir = Pathname.new(opts[:dir]) if opts[:dir]
+      @digest_name, @digest_class = allocate_digest(opts[:digest_type])
+    end
+
+    def dump
+      logger = EnhanceRepo.logger
+
+      logger.info "index #{@index}"
+      logger.info "expire #{@expire}"
+      logger.info "primary #{@primary}"
+      logger.info "repoproducts #{@repoproducts}"
+      logger.info "repokeywords #{@repokeywords}"
+      logger.info "signkey #{@signkey}"
+      logger.info "updates #{@updates}"
+      logger.info "split_updates #{@split_updates}"
+      logger.info "generate_update #{@generate_update}"
+      logger.info "eulas #{@eulas}"
+      logger.info "keywords #{@keywords}"
+      logger.info "diskusage #{@diskusage}"
+      logger.info "deltas #{@deltas}"
+      logger.info "create_deltas #{@create_deltas}"
+      logger.info "products #{@products}"
+      logger.info "benchmark #{@benchmark}"
+      logger.info "patterns #{@patterns}"
+      logger.info "split_patterns #{@split_patterns}"
+      unless @generate_patterns.nil?
+        @generate_patterns.each do |p|
+          logger.info "generate_patterns #{p}"
+        end
+      end
+      logger.info "updatesbasedir #{@updatesbasedir}"
+      logger.info "outputdir #{@outputdir}"
+      logger.info "dir #{@dir}"
+    end
+
+    private
+
+    def allocate_digest(digest_name)
+      return ['sha', Digest::SHA1] unless digest_name
+
+      valid_names = %w[sha sha1 sha2 sha256 md5]
+      unless valid_names.include?(digest_name.downcase)
+        warn "Invalid digest type #{digest_name}"
+        warn "Accepted types: #{valid_names.join(', ')}"
+        exit 1
+      end
+
+      case digest_name.downcase
+      when /^(sha2|sha256)$/
+        ['sha256', Digest::SHA2]
+      when /^(sha|sha1)$/
+        ['sha', Digest::SHA1]
+      when 'md5'
+        ['md5', Digest::MD5]
+      end
     end
-    
   end
 end