server.rb

# coding: utf-8

require 'socket'
require 'timeout'
require 'childprocess'
require 'jasmine'

require 'guard/compat/plugin'

module Guard
  class Jasmine < Plugin
    # Start and stop a Jasmine test server for requesting the specs
    # from PhantomJS.
    #
    module Server
      class << self
        attr_accessor :process, :cmd
        # Start the internal test server for getting the Jasmine runner.
        #
        # @param [Hash] options the server options
        # @option options [String] server the server to use
        # @option options [Number] port the server port
        # @option options [String] server_env the Rails environment
        # @option options [Number] server_timeout the server start timeout
        # @option options [String] spec_dir the spec directory
        # @option options [String] rackup_config custom rackup config to use (i.e. spec/dummy/config.ru for mountable engines)
        #
        def start(options)
          port = options[:port]

          case options[:server]
          when :webrick, :mongrel, :thin, :puma
            start_rack_server(options[:server], port, options)
          when :unicorn
            start_unicorn_server(port, options)
          when :jasmine_gem
            start_rake_server(port, 'jasmine', options)
          when :none # noop
          else
            start_rake_server(port, options[:server], options)
          end

          wait_for_server(port, options[:server_timeout]) unless options[:server] == :none
        end

        # Stop the server thread.
        #
        def stop
          return unless process
          Compat::UI.info 'Guard::Jasmine stops server.'
          process.stop(5)
        end

        # A port was not specified, therefore we attempt to detect the best port to use
        # @param [Hash] options the server options
        # @option options [Symbol] server the rack server to use
        # @return [Integer] port number
        def choose_server_port(options)
          if options[:server] == :jasmine_gem
            ::Jasmine.config.port(:server)
          else
            ::Guard::Jasmine.find_free_server_port
          end
        end

        # Detect the server to use
        #
        # @param [String] spec_dir the spec directory
        # @return [Symbol] the server strategy
        #
        def detect_server(spec_dir)
          if spec_dir && File.exist?(File.join(spec_dir, 'support', 'jasmine.yml'))
            :jasmine_gem
          elsif File.exist?('config.ru')
            %w(unicorn thin mongrel puma).each do |server|
              begin
                require server
                return server.to_sym
              rescue LoadError
                # Ignore missing server and try next
              end
            end
            :webrick
          else
            :none
          end
        end

        private

        # Start the Rack server of the current project. This
        # will simply start a server that uses the `config.ru`
        # in the current directory.
        #
        # @param [Symbol] server the server name
        # @param [Integer] port the server port
        # @param [Hash] options the server options
        # @option options [Symbol] server the rack server to use
        # @option options [String] server_env the Rails environment
        # @option options [String] rackup_config custom rackup config to use (i.e. spec/dummy/config.ru for mountable engines)
        #
        def start_rack_server(server, port, options)
          coverage = options[:coverage] ? 'on' : 'off'
          Compat::UI.info "Guard::Jasmine starts #{server} spec server on port #{port} in #{options[:server_env]} environment (coverage #{coverage})."
          execute(options, ['rackup', '-E', options[:server_env].to_s, '-p', port.to_s, '-s', server.to_s, options[:rackup_config]])
        end

        # Start the Rack server of the current project. This
        # will simply start a server that uses the `config.ru`
        # in the current directory.
        #
        # @param [Hash] options the server options
        # @option options [String] server_env the Rails environment
        # @option options [Number] port the server port
        #
        def start_unicorn_server(port, options)
          coverage = options[:coverage] ? 'on' : 'off'
          Compat::UI.info "Guard::Jasmine starts Unicorn spec server on port #{port} in #{options[:server_env]} environment (coverage #{coverage})."
          execute(options, ['unicorn_rails', '-E', options[:server_env].to_s, '-p', port.to_s])
        end

        # Start the Jasmine gem server of the current project.
        #
        # @param [Number] port the server port
        # @param [String] task the rake task name
        # @option options [Symbol] server the rack server to use
        #
        def start_rake_server(port, task, options)
          Compat::UI.info "Guard::Jasmine starts Jasmine Gem test server on port #{port}."
          execute(options, ['rake', task])
        end

        # Builds a child process with the given command and arguments
        # @param [Array<string>] array of arguments to send to ChildProcess
        def execute(options, cmd)
          if RUBY_PLATFORM == "java"
            cmd.unshift("jruby", "-S")
          else
            cmd.unshift("ruby", "-S")
          end
          self.cmd = cmd
          puts "Starting server using: #{cmd.join(' ')}" if options[:debug]
          self.process = ChildProcess.build(*cmd.compact)
          process.environment['COVERAGE'] = options[:coverage].to_s
          process.environment['IGNORE_INSTRUMENTATION'] = options[:ignore_instrumentation].to_s
          process.io.inherit! if options[:verbose]
          process.start
        rescue => e
          Compat::UI.error "Cannot start server using command #{cmd.join(' ')}."
          Compat::UI.error "Error was: #{e.message}"
        end

        # Wait until the Jasmine test server is running.
        #
        # @param [Number] port the server port
        # @param [Number] timeout the server wait timeout
        #
        def wait_for_server(port, timeout)
          Timeout.timeout(timeout) do
            loop do
              begin
                ::TCPSocket.new('localhost', port).close
                break
              rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
                # Ignore, server still not available
              end
              sleep 0.1
            end
          end

        rescue Timeout::Error
          Compat::UI.warning "Timeout while waiting for the server to startup"
          Compat::UI.warning "Most likely there is a configuration error that's preventing the server from starting"
          Compat::UI.warning "You may need to increase the `:server_timeout` option."
          Compat::UI.warning "The commandline that was used to start the server was:"
          Compat::UI.warning cmd.join(' ')
          Compat::UI.warning "You should attempt to run that and see if any errors occur"

          throw :task_has_failed
        end
      end
    end
  end
end