etcutils 1.0.0

data/lib/etcutils.rb

@@ -0,0 +1,4 @@
+$:.unshift File.dirname(__FILE__)
+require 'etcutils/etcutils.so'
+require 'etcutils/version'
+EU = EtcUtils

data/lib/etcutils/version.rb

@@ -0,0 +1,3 @@
+module EtcUtils
+  VERSION = '1.0.0'
+end

data/tests/README

@@ -0,0 +1,141 @@
+EU Tests
+======
+
+Trying to clearly define what should be expected and where it is tested.
+
+
+test_eu_next_uid_next_gid
+  next_uid
+  next_gid
+  next_uid()
+  next_gid()
+  next_uid=
+  next_gid=
+
+test_etc_utils
+  me
+  getlogin
+  has_passwd?
+  has_shadow?
+  has_group?
+  has_gshadow?
+  setXXent
+  endXXent
+  getpwent
+  getgrent
+  find_pwd
+  setpwent
+  endpwent
+
+test_eu_sgetpwent
+  sgetpwent
+     find_pwd.to_entry = sgetpwent.to_entry
+     most field changes are allowed
+      - gecos, directory, passwd, shell
+     new entry with available UID/GID
+     new entry with unavailable/conflicting UID/GID
+     nil username should raise exception
+
+
+test_eu_locking
+  lckpwdf
+  ulckpwdf
+  lock
+  unlock
+  locked?
+  - root/locking
+      lock = locked?
+      unlock != locked?
+      block locking
+      lock exception handling
+  - user/locking
+      lock exception raised
+
+
+root/etc_utils.rb
+ |- root/shadow_tests
+   module tests
+    getspent
+    find_spwd
+    setspent
+    endspent
+    sgetspent
+    getspnam
+    fgetspent
+    putspent
+    putspent_raises for	file/type
+   class tests
+    get
+    each
+    find
+    parse
+    set
+    end
+
+ |- root/gshadow_tests
+   module tests
+    getsgent
+    find_sgrp
+    setsgent
+    endsgent
+    sgetsgent
+    getsgnam
+    fgetsgent
+    putsgent
+    putspent_raises for	file/type
+   class tests
+    get
+    each
+    find
+    parse
+    set
+    end
+    members
+    admins
+
+test_passwd_class
+   module tests
+    getpwent
+    find_pwd
+    setpwent
+    endpwent
+    sgetpwent
+    getpwnam
+    fgetpwent
+    putpwent
+    putspent_raises for	file/type
+   class tests
+    get
+    each
+    find
+    parse
+    set
+    end
+
+
+test_group_class
+   module tests
+    getgrent
+    find_grp
+    setgrent
+    endgrent
+    sgetgrent
+    getgrnam
+    fgetgrent
+    putgrent
+    putspent_raises for	file/type
+   class tests
+    get
+    each
+    find
+    parse
+    set
+    end
+    members
+
+
+## TODO
+
+ DRYIFY root/etc_utils.rb
+
+ Should raise rb_eSystemCallError if system calls fail

data/tests/etcutils_test_helper.rb

@@ -0,0 +1,8 @@
+$:.unshift File.dirname(__FILE__) + "/../lib"
+
+require 'test/unit'
+require 'etcutils'
+
+$eu_user = EtcUtils.me.uid.zero? ? "root" : "user"
+
+class Test::Unit::TestCase; include EtcUtils; end

data/tests/root/etc_utils.rb

@@ -0,0 +1,5 @@
+require 'root/shadow_tests'
+
+if EU.read_gshadow?
+  require 'root/gshadow_tests'
+end

data/tests/root/gshadow_tests.rb

@@ -0,0 +1,153 @@
+# This needs to be mentioned during install, but it's just going to
+# fail a majority of the time until 14.04.
+#
+#   def test_nsswitch_conf_gshadow
+#     assert_block "\n#{'*' * 75}
+# nsswitch.conf may be misconfigured. Consider adding the below to /etc/nsswitch.conf.
+# gshadow:\tfiles
+# See 'http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=699089' for more.\n" do
+#       setsgent
+#       !!getsgent
+#     end
+#   end
+
+class GShadowTest < Test::Unit::TestCase
+
+  ##
+  # Module Specific Methods
+  #
+
+  def test_set_end_ent
+    assert_nothing_raised do
+      EU.setsgent
+    end
+
+    assert_nothing_raised do
+      EU.endsgent
+    end
+  end
+
+  def test_find
+    assert_nil EtcUtils.find_sgrp("testuser"), "EU.find_sgrp should return nil if user does not exist"
+    assert_equal("root", EtcUtils.find_sgrp("root").name, "EU.find_sgrp(str) should return user if it exists")
+    assert_equal("root", EtcUtils.find_sgrp(0).name, "EU.find_sgrp(int) should return user if it exists")
+    assert_nothing_raised do
+      EU.setsgent
+    end
+    assert_equal(getsgnam('root').name, getsgent.name, "EU.getsgnam('root') and EU.getsgent should return the same user")
+  end
+
+  def test_shadow_vs_passwd
+    assert_equal(find_sgrp('root').name, find_grp('root').name, "EU.find_sgrp and EU.find_grp should return the same user")
+  end
+
+  def test_sgetsgent
+    assert sgetsgent(find_sgrp('root').to_entry).name.eql? "root"
+  end
+
+  def test_getsgent_while
+    assert_nothing_raised do
+      EtcUtils.setsgent
+      while ( ent = EtcUtils.getsgent ); nil; end
+    end
+  end
+
+  def test_fgetsgent_and_putsgent
+    tmp_fn = "/tmp/_fgetsgent_test"
+    assert_nothing_raised do
+      fh = File.open('/etc/gshadow', 'r')
+      File.open(tmp_fn, File::RDWR|File::CREAT, 0600) { |tmp_fh|
+        while ( ent = EtcUtils.fgetsgent(fh) )
+          EU.putsgent(ent, tmp_fh)
+        end
+      }
+      fh.close
+    end
+    assert File.exists?(tmp_fn), "EU.fgetsgent(fh) should write to fh"
+    assert FileUtils.compare_file("/etc/gshadow", tmp_fn) == true,
+      "DIFF FAILED: /etc/gshadow <=> #{tmp_fn}\n" << `diff /etc/gshadow #{tmp_fn}`
+  ensure
+    FileUtils.remove_file(tmp_fn);
+  end
+
+  def test_putsgent_raises
+    FileUtils.touch "/tmp/_gshadow"
+
+    assert_raise IOError do
+      f = File.open("/tmp/_gshadow", 'r')
+      u = EU.find_sgrp('root')
+      u.fputs f
+    end
+  ensure
+    FileUtils.remove_file("/tmp/_gshadow");
+  end
+
+  ##
+  # EU::GShadow class methods
+  #
+  def test_class_set_end_ent
+    assert_nothing_raised do
+      EU::GShadow.set
+    end
+
+    assert_nothing_raised do
+      EU::GShadow.end
+    end
+  end
+
+  def test_class_get
+    assert_not_nil EU::GShadow.get
+  end
+
+  def test_class_each
+    assert_nothing_raised do
+      EU::GShadow.each do |e|
+        assert e.name
+      end
+    end
+  end
+
+  def test_class_find
+    assert_equal "root", EU::GShadow.find('root').name
+  end
+
+  def test_class_parse
+    assert_nothing_raised do
+      EtcUtils::GShadow.parse("root:x:0:")
+    end
+  end
+
+  def test_class_parse_members
+    assert_nothing_raised do
+      assert_equal Array, EtcUtils::GShadow.parse("root:*::").members.class
+    end
+
+    assert_equal "user", EtcUtils::GShadow.parse("root:*:admin:user").members.first
+  end
+
+  def test_class_parse_admins
+    assert_nothing_raised do
+      assert_equal Array, EtcUtils::GShadow.parse("root:*::").admins.class
+    end
+
+    assert_equal "admin", EtcUtils::GShadow.parse("root:*:admin:user").admins.first
+  end
+
+  ##
+  # EU::GShadow instance methods
+  #
+  def test_init
+    assert_equal EU::GShadow, EU::GShadow.new.class
+  end
+
+  def test_instance_methods
+    e = EU::GShadow.find('root')
+    assert_equal 'root', e.name
+    assert_not_nil e.passwd
+    assert_equal 'root', EU::GShadow.parse(e.to_entry).name
+    assert_equal String, e.to_entry.class
+    assert_equal Array, e.members.class
+    assert_equal Array, e.admins.class
+    assert e.respond_to?(:fputs)
+  end
+end

data/tests/root/locking.rb

@@ -0,0 +1,23 @@
+class RootLockingTest < EULockingTest
+  def test_locking
+    assert_equal(lock, locked?)
+    assert_not_equal(unlock, locked?)
+  end
+
+  def test_locking_block
+    assert_block "Couldn't run a block inside of lock()" do
+      lock { assert locked? }
+      !locked?
+    end
+  end
+
+  def test_locked_after_exception
+    assert_block "Files remained locked when an exception is raised inside of lock()" do
+      begin
+        lock { raise "foobar" }
+      rescue
+        !locked?
+      end
+    end
+  end
+end

data/tests/root/shadow_tests.rb

@@ -0,0 +1,161 @@
+class ShadowTest < Test::Unit::TestCase
+  require 'stringio'
+  ##
+  # Module Specific Methods
+  #
+
+  def test_set_end_ent
+    assert_nothing_raised do
+      EU.setspent
+    end
+
+    assert_nothing_raised do
+      EU.endspent
+    end
+  end
+
+  def test_find
+    assert_nil EtcUtils.find_spwd("testuser"), "EU.find_spwd should return nil if user does not exist"
+    assert_equal("root", EtcUtils.find_spwd("root").name, "EU.find_spwd(str) should return user if it exists")
+    assert_equal("root", EtcUtils.find_spwd(0).name, "EU.find_spwd(int) should return user if it exists")
+    assert_nothing_raised do
+      EU.setspent
+    end
+    assert_equal(getspnam('root').name, getspent.name, "EU.getspent and EU.find_spwd(0) should return the same user")
+  end
+
+  def test_shadow_vs_passwd
+    assert_equal(find_spwd('root').name, find_pwd('root').name, "EU.find_spwd and EU.find_pwd should return the same user")
+  end
+
+  def test_sgetspent
+    assert EU.sgetspent(EU.find_spwd('root').to_entry).name.eql? "root"
+  end
+
+  def test_getspent_while
+    assert_nothing_raised do
+      EtcUtils.setspent
+      while ( ent = EtcUtils.getspent ); nil; end
+    end
+  end
+
+  def test_fgetspent_and_putspent
+    tmp_fn = "/tmp/_fgetsgent_test"
+    assert_nothing_raised do
+      fh = File.open('/etc/shadow', 'r')
+      File.open(tmp_fn, File::RDWR|File::CREAT, 0600) { |tmp_fh|
+        while ( ent = EtcUtils.fgetspent(fh) )
+          EU.putspent(ent, tmp_fh)
+        end
+      }
+      fh.close
+    end
+    assert File.exists?(tmp_fn), "EU.fgetspent(fh) should write to fh"
+    assert FileUtils.compare_file("/etc/shadow", tmp_fn) == true,
+      "DIFF FAILED: /etc/shadow <=> #{tmp_fn}\n" << `diff /etc/shadow #{tmp_fn}`
+  ensure
+    FileUtils.remove_file(tmp_fn);
+  end
+
+  def test_putspent_raises
+    FileUtils.touch "/tmp/_shadow"
+
+    assert_raise IOError do
+      f = File.open("/tmp/_shadow", 'r')
+      u = EU.find_spwd('root')
+      u.fputs f
+    end
+  ensure
+    FileUtils.remove_file("/tmp/_shadow");
+  end
+
+  ##
+  # EU::Shadow class methods
+  #
+  def test_class_set_end_ent
+    assert_nothing_raised do
+      EU::Shadow.set
+    end
+
+    assert_nothing_raised do
+      EU::Shadow.end
+    end
+  end
+
+  def test_class_get
+    assert_not_nil EU::Shadow.get
+  end
+
+  def test_class_each
+    assert_nothing_raised do
+      EU::Shadow.each do |e|
+        assert e.name
+      end
+    end
+  end
+
+  def test_class_find
+    assert_equal "root", EU::Shadow.find('root').name
+  end
+
+  def test_class_parse
+    assert_nothing_raised do
+      EtcUtils::Shadow.parse("root:!:16122:0:99999:7:::")
+    end
+  end
+
+  ##
+  # EU::Shadow instance methods
+  #
+  def test_init
+    assert_equal EU::Shadow, EU::Shadow.new.class
+  end
+
+  def test_instance_methods
+    e = EU::Shadow.find('root')
+    assert_equal 'root', e.name
+    assert_not_nil e.passwd
+    assert_not_nil e.last_pw_change
+    assert e.respond_to?(:fputs)
+    assert_equal 'root', EU::Shadow.parse(e.to_entry).name
+    assert_equal String, e.to_entry.class
+  end
+
+#  rb_define_method(rb_cShadow, "passwd=", user_set_pw_change, 1);
+#  rb_define_method(rb_cShadow, "last_pw_change_date", user_get_pw_change, 0);
+#  rb_define_method(rb_cShadow, "expire_date", user_get_expire, 0);
+#  rb_define_method(rb_cShadow, "expire_date=", user_set_expire, 1);
+  def test_last_pwchange
+    e = EU::Shadow.find('root')
+    lstchg = e.last_pw_change
+    e.passwd = "!#{e.passwd}"
+    assert_not_equal e.last_pw_change, lstchg
+  end
+
+  def test_expire
+    e = EU::Shadow.find('root')
+    assert_not_nil e.expire = 500
+    assert_equal Time.at(500 * 86400), e.expire_date
+    n = Time.now
+    assert_not_nil e.expire = n
+    assert_equal n.to_i / 86400, e.expire
+  end
+
+  def test_expire_warning
+    e = EU::Shadow.find('root')
+    assert_equal capture_stderr{  e.expire = 0 }.gsub(/.+warning:\s+|\n/,''), "Setting EtcUtils::Shadow#expire to 0 should not be used as it is interpreted as either an account with no expiration, or as an expiration of Jan 1, 1970."
+    assert_equal 0, e.expire
+  end
+
+  def capture_stderr
+    # The output stream must be an IO-like object. In this case we capture it in
+    # an in-memory IO object so we can return the string value. You can assign any
+    # IO object here.
+    previous_stderr, $stderr = $stderr, StringIO.new
+    yield
+    $stderr.string
+  ensure
+    # Restore the previous value of stderr (typically equal to STDERR).
+    $stderr = previous_stderr
+  end
+end