idrac 0.1.29 → 0.1.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c080d98bd3ca44b9cc006ba66cc443ec410dcfb6bc1b712141720cc82998884
-  data.tar.gz: fe0e09d1e3089c5d354abf6f786624d5afd7dfbcd7b2984d84a72be9936dcf9c
+  metadata.gz: 6992752c6eee7bfb3c858d8bb465c68c68bff2008732ecfc88553ba7ac0524b5
+  data.tar.gz: ab1e816e1c1d903c3095c5131652f917a61b3c4006e0941fd05d24555230f9f5
 SHA512:
-  metadata.gz: 479b4ceb21686d4803a3f780f8fe19fcd1741f17cf3b1e24cd0039bd7758688810260dd939fe60cfe07b3b829feefcfbeee4953826f315b65707d2467121fa6c
-  data.tar.gz: 1855a7715e1267c505cc20f9dfd9a9e0665b78ac4db5b06a6984503bb88fb849e7f41b9ebeb68b6e67a70d0b663ea3a6f9b7bbecd1e4c5e194aff198ca9b5238
+  metadata.gz: b65362922f5a5728e6840a005ee7a79f2c08a835bba4ae7394eb304d2992426d9a9a52457173eb579e8e792413767c9249c64f5eacaee9dd47105971b10b3187
+  data.tar.gz: 8f97a86b72b0fb3544cb85c61f94b8228b037f63adeb345d9da856f7159d7e698c176fd303e212182dd779496b77c07b0b2efe83cc8d8fe8cee281060132d0e0

data/README.md

@@ -7,7 +7,11 @@ A Ruby client for the Dell iDRAC API. This gem provides a command-line interface
 - Take screenshots of the iDRAC console
 - Update firmware using Dell's catalog
 - Check for firmware updates
-- Interactive firmware update process
+- Interactive firmware update process with robust error handling
+- Simplified catalog download without requiring host connection
+- Comprehensive error handling with clear user guidance
+- Automatic job tracking and monitoring for firmware updates
+- Color-coded terminal output for improved readability and user experience
 
 ## Installation
 
@@ -130,6 +134,25 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Changelog
 
+### Version 0.1.30
+- **Enhanced Terminal Output with Colors**: Added colorized output for better readability and user experience
+- Integrated the `colorize` gem to provide color-coded messages throughout the application
+- Success messages are displayed in green, warnings in yellow, errors in red, and informational messages in cyan
+- Improved visual distinction between different types of messages (success, error, warning, info)
+- Enhanced readability of firmware update status, system information, and error messages
+- Updated all output messages across the codebase for consistent color formatting
+- Added color to the test script output for better visualization of the firmware update process
+
+### Version 0.1.29
+- **Enhanced Firmware Update Error Handling**: Improved detection and handling of common firmware update issues
+- Added specific error handling for "deployment already in progress" scenarios with clear user guidance
+- Improved job ID extraction with fallback mechanisms to ensure proper job tracking
+- Enhanced the `upload_firmware` method to properly initiate firmware updates by calling the SimpleUpdate action
+- Added informative messages before starting firmware updates, including iDRAC limitations and requirements
+- Simplified the catalog download process by removing host requirement from the `firmware:catalog` command
+- Added a comprehensive test script (`test_firmware_update.rb`) to demonstrate the firmware update process
+- Improved user experience with better error messages and recovery suggestions for common issues
+
 ### Version 0.1.28
 - **Improved Firmware Update Checking**: Completely redesigned the firmware update checking process
 - Added a dedicated `FirmwareCatalog` class for better separation of concerns

data/bin/idrac

@@ -10,6 +10,7 @@ end
 # Load required gems directly
 require "thor"
 require "idrac"
+require "colorize"
 
 module IDRAC
   class CLI < Thor
@@ -51,10 +52,11 @@ module IDRAC
       catalog = IDRAC::FirmwareCatalog.new
       
       begin
+        puts "Downloading Dell catalog...".yellow
         catalog_path = catalog.download(directory)
-        puts "Catalog downloaded to: #{catalog_path}"
+        puts "Catalog downloaded to: #{catalog_path}".green
       rescue IDRAC::Error => e
-        puts "Error: #{e.message}"
+        puts "Error: #{e.message}".red.bold
         exit 1
       end
     end
@@ -73,15 +75,15 @@ module IDRAC
         # Get system inventory - the Firmware class will print its own message
         inventory = firmware.get_system_inventory
         
-        puts "System Information:"
-        puts "  Model: #{inventory[:system][:model]}"
-        puts "  Manufacturer: #{inventory[:system][:manufacturer]}"
-        puts "  Service Tag: #{inventory[:system][:service_tag]}"
-        puts "  BIOS Version: #{inventory[:system][:bios_version]}"
+        puts "System Information:".green.bold
+        puts "  Model: #{inventory[:system][:model]}".light_cyan
+        puts "  Manufacturer: #{inventory[:system][:manufacturer]}".light_cyan
+        puts "  Service Tag: #{inventory[:system][:service_tag]}".light_cyan
+        puts "  BIOS Version: #{inventory[:system][:bios_version]}".light_cyan
         
-        puts "\nInstalled Firmware:"
+        puts "\nInstalled Firmware:".green.bold
         inventory[:firmware].each do |fw|
-          puts "  #{fw[:name]}: #{fw[:version]} (#{fw[:updateable] ? 'Updateable' : 'Not Updateable'})"
+          puts "  #{fw[:name]}: #{fw[:version]} (#{fw[:updateable] ? 'Updateable'.light_green : 'Not Updateable'.light_red})".light_cyan
         end
         
         # Default catalog location is now ~/.idrac/Catalog.xml
@@ -95,13 +97,13 @@ module IDRAC
           updates = firmware.check_updates(catalog_path)
           
           if updates.empty?
-            puts "No updates available."
+            puts "\nNo updates available.".yellow
           end
         else
-          puts "\nTo check for updates, download the catalog first with 'idrac firmware:catalog'"
+          puts "\nTo check for updates, download the catalog first with 'idrac firmware:catalog'".yellow
         end
       rescue IDRAC::Error => e
-        puts "Error: #{e.message}"
+        puts "Error: #{e.message}".red.bold
         exit 1
       ensure
         client.logout
@@ -131,42 +133,42 @@ module IDRAC
         
         # If still no catalog, download it
         if catalog_path.nil?
-          puts "No catalog found. Downloading..."
+          puts "No catalog found. Downloading...".yellow
           catalog = IDRAC::FirmwareCatalog.new
           catalog_path = catalog.download
         end
         
-        puts "Starting interactive firmware update. Please note:"
-        puts "- The iDRAC can only process one firmware update at a time"
-        puts "- Updates may take several minutes to complete"
-        puts "- For BIOS updates, a server reboot will be required to apply the update"
-        puts "- If you encounter errors, check the iDRAC web interface for active jobs"
+        puts "Starting interactive firmware update. Please note:".green.bold
+        puts "- The iDRAC can only process one firmware update at a time".light_cyan
+        puts "- Updates may take several minutes to complete".light_cyan
+        puts "- For BIOS updates, a server reboot will be required to apply the update".light_cyan
+        puts "- If you encounter errors, check the iDRAC web interface for active jobs".light_cyan
         puts ""
         
         begin
           firmware.interactive_update(catalog_path)
         rescue ArgumentError => e
-          puts "Error: #{e.message}"
-          puts "This could be due to an issue with the interactive update process."
-          puts "If you're seeing a 'job ID not found' error, it might be because:"
-          puts "1. The firmware update job wasn't created properly"
-          puts "2. There's already an update in progress"
-          puts "3. The iDRAC needs time to process the previous request"
-          puts "\nTry again in a few minutes or check the iDRAC web interface for active jobs."
+          puts "Error: #{e.message}".red.bold
+          puts "This could be due to an issue with the interactive update process.".yellow
+          puts "If you're seeing a 'job ID not found' error, it might be because:".yellow
+          puts "1. The firmware update job wasn't created properly".light_yellow
+          puts "2. There's already an update in progress".light_yellow
+          puts "3. The iDRAC needs time to process the previous request".light_yellow
+          puts "\nTry again in a few minutes or check the iDRAC web interface for active jobs.".light_cyan
         rescue IDRAC::Error => e
           if e.message.include?("already in progress")
-            puts "Error: #{e.message}"
-            puts "\nTroubleshooting steps:"
-            puts "1. Check the iDRAC web interface under Maintenance > System Update for active jobs"
-            puts "2. Wait for any existing updates to complete (can take 15-30 minutes)"
-            puts "3. If no updates appear to be in progress, you may need to restart the iDRAC"
-            puts "   (iDRAC web interface > Settings > iDRAC Settings > Reset iDRAC)"
+            puts "Error: #{e.message}".red.bold
+            puts "\nTroubleshooting steps:".yellow.bold
+            puts "1. Check the iDRAC web interface under Maintenance > System Update for active jobs".light_yellow
+            puts "2. Wait for any existing updates to complete (can take 15-30 minutes)".light_yellow
+            puts "3. If no updates appear to be in progress, you may need to restart the iDRAC".light_yellow
+            puts "   (iDRAC web interface > Settings > iDRAC Settings > Reset iDRAC)".light_yellow
           else
-            puts "Error: #{e.message}"
+            puts "Error: #{e.message}".red.bold
           end
         end
       rescue => e
-        puts "Error: #{e.message}"
+        puts "Error: #{e.message}".red.bold
         exit 1
       ensure
         client.logout
@@ -212,7 +214,7 @@ module IDRAC
 
     def ensure_host_provided
       unless options[:host]
-        puts "Error: No value provided for required option '--host'"
+        puts "Error: No value provided for required option '--host'".red.bold
         exit 1
       end
     end
@@ -220,8 +222,8 @@ module IDRAC
     def check_ssl_verification
       # If verify_ssl is not explicitly set in the command line, show a warning
       unless ARGV.include?('--verify-ssl') || ARGV.include?('--no-verify-ssl')
-        puts "WARNING: SSL verification is disabled by default. iDRAC typically uses self-signed certificates."
-        puts "         Use --verify-ssl if you want to enable SSL verification."
+        puts "WARNING: SSL verification is disabled by default. iDRAC typically uses self-signed certificates.".yellow
+        puts "         Use --verify-ssl if you want to enable SSL verification.".yellow
         puts ""
       end
     end

data/dell_firmware_downloads/Catalog.etag

@@ -0,0 +1 @@
+"8e46be845f83db1:0"

data/idrac-0.1.6/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/idrac-0.1.6/README.md

@@ -0,0 +1,103 @@
+# IDRAC
+
+A Ruby client for the Dell iDRAC API. This gem provides a command-line interface and a Ruby API for interacting with Dell iDRAC servers.
+
+## Features
+
+- Take screenshots of the iDRAC console
+- Update firmware using Dell's catalog
+- Check for firmware updates
+- Interactive firmware update process
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'idrac'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install idrac
+
+## Usage
+
+### Command Line Interface
+
+The gem provides a command-line interface for interacting with iDRAC servers:
+
+```bash
+# Take a screenshot of the iDRAC console
+idrac screenshot --host=192.168.1.100 --username=root --password=calvin
+# Specify a custom output filename
+idrac screenshot --host=192.168.1.100 --username=root --password=calvin --output=my_screenshot.png
+
+# Download the Dell firmware catalog
+idrac firmware:catalog --host=192.168.1.100 --username=root --password=calvin
+
+# Check firmware status and available updates
+idrac firmware:status --host=192.168.1.100 --username=root --password=calvin
+
+# Update firmware using a specific file
+idrac firmware:update /path/to/firmware.exe --host=192.168.1.100 --username=root --password=calvin
+
+# Interactive firmware update
+idrac firmware:interactive --host=192.168.1.100 --username=root --password=calvin
+```
+
+### Ruby API
+
+```ruby
+require 'idrac'
+
+# Create a client
+client = IDRAC.new(
+  host: '192.168.1.100',
+  username: 'root',
+  password: 'calvin'
+)
+
+# Take a screenshot (using the client convenience method)
+filename = client.screenshot
+puts "Screenshot saved to: #{filename}"
+
+# Or use the Screenshot class directly for more control
+screenshot = IDRAC::Screenshot.new(client)
+filename = screenshot.capture
+puts "Screenshot saved to: #{filename}"
+
+# Firmware operations
+firmware = IDRAC::Firmware.new(client)
+
+# Download catalog
+catalog_path = firmware.download_catalog
+
+# Get system inventory
+inventory = firmware.get_system_inventory
+puts "Service Tag: #{inventory[:system][:service_tag]}"
+
+# Check for updates
+updates = firmware.check_updates(catalog_path)
+updates.each do |update|
+  puts "#{update[:name]}: #{update[:current_version]} -> #{update[:available_version]}"
+end
+
+# Update firmware
+job_id = firmware.update('/path/to/firmware.exe', wait: true)
+puts "Update completed with job ID: #{job_id}"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/usiegj00/idrac.

data/idrac-0.1.6/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+# Add a task that tags and pushes to the repository and builds 
+# the gem and pushes it to rubygems.org.
+# Depend on the build task to ensure the gem is up to date.
+task :release => [:build] do
+  system "git tag v#{Idrac::VERSION}"
+  system "git push --tags"
+  system "gem push pkg/idrac-#{Idrac::VERSION}.gem"
+end

data/idrac-0.1.6/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "idrac"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/idrac-0.1.6/bin/idrac

@@ -0,0 +1,179 @@
+#!/usr/bin/env ruby
+
+# Attempt to load bundler/setup, but don't fail if it's not available
+begin
+  require "bundler/setup"
+rescue LoadError
+  # Continue without bundler
+end
+
+# Load required gems directly
+require "thor"
+require "idrac"
+
+module IDRAC
+  class CLI < Thor
+    class_option :host, type: :string, required: true, desc: "iDRAC host address"
+    class_option :username, type: :string, required: true, desc: "iDRAC username"
+    class_option :password, type: :string, required: true, desc: "iDRAC password"
+    class_option :port, type: :numeric, default: 443, desc: "iDRAC port"
+    class_option :no_ssl, type: :boolean, default: false, desc: "Disable SSL"
+    class_option :no_verify_ssl, type: :boolean, default: false, desc: "Disable SSL verification"
+
+    desc "firmware:update PATH", "Update firmware using the specified file"
+    method_option :wait, type: :boolean, default: true, desc: "Wait for the update to complete"
+    method_option :timeout, type: :numeric, default: 3600, desc: "Timeout in seconds when waiting"
+    def firmware_update(path)
+      client = create_client
+      firmware = IDRAC::Firmware.new(client)
+      
+      begin
+        job_id = firmware.update(path, wait: options[:wait], timeout: options[:timeout])
+        puts "Firmware update initiated with job ID: #{job_id}"
+      rescue IDRAC::Error => e
+        puts "Error: #{e.message}"
+        exit 1
+      ensure
+        client.logout
+      end
+    end
+    
+    desc "firmware:catalog [DIRECTORY]", "Download Dell firmware catalog"
+    def firmware_catalog(directory = nil)
+      client = create_client
+      firmware = IDRAC::Firmware.new(client)
+      
+      begin
+        catalog_path = firmware.download_catalog(directory)
+        puts "Catalog downloaded to: #{catalog_path}"
+      rescue IDRAC::Error => e
+        puts "Error: #{e.message}"
+        exit 1
+      ensure
+        client.logout
+      end
+    end
+    
+    desc "firmware:status", "Show current firmware status and available updates"
+    method_option :catalog, type: :string, desc: "Path to existing catalog file"
+    def firmware_status
+      client = create_client
+      firmware = IDRAC::Firmware.new(client)
+      
+      begin
+        # Get system inventory
+        inventory = firmware.get_system_inventory
+        
+        puts "System Information:"
+        puts "  Model: #{inventory[:system][:model]}"
+        puts "  Manufacturer: #{inventory[:system][:manufacturer]}"
+        puts "  Service Tag: #{inventory[:system][:service_tag]}"
+        puts "  BIOS Version: #{inventory[:system][:bios_version]}"
+        
+        puts "\nInstalled Firmware:"
+        inventory[:firmware].each do |fw|
+          puts "  #{fw[:name]}: #{fw[:version]} (#{fw[:updateable] ? 'Updateable' : 'Not Updateable'})"
+        end
+        
+        # Check for updates if catalog is available
+        if options[:catalog] || File.exist?(File.join(Dir.pwd, "Catalog.xml"))
+          catalog_path = options[:catalog] || File.join(Dir.pwd, "Catalog.xml")
+          puts "\nChecking for updates using catalog: #{catalog_path}"
+          
+          updates = firmware.check_updates(catalog_path)
+          
+          if updates.empty?
+            puts "No updates available."
+          else
+            puts "\nAvailable Updates:"
+            updates.each do |update|
+              puts "  #{update[:name]}: #{update[:current_version]} -> #{update[:available_version]}"
+            end
+          end
+        else
+          puts "\nTo check for updates, download the catalog first with 'idrac firmware:catalog'"
+        end
+      rescue IDRAC::Error => e
+        puts "Error: #{e.message}"
+        exit 1
+      ensure
+        client.logout
+      end
+    end
+    
+    desc "firmware:interactive", "Interactive firmware update"
+    method_option :catalog, type: :string, desc: "Path to existing catalog file"
+    def firmware_interactive
+      client = create_client
+      firmware = IDRAC::Firmware.new(client)
+      
+      begin
+        catalog_path = options[:catalog]
+        
+        # If no catalog specified, check if one exists in current directory
+        if catalog_path.nil? && File.exist?(File.join(Dir.pwd, "Catalog.xml"))
+          catalog_path = File.join(Dir.pwd, "Catalog.xml")
+        end
+        
+        # If still no catalog, download it
+        if catalog_path.nil?
+          puts "No catalog found. Downloading..."
+          catalog_path = firmware.download_catalog
+        end
+        
+        firmware.interactive_update(catalog_path)
+      rescue IDRAC::Error => e
+        puts "Error: #{e.message}"
+        exit 1
+      ensure
+        client.logout
+      end
+    end
+    
+    desc "screenshot", "Take a screenshot of the current iDRAC console"
+    method_option :output, type: :string, desc: "Output filename (default: idrac_screenshot_timestamp.png)"
+    def screenshot
+      client = create_client
+      
+      begin
+        # Create a Screenshot instance directly
+        screenshot = IDRAC::Screenshot.new(client)
+        filename = screenshot.capture
+        
+        # Rename the file if output option is provided
+        if options[:output]
+          new_filename = options[:output]
+          File.rename(filename, new_filename)
+          filename = new_filename
+        end
+        
+        puts "Screenshot saved to: #{filename}"
+      rescue IDRAC::Error => e
+        puts "Error: #{e.message}"
+        exit 1
+      ensure
+        client.logout
+      end
+    end
+    
+    map "firmware:update" => :firmware_update
+    map "firmware:catalog" => :firmware_catalog
+    map "firmware:status" => :firmware_status
+    map "firmware:interactive" => :firmware_interactive
+
+    private
+
+    def create_client
+      IDRAC::Client.new(
+        host: options[:host],
+        username: options[:username],
+        password: options[:password],
+        port: options[:port],
+        use_ssl: !options[:no_ssl],
+        verify_ssl: !options[:no_verify_ssl]
+      )
+    end
+  end
+end
+
+IDRAC::CLI.start(ARGV) 

data/idrac-0.1.6/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/idrac-0.1.6/idrac.gemspec

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "lib/idrac/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "idrac"
+  spec.version = IDRAC::VERSION
+  spec.authors = ["Jonathan Siegel"]
+  spec.email = ["<248302+usiegj00@users.noreply.github.com>"]
+
+  spec.summary = "API Client for Dell iDRAC"
+  spec.description = "A Ruby client for the Dell iDRAC API"
+  spec.homepage = "http://github.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0" # Updated to support Ruby 3.2.x
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "bin"
+  spec.executables = ["idrac"]
+  spec.require_paths = ["lib"]
+
+  # Dependencies - Using more flexible version constraints
+  spec.add_dependency "httparty", ">= 0.21.0", "< 0.22.0"
+  spec.add_dependency "nokogiri", ">= 1.15.0", "< 1.19.0"
+  spec.add_dependency "faraday", ">= 2.7.0", "< 2.8.0"
+  spec.add_dependency "faraday-multipart", ">= 1.0.0", "< 1.1.0"
+  spec.add_dependency "thor", ">= 1.2.0", "< 1.4.0"
+  spec.add_dependency "base64", "~> 0.1", ">= 0.1.0"
+
+  # Development dependencies
+  spec.add_development_dependency "bundler", "~> 2.4", ">= 2.4.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "debug", "~> 1.8"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end