beefproject-beef/spec/beef/modules/misc/misc_spec.rb

#
# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
# Browser Exploitation Framework (BeEF) - https://beefproject.com
# See the file 'doc/COPYING' for copying permission
#
# Unit tests for every module under modules/misc/ (including subdirs).
# Branch coverage: extra post_execute runs for modules in
# BeefTestConfig.branch_coverage_for(:misc) (defined in spec_helper.rb).
#

require_relative '../../../spec_helper'

project_root = File.expand_path('../../../../', __dir__)
paths = Dir[File.join(project_root, 'modules/misc/**/module.rb')].sort

BRANCH_COVERAGE_MISC = BeefTestConfig.branch_coverage_for(:misc)

paths.each do |path|
  rel = path.sub("#{project_root}/", '').sub(/\.rb$/, '')
  branch_key = File.dirname(path).sub("#{project_root}/", '')
  require_path = File.join('../../../../', rel)
  class_line = File.read(path).lines.find { |l| l =~ /\bclass\s+(\w+)\s+<\s+(?:\w+|BeEF::\w+(?:::\w+)*)/ }
  next unless class_line

  klass_name = class_line.match(/\bclass\s+(\w+)\s+<\s+(?:\w+|BeEF::\w+(?:::\w+)*)/)[1]
  require_relative require_path
  mod = Object.const_get(klass_name)

  RSpec.describe mod do
    if described_class.respond_to?(:options)
      describe '.options' do
        it 'returns an Array' do
          config = instance_double(BeEF::Core::Configuration)
          allow(config).to receive(:beef_host).and_return('127.0.0.1')
          allow(config).to receive(:beef_port).and_return('3000')
          allow(config).to receive(:beef_proto).and_return('http')
          allow(config).to receive(:get).with(anything).and_return('127.0.0.1')
          allow(BeEF::Core::Configuration).to receive(:instance).and_return(config)
          expect(described_class.options).to be_an(Array)
        end
      end

      # Targeted structural assertions for selected misc modules. Higher value than
      # the generic smoke test: checks option count, names, types and shape.
      if klass_name == 'Wordpress_add_user'
        describe '.options (Wordpress_add_user specifics)' do
          it 'includes wordpress path and user options' do
            config = instance_double(BeEF::Core::Configuration)
            allow(config).to receive(:beef_host).and_return('127.0.0.1')
            allow(config).to receive(:beef_port).and_return('3000')
            allow(config).to receive(:beef_proto).and_return('http')
            allow(config).to receive(:get).with(anything).and_return('127.0.0.1')
            allow(BeEF::Core::Configuration).to receive(:instance).and_return(config)

            options = described_class.options
            expect(options).to be_an(Array)
            expect(options.length).to eq(5) # wp_path (parent) + username, password, email, role

            wp_path_option = options.find { |opt| opt['name'] == 'wp_path' }
            expect(wp_path_option).not_to be_nil
            expect(wp_path_option['value']).to eq('/')

            username_option = options.find { |opt| opt['name'] == 'username' }
            expect(username_option).not_to be_nil
            expect(username_option['value']).to eq('beef')

            password_option = options.find { |opt| opt['name'] == 'password' }
            expect(password_option).not_to be_nil
            expect(password_option['value']).to be_a(String)
            expect(password_option['value'].length).to eq(10) # SecureRandom.hex(5) = 10 chars

            role_option = options.find { |opt| opt['name'] == 'role' }
            expect(role_option).not_to be_nil
            expect(role_option['value']).to eq('administrator')
          end
        end
      end

      if klass_name == 'Test_get_variable'
        describe '.options (Test_get_variable specifics)' do
          it 'returns payload_name option with correct structure' do
            config = instance_double(BeEF::Core::Configuration)
            allow(config).to receive(:beef_host).and_return('127.0.0.1')
            allow(config).to receive(:beef_port).and_return('3000')
            allow(config).to receive(:beef_proto).and_return('http')
            allow(config).to receive(:get).with(anything).and_return('127.0.0.1')
            allow(BeEF::Core::Configuration).to receive(:instance).and_return(config)

            options = described_class.options
            expect(options).to be_an(Array)
            expect(options.length).to eq(1)

            option = options.first
            expect(option['name']).to eq('payload_name')
            expect(option['ui_label']).to eq('Payload Name')
            expect(option['type']).to eq('text')
            expect(option['value']).to eq('message')
            expect(option['width']).to eq('400px')
          end
        end
      end
    end

    if described_class.method_defined?(:pre_send)
      describe '#pre_send' do
        it 'runs without error' do
          handler = instance_double('AssetHandler')
          allow(handler).to receive(:unbind).and_return(nil)
          allow(handler).to receive(:bind).and_return(nil)
          allow(handler).to receive(:bind_raw).and_return(nil)
          allow(handler).to receive(:remap).and_return(nil)
          allow(BeEF::Core::NetworkStack::Handlers::AssetHandler).to receive(:instance).and_return(handler)
          config = instance_double(BeEF::Core::Configuration)
          allow(config).to receive(:get).with(anything).and_return('127.0.0.1')
          allow(BeEF::Core::Configuration).to receive(:instance).and_return(config)
          allow(IO).to receive(:popen).and_return(StringIO.new(''))
          instance = build_command_instance(described_class, 'result' => '', 'results' => '', 'cid' => '0')
          expect { run_pre_send(instance) }.not_to raise_error
        end
      end
    end

    if described_class.method_defined?(:post_execute)
      describe '#post_execute' do
        it 'runs without error' do
          handler = instance_double('AssetHandler')
          allow(handler).to receive(:unbind)
          allow(handler).to receive(:bind)
          allow(handler).to receive(:remap)
          allow(handler).to receive(:bind_raw)
          allow(BeEF::Core::NetworkStack::Handlers::AssetHandler).to receive(:instance).and_return(handler)
          file_double = double('File').as_null_object
          allow(File).to receive(:open).and_return(file_double)
          allow(BeEF::Core::Models::Command).to receive(:save_result)
          allow_any_instance_of(described_class).to receive(:ip).and_return('0.0.0.0')
          allow_any_instance_of(described_class).to receive(:timestamp).and_return('0')
          instance = build_command_instance(described_class, 'result' => '', 'results' => '', 'cid' => '0')
          expect { run_post_execute(instance) }.not_to raise_error
        end

        if BRANCH_COVERAGE_MISC[branch_key]
          it 'runs branch path with realistic datastore' do
            branch = BRANCH_COVERAGE_MISC[branch_key]

            handler = instance_double('AssetHandler')
            allow(handler).to receive(:unbind)
            allow(handler).to receive(:bind)
            allow(handler).to receive(:remap)
            allow(handler).to receive(:bind_raw)
            allow(BeEF::Core::NetworkStack::Handlers::AssetHandler).to receive(:instance).and_return(handler)
            file_double = double('File').as_null_object
            allow(File).to receive(:open).and_return(file_double)
            allow(BeEF::Core::Models::Command).to receive(:save_result)
            allow_any_instance_of(described_class).to receive(:ip).and_return('0.0.0.0')
            allow_any_instance_of(described_class).to receive(:timestamp).and_return('0')
            instance = build_command_instance(described_class, branch[:datastore])
            expect { run_post_execute(instance) }.not_to raise_error
          end
        end
      end
    end
  end
end