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

Refactor Puma spec helper methods #964

Merged
merged 1 commit into from
May 3, 2023
Merged

Refactor Puma spec helper methods #964

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
47 changes: 21 additions & 26 deletions spec/lib/puma/appsignal_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,26 +106,31 @@ def in_background(&block)
end
end
end
Puma._set_stats = stats_data
load File.expand_path("../lib/puma/plugin/appsignal.rb", APPSIGNAL_SPEC_DIR)

@statsd = StatsdServer.new
@server_thread = Thread.new { @statsd.start }
@server_thread.abort_on_exception = true
end
after do
@statsd = nil

Object.send(:remove_const, :Puma)
Object.send(:remove_const, :AppsignalPumaPlugin)
end

def run_plugin(plugin, &block)
def run_plugin(stats_data, plugin, &block)
Puma._set_stats = stats_data
@statsd = StatsdServer.new
@server_thread = Thread.new { @statsd.start }
@server_thread.abort_on_exception = true
@client_thread = Thread.new { start_plugin(plugin) }
@client_thread.abort_on_exception = true
wait_for(:puma_client_wait, &block)
ensure
stop_all
Puma._set_stats = nil
# Stop all threads in test and stop listening on the UDPSocket
@client_thread.kill if defined?(@client_thread) && @client_thread
@server_thread.kill if defined?(@server_thread) && @server_thread
@client_thread = nil
@server_thread = nil

@statsd.stop if defined?(@statsd) && @statsd
@statsd = nil
end

def appsignal_plugin
Expand All @@ -141,15 +146,6 @@ def start_plugin(plugin_class)
plugin.in_background_block.call
end

# Stop all threads in test and stop listening on the UDPSocket
def stop_all
@client_thread.kill if defined?(@client_thread) && @client_thread
@server_thread.kill if defined?(@server_thread) && @server_thread
@statsd.stop if defined?(@statsd) && @statsd
@client_thread = nil
@server_thread = nil
end

def logs
launcher.log_writer.logs
end
Expand Down Expand Up @@ -209,7 +205,7 @@ def expect_gauge(metric_name, metric_value, tags_hash = {})
end

it "collects puma stats as guage metrics with the (summed) worker metrics" do
run_plugin(appsignal_plugin) do
run_plugin(stats_data, appsignal_plugin) do
expect(logs).to_not include([:error, kind_of(String)])
expect_gauge(:workers, 2, "type" => "count")
expect_gauge(:workers, 2, "type" => "booted")
Expand All @@ -233,7 +229,7 @@ def expect_gauge(metric_name, metric_value, tags_hash = {})
end

it "calls `puma_gauge` with the (summed) worker metrics" do
run_plugin(appsignal_plugin) do
run_plugin(stats_data, appsignal_plugin) do
expect(logs).to_not include([:error, kind_of(String)])
expect_gauge(:connection_backlog, 0)
expect_gauge(:pool_capacity, 5)
Expand All @@ -249,7 +245,7 @@ def expect_gauge(metric_name, metric_value, tags_hash = {})
after { ENV.delete("APPSIGNAL_HOSTNAME") }

it "reports the APPSIGNAL_HOSTNAME as the hostname tag value" do
run_plugin(appsignal_plugin) do
run_plugin(stats_data, appsignal_plugin) do
expect(logs).to_not include([:error, kind_of(String)])
expect_gauge(:connection_backlog, 1)
end
Expand All @@ -262,7 +258,7 @@ def expect_gauge(metric_name, metric_value, tags_hash = {})
end

it "fetches metrics from Puma.stats instead" do
run_plugin(appsignal_plugin) do
run_plugin(stats_data, appsignal_plugin) do
expect(logs).to_not include([:error, kind_of(String)])
expect(logs).to_not include([kind_of(Symbol), "AppSignal: No Puma stats to report."])
expect_gauge(:connection_backlog, 1)
Expand All @@ -277,7 +273,7 @@ def expect_gauge(metric_name, metric_value, tags_hash = {})
end

it "does not fetch metrics" do
run_plugin(appsignal_plugin) do
run_plugin(stats_data, appsignal_plugin) do
expect(logs).to_not include([:error, kind_of(String)])
expect(logs).to include([:debug, "AppSignal: No Puma stats to report."])
expect(messages).to be_empty
Expand All @@ -287,8 +283,7 @@ def expect_gauge(metric_name, metric_value, tags_hash = {})

context "without running StatsD server" do
it "does nothing" do
stop_all
run_plugin(appsignal_plugin) do
run_plugin(stats_data, appsignal_plugin) do
expect(logs).to_not include([:error, kind_of(String)])
expect(messages).to be_empty
end
Expand Down Expand Up @@ -328,7 +323,7 @@ def events
let(:stats_data) { { :max_threads => 5 } }

it "logs messages to the events class" do
run_plugin(appsignal_plugin) do
run_plugin(stats_data, appsignal_plugin) do
expect(launcher.events.logs).to_not be_empty
end
end
Expand Down