1
mirror of https://github.com/rapid7/metasploit-framework synced 2024-10-29 18:07:27 +01:00

Fail rake spec if leak tracking unnecessary

MSP-11130

Fail `rake spec` if
`Metasploit::Framework::Spec::Constants::Each.configure!`'s
`before(:each)` does not clean all leaked constants and if should be
removed so that it does not interefore with future specs.
This commit is contained in:
Luke Imhoff 2014-10-30 09:37:17 -05:00
parent c2bd75b587
commit c8e4745d6d
No known key found for this signature in database
GPG Key ID: 5B1FB01FB33356F8
3 changed files with 77 additions and 4 deletions

View File

@ -9,4 +9,4 @@ require 'metasploit/framework/require'
Metasploit::Framework::Require.optionally_active_record_railtie
Metasploit::Framework::Application.load_tasks
Metasploit::Framework::Spec::Constants::Suite.define_task
Metasploit::Framework::Spec::Constants.define_task

View File

@ -28,12 +28,28 @@ module Metasploit::Framework::Spec::Constants
# Cleans child constants from {PARENT_CONSTANT}.
#
# @return [void]
# @return [true] if there were leaked constants that were cleaned.
# @return [false] if there were no leaked constants.
# @see each
def self.clean
each do |child_name|
count = each do |child_name|
PARENT_CONSTANT.send(:remove_const, child_name)
end
count != 0
end
# Adds actions to `spec` task so that `rake spec` fails if any of the following:
#
# # `log/leaked-constants.log` exists after printing out the leaked constants.
# # {Each.configured!} is unnecessary in `spec/spec_helper.rb` and should be removed.
#
# @return [void]
def self.define_task
Suite.define_task
# After Suite as Suite will kill for leaks before Each say it cleaned no leaks in case there are leaks in an
# `after(:all)` that {Each} won't catch in its `after(:each)` checks.
Each.define_task
end
# Yields each child_constant_name under {PARENT_CONSTANT}.

View File

@ -5,6 +5,28 @@
#
# Fails example if it leaks module loading constants.
module Metasploit::Framework::Spec::Constants::Each
#
# CONSTANTS
#
LOG_PATHNAME = Pathname.new('log/remove-cleaner')
#
# Module Methods
#
class << self
attr_accessor :leaks_cleaned
end
# Is {Metasploit::Framework::Spec::Constants::Each.configure!} still necessary or should it be removed?
#
# @return [true] if {configure!}'s `before(:each)` cleaned up leaked constants
# @return [false] otherwise
def self.leaks_cleaned?
!!@leaks_cleaned
end
# Configures after(:each) callback for RSpe to fail example if leaked constants.
#
# @return [void]
@ -13,7 +35,7 @@ module Metasploit::Framework::Spec::Constants::Each
RSpec.configure do |config|
config.before(:each) do
# clean so that leaks from earlier example aren't attributed to this example
Metasploit::Framework::Spec::Constants.clean
Metasploit::Framework::Spec::Constants::Each.leaks_cleaned ||= Metasploit::Framework::Spec::Constants.clean
end
config.after(:each) do
@ -36,9 +58,44 @@ module Metasploit::Framework::Spec::Constants::Each
fail RuntimeError, message, example.metadata[:caller]
end
end
config.after(:suite) do
if Metasploit::Framework::Spec::Constants::Each.leaks_cleaned?
if LOG_PATHNAME.exist?
LOG_PATHNAME.delete
end
else
LOG_PATHNAME.open('w') { |f|
f.write('1')
}
end
end
end
@configured = true
end
end
# Whether {configure!} was called
#
# @return [Boolean]
def self.configured?
!!@configured
end
# Adds action to `spec` task so that `rake spec` fails if {configured!} is unnecessary in `spec/spec_helper.rb` and
# should be removed
#
# @return [void]
def self.define_task
Rake::Task.define_task(:spec) do
if LOG_PATHNAME.exist?
$stderr.puts "No leaks were cleaned by `#{self}.configured!`. Remove it from `spec/spec_helper.rb` so it " \
"does not interfere with contexts that persist loaded modules for entire context and clean up " \
"modules in `after(:all)`."
exit(1)
end
end
end
end