symbiont 0.0.1 → 0.0.2

data/HISTORY.md

@@ -1,6 +1,12 @@
 Change Log and History
 ======================
 
+Version 0.0.2 / 2012-03-15
+--------------------------
+
+This implementation of Symbiont is designed to show the basics of how platform objects, web objects, and a generator mechanism work together to create a test script style that normalizes execution with Selenium and Watir and provides a convention-based approach to interaction with browser objects.
+
+
 Version 0.0.1 / 2012-03-02
 --------------------------
 

data/README.md

@@ -6,6 +6,8 @@ Description
 
 The Symbiont gem is designed to provide an open framework for running automated tests against a browser using popular web testing interfaces.
 
+Right now the best information on the purpose of this project and how it works can be found on [my Symbiont-tagged blog posts](http://testerstories.com/?cat=16).
+
 
 Meaning
 -------

data/lib/symbiont/generators.rb

@@ -15,5 +15,80 @@ module Symbiont
       end
     end
 
+    # This method allows for a begin_at() method in definitions. The
+    # URL provided can be navigated to using the generated start()
+    # method on a definition instance.
+    #
+    # @see Symbiont::Generators#url_is
+    # @param [String] url the resource identifier to access
+    # @return [Nil]
+    def begin_at(url)
+      define_method("start") do
+        @platform.visit(url)
+      end
+    end
+
+    # Definition method for links. Methods for the following actions will
+    # be created:
+    # * reference a link (identifier_object, identifier_link)
+    # * click a link (identifier)
+    # @param [Symbol] identifier the friendly name of the web object
+    # @param [optional, Hash] locator the key/values that identify the object
+    # @return [Object] instance of Symbiont::WebObjects::Link
+    def link(identifier, locator)
+      define_method("#{identifier}_object") do
+        @platform.get_link_for(locator.clone)
+      end
+
+      alias_method "#{identifier}_link".to_sym, "#{identifier}_object".to_sym
+
+      define_method(identifier) do
+        @platform.click_link_for(locator.clone)
+      end
+    end
+
+    # Definition method for buttons. Methods for the following actions will
+    # be created:
+    # * reference a button (identifier_object, identifier_button)
+    # * click a button (identifier)
+    # @param [Symbol] identifier the friendly name of the web object
+    # @param [optional, Hash] locator the key/values that identify the object
+    # @return [Object] instance of Symbiont::WebObjects::Button
+    def button(identifier, locator)
+      define_method("#{identifier}_object") do
+        @platform.get_button_for(locator.clone)
+      end
+
+      alias_method "#{identifier}_button".to_sym, "#{identifier}_object".to_sym
+
+      define_method(identifier) do
+        @platform.click_button_for(locator.clone)
+      end
+    end
+
+    # Definition method for text fields. Methods for the following actions
+    # will be created:
+    # * reference a text field (identifier_object, identifier_button)
+    # * get text from a text field (identifier)
+    # * set text in a text field (identifier=)
+    # @param [Symbol] identifier the friendly name of the web object
+    # @param [optional, Hash] locator the key/values that identify the object
+    # @return [Object] instance of Symbiont::WebObjects::TextField
+    def text_field(identifier, locator)
+      define_method("#{identifier}_object") do
+        @platform.get_text_field_for(locator.clone)
+      end
+
+      alias_method "#{identifier}_text_field".to_sym, "#{identifier}_object".to_sym
+
+      define_method(identifier) do
+        @platform.get_text_field_value_for(locator.clone)
+      end
+
+      define_method("#{identifier}=") do |value|
+        @platform.set_text_field_value_for(locator.clone, value)
+      end
+    end
+
   end # module: Generators
 end # module: Symbiont

data/lib/symbiont/platform_selenium/platform_object.rb

@@ -14,8 +14,58 @@ module Symbiont
           @browser.navigate.to(url)
         end
 
+        # Platform method to return a link object.
+        # Link objects are of type: Symbiont::WebObjects::Link
+        # @see Symbiont::Generators#link
+        def get_link_for(locator)
+          web_object = @browser.find_element(locator.keys.first, locator.values.first)
+          WebObjects::Link.new()
+        end
+
+        # Platform method to click a link object.
+        # @see Symbiont::Generators#link
+        def click_link_for(locator)
+          @browser.find_element(locator.keys.first, locator.values.first).click
+        end
+
+        # Platform method to return a button object.
+        # Button objects are of type: Symbiont::WebObjects::Button
+        # @see Symbiont::Generators#button
+        def get_button_for(locator)
+          web_object = @browser.find_element(locator.keys.first, locator.values.first)
+          WebObjects::Button.new()
+        end
+
+        # Platform method to click a button object.
+        # @see Symbiont::Generators#button
+        def click_button_for(locator)
+          @browser.find_element(locator.keys.first, locator.values.first).click
+        end
+
+        # Platform method to return a text field object.
+        # Text field objects are of type: Symbiont::WebObjects::TextField
+        # @see Symbiont::Generators#text_field
+        def get_text_field_for(locator)
+          web_object = @browser.find_element(locator.keys.first, locator.values.first)
+          WebObjects::TextField.new()
+        end
+
+        # Platform method to retrieve text from a text field object.
+        # @see Symbiont::Generators#text_field
+        def get_text_field_value_for(locator)
+          @browser.find_element(locator.keys.first, locator.values.first).attribute('value')
+        end
+
+        # Platform method to enter text into a text field object.
+        # @see Symbiont::Generators#text_field
+        def set_text_field_value_for(locator, value)
+          @browser.find_element(locator.keys.first, locator.values.first).clear
+          @browser.find_element(locator.keys.first, locator.values.first).send_keys(value)
+        end
       end # class: PlatformObject
 
     end # module: SeleniumWebDriver
   end # module: Platforms
-end # module: Symbiont
+end # module: Symbiont
+
+Dir["#{File.dirname(__FILE__)}/../web_objects/**/*.rb"].sort.each { |file| require file }

data/lib/symbiont/platform_watir/platform_object.rb

@@ -14,8 +14,57 @@ module Symbiont
           @browser.goto(url)
         end
 
+        # Platform method to return a link object.
+        # Link objects are of type: Symbiont::WebObjects::Link
+        # @see Symbiont::Generators#link
+        def get_link_for(locator)
+          web_object = @browser.instance_eval "link(locator)"
+          WebObjects::Link.new()
+        end
+
+        # Platform method to click a link object.
+        # @see Symbiont::Generators#link
+        def click_link_for(locator)
+          @browser.instance_eval "link(locator).click"
+        end
+
+        # Platform method to return a button object.
+        # Button objects are of type: Symbiont::WebObjects::Button
+        # @see Symbiont::Generators#button
+        def get_button_for(locator)
+          web_object = @browser.instance_eval "button(locator)"
+          WebObjects::Button.new()
+        end
+
+        # Platform method to click a button object.
+        # @see Symbiont::Generators#button
+        def click_button_for(locator)
+          @browser.instance_eval "button(locator).click"
+        end
+
+        # Platform method to return a text field object.
+        # Text field objects are of type: Symbiont::WebObjects::TextField
+        # @see Symbiont::Generators#text_field
+        def get_text_field_for(locator)
+          @browser.instance_eval "text_field(locator)"
+          WebObjects::TextField.new()
+        end
+
+        # Platform method to retrieve text from a text field object.
+        # @see Symbiont::Generators#text_field
+        def get_text_field_value_for(locator)
+          @browser.instance_eval "text_field(locator).value"
+        end
+
+        # Platform method to enter text into a text field object.
+        # @see Symbiont::Generators#text_field
+        def set_text_field_value_for(locator, value)
+          @browser.instance_eval "text_field(locator).set(value)"
+        end
       end # class: PlatformObject
 
     end # module: WatirWebDriver
   end # module: Platforms
-end # module: Symbiont
+end # module: Symbiont
+
+Dir["#{File.dirname(__FILE__)}/../web_objects/**/*.rb"].sort.each { |file| require file }

data/lib/symbiont/version.rb

@@ -1,3 +1,3 @@
-module Symbiont
-  VERSION = "0.0.1"
-end
+module Symbiont
+  VERSION = "0.0.2"
+end

data/lib/symbiont/web_objects/_common.rb

@@ -0,0 +1,9 @@
+module Symbiont
+  module WebObjects
+
+    class WebObject
+
+    end # class: WebObject
+
+  end # module: WebObjects
+end # module: Symbiont

data/lib/symbiont/web_objects/button.rb

@@ -0,0 +1,9 @@
+module Symbiont
+  module WebObjects
+
+    class Button < WebObject
+
+    end # class: Button
+
+  end # module: WebObjects
+end # module: Symbiont

data/lib/symbiont/web_objects/link.rb

@@ -0,0 +1,9 @@
+module Symbiont
+  module WebObjects
+
+    class Link < WebObject
+
+    end # class: Link
+
+  end # module: WebObjects
+end # module: Symbiont

data/lib/symbiont/web_objects/text_field.rb

@@ -0,0 +1,9 @@
+module Symbiont
+  module WebObjects
+
+    class TextField < WebObject
+
+    end # class: TextField
+
+  end # module: WebObjects
+end # module: Symbiont

data/spec/spec_helper.rb

@@ -15,6 +15,11 @@ class DefinitionTest
   include Symbiont
 
   url_is "http://localhost:4567"
+  begin_at "http://localhost:4567"
+
+  link :reset_password, id: "resetPassword"
+  button :submit, id: "btnSubmit"
+  text_field :login_name, id: "loginName"
 end
 
 def mock_browser_for_watir

data/spec/symbiont/generators/button_generators_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Symbiont::Generators do
+  let(:watir_browser) { mock_browser_for_watir }
+  let(:selenium_browser) { mock_browser_for_selenium }
+  let(:watir_definition) { DefinitionTest.new(watir_browser) }
+  let(:selenium_definition) { DefinitionTest.new(selenium_browser) }
+
+  describe "button web objects" do
+    context "when declared in a definition" do
+      it "should generate methods for referencing the button" do
+        watir_definition.should respond_to(:submit_object)
+        watir_definition.should respond_to(:submit_button)
+
+        selenium_definition.should respond_to(:submit_object)
+        selenium_definition.should respond_to(:submit_button)
+      end
+    end
+
+    context "used by the watir platform" do
+      it "should locate the button" do
+        watir_browser.should_receive(:button).and_return(watir_browser)
+        web_object = watir_definition.submit_object
+        web_object.should_not be_nil
+        web_object.should be_instance_of Symbiont::WebObjects::Button
+      end
+
+      it "should click the button" do
+        watir_browser.should_receive(:button).and_return(watir_browser)
+        watir_browser.should_receive(:click)
+        watir_definition.submit
+      end
+    end
+
+    context "used by the selenium platform" do
+      it "should locate the button" do
+        selenium_browser.should_receive(:find_element).and_return(selenium_browser)
+        web_object = selenium_definition.submit_object
+        web_object.should_not be_nil
+        web_object.should be_instance_of Symbiont::WebObjects::Button
+      end
+
+      it "should click the button" do
+        selenium_browser.should_receive(:find_element).and_return(selenium_browser)
+        selenium_browser.should_receive(:click)
+        selenium_definition.submit
+      end
+    end
+  end
+end

data/spec/symbiont/generators/link_generators_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Symbiont::Generators do
+  let(:watir_browser) { mock_browser_for_watir }
+  let(:selenium_browser) { mock_browser_for_selenium }
+  let(:watir_definition) { DefinitionTest.new(watir_browser) }
+  let(:selenium_definition) { DefinitionTest.new(selenium_browser) }
+
+  describe "link web objects" do
+    context "when declared in a definition" do
+      it "should generate methods for referencing the link" do
+        watir_definition.should respond_to(:reset_password_object)
+        watir_definition.should respond_to(:reset_password_link)
+
+        selenium_definition.should respond_to(:reset_password_object)
+        selenium_definition.should respond_to(:reset_password_link)
+      end
+    end
+
+    context "when used by the watir platform" do
+      it "should locate the link" do
+        watir_browser.should_receive(:link).and_return(watir_browser)
+        web_object = watir_definition.reset_password_object
+        web_object.should_not be_nil
+        web_object.should be_instance_of Symbiont::WebObjects::Link
+      end
+
+      it "should click the link" do
+        watir_browser.stub_chain(:link, :click)
+        watir_definition.reset_password
+      end
+    end
+
+    context "when used by the selenium platform" do
+      it "should locate the link" do
+        selenium_browser.should_receive(:find_element).and_return(selenium_browser)
+        web_object = selenium_definition.reset_password_object
+        web_object.should_not be_nil
+        web_object.should be_instance_of Symbiont::WebObjects::Link
+      end
+
+      it "should click the link" do
+        selenium_browser.stub_chain(:find_element, :click)
+        selenium_definition.reset_password
+      end
+    end
+  end
+end

data/spec/symbiont/generators/text_field_generators_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Symbiont::Generators do
+  let(:watir_browser) { mock_browser_for_watir }
+  let(:selenium_browser) { mock_browser_for_selenium }
+  let(:watir_definition) { DefinitionTest.new(watir_browser) }
+  let(:selenium_definition) { DefinitionTest.new(selenium_browser) }
+
+  describe "text field web objects" do
+    context "when declared in a definition" do
+      it "should generate methods for referencing the text field" do
+        watir_definition.should respond_to(:login_name_text_field)
+        watir_definition.should respond_to(:login_name_object)
+
+        selenium_definition.should respond_to(:login_name_text_field)
+        selenium_definition.should respond_to(:login_name_object)
+      end
+    end
+
+    context "when used by the watir platform" do
+      it "should locate the text field" do
+        watir_browser.should_receive(:text_field).and_return(watir_browser)
+        web_object = watir_definition.login_name_object
+        web_object.should_not be_nil
+        web_object.should be_instance_of Symbiont::WebObjects::TextField
+      end
+
+      it "should retrieve text from the text field" do
+        watir_browser.should_receive(:text_field).and_return(watir_browser)
+        watir_browser.should_receive(:value).and_return("testing")
+        watir_definition.login_name.should == "testing"
+      end
+
+      it "should enter text into a text field" do
+        watir_browser.should_receive(:text_field).and_return(watir_browser)
+        watir_browser.should_receive(:set).with("testing")
+        watir_definition.login_name = "testing"
+      end
+    end
+
+    context "when used by the selenium platform" do
+      it "should locate the text field" do
+        selenium_browser.should_receive(:find_element).and_return(selenium_browser)
+        web_object = selenium_definition.login_name_object
+        web_object.should_not be_nil
+        web_object.should be_instance_of Symbiont::WebObjects::TextField
+      end
+
+      it "should retrieve text from the text field" do
+        selenium_browser.should_receive(:find_element).and_return(selenium_browser)
+        selenium_browser.should_receive(:attribute).with('value').and_return("testing")
+        selenium_definition.login_name.should == "testing"
+      end
+
+      it "should enter text into a text field" do
+        selenium_browser.should_receive(:find_element).twice.and_return(selenium_browser)
+        selenium_browser.should_receive(:clear)
+        selenium_browser.should_receive(:send_keys).with("testing")
+        selenium_definition.login_name = "testing"
+      end
+    end
+  end
+end

data/spec/symbiont/generators_spec.rb

@@ -12,6 +12,11 @@ describe Symbiont::Generators do
         watir_browser.should_receive(:goto)
         watir_definition.view
       end
+
+      it "should navigate to the page when started" do
+        watir_browser.should_receive(:goto)
+        watir_definition.start
+      end
     end
   end
 
@@ -22,6 +27,12 @@ describe Symbiont::Generators do
         selenium_browser.should_receive(:to)
         selenium_definition.view
       end
+
+      it "should navigate to the page when started" do
+        selenium_browser.should_receive(:navigate).and_return(selenium_browser)
+        selenium_browser.should_receive(:to)
+        selenium_definition.start
+      end
     end
   end
 

data/test/symbiont_selenium.rb

@@ -6,10 +6,30 @@ class Login
   include Symbiont
 
   url_is "http://localhost:4567"
+  begin_at "http://localhost:4567"
+
+  link :test_page, id: "testPage"
+  button :clickme, id: "clickme_id"
+  text_field :book_title, id: "title"
 end
 
 @browser_selenium = Selenium::WebDriver.for(:firefox)
 selenium_test = Login.new(@browser_selenium)
 selenium_test.view
 
+test_link = selenium_test.test_page_object
+puts test_link
+selenium_test.test_page
+
+test_text_field = selenium_test.book_title_object
+puts test_text_field
+
+selenium_test.book_title = "Revelation Space"
+book = selenium_test.book_title
+puts "Book title is '#{book}'."
+
+test_button = selenium_test.clickme_object
+puts test_button
+selenium_test.clickme
+
 @browser_selenium.close

data/test/symbiont_watir.rb

@@ -6,10 +6,30 @@ class Login
   include Symbiont
 
   url_is "http://localhost:4567"
+  begin_at "http://localhost:4567"
+
+  link :test_page, id: "testPage"
+  button :clickme, id: "clickme_id"
+  text_field :book_title, id: "title"
 end
 
 @browser_watir = Watir::Browser.new(:firefox)
 watir_test = Login.new(@browser_watir)
 watir_test.view
 
-@browser_watir.close
+test_link = watir_test.test_page_object
+puts test_link
+watir_test.test_page
+
+test_text_field = watir_test.book_title_object
+puts test_text_field
+
+watir_test.book_title = "Revelation Space"
+book = watir_test.book_title
+puts "Book title is '#{book}'."
+
+test_button = watir_test.clickme_object
+puts test_button
+watir_test.clickme
+
+@browser_watir.close

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: symbiont
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-02 00:00:00.000000000Z
+date: 2012-03-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &21048780 !ruby/object:Gem::Requirement
+  requirement: &27142536 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *21048780
+  version_requirements: *27142536
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &21048504 !ruby/object:Gem::Requirement
+  requirement: &27142260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.6.1
   type: :development
   prerelease: false
-  version_requirements: *21048504
+  version_requirements: *27142260
 - !ruby/object:Gem::Dependency
   name: watir-webdriver
-  requirement: &21048228 !ruby/object:Gem::Requirement
+  requirement: &27141972 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -43,10 +43,10 @@ dependencies:
         version: 0.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *21048228
+  version_requirements: *27141972
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
-  requirement: &28582476 !ruby/object:Gem::Requirement
+  requirement: &27141684 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -54,7 +54,7 @@ dependencies:
         version: 2.20.0
   type: :runtime
   prerelease: false
-  version_requirements: *28582476
+  version_requirements: *27141684
 description: An endosymbiotic facultative library for web application testing.
 email:
 - jeffnyman@gmail.com
@@ -76,7 +76,14 @@ files:
 - lib/symbiont/platform_watir/platform_object.rb
 - lib/symbiont/platforms.rb
 - lib/symbiont/version.rb
+- lib/symbiont/web_objects/_common.rb
+- lib/symbiont/web_objects/button.rb
+- lib/symbiont/web_objects/link.rb
+- lib/symbiont/web_objects/text_field.rb
 - spec/spec_helper.rb
+- spec/symbiont/generators/button_generators_spec.rb
+- spec/symbiont/generators/link_generators_spec.rb
+- spec/symbiont/generators/text_field_generators_spec.rb
 - spec/symbiont/generators_spec.rb
 - spec/symbiont/platform_object_spec.rb
 - spec/symbiont/symbiont_spec.rb