solaris-prototype 1.0.0

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright 2011 Martin Carpenter. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY Martin Carpenter ``AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Martin Carpenter OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those of the
+authors and should not be interpreted as representing official policies, either expressed
+or implied, of Martin Carpenter.
+

data/README.rdoc

@@ -0,0 +1,27 @@
+
+= solaris-prototype
+
+Author:: Martin Carpenter
+Email:: mcarpenter@free.fr
+Copyright:: Copyright (c) Martin Carpenter 2011
+
+== About
+
+The solaris-prototype gem helps with the manipulation of SunOS and Solaris
+prototype entries for SysV packages.
+
+== Examples
+
+=== Prepare a prototype for installation as another user
+
+    p = Solaris::Prototype.from_path './usr/local/bin/foo'
+    p.to_s
+      => "f none ./usr/local/bin/foo 0755 martin staff"
+    p.owner = 'root'
+    p.group = 'sys'
+    p.to_s
+      => "f none ./usr/local/bin/foo 0755 root sys"
+    p.pathname = "/usr/local/bin/foo=./usr/local/bin/foo"
+      => "f none /usr/local/bin/foo=./usr/local/bin/foo 0755 root sys"
+  
+This can then be fed into pkgmk(1M).

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'rubygems/package_task'
+
+desc 'Default task (package)'
+task :default => [:package]
+
+Rake::TestTask.new( 'test' )
+
+SPECFILE = 'solaris-prototype.gemspec'
+if File.exist?( SPECFILE )
+  spec = eval( File.read( SPECFILE ) )
+  #Rake::GemPackageTask.new( spec ).define
+  Gem::PackageTask.new( spec ).define
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'solaris-prototype'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.options << '--all'
+  rdoc.rdoc_files.include( 'README.rdoc' )
+  rdoc.rdoc_files.include( FileList[ 'lib/**/*' ] )
+  rdoc.rdoc_files.include( FileList[ 'test/**/*' ] )
+end
+

data/lib/solaris.rb

@@ -0,0 +1,8 @@
+
+# Namespace for child classes.
+module Solaris
+
+  require 'solaris/prototype'
+
+end # Solaris
+

data/lib/solaris/prototype.rb

@@ -0,0 +1,183 @@
+
+require 'etc'
+
+module Solaris
+
+  # Class to represent Solaris package file prototypes.
+  # A prototype line contains information regarding file
+  # type, location, ownership, permisions.
+  #
+  # See Solaris' prototype(4) man-page for information on
+  # attributes.
+  #
+  # This class does not support special lines (those
+  # beginning with !), pathname variable substitution or
+  # prototype parts.
+  class Prototype
+
+    attr_accessor :part
+    attr_accessor :ftype
+    attr_accessor :install_class
+    attr_accessor :pathname
+    attr_accessor :major
+    attr_accessor :minor
+    attr_accessor :mode
+    attr_accessor :owner
+    attr_accessor :group
+
+    # Install class to use if not specified.
+    DEFAULT_INSTALL_CLASS = 'none'
+
+    # Part to use if not specified. Solaris 10 documentation
+    # for prototype(4) states that no part given implies
+    # "part 1".
+    DEFAULT_PART = nil
+
+    # Regular expression for filetype.
+    RE_FTYPE = '([bcdefpvxils])'
+
+    # Regular expression for install class.
+    RE_INSTALL_CLASS = '(\w{1,12})'
+
+    # Regular expression for path.
+    RE_PATH = '(\S+)'
+
+    # Regular expression for major device mode.
+    RE_MAJOR = '(\d+)'
+
+    # Regular expression for minor device mode.
+    RE_MINOR = '(\d+)'
+
+    # Regular expression for octal file mode.
+    RE_MODE = '([0-7]{4})'
+
+    # Regular expression for user name.
+    RE_OWNER = '(\S+)'
+
+    # Regular expression for group name.
+    RE_GROUP = '(\S+)'
+
+    # Create a Prototype object from a line from a prototype(4) file.
+    def self.from_line(line)
+      ftype = $1.to_sym if line =~ /^#{RE_FTYPE} /
+        re = case ftype
+             when :b, :c
+               /^#{ftype} #{RE_INSTALL_CLASS} #{RE_PATH} #{RE_MAJOR} #{RE_MINOR} #{RE_MODE} #{RE_OWNER} #{RE_GROUP}$/
+             when :d, :e, :f, :p, :v, :x
+               /^#{ftype} #{RE_INSTALL_CLASS} #{RE_PATH} #{RE_MODE} #{RE_OWNER} #{RE_GROUP}$/
+             when :i
+               /^#{ftype} #{RE_PATH}/ # perhaps not really path
+             when :l, :s
+               /^#{ftype} #{RE_INSTALL_CLASS} #{RE_PATH}/
+             else
+               raise ArgumentError, 'Unknown filetype'
+             end
+      if line =~ re
+        proto = self.new
+        proto.ftype = ftype
+        case ftype
+        when :b, :c
+          proto.install_class = $1
+          proto.pathname =$2
+          proto.major = $3.to_i
+          proto.minor = $4.to_i
+          proto.mode = $5.to_i(8)
+          proto.owner = $6
+          proto.group = $7
+        when :d, :e, :f, :p, :v, :x
+          proto.install_class = $1
+          proto.pathname = $2
+          proto.mode = $3.to_i(8)
+          proto.owner = $4
+          proto.group = $5
+        when :i
+          proto.pathname = $1
+        when :l, :s
+          proto.install_class = $1
+          proto.pathname = $2
+        end
+      else
+        if line =~ /^!/
+          raise ArgumentError, "Prototype commands not supported #{line.inspect}"
+        else
+          raise ArgumentError, "Could not parse line #{line.inspect}"
+        end
+      end
+      proto
+    end
+
+    # Create a Prototype from the file at the +path+ on the local
+    # filesystem.
+    #
+    # If +actual+ is provided then this is the path that is used for the
+    # object's pathname property although all other properties are
+    # created from the +path+ argument. The process must be able to
+    # stat(1) the file at +path+ to determine these properties.
+    #
+    # If this object is to be fed to pkgmk(1M) to be installed at
+    # +real_location+ and the file that will be used to construct the
+    # package currently lives at +current_location+ then the second
+    # argument should take the form +real_location+=+current_location+.
+    # The first argument (+path+) is always the file from which the
+    # Prototype's properties only (eg. owner, mode) are created.
+    #
+    # For example, to take the object attributes from the already
+    # installed file in /opt/MYpkg/foo, but to subsequently package the
+    # file ./foo in that same location using pkgmk(1M) call:
+    #     from_path( '/opt/MYpkg/foo', '/opt/MYpkg/foo=./foo' )
+    def self.from_path(path, actual=nil)
+      proto = self.new
+      proto.part = DEFAULT_PART
+      # Use #lstat since we are always interested in the link source,
+      # not the target.
+      stat = File.lstat( path )
+      raise RuntimeError, 'Unknown file type' if stat.ftype == 'unknown'
+      # Stat returns "link" for symlink, not "symlink"
+      proto.ftype = stat.symlink? ? :s : stat.ftype[0].to_sym
+      proto.pathname = actual ? actual : path
+      proto.part = nil
+      proto.install_class = DEFAULT_INSTALL_CLASS
+      if [ :b, :c ].include?( proto.ftype )
+        proto.major = stat.dev_major
+        proto.minor = stat.dev_minor
+      end
+      proto.mode = stat.mode & 07777
+      proto.owner = Etc.getpwuid( stat.uid ).name
+      proto.group = Etc.getgrgid( stat.gid ).name
+      proto
+    end
+
+    # Convert the object to a prototype(4) line (string).
+    def to_s
+      ( ( @part ? [ @part ] : [] ) +
+       case @ftype
+       when :b, :c
+         [ @ftype.to_s, @install_class, @pathname, @major, @minor, '%04o' % @mode, @owner, @group ]
+       when :d, :e, :f, :p, :v, :x
+         [ @ftype.to_s, @install_class, @pathname, '%04o' % @mode, @owner, @group ]
+       when :i
+         [ @ftype.to_s, @pathname ]
+       when :l, :s
+         [ @ftype.to_s, @install_class, @pathname ]
+       else
+         raise RuntimeError, "Unknown ftype #{@ftype.inspect}"
+       end ).join(' ')
+    end
+
+    # Returns true if the object is a valid prototype specification, false
+    # otherwise.
+    def valid?
+      begin
+        self.class.from_line( to_s )
+      rescue ArgumentError, RuntimeError
+        false
+      else
+        true
+      end
+
+    end
+
+  end # Prototype
+
+end # Solaris
+

data/test/test_prototype.rb

@@ -0,0 +1,108 @@
+
+require 'test/unit'
+
+# Unit tests for Solaris::Prototype.
+class TestPrototype < Test::Unit::TestCase #:nodoc:
+
+  # These don't work on Cygwin. They might work on proper unices.
+  #def test_from_path_file
+  #  assert( Solaris::Prototype.from_path( __FILE__ ).valid? )
+  #end
+  #
+  #def test_from_path_root
+  #  assert( Solaris::Prototype.from_path( '/' ).valid? )
+  #end
+
+  def test_character_device
+    line = 'c none /dev/null 13 2 0666 root sys'
+    proto = Solaris::Prototype.from_line( line )
+    assert_equal( :c, proto.ftype )
+    assert_equal( 'none', proto.install_class )
+    assert_equal( '/dev/null', proto.pathname )
+    assert_equal( 13, proto.major )
+    assert_equal( 2, proto.minor )
+    assert_equal( 438, proto.mode )
+    assert_equal( 'root', proto.owner )
+    assert_equal( 'sys', proto.group )
+    assert( proto.valid? )
+    assert_equal( line, proto.to_s )
+  end
+
+  def test_symbolic_link
+    line = 's none /etc/hosts=./inet/hosts'
+    proto = Solaris::Prototype.from_line( line )
+    assert_equal( :s, proto.ftype )
+    assert_equal( 'none', proto.install_class )
+    assert_equal( '/etc/hosts=./inet/hosts', proto.pathname )
+    assert_equal( nil, proto.major )
+    assert_equal( nil, proto.minor )
+    assert_equal( nil, proto.mode )
+    assert_equal( nil, proto.owner )
+    assert_equal( nil, proto.group )
+    assert( proto.valid? )
+    assert_equal( line, proto.to_s )
+  end
+
+  def test_directory
+    line = 'd none /export/home/martin 0755 mcarpenter staff'
+    proto = Solaris::Prototype.from_line( line )
+    assert_equal( :d, proto.ftype )
+    assert_equal( 'none', proto.install_class )
+    assert_equal( '/export/home/martin', proto.pathname )
+    assert_equal( nil, proto.major )
+    assert_equal( nil, proto.minor )
+    assert_equal( 493, proto.mode )
+    assert_equal( 'mcarpenter', proto.owner )
+    assert_equal( 'staff', proto.group )
+    assert( proto.valid? )
+    assert_equal( line, proto.to_s )
+  end
+
+  def test_file
+    line = 'f none /export/home/martin/.profile 0755 mcarpenter staff'
+    proto = Solaris::Prototype.from_line( line )
+    assert_equal( :f, proto.ftype )
+    assert_equal( 'none', proto.install_class )
+    assert_equal( '/export/home/martin/.profile', proto.pathname )
+    assert_equal( nil, proto.major )
+    assert_equal( nil, proto.minor )
+    assert_equal( 493, proto.mode )
+    assert_equal( 'mcarpenter', proto.owner )
+    assert_equal( 'staff', proto.group )
+    assert( proto.valid? )
+    assert_equal( line, proto.to_s )
+  end
+
+  def test_part
+    line = 'f none /export/home/martin/.profile 0755 mcarpenter staff'
+    proto = Solaris::Prototype.from_line( line )
+    proto.part = 'part'
+    assert_equal( "part #{line}", proto.to_s )
+  end
+
+  def test_unknown_ftype
+    line = 'X none /export/home/martin/.profile 0755 mcarpenter staff'
+    assert_raise ArgumentError do
+      Solaris::Prototype.from_line( line )
+    end
+  end
+
+  def test_unparseable_line
+    line = 'f nonsense'
+    assert_raise ArgumentError do
+      Solaris::Prototype.from_line( line )
+    end
+  end
+
+  def test_valid
+    line = 'f none /export/home/martin/.profile 0755 mcarpenter staff'
+    proto = Solaris::Prototype.from_line( line )
+    assert( proto.valid? )
+    proto.ftype = :invalid
+    assert( ! proto.valid? )
+    proto.ftype = :d
+    assert( proto.valid? )
+  end
+
+end
+

data/test/test_solaris.rb

@@ -0,0 +1,17 @@
+
+require 'test/unit'
+require 'solaris'
+
+# Unit tests for top level require.
+class TestSolaris < Test::Unit::TestCase #:nodoc:
+
+  def test_solaris
+    assert_nothing_raised { Solaris }
+  end
+
+  def test_solaris_prototype
+    assert_nothing_raised { Solaris::Prototype }
+  end
+
+end
+

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: solaris-prototype
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Martin Carpenter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-15 00:00:00.000000000Z
+dependencies: []
+description: Parse and write Solaris package prototype records
+email: mcarpenter@free.fr
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- Rakefile
+- README.rdoc
+files:
+- lib/solaris/prototype.rb
+- lib/solaris.rb
+- test/test_solaris.rb
+- test/test_prototype.rb
+- LICENSE
+- Rakefile
+- README.rdoc
+homepage: http://mcarpenter.org/projects/solaris-prototype
+licenses:
+- BSD
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Parse and write Solaris package prototype records
+test_files:
+- test/test_solaris.rb
+- test/test_prototype.rb