rubyipmi 0.11.1 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ded5dae3237a5610e1b3d5e1595743be1401636b68b76965d9b1c4bfaa174ac8
-  data.tar.gz: bbfd85a434bfafdeccd6efbcea2dc898032b04b92ceb6c7ebe918f11ac12e4eb
+  metadata.gz: 6f4f084aa7f49cb5e387e91beb0d0e3127de0c03bf320f49c0ebbb3134c0e37c
+  data.tar.gz: 23e6a5dd885284aa9c2806b6ae7196f8d03fbf7009a72b9b89a66cd9a7e9e0b8
 SHA512:
-  metadata.gz: 60e95d651aa6b3275f91ea531628c33a473eaaf3d3e34c7c60a61d97cbbcbedfa907356138010eae1d0eda3c0a362316f8fb34e472b594edc834bbd78b0bb619
-  data.tar.gz: 1d8bb664adf6c327a238358ace1a90fdff409cbf8b8328d15f7081f1e60f114f55efdfbe754f98f08ce92ea59079ebd970f07834b6c38b14c3300b622e99e84c
+  metadata.gz: 7d7b1f5a620e693dbbc013d80311c45496e9fa49494ed90b936b7e17bc9084123b5951878962ab53738ef484b4bda2d737afa13b9461d7fdf634913022acaabd
+  data.tar.gz: 809ac56808cc4183461e6722224220a64be4904940aa7eef59a94abccdcf4a750ecb031c83ec706b4206f0ecc8e60272e1fd3f8d637bca7ec93b5c1100111a4c

data/CHANGELOG.md

@@ -0,0 +1,236 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased] - 0.12.1
+
+### Fixed
+- Don't re-raise the original exception in basecommand
+- Properly mock capture3 API which returns a Process::Status, not true
+- Don't fail when status was success
+- Strip `which` output like it was before the Ruby 3.0 changes
+
+### Changed
+- Update link to sensu ipmi plugin
+
+## [0.12.0] - 2024
+
+### Added
+- Ruby 3.4 support
+- GitHub Actions for CI/CD testing
+- Logger gem dependency (will be removed in Ruby 3.5)
+
+### Changed
+- Test on Ruby 3.1, 3.2 & 3.3
+- Fix tests for Ruby 3.0
+- Update actions/checkout to v4
+- Remove highline as a runtime dependency
+- Simplify gemspec and Gemfile
+- Use SPDX license code in gemspec
+- Limit dependency ranges to avoid gemspec warnings
+- Let git ignore *.gem files
+
+## [0.11.1] - 2023
+
+### Fixed
+- Exclude hidden files from the gem package
+
+## [0.11.0] - 2023
+
+### Added
+- SensorsMixin to remove duplicate code
+- Rubocop GuardClause support
+- Additional rubocop cops
+
+### Changed
+- Remove jeweler dependency, replace with bundler commands
+- Use HTTPS for homepage field in gemspec
+- Leverage Enumerable#each_with_object
+- Move #drivers_map to a constant
+- Update .rubocop.yml
+- Reword confusing project description
+- Update README.md section on booting to specific devices
+- Remove puppet code and vagrant
+
+### Fixed
+- Fix infinite loop when executing 'lan print' command
+- Fix "NoMethodError: undefined method `success?' for nil:NilClass"
+- Fix rubocop Style/MethodName "Use snake_case for method names"
+- Remove duplicate methods
+- Remove if/else logic and unnecessary return in #validate_status
+- Remove pry statement from method
+- Fix many rubocop style infractions
+
+## [0.10.0] - 2022
+
+### Changed
+- Make the driver default to lan20 (users of older IPMI devices will need to pass the specified driver type)
+
+## [0.9.3] - 2022
+
+### Fixed
+- Normalize the options being passed into the connect method
+
+## [0.9.2] - 2022
+
+### Fixed
+- Fix issue where is_provider_installed? should only return a boolean value instead of raising an error
+- Fix minor style issue where providers_installed? was returning an array when a boolean might have been expected
+
+### Changed
+- Updated README about support and added TOC
+
+## [0.9.1] - 2022
+
+### Fixed
+- Fix issue with connection_works? API call when command raises an error
+
+### Changed
+- Updated README and release notes
+- Fix spelling mistakes
+
+## [0.9.0] - 2022
+
+### Added
+- Ability to generate a logfile
+- Ability to test connection
+- Coveralls support for coverage data
+
+### Changed
+- Move to rspec3 expect syntax
+- Refactor get_diag function to be useful
+- Remove 1.9.2 support and add 2.2 support
+- Updated .gitignore to stop watching Gemfile.lock
+- Updated spec tests to load spec_helper differently
+- Removed development support for Ruby 1.8
+
+### Fixed
+- Fix issue with freeipmi lan info and auto fix
+- Fix issue with options not being deleted for fru
+
+## [0.8.1] - 2021
+
+### Changed
+- Switch to LGPL license
+- Remove rcov in favor of simplecov
+- Updated gemspec and removed rcov from Gemfile
+- Added new rubies to travis testing suite
+
+## [0.8.0] - 2021
+
+### Added
+- Option to specify privilege level
+- Support for multiple driver-types
+- Flexible options hash
+
+### Changed
+- Changed License from GPL to LGPL
+- Refactored new opts hash feature
+- Added unit tests for opts hash feature
+- Updated README
+
+### Fixed
+- Fix ipmitool power.on precheck
+
+## [0.7.0] - 2020
+
+### Added
+- Debug option (set rubyipmi_debug=true environment variable)
+- Attribute reader for result to retrieve from outside classes
+- Travis CI support
+
+### Changed
+- Updated gemspec files
+- Updated README
+- Removed development support for Ruby 2.0.0
+
+### Fixed
+- Fix bug where command was returning the value and not the result
+- Fix bug where bmc-config was not raising an error when errors occurred
+- Fix issues with freeipmi not getting right error code
+- Updated unit tests for error code checking
+- Updated ipmitool spec tests and fixed error code search functionality
+
+## [0.6.0] - 2020
+
+### Added
+- Support for using bmc reset
+
+### Changed
+- Default connection for ipmitool now uses IPMI 2.0
+- Updated license
+
+## [0.5.1] - 2020
+
+### Fixed
+- Fix loading error in rbenv environment
+
+### Changed
+- Updated README
+
+## [0.5.0] - 2020
+
+### Added
+- FRU (Field Replaceable Unit) support
+- Hidden password security
+- Printdiag function
+
+## [0.4.0] - 2020
+
+### Added
+- Sensor support
+
+### Changed
+- Renamed subnet function to netmask function
+
+## [0.3.3] - 2020
+
+### Changed
+- Updated error output
+
+## [0.3.2] - 2020
+
+### Fixed
+- Fix issue with commands not returning value
+
+## [0.3.1] - 2020
+
+### Fixed
+- Fix issue with ipmitool identify
+
+## [0.3.0] - 2020
+
+### Added
+- Makecommand function
+- BMC lan info
+- Boot settings
+
+### Changed
+- Updated tests and lan parser
+
+### Fixed
+- Fix error with getting info object
+
+## [0.2.0] - 2020
+
+### Added
+- BMC info function
+
+### Changed
+- Updated tests
+
+## [0.1.1] - 2020
+
+### Fixed
+- Fix issue with power cycle when system is off
+
+### Changed
+- Updated tests
+
+## [0.1.0] - 2020
+
+### Added
+- Initial release with ruby-freeipmi and ipmitool code support

data/CONTRIBUTORS.md

@@ -0,0 +1,8 @@
+## Contributors
+Big thank you to our maintainers and contributors.
+
+- Ewoud Kohl van Wijngaarden @ekohl
+- Lukáš Zapletal @lzap
+- Evgeni Golov @evgeni
+- Mateusz Gozdek
+- Brandon Dunne @bdunne

data/Gemfile

@@ -1,13 +1,11 @@
 source "http://rubygems.org"
 
+gemspec
+
 group :development do
-  gem "rspec", "~> 3.1"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", ">= 2.0.0"
-  gem "highline"
-  gem "rake"
-  gem 'coveralls', :require => false
+  gem 'coveralls_reborn', require: false
   gem 'pry'
   gem 'pry-rescue'
-  gem "rubocop", "~> 0.33.0", :require => false
+  gem "rubocop", :require => false
+  gem "reline"
 end

data/README.md

@@ -43,7 +43,7 @@ Rubyipmi was built because I wanted an object oriented way to get data from BMC
 and if any IPMI hacks/workarounds were required I wanted to build those into the library to make life easier.
 
 ## Projects that use Rubyipmi
-* https://github.com/sensu/sensu-community-plugins/blob/master/plugins/ipmi/check-sensor.rb
+* https://github.com/sensu-plugins/sensu-plugins-ipmi
 * https://github.com/theforeman/smart-proxy  (Turns Rubyipmi into a Remote Web API Proxy server)
 * https://github.com/logicminds/ipmispec (just started)
 

data/RELEASE_NOTES.md

@@ -1,3 +1,14 @@
+## unreleased
+
+### 0.12.0
+ * Add Ruby 3.4 support @ekohl
+ * Update test matrix for other 3.x rubies @ekohl
+ * Remove highline as a runtime dependency + simpify gemspec & Gemfile @ekohl
+ * Use the SPDX license code in gemspec @ekohl
+ * Limit dependency ranges to avoid gemspec warnings @ekohl
+ * Simplify gemspec @ekohl
+ * Adds github actions for testing
+
 ### 0.11.1
  * remove hidden files from gem package
 
@@ -13,7 +24,7 @@ This is a big update with many minor changes and bug fixes.  Thank you for all t
   Adds a missing counter incrementation with the same style as
   in basecommands and make it return current @info in case of a failure,
   so all methods accessing it will just get return nil.
- 
+
 - Leverage Enumerable#each_with_object
 - Add a SensorsMixin to remove duplicate code
 - Enable Rubocop GuardClause and fix complaints
@@ -32,7 +43,7 @@ This is a big update with many minor changes and bug fixes.  Thank you for all t
 - Remove if / else logic and unnecessary return in #validate_status
 - Reword confusing project description
 - Update README.md section on booting to specific devices
-- Update documentation around bootpxe, bootdisk functions 
+- Update documentation around bootpxe, bootdisk functions
 - Remove pry statement from method
 ### 0.10.0
 * gh-26 - make the driver default to lan20

data/VERSION

@@ -1 +1 @@
-0.10.0
+0.12.1

data/lib/rubyipmi/commands/basecommand.rb

@@ -37,9 +37,8 @@ module Rubyipmi
     end
 
     def locate_command(commandname)
-      location = `which #{commandname}`.strip
-      unless $?.success?
-        logger.error("#{commandname} command not found, is #{commandname} installed?") if logger
+      unless location = Rubyipmi.locate_command(commandname)
+        logger&.error("#{commandname} command not found, is #{commandname} installed?")
         raise "#{commandname} command not found, is #{commandname} installed?"
       end
       location
@@ -67,10 +66,10 @@ module Rubyipmi
       logger.debug(makecommand) if logger
       begin
         command = makecommand
-        @lastcall = "#{command}"
-        @result = `#{command} 2>&1`
+        @lastcall = command.to_s
+        @result, @result_err, status = Rubyipmi.capture3(command)
         # sometimes the command tool does not return the correct result, validate it with additional code
-        process_status = validate_status($?)
+        process_status = validate_status(status)
       rescue
         if retrycount < max_retry_count
           find_fix(@result)
@@ -108,7 +107,7 @@ module Rubyipmi
 
     # This method will check if the results are really valid as the exit code can be misleading and incorrect
     def validate_status(exitstatus)
-      raise "Error occurred" unless exitstatus.success?
+      raise "Error occurred" unless exitstatus.respond_to?(:success?) && exitstatus.success?
 
       true
     end

data/lib/rubyipmi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rubyipmi
-  VERSION = '0.11.1'.freeze
+  VERSION = '0.12.1'.freeze
 end

data/lib/rubyipmi.rb

@@ -19,6 +19,7 @@
 require 'rubyipmi/ipmitool/connection'
 require 'rubyipmi/freeipmi/connection'
 require 'logger'
+require 'open3'
 
 class NullLogger < Logger
   def initialize(*_args)
@@ -144,11 +145,18 @@ module Rubyipmi
     PRIV_TYPES.include?(type)
   end
 
+  # test-friendly capture3
+  def self.capture3(cmd)
+    return Open3.capture3(cmd)
+  end
+
   # method used to find the command which also makes it easier to mock with
   def self.locate_command(commandname)
-    location = `which #{commandname}`.strip
-    location = nil unless $?.success?
-    location
+    stdout, stderr, status = Open3.capture3("which #{commandname}")
+    logger&.error("Which command returned: #{stderr}") unless status.success?
+
+    return nil unless status.success?
+    stdout.strip
   end
 
   # Return true or false if the provider is available

data/rubyipmi.gemspec

@@ -6,8 +6,6 @@ Gem::Specification.new do |s|
   s.name = "rubyipmi"
   s.version = Rubyipmi::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
   s.authors = ["Corey Osman"]
   s.date = "2021-09-29"
   s.description = "Controls IPMI devices via command line wrapper for ipmitool and freeipmi"
@@ -20,15 +18,14 @@ Gem::Specification.new do |s|
     f.match(/^(\.|test|spec|features)/) || f.match(/^*.tar\.gz/)
   end
   s.homepage = "https://github.com/logicminds/rubyipmi"
-  s.licenses = ["LGPLv2.1"]
-  s.rubygems_version = "2.4.5"
+  s.license = "LGPL-2.1-only"
   s.summary = "A ruby wrapper for ipmi command line tools that supports ipmitool and freeipmi"
   s.require_paths = ['lib']
-  s.add_development_dependency(%q<rspec>, ["~> 3.1"])
-  s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-  s.add_development_dependency(%q<bundler>, [">= 1.1.5"])
-  s.add_development_dependency(%q<highline>, [">= 0"])
-  s.add_development_dependency(%q<rake>, [">= 0"])
-  s.add_dependency(%q<highline>, [">= 0"])
+  s.add_dependency 'observer', '~> 0.1.0'
+  s.add_dependency 'logger'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rdoc', "~> 6.1"
+  s.add_development_dependency 'bundler', "~> 2.0"
+  s.add_development_dependency 'highline', '>= 1.0', '< 3'
+  s.add_development_dependency 'rake', '~> 13'
 end
-

metadata

@@ -1,99 +1,118 @@
 --- !ruby/object:Gem::Specification
 name: rubyipmi
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.1
 platform: ruby
 authors:
 - Corey Osman
-autorequire:
 bindir: bin
 cert_chain: []
 date: 2021-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: observer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :development
+        version: 0.1.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: highline
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
 description: Controls IPMI devices via command line wrapper for ipmitool and freeipmi
 email: corey@logicminds.biz
 executables: []
@@ -102,6 +121,8 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- CHANGELOG.md
+- CONTRIBUTORS.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -140,9 +161,8 @@ files:
 - rubyipmi.gemspec
 homepage: https://github.com/logicminds/rubyipmi
 licenses:
-- LGPLv2.1
+- LGPL-2.1-only
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -157,8 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A ruby wrapper for ipmi command line tools that supports ipmitool and freeipmi
 test_files: []