Test coverage improvements - Core #3503

jake-the-dev · 2026-01-22T07:55:55Z

Pull Request

Thanks for submitting a PR! Please fill in this template where appropriate:

Feature/Issue Description

Q: Please give a brief summary of your feature/fix
A: Improving test coverage utilising SimpleCov for tracking. I understand this PR is massive, but I don't think there's a quick way of introducing a large amount of coverage. This may be the least painful way.

Current coverage overview:

Current result from tests:
(note, pending tests already existed)

NOTE: the creation of tests has been AI assisted but also painstakingly reviewed and adjusted for each and every file.

Q: Give a technical rundown of what you have changed (if applicable)
A: I'm going through the beef/core files and creating tests for them ensure the core functionality is tested and trusted.
Trying not to change any business logic - only some lint issues as I come across them due to updates in Ruby over time.

Test Cases

Q: Describe your test cases, what you have covered and if there are any use cases that still need addressing.
A: Anything and everything in beef/core. Not touching beef/extensions or been/modules in this PR as it's already large enough.

Wiki Page

If you are adding a new feature that is not easily understood without context, please draft a section to be added to the Wiki below.
N/A

jake-the-dev · 2026-01-22T07:58:10Z

modules/social_engineering/text_to_voice/module.rb

+    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}")


Additional logging to help with new installs. This caught me out.

jake-the-dev · 2026-01-22T07:59:31Z

spec/beef/core/filter/base_spec.rb

+RSpec.describe BeEF::Filters do
+  describe '.is_non_empty_string?' do
+    it 'nil' do
+      expect(BeEF::Filters.is_non_empty_string?(nil)).to be(false)
+    end


Replaces the old filters_spec.rb that was missing methods and combined different files. This is more specific

zinduolis · 2026-01-26T22:54:49Z

Hey @jake-the-dev ,

Are you still working on this PR or it's ready for review? I can see its status is Draft.

Thanks

jake-the-dev · 2026-01-26T23:02:53Z

Hey @jake-the-dev ,

Are you still working on this PR or it's ready for review? I can see its status is Draft.

Thanks

Hi @zinduolis , I initially intended to continue this until core was sufficiently covered. However on Friday Wade had asked for this to be merged.

I don't have the permissions so i assumed he was going to merge - or maybe thats something he left with you?

To clarify - I will remove draft and any further iterations to core tests will be in another pr.

Feel free to review if you wish, no functional code should be changed so it should all just be assertions on existing logic.

zinduolis · 2026-01-26T23:04:50Z

Thanks, @jake-the-dev , just click Ready for review and I will review it and will let you know when you're good to merge (Wade asked me to review it). If you don't have permissions to merge, i'll happy to do that on your behalf once successful review.

zinduolis · 2026-01-27T00:54:03Z

spec/beef/core/main/command_spec.rb

+
+  describe '#oc_value' do
+    it 'returns option value when option exists' do
+      option = BeEF::Core::Models::OptionCache.create!(name: 'test_option', value: 'test_value')


@jake-the-dev , could you please remove the 'option' line?

zinduolis · 2026-01-26T23:37:19Z

spec/beef/core/api/registrar_spec.rb

I have impression that Wade would like to deprecate the beef APIs, thus API testing would be redundant. Please check with him whether that has changed. Thanks

zinduolis · 2026-01-27T01:02:27Z

spec/beef/core/main/crypto_spec.rb

+    end
+  end
+
+  describe '.api_token' do


this is probably redundant given plan to deprecate APIs

zinduolis · 2026-01-27T01:43:34Z

Hi @jake-the-dev ,

I've noticed a lot of spec files are missing the Copyright statement at the top. Could you please add it? Thanks

zinduolis · 2026-01-27T01:53:00Z

spec/beef/core/main/rest/api_spec.rb

One more API related test that will likely need to be removed given plan to deprecate APIs.

zinduolis · 2026-01-27T01:54:10Z

spec/beef/core/main/rest/handlers/browserdetails_spec.rb

One more API related test that will likely need to be removed given plan to deprecate APIs.

zinduolis · 2026-01-27T01:55:31Z

spec/beef/core/main/rest/handlers/categories_spec.rb

One more API related test that will likely need to be removed given plan to deprecate APIs.

zinduolis · 2026-01-27T01:57:21Z

spec/beef/core/main/rest/handlers/logs_spec.rb

One more API related test that will likely need to be removed given plan to deprecate APIs.

jake-the-dev added 13 commits January 22, 2026 14:23

ADD: simplecov

9b22d92

FIX: espeak text_to_voice install help

b2d8320

TEST: core/ruby method specs

0970bdc

TEST: core/logger spec

96a0891

TEST: core/settings spec

d678c48

TEST: core/crypo spec

ac3f14b

TEST: core/migration spec

e92da3b

TEST: move filters to filters/base spec

45a046e

UPDATE: rubocop lints on browser.rb

5872df9

TEST: remaining core/filter specs

f923285

FIX: command_spec test

32af09b

TEST: core/models legacybrwosseruseragents optioncache specs

6377b02

FIX: isolate beef modules spec

f847cd0

jake-the-dev temporarily deployed to Integrate Pull Request January 22, 2026 07:55 — with GitHub Actions Inactive

jake-the-dev marked this pull request as draft January 22, 2026 07:57

jake-the-dev changed the title ~~Test coverage improvements~~ WIP | Test coverage improvements Jan 22, 2026

jake-the-dev commented Jan 22, 2026

View reviewed changes

jake-the-dev added 2 commits January 23, 2026 11:16

TEST: core/main/handlers specs

20c69be

TEST: core/main/models specs

8423b37

jake-the-dev temporarily deployed to Integrate Pull Request January 23, 2026 01:32 — with GitHub Actions Inactive

jake-the-dev added 4 commits January 23, 2026 12:56

TEST: core main network specs

5869656

TEST: core main rest specs

d3aef8a

TEST: core api registrar spec

ec4d739

TEST: core module spec

6ca679d

jake-the-dev temporarily deployed to Integrate Pull Request January 23, 2026 04:38 — with GitHub Actions Inactive

TEST: core main router spec

d54ec67

jake-the-dev temporarily deployed to Integrate Pull Request January 23, 2026 05:27 — with GitHub Actions Inactive

jake-the-dev added 2 commits January 23, 2026 15:32

TEST: core main server spec

8b54f67

TEST: core main geoip spec

7178460

jake-the-dev added 3 commits January 23, 2026 16:35

TEST: core main command spec

647500c

TEST: core main handlers browserdetails

35c3912

TEST: core main handlers

95052f2

jake-the-dev temporarily deployed to Integrate Pull Request January 23, 2026 06:47 — with GitHub Actions Inactive

jake-the-dev changed the title ~~WIP | Test coverage improvements~~ Test coverage improvements - Core Jan 23, 2026

github-advanced-security bot found potential problems Jan 26, 2026

View reviewed changes

zinduolis reviewed Jan 26, 2026

View reviewed changes

jake-the-dev marked this pull request as ready for review January 26, 2026 23:54

zinduolis reviewed Jan 27, 2026

View reviewed changes

spec/beef/core/main/crypto_spec.rb

end

end

describe '.api_token' do

Copy link

Contributor

zinduolis Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is probably redundant given plan to deprecate APIs

zinduolis reviewed Jan 27, 2026

View reviewed changes

spec/beef/core/main/rest/api_spec.rb

Copy link

Contributor

zinduolis Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more API related test that will likely need to be removed given plan to deprecate APIs.

zinduolis reviewed Jan 27, 2026

View reviewed changes

Test coverage improvements - Core #3503

Are you sure you want to change the base?

Test coverage improvements - Core #3503

Conversation

jake-the-dev commented Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

Category

Feature/Issue Description

Test Cases

Wiki Page

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zinduolis commented Jan 26, 2026

Uh oh!

jake-the-dev commented Jan 26, 2026

Uh oh!

zinduolis commented Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Check warning

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zinduolis commented Jan 27, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jake-the-dev commented Jan 22, 2026 •

edited

Loading

zinduolis commented Jan 26, 2026 •

edited

Loading