Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Check if :appsec setting is present before accessing it in remote component #2854

Merged
merged 1 commit into from
May 17, 2023
Merged

Check if :appsec setting is present before accessing it in remote component #2854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/datadog/core/remote/client/capabilities.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ def initialize(settings)
private

def register(settings)
if settings.appsec.enabled
if settings.respond_to?(:appsec) && settings.appsec.enabled
Comment on lines 25 to +26
Copy link
Member

Choose a reason for hiding this comment

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

To be honest, this is why I'm not a big fan of patching behavior into core classes, especially conditionally; it makes is a bit hard to reason about what's there or what's not and only really gives the illusion of things being separate.

Copy link
Member Author

Choose a reason for hiding this comment

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

Agree 👍

register_capabilities(Datadog::AppSec::Remote.capabilities)
register_products(Datadog::AppSec::Remote.products)
register_receivers(Datadog::AppSec::Remote.receivers)
Expand Down
92 changes: 56 additions & 36 deletions spec/datadog/core/remote/client/capabilities_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,54 +11,74 @@
capabilities
end

context 'when no component enabled' do
let(:settings) do
appsec_settings = Datadog::AppSec::Configuration::Settings.new
dsl = Datadog::AppSec::Configuration::DSL.new
dsl.enabled = false
appsec_settings.merge(dsl)
context 'AppSec component' do
context 'when disabled' do
let(:settings) do
appsec_settings = Datadog::AppSec::Configuration::Settings.new
dsl = Datadog::AppSec::Configuration::DSL.new
dsl.enabled = false
appsec_settings.merge(dsl)

settings = Datadog::Core::Configuration::Settings.new
expect(settings).to receive(:appsec).at_least(:once).and_return(appsec_settings)
settings = Datadog::Core::Configuration::Settings.new
expect(settings).to receive(:appsec).at_least(:once).and_return(appsec_settings)

settings
end
settings
end

it 'does not register any capabilities, products, and receivers' do
expect(capabilities.capabilities).to be_empty
expect(capabilities.products).to be_empty
expect(capabilities.receivers).to be_empty
end
it 'does not register any capabilities, products, and receivers' do
expect(capabilities.capabilities).to be_empty
expect(capabilities.products).to be_empty
expect(capabilities.receivers).to be_empty
end

describe '#base64_capabilities' do
it 'returns an empty string' do
expect(capabilities.base64_capabilities).to eq('')
describe '#base64_capabilities' do
it 'returns an empty string' do
expect(capabilities.base64_capabilities).to eq('')
end
end
end
end

context 'when a component enabled' do
let(:settings) do
appsec_settings = Datadog::AppSec::Configuration::Settings.new
dsl = Datadog::AppSec::Configuration::DSL.new
dsl.enabled = true
appsec_settings.merge(dsl)
context 'when not present' do
let(:settings) do
double(Datadog::Core::Configuration)
end

settings = Datadog::Core::Configuration::Settings.new
expect(settings).to receive(:appsec).and_return(appsec_settings)
it 'does not register any capabilities, products, and receivers' do
expect(capabilities.capabilities).to be_empty
expect(capabilities.products).to be_empty
expect(capabilities.receivers).to be_empty
end

settings
describe '#base64_capabilities' do
it 'returns an empty string' do
expect(capabilities.base64_capabilities).to eq('')
end
end
end

it 'register capabilities, products, and receivers' do
expect(capabilities.capabilities).to_not be_empty
expect(capabilities.products).to_not be_empty
expect(capabilities.receivers).to_not be_empty
end
context 'when enabled' do
let(:settings) do
appsec_settings = Datadog::AppSec::Configuration::Settings.new
dsl = Datadog::AppSec::Configuration::DSL.new
dsl.enabled = true
appsec_settings.merge(dsl)

settings = Datadog::Core::Configuration::Settings.new
expect(settings).to receive(:appsec).and_return(appsec_settings)

settings
end

it 'register capabilities, products, and receivers' do
expect(capabilities.capabilities).to_not be_empty
expect(capabilities.products).to_not be_empty
expect(capabilities.receivers).to_not be_empty
end

describe '#base64_capabilities' do
it 'returns binary capabilities' do
expect(capabilities.base64_capabilities).to eq('/A==')
describe '#base64_capabilities' do
it 'returns binary capabilities' do
expect(capabilities.base64_capabilities).to eq('/A==')
end
end
end
end
Expand Down