jarib/cukeforker

module CukeForker

  #
  # Runner.run(features, opts)
  #
  # where 'features' is an Array of file:line
  # and 'opts' is a Hash of options:
  #
  #   :max        => Fixnum            number of workers (default: 2, pass 0 for unlimited)
  #   :vnc        => true/false,Class  children are launched with DISPLAY set from a VNC server pool,
  #                                    where the size of the pool is equal to :max. If passed a Class instance,
  #                                    this will be passed as the second argument to VncTools::ServerPool.
  #   :record     => true/false,Hash   whether to record a video of failed tests (requires ffmpeg)
  #                                    this will be ignored if if :vnc is not true. If passed a Hash,
  #                                    this will be passed as options to RecordingVncListener
  #   :notify     => object            (or array of objects) implementing the AbstractListener API
  #   :out        => path              directory to dump output to (default: current working dir)
  #   :log        => true/false        wether or not to log to stdout (default: true)
  #   :format     => Symbol            format passed to `cucumber --format` (default: html)
  #   :extra_args => Array             extra arguments passed to cucumber
  #   :delay      => Numeric           seconds to sleep between each worker is started (default: 0)
  #

  class Runner
    include Observable

    DEFAULT_OPTIONS = {
      :max        => 2,
      :vnc        => false,
      :record     => false,
      :notify     => nil,
      :out        => Dir.pwd,
      :log        => true,
      :format     => :html,
      :delay      => 0,
      :fail_fast  => false,
    }

    def self.run(features, opts = {})
      create(features, opts).run
    end

    def self.create(features, opts = {})
      opts = DEFAULT_OPTIONS.dup.merge(opts)

      max        = opts[:max]
      format     = opts[:format]
      out        = File.join opts[:out]
      listeners  = Array(opts[:notify])
      extra_args = Array(opts[:extra_args])
      delay      = opts[:delay]
      fail_fast  = opts[:fail_fast]

      if opts[:log]
        listeners << LoggingListener.new
      end

      if vnc = opts[:vnc]
        if vnc.kind_of?(Class)
          vnc_pool = VncTools::ServerPool.new(max, vnc)
        else
          vnc_pool = VncTools::ServerPool.new(max)
        end

        listener = VncListener.new(vnc_pool)

        if record = opts[:record]
          if record.kind_of?(Hash)
            listeners << RecordingVncListener.new(listener, record)
          else
            listeners << RecordingVncListener.new(listener)
          end
        else
          listeners << listener
        end
      end

      queue = WorkerQueue.new(max, delay, fail_fast)
      features.each do |feature|
        queue.add Worker.new(feature, format, out, extra_args)
      end

      runner = Runner.new queue

      listeners.each { |l|
        queue.add_observer l
        runner.add_observer l
        vnc_pool.add_observer l if opts[:vnc]
      }

      runner
    end

    def initialize(queue)
      @queue = queue
    end

    def run
      start
      process
      stop
      !@queue.has_failures?
    rescue Interrupt
      fire :on_run_interrupted
      stop
      false
    rescue StandardError
      fire :on_run_interrupted
      stop
      raise
    end

    private

    def start
      fire :on_run_starting
    end

    def process
      @queue.process 0.2
    end

    def stop
      @queue.wait_until_finished 0.5
    ensure # catch potential second Interrupt
      fire :on_run_finished, @queue.has_failures?
    end

    def fire(*args)
      changed
      notify_observers(*args)
    end

  end # Runner
end # CukeForker