robotest 1.0.2

data/README.md

@@ -0,0 +1,207 @@
+# RoboTest
+
+Robotest is a Page Object Model (POM) framework for selenium automation with ruby 'rspec'. In order to make the testing faster, robotest included the 'parallel_tests' gem to make multiple process testing 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/)
+[![Gitter](https://img.shields.io/badge/Gitter-Chat-green.svg)](https://gitter.im/POM-selenium-framework/POM-Selenium-rspec-framework)
+[![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](lib/robotest/RoboTest.png)
+
+## Getting Started
+
+For faster onboarding sample project has been added to this gem. Just try
+
+```
+robotest example
+```
+to get a sample project loaded in to your current directry.
+
+Note: This will work for linux and mac machines. For windows machines try to copy paste the sample project folder `Full_Suite` from the installation directory.
+
+
+### Prerequisites
+
+* Install Sublime, Atom, Code or Xcode based on your preference
+* Install homebrew from http://brew.sh/
+* Install ruby and rvm with `brew install ruby` and `curl -sSL https://get.rvm.io | bash -s stable --ruby`
+* Install chrome driver using `brew cask install chromedriver`
+
+ Note: The above all is for linux and mac machines. For windows machines the installation may vary.
+
+
+### Installing
+
+Install using `gem install` command
+
+```
+gem install robotest
+```
+
+or
+
+1. Clone this project to your local.
+2. Inside the cloned project directory do `bash build.sh`
+
+
+## Running the tests
+
+At first you need to describe your tests in the spec folder with .rb extention. Then need to add your spec file directory in the yaml file as given in the example file. Now run the tests with the following command
+
+```
+robotest <Directory to your yaml file>
+```
+In the example project you can try
+```
+robotest yaml/test.yml
+```
+in the directory where the example project is placed.
+
+To run the tests in parallel mode using `parallel_tests` try running
+```
+robotest yaml/test_parallel.yml
+```
+in the directory where the example project is placed.
+
+
+### 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(driver)
+      super()
+      @driver = driver
+    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 spec file in the project**
+
+1. Require the spec_helper file.
+```
+require 'spec_helper'
+```
+2. Describe the test case with a unique name.
+```
+describe "Testing" do
+
+end
+```
+3. Declare the before all, before each, after all, after each if needed inside the describe. *check out the spec_helper file to have a global before and after blocks*
+```
+  before(:all) do
+    # Initialize all the constants here.
+	# Code which has to be run before starting all the test cases are placed here.
+  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
+ ```
+4. Now declare your tests after the before and after block within the descibe block.
+```
+  it 'Test 1',:tag_string => "tag_name", :tag_boolean => true, :tag_number => '001' do |e|
+	#use e.step to have the reporting in the allure.
+	e.step "test reporting 1" do
+		expect(true).to eql true
+	end
+	# Best practice is to have more e.step and have all the code inside any of the e.step so that any failure happend in the test case will be reported with screenshots.
+  end
+```
+*For more check the sample files after doing `robotest example`*
+
+
+## Built With
+
+* [Rspec](https://rubygems.org/gems/rspec/versions/3.4.0) - Automation core framework
+* [Parallel_tests](https://rubygems.org/gems/parallel_tests) - To run automation parallely at the same time.
+* [Allure Rspec](https://rubygems.org/gems/allure-rspec) - For Detailed reporting.
+* [Selenium](https://www.seleniumhq.org/) - For web browser automation.
+
+## Contributing
+
+1. Fork it!
+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. Submit a pull request :D
+
+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 used in this project.

data/Rakefile

@@ -0,0 +1 @@
+import "./lib/tasks/robotest.rake"

data/bin/robotest

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'robotest'
+
+RoboTest::CLI.new.invoke(ARGV)

data/lib/robotest.rb

@@ -0,0 +1,258 @@
+require 'selenium-webdriver'
+require 'yaml'
+require 'yaml_extend'
+require 'rspec/core'
+require 'parallel_tests'
+require 'optparse'
+require 'pry'
+require 'progress_bar'
+require 'readline'
+require_relative "./robotest/driver.rb"
+require_relative "./robotest/locator.rb"
+require_relative "./robotest/version.rb"
+require_relative "./robotest/wait.rb"
+require_relative "./robotest/dsl.rb"
+require_relative "./robotest/multilocator.rb"
+
+module RoboTest
+
+  class CLI
+    
+    $conf
+    def invoke(argv)
+      `gem cleanup`
+      logo
+      welcome_message
+      if argv.empty?
+        help_text
+        puts "Add a path to an yaml file to start running your suite\n"
+        puts "Enter a path to your yaml file:\n"
+        argv = STDIN.gets
+        if !argv.include? ".yml"
+          puts "Need to enter the path for a configured yml file !!!"
+          exit_message
+          exit!
+        end
+      end
+      at_exit {
+        delete_temp_files
+      }
+      example if argv.include?('example')
+      options, rspec_args = parse_options(argv)
+      $conf = load_config_file(argv[0], options)
+      modified_argv = setup_args(argv, $conf, rspec_args)
+      yaml_dump('_robotest.yml', $conf)
+      run(modified_argv)
+    end
+
+    private
+
+    def opt_parser_banner
+      puts "RoboTest is built over rspec, parallel_tests and allure.\n\n"
+      help_text
+      puts "1. Install Sublime, Atom, Code or Xcode based on your preference\n"
+      puts "2. Install homebrew from http://brew.sh/\n"
+      puts "3. Install ruby and rvm with `brew install ruby` and `curl -sSL https://get.rvm.io | bash -s stable --ruby`\n"
+      puts "4. Install chrome driver using `brew cask install chromedriver`\n"
+      puts "5. For sample project run `robotest example` and move to that directory in the command prompt\n"
+      puts "6. Now Make sure to rename the project name from `Full_Suite` to your `Custom Name`\n"
+      puts "7. Rename the file `rspec_parallel` in Full_Suite/ folder to `.rspec_parallel` to get the console logs while running the scripts !!!\n"
+      puts "8. To test a sample run with single process try running `robotest yaml/test.yml`\n"
+      puts "9. To test a sample run with multiple process try running `robotest yaml/test_parallel.yml`\n"
+      puts "10. You can specify the additional parameters as follows,\n> robotest yaml/test.yml -t sanity||true\n"
+      puts "Here test cases with sanity tag alone will run \n\n
+        Other additional parameters are:"
+    end
+
+    def exit_message
+      puts "\nExiting ...!!!"  
+    end
+
+    def logo
+      puts "
+           _______________________________________________________________________________________________
+            RRRRRRRRR   OOOOOOOOOO  BBBBBBBBB   OOOOOOOOOO  TTTTTTTTTTT  EEEEEEEEE  SSSSSSSS  TTTTTTTTTTT
+            R        r  O        O  B        b  O        O       T       E          S              T     
+            R        R  O        O  B        B  O        O       T       E          S              T     
+            R        r  O        O  B        b  O        O       T       E          S              T     
+            RRRRRRRRR   O        O  BBBBBBBBB   O        O       T       EEEEEEEEE  SSSSSSSS       T     
+            R     R     O        O  B        b  O        O       T       E                 S       T     
+            R      R    O        O  B        B  O        O       T       E                 S       T     
+            R       R   O        O  B        b  O        O       T       E                 S       T     
+            R        r  OOOOOOOOOO  BBBBBBBBB   OOOOOOOOOO       T       EEEEEEEEE  SSSSSSSS       T     
+           -----------------------------------------------------------------------------------------------
+      "
+    end
+
+    def welcome_message
+      puts "Welcome to RoboTest !!!\n\n"
+    end
+
+    def help_text
+      puts "New to RoboTest? try \n> robotest example \nto get a sample project get loaded in your directory \n \n"
+      puts "Need help in running the suite? try \n> robotest -h\nfor help (or) \n \n"
+    end
+
+    def example
+      begin
+        source_directory      = File.dirname(__FILE__) + "/../Full_Suite/."
+        destination_directory = Dir.pwd + "/Full_Suite/"
+        `cp -a #{source_directory} #{destination_directory}`
+        puts "\n\nInitialized sample robotest project in #{destination_directory}\n\n"
+        puts "Follow the following steps to make sure everyting is setup in a right way:"
+        puts "1. Now Make sure to rename the project name from `Full_Suite` to your `Custom Name`"
+        puts "2. Rename the file `rspec_parallel` in Full_Suite/ folder to `.rspec_parallel`. Navigate to your project and Do `bundle install` before proceeding with the following step"
+        puts "3. To test a sample run with single process try running `robotest yaml/test.yml`"
+        puts "4. To test a sample run with multiple process try running `robotest yaml/test_parallel.yml`\n\n"
+        exit_message
+        exit!
+      rescue Exception => e
+        puts e.message
+        puts e.backtrace
+      ensure
+        exit_message
+        exit!
+      end
+    end
+
+    def generate(argv)
+      begin
+        raise 'Pass module name as an argument, example: robotest generate login' unless argv.length >= 2
+        argv.each do |file_name|
+          next if file_name == 'generate'
+          class_name = file_name.split('_').collect(&:capitalize).join
+          locators_file_path = File.read(File.join(File.dirname(__FILE__), '..', 'templates', 'locators.erb'))
+          pages_file_path = File.read(File.join(File.dirname(__FILE__), '..', 'templates', 'pages.erb'))
+          File.write(File.join(Dir.pwd, 'locators', "#{file_name}.rb"), ERB.new(locators_file_path).result(binding))
+          File.write(File.join(Dir.pwd, 'pages', "#{file_name}.rb"), ERB.new(pages_file_path).result(binding))
+          puts "Template class: '#{class_name}' is created under pages and locators directory"
+        end
+      rescue Exception => e
+        puts e.message
+        puts e.backtrace
+      ensure
+        exit_message
+        exit!
+      end
+    end
+
+    def run(argv)
+      if $conf["mode"] == 'parallel'
+        ParallelTests::CLI.new.run(["--type", "rspec"] + argv)
+      else
+        ParallelTests::CLI.new.run(["--type", "rspec", "--first-is-1", "-n", "1"] + argv)
+      end
+    end
+
+    def yaml_dump(filename, data)
+      File.open(filename, 'w') do |f|
+        f.write(YAML.dump(data))
+      end
+    end
+
+    def delete_temp_files
+      File.delete('_robotest.yml') if File.exist?('_robotest.yml')
+    end
+
+    def setup_args(argv, conf, rspec_args)
+      argv.shift
+      conf["specs"].each { |spec| argv << spec } if argv.empty?
+      argv.unshift('--')
+      if conf["tag"]
+        if conf["tag"].class == Hash
+          conf["tag"].each do|key, value|
+            argv.unshift("#{key}:#{value}")
+            argv.unshift("-t")
+          end
+        else
+          tags = conf["tag"].split("&&")
+          tags.each do|tag|
+            argv.unshift(tag)
+            argv.unshift("-t")
+          end
+        end
+      end
+      argv.unshift(conf['exclude'].join(',')) unless conf['exclude'].nil?
+      argv.unshift('--exclude-pattern') unless conf['exclude'].nil?
+      argv.unshift('--only-failures') if conf['only_failures']
+      argv.unshift('@sanity:true') if conf['sanity']
+      argv.unshift('--tag') if conf['sanity']
+      argv.unshift('--')
+      argv.unshift('--first-is-1')
+      if conf['mode'] == 'parallel' and conf['count']
+        argv.unshift(conf['count'])
+        argv.unshift('-n')
+      end
+      return argv
+    end
+
+    def load_config_file(file, options)
+      raise "An yaml file needs to be" if !File.file?(file)
+      configFile = YAML.ext_load_file(file)
+      configFile["base_urls"] = options[:url].split(',') if options[:url]
+      configFile["browser"] = options[:browser] if options[:browser]
+      configFile["remote"] = options[:remote] if options[:remote]
+      if configFile["parallel_process"] != nil
+        configFile["count"] = "#{configFile["parallel_process"]}"
+      else
+        configFile["count"] = options[:count] ? options[:count] : configFile["base_urls"].length.to_s
+      end
+      configFile["mode"] = options[:mode] if options[:mode]
+      configFile["only_failures"] = options[:only_failures] if options[:only_failures]
+      configFile["tag"] = options[:tag] if options[:tag]
+      configFile["dimensions"]["horizontal"] = options[:horizontal] if options[:horizontal]
+      configFile["dimensions"]["vertical"] = options[:vertical] if options[:vertical]
+      configFile["testrail"]["run_id"] = options[:runid].to_i if options[:runid]
+      configFile["buildURL"] = options[:buildURL] if options[:buildURL]
+      configFile
+    end
+
+    def parse_options(argv)
+
+      options = {}
+      rspec_args = []
+
+      OptionParser.new do |opts|
+        opts.banner = <<-BANNER.gsub(/^          /, '')
+          BANNER
+
+        opts.on("-f", "--format FORMATTER", "Result format as specified in rspec") do |format|
+          options[:format] = format
+          rspec_args << '-f' << format
+        end
+
+        opts.on("-t", "--tag TAG[:VALUE]", "Run examples with the specified tag") do |tag|
+          options[:tag] = tag
+          rspec_args << '-t' << tag
+        end
+
+        opts.on("-e", "--example STRING", "Runs test cases with the specified string") do |example|
+          options[:example] = example
+          rspec_args << '-e' << example
+        end
+
+        opts.on("", "--only-failures", "Run only the failures from the last run") do |only_failures|
+          options[:only_failures] = only_failures
+          rspec_args << '--only-failures'
+        end
+
+        opts.on("-n", "--count COUNT", "Process count.") { |count| options[:count] = count }
+        opts.on("-u", "--url URL", "Run scripts with this url.") { |url| options[:url] = url }
+        opts.on("-x", "--horizontal HORIZONTAL", "Browser dimension in horizontal direction") { |horizontal| options[:horizontal] = horizontal.to_i }
+        opts.on("-y", "--vertical VERTICAL", "Browser dimension in vertical direction") { |vertical| options[:vertical] = vertical.to_i }
+        opts.on("-b", "--browser BROWSER", "chrome/firefox/edge/safari") { |browser| options[:browser] = browser }
+        opts.on("-m", "--mode MODE", "single/parallel") { |mode| options[:mode] = mode }
+        opts.on("-v", "--version", "Show version.") { puts "Version - #{RoboTest::VERSION}\n"; exit 0 }
+        opts.on("-h", "--help", "Print help.") { 
+          opt_parser_banner
+          puts opts; 
+          exit_message
+          exit! }
+      end.parse!
+
+      [options, rspec_args]
+
+    end
+
+  end
+end