free_mutant/lib/mutant/cli.rb

230 lines
5.6 KiB
Ruby
Raw Normal View History

2012-08-28 12:57:39 -04:00
module Mutant
# Commandline parser
class CLI
include Adamantium::Flat, Equalizer.new(:config), Procto.call(:config)
2012-08-28 12:57:39 -04:00
# Error failed when CLI argv is invalid
Error = Class.new(RuntimeError)
EXIT_FAILURE = 1
EXIT_SUCCESS = 0
# Run cli with arguments
#
# @param [Array<String>] arguments
#
# @return [Fixnum]
# the exit status
#
# @api private
def self.run(arguments)
Runner.call(Env::Bootstrap.call(call(arguments))).success? ? EXIT_SUCCESS : EXIT_FAILURE
rescue Error => exception
$stderr.puts(exception.message)
EXIT_FAILURE
end
# Initialize objecct
#
# @param [Array<String>]
#
# @return [undefined]
#
# @api private
def initialize(arguments)
@config = Config::DEFAULT
parse(arguments)
end
2014-06-15 15:30:17 -04:00
# Config parsed from CLI
2014-06-15 15:30:17 -04:00
#
# @return [Config]
#
# @api private
attr_reader :config
private
2013-06-15 10:37:43 -04:00
# Parse the command-line options
#
# @param [Array<String>] arguments
# Command-line options and arguments to be parsed.
#
# @fail [Error]
# An error occurred while parsing the options.
#
2013-06-15 10:37:43 -04:00
# @return [undefined]
#
# @api private
def parse(arguments)
2013-07-28 13:58:53 -04:00
opts = OptionParser.new do |builder|
2014-07-06 11:00:37 -04:00
builder.banner = 'usage: mutant [options] MATCH_EXPRESSION ...'
%w[add_environment_options add_mutation_options add_filter_options add_debug_options].each do |name|
2015-05-02 18:01:10 -04:00
__send__(name, builder)
2013-06-21 11:21:04 -04:00
end
end
parse_match_expressions(opts.parse!(arguments))
rescue OptionParser::ParseError => error
2015-05-02 18:01:10 -04:00
raise(Error, error)
end
# Parse matchers
#
# @param [Array<String>] expressions
#
2013-06-21 21:47:23 -04:00
# @return [undefined]
#
# @api private
def parse_match_expressions(expressions)
fail Error, 'No expressions given' if expressions.empty?
expressions.each do |expression|
add_matcher(:match_expressions, config.expression_parser.(expression))
end
end
2013-06-14 14:54:02 -04:00
2013-08-04 17:03:39 -04:00
# Add environmental options
#
# @param [Object] opts
#
# @return [undefined]
#
2014-12-21 20:28:30 -05:00
# rubocop:disable MethodLength
#
2015-07-01 23:35:54 -04:00
# @api private
def add_environment_options(opts)
2014-01-18 18:27:56 -05:00
opts.separator('Environment:')
2013-08-04 17:03:39 -04:00
opts.on('--zombie', 'Run mutant zombified') do
update(zombie: true)
end
opts.on('-I', '--include DIRECTORY', 'Add DIRECTORY to $LOAD_PATH') do |directory|
add(:includes, directory)
end
opts.on('-r', '--require NAME', 'Require file with NAME') do |name|
add(:requires, name)
2013-08-04 17:03:39 -04:00
end
opts.on('-j', '--jobs NUMBER', 'Number of kill jobs. Defaults to number of processors.') do |number|
update(jobs: Integer(number))
2014-07-17 09:59:25 -04:00
end
2013-08-04 17:03:39 -04:00
end
# Use integration
2014-01-17 18:25:16 -05:00
#
# @param [String] name
2014-01-17 18:15:42 -05:00
#
# @return [undefined]
#
# @api private
def setup_integration(name)
update(integration: Integration.setup(name))
rescue LoadError
2014-12-21 20:28:30 -05:00
raise Error, "Could not load integration #{name.inspect} (you may want to try installing the gem mutant-#{name})"
2014-01-17 18:15:42 -05:00
end
2015-03-05 23:46:03 -05:00
# Add mutation options
2013-06-21 11:21:04 -04:00
#
2014-01-18 18:27:56 -05:00
# @param [OptionParser] opts
2013-06-21 11:21:04 -04:00
#
2013-06-21 21:47:23 -04:00
# @return [undefined]
#
2013-06-21 11:21:04 -04:00
# @api private
2014-01-18 18:27:56 -05:00
def add_mutation_options(opts)
2015-05-02 18:01:10 -04:00
opts.separator(nil)
2014-01-18 18:27:56 -05:00
opts.separator('Options:')
2013-06-21 11:21:04 -04:00
opts.on(
'--expected-coverage COVERAGE',
'Fail unless COVERAGE is not reached exactly, parsed via Rational()'
) do |coverage|
update(expected_coverage: Rational(coverage))
end
2015-06-13 00:26:08 -04:00
opts.on('--use INTEGRATION', 'Use INTEGRATION to kill mutations', &method(:setup_integration))
end
# Add filter options
#
# @param [OptionParser] opts
#
# @return [undefined]
#
# @api private
def add_filter_options(opts)
opts.on('--ignore-subject EXPRESSION', 'Ignore subjects that match EXPRESSION as prefix') do |pattern|
add_matcher(:ignore_expressions, config.expression_parser.(pattern))
end
opts.on('--since REVISION', 'Only select subjects touched since REVISION') do |revision|
add_matcher(:subject_filters, Repository::SubjectFilter.new(Repository::Diff.from_head(revision)))
end
2014-01-18 18:27:56 -05:00
end
# Add debug options
#
# @param [OptionParser] opts
#
# @return [undefined]
#
# @api private
def add_debug_options(opts)
opts.on('--fail-fast', 'Fail fast') do
update(fail_fast: true)
2014-12-21 20:28:30 -05:00
end
opts.on('--version', 'Print mutants version') do
2015-05-02 18:01:10 -04:00
puts("mutant-#{VERSION}")
2014-07-06 11:00:37 -04:00
Kernel.exit(EXIT_SUCCESS)
2014-12-21 20:28:30 -05:00
end
opts.on('-d', '--debug', 'Enable debugging output') do
update(debug: true)
2014-12-21 20:28:30 -05:00
end
opts.on_tail('-h', '--help', 'Show this message') do
2014-07-06 11:00:37 -04:00
puts(opts.to_s)
Kernel.exit(EXIT_SUCCESS)
2013-06-21 11:21:04 -04:00
end
end
# Update configuration
#
# @param [Hash<Symbol, Object>] attributes
#
# @return [undefined]
#
# @api private
def update(attributes)
@config = @config.update(attributes)
end
# Add configuration
#
# @param [Symbol] attribute
# the attribute to add to
#
# @param [Object] value
# the value to add
#
# @return [undefined]
#
# @api private
def add(attribute, value)
update(attribute => config.public_send(attribute).dup << value)
end
# Add matcher configuration
#
# @param [Symbol] attribute
# the attribute to add to
#
# @param [Object] value
# the value to add
#
# @return [undefined]
#
# @api private
def add_matcher(attribute, value)
update(matcher: config.matcher.add(attribute, value))
end
2013-06-14 14:54:02 -04:00
end # CLI
end # Mutant