sys-admin 1.8.2 → 1.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c191067356dcf507ffbbed68d96c9a13bf7fa31cb6feaaadbcfd2f219ec873b
-  data.tar.gz: db228e72e4c6a3c0bff4acb11f56066819aea11d1c2b4b82f36b387b245ac1b9
+  metadata.gz: 2ea8a73dbb3ee22a4e429f99209448968e6ec348157a26e0b00be8f664dbbdce
+  data.tar.gz: 84e774eb93edcda1debe1297b35171b2fcdba9feafde99fc7829ff2f3017de49
 SHA512:
-  metadata.gz: 3a63f387f83d94ad3654d1e1a02ed082e53ce2841f6cdb12c00d72a6cc9a89bbd2fbaceb4feb1c5f8c440c51bd9cbfe9feef6bb202a996033ab9ac98889f35dd
-  data.tar.gz: b46f0d812861d7232c62d307ad6806c0e8de4b54a277ade7f0f30530239479fcd1bf86ba391301945499fe8f9e8a48c13355a0e27bd5ec5f35319575845ee287
+  metadata.gz: c31661d8f953153948dae7410990996989b925ce92eacd5af6d8ea83a1e0d527d26e19b6b3eb66d0d9ec5dd35a044225d586c0fff971eb41c97fb167a0cbc96b
+  data.tar.gz: 73e7ca82c6abf0da81c7a2586554bdaaf376de31f3838c0f6a40b6826e7c29d8563a6b0674e81cb7fc5c4b30985515087f9c91fe67509cbdb64b38cf8825982f

data/CHANGES.md

@@ -1,3 +1,10 @@
+## 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.

data/README.md

@@ -162,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/lib/bsd/sys/admin.rb

@@ -131,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
@@ -142,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

data/lib/darwin/sys/admin.rb

@@ -125,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
@@ -136,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

@@ -120,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
@@ -131,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

data/lib/sys/admin.rb

@@ -5,7 +5,7 @@ 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.2'
+    VERSION = '1.8.3'
 
     private_class_method :new
   end

data/spec/sys_admin_shared.rb

@@ -2,7 +2,7 @@
 
 RSpec.shared_examples Sys::Admin do
   example 'version is set to expected value' do
-    expect(described_class::VERSION).to eq('1.8.2')
+    expect(described_class::VERSION).to eq('1.8.3')
   end
 
   example 'version constant is frozen' do

data/spec/sys_admin_unix_spec.rb

@@ -76,6 +76,12 @@ RSpec.describe Sys::Admin, :unix do
     end
 
     describe 'get_group' do
+      before do
+        described_class.class_eval do
+          public :getgrgid_r
+        end
+      end
+
       example 'get_group basic functionality' do
         expect(described_class).to respond_to(:get_group)
         expect{ described_class.get_group(group) }.not_to raise_error
@@ -100,8 +106,31 @@ RSpec.describe Sys::Admin, :unix do
       end
 
       example 'get_group raises an Error if the group cannot be found' do
+        expect{ described_class.get_group(123456789) }.to raise_error(Sys::Admin::Error)
         expect{ described_class.get_group('foofoofoo') }.to raise_error(Sys::Admin::Error)
       end
+
+      example 'get_group handles large groups and will retry an ERANGE' do
+        allow(Sys::Admin).to receive(:getgrgid_r).with(any_args).and_return(34)
+        allow(Sys::Admin).to receive(:getgrgid_r).with(any_args).and_call_original
+        expect{ described_class.get_group(group_id) }.not_to raise_error
+      end
+
+      example 'get_group will raise the expected error for an ENOENT' do
+        allow(Sys::Admin).to receive(:getgrgid_r).with(any_args).and_return(2)
+        expect{ described_class.get_group(group_id) }.to raise_error(Sys::Admin::Error)
+      end
+
+      example 'get_group will raise the expected error for a failed getgrxxx function call' do
+        allow(Sys::Admin).to receive(:getgrgid_r).with(any_args).and_return(22)
+        allow_any_instance_of(FFI::MemoryPointer).to receive(:null?).and_return(true)
+        expect{ described_class.get_group(group_id) }.to raise_error(Errno::EINVAL)
+      end
+
+      example 'get_group will not retry failures other than an ERANGE' do
+        allow(Sys::Admin).to receive(:getgrgid_r).with(any_args).and_return(35)
+        expect{ described_class.get_group(group_id) }.to raise_error(Sys::Admin::Error)
+      end
     end
 
     describe 'groups' do

data/sys-admin.gemspec

@@ -3,7 +3,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-admin'
-  spec.version    = '1.8.2'
+  spec.version    = '1.8.3'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sys-admin
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.8.3
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2023-04-09 00:00:00.000000000 Z
+date: 2024-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi