js-test-server 0.2.0

data/CHANGES

@@ -0,0 +1,31 @@
+- Added JsTestCore::Representations::Spec.project_js_files and .project_css_files
+- Updated to erector 0.6.7, which fixes a bug related to including modules into Representations.
+- Allow test suite to clear all cookies
+- No longer using the /implementanions directory. Replace all cases of /implementations with /javascripts.
+- Added support for custom suite files
+- Added dependency on Erector
+- Better error messages
+- Changed dependency from Selenium to selenium-client
+- Renamed Resources::Runner to Resources::SeleniumSession
+- Changed /runners to /selenium_sessions
+
+0.2.0
+- Renamed Suite to Session to follow Selenium conventions
+- Renamed SuiteFinish to SessionFinish to follow Selenium conventions
+- Added /session, which uses the session_id cookie to derive the current session.
+- Added /session/finished to be used to simplify client/server interactions.
+- Remove File caching because it doesn't cause a noticable performance benefit over a local network and because it sometimes doesn't write over stale files.
+- Client accepts selenium_browser_start_command parameter, which allows the user to parameterize the selenium_browser_start_command
+- Added support for running specs in Internet Explorer via POST /runners/iexplore
+- Resource file download performance improvements via caching and chunked sending
+- Fixed false positive bug when Client connection times out
+
+0.1.1
+- SuiteFinish#post immediately closes the connection
+
+0.1.0
+- Initial Release extracted from JsTestCore.
+- Added JsTestCore::WebRoot.dispatch_specs and .dispatch_strategy
+- Extracted JsTestCore::Resources::Specs::SpecDir
+- Extracted JsTestCore::Resources::Specs::SpecFile
+- No longer depending on Guid. The child libraries are responsible for obtaining the Selenium session_id from the client by using top.runOptions.getSessionId().

data/Gemfile

@@ -0,0 +1,17 @@
+group :gem do
+  gem 'sinatra', '1.0'
+  gem 'thin', '1.2.7'
+  gem 'erector', '0.7.2'
+  gem 'selenium-client', '1.2.18'
+  gem 'trollop', '1.16.2'
+  gem 'guid', '0.1.1'
+  gem 'json', '1.4.0'
+end
+
+group :test do
+  gem 'selenium-rc', '2.2.1'
+  gem 'lsof', '0.3.0'
+  gem 'rack-test', '0.5.3'
+  gem 'rr', '0.10.11'
+  gem 'nokogiri', '1.4.1'
+end

data/README.markdown

@@ -0,0 +1,9 @@
+= JsTestServer
+JsTestServer provides a command line runner and html suite file generation for your favorite Javascript testing framework.
+
+== Current supported frameworks
+* Jasmine
+* Screw Unit
+
+== Thanks To
+* Aman Gupta for advice and patch to the Remote Control

data/Rakefile

@@ -0,0 +1,63 @@
+require "rake"
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'bundler'
+
+desc "Runs the Rspec suite"
+task(:default) do
+  run_suite
+end
+
+desc "Runs the Rspec suite"
+task(:spec) do
+  run_suite
+end
+
+def run_suite
+  dir = File.dirname(__FILE__)
+  system("ruby #{dir}/spec/spec_suite.rb") || raise("Example Suite failed")
+end
+
+PKG_NAME = "js-test-server"
+PKG_VERSION = "0.2.0"
+PKG_FILES = FileList[
+  '[A-Z]*',
+  '*.rb',
+  'lib/**/*.rb',
+  'core/**',
+  'bin/**',
+  'spec/**/*.rb'
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.summary = "The JsTestServer library is the core javascript test server library used by several JS Test server libraries."
+  s.test_files = "spec/spec_suite.rb"
+  s.description = s.summary
+
+  s.files = PKG_FILES.to_a
+  s.require_path = 'lib'
+
+  s.has_rdoc = true
+
+  s.test_files = Dir.glob('spec/*_spec.rb')
+  s.require_path = 'lib'
+  s.author = "Brian Takita"
+  s.email = "brian.takita@gmail.com"
+  s.homepage = "http://pivotallabs.com"
+  s.rubyforge_project = "pivotalrb"
+  Bundler::Definition.from_gemfile("#{File.dirname(__FILE__)}/Gemfile").dependencies.select do |dependency|
+    dependency.groups.include?(:gem)
+  end.each do |dependency|
+    s.add_dependency(dependency.name, dependency.version_requirements)
+  end
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end

data/bin/jasmine-server

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift("#{dir}/../lib")
+
+require "rubygems"
+require "js_test_server"
+JsTestServer::Server::DEFAULTS[:framework_name] = "jasmine"
+JsTestServer::Server::Runner.new.cli(*ARGV)

data/bin/js-test-client

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift("#{dir}/../lib")
+
+require "rubygems"
+require "js_test_server"
+JsTestServer::Client::Runner.run_argv(ARGV)

data/bin/js-test-server

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+#bin/js-test-server --spec-path=./js-test-server/spec/functional/jasmine/example_spec --root-path=./js-test-server/spec/example_root --framework-name=jasmine --framework-path=./js-test-server/spec/frameworks/jasmine/lib
+
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift("#{dir}/../lib")
+
+require "rubygems"
+require "js_test_server"
+JsTestServer::Server::Runner.new.cli(*ARGV)

data/bin/screw-unit-server

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift("#{dir}/../lib")
+
+require "rubygems"
+require "js_test_server"
+JsTestServer::Server::DEFAULTS[:framework_name] = "screw-unit"
+JsTestServer::Server::Runner.new.cli(*ARGV)

data/lib/js_test_server.rb

@@ -0,0 +1,29 @@
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift File.expand_path("#{dir}/../vendor/lucky-luciano/lib")
+require "lucky_luciano"
+
+require "timeout"
+require "selenium/client"
+require "trollop"
+require "json"
+require "erector"
+
+Erector::Widget.prettyprint_default = true
+
+require "#{dir}/js_test_server/configuration"
+require "#{dir}/js_test_server/server"
+require "#{dir}/js_test_server/client"
+
+module JsTestServer
+  class << self
+    Configuration.instance = Configuration.new
+
+    def method_missing(method_name, *args, &block)
+      if Configuration.instance.respond_to?(method_name)
+        Configuration.instance.send(method_name, *args, &block)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/js_test_server/client.rb

@@ -0,0 +1,23 @@
+module JsTestServer
+  module Client
+    RUNNING_RUNNER_STATE = "running"
+    PASSED_RUNNER_STATE = "passed"
+    FAILED_RUNNER_STATE = "failed"
+    FINISHED_RUNNER_STATES = [PASSED_RUNNER_STATE, FAILED_RUNNER_STATE]
+
+    DEFAULT_SELENIUM_BROWSER = "*firefox"
+    DEFAULT_SELENIUM_HOST = "0.0.0.0"
+    DEFAULT_SELENIUM_PORT = 4444
+    DEFAULT_SPEC_URL = "http://localhost:8080/specs"
+    DEFAULT_TIMEOUT = 60
+
+    class ClientException < Exception
+    end
+
+    class InvalidStatusResponse < ClientException
+    end
+  end
+end
+
+dir = File.dirname(__FILE__)
+require "#{dir}/client/runner"

data/lib/js_test_server/client/runner.rb

@@ -0,0 +1,129 @@
+module JsTestServer
+  module Client
+    class Runner
+      class << self
+        def run(parameters={})
+          new(parameters).run
+        end
+
+        def run_argv(argv)
+          opts = Trollop.options(argv) do
+            opt(
+              :selenium_browser,
+              "The Selenium browser (e.g. *firefox). See http://selenium-rc.openqa.org/",
+              :type => String,
+              :default => DEFAULT_SELENIUM_BROWSER
+            )
+            opt(
+              :selenium_host,
+              "The host name of the Selenium Server relative to where this file is executed",
+              :type => String,
+              :default => DEFAULT_SELENIUM_HOST
+            )
+            opt(
+              :selenium_port,
+              "The port of the Selenium Server relative to where this file is executed",
+              :type => Integer,
+              :default => DEFAULT_SELENIUM_PORT
+            )
+            opt(
+              :spec_url,
+              "The url of the js spec server, relative to the browsers running via the Selenium Server",
+              :type => String,
+              :default => DEFAULT_SPEC_URL
+            )
+            opt(
+              :timeout,
+              "The timeout limit of the test run",
+              :type => Integer,
+              :default => DEFAULT_TIMEOUT
+            )
+          end
+          run opts
+        end
+      end
+
+      attr_reader :parameters, :selenium_client, :current_status, :flushed_console
+
+      def initialize(parameters)
+        @parameters = parameters
+        @flushed_console = ""
+      end
+
+      def run
+        if parameters[:timeout]
+           Timeout.timeout(parameters[:timeout]) {do_run}
+        else
+          do_run
+        end
+      end
+
+      protected
+      def do_run
+        start_selenium_client
+        wait_for_session_to_finish
+        flush_console
+        suite_passed?
+      end
+
+      def start_selenium_client
+        uri =  URI.parse(parameters[:spec_url] || DEFAULT_SPEC_URL)
+        @selenium_client = Selenium::Client::Driver.new(
+          :host => parameters[:selenium_host] || DEFAULT_SELENIUM_HOST,
+          :port => parameters[:selenium_port] || DEFAULT_SELENIUM_PORT,
+          :browser => parameters[:selenium_browser] || DEFAULT_SELENIUM_BROWSER,
+          :url => "#{uri.scheme}://#{uri.host}:#{uri.port}"
+        )
+        selenium_client.start
+        selenium_client.open([uri.path, uri.query].compact.join("?"))
+
+        at_exit do
+          selenium_client.stop
+        end
+      end
+
+      def wait_for_session_to_finish
+        while !suite_finished?
+          poll
+          flush_console
+          sleep 0.1
+        end
+        if suite_passed?
+          STDOUT.puts(PASSED_RUNNER_STATE.capitalize)
+        else
+          STDOUT.puts(FAILED_RUNNER_STATE.capitalize)
+        end
+      end
+
+      def poll
+        raw_status = selenium_client.get_eval("window.JsTestServer.status()")
+        unless raw_status.to_s == ""
+          @current_status = JSON.parse(raw_status)
+        end
+      end
+
+      def suite_finished?
+        current_status && FINISHED_RUNNER_STATES.include?(runner_state)
+      end
+
+      def flush_console
+        if current_status && console != ""
+          STDOUT.print(console.gsub(flushed_console, ""))
+          @flushed_console = console
+        end
+      end
+
+      def suite_passed?
+        runner_state == PASSED_RUNNER_STATE
+      end
+
+      def runner_state
+        current_status["runner_state"]
+      end
+
+      def console
+        current_status["console"] || ""
+      end
+    end
+  end
+end

data/lib/js_test_server/configuration.rb

@@ -0,0 +1,69 @@
+module JsTestServer
+  class Configuration
+    class << self
+      attr_accessor :instance
+
+      def method_missing(method_name, *args, &block)
+        if Configuration.instance.respond_to?(method_name)
+          Configuration.instance.send(method_name, *args, &block)
+        else
+          super
+        end
+      end
+    end
+
+    attr_reader :host, :port, :spec_path, :root_path, :framework_path, :framework_name
+    attr_writer :host, :port, :framework_path, :framework_name
+
+    def initialize(params={})
+      params = Server::DEFAULTS.dup.merge(params)
+      @spec_path = ::File.expand_path(params[:spec_path])
+      @root_path = ::File.expand_path(params[:root_path])
+      @host = params[:host]
+      @port = params[:port]
+      @framework_path = params[:framework_path]
+      @framework_name = params[:framework_name]
+    end
+
+    def suite_representation_class
+      if framework_name
+        JsTestServer::Server::Representations::Suites.const_get(framework_name.gsub("-", "_").camelcase)
+      end
+    end
+
+    def spec_path=(path)
+      validate_path(path)
+      @spec_path = path
+    end
+
+    def root_path=(path)
+      validate_path(path)
+      @root_path = path
+    end
+
+    def js_test_server_root_path
+      "#{library_root_dir}/public"
+    end
+
+    def root_url
+      "http://#{host}:#{port}"
+    end
+
+    def rackup_path
+      File.expand_path("#{File.dirname(__FILE__)}/server/standalone.ru")
+    end
+
+    protected
+
+    def library_root_dir
+      dir = File.dirname(__FILE__)
+      File.expand_path("#{dir}/../..")
+    end
+
+    def validate_path(path)
+      unless File.directory?(path)
+        raise ArgumentError, "#{path} must be a directory"
+      end
+    end
+  end
+end

data/lib/js_test_server/server.rb

@@ -0,0 +1,14 @@
+module JsTestServer::Server
+  DEFAULTS = {
+    :host => "0.0.0.0",
+    :port => 8080,
+    :spec_path => File.expand_path("./spec/javascripts"),
+    :root_path => File.expand_path("./public"),
+  }
+end
+
+dir = File.dirname(__FILE__)
+require "#{dir}/server/runner"
+require "#{dir}/server/resources"
+require "#{dir}/server/representations"
+require "#{dir}/server/app"

data/lib/js_test_server/server/app.rb

@@ -0,0 +1,10 @@
+class JsTestServer::Server::App < Sinatra::Base
+  set :logging, true
+  register(JsTestServer::Server::Resources::WebRoot.route_handler)
+  register(JsTestServer::Server::Resources::SpecFile.route_handler)
+  register(JsTestServer::Server::Resources::File.route_handler)
+  register(JsTestServer::Server::Resources::FrameworkFile.route_handler)
+  register(JsTestServer::Server::Resources::RemoteControl.route_handler)
+  register(JsTestServer::Server::Resources::ImplementationsDeprecation.route_handler)
+  register(JsTestServer::Server::Resources::NotFound.route_handler)
+end