sys-admin 1.8.1 → 1.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d20b0abf74cb8d4769f69346ac22ade3d1336bd10d3b6f83eeca2865ab9b85fe
-  data.tar.gz: 7c56cb4dec18928e3ea4fb1371e9c3f4e660fb5ec94519b0385a1448c07e0d84
+  metadata.gz: 2ea8a73dbb3ee22a4e429f99209448968e6ec348157a26e0b00be8f664dbbdce
+  data.tar.gz: 84e774eb93edcda1debe1297b35171b2fcdba9feafde99fc7829ff2f3017de49
 SHA512:
-  metadata.gz: 55d12a7b5d4999eec9801b60a06d1da16bfb2879a4270b0d5188b7d20a397a170619fb0dc75f9fd394952c02e3228d686ff9c908f15a38750220bea7eb2a2e9d
-  data.tar.gz: 3ec5f6ac0690458751f5dd5e2ccaf764b977f1aa46fc6f2acf0c506417c39a4baf704338c712614728fe8d89c289bd76c20dcd62b41f6b28ab5205404ef338e3
+  metadata.gz: c31661d8f953153948dae7410990996989b925ce92eacd5af6d8ea83a1e0d527d26e19b6b3eb66d0d9ec5dd35a044225d586c0fff971eb41c97fb167a0cbc96b
+  data.tar.gz: 73e7ca82c6abf0da81c7a2586554bdaaf376de31f3838c0f6a40b6826e7c29d8563a6b0674e81cb7fc5c4b30985515087f9c91fe67509cbdb64b38cf8825982f

data/CHANGES.md

@@ -1,3 +1,17 @@
+## 1.8.3 - 20-Apr-2024
+* Fixed up the get_group method on most platforms. Previously it was allocating
+  slightly more memory than it needed (wrong struct, oops). In addition, the
+  error handling wasn't consistent because I can't read a man page properly.
+* More specs were added to properly test the get_group updates.
+* The github actions test matrix was updated.
+
+## 1.8.2 - 9-Apr-2023
+* Lots of rubocop related updates.
+* Refactored specs to use shared specs.
+* The lastlog key will return nil instead of an empty struct if it can't be read.
+* Added more information to the gemspec metadata.
+* The rubocop and rubocop-rspec gems are now development dependencies.
+
 ## 1.8.1 - 25-Sep-2021
 * The users and get_user methods on Darwin now take an optional :lastlog key
   that you can set to false in order to significantly speed up those methods

data/MANIFEST.md

@@ -15,6 +15,7 @@
 * lib/sunos/sys/admin.rb
 * lib/sys/admin/common.rb
 * lib/sys/admin/custom.rb
-* test/test_sys_admin.rb
-* test/test_sys_admin_unix.rb
-* test/test_sys_admin_windows.rb
+* spec/spec_helper.rb
+* spec/sys_admin_universal_spec.rb
+* spec/sys_admin_unix_spec.rb
+* spec/sys_admin_windows_spec.rb

data/README.md

@@ -144,6 +144,11 @@ The underlying implementation is similar to core Ruby's Etc implementation.
 But, in addition to the different interface, I use the re-entrant version
 of the appropriate functions when available.
 
+### OSX
+The slowdown for collecting lastlog information on OSX seems to have gotten
+progressively worse over time. Do not be surprised by significant slowdowns
+if you opt to collect it.
+
 ## Future Plans
 * Make the User and Group objects comparable.
 * Add ability to add, configure and delete users on Unix platforms.
@@ -157,7 +162,7 @@ None that I'm aware of. If you find any, please log them on the project page at:
 Apache-2.0
 
 ## Copyright
-(C) 2005-2020, Daniel J. Berger
+(C) 2005-2024, Daniel J. Berger
 All Rights Reserved
 
 ## Author

data/Rakefile

@@ -2,11 +2,12 @@ require 'rake'
 require 'rake/clean'
 require 'rspec/core/rake_task'
 require 'rbconfig'
+require 'rubocop/rake_task'
 
 CLEAN.include("**/*.gem", "**/*.rbx", "**/*.rbc", "ruby.core", "**/*.lock")
 
 namespace :gem do
-  desc "Create the sys-uname gem"
+  desc "Create the sys-admin gem"
   task :create => [:clean] do
     require 'rubygems/package'
     spec = Gem::Specification.load('sys-admin.gemspec')
@@ -14,7 +15,7 @@ namespace :gem do
     Gem::Package.build(spec)
   end
 
-  desc "Install the sys-uname gem"
+  desc "Install the sys-admin gem"
   task :install => [:create] do
     file = Dir["*.gem"].first
     sh "gem install -l #{file}"
@@ -39,4 +40,6 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   end
 end
 
+RuboCop::RakeTask.new
+
 task :default => :spec

data/lib/bsd/sys/admin.rb

@@ -1,42 +1,46 @@
+# frozen_string_literal: true
+
 require 'sys/admin/custom'
 require 'sys/admin/common'
 require 'rbconfig'
 
 # The BSD specific code.
 
+# The Sys module serves as a namespace only.
 module Sys
+  # The Admin class provides a unified, cross platform replacement for the Etc module.
   class Admin
     # :no-doc:
     BUF_MAX = 65536 # Max buffer for retry
     private_constant :BUF_MAX
 
     # I'm making some aliases here to prevent potential conflicts
-    attach_function :open_c, :open, [:string, :int], :int
-    attach_function :pread_c, :pread, [:int, :pointer, :size_t, :off_t], :size_t
+    attach_function :open_c, :open, %i[string int], :int
+    attach_function :pread_c, :pread, %i[int pointer size_t off_t], :size_t
     attach_function :close_c, :close, [:int], :int
 
-    attach_function :getlogin_r, [:pointer, :int], :int
-    attach_function :getpwnam_r, [:string, :pointer, :pointer, :size_t, :pointer], :int
-    attach_function :getpwuid_r, [:long, :pointer, :pointer, :size_t, :pointer], :int
-    attach_function :getgrnam_r, [:string, :pointer, :pointer, :size_t, :pointer], :int
-    attach_function :getgrgid_r, [:long, :pointer, :pointer, :size_t, :pointer], :int
+    attach_function :getlogin_r, %i[pointer int], :int
+    attach_function :getpwnam_r, %i[string pointer pointer size_t pointer], :int
+    attach_function :getpwuid_r, %i[long pointer pointer size_t pointer], :int
+    attach_function :getgrnam_r, %i[string pointer pointer size_t pointer], :int
+    attach_function :getgrgid_r, %i[long pointer pointer size_t pointer], :int
 
     private_class_method :getlogin_r, :getpwnam_r, :getpwuid_r, :getgrnam_r, :getgrgid_r
     private_class_method :open_c, :pread_c, :close_c
 
     # struct passwd from /usr/include/pwd.h
     class PasswdStruct < FFI::Struct
-      fields = [
-        :pw_name, :string,
-        :pw_passwd, :string,
-        :pw_uid, :uid_t,
-        :pw_gid, :gid_t,
-        :pw_change, :time_t,
-        :pw_class, :string,
-        :pw_gecos, :string,
-        :pw_dir, :string,
-        :pw_shell, :string,
-        :pw_expire, :time_t
+      fields = %i[
+        pw_name string
+        pw_passwd string
+        pw_uid uid_t
+        pw_gid gid_t
+        pw_change time_t
+        pw_class string
+        pw_gecos string
+        pw_dir string
+        pw_shell string
+        pw_expire time_t
       ]
 
       if RbConfig::CONFIG['host_os'] =~ /freebsd/i
@@ -77,7 +81,7 @@ module Sys
       buf = FFI::MemoryPointer.new(:char, 256)
 
       if getlogin_r(buf, buf.size) != 0
-        raise Error, "getlogin_r function failed: " + strerror(FFI.errno)
+        raise Error, "getlogin_r function failed: #{strerror(FFI.errno)}"
       end
 
       buf.read_string
@@ -98,11 +102,11 @@ module Sys
 
       if uid.is_a?(String)
         if getpwnam_r(uid, temp, buf, buf.size, pbuf) != 0
-          raise Error, "getpwnam_r function failed: " + strerror(FFI.errno)
+          raise Error, "getpwnam_r function failed: #{strerror(FFI.errno)}"
         end
       else
         if getpwuid_r(uid, temp, buf, buf.size, pbuf) != 0
-          raise Error, "getpwuid_r function failed: " + strerror(FFI.errno)
+          raise Error, "getpwuid_r function failed: #{strerror(FFI.errno)}"
         end
       end
 
@@ -127,7 +131,7 @@ module Sys
     def self.get_group(gid)
       size = 1024
       buf  = FFI::MemoryPointer.new(:char, size)
-      pbuf = FFI::MemoryPointer.new(PasswdStruct)
+      pbuf = FFI::MemoryPointer.new(GroupStruct)
       temp = GroupStruct.new
 
       begin
@@ -138,7 +142,14 @@ module Sys
           val = getgrgid_r(gid, temp, buf, buf.size, pbuf)
           fun = 'getgrgid_r'
         end
-        raise SystemCallError.new(fun, val) if val != 0
+
+        if pbuf.null?
+          if val != 0
+            raise SystemCallError.new(fun, val)
+          else
+            raise Error, "group '#{gid}' not found"
+          end
+        end
       rescue Errno::ERANGE
         size += 1024
         raise if size > BUF_MAX
@@ -242,13 +253,13 @@ module Sys
       begin
         fd = open_c(logfile, File::RDONLY)
 
-        if fd != -1
+        if fd >= 0
           bytes = pread_c(fd, lastlog, lastlog.size, uid * lastlog.size)
           if bytes < 0
-            raise Error, "pread function failed: " + strerror(FFI.errno)
+            raise Error, "pread function failed: #{strerror(FFI.errno)}"
           end
         else
-          nil # Ignore, improper permissions
+          lastlog = nil # Ignore, most likely improper permissions
         end
       ensure
         close_c(fd) if fd && fd >= 0

data/lib/darwin/sys/admin.rb

@@ -1,20 +1,24 @@
+# frozen_string_literal: true
+
 require 'sys/admin/custom'
 require 'sys/admin/common'
 
 # The Darwin specific code.
 
+# The Sys module serves as a namespace only.
 module Sys
+  # The Admin class provides a unified, cross platform replacement for the Etc module.
   class Admin
     # :no-doc:
     BUF_MAX = 65536 # Max buf size for retry.
     private_constant :BUF_MAX
 
-    attach_function :getlogin_r, [:pointer, :int], :int
-    attach_function :getpwnam_r, [:string, :pointer, :pointer, :size_t, :pointer], :int
-    attach_function :getpwuid_r, [:long, :pointer, :pointer, :size_t, :pointer], :int
-    attach_function :getgrnam_r, [:string, :pointer, :pointer, :size_t, :pointer], :int
-    attach_function :getgrgid_r, [:long, :pointer, :pointer, :size_t, :pointer], :int
-    attach_function :getlastlogx, [:long, :pointer], :pointer
+    attach_function :getlogin_r, %i[pointer int], :int
+    attach_function :getpwnam_r, %i[string pointer pointer size_t pointer], :int
+    attach_function :getpwuid_r, %i[long pointer pointer size_t pointer], :int
+    attach_function :getgrnam_r, %i[string pointer pointer size_t pointer], :int
+    attach_function :getgrgid_r, %i[long pointer pointer size_t pointer], :int
+    attach_function :getlastlogx, %i[long pointer], :pointer
 
     private_class_method :getlogin_r, :getpwnam_r, :getpwuid_r
     private_class_method :getgrnam_r, :getgrgid_r, :getlastlogx
@@ -67,7 +71,7 @@ module Sys
       buf = FFI::MemoryPointer.new(:char, 256)
 
       if getlogin_r(buf, buf.size) != 0
-        raise Error, "getlogin_r function failed: " + strerror(FFI.errno)
+        raise Error, "getlogin_r function failed: #{strerror(FFI.errno)}"
       end
 
       buf.read_string
@@ -92,11 +96,11 @@ module Sys
 
       if uid.is_a?(String)
         if getpwnam_r(uid, temp, buf, buf.size, pbuf) != 0
-          raise Error, "getpwnam_r function failed: " + strerror(FFI.errno)
+          raise Error, "getpwnam_r function failed: #{strerror(FFI.errno)}"
         end
       else
         if getpwuid_r(uid, temp, buf, buf.size, pbuf) != 0
-          raise Error, "getpwuid_r function failed: " + strerror(FFI.errno)
+          raise Error, "getpwuid_r function failed: #{strerror(FFI.errno)}"
         end
       end
 
@@ -121,7 +125,7 @@ module Sys
     def self.get_group(gid)
       size = 1024
       buf  = FFI::MemoryPointer.new(:char, size)
-      pbuf = FFI::MemoryPointer.new(PasswdStruct)
+      pbuf = FFI::MemoryPointer.new(GroupStruct)
       temp = GroupStruct.new
 
       begin
@@ -132,7 +136,14 @@ module Sys
           val = getgrgid_r(gid, temp, buf, buf.size, pbuf)
           fun = 'getgrgid_r'
         end
-        raise SystemCallError.new(fun, val) if val != 0
+
+        if pbuf.null?
+          if val != 0
+            raise SystemCallError.new(fun, val)
+          else
+            raise Error, "group '#{gid}' not found"
+          end
+        end
       rescue Errno::ERANGE
         size += 1024
         raise if size > BUF_MAX

data/lib/linux/sys/admin.rb

@@ -1,25 +1,29 @@
+# frozen_string_literal: true
+
 require 'sys/admin/custom'
 require 'sys/admin/common'
 
 # The Linux specific code.
 
+# The Sys module serves as a namespace only.
 module Sys
+  # The Admin class provides a unified, cross platform replacement for the Etc module.
   class Admin
     # :no-doc:
     BUF_MAX = 65536 # Absolute max buffer size for retry attempts.
     private_constant :BUF_MAX
 
     # I'm making some aliases here to prevent potential conflicts
-    attach_function :open_c, :open, [:string, :int], :int
-    attach_function :pread_c, :pread, [:int, :pointer, :size_t, :off_t], :size_t
+    attach_function :open_c, :open, %i[string int], :int
+    attach_function :pread_c, :pread, %i[int pointer size_t off_t], :size_t
     attach_function :close_c, :close, [:int], :int
 
-    attach_function :getpwnam_r, [:string, :pointer, :pointer, :size_t, :pointer], :int
-    attach_function :getpwuid_r, [:long, :pointer, :pointer, :size_t, :pointer], :int
-    attach_function :getpwent_r, [:pointer, :pointer, :size_t, :pointer], :int
-    attach_function :getgrent_r, [:pointer, :pointer, :size_t, :pointer], :int
-    attach_function :getgrnam_r, [:string, :pointer, :pointer, :size_t, :pointer], :int
-    attach_function :getgrgid_r, [:long, :pointer, :pointer, :size_t, :pointer], :int
+    attach_function :getpwnam_r, %i[string pointer pointer size_t pointer], :int
+    attach_function :getpwuid_r, %i[long pointer pointer size_t pointer], :int
+    attach_function :getpwent_r, %i[pointer pointer size_t pointer], :int
+    attach_function :getgrent_r, %i[pointer pointer size_t pointer], :int
+    attach_function :getgrnam_r, %i[string pointer pointer size_t pointer], :int
+    attach_function :getgrgid_r, %i[long pointer pointer size_t pointer], :int
 
     private_class_method :getgrent_r, :getgrnam_r, :getgrgid_r
     private_class_method :open_c, :pread_c, :close_c
@@ -83,11 +87,11 @@ module Sys
 
       if uid.is_a?(String)
         if getpwnam_r(uid, temp, buf, buf.size, pbuf) != 0
-          raise Error, "getpwnam_r function failed: " + strerror(FFI.errno)
+          raise Error, "getpwnam_r function failed: #{strerror(FFI.errno)}"
         end
       else
         if getpwuid_r(uid, temp, buf, buf.size, pbuf) != 0
-          raise Error, "getpwuid_r function failed: " + strerror(FFI.errno)
+          raise Error, "getpwuid_r function failed: #{strerror(FFI.errno)}"
         end
       end
 
@@ -116,7 +120,7 @@ module Sys
     def self.get_group(gid)
       size = 1024
       buf  = FFI::MemoryPointer.new(:char, size)
-      pbuf = FFI::MemoryPointer.new(PasswdStruct)
+      pbuf = FFI::MemoryPointer.new(GroupStruct)
       temp = GroupStruct.new
 
       begin
@@ -127,7 +131,14 @@ module Sys
           val = getgrgid_r(gid, temp, buf, buf.size, pbuf)
           fun = 'getgrgid_r'
         end
-        raise SystemCallError.new(fun, val) if val != 0
+
+        if pbuf.null?
+          if val != 0
+            raise SystemCallError.new(fun, val)
+          else
+            raise Error, "group '#{gid}' not found"
+          end
+        end
       rescue Errno::ERANGE # Large groups
         size += 1024
         raise if size > BUF_MAX
@@ -239,7 +250,7 @@ module Sys
 
     private_class_method :get_user_from_struct
 
-    # Note: it seems that Linux, or at least Ubuntu, does not track logins
+    # NOTE: It seems that Linux, or at least Ubuntu, does not track logins
     # via GDM (Gnome Display Manager) for some reason, so this may not return
     # anything useful.
     #
@@ -252,13 +263,13 @@ module Sys
       begin
         fd = open_c(logfile, File::RDONLY)
 
-        if fd != -1
+        if fd >= 0
           bytes = pread_c(fd, lastlog, lastlog.size, uid * lastlog.size)
           if bytes < 0
-            raise Error, "pread function failed: " + strerror(FFI.errno)
+            raise Error, "pread function failed: #{strerror(FFI.errno)}"
           end
         else
-          nil # Ignore, improper permissions
+          lastlog = nil # Ignore, most likely improper permissions
         end
       ensure
         close_c(fd) if fd && fd >= 0

data/lib/sunos/sys/admin.rb

@@ -1,26 +1,30 @@
+# frozen_string_literal: true
+
 require 'sys/admin/custom'
 require 'sys/admin/common'
 
 # The Solaris specific code.
 
+# The Sys module serves as a namespace only.
 module Sys
+  # The Admin class provides a unified, cross platform replacement for the Etc module.
   class Admin
     # :no-doc:
     BUF_MAX = 65536 # Max buffer size for retry.
     private_constant :BUF_MAX
 
     # I'm making some aliases here to prevent potential conflicts
-    attach_function :open_c, :open, [:string, :int], :int
-    attach_function :pread_c, :pread, [:int, :pointer, :size_t, :off_t], :size_t
+    attach_function :open_c, :open, %i[string int], :int
+    attach_function :pread_c, :pread, %i[int pointer size_t off_t], :size_t
     attach_function :close_c, :close, [:int], :int
 
-    attach_function :getlogin_r, [:pointer, :size_t], :pointer
-    attach_function :getpwnam_r, [:string, :pointer, :pointer, :size_t], :pointer
-    attach_function :getpwuid_r, [:long, :pointer, :pointer, :size_t], :pointer
-    attach_function :getpwent_r, [:pointer, :pointer, :int], :pointer
-    attach_function :getgrent_r, [:pointer, :pointer, :int], :pointer
-    attach_function :getgrnam_r, [:string, :pointer, :pointer, :int], :pointer
-    attach_function :getgrgid_r, [:long, :pointer, :pointer, :int], :pointer
+    attach_function :getlogin_r, %i[pointer size_t], :pointer
+    attach_function :getpwnam_r, %i[string pointer pointer size_t], :pointer
+    attach_function :getpwuid_r, %i[long pointer pointer size_t], :pointer
+    attach_function :getpwent_r, %i[pointer pointer int], :pointer
+    attach_function :getgrent_r, %i[pointer pointer int], :pointer
+    attach_function :getgrnam_r, %i[string pointer pointer int], :pointer
+    attach_function :getgrgid_r, %i[long pointer pointer int], :pointer
 
     private_class_method :getlogin_r, :getpwnam_r, :getpwuid_r, :getpwent_r
     private_class_method :getgrent_r, :getgrnam_r, :getgrgid_r
@@ -74,7 +78,7 @@ module Sys
       ptr = getlogin_r(buf, buf.size)
 
       if ptr.null?
-        raise Error, "getlogin_r function failed: " + strerror(FFI.errno)
+        raise Error, "getlogin_r function failed: #{strerror(FFI.errno)}"
       end
 
       buf.read_string
@@ -99,7 +103,7 @@ module Sys
       end
 
       if ptr.null?
-        raise Error, "getpwnam_r or getpwuid_r function failed: " + strerror(FFI.errno)
+        raise Error, "getpwnam_r or getpwuid_r function failed: #{strerror(FFI.errno)}"
       end
 
       pwd = PasswdStruct.new(ptr)
@@ -251,7 +255,7 @@ module Sys
         if fd != -1
           bytes = pread_c(fd, lastlog, lastlog.size, uid * lastlog.size)
           if bytes < 0
-            raise Error, "pread function failed: " + strerror(FFI.errno)
+            raise Error, "pread function failed: #{strerror(FFI.errno)}"
           end
         else
           nil # Ignore, improper permissions

data/lib/sys/admin/common.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'ffi'
 
 # The Sys module serves as a namespace only.
 module Sys
-
   # The Admin class provides a unified, cross platform replacement
   # for the Etc module.
   class Admin
@@ -99,9 +100,9 @@ module Sys
       def groups
         array = []
 
-        Sys::Admin.groups.each{ |grp|
-          array << grp.name if grp.members.include?(self.name)
-        }
+        Sys::Admin.groups.each do |grp|
+          array << grp.name if grp.members.include?(name)
+        end
 
         array
       end

data/lib/sys/admin/custom.rb

@@ -1,14 +1,17 @@
+# frozen_string_literal: true
+
 require 'ffi'
 
+# Re-open the FFI::Pointer class to add a custom method.
 class FFI::Pointer
   def read_array_of_string
     elements = []
 
     loc = self
 
-    until ((element = loc.read_pointer).null?)
-     elements << element.read_string
-     loc += FFI::Type::POINTER.size
+    until (element = loc.read_pointer).null?
+      elements << element.read_string
+      loc += FFI::Type::POINTER.size
     end
 
     elements

data/lib/sys/admin.rb

@@ -1,7 +1,13 @@
+# frozen_string_literal: true
+
+# The Sys modules serves as a namespace only.
 module Sys
+  # The Admin class provides a unified, cross platform replacement for the Etc module.
   class Admin
     # The version of the sys-admin library.
-    VERSION = '1.8.1'.freeze
+    VERSION = '1.8.3'
+
+    private_class_method :new
   end
 end
 

data/lib/sys-admin.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'sys/admin'

data/lib/unix/sys/admin.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 require 'sys/admin/custom'
 require 'sys/admin/common'
 
 # Code used as a fallback for UNIX platforms.
 
+# The Sys module serves as a namespace only.
 module Sys
+  # The Admin class provides a unified, cross platform replacement for the Etc module.
   class Admin
     class PasswdStruct < FFI::Struct
       layout(
@@ -55,7 +59,7 @@ module Sys
         raise Error, "no user found for: #{uid}"
       end
 
-      user = User.new do |u|
+      User.new do |u|
         u.name   = pwd[:pw_name]
         u.passwd = pwd[:pw_passwd]
         u.uid    = pwd[:pw_uid]
@@ -64,8 +68,6 @@ module Sys
         u.dir    = pwd[:pw_dir]
         u.shell  = pwd[:pw_shell]
       end
-
-      user
     end
 
     # Returns a Group object for the given name or uid. Raises an error
@@ -147,7 +149,7 @@ module Sys
 
     # Takes a UserStruct and converts it to a User object.
     def self.get_user_from_struct(pwd)
-      user = User.new do |u|
+      User.new do |u|
         u.name         = pwd[:pw_name]
         u.passwd       = pwd[:pw_passwd]
         u.uid          = pwd[:pw_uid]
@@ -156,8 +158,6 @@ module Sys
         u.dir          = pwd[:pw_dir]
         u.shell        = pwd[:pw_shell]
       end
-
-      user
     end
 
     private_class_method :get_user_from_struct