selenium_shots 0.1.0 → 0.2.0

data/README.rdoc

@@ -3,16 +3,6 @@
 http://www.seleniumshots.com
 Selenium Shots is an Integration Testing Service that transparently distributes your integration tests across multiple operating systems with different versions of all major browsers AND captures a screen shot. This eliminates the need to have multiple vm's on your computer or the need for multiple machines on your test to test your web application.  Running your tests remotely will dramatically speed up in-browser web testing and leave more time to  and create a slide show available to confirm visuals making it easy for you to improve your web application.
 
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
 == Copyright
 
 Copyright (c) 2010 Kyle Ginavan. See LICENSE for details.

data/bin/selenium_shots_local_server

@@ -3,52 +3,14 @@
 require 'rubygems'
 require 'fileutils'
 
-GEM_ROOT        = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-SELENIUM_SERVER = File.join(GEM_ROOT, 'vendor', 'selenium-server-1.0.2-SNAPSHOT-standalone.jar')
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib/selenium_shots/cli/')
 
-
-module SeleniumShots
-  module Server
-    class << self
-      def pid_file
-        '/tmp/selenium_shots.pid'
-      end
-
-      def start_process
-        if File.exists?(pid_file)
-          puts "the selenium shots server is running...."
-        else
-          pipe = IO.popen("java -jar #{SELENIUM_SERVER}")
-          File.open(pid_file, 'w') {|f| f.write(pipe.pid) }
-        end
-      end
-
-      def stop_process
-        if File.exists?(pid_file)
-          process_id = File.open(pid_file,'r').readline
-          Process.kill 9, process_id.to_i
-          FileUtils.rm(pid_file)
-        end
-      end
-    end
-  end
-end
-
-help = <<EOF
-  selenium_shots_local_server {start|stop}
-EOF
+require 'init'
 
 args = ARGV.dup
 ARGV.clear
 
-command = args.shift.strip rescue help
+command = args.shift.strip rescue 'help'
 
-case command
-  when "start"
-    SeleniumShots::Server.start_process
-  when "stop":
-    SeleniumShots::Server.stop_process
-  else
-    puts help
-end
+SeleniumShots::Command.run("server:#{command}", args)
 

data/examples/google.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+
+class Google < SeleniumShots
+
+  @group = "Google"
+
+  selenium_shot "should search on google" do
+    @name = "selenium shots"
+    browser.open "/"
+    browser.type "q", "Selenium Shots"
+    browser.click "btnG"
+  end
+
+end
+

data/lib/selenium_shots/cli/client.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-#require 'rest_client'
+require 'rest_client'
 require 'uri'
 require 'time'
 
@@ -12,11 +12,6 @@ class SeleniumShots::Client
 		@host     = host
 	end
 
-  def list
-    #get list app from selenium_shots
-    []
-  end
-
 ############
 	def resource(uri)
 		RestClient::Resource.new("http://#{host}", api_key)[uri]

data/lib/selenium_shots/cli/command.rb

@@ -8,6 +8,8 @@ module SeleniumShots
 				run_internal(command, args)
 			rescue InvalidCommand
 				display "Unknown command. Run 'selenium_shots help' for usage information."
+    	rescue RestClient::Unauthorized
+				display "Authentication failure. For more information you can go to http://www.seleniumshots.com"
 			end
 
 			def run_internal(command, args)

data/lib/selenium_shots/cli/commands/app.rb

@@ -1,23 +1,16 @@
 module SeleniumShots::Command
 	class App < Base
     def create
-		  name    = args.shift.downcase.strip rescue nil
+		  name = args.shift.downcase.strip rescue nil
       if name
-        api_key ||= SeleniumShots::Command.run_internal('auth:api_key', args)
-		    display "Created #{name}" if make_config_file(name, api_key) == "y"
+        selenium_shots_api_key
+        if make_config_file(name, @api_key) == "y"
+		      display "Created #{name}\nYou can configurate selenium shots on config/selenium_shots.yml"
+        end
       else
         display "You need specify a name for your app. Run 'selenium_shots help' for usage information"
       end
     end
-
-    def list
-			list = selenium_shots.list
-			if list.size > 0
-				display list.join("\n")
-			else
-				display "You have no apps."
-			end
-		end
 	end
 end
 

data/lib/selenium_shots/cli/commands/auth.rb

@@ -15,7 +15,7 @@ module SeleniumShots::Command
 		end
 
     def get_api_key_from_host
-      RestClient.post 'http://seleniumshots.heroku.com/selenium_tests/get_api_key', :user_session => { :login => @api_key_hash[0],
+      RestClient.post 'http://seleniumshots.heroku.com/selenium_tests/get_api_key', :user_session => { :email => @api_key_hash[0],
                                                                                     :password => @api_key_hash[1]}
     end
 
@@ -49,7 +49,7 @@ module SeleniumShots::Command
 		def ask_for_api_key
 			puts "Enter your SeleniumShots Account"
 
-			print "Login: "
+			print "Email: "
 			user = ask
 
 			print "Password: "

data/lib/selenium_shots/cli/commands/base.rb

@@ -11,6 +11,10 @@ module SeleniumShots::Command
 			@selenium_shots ||= SeleniumShots::Command.run_internal('auth:client', args)
 		end
 
+    def selenium_shots_api_key
+      @api_key ||= SeleniumShots::Command.run_internal('auth:api_key', args)
+    end
+
 		def display(msg, newline=true)
 			newline ? puts(msg) : print(msg)
 		end
@@ -38,7 +42,7 @@ module SeleniumShots::Command
 
   def ask_for_config_file
     if File.exists?(config_file)
-			print "The config file exists, do you want overwrite this? (y/n): "
+			print "The file config/selenium_shots.yml exists, do you want overwrite this? (y/n): "
 			ask
     else
       "y"
@@ -49,15 +53,14 @@ module SeleniumShots::Command
       overwrite_or_create_file = ask_for_config_file
       if overwrite_or_create_file == "y"
         config_file_hash = <<EOFILE
-#remote way
 api_key: "#{api_key}"
 mode: "remote" # "local" for run test locally
 default_browser_url: "http://www.myapp.com"
 application_name: "#{name}"
+local_browser: "*firefox3"
 browsers:
-    - IE8 on XP          #browser for remote way
-    - Firefox3.6 on XP   #browser for remote way
-#   - "*firefox3" #browser for local way
+    - IE8 on XP
+    - Firefox3.6 on XP
 EOFILE
 			File.open(config_file, 'w') do |f|
 				f.puts config_file_hash
@@ -66,10 +69,6 @@ EOFILE
     overwrite_or_create_file
   end
 
-    def inside_rails_app?
-      File.exists?('config/environment.rb')
-    end
-
 	end
 
 end

data/lib/selenium_shots/cli/commands/help.rb

@@ -8,8 +8,9 @@ module SeleniumShots::Command
 			usage = <<EOTXT
 === General Commands
 
- help                         # show this usage
- create [name]                # create file config for your app
+ help                     # show this usage
+ create [name]            # create file config for your app
+
 === Example story:
 
  rails myapp

data/lib/selenium_shots/cli/commands/server.rb

@@ -0,0 +1,34 @@
+module SeleniumShots::Command
+	class Server < Base
+
+    GEM_ROOT        = File.expand_path(File.join(File.dirname(__FILE__), '/../../../../'))
+    SELENIUM_SERVER = File.join(GEM_ROOT, 'vendor', 'selenium-server-1.0.2-SNAPSHOT-standalone.jar')
+
+    def pid_file
+      '/tmp/selenium_shots.pid'
+    end
+
+    def start
+      if File.exists?(pid_file)
+        puts "the selenium shots server is running...."
+      else
+        pipe = IO.popen("java -jar #{SELENIUM_SERVER}")
+        File.open(pid_file, 'w') {|f| f.write(pipe.pid) }
+      end
+    end
+
+    def stop
+      if File.exists?(pid_file)
+        process_id = File.open(pid_file,'r').readline
+        Process.kill 9, process_id.to_i
+        FileUtils.rm(pid_file)
+      end
+    end
+
+    def help
+      puts "selenium_shots_local_server {start|stop}"
+    end
+
+	end
+end
+

data/lib/selenium_shots/cli/init.rb

@@ -1,9 +1,9 @@
 module SeleniumShots; end
 
+$LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/commands')
 
-require "rubygems" #take this later
-require "base"
 require "client"
 require "command"
+require "base"
 

data/lib/selenium_shots/test_selenium_shots.rb

@@ -5,11 +5,9 @@ require 'active_support'
 require 'active_support/test_case'
 require 'ostruct'
 
-
 #load config
 SeleniumConfig = OpenStruct.new(YAML.load_file("#{RAILS_ROOT}/config/selenium_shots.yml"))
 #
-ENV["RAILS_ENV"] = "test"
 
 #activeresource models
 class SeleniumTest < ActiveResource::Base
@@ -37,6 +35,22 @@ class SeleniumShots < ActionController::IntegrationTest
     "/tmp/selenium_shots.pid"
   end
 
+  def local_browsers
+    ["*firefox3", "*iexplore", "*safari"]
+  end
+
+  def selected_browsers
+    if SeleniumConfig.mode == "remote"
+      SeleniumConfig.browsers
+    else
+      if defined?(SeleniumConfig.local_browser)
+        [SeleniumConfig.local_browser]
+     else
+        [local_browsers.first]
+     end
+    end
+  end
+
   def setup
     if(not self.class.expected_test_count)
       self.class.expected_test_count = (self.class.instance_methods.reject{|method| method[0..3] != 'test'}).length
@@ -75,14 +89,24 @@ class SeleniumShots < ActionController::IntegrationTest
   end
 
   def run_in_all_browsers(&block)
-    SeleniumConfig.browsers.each do |browser_spec|
+    browsers = (@selected_browser || selected_browsers)
+    browsers.each do |browser_spec|
       begin
         run_browser(browser_spec, block)
         @error = nil
-      rescue => error
+      rescue  => error
         @error = error.message
+        if @error.match(/Failed to start new browser session/) && SeleniumConfig.mode == "local"
+          @tmp_browsers ||= local_browsers
+          @tmp_browsers.delete(browser_spec)
+          @selected_browser  = [@tmp_browsers.shift]
+          unless @selected_browser.empty?
+            puts "The browser #{browser_spec} is not available, selenium_shots going to try with #{@selected_browser} browser"
+            run_in_all_browsers(&block)
+          end
+        end
       end
-       assert @error.nil?, "Expected zero failures or errors, but got #{@error}\n"
+      assert @error.nil?, "Expected zero failures or errors, but got #{@error}\n"
     end
   end
 

data/spec/base.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'spec'
+require 'fileutils'
+
+require File.dirname(__FILE__) + '/../lib/selenium_shots/cli/init'
+
+%w(app auth base server).each { |c| require c }
+
+def prepare_command(klass)
+	command = klass.new([])
+	command.stub!(:display)
+	command
+end
+

data/spec/commands/app_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../base'
+
+module SeleniumShots::Command
+	describe App do
+		before do
+			@cli  = prepare_command(App)
+			@auth = prepare_command(Auth)
+		end
+
+		it "creates with a name" do
+			@cli.stub!(:args).and_return([ 'myapp' ])
+      @cli.stub!(:selenium_shots_api_key).and_return("api_key")
+      @cli.should_receive(:make_config_file)
+			@cli.create
+		end
+
+		it "cant creates app without a name" do
+			@cli.stub!(:args).and_return([ nil ])
+      @cli.stub!(:selenium_shots_api_key)
+      @cli.should_not_receive(:make_config_file)
+			@cli.create
+		end
+
+	end
+end
+

data/spec/commands/auth_spec.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/../base'
+
+module SeleniumShots::Command
+	describe Auth do
+		before do
+			@cli = prepare_command(Auth)
+		end
+
+		it "reads api key from the api keys file" do
+			sandbox = "/tmp/cli_spec_#{Process.pid}"
+			File.open(sandbox, "w") { |f| f.write "api_key" }
+			@cli.stub!(:api_key_file).and_return(sandbox)
+			@cli.read_api_key.should == %w(api_key)
+		end
+
+		it "takes the apikey from the file" do
+			@cli.stub!(:read_api_key).and_return(%w(api_key))
+			@cli.api_key.should == %w(api_key)
+		end
+
+		it "asks for api_key when the file doesn't exist" do
+			sandbox = "/tmp/cli_spec_#{Process.pid}"
+			FileUtils.rm_rf(sandbox)
+			@cli.stub!(:api_key_file).and_return(sandbox)
+			@cli.should_receive(:ask_for_api_key).and_return(['u', 'p'])
+			@cli.should_receive(:save_api_key)
+			@cli.get_api_key.should == [ 'u', 'p' ]
+		end
+
+		it "writes the api_key to a file" do
+			sandbox = "/tmp/cli_spec_#{Process.pid}"
+			FileUtils.rm_rf(sandbox)
+			@cli.stub!(:api_key_file).and_return(sandbox)
+			@cli.stub!(:api_key_hash).and_return(['api_key'])
+			@cli.should_receive(:set_api_key_permissions)
+			@cli.write_api_key
+			File.read(sandbox).should == "api_key\n"
+		end
+
+		it "sets ~/.selenium_shots/api_key to be readable only by the user" do
+			sandbox = "/tmp/cli_spec_#{Process.pid}"
+			FileUtils.rm_rf(sandbox)
+			FileUtils.mkdir_p(sandbox)
+			fname = "#{sandbox}/file"
+			system "touch #{fname}"
+			@cli.stub!(:api_key_file).and_return(fname)
+			@cli.set_api_key_permissions
+			File.stat(sandbox).mode.should == 040700
+			File.stat(fname).mode.should == 0100600
+		end
+
+		it "writes api_key when the account is ok" do
+			@cli.stub!(:api_key)
+			@cli.should_receive(:write_api_key)
+			@cli.should_receive(:get_api_key_from_host).and_return("api_key")
+			@cli.save_api_key
+		end
+
+		it "save_api_key deletes the api_key when the resquest api_key is unauthorized" do
+			@cli.stub!(:write_api_key)
+			@cli.stub!(:retry_login?).and_return(false)
+			@cli.should_receive(:get_api_key_from_host).and_raise(RestClient::Unauthorized)
+			@cli.should_receive(:delete_api_key)
+			lambda { @cli.save_api_key }.should raise_error(RestClient::Unauthorized)
+		end
+
+
+		it "asks for login again when not authorized, for three times" do
+			@cli.stub!(:read_api_key)
+			@cli.stub!(:write_api_key)
+			@cli.stub!(:delete_api_key)
+			@cli.should_receive(:get_api_key_from_host).exactly(3).times.and_raise(RestClient::Unauthorized)
+			@cli.should_receive(:ask_for_api_key).exactly(4).times
+			lambda { @cli.save_api_key }.should raise_error(RestClient::Unauthorized)
+		end
+
+		it "deletes the api_key file" do
+			FileUtils.should_receive(:rm_f).with(@cli.api_key_file)
+			@cli.delete_api_key
+		end
+	end
+end
+

data/spec/commands/base_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../base'
+
+module SeleniumShots::Command
+	describe Base do
+		before do
+			@args = [1, 2]
+			@base = Base.new(@args)
+			@base.stub!(:display)
+		end
+
+		it "initializes the selenium_shots client with the Auth command" do
+			SeleniumShots::Command.should_receive(:run_internal).with('auth:client', @args)
+			@base.selenium_shots
+		end
+
+    it "creates or overwrite the selenium_shots yml file" do
+			sandbox = "/tmp/cli_spec_selenium_shots"
+			@base.stub!(:config_file).and_return(sandbox)
+      @base.should_receive(:ask_for_config_file).and_return("y")
+      @base.make_config_file("myapp", "api_key")
+      File.exists?(sandbox) == true
+    end
+
+    it "not overwrite the selenium_shots yml file" do
+			sandbox = "/tmp/cli_spec_selenium_shots"
+			@base.stub!(:config_file).and_return(sandbox)
+      @base.should_receive(:ask_for_config_file).and_return("n")
+      @base.make_config_file("myapp", "api_key")
+      File.exists?(sandbox) == false
+    end
+
+    it "return the config file name" do
+      @base.config_file.should == 'config/selenium_shots.yml'
+    end
+
+	end
+end
+

data/spec/commands/server_spec.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + '/../base'
+
+module SeleniumShots::Command
+	describe Server do
+		before do
+			@cli = prepare_command(Server)
+		end
+
+		it "run local instance of selenium server" do
+			@cli.start
+      File.exists?("/tmp/selenium_shots.pid") == true
+		end
+
+		it "stop local instance of selenium server" do
+			@cli.stop
+      File.exists?("/tmp/selenium_shots.pid") == false
+		end
+
+
+	end
+end
+

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kyle J. Ginavan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-13 00:00:00 -05:00
+date: 2010-04-20 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,6 +44,20 @@ dependencies:
         version: 1.2.18
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 2
+        version: 0.8.2
+  type: :runtime
+  version_requirements: *id003
 description: Selenium Shots is an Integration Testing Service that transparently distributes your integration tests across multiple operating systems with different versions of all major browsers AND captures a screen shot
 email: kyle@4rockets.com
 executables: 
@@ -63,6 +77,7 @@ files:
 - lib/selenium_shots/cli/commands/auth.rb
 - lib/selenium_shots/cli/commands/base.rb
 - lib/selenium_shots/cli/commands/help.rb
+- lib/selenium_shots/cli/commands/server.rb
 - lib/selenium_shots/cli/init.rb
 - lib/selenium_shots/test_selenium_shots.rb
 - vendor/selenium-server-1.0.2-SNAPSHOT-standalone.jar
@@ -100,5 +115,11 @@ signing_key:
 specification_version: 3
 summary: Integration Tests made easy
 test_files: 
+- spec/base.rb
+- spec/commands/app_spec.rb
+- spec/commands/auth_spec.rb
+- spec/commands/base_spec.rb
+- spec/commands/server_spec.rb
 - test/helper.rb
 - test/test_selenium_shots.rb
+- examples/google.rb