Merge pull request #3503 from jake-the-dev/coverage-improvements

Test coverage improvements - Core

Author: zinduolis

core/filters/browser.rb

@@ -8,7 +8,7 @@ module Filters
     # Check the browser type value - for example, 'FF'
     # @param [String] str String for testing
     # @return [Boolean] If the string has valid browser name characters
-    def self.is_valid_browsername?(str)
+    def self.is_valid_browsername?(str) # rubocop:disable Naming/PredicatePrefix
       return false unless is_non_empty_string?(str)
       return false if str.length > 2
       return false if has_non_printable_char?(str)
@@ -19,7 +19,7 @@ def self.is_valid_browsername?(str)
     # Check the Operating System name value - for example, 'Windows XP'
     # @param [String] str String for testing
     # @return [Boolean] If the string has valid Operating System name characters
-    def self.is_valid_osname?(str)
+    def self.is_valid_osname?(str) # rubocop:disable Naming/PredicatePrefix
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length < 2
@@ -30,7 +30,7 @@ def self.is_valid_osname?(str)
     # Check the Hardware name value - for example, 'iPhone'
     # @param [String] str String for testing
     # @return [Boolean] If the string has valid Hardware name characters
-    def self.is_valid_hwname?(str)
+    def self.is_valid_hwname?(str) # rubocop:disable Naming/PredicatePrefix
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length < 2
@@ -41,12 +41,12 @@ def self.is_valid_hwname?(str)
     # Verify the browser version string is valid
     # @param [String] str String for testing
     # @return [Boolean] If the string has valid browser version characters
-    def self.is_valid_browserversion?(str)
+    def self.is_valid_browserversion?(str) # rubocop:disable Naming/PredicatePrefix
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return true if str.eql? 'UNKNOWN'
       return true if str.eql? 'ALL'
-      return false if !nums_only?(str) and !str.match(/\A(0|[1-9][0-9]{0,3})(\.(0|[1-9][0-9]{0,3})){0,3}\z/)
+      return false if !nums_only?(str) && !str.match(/\A(0|[1-9][0-9]{0,3})(\.(0|[1-9][0-9]{0,3})){0,3}\z/)
       return false if str.length > 20
 
       true
@@ -55,7 +55,7 @@ def self.is_valid_browserversion?(str)
     # Verify the os version string is valid
     # @param [String] str String for testing
     # @return [Boolean] If the string has valid os version characters
-    def self.is_valid_osversion?(str)
+    def self.is_valid_osversion?(str) # rubocop:disable Naming/PredicatePrefix
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return true if str.eql? 'UNKNOWN'
@@ -69,7 +69,7 @@ def self.is_valid_osversion?(str)
     # Verify the browser/UA string is valid
     # @param [String] str String for testing
     # @return [Boolean] If the string has valid browser / ua string characters
-    def self.is_valid_browserstring?(str)
+    def self.is_valid_browserstring?(str) # rubocop:disable Naming/PredicatePrefix
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length > 300
@@ -80,7 +80,7 @@ def self.is_valid_browserstring?(str)
     # Verify the cookies are valid
     # @param [String] str String for testing
     # @return [Boolean] If the string has valid cookie characters
-    def self.is_valid_cookies?(str)
+    def self.is_valid_cookies?(str) # rubocop:disable Naming/PredicatePrefix
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length > 2000
@@ -91,7 +91,7 @@ def self.is_valid_cookies?(str)
     # Verify the system platform is valid
     # @param [String] str String for testing
     # @return [Boolean] If the string has valid system platform characters
-    def self.is_valid_system_platform?(str)
+    def self.is_valid_system_platform?(str) # rubocop:disable Naming/PredicatePrefix
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length > 200
@@ -102,7 +102,7 @@ def self.is_valid_system_platform?(str)
     # Verify the date stamp is valid
     # @param [String] str String for testing
     # @return [Boolean] If the string has valid date stamp characters
-    def self.is_valid_date_stamp?(str)
+    def self.is_valid_date_stamp?(str) # rubocop:disable Naming/PredicatePrefix
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length > 200
@@ -113,7 +113,7 @@ def self.is_valid_date_stamp?(str)
     # Verify the CPU type string is valid
     # @param [String] str String for testing
     # @return [Boolean] If the string has valid CPU type characters
-    def self.is_valid_cpu?(str)
+    def self.is_valid_cpu?(str) # rubocop:disable Naming/PredicatePrefix
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length > 200
@@ -124,7 +124,7 @@ def self.is_valid_cpu?(str)
     # Verify the memory string is valid
     # @param [String] str String for testing
     # @return [Boolean] If the string has valid memory type characters
-    def self.is_valid_memory?(str)
+    def self.is_valid_memory?(str) # rubocop:disable Naming/PredicatePrefix
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length > 200
@@ -135,7 +135,7 @@ def self.is_valid_memory?(str)
     # Verify the GPU type string is valid
     # @param [String] str String for testing
     # @return [Boolean] If the string has valid GPU type characters
-    def self.is_valid_gpu?(str)
+    def self.is_valid_gpu?(str) # rubocop:disable Naming/PredicatePrefix
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length > 200
@@ -148,11 +148,11 @@ def self.is_valid_gpu?(str)
     # @return [Boolean] If the string has valid browser plugin characters
     # @note This string can be empty if there are no browser plugins
     # @todo Verify if the ruby version statement is still necessary
-    def self.is_valid_browser_plugins?(str)
+    def self.is_valid_browser_plugins?(str) # rubocop:disable Naming/PredicatePrefix
       return false unless is_non_empty_string?(str)
       return false if str.length > 1000
 
-      if str.encoding === Encoding.find('UTF-8')
+      if str.encoding == Encoding.find('UTF-8') # Style/CaseEquality: Avoid the use of the case equality operator `===`.
         (str =~ /[^\w\d\s()-.,';_!\302\256]/u).nil?
       else
         (str =~ /[^\w\d\s()-.,';_!\302\256]/n).nil?

modules/social_engineering/text_to_voice/module.rb

@@ -4,17 +4,23 @@
 # See the file 'doc/COPYING' for copying permission
 #
 class Text_to_voice < BeEF::Core::Command
-  require 'espeak'
-  include ESpeak
-
   def pre_send
-    # Ensure lame and espeak are installed
+    # Check for required binaries
+    if IO.popen(%w[which espeak], 'r').read.to_s.eql?('')
+      print_error('[Text to Voice] eSpeak is not in $PATH (brew install espeak on macOS, apt-get install espeak on Linux)')
+      return
+    end
     if IO.popen(%w[which lame], 'r').read.to_s.eql?('')
-      print_error('[Text to Voice] Lame is not in $PATH (apt-get install lame)')
+      print_error('[Text to Voice] Lame is not in $PATH (brew install lame on macOS, apt-get install lame on Linux)')
       return
     end
-    if IO.popen(%w[which espeak], 'r').read.to_s.eql?('')
-      print_error('[Text to Voice] eSpeak is not in $PATH (apt-get install espeak)')
+
+    # Load espeak gem (only if binaries are available)
+    begin
+      require 'espeak'
+      include ESpeak
+    rescue LoadError, StandardError => e
+      print_error("[Text to Voice] Failed to load espeak gem: #{e.message}")
       return
     end
 
@@ -25,9 +31,16 @@ def pre_send
       message  = input['value'] if input['name'] == 'message'
       language = input['value'] if input['name'] == 'language'
     end
-    unless Voice.all.map(&:language).include?(language)
-      print_error("[Text to Voice] Language '#{language}' is not supported")
-      print_more("Supported languages: #{Voice.all.map(&:language).join(',')}")
+    
+    # Validate language
+    begin
+      unless Voice.all.map(&:language).include?(language)
+        print_error("[Text to Voice] Language '#{language}' is not supported")
+        print_more("Supported languages: #{Voice.all.map(&:language).join(',')}")
+        return
+      end
+    rescue StandardError => e
+      print_error("[Text to Voice] Could not validate language: #{e.message}")
       return
     end
 

spec/beef/core/extension_spec.rb

@@ -0,0 +1,100 @@
+#
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
+#
+
+RSpec.describe BeEF::Extension do
+  let(:config) { BeEF::Core::Configuration.instance }
+
+  describe '.is_present' do
+    it 'returns true when extension exists in configuration' do
+      allow(config).to receive(:get).with('beef.extension').and_return({ 'test_ext' => {} })
+      expect(described_class.is_present('test_ext')).to be true
+    end
+
+    it 'returns false when extension does not exist' do
+      allow(config).to receive(:get).with('beef.extension').and_return({})
+      expect(described_class.is_present('nonexistent')).to be false
+    end
+
+    it 'converts extension key to string' do
+      allow(config).to receive(:get).with('beef.extension').and_return({ 'test_ext' => {} })
+      expect(described_class.is_present(:test_ext)).to be true
+    end
+  end
+
+  describe '.is_enabled' do
+    it 'returns true when extension is present and enabled' do
+      allow(config).to receive(:get).with('beef.extension').and_return({ 'test_ext' => {} })
+      allow(config).to receive(:get).with('beef.extension.test_ext.enable').and_return(true)
+      expect(described_class.is_enabled('test_ext')).to be true
+    end
+
+    it 'returns false when extension is not present' do
+      allow(config).to receive(:get).with('beef.extension').and_return({})
+      expect(described_class.is_enabled('nonexistent')).to be false
+    end
+
+    it 'returns false when extension is disabled' do
+      allow(config).to receive(:get).with('beef.extension').and_return({ 'test_ext' => {} })
+      allow(config).to receive(:get).with('beef.extension.test_ext.enable').and_return(false)
+      expect(described_class.is_enabled('test_ext')).to be false
+    end
+  end
+
+  describe '.is_loaded' do
+    it 'returns true when extension is enabled and loaded' do
+      allow(config).to receive(:get).with('beef.extension').and_return({ 'test_ext' => {} })
+      allow(config).to receive(:get).with('beef.extension.test_ext.enable').and_return(true)
+      allow(config).to receive(:get).with('beef.extension.test_ext.loaded').and_return(true)
+      expect(described_class.is_loaded('test_ext')).to be true
+    end
+
+    it 'returns false when extension is not enabled' do
+      allow(config).to receive(:get).with('beef.extension').and_return({ 'test_ext' => {} })
+      allow(config).to receive(:get).with('beef.extension.test_ext.enable').and_return(false)
+      expect(described_class.is_loaded('test_ext')).to be false
+    end
+
+    it 'returns false when extension is not loaded' do
+      allow(config).to receive(:get).with('beef.extension').and_return({ 'test_ext' => {} })
+      allow(config).to receive(:get).with('beef.extension.test_ext.enable').and_return(true)
+      allow(config).to receive(:get).with('beef.extension.test_ext.loaded').and_return(false)
+      expect(described_class.is_loaded('test_ext')).to be false
+    end
+  end
+
+  describe '.load' do
+    it 'returns true when extension file exists' do
+      ext_path = "#{$root_dir}/extensions/test_ext/extension.rb"
+      allow(File).to receive(:exist?).with(ext_path).and_return(true)
+      allow(config).to receive(:set).with('beef.extension.test_ext.loaded', true).and_return(true)
+      # Stub require on the module itself since it's called directly
+      allow(described_class).to receive(:require).with(ext_path)
+      expect(described_class.load('test_ext')).to be true
+    end
+
+    it 'returns false when extension file does not exist' do
+      ext_path = "#{$root_dir}/extensions/test_ext/extension.rb"
+      allow(File).to receive(:exist?).with(ext_path).and_return(false)
+      expect(described_class.load('test_ext')).to be false
+    end
+
+    it 'sets loaded flag to true when successfully loaded' do
+      ext_path = "#{$root_dir}/extensions/test_ext/extension.rb"
+      allow(File).to receive(:exist?).with(ext_path).and_return(true)
+      allow(described_class).to receive(:require).with(ext_path)
+      expect(config).to receive(:set).with('beef.extension.test_ext.loaded', true).and_return(true)
+      described_class.load('test_ext')
+    end
+
+    it 'handles errors during loading gracefully' do
+      ext_path = "#{$root_dir}/extensions/test_ext/extension.rb"
+      allow(File).to receive(:exist?).with(ext_path).and_return(true)
+      allow(described_class).to receive(:require).with(ext_path).and_raise(StandardError.new('Load error'))
+      # The rescue block calls print_more which may return a value, so just verify it doesn't raise
+      expect { described_class.load('test_ext') }.not_to raise_error
+    end
+  end
+end

spec/beef/core/extensions_spec.rb

@@ -1,3 +1,9 @@
+#
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
+#
+
 RSpec.describe 'BeEF Extensions' do
 
   it 'loaded successfully' do