metasploit-framework/test/lib/regexr.rb

134 lines
3.3 KiB
Ruby

## This class consists of helper methods for regexing logs
##
## TODO - clean up the style. looks like it was written in the early 90s
##
## $id$
class Regexr
def initialize
@verbose = true
end
# Check for the beginning line. Handy when you need to ensure a log has started
def verify_start(data,the_start)
data_lines = data.split("\n")
regex_start = Regexp.new(the_start, @case_insensitive)
return regex_start.match(data_lines.first)
end
# Check for end line. Handy when you need to ensure a log has completed.
def verify_end(data,the_end)
data_lines = data.split("\n")
regex_end = Regexp.new(the_end, @case_insensitive)
return regex_end.match(data_lines.last)
end
# Check for the beginning and end lines. Handy when you need to ensure a log has started & completed
def verify_start_and_end(data,the_start,the_end)
data_lines = data.split("\n")
regex_start = Regexp.new(the_start, @case_insensitive)
regex_endline = Regexp.new(the_end, @case_insensitive)
## yuck, refactor this - TODO
if regex_start.match == data_lines.first
return regex_endline == data_lines.last
end
return false
end
# Scan for any number of success lines. In order to pass, all successes must match.
def ensure_all_exist_in_data(data,regexes=[])
data_lines = data.split("\n")
if regexes
success = false
target_successes = regexes.size
count = 0
regexes.each { |condition|
matched = false
re = Regexp.new(condition, @case_insensitive)
data_lines.each {|line|
if line =~ re
count += 1
matched = true
break
end
}
# A way to tell if a match was never found.
if !matched
if @verbose
puts "DEBUG: Didn't see success condition '#{condition}'"
end
return false
end
}
if target_successes == count
if @verbose
puts "DEBUG: woot, got all successes"
end
return true
else
if @verbose
puts "DEBUG: Didn't get enough successes, somehow. (" + count + "/" + target_successes + ")"
end
end
else
return true # No successes are defined, so count this as a pass (true).
end
end
# Scan for failures -- if any single failure matches, the test returns true.
def ensure_none_exist_in_data(data,regexes=[],exceptions=[])
data_lines = data.split("\n")
if regexes
regexes.each { |condition|
## for each failure condition that we've been passed
re = Regexp.new(condition, @case_insensitive)
## assume we're okay
okay = true
data_lines.each { |line|
if re.match(line)
okay = false # oh, we found a match
if @verbose
puts "found " + line
end
# but let's check the exceptions
exceptions.map { |exception|
reg_exception = Regexp.new(exception, @case_insensitive)
# If the exception matches here, we'll spare it
if reg_exception.match(line)
if @verbose
puts "\'" + line + "\' is an exception, we can ignore it."
end
okay = true
break
end
}
# If we didn't find an exception, we have to fail it. do not pass go.
if !okay
if @verbose
puts "DEBUG: Saw failure condition '#{condition}' in #{line}; regex matched: #{re.inspect}"
end
return false
end
end
}
}
else
return false # we gots no failures, so count this as a pass.
end
end
end