robotest 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd392de1a562f67f155ce7619bc89a55298d1304e31b579acd27dac9f1566be9
+  data.tar.gz: cbad2a416a4827362da5a6922d2c00ffd1d63bbd46345877e4d9e29507ca5981
+SHA512:
+  metadata.gz: 64f9d1454edb569d0b796cddf4ad17ea1c58c290abee9e73ea4f4fe19b4861ccb10b861cb6f13d51da5dd7382db4f41f2a16812faffb23fc52a85f164dcf8b02
+  data.tar.gz: 8f5165f6531a6d5bb61d5b9e08fbb2d086f67d3629af7c0adfa3dace3c40bad1c248878d4da6db4d510e13b0292060d17ec5898ed3fa8728c7910e5be70e70f3

data/CONTRIBUTING.md

@@ -0,0 +1,93 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment 
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent.
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 
+   do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting me at [nareshnavinash@gmail.com]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project member has
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Full_Suite/Gemfile

@@ -0,0 +1,16 @@
+  source 'https://rubygems.org'
+
+  gem 'robotest'
+  gem 'selenium-webdriver'
+  gem 'rspec'
+  gem 'rspec-expectations'
+  gem 'rake'
+  gem 'headless'
+  gem 'pry'
+  gem 'require_all'
+  gem 'allure-rspec'
+  gem 'yaml_extend'
+  gem 'parallel_tests'
+  gem 'progress_bar'
+  gem 'coderay'
+  gem 'activesupport'

data/Full_Suite/README.md

@@ -0,0 +1,12 @@
+RoboTest is built over rspec, parallel_tests and allure.
+   1. Install Sublime, Atom, Code or Xcode based on your preference
+   2. Install homebrew from http://brew.sh/
+   3. Install ruby and rvm with `brew install ruby` and `curl -sSL https://get.rvm.io | bash -s stable --ruby`
+   4. Install chrome driver using `brew cask install chromedriver`
+   5. For sample project run `robotest example` and move to that directory in the command prompt
+   6. Now Make sure to rename the project name from `Full_Suite` to your `Custom Name`
+   7. Rename the file `rspec_parallel` in Full_Suite/ folder to `.rspec_parallel` to get the console logs while running the scripts !!!
+   8. To test a sample run with single process try running `robotest yaml/test.yml`
+   9. To test a sample run with multiple process try running `robotest yaml/test_parallel.yml`
+   10. You can specify the additional parameters as follows,\n> robotest yaml/test.yml -t sanity||true
+   Here test cases with sanity tag alone will run

data/Full_Suite/Rakefile

@@ -0,0 +1,9 @@
+require_relative "spec/spec_helper.rb"
+task :rake_job_test1, [] do |t, args|
+	begin
+		RakeJobs.new()
+	rescue Exception => e
+		puts e
+	end
+end
+

data/Full_Suite/conf/account_credentials.yml

@@ -0,0 +1,2 @@
+admin_email: freshdesk.1@gmail.com
+common_password: Freshdesk@123

data/Full_Suite/libraries/constants.rb

@@ -0,0 +1,25 @@
+class Constants
+
+    attr_accessor :BASE_URL
+    attr_accessor :BASE_URL_FOR_ACCOUNTS
+    attr_accessor :COMMON_EMAIL
+    attr_accessor :COMMON_PASSWORD
+    
+    def initialize
+        account_conf = ParseConfig.new("#{__dir__}/../test-data/credentials/test_credentials.conf")
+        conf_data = account_conf.params
+
+        @BASE_URL_FOR_ACCOUNTS = $conf["base_urls"]
+        @PARALLEL_TESTS = $conf["parallel_process"]
+        if $conf["base_urls"] != nil
+            if @PARALLEL_TESTS != nil
+                @BASE_URL = @BASE_URL_FOR_ACCOUNTS[0]
+            else
+                @BASE_URL = $conf["mode"] == 'parallel' ? @BASE_URL_FOR_ACCOUNTS[ENV[:TEST_ENV_NUMBER.to_s].to_i - 1] : @BASE_URL_FOR_ACCOUNTS[0]
+            end
+        end
+
+        @COMMON_EMAIL = conf_data["common_email"]
+        @COMMON_PASSWORD = conf_data["common_password"]
+    end
+end

data/Full_Suite/libraries/dsl.rb

@@ -0,0 +1,52 @@
+module AllureRSpec
+  module DSL
+    module Example
+
+      @@step_count = 0
+      @@current_example_location = nil
+
+      def step(step, *tags, &block)
+        __increment_step_count
+        metadata[:step_group] ||= {}
+        tags = tags[0].nil? ? {} : tags[0]
+        metadata[:step_group][@@step_count] = tags
+        metadata[:step_name] = step
+        test_case_name = metadata[:description]
+        
+        suite = __description(metadata[:example_group])
+        test = __description(metadata)
+        begin
+          AllureRubyAdaptorApi::Builder.start_step(suite, test, step)
+          __with_step step, &block
+          puts "#{suite} - #{test_case_name} - #{step} - Passed"
+          __set_step_status('passed')
+          AllureRubyAdaptorApi::Builder.stop_step(suite, test, step)
+        rescue Exception => e
+          __set_step_status('failed')
+          puts "#{suite} - #{test_case_name} - #{step} - Failed"
+          AllureRubyAdaptorApi::Builder.stop_step(suite, test, step, :failed)
+          raise e
+        end
+      end
+
+      private
+
+      def __increment_step_count
+        if @@current_example_location != metadata[:location]
+          __reset_step_count
+          @@current_example_location = metadata[:location]
+        else
+          @@step_count += 1
+        end
+      end
+
+      def __reset_step_count
+        @@step_count = 0
+      end
+
+      def __set_step_status(status)
+        metadata[:step_group][@@step_count][:status] = status
+      end
+    end
+  end
+end

data/Full_Suite/locators/testpage.rb

@@ -0,0 +1,27 @@
+module Locators
+  class TestPage
+
+    # All the Locators in the initialize block need to be declared here for read write permission.
+    attr_accessor :EMAIL_TEXTBOX
+    attr_accessor :PASSWORD_TEXTBOX
+    attr_accessor :LOGIN_LINK
+    attr_accessor :LOGIN_BUTTON
+    attr_accessor :SUBMIT_BUTTON
+
+    def initialize
+
+      # Locators can be declared here by mentioning {how?(xpath,css,id) and what?(identifier)}
+      @EMAIL_TEXTBOX = Locator.new(:id, "")
+      @PASSWORD_TEXTBOX = Locator.new(:xpath, "")
+      @LOGIN_LINK = Locator.new(:link, "Login")
+      @LOGIN_BUTTON = Locator.new(:css, "")
+      @SUBMIT_BUTTON = Locator.new(:css, "")
+    end
+
+    # Dynamic locators can be declared here as a seperate method (This method doesnot need to be declared with attr_accessor)
+    def LOGIN_DYNAMIC(variable)
+      @LOGIN_DYNAMIC = Locator.new(:xpath,"//*[text()=#{variable}]")
+    end
+
+  end
+end

data/Full_Suite/pages/testpage.rb

@@ -0,0 +1,31 @@
+module Pages
+  class TestPage < Locators::TestPage
+
+    def initialize(driver)
+      super()
+      @driver = driver
+    end
+
+    def login(email, password, base_url = nil)
+      $focus_driver = @driver
+
+      #To navigate to the given url,
+      # @driver.get(base_url) 
+
+      # Normal locators has to be used with the @
+      @LOGIN_LINK.is_present?
+
+      #Dynamic locators has to be declared without @
+      LOGIN_DYNAMIC("Login").is_present?
+
+      # Conditions can be used for a locator
+      if @EMAIL_TEXTBOX.is_present?
+        @EMAIL_TEXTBOX.clear_and_send_keys(email)
+        @PASSWORD_TEXTBOX.clear_and_send_keys(password)
+        @LOGIN_BUTTON.click
+      end
+      
+    end
+
+  end
+end

data/Full_Suite/rake-jobs/rake_jobs.rb

@@ -0,0 +1,9 @@
+class RakeJobs
+	def initialize()
+		
+	end
+
+	def setup
+		# to initialize via rake
+	end
+end

data/Full_Suite/rspec_parallel

@@ -0,0 +1,6 @@
+--color
+--format RspecJunitFormatter --out reports/junit/report_<%= ENV['TEST_ENV_NUMBER'] %>.xml
+--format html --out reports/html/report_<%= ENV['TEST_ENV_NUMBER'] %>.html
+--format json --out reports/json/report_<%= ENV['TEST_ENV_NUMBER'] %>.json
+--format Fuubar --out reports/fuubar/report_<%= ENV['TEST_ENV_NUMBER'] %>.txt
+--format progress

data/Full_Suite/spec/spec_helper.rb

@@ -0,0 +1,84 @@
+require 'robotest'
+require 'require_all'
+require 'allure-rspec'
+require 'pathname'
+require 'fileutils'
+require 'headless'
+require 'os'
+require "pry"
+require_rel "../locators/"
+require_rel "../libraries/"
+require_rel "../pages/"
+require "time"
+require "fileutils"
+require 'uri'
+require 'active_support/time'
+require 'parseconfig'
+include RoboTest
+
+$conf = File.exist?('_robotest.yml') ? YAML.load_file('_robotest.yml') : raise "yaml file needs to be given as a input parameter"
+FileUtils.mkdir_p("#{Pathname.pwd}/#{$conf['screenshot_location']}")
+$browser = $conf['browser']
+
+if OS.mac?
+    $conf["switches"].delete("headless") if $conf["switches"]
+end
+
+RSpec.configure do |config|
+    config.filter_run_when_matching :focus
+    config.example_status_persistence_file_path = "reports/examples.txt"
+    config.include AllureRSpec::Adaptor
+end
+
+AllureRSpec.configure do |config|
+    config.output_dir = "reports/allure"
+    config.clean_dir = true
+    config.logging_level = Logger::WARN
+end
+
+RSpec.configure do |c|
+  
+  # To take screen shots of all the drivers when there is a failure
+  c.after(:each) do |example|
+    unless example.exception.nil?
+        begin
+            drivers = Driver.get_all_drivers
+            drivers.each do |l,m|
+              example.attach_file(m,l.save_screenshot)
+            end
+        rescue Exception => e
+            puts example.message
+            puts example.backtrace
+        end
+    end
+    puts "Runs after each in spec helper"
+  end
+  
+  # To quit all the drivers after all the test cases are run.
+  c.after(:all) do |example|
+    Driver.quit_all_drivers
+    puts "Runs after all in spec helper"
+  end
+
+  # steps to be added which has to be run before all block (Common throughout the project)
+  c.before(:all) do |example|
+    puts "Runs before all in spec helper"
+  end
+  
+  # steps to be added which has to be run before each block (Common throughout the project)
+  c.before(:each) do |example|
+    puts "#{example.metadata[:example_group][:description]} - #{example.metadata[:description]} - Started"
+    puts "Runs before each in spec helper"
+  end
+
+  # Following is the order in which the before and after blocks are run
+      # Runs before all in spec helper
+      # Runs before all in spec
+      # Runs before each in spec helper
+      # Runs before each in spec
+      # Runs after each in spec
+      # Runs after each in spec helper
+      # Runs after all in spec
+      # Runs after all in spec helper
+end
+

data/Full_Suite/spec/test_spec.rb

@@ -0,0 +1,130 @@
+# to require all the related gems and functionalities to this spec we need to give this in every spec file.
+require 'spec_helper'
+
+# Give a unique name in describe so that allure report will be created seperately. 
+# Note: If two spec has same name, allure will override the results of first spec with the second spec which has same name.
+describe "Test Spec" do
+  
+  before(:all) do
+    # Initialize all the constants here.
+
+    # Initialize a driver with a name, so that when there is a bug screen shots will be saved with the name.
+    # Multiple drivers can be initialized (with different properties, check driver.rb file in the gem for details)
+    # We can initialize one chrome, one firefox, one explorer, one safari browser at a time.
+    @driver1 = Driver.new("Test_Driver_1")
+    @driver2 = Driver.new("Test_Driver_2")
+    @driver3 = Driver.new("Test_Driver_3")
+    @driver4 = Driver.new("Test_Driver_4")
+
+    # To load the constants file from Constants class.
+    @constants = Constants.new
+
+    # Initialize the page class with the driver.
+    # Each instance method will be corresponding to the driver with which it is declared.
+    # New pages can be added and used in the same way
+    @driver1_login_page = Pages::TestPage.new(@driver1)
+    @driver2_login_page = Pages::TestPage.new(@driver2)
+    @driver3_login_page = Pages::TestPage.new(@driver3)
+    @driver4_login_page = Pages::TestPage.new(@driver4)
+
+  end
+
+  before(:each) do
+    # any specfic steps that needs to be done before each testcase can be done here
+    # Example : Moving to the home page after all the test case will be an idle one.
+  end
+
+  after(:all) do
+    # Steps that is to be run after all the test cases are done can be given here.
+    # Usual steps will be quiting all the drivers, but that is handled in the spec_helper.rb so any other specific steps other than quit can be given here.
+  end
+
+  after(:each) do |e|
+    # any specfic steps that needs to be done after each testcase can be done here
+    # Usually taking screen shots after each test case when there is a failure is done here, but that is covered in spec_helper.rb
+    # Any other steps than taking screenshot can be given here.
+  end
+
+
+  # Each test case can be declared with `it` 
+  # after the test case name is defined we can define the tags for that test case
+  # These tags can be used to run only critical test cases, only sanity test cases or we can use the testId for any custom reporting.
+  it 'this test will pass',:severity => "critical", :sanity => true, :testId => '001' do |e|
+    # for more help on rspec expect statements you can visit the following website
+    # https://relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    
+    # e.step is used by allure for reporting purpose. It is best to have all the lines inside any one of the e.step so that we can have a detailed reporting
+    e.step "true eql true" do
+      expect(true).to eq true
+    end
+    e.step "false eql false" do
+      expect(false).to eq false
+    end
+    e.step "string eql string" do
+      expect("test").to eq "test"
+    end
+    e.step "number eql number" do
+      expect(1).to eq 1
+    end
+  end
+
+  it "this test will fail", :severity => "critical", :testId => '002' do |e|
+    e.step "true eql true" do
+      expect(true).to eq true
+    end
+    e.step "false eql false" do
+      expect(false).to eq false
+    end
+    # Test case will fail in the below step
+    e.step "true eql false" do
+      expect(true).to eq false
+    end
+    # Since the above step is failed, following steps will not be executed.
+    e.step "true eql true" do
+      expect(true).to eq true
+    end
+    e.step "false eql false" do
+      expect(false).to eq false
+    end
+  end
+
+  it "this test will fail", :severity => "critical", :testId => '003' do |e|
+    e.step "true eql true" do
+      expect(true).to eq true
+    end
+    e.step "false eql false" do
+      expect(false).to eq false
+    end
+    # Test case will fail in the below step
+    # cstep is the custom method in which if a step fails it wont stop the test case
+    # this cstep can be used to validate data in a page, if we need to test and report 10 variables in a page, then we can use this so that all the validation point steps even if one step is failed
+    e.cstep "1 equal 2" do
+      expect(1).to eq 2
+    end
+    # even if the  the above step is failed, following steps will be executed.
+    e.step "true eql true" do
+      expect(true).to eq true
+    end
+    e.step "false eql false" do
+      expect(false).to eq false
+    end
+  end
+
+  it 'Calling a function in a `Page` and `Object` from the spec file',:severity => "critical", :testId => '004' do |e|
+    # we can call a funtion in the pages in the following ways
+    e.step "Login to the application" do
+      @driver1_login_page.login(@constants.COMMON_EMAIL, @constants.COMMON_PASSWORD, @constants.BASE_URL)
+      Pages::TestPage.new(@driver2).login(@constants.COMMON_EMAIL, @constants.COMMON_PASSWORD, @constants.BASE_URL)
+    end
+    
+    # we can call a locator with the page instance itself as follows,
+    e.step "Is login link is present" do
+      expect(@driver1_login_page.LOGIN_LINK.is_present?).to eql false
+      expect(@driver1_login_page.LOGIN_DYNAMIC("Login").is_present?).to eql false
+    end
+
+  end
+
+
+  
+end