sspec-core 3.8.0

data/lib/rspec/core/reporter.rb

@@ -0,0 +1,257 @@
+module RSpec::Core
+  # A reporter will send notifications to listeners, usually formatters for the
+  # spec suite run.
+  class Reporter
+    # @private
+    RSPEC_NOTIFICATIONS = Set.new(
+      [
+        :close, :deprecation, :deprecation_summary, :dump_failures, :dump_pending,
+        :dump_profile, :dump_summary, :example_failed, :example_group_finished,
+        :example_group_started, :example_passed, :example_pending, :example_started,
+        :message, :seed, :start, :start_dump, :stop, :example_finished
+      ])
+
+    def initialize(configuration)
+      @configuration = configuration
+      @listeners = Hash.new { |h, k| h[k] = Set.new }
+      @examples = []
+      @failed_examples = []
+      @pending_examples = []
+      @duration = @start = @load_time = nil
+      @non_example_exception_count = 0
+      @setup_default = lambda {}
+      @setup = false
+      @profiler = nil
+    end
+
+    # @private
+    attr_reader :examples, :failed_examples, :pending_examples
+
+    # Registers a listener to a list of notifications. The reporter will send
+    # notification of events to all registered listeners.
+    #
+    # @param listener [Object] An obect that wishes to be notified of reporter
+    #   events
+    # @param notifications [Array] Array of symbols represents the events a
+    #   listener wishes to subscribe too
+    def register_listener(listener, *notifications)
+      notifications.each do |notification|
+        @listeners[notification.to_sym] << listener
+      end
+      true
+    end
+
+    # @private
+    def prepare_default(loader, output_stream, deprecation_stream)
+      @setup_default = lambda do
+        loader.setup_default output_stream, deprecation_stream
+      end
+    end
+
+    # @private
+    def registered_listeners(notification)
+      @listeners[notification].to_a
+    end
+
+    # @overload report(count, &block)
+    # @overload report(count, &block)
+    # @param expected_example_count [Integer] the number of examples being run
+    # @yield [Block] block yields itself for further reporting.
+    #
+    # Initializes the report run and yields itself for further reporting. The
+    # block is required, so that the reporter can manage cleaning up after the
+    # run.
+    #
+    # @example
+    #
+    #     reporter.report(group.examples.size) do |r|
+    #       example_groups.map {|g| g.run(r) }
+    #     end
+    #
+    def report(expected_example_count)
+      start(expected_example_count)
+      begin
+        yield self
+      ensure
+        finish
+      end
+    end
+
+    # @private
+    def start(expected_example_count, time=RSpec::Core::Time.now)
+      @start = time
+      @load_time = (@start - @configuration.start_time).to_f
+      notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)
+      notify :start, Notifications::StartNotification.new(expected_example_count, @load_time)
+    end
+
+    # @param message [#to_s] A message object to send to formatters
+    #
+    # Send a custom message to supporting formatters.
+    def message(message)
+      notify :message, Notifications::MessageNotification.new(message)
+    end
+
+    # @param event [Symbol] Name of the custom event to trigger on formatters
+    # @param options [Hash] Hash of arguments to provide via `CustomNotification`
+    #
+    # Publish a custom event to supporting registered formatters.
+    # @see RSpec::Core::Notifications::CustomNotification
+    def publish(event, options={})
+      if RSPEC_NOTIFICATIONS.include? event
+        raise "RSpec::Core::Reporter#publish is intended for sending custom " \
+              "events not internal RSpec ones, please rename your custom event."
+      end
+      notify event, Notifications::CustomNotification.for(options)
+    end
+
+    # @private
+    def example_group_started(group)
+      notify :example_group_started, Notifications::GroupNotification.new(group) unless group.descendant_filtered_examples.empty?
+    end
+
+    # @private
+    def example_group_finished(group)
+      notify :example_group_finished, Notifications::GroupNotification.new(group) unless group.descendant_filtered_examples.empty?
+    end
+
+    # @private
+    def example_started(example)
+      @examples << example
+      notify :example_started, Notifications::ExampleNotification.for(example)
+    end
+
+    # @private
+    def example_finished(example)
+      notify :example_finished, Notifications::ExampleNotification.for(example)
+    end
+
+    # @private
+    def example_passed(example)
+      notify :example_passed, Notifications::ExampleNotification.for(example)
+    end
+
+    # @private
+    def example_failed(example)
+      @failed_examples << example
+      notify :example_failed, Notifications::ExampleNotification.for(example)
+    end
+
+    # @private
+    def example_pending(example)
+      @pending_examples << example
+      notify :example_pending, Notifications::ExampleNotification.for(example)
+    end
+
+    # @private
+    def deprecation(hash)
+      notify :deprecation, Notifications::DeprecationNotification.from_hash(hash)
+    end
+
+    # @private
+    # Provides a way to notify of an exception that is not tied to any
+    # particular example (such as an exception encountered in a :suite hook).
+    # Exceptions will be formatted the same way they normally are.
+    def notify_non_example_exception(exception, context_description)
+      @configuration.world.non_example_failure = true
+      @non_example_exception_count += 1
+
+      example = Example.new(AnonymousExampleGroup, context_description, {})
+      presenter = Formatters::ExceptionPresenter.new(exception, example, :indentation => 0)
+      message presenter.fully_formatted(nil)
+    end
+
+    # @private
+    def finish
+      close_after do
+        stop
+        notify :start_dump,    Notifications::NullNotification
+        notify :dump_pending,  Notifications::ExamplesNotification.new(self)
+        notify :dump_failures, Notifications::ExamplesNotification.new(self)
+        notify :deprecation_summary, Notifications::NullNotification
+        unless mute_profile_output?
+          notify :dump_profile, Notifications::ProfileNotification.new(@duration, @examples,
+                                                                       @configuration.profile_examples,
+                                                                       @profiler.example_groups)
+        end
+        notify :dump_summary, Notifications::SummaryNotification.new(@duration, @examples, @failed_examples,
+                                                                     @pending_examples, @load_time,
+                                                                     @non_example_exception_count)
+        notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)
+      end
+    end
+
+    # @private
+    def close_after
+      yield
+    ensure
+      close
+    end
+
+    # @private
+    def stop
+      @duration = (RSpec::Core::Time.now - @start).to_f if @start
+      notify :stop, Notifications::ExamplesNotification.new(self)
+    end
+
+    # @private
+    def notify(event, notification)
+      ensure_listeners_ready
+      registered_listeners(event).each do |formatter|
+        formatter.__send__(event, notification)
+      end
+    end
+
+    # @private
+    def abort_with(msg, exit_status)
+      message(msg)
+      close
+      exit!(exit_status)
+    end
+
+    # @private
+    def fail_fast_limit_met?
+      return false unless (fail_fast = @configuration.fail_fast)
+
+      if fail_fast == true
+        @failed_examples.any?
+      else
+        fail_fast <= @failed_examples.size
+      end
+    end
+
+  private
+
+    def ensure_listeners_ready
+      return if @setup
+
+      @setup_default.call
+      @profiler = Profiler.new
+      register_listener @profiler, *Profiler::NOTIFICATIONS
+      @setup = true
+    end
+
+    def close
+      notify :close, Notifications::NullNotification
+    end
+
+    def mute_profile_output?
+      # Don't print out profiled info if there are failures and `--fail-fast` is
+      # used, it just clutters the output.
+      !@configuration.profile_examples? || fail_fast_limit_met?
+    end
+
+    def seed_used?
+      @configuration.seed && @configuration.seed_used?
+    end
+  end
+
+  # @private
+  # # Used in place of a {Reporter} for situations where we don't want reporting output.
+  class NullReporter
+    def self.method_missing(*)
+      # ignore
+    end
+    private_class_method :method_missing
+  end
+end

data/lib/rspec/core/ruby_project.rb

@@ -0,0 +1,53 @@
+# This is borrowed (slightly modified) from Scott Taylor's
+# project_path project:
+#   http://github.com/smtlaissezfaire/project_path
+module RSpec
+  module Core
+    # @private
+    module RubyProject
+      def add_to_load_path(*dirs)
+        dirs.each { |dir| add_dir_to_load_path(File.join(root, dir)) }
+      end
+
+      def add_dir_to_load_path(dir)
+        $LOAD_PATH.unshift(dir) unless $LOAD_PATH.include?(dir)
+      end
+
+      def root
+        @project_root ||= determine_root
+      end
+
+      def determine_root
+        find_first_parent_containing('spec') || '.'
+      end
+
+      def find_first_parent_containing(dir)
+        ascend_until { |path| File.exist?(File.join(path, dir)) }
+      end
+
+      def ascend_until
+        fs = File::SEPARATOR
+        escaped_slash = "\\#{fs}"
+        special = "_RSPEC_ESCAPED_SLASH_"
+        project_path = File.expand_path(".")
+        parts = project_path.gsub(escaped_slash, special).squeeze(fs).split(fs).map do |x|
+          x.gsub(special, escaped_slash)
+        end
+
+        until parts.empty?
+          path = parts.join(fs)
+          path = fs if path == ""
+          return path if yield(path)
+          parts.pop
+        end
+      end
+
+      module_function :add_to_load_path
+      module_function :add_dir_to_load_path
+      module_function :root
+      module_function :determine_root
+      module_function :find_first_parent_containing
+      module_function :ascend_until
+    end
+  end
+end

data/lib/rspec/core/runner.rb

@@ -0,0 +1,199 @@
+module RSpec
+  module Core
+    # Provides the main entry point to run a suite of RSpec examples.
+    class Runner
+      # @attr_reader
+      # @private
+      attr_reader :options, :configuration, :world
+
+      # Register an `at_exit` hook that runs the suite when the process exits.
+      #
+      # @note This is not generally needed. The `rspec` command takes care
+      #       of running examples for you without involving an `at_exit`
+      #       hook. This is only needed if you are running specs using
+      #       the `ruby` command, and even then, the normal way to invoke
+      #       this is by requiring `rspec/autorun`.
+      def self.autorun
+        if autorun_disabled?
+          RSpec.deprecate("Requiring `rspec/autorun` when running RSpec via the `rspec` command")
+          return
+        elsif installed_at_exit? || running_in_drb?
+          return
+        end
+
+        at_exit { perform_at_exit }
+        @installed_at_exit = true
+      end
+
+      # @private
+      def self.perform_at_exit
+        # Don't bother running any specs and just let the program terminate
+        # if we got here due to an unrescued exception (anything other than
+        # SystemExit, which is raised when somebody calls Kernel#exit).
+        return unless $!.nil? || $!.is_a?(SystemExit)
+
+        # We got here because either the end of the program was reached or
+        # somebody called Kernel#exit. Run the specs and then override any
+        # existing exit status with RSpec's exit status if any specs failed.
+        invoke
+      end
+
+      # Runs the suite of specs and exits the process with an appropriate exit
+      # code.
+      def self.invoke
+        disable_autorun!
+        status = run(ARGV, $stderr, $stdout).to_i
+        exit(status) if status != 0
+      end
+
+      # Run a suite of RSpec examples. Does not exit.
+      #
+      # This is used internally by RSpec to run a suite, but is available
+      # for use by any other automation tool.
+      #
+      # If you want to run this multiple times in the same process, and you
+      # want files like `spec_helper.rb` to be reloaded, be sure to load `load`
+      # instead of `require`.
+      #
+      # @param args [Array] command-line-supported arguments
+      # @param err [IO] error stream
+      # @param out [IO] output stream
+      # @return [Fixnum] exit status code. 0 if all specs passed,
+      #   or the configured failure exit code (1 by default) if specs
+      #   failed.
+      def self.run(args, err=$stderr, out=$stdout)
+        trap_interrupt
+        options = ConfigurationOptions.new(args)
+
+        if options.options[:runner]
+          options.options[:runner].call(options, err, out)
+        else
+          new(options).run(err, out)
+        end
+      end
+
+      def initialize(options, configuration=RSpec.configuration, world=RSpec.world)
+        @options       = options
+        @configuration = configuration
+        @world         = world
+      end
+
+      # Configures and runs a spec suite.
+      #
+      # @param err [IO] error stream
+      # @param out [IO] output stream
+      def run(err, out)
+        setup(err, out)
+        run_specs(@world.ordered_example_groups).tap do
+          persist_example_statuses
+        end
+      end
+
+      # Wires together the various configuration objects and state holders.
+      #
+      # @param err [IO] error stream
+      # @param out [IO] output stream
+      def setup(err, out)
+        configure(err, out)
+        @configuration.load_spec_files
+        @world.announce_filters
+      end
+
+      # Runs the provided example groups.
+      #
+      # @param example_groups [Array<RSpec::Core::ExampleGroup>] groups to run
+      # @return [Fixnum] exit status code. 0 if all specs passed,
+      #   or the configured failure exit code (1 by default) if specs
+      #   failed.
+      def run_specs(example_groups)
+        examples_count = @world.example_count(example_groups)
+        success = @configuration.reporter.report(examples_count) do |reporter|
+          @configuration.with_suite_hooks do
+            if examples_count == 0 && @configuration.fail_if_no_examples
+              return @configuration.failure_exit_code
+            end
+
+            example_groups.map { |g| g.run(reporter) }.all?
+          end
+        end && !@world.non_example_failure
+
+        success ? 0 : @configuration.failure_exit_code
+      end
+
+      # @private
+      def configure(err, out)
+        @configuration.error_stream = err
+        @configuration.output_stream = out if @configuration.output_stream == $stdout
+        @options.configure(@configuration)
+      end
+
+      # @private
+      def self.disable_autorun!
+        @autorun_disabled = true
+      end
+
+      # @private
+      def self.autorun_disabled?
+        @autorun_disabled ||= false
+      end
+
+      # @private
+      def self.installed_at_exit?
+        @installed_at_exit ||= false
+      end
+
+      # @private
+      def self.running_in_drb?
+        return false unless defined?(DRb)
+
+        server = begin
+                   DRb.current_server
+                 rescue DRb::DRbServerNotFound
+                   return false
+                 end
+
+        return false unless server && server.alive?
+
+        require 'socket'
+        require 'uri'
+
+        local_ipv4 = begin
+                       IPSocket.getaddress(Socket.gethostname)
+                     rescue SocketError
+                       return false
+                     end
+
+        ["127.0.0.1", "localhost", local_ipv4].any? { |addr| addr == URI(DRb.current_server.uri).host }
+      end
+
+      # @private
+      def self.trap_interrupt
+        trap('INT') { handle_interrupt }
+      end
+
+      # @private
+      def self.handle_interrupt
+        if RSpec.world.wants_to_quit
+          exit!(1)
+        else
+          RSpec.world.wants_to_quit = true
+          $stderr.puts "\nRSpec is shutting down and will print the summary report... Interrupt again to force quit."
+        end
+      end
+
+    private
+
+      def persist_example_statuses
+        return if @configuration.dry_run
+        return unless (path = @configuration.example_status_persistence_file_path)
+
+        ExampleStatusPersister.persist(@world.all_examples, path)
+      rescue SystemCallError => e
+        RSpec.warning "Could not write example statuses to #{path} (configured as " \
+                      "`config.example_status_persistence_file_path`) due to a " \
+                      "system error: #{e.inspect}. Please check that the config " \
+                      "option is set to an accessible, valid file path", :call_site => nil
+      end
+    end
+  end
+end