iv-org-mirror/shard-spectator
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/shard-spectator.git synced 2024-08-15 00:53:35 +00:00
Code Issues Projects Releases Packages Wiki Activity

Clean up and simplify Config and Builder

Browse source
This commit is contained in:
Michael Miller 2021-05-08 23:37:33 -06:00
parent 8a4735b9e6
commit e7138080a6
No known key found for this signature in database
GPG key ID: F9A0C5C65B162436
3 changed files with 187 additions and 175 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
src/spectator/config.cr
View file

@ -1,11 +1,15 @@
require "./config/*"
require "./example_filter" require "./example_filter"
require "./formatting" require "./example_group"
require "./example_iterator"
require "./formatting/formatter"
require "./run_flags" require "./run_flags"
module Spectator module Spectator
# Provides customization and describes specifics for how Spectator will run and report tests. # Provides customization and describes specifics for how Spectator will run and report tests.
class Config class Config
@formatters : Array(Formatting::Formatter) # Primary formatter all events will be sent to.
getter formatter : Formatting::Formatter
# Flags indicating how the spec should run. # Flags indicating how the spec should run.
getter run_flags : RunFlags getter run_flags : RunFlags
@ -15,14 +19,19 @@ module Spectator
# Creates a new configuration. # Creates a new configuration.
# Properties are pulled from *source*. # Properties are pulled from *source*.
# Typically, *source* is a `ConfigBuilder`. # Typically, *source* is a `Config::Builder`.
def initialize(source) def initialize(source)
@formatters = source.formatters @formatter = source.formatter
@run_flags = source.run_flags @run_flags = source.run_flags
@random_seed = source.random_seed @random_seed = source.random_seed
@example_filter = source.example_filter @example_filter = source.example_filter
end end
# Produces the default configuration.
def self.default : self
Builder.new.build
end
# Shuffles the items in an array using the configured random settings. # Shuffles the items in an array using the configured random settings.
# If `#randomize?` is true, the *items* are shuffled and returned as a new array. # If `#randomize?` is true, the *items* are shuffled and returned as a new array.
# Otherwise, the items are left alone and returned as-is. # Otherwise, the items are left alone and returned as-is.
@ -43,11 +52,9 @@ module Spectator
items.shuffle!(random) items.shuffle!(random)
end end
# Yields each formatter that should be reported to. # Creates an iterator configured to select the filtered examples.
def each_formatter def iterator(group : ExampleGroup)
@formatters.each do |formatter| ExampleIterator.new(group).select(@example_filter)
yield formatter
end
end end
# Retrieves the configured random number generator. # Retrieves the configured random number generator.

171
src/spectator/config/builder.cr Normal file
View file

@ -0,0 +1,171 @@
require "../composite_example_filter"
require "../example_filter"
require "../null_example_filter"
require "../reporters"
require "../run_flags"
module Spectator
class Config
# Mutable configuration used to produce a final configuration.
# Use the setters in this class to incrementally build a configuration.
# Then call `#build` to create the final configuration.
class Builder
# Seed used for random number generation.
property random_seed : UInt64 = Random.rand(UInt64)
@primary_formatter : Formatting::Formatter?
@additional_formatters = [] of Formatting::Formatter
@run_flags = RunFlags::None
@filters = [] of ExampleFilter
# Creates a configuration.
def build : Config
Config.new(self)
end
# Sets the primary formatter to use for reporting test progress and results.
def formatter=(formatter : Formatting::Formatter)
@primary_formatter = formatter
end
# Adds an extra formatter to use for reporting test progress and results.
def add_formatter(formatter : Formatting::Formatter)
@additional_formatters << formatter
end
# Retrieves the formatters to use.
# If one wasn't specified by the user,
# then `#default_formatter` is returned.
private def formatters
@additional_formatters + [(@primary_formatter || default_formatter)]
end
# The formatter that should be used if one wasn't provided.
private def default_formatter
Formatting::ProgressFormatter.new
end
# A single formatter that will satisfy the configured output.
# If one formatter was configured, then it is returned.
# Otherwise, a `Formatting::BroadcastFormatter` is returned.
protected def formatter
case (formatters = self.formatters)
when .one? then formatters.first
else Formatting::BroadcastFormatter.new(formatters)
end
# Enables fail-fast mode.
def fail_fast
@run_flags |= RunFlags::FailFast
end
# Sets the fail-fast flag.
def fail_fast=(flag)
if flag
@run_flags |= RunFlags::FailFast
else
@run_flags &= ~RunFlags::FailFast
end
end
# Indicates whether fail-fast mode is enabled.
protected def fail_fast?
@run_flags.fail_fast?
end
# Enables fail-blank mode (fail on no tests).
def fail_blank
@run_flags |= RunFlags::FailBlank
end
# Enables or disables fail-blank mode.
def fail_blank=(flag)
if flag
@run_flags |= RunFlags::FailBlank
else
@run_flags &= ~RunFlags::FailBlank
end
end
# Indicates whether fail-fast mode is enabled.
# That is, it is a failure if there are no tests.
protected def fail_blank?
@run_flags.fail_blank?
end
# Enables dry-run mode.
def dry_run
@run_flags |= RunFlags::DryRun
end
# Enables or disables dry-run mode.
def dry_run=(flag)
if flag
@run_flags |= RunFlags::DryRun
else
@run_flags &= ~RunFlags::DryRun
end
end
# Indicates whether dry-run mode is enabled.
# In this mode, no tests are run, but output acts like they were.
protected def dry_run?
@run_flags.dry_run?
end
# Randomizes test execution order.
def randomize
@run_flags |= RunFlags::Randomize
end
# Enables or disables running tests in a random order.
def randomize=(flag)
if flag
@run_flags |= RunFlags::Randomize
else
@run_flags &= ~RunFlags::Randomize
end
end
# Indicates whether tests are run in a random order.
protected def randomize?
@run_flags.randomize?
end
# Displays profiling information
def profile
@run_flags |= RunFlags::Profile
end
# Enables or disables displaying profiling information.
def profile=(flag)
if flag
@run_flags |= RunFlags::Profile
else
@run_flags &= ~RunFlags::Profile
end
end
# Indicates whether profiling information should be displayed.
protected def profile?
@run_flags.profile?
end
# Adds a filter to determine which examples can run.
def add_example_filter(filter : ExampleFilter)
@filters << filter
end
# Retrieves a filter that determines which examples can run.
# If no filters were added with `#add_example_filter`,
# then the returned filter will allow all examples to be run.
protected def example_filter
case (filters = @filters)
when .empty? then NullExampleFilter.new
when .one? then filters.first
else CompositeExampleFilter.new(filters)
end
end
end
end
end

166
src/spectator/config_builder.cr
View file

@ -1,166 +0,0 @@
require "./composite_example_filter"
require "./config"
require "./example_filter"
require "./null_example_filter"
require "./run_flags"
module Spectator
# Mutable configuration used to produce a final configuration.
# Use the setters in this class to incrementally build a configuration.
# Then call `#build` to create the final configuration.
class ConfigBuilder
# Creates a default configuration.
def self.default
new.build
end
# Seed used for random number generation.
property random_seed : UInt64 = Random.rand(UInt64)
@primary_formatter : Formatting::Formatter?
@additional_formatters = [] of Formatting::Formatter
@run_flags = RunFlags::None
@filters = [] of ExampleFilter
# Creates a configuration.
def build : Config
Config.new(self)
end
# Sets the primary formatter to use for reporting test progress and results.
def formatter=(formatter : Formatting::Formatter)
@primary_formatter = formatter
end
# Adds an extra formater to use for reporting test progress and results.
def add_formatter(formatter : Formatting::Formatter)
@additional_formatters << formatter
end
# Retrieves the formatters to use.
# If one wasn't specified by the user,
# then `#default_formatter` is returned.
protected def formatters
@additional_formatters + [(@primary_formatter || default_formatter)]
end
# The formatter that should be used,
# if one wasn't provided.
private def default_formatter
Formatting::DotsFormatter.new
end
# Enables fail-fast mode.
def fail_fast
@run_flags |= RunFlags::FailFast
end
# Sets the fail-fast flag.
def fail_fast=(flag)
if flag
@run_flags |= RunFlags::FailFast
else
@run_flags &= ~RunFlags::FailFast
end
end
# Indicates whether fail-fast mode is enabled.
protected def fail_fast?
@run_flags.fail_fast?
end
# Enables fail-blank mode (fail on no tests).
def fail_blank
@run_flags |= RunFlags::FailBlank
end
# Enables or disables fail-blank mode.
def fail_blank=(flag)
if flag
@run_flags |= RunFlags::FailBlank
else
@run_flags &= ~RunFlags::FailBlank
end
end
# Indicates whether fail-fast mode is enabled.
# That is, it is a failure if there are no tests.
protected def fail_blank?
@run_flags.fail_blank?
end
# Enables dry-run mode.
def dry_run
@run_flags |= RunFlags::DryRun
end
# Enables or disables dry-run mode.
def dry_run=(flag)
if flag
@run_flags |= RunFlags::DryRun
else
@run_flags &= ~RunFlags::DryRun
end
end
# Indicates whether dry-run mode is enabled.
# In this mode, no tests are run, but output acts like they were.
protected def dry_run?
@run_flags.dry_run?
end
# Randomizes test execution order.
def randomize
@run_flags |= RunFlags::Randomize
end
# Enables or disables running tests in a random order.
def randomize=(flag)
if flag
@run_flags |= RunFlags::Randomize
else
@run_flags &= ~RunFlags::Randomize
end
end
# Indicates whether tests are run in a random order.
protected def randomize?
@run_flags.randomize?
end
# Displays profiling information
def profile
@run_flags |= RunFlags::Profile
end
# Enables or disables displaying profiling information.
def profile=(flag)
if flag
@run_flags |= RunFlags::Profile
else
@run_flags &= ~RunFlags::Profile
end
end
# Indicates whether profiling information should be displayed.
protected def profile?
@run_flags.profile?
end
# Adds a filter to determine which examples can run.
def add_example_filter(filter : ExampleFilter)
@filters << filter
end
# Retrieves a filter that determines which examples can run.
# If no filters were added with `#add_example_filter`,
# then the returned filter will allow all examples to be run.
protected def example_filter
case (filters = @filters)
when .empty? then NullExampleFilter.new
when .one? then filters.first
else CompositeExampleFilter.new(filters)
end
end
end
end