js_test_core 0.1.1

data/CHANGES

@@ -0,0 +1,9 @@
+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/README

@@ -0,0 +1,12 @@
+= JsTestCore
+The JsTestCore library is the core javascript test server library used by several JS Test server libraries.
+
+To hook up your own JS Test framework:
+  * You will need to call either JsTestCore::Resources::WebRoot.dispatch_specs or JsTestCore::Resources::WebRoot.dispatch_tests
+    depending if you are serving specs or tests.
+  * Set JsTestCore.core_path to the directory of the client side test framework (javascript files)
+  * Override JsTestCore::Resources::Specs::SpecFile#get or JsTestCore::Resources::Specs::TestFile#get
+  * Override JsTestCore::Resources::Specs::SpecDir#get or JsTestCore::Resources::Specs::TestDir#get
+
+NOTE: The current version of JsTestCore does not yet support tests. Support will be added soon.
+      I just wanted the test stuff to be in the docs to establish the current architectural direction.

data/Rakefile

@@ -0,0 +1,72 @@
+require "rake"
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc "Runs the Rspec suite"
+task(:default) do
+  run_suite
+end
+
+desc "Runs the Rspec suite"
+task(:spec) do
+  run_suite
+end
+
+desc "Copies the trunk to a tag with the name of the current release"
+task(:tag_release) do
+  tag_release
+end
+
+def run_suite
+  dir = File.dirname(__FILE__)
+  system("ruby #{dir}/spec/spec_suite.rb") || raise("Example Suite failed")
+end
+
+PKG_NAME = "js_test_core"
+PKG_VERSION = "0.1.1"
+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 JsTestCore 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.extra_rdoc_files = [ "README", "CHANGES" ]
+  s.rdoc_options = ["--main", "README", "--inline-source", "--line-numbers"]
+
+  s.test_files = Dir.glob('spec/*_spec.rb')
+  s.require_path = 'lib'
+  s.author = "Brian Takita"
+  s.email = "brian@pivotallabs.com"
+  s.homepage = "http://pivotallabs.com"
+  s.rubyforge_project = "pivotalrb"
+  s.add_dependency('Selenium')
+  s.add_dependency('thin', '=0.8.1')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+def tag_release
+  dashed_version = PKG_VERSION.gsub('.', '-')
+  svn_user = "#{ENV["SVN_USER"]}@" || ""
+  `svn cp svn+ssh://#{svn_user}rubyforge.org/var/svn/pivotalrb/js_test_core/trunk svn+ssh://#{svn_user}rubyforge.org/var/svn/pivotalrb/js_test_core/tags/REL-#{dashed_version} -m 'Version #{PKG_VERSION}'`
+end

data/lib/js_test_core.rb

@@ -0,0 +1,30 @@
+require "rubygems"
+gem "thin", ">=0.8.0"
+
+require "thin"
+require "fileutils"
+require "tmpdir"
+require "timeout"
+require "cgi"
+require "net/http"
+require "selenium"
+require "optparse"
+
+dir = File.dirname(__FILE__)
+require "#{dir}/js_test_core/thin"
+require "#{dir}/js_test_core/rack"
+require "#{dir}/js_test_core/resources"
+require "#{dir}/js_test_core/selenium"
+
+require "#{dir}/js_test_core/client"
+require "#{dir}/js_test_core/server"
+require "#{dir}/js_test_core/rails_server"
+
+module JsTestCore
+  DEFAULT_HOST = "0.0.0.0"
+  DEFAULT_PORT = 8080
+
+  class << self
+    attr_accessor :core_path
+  end
+end

data/lib/js_test_core/client.rb

@@ -0,0 +1,50 @@
+module JsTestCore
+  class Client
+    class << self
+      def run(params={})
+        data = []
+        data << "selenium_host=#{CGI.escape(params[:selenium_host] || 'localhost')}"
+        data << "selenium_port=#{CGI.escape((params[:selenium_port] || 4444).to_s)}"
+        data << "spec_url=#{CGI.escape(params[:spec_url])}" if params[:spec_url]
+        response = Net::HTTP.start(DEFAULT_HOST, DEFAULT_PORT) do |http|
+          http.post('/runners/firefox', data.join("&"))
+        end
+
+        body = response.body
+        if body.empty?
+          puts "SUCCESS"
+          return true
+        else
+          puts "FAILURE"
+          puts body
+          return false
+        end
+      end
+
+      def run_argv(argv)
+        params = {}
+        parser = OptionParser.new do |o|
+          o.banner = "JsTestCore Runner"
+          o.banner << "\nUsage: #{$0} [options] [-- untouched arguments]"
+
+          o.on
+          o.on('-h', '--selenium_host=SELENIUM_HOST', "The host name of the Selenium Server relative to where this file is executed") do |host|
+            params[:selenium_host] = host
+          end
+
+          o.on('-p', '--selenium_port=SELENIUM_PORT', "The port of the Selenium Server relative to where this file is executed") do |port|
+            params[:selenium_port] = port
+          end
+
+          o.on('-u', '--spec_url=SPEC_URL', "The url of the js spec server, relative to the browsers running via the Selenium Server") do |spec_url|
+            params[:spec_url] = spec_url
+          end
+
+          o.on_tail
+        end
+        parser.order!(argv)
+        run params
+      end
+    end
+  end
+end

data/lib/js_test_core/rack.rb

@@ -0,0 +1,2 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/rack/commonlogger"

data/lib/js_test_core/rack/commonlogger.rb

@@ -0,0 +1,5 @@
+Rack::CommonLogger.class_eval do
+  def empty?
+    @body.empty?
+  end
+end

data/lib/js_test_core/rails_server.rb

@@ -0,0 +1,22 @@
+module JsTestCore
+  class RailsServer < Server
+    class << self
+      def run(rails_root, server_options = {})
+        server_options[:Host] ||= DEFAULT_HOST
+        server_options[:Port] ||= DEFAULT_PORT
+        Server.instance = new(rails_root, server_options[:Host], server_options[:Port])
+        Server.instance.run server_options
+      end
+    end
+
+    def initialize(rails_root, host=DEFAULT_HOST, port=DEFAULT_PORT)
+      super(
+        "#{rails_root}/spec/javascripts",
+        "#{rails_root}/public/javascripts",
+        "#{rails_root}/public",
+        host,
+        port
+      )
+    end
+  end
+end

data/lib/js_test_core/resources.rb

@@ -0,0 +1,10 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/resources/runners"
+require "#{dir}/resources/runners/firefox_runner"
+require "#{dir}/resources/file"
+require "#{dir}/resources/dir"
+require "#{dir}/resources/specs/spec_file"
+require "#{dir}/resources/specs/spec_dir"
+require "#{dir}/resources/web_root"
+require "#{dir}/resources/suite"
+require "#{dir}/resources/suite_finish"

data/lib/js_test_core/resources/dir.rb

@@ -0,0 +1,52 @@
+module JsTestCore
+  module Resources
+    class Dir < File
+      def locate(name)
+        if file = file(name)
+          file
+        elsif subdir = subdir(name)
+          subdir
+        else
+          raise "No file or directory found at #{relative_path}/#{name}."
+        end
+      end
+
+      def get(request, response)
+
+      end
+
+      def glob(pattern)
+        expanded_pattern = absolute_path + pattern
+        ::Dir.glob(expanded_pattern).map do |absolute_globbed_path|
+          relative_globbed_path = absolute_globbed_path.gsub(absolute_path, relative_path)
+          File.new(absolute_globbed_path, relative_globbed_path)
+        end
+      end
+
+      protected
+      def determine_child_paths(name)
+        absolute_child_path = "#{absolute_path}/#{name}"
+        relative_child_path = "#{relative_path}/#{name}"
+        [absolute_child_path, relative_child_path]
+      end
+
+      def file(name)
+        absolute_file_path, relative_file_path = determine_child_paths(name)
+        if ::File.exists?(absolute_file_path) && !::File.directory?(absolute_file_path)
+          Resources::File.new(absolute_file_path, relative_file_path)
+        else
+          nil
+        end
+      end
+
+      def subdir(name)
+        absolute_dir_path, relative_dir_path = determine_child_paths(name)
+        if ::File.directory?(absolute_dir_path)
+          Resources::Dir.new(absolute_dir_path, relative_dir_path)
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/js_test_core/resources/file.rb

@@ -0,0 +1,32 @@
+module JsTestCore
+  module Resources
+    class File
+      MIME_TYPES = {
+        '.js' => 'text/javascript',
+        '.css' => 'text/css',
+        '.png' => 'image/png',
+        '.jpg' => 'image/jpeg',
+        '.jpeg' => 'image/jpeg',
+        '.gif' => 'image/gif',
+      }
+
+      attr_reader :absolute_path, :relative_path
+
+      def initialize(absolute_path, relative_path)
+        @absolute_path = absolute_path
+        @relative_path = relative_path
+      end
+
+      def get(request, response)
+        extension = ::File.extname(absolute_path)
+        response.headers['Content-Type'] = MIME_TYPES[extension] || 'text/html'
+        response.body = ::File.read(absolute_path)
+      end
+
+      def ==(other)
+        return false unless other.class == self.class
+        absolute_path == other.absolute_path && relative_path == other.relative_path
+      end
+    end
+  end
+end

data/lib/js_test_core/resources/runners.rb

@@ -0,0 +1,15 @@
+dir = File.dirname(__FILE__)
+
+module JsTestCore
+  module Resources
+    class Runners
+      def locate(name)
+        if name == 'firefox'
+          FirefoxRunner.new
+        else
+          raise "Invalid path #{name}"
+        end
+      end
+    end
+  end
+end

data/lib/js_test_core/resources/runners/firefox_runner.rb

@@ -0,0 +1,73 @@
+module JsTestCore
+  module Resources
+    class Runners
+      class FirefoxRunner
+        class << self
+          def resume(suite_id, text)
+            runner = instances.delete(suite_id)
+            runner.finalize(text)
+          end
+
+          def register_instance(runner)
+            instances[runner.suite_id] = runner
+          end
+
+          protected
+          def instances
+            @instances ||= {}
+          end
+        end
+
+        include FileUtils
+        attr_reader :profile_dir, :connection, :driver, :response
+
+        def initialize
+          profile_base = "#{::Dir.tmpdir}/js_test_core/firefox"
+          mkdir_p profile_base
+          @profile_dir = "#{profile_base}/#{Time.now.to_i}"
+          @connection = Server.connection
+        end
+
+        def post(request, response)
+          @response = response
+
+          spec_url = (request && request['spec_url']) ? request['spec_url'] : spec_suite_url
+          parsed_spec_url = URI.parse(spec_url)
+          selenium_port = (request['selenium_port'] || 4444).to_i
+          @driver = Selenium::SeleniumDriver.new(
+            request['selenium_host'] || 'localhost',
+            selenium_port,
+            '*firefox',
+            "#{parsed_spec_url.scheme}://#{parsed_spec_url.host}:#{parsed_spec_url.port}"
+          )
+          begin
+            driver.start
+          rescue Errno::ECONNREFUSED => e
+            raise Errno::ECONNREFUSED, "Cannot connect to Selenium Server on port #{selenium_port}. To start the selenium server, run `selenium`."
+          end
+          Thread.start do
+            driver.open(spec_url)
+          end
+          response.status = 200
+          FirefoxRunner.register_instance self
+        end
+
+        def finalize(text)
+          driver.stop
+          response.body = text
+          connection.send_body(response)
+        end
+
+        def suite_id
+          driver.session_id
+        end
+
+        protected
+
+        def spec_suite_url
+          "#{Server.root_url}/specs"
+        end
+      end
+    end
+  end
+end

data/lib/js_test_core/resources/specs/spec_dir.rb

@@ -0,0 +1,50 @@
+module JsTestCore
+  module Resources
+    module Specs
+      class SpecDirSuperclass < ::JsTestCore::Resources::Dir
+        def get(request, response)
+          raise NotImplementedError, "#{self.class}#get needs to be implemented"
+        end
+      end
+
+      class SpecDir < SpecDirSuperclass
+        def spec_files
+          glob("/**/*_spec.js")
+        end
+
+        def locate(name)
+          if file = file(name)
+            file
+          elsif subdir = subdir(name)
+            subdir
+          elsif spec_file = spec_file(name)
+            spec_file
+          else
+            base_path = "#{relative_path}/#{name}"
+            raise "No file or directory found at #{base_path} or spec found at #{base_path}.js."
+          end
+        end
+
+        protected
+
+        def subdir(name)
+          absolute_dir_path, relative_dir_path = determine_child_paths(name)
+          if ::File.directory?(absolute_dir_path)
+            SpecDir.new(absolute_dir_path, relative_dir_path)
+          else
+            nil
+          end
+        end
+
+        def spec_file(name)
+          absolute_file_path, relative_file_path = determine_child_paths("#{name}.js")
+          if ::File.exists?(absolute_file_path) && !::File.directory?(absolute_file_path)
+            SpecFile.new(absolute_file_path, relative_file_path)
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end