teber-library 0.1.3 → 1.0.0

data/sample/README.md

@@ -0,0 +1,263 @@
+# Teber-Ruby
+
+Teber-Ruby is a Page Object Model (POM) framework for selenium automation with ruby `Cucumber`. In order to make the testing faster used 'parallel_tests' gem to run multiple threads to run the tests at the same time. For reporting 'allure' is being adapted.
+
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
+[![Made with Ruby](https://img.shields.io/badge/Made%20with-Ruby-red.svg)](https://www.ruby-lang.org/en/)
+[![StackOverflow](http://img.shields.io/badge/Stack%20Overflow-Ask-blue.svg)]( https://stackoverflow.com/users/10505289/naresh-sekar )
+[![Contributions Welcome](https://img.shields.io/badge/Contributions-Welcome-brightgreen.svg)](CONTRIBUTING.md)
+[![email me](https://img.shields.io/badge/Contact-Email-green.svg)](nareshnavinash@gmail.com)
+
+
+![alt text](features/libraries/Teber_Ruby_Black.png)
+
+
+## Supports
+* Multiple browser automation
+* Multi browser automation
+* Allure reports
+* Jenkins Integration
+* Modes of run via CLI command
+* Headless run
+* Docker Execution
+* Failed Screenshots
+* Testdata driven tests
+* Multi Thread run
+
+## Setup
+* Clone this repository
+* Navigate to the cloned folder
+* Install bundler using `gem install bundler`
+* Install the dependencies by `bundle install`
+
+## To Run the tests
+For a simple run of all the feature files in normal mode, try
+```
+cucumber
+```
+To Run the tests in parallel mode for the available feature files, try
+
+```
+parallel_cucumber features/ 
+```
+To Run the tests in parallel mode for the available feature files along with tags, try
+```
+parallel_cucumber features/ -o "-t "@scenario_001""
+```
+To Run the tests in parallel mode for the available feature files along with tags and environment variables, try
+```
+parallel_cucumber features/ -o "-t "@scenario_001" MODE=headless"
+```
+This will run the tests in headless mode
+
+## To open allure results
+```
+allure serve reports/allure
+```
+
+## Multiple Browser
+Currently supports for Chrome browser, but handled in such a way that framework can be easily configured to support multiple browsers. I used webdriver manager to resolve the driver-browser compatibility issues, use the same to add your designated browser (firefox, edge, ie, safari etc.,).
+
+## Multi Browser
+Initiate the driver class inside support package mutiple times with different WebDriver objects. You can execute the actions in multiple browsers at the same time by executing actions against each driver object.
+
+## Reports
+For better illustration on the testcases, allure reports has been integrated. Allure reports can also be integrated with jenkins to get a dashboard view. Apart from allure, cucumber's default reporting such as html, pretty, progress, rerun files has been added to the `reports/` folder.
+
+## Jenkins Integration with Docker images
+Get any of the linux with ruby docker image as the slaves in jenkins and use the same for executing the UI automation with this framework (Sample docker image - `https://hub.docker.com/_/ruby`). From the jenkins bash Execute the following to get the testcases to run,
+```
+#!/bin/bash -l
+rvm list
+ls
+cd <path_to_the_project>
+bundle install
+cucumber #or custom commands
+```
+for complete guide to setup in linux check [Cloud Setup for Ruby](https://github.com/nareshnavinash/Cloud-Setup-Ruby)
+
+In Jenkins pipeline, try to add the following snippet to execute the tests,
+```
+pipeline {
+    agent { docker { image 'ruby' } }
+    stages {
+        stage('build') {
+            steps {
+                sh 'cd project/'
+                sh 'gem install bundler'
+                sh 'bundle install'
+                sh 'cucumber' # or custom methods
+            }
+        }
+    }
+}
+```
+
+## Headless Run
+In `global-data/global.yml` file, if the mode is `headless`, the chrome will be initialized in headless mode which can be used to run in server. Screenshots will be added even if the browser runs in headless mode.
+
+## Break down into end to end tests
+
+### Adding Locators to the project
+
+1. Add Locators to the that are going to be used inside the project inside the `Locators` module
+```
+module Locators
+	# Add a class for each page and add the locators
+end
+```
+2. For each page add a new class inside the `Locators` module.
+
+```
+module Locators
+  class TestPage
+
+    # All the Locators in the initialize block need to be declared here for read write permission.
+    attr_accessor :TEST_LOCATOR
+
+    def initialize
+      # Locators can be declared here by mentioning {how?(xpath,css,id) and what?(identifier)}
+      @TEST_LOCATOR = Locator.new(:id, "")
+    end
+
+    # Dynamic locators can be declared here as a seperate method (This method doesnot need to be declared with attr_accessor)
+    def TEST_DYNAMIC_LOCATOR(variable)
+      @TEST_DYNAMIC_LOCATOR = Locator.new(:xpath,"//*[text()=#{variable}]")
+    end
+
+  end
+end
+```
+
+3. Ideally each web page should have a new file inside locators folder (with the same name as the web page) and all the locators inside a web page has to be declared inside a page class(Class name also should be same as the web page name).
+* If the web page name is `home page` then the locator file name should be `home_page.rb` inside `locators` folder and the class name should be `HomePage` inside `Locators` module.
+
+### Adding page methods to the project
+
+1. Add page specific methods inside the `Pages` module.
+
+```
+module Pages
+  # add the page class here
+end
+```
+
+2. For each page add a new class inside `Pages` module and each page class should inherit the locators class of the same page
+
+```
+module Pages
+  class TestPage < Locators::TestPage
+
+    def initialize()
+      super()
+    end
+
+    def test_method(attribute_text)
+    	puts "#{attribute_text}"
+    end
+
+  end
+end
+```
+
+3. Ideally each web page should have a new page file inside `pages` folder with the class name same as the web page name.
+* If the web page name is `home page` then the pages file name should be `home_page.rb` inside `pages` folder and the class name should be `HomePage` inside `Pages` module.
+
+### Creating a new feature file in the project
+
+1. Define the tests in the feature file in gherkin language.
+
+```
+Feature: Sample project setup
+  To get to know the sample cucumber project
+
+  Scenario: This test will pass
+    Given true eql true
+    When false eql false
+    Then string eql string
+```
+
+2. Ideally tags has to be used for each feature and each scenario to identify the test cases in the unique way.
+
+```
+@before_feature @test_feature
+Feature: Sample project setup
+  To get to know about the basic flows in this framework
+
+  @before_scenario @test_id=001
+  Scenario: This test will pass
+    Given true eql true
+    When false eql false
+    Then string eql string
+```
+
+3. Now declare the feature steps inside the step definitions file, the name of the step definition file should be same as the feature file.
+
+4. In the step definitions file, initially declare the before and after action block.
+
+```
+Before do
+  puts "before each "
+end
+
+After do |s|
+   puts "after each "
+end
+```
+
+5. Cucumber allows us to use in an extensive way. So we can define `Before` and `After` for each specific tags that we defined in the feature file.
+
+```
+Before('@test_tag') do
+  puts "before each "
+end
+
+After('@test_tag') do |s|
+   puts "after each "
+end
+```
+
+6. Define the steps after the before/after block.
+
+```
+Given("true eql true") do
+  expect(true).to eql true
+end
+
+When("false eql false") do
+  expect(false).to eql false
+end
+
+Then("string eql string") do
+  expect("test").to eql "test"
+end
+```
+
+## Built With
+
+* [Cucumber](https://rubygems.org/gems/cucumber/versions/3.1.2) - Automation core framework
+* [Parallel_tests](https://rubygems.org/gems/parallel_tests) - To run automation parallely at the same time.
+* [Allure Cucumber](https://rubygems.org/gems/allure-cucumber/versions/0.6.1) - For Detailed reporting.
+* [Selenium](https://www.seleniumhq.org/) - For web browser automation.
+
+## Contributing
+
+1. Clone the repo!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Create a pull request.
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on code of conduct, and the process for submitting pull requests.
+
+## Authors
+
+* **[Naresh Sekar](https://github.com/nareshnavinash)**
+
+## License
+
+This project is licensed under the GNU GPL-3.0 License - see the [LICENSE](LICENSE) file for details
+
+## Acknowledgments
+
+* To all the open source contributors whose code has been referred in this project.

data/sample/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

data/sample/config/cucumber.yml

@@ -0,0 +1,2 @@
+default: --color --format AllureCucumber::Formatter --out reports/allure --format html --out reports/html/html_result.html --format ParallelTests::Cucumber::FailuresLogger --out reports/parallel_failures_log/cucumber_failures.log --format rerun --out reports/cucumber_rerun/rerun.txt --format progress --out reports/progress/progress.txt --format pretty --out reports/pretty/pretty.txt --format pretty
+parallel: --color --format AllureCucumber::Formatter --out reports/allure --format html --out reports/html/html_result<%= ENV['TEST_ENV_NUMBER']%>.html --format ParallelTests::Cucumber::FailuresLogger --out reports/parallel_failures_log/cucumber_failures<%= ENV['TEST_ENV_NUMBER']%>.log --format rerun --out reports/cucumber_rerun/rerun<%= ENV['TEST_ENV_NUMBER']%>.txt --format progress --out reports/progress/progress<%= ENV['TEST_ENV_NUMBER']%>.txt --format pretty --out reports/pretty/pretty<%= ENV['TEST_ENV_NUMBER']%>.txt --format pretty

data/sample/features/feature/googleSearch.feature

@@ -0,0 +1,27 @@
+@TC_Google_Search
+Feature: Search for a term in google search
+  Entering a term in google search and verifying result page is displayed
+
+  @scenario_001 @regression @sanity
+  Scenario: Single term serach
+    Given I navigate to google search page
+    When I type the term in google search bar and click on serach results
+    Then I should get the results page
+
+  @scenario_002
+  Scenario Outline: Multiple search items in google using scenario outline
+    Given I navigate to google search page
+    When I type the "<Term>" in google search bar and click on serach results
+    Then I should get the results page
+
+    @regression
+    Examples: 
+      | Term  |
+      | Hello |
+      | Hi    |
+      | Where |
+      
+    @sanity
+    Examples: 
+      | Term  |
+      | Hello |

data/sample/features/feature/googleSearchParallel.feature

@@ -0,0 +1,9 @@
+@TC_Google_Search
+Feature: Search for a term in google search
+  Entering a term in google search and verifying result page is displayed
+
+  @scenario_001 @regression @sanity
+  Scenario: Single term serach
+    Given I navigate to google search page
+    When I type the term in google search bar and click on serach results
+    Then I should get the results page

data/sample/features/global-data/global.yml

@@ -0,0 +1,4 @@
+browser: chrome
+implicit_wait: 10
+screenshot_location: reports/screenshots
+mode: UI

data/sample/features/libraries/categories.json

@@ -0,0 +1,31 @@
+[
+	{
+	"name": "Skipped tests",
+	"messageRegex": ".*",
+	"matchedStatuses": [ "skipped" ]
+	},
+	{
+	  "name": "Element not found",
+	  "traceRegex": ".*NoSuchElementError.*",
+	  "matchedStatuses": [ "failed" ]
+	},
+	{
+	  "name": "Broken tests",
+	  "traceRegex": "Error.*",
+	  "matchedStatuses": [ "failed"]
+	},
+	{
+	  "name": "Test Script defect",
+	  "messageRegex": ".*Expected is not a String or a RegExp.*",
+	  "matchedStatuses": ["failed"]
+	},
+	{
+	  "name": "Element not found Defect",
+	  "messageRegex": ".*no such element.*",
+	  "matchedStatuses": ["failed"]
+	},
+	{
+	  "name": "Passed tests",
+	  "matchedStatuses": ["passed"]
+	}
+]

data/sample/features/libraries/driver.rb

@@ -0,0 +1,212 @@
+# module Libraries
+
+#     class Driver
+#       attr_accessor :driver
+#       $focus_driver = nil
+#       @driver = nil
+#       @main_window = nil
+#       @click_exception_count = nil
+#       @@drivers = []
+#       @@drivers_with_names = {}
+  
+#       def initialize(driver_name = "Driver", browser = $conf["browser"])
+#         begin
+#           start(driver_name,browser)
+#           puts "#{driver_name} is initialized"
+#         rescue Exception => e
+#           puts "#{driver_name} is failed to initialize \n\n #{e.backtrace}\n\nRetrying to initialize #{driver_name}"
+#           start(driver_name,browser)
+#           puts "#{driver_name} is initialized after an exception"
+#         end
+#       end
+  
+#       ##############################
+#       # Custom methods of driver #
+#       ##############################
+  
+#       def start(driver_name, browser)
+
+#         case browser
+  
+#         when 'chrome'
+#           options = Selenium::WebDriver::Chrome::Options.new
+#           if ENV['MODE'] == "headless" or $conf["mode"] == "headless"
+#             switches = ["disable-infobars", "disable-gpu", "disable-dev-shm-usage", "no-sandbox", "headless"]
+#           else
+#             switches = ["disable-infobars", "disable-gpu", "disable-dev-shm-usage", "no-sandbox"]
+#           end
+#           switches.map { |k| options.add_argument(k) }
+#           @driver = Selenium::WebDriver.for(:chrome, options: options)
+#           @driver.manage.timeouts.implicit_wait = $conf["implicit_wait"]
+  
+#         when 'firefox', 'ff'
+#             # to be added
+
+#         when 'ie', 'internet_explorer'
+#             # to be added
+
+#         when 'edge'
+#             # to be added 
+
+#         when 'safari'
+#             # to be added
+  
+#         else
+#           raise ArgumentError, "Specify a proper browser while initiating a driver \n \n#{browser.inspect}"
+#         end
+  
+#         target_size = Selenium::WebDriver::Dimension.new(1200, 700)
+#         @driver.manage.window.size = target_size
+#         @click_exception_count=0
+#         @@drivers.push(self)
+#         @@drivers_with_names[self] = "#{driver_name}"
+#         $focus_driver = self
+#         puts "#{driver_name} - #{self}"
+#         return self
+#       end
+  
+#       def get(url)
+#         $focus_driver = self
+#         @driver.get(url)
+#         puts "#{$focus_driver} loaded with - #{url}"
+#       end
+  
+#       def refresh
+#         $focus_driver = self
+#         navigate.refresh
+#         puts "#{$focus_driver} is refreshed"
+#       end
+  
+#       def find_element(locator)
+#         $focus_driver = self
+#         Libraries::Wait.wait_for_element(locator)
+#         return @driver.find_element(locator.how,locator.what)
+#       end
+  
+#       def find_elements(locator)
+#         $focus_driver = self
+#         return @driver.find_elements(locator.how,locator.what)
+#       end
+  
+#       def mouse_over(locator,index=1)
+#         $focus_driver = self
+#         element=find_elements(locator)[index-1]
+#         @driver.action.move_to(element).perform
+#         puts "mouse over for the element - #{locator.how} => #{locator.what} is done"
+#       end
+      
+#       def mouse
+#         $focus_driver = self
+#         return @driver.mouse
+#       end
+  
+#       def action
+#         $focus_driver = self
+#         return @driver.action
+#       end
+  
+#       def move_and_click(locator)
+#         $focus_driver = self
+#         ele=find_element(locator)
+#         @driver.action.move_to(ele).click.perform
+#         puts "Mouse over the locator and then click for - #{locator.how} => #{locator.what} is done"
+#       end
+  
+#       def current_url
+#         $focus_driver = self
+#         @driver.current_url
+#       end
+  
+#       def save_screenshot(file_name = nil)
+#         $focus_driver = self
+#         file_name = "#{Pathname.pwd}/#{$conf['screenshot_location']}/#{Time.new.strftime("%Y-%m-%d-%H-%M-%S-%L-%N")}.png" if file_name.nil?
+#         puts "#{$focus_driver}'s Screenshot saved in this path => #{file_name}"
+#         @driver.save_screenshot(file_name)
+#       end
+  
+#       def switch_to_frame(locator)
+#         $focus_driver = self
+#         @main_window=@driver.window_handle
+#         @driver.switch_to.frame(find_element(locator))
+#         puts "Switched to iframe - #{locator.how} => #{locator.what} on #{$focus_driver}"
+#         return @main_window
+#       end
+  
+#       def switch_to_window(locator=nil)
+#         $focus_driver = self
+#         @main_window=@driver.window_handle
+#         locator.click if locator != nil
+#         windows=@driver.window_handles
+#         new_window=nil;
+#         windows.length.times do |i|
+#           if windows[i] != @main_window
+#             new_window=windows[i]
+#           end
+#         end
+#         @driver.switch_to.window(new_window)
+#         puts "Switched to new window on #{$focus_driver}"
+#         return @main_window
+#       end
+  
+#       def scroll_to_locator(locator)
+#         $focus_driver = self
+#         element = find_element(locator)
+#         @driver.execute_script("arguments[0].scrollIntoView({behavior: 'smooth', block: 'center', inline: 'nearest'});",element)
+#         puts "Scroll to this locator - #{locator.how} => #{locator.what} on #{$focus_driver}"
+#         sleep 1
+#       end
+  
+#       def revert_to(window=nil)
+#         $focus_driver = self
+#         if window != nil
+#           @driver.switch_to.window(window)
+#           puts "Switched back to another window - #{window} in #{$focus_driver}"
+#         else
+#           @driver.switch_to.window(@main_window)
+#           puts "Switched back to main window in #{focus_driver}"
+#         end
+#       end
+  
+#       def close
+#         $focus_driver = self
+#         @driver.close
+#         puts "Closed the browser - #{$focus_driver}"
+#       end
+  
+#       def quit
+#         @driver.quit
+#         @@drivers.delete(self)
+#         $focus_driver = @@drivers[0]
+#         puts "Quit the browser - #{$focus_driver}"
+#       end
+  
+#       def quit_all
+#         @@drivers.each do |driver|
+#           driver.quit if driver != self
+#         end
+#         self.quit
+#         puts "deleted all the browsers"
+#       end
+
+#       def self.quit_all_drivers
+#         @@drivers.each do |driver|
+#           driver.quit if driver != self
+#         end
+#         puts "deleted all the browsers"
+#       end
+  
+#       def self.get_all_drivers
+#         return @@drivers_with_names
+#       end
+
+#       def self.get_current_driver
+#         return $focus_driver
+#       end
+  
+#       def self.switch_to(driver)
+#         $focus_driver = driver
+#       end
+
+#     end
+#   end
+