legoTech_gem 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8dcdf8b4ace38d60ede6edb10f3b3022e5b7891b4cea351a305764a55b66562
-  data.tar.gz: e78be33f3e91b37cb8b88c25c2150d50fe68f1a821fe58fa7e7bfa02367ec5a6
+  metadata.gz: 3473c8222c2746357db699716897be3e93e2e2e09b281d38f23b77225d61a47f
+  data.tar.gz: 92154882a866343da76af76f0ed66954fcb69f6e9fbe341588d3db7df149e5b5
 SHA512:
-  metadata.gz: 861a511b1372060f3fd766b02584c8b99968ae740bbdad1044f5e7f4d653d3cf2f0567b8bb6fe0570c5db91fcf6524b94fddcf24d6dab78bdea0e4b679c695e0
-  data.tar.gz: 02ff6ea3d4c1356f2961b7fdc8b4677425c872d30bf87c60ab81028ced7e306817f2e8f22f6db0953e6162e992dc8ea45f45bc0a846adcd83b95a9cf5c822dbc
+  metadata.gz: da884052353e8b4c88dbe4c19a7c8eb773f3f21ad3d65e1519127969c7d28fc2a397a43c16fd8bfe6acb48a8ab7ddfc2254f3d1d9a68fd2fe6a5a70d9f8c8b21
+  data.tar.gz: e7f784b4c166047e170d8d1b476a5ececcc337a7d30594ffc48124d669cb1057cfa6e99848ce5988cff0aeb695323e3afac8dcfb97787537cacd354051edeae9

data/README.md

@@ -1,11 +1,78 @@
 # Ruby-Selenium
-A Ruby gem to help developers write test cases for the UI
 
-Please respect the naming definition as taken from here: https://github.com/airbnb/ruby#naming
-Comments and tags must respect the naming from: https://rubydoc.info/gems/yard/file/docs/Tags.md
-Ruby Types are defined here: https://www.geeksforgeeks.org/ruby-data-types/
+![](https://github.com/pat-lego/LegoTechGem/workflows/Test%20Feature/badge.svg)
 
-**Note**: https://stackoverflow.com/questions/28506769/failed-to-require-a-local-gem/28507368#28507368
+A Ruby gem to help developers write test cases for a UI.
+
+Create Action
+```
+def get_check_box_action(driver)
+  # Create your action
+  RadioButtonAction.new(driver)
+end
+
+def get_radio_button_action(driver)
+  # Create your action
+  CheckBoxAction.new(driver)
+end
+
+def get_input_action(driver)
+  # Create your action
+  InputAction.new(driver)
+end
+
+def get_select_action(driver)
+  # Create your action
+  SelectAction.new(driver)
+end
+
+def get_button_action(driver)
+  # Create your action
+  ButtonAction.new(driver)
+end
+```
+
+Create Test Case
+```
+def get_test_case(driver)
+  LegoTechSelenium::TestCase::Builder.new("My first test case", driver)
+    .add_action(get_input_action(driver))
+    .add_action(get_select_action(driver))
+    .add_action(get_button_action(driver))
+    .add_action(get_check_box_action(driver))
+    .add_action(get_radio_button_action(driver))
+    .build
+end
+```
+
+Create a Test Suite
+```
+def get_test_suite(driver)
+  LegoTechSelenium::TestSuite::Builder.new("My first test suite", driver)
+    .add_test_case(get_test_case(driver))
+    .build
+end
+```
+
+**And Off you go!**
+
+```
+testSuite = get_test_suite(driver)
+testSuite.run
+```
+
+## Now supports Action validation
+
+You can now validate that the field that you clicked has valid data within it by simply setting the `:validate => true` flag within your Action.
+
+If you don't want to then just don't set it.
+
+# How to install Chrome Driver on Mac OSX
+
+In order to control Chrome you will need to install the Chrome Driver please follow these steps.
+https://www.swtestacademy.com/install-chrome-driver-on-mac/
+
+Note once the driver is installed run it manually once in order to allow the system to trust it. If you do not do thisd then the system will not trust it and then it will not open
 
 # How to install dependencies
 
@@ -18,10 +85,71 @@ Ruby Types are defined here: https://www.geeksforgeeks.org/ruby-data-types/
 
 1. Make sure Ruby is installed `ruby -v` should return the current version of the language on your computer
 2. Install bundler using `gem install bundler` to allow you to build the project
-3. Building is as simple as `gem build ruby-selenium.gemspec` 
+3. Building is as simple as `gem build legoTech.gemspec` 
 
 # How to publish
 
 1. Make sure Ruby is installed `ruby -v` should return the current version of the language on your computer
 2. Make sure you have a built gem
-3. Using the gem command run the following `gem push [YOUR_GEM_NAME].gem`
+3. Using the gem command run the following `gem push [YOUR_GEM_NAME].gem`
+
+# How to include within project
+
+**Using Bundler**
+
+1. Install bundler
+2. Create a Gemfile
+3. Locate all the gem [here](https://rubygems.org/gems/legoTech_gem)
+4. Include the version that you wish to use within the Gemfile 
+5. Add `selenium-webdriver` as a dependency to the Gemfile
+6. Run `bundle install`
+7. Create a ruby file called `example.rb`
+8. At the top write `require "legoTech_gem"`
+9. Run the following command `bundle exec ruby example.rb`
+
+**Using pure Gem**
+
+1. Make sure Ruby is installed 
+2. Run `gem install legoTech_gem`
+3. Create a ruby file
+4. At the top write `require "legoTech_gem"`
+5. Run the file and all your dependencies should be there
+
+# Run the Example
+
+You can run the example script which would provide you  with a nice and simple example of how the script works.
+
+1. Install Selenium
+2. Install Chrome Driver (shown above)
+3. Install Ruby
+4. Within the `e2e` folder run `ruby main.rb`
+
+Before Result:
+
+![Page Before Selenium](https://i.imgur.com/vwGZ92G.png)
+
+After Result:
+ 
+![Page After Selenium](https://i.imgur.com/A8QF5kk.png)
+
+# Author
+
+[Patrique Legault](mailto:patrique.legault@gmail.com)
+
+**Profile Links**
+
+[Github](https://github.com/pat-lego)
+
+[LinkedIn](https://www.linkedin.com/in/patrique-legault/)
+
+[Twitter](https://twitter.com/_patlego)
+
+# Notes
+
+Please respect the naming definition as taken from here: https://github.com/airbnb/ruby#naming
+
+Comments and tags must respect the naming from: https://rubydoc.info/gems/yard/file/docs/Tags.md
+
+Ruby Types are defined here: https://www.geeksforgeeks.org/ruby-data-types/
+
+**Note**: https://stackoverflow.com/questions/28506769/failed-to-require-a-local-gem/28507368#28507368

data/legoTech.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "legoTech_gem"
-  spec.version = "0.0.4"
+  spec.version = "0.0.5"
   spec.authors = ["Patrique Legault"]
   spec.email = ["patrique.legault@gmail.com"]
   spec.summary = %q{A Ruby library used to test forms using browser automation}

data/lib/legoTech_gem.rb

@@ -11,5 +11,4 @@ require_relative "ui/test-suites/TestSuite"
 
 require_relative "ui/enums/Field"
 require_relative "ui/enums/Identifier"
-
 # End Module => LegoTechSelenium

data/lib/ui/actions/Action.rb

@@ -1,20 +1,93 @@
 # @author Patrique Legault
+
+require_relative "../enums/FieldType"
+require_relative "../validate/ValidateElement"
+
 module LegoTechSelenium
-  class Actions
+  class Action
 
-    # A function that performs the given action against the webpage given the driver and the action
-    #
-    # @param driver [Driver] The driver object that represents the instance that is connected to the browser
+    # The constructor of the Action class
+    # @param driver [LegoTechSelenium::Driver] The driver object that represents the instance that is connected to the browser
     # @param action [Hash] A ruby object that has the following layout
     #   {
-    #        :field => Fields::...
+    #        :fieldtype => Fields::...
     #        :identifier => Identifier::...
     #        :value => String
+    #        :validate => True -> Verify the value before continuing to the next action. False -> skip validation.
     #   }
-    # @return void
-    # @raise Selenium Exceptions
-    def test(driver, action)
-      raise "Test function in the Actions.rb file has not been overriden"
+    def initialize(action, driver)
+      @driver = driver
+      @action = action
+      @wait = @driver.get_wait
+      @selenium_driver = @driver.get_selenium_driver
+
+      if @driver.nil?
+        raise "Cannot have a nil driver within the Action class"
+      end
+
+      if @action.nil? or @action.empty?
+        raise "Cannot have a nil or empty action hash within the Action class"
+      end
+    end
+
+    # A function that performs the given action against the webpage given the driver and the action
+    # @raise [RuntimeError] FieldType is not supported
+    def test()
+      element = @wait.until { @selenium_driver.find_element(@action[:identifier], @action[:fieldname]) }
+
+      case @action[:fieldtype]
+      when LegoTechSelenium::FieldType::INPUT
+        executeInput(element)
+      when LegoTechSelenium::FieldType::DROPDOWN_LIST
+        executeSelect(element)
+      when LegoTechSelenium::FieldType::BUTTON
+        executeButton(element)
+      when LegoTechSelenium::FieldType::CHECK_BOX
+        executeCheckBox(element)
+      when LegoTechSelenium::FieldType::RADIO_BUTTON
+        executeRadioButton(element)
+      else
+        raise "Could not locate the field type to perform the action on, received the following field #{@action[:fieldtype].downcase}. Currently only supports the fields within FieldType.rb"
+      end
+
+      if @action[:validate] == true
+        unless LegoTechSelenium::ValidateElement.new(@action, element).validate
+          raise "Failed to validate the #{@action[:fieldname]} is set to \"#{@action[:value]}\""
+        end
+      else
+        puts "Skipping assertion for #{self.class.name}"
+      end
+    end
+
+    # Perform the input exection on the element
+    # @param element [Selenium::WebDriver::Element]
+    def executeInput(element)
+      element.send_keys(@action[:value])
+    end
+
+    # Perform the input exection on the element
+    # @param element [Selenium::WebDriver::Element]
+    def executeSelect(element)
+      dropdown = Selenium::WebDriver::Support::Select.new(element)
+      dropdown.select_by(:text, @action[:value])
+    end
+
+    # Perform the input exection on the element
+    # @param element [Selenium::WebDriver::Element]
+    def executeButton(element)
+      element.click
+    end
+
+    # Perform the check box exection on the element
+    # @param element [Selenium::WebDriver::Element]
+    def executeCheckBox(element)
+      element.click
+    end
+
+    # Perform the radio button exection on the element
+    # @param element [Selenium::WebDriver::Element]
+    def executeRadioButton(element)
+      element.click
     end
   end
 end

data/lib/ui/driver/Driver.rb

@@ -2,33 +2,54 @@ require "selenium-webdriver"
 
 # @author Patrique Legault
 module LegoTechSelenium
-  class LegoTechSelenium::Driver
-    @driver
-
+  class Driver
     # Pass in an instance of the driver
     # @param The driver from Selenium Webdriver class
     def initialize(driver)
       @driver = driver
+      @wait = Selenium::WebDriver::Wait.new(:timeout => 15)
     end
 
     # Set the amount of time the driver should wait when searching for elements.
     # @param implicit_wait seconds for implicit wait
     def set_implicit_wait(implicit_wait)
+      @driver.manage.timeouts.implicit_wait = implicit_wait
     end
 
     # Sets the amount of time to wait for a page load to complete before throwing an error.
     # @param page_load seconds to wait for page to load
     def set_page_load(page_load)
+      @driver.manage.timeouts.page_load = page_load
     end
 
     # Sets the amount of time to wait for an asynchronous script to finish execution before throwing an error.
     # @param script_time seconds to wait for script to complete
-    def set_script_tiemout(script_tiemout)
+    def set_script_timeout(script_timeout)
+      @driver.manage.timeouts.script_timeout = script_timeout
     end
 
     # The URL to navigate to
     # @param navigate_to location for the browser to navigate to
     def set_navigate_to(navigate_to)
+      @driver.navigate.to(navigate_to)
+    end
+
+    # Function used to override the overall wait in order to find an element within the DOM
+    # @param wait_time [Number] represents how long to wait until an error is thrown
+    def set_element_find_wait(wait_time)
+      @wait = Selenium::WebDriver::Wait.new(:timeout => wait_time)
+    end
+
+    # Function used to get the wait object
+    # @return [Selenium::WebDriver::Wait] Wait object that does a wait for the object to appear in the DOM
+    def get_wait
+      @wait
+    end
+
+    # Function used to get the Selenium WebDriver
+    # @return [Selenium::WebDriver] Selenium webdriver
+    def get_selenium_driver
+      @driver
     end
   end
 end

data/lib/ui/enums/FieldType.rb

@@ -0,0 +1,10 @@
+# @author Patrique Legault
+module LegoTechSelenium
+  module FieldType
+    RADIO_BUTTON = "radio_button"
+    CHECK_BOX = "check_box"
+    INPUT = "input"
+    DROPDOWN_LIST = "dropdown_list"
+    BUTTON = "button"
+  end
+end

data/lib/ui/enums/Identifier.rb

@@ -1,8 +1,8 @@
 # @author Patrique Legault
 module LegoTechSelenium
   module Identifier
-    CSS = 1
-    NAME = 2
-    ID = 3
+    CSS = :css
+    NAME = :name
+    ID = :id
   end
 end

data/lib/ui/test-cases/TestCase.rb

@@ -1,12 +1,74 @@
+require_relative "../actions/Action"
+
 # @author Patrique Legault
 module LegoTechSelenium
   class TestCase
-    def initialize(name)
+    def initialize(name, driver)
       if name.nil? or name.empty?
         raise "All TestCasses must have a name associated to them"
       end
 
+      if driver.nil?
+        raise "The driver is nil in the TestCase"
+      end
       @name = name
+      @driver = driver
+
+      @actions = []
+    end
+
+    # Function used to add an action to the list of actions to later be invoked
+    # @param action [Action] an object that represents a list of events to invoke
+    # @return nil
+    def add_action(action)
+      if action.nil?
+        raise "Cannot pass a nil action to TestCase"
+      end
+
+      unless action.class.superclass.name.eql? ("LegoTechSelenium::Action")
+        raise "action is not an instance of LegoTechSelenium::Action within TestCase"
+      end
+      @actions.push(action)
+      return nil
+    end
+
+    # Function used to get the name of the Test Case instance
+    # @return [String] Name of the Test Case Instance
+    def get_name()
+      @name
+    end
+
+    # Function get the number of actions within the TestCase
+    # [Number] The number of actions within the TestCase
+    def get_number_of_actions()
+      @actions.size
+    end
+
+    # Function used to invoke all of the actions within the list
+    def run()
+      @actions.each do |action|
+        action.test()
+      end
+    end
+
+    class Builder
+      def initialize(name, driver)
+        @testCase = TestCase.new(name, driver)
+      end
+
+      # Function used to add an action using a Builder class
+      # @param action [Action] The action to add to the list of actions
+      # @return [Builder] the Builder class
+      def add_action(action)
+        @testCase.add_action(action)
+        self
+      end
+
+      # A function the return the built TestCase
+      # @return [TestCase] The built TestCase
+      def build
+        @testCase
+      end
     end
   end
 end

data/lib/ui/test-suites/TestSuite.rb

@@ -1,3 +1,5 @@
+require_relative "../test-cases/TestCase"
+
 # @author Patrique Legault
 module LegoTechSelenium
   class TestSuite
@@ -13,30 +15,39 @@ module LegoTechSelenium
       end
       @name = name
       @driver = driver
-      @entries = []
+      @testCases = []
     end
 
     # Function used to add a TestCase to thee TestSuite
     # @param testCase [TestCase] A test case to be executed
-    def addTestCase(testCase)
-      @entries.push(testCase)
+    def add_test_case(testCase)
+      if testCase.nil?
+        raise "Cannot have nil testCase within TestSuite"
+      end
+
+      unless testCase.instance_of? LegoTechSelenium::TestCase
+        raise "testCase is not an instance of TestCase within the TestSuite"
+      end
+      @testCases.push(testCase)
     end
 
     # Retrieve the name of the TestSuite
     # @return [String] The name of the TestSuite
-    def getName()
+    def get_name()
       return @name
     end
 
     # Retrieve the number of TestCases within the TestSuite
     # @return [Number] Number of TestCases
-    def getNumberOfTestCases
-      return @entries.size
+    def get_number_of_test_cases
+      return @testCases.size
     end
 
     # Function that will invoke all test cases
     def run()
-      raise "Not yet built"
+      @testCases.each do |testCase|
+        testCase.run()
+      end
     end
 
     class Builder
@@ -50,8 +61,8 @@ module LegoTechSelenium
       # Add a test case to the test suite
       # @param TestsCase [TestCase] to be added to the list
       # @return self
-      def addTestCase(testCase)
-        @testSuites.addTestCase(testCase)
+      def add_test_case(testCase)
+        @testSuites.add_test_case(testCase)
         self
       end
 

data/lib/ui/validate/ValidateElement.rb

@@ -0,0 +1,86 @@
+require_relative "../enums/FieldType"
+
+module LegoTechSelenium
+  class ValidateElement
+
+    # The constructor of the Action class
+    # @param element [Selenium::WebDriver::Element]
+    # @param action [Hash] A ruby object that has the following layout
+    #   {
+    #        :fieldtype => Fields::...
+    #        :identifier => Identifier::...
+    #        :value => String
+    #        :validate => True -> Verify the value before continuing to the next action, skip validation
+    #   }
+    def initialize(action, element)
+      if action.nil? or action.empty?
+        raise "Cannot submit a nil or empty action within the Validate class"
+      end
+
+      if element.nil?
+        raise "Cannot submit a nil Selenium element within the Validate class"
+      end
+
+      # Set instance variables
+      @action = action
+      @element = element
+    end
+
+    # Function used to validate the element is correctly set
+    # @return True if correctly validated, False if incorrectly validated
+    # @raise [RuntimeError] FieldType is not supported
+    def validate()
+      case @action[:fieldtype]
+      when LegoTechSelenium::FieldType::INPUT
+        return validateInput
+      when LegoTechSelenium::FieldType::DROPDOWN_LIST
+        return validateSelect
+      when LegoTechSelenium::FieldType::BUTTON
+        # Cannot validate the value of a button
+        return true
+      when LegoTechSelenium::FieldType::CHECK_BOX
+        return validateCheckBox
+      when LegoTechSelenium::FieldType::RADIO_BUTTON
+        return validateRadioButton
+      else
+        raise "Cannot validate this field type please refer to the validate function within the Validate class for further details"
+      end
+    end
+
+    # Validates the value of an input field
+    # return True -> action value is equal to the input field value
+    def validateCheckBox()
+      puts "Asserting that #{LegoTechSelenium::FieldType::INPUT} with field name #{@action[:fieldname]} is set to \"#{@action[:value]}\""
+      unless @action[:value].nil?
+        return @action[:value].eql? @element.attribute("value")
+      else
+        return @action[:fieldname].eql? @element.attribute("value")
+      end
+    end
+
+    # Validates the value of an input field
+    # return True -> action value is equal to the input field value
+    def validateRadioButton()
+      puts "Asserting that #{LegoTechSelenium::FieldType::INPUT} with field name #{@action[:fieldname]} is set to \"#{@action[:value]}\""
+      unless @action[:value].nil?
+        return @action[:value].eql? @element.attribute("value")
+      else
+        return @action[:fieldname].eql? @element.attribute("value")
+      end
+    end
+
+    # Validates the value of an input field
+    # return True -> action value is equal to the input field value
+    def validateInput()
+      puts "Asserting that #{LegoTechSelenium::FieldType::INPUT} with field name #{@action[:fieldname]} is set to \"#{@action[:value]}\""
+      return @action[:value].eql? @element.attribute("value")
+    end
+
+    # Validates the value of an input field
+    # return True -> action value is equal to the input field value
+    def validateSelect()
+      puts "Asserting that #{LegoTechSelenium::FieldType::DROPDOWN_LIST} with field name #{@action[:fieldname]} is set to \"#{@action[:value]}\""
+      return @action[:value].eql? Selenium::WebDriver::Support::Select.new(@element).first_selected_option.text
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: legoTech_gem
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Patrique Legault
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-16 00:00:00.000000000 Z
+date: 2020-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,10 +52,11 @@ files:
 - lib/legoTech_gem.rb
 - lib/ui/actions/Action.rb
 - lib/ui/driver/Driver.rb
-- lib/ui/enums/Field.rb
+- lib/ui/enums/FieldType.rb
 - lib/ui/enums/Identifier.rb
 - lib/ui/test-cases/TestCase.rb
 - lib/ui/test-suites/TestSuite.rb
+- lib/ui/validate/ValidateElement.rb
 homepage: https://www.pat-lego.io
 licenses:
 - MIT

data/lib/ui/enums/Field.rb

@@ -1,9 +0,0 @@
-# @author Patrique Legault
-module LegoTechSelenium
-  module Fields
-    RADIO_BUTTON = 1
-    CHECK_BOX = 2
-    INPUT = 3
-    DROPDOWN_LIST = 4
-  end
-end