selenium-framework 0.0.4

data/bin/copyfiles/Gemfile

@@ -0,0 +1,10 @@
+source 'http://gemcutter.org'
+source 'http://gems.rubyforge.org'
+source 'http://rubygems.org'
+gem 'selenium-webdriver'
+gem 'mail'
+gem 'faker'
+gem 'nokogiri'
+gem 'selenium-client'
+gem 'headless'
+

data/bin/copyfiles/include.rb

@@ -0,0 +1,12 @@
+require 'selenium-framework'
+require 'selenium-webdriver'
+require 'test/unit'
+require 'date'
+require 'csv'
+require 'faker'
+require 'mail'
+require 'open-uri'
+require 'nokogiri'
+require 'uri'
+require 'headless'
+

data/bin/copyfiles/project_file.rb

@@ -0,0 +1,25 @@
+require './include.rb'
+
+class Project < Test::Unit::TestCase
+
+def setup 
+client = Selenium::WebDriver::Remote::Http::Default.new 
+client.timeout = 120 # seconds 
+$driver = Selenium::WebDriver.for(:remote, :http_client => client, :url => 'http://<IP ADDRESS>:<PORT NUMBER>/wd/hub', :desired_capabilities => ':firefox')
+$base_url = 'http://<WEBSITE URL>'
+$driver.manage.timeouts.implicit_wait = 180
+@verification_errors = []
+end
+
+def teardown 
+$driver.quit 
+assert_equal [],@verification_errors 
+end
+
+def verify(&blk) 
+yield 
+rescue Test::Unit::AssertionFailedError => ex 
+@verification_errors << ex 
+end
+
+end

data/bin/framework

@@ -0,0 +1,297 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+require 'readline'
+
+
+def print_path(filename, filepath, project_directory_path)
+  path = filepath +"/"+ filename
+  path = path.to_s
+  puts "create " + path.split(project_directory_path.to_s)[1].to_s
+end
+
+def create_dir(dirname, directory_path, project_directory_path)
+  Dir.chdir(directory_path)
+  unless  (File.exists?(dirname))
+    Dir.mkdir(dirname)
+    print_path(dirname, directory_path, project_directory_path)
+  end
+  Dir.chdir(directory_path + "/" + dirname)
+  unless  (File.exists?(".gitignore"))
+    FileUtils.touch ".gitignore"
+    print_path(".gitignore", directory_path + "/" + dirname, project_directory_path)
+  end
+  Dir.chdir(directory_path)
+end
+
+def help_text
+  puts "Usage: \n\tframework new <PROJECT_PATH> [options] \n\tframework update <PROJECT_PATH> [options]\n\nFramework options: \n\t-h, [--help]\t# Show this help message and quit\n\nRuntime options: \n\t-f, [--force]\t# Overwrite files that already exist"
+  exit
+end
+
+
+if ARGV[0] == nil || ARGV[1] == nil || (ARGV[0] !='new' && ARGV[0] !='update' ) || ARGV[0] == '-h' || ARGV[0] == '--help'
+  help_text
+end
+force_flag = 0
+if ARGV.length == 3
+  if ARGV[2] == '-f' || ARGV[2] == '--force'
+    exist_flag = 1
+    force_flag = 1
+  else
+    help_text
+  end
+end
+
+update_flag = 0
+if ARGV[0] == 'update'
+  if ARGV.length == 2 && ARGV[1] != nil
+    update_flag = 1
+  else
+    help_text
+  end
+end
+
+
+
+project_name = ARGV[1]
+project_directory_path = Dir.pwd
+puts "\n"
+
+exist_flag = 1
+if ("true".casecmp(File.directory?(project_directory_path +"/"+ project_name).to_s)) == 0 && exist_flag == 1 && force_flag == 0 && update_flag == 0
+  puts "Project exist !!! What do you want to do? \n1. Overwrite the project\n2. Take backup and create new project\n3. Create project in existing directory\n4. Exit :\n\n"
+  exist_flag = Readline.readline(":", true)
+  exist_flag = exist_flag.to_i
+else
+
+
+end
+
+if exist_flag == 1 && update_flag == 0
+  if File.exists?(project_name)
+    FileUtils.rm_r(project_name)
+    puts "Deleted the previous project...\n\n"
+  end
+  puts "Creating new project as #{project_name}..."
+  create_dir(project_name, project_directory_path, project_directory_path)
+  Dir.chdir(project_directory_path + "/" + project_name)
+
+  project_main_file = project_name + ".rb"
+  FileUtils.touch project_main_file
+  source = File.expand_path File.dirname(__FILE__).to_s + "/copyfiles/project_file.rb"
+  destination = project_directory_path + "/" + project_name + "/" + project_main_file
+  FileUtils.copy_file(source,destination)
+  outdata = File.read(destination).gsub("Project", project_name.capitalize)
+  File.open(destination, 'w') do |out|
+    out << outdata
+  end
+  print_path(project_main_file, project_directory_path + "/" + project_name, project_directory_path)
+
+  FileUtils.touch "include.rb"
+  source = File.expand_path File.dirname(__FILE__).to_s + "/copyfiles/include.rb"
+  destination = project_directory_path + "/" + project_name + "/include.rb"
+  FileUtils.copy_file(source,destination)
+  print_path("include.rb", project_directory_path + "/" + project_name, project_directory_path)
+
+  FileUtils.touch "Gemfile"
+  source = File.expand_path File.dirname(__FILE__).to_s + "/copyfiles/Gemfile"
+  destination = project_directory_path + "/" + project_name + "/Gemfile"
+  FileUtils.copy_file(source,destination)
+  print_path("Gemfile", project_directory_path + "/" + project_name, project_directory_path)
+
+  Dir.chdir(project_directory_path)
+# internal_dir -- array for storing framework directory names
+  internal_dir = ["libraries", "testcases", "logs", "reports", "screenshots"]
+  directory_path = project_directory_path + "/" + project_name
+# dir_counter -- iterator for the loop
+  for dir_counter in 0..internal_dir.length-1
+    create_dir(internal_dir[dir_counter], directory_path, project_directory_path)
+  end
+  puts "\nFramework for #{project_name} is created..."
+  puts "\nbundle install"
+  Dir.chdir(project_directory_path + "/" + project_name)
+  system("bundle install")
+  Dir.chdir(project_directory_path)
+end
+
+if exist_flag == 2
+  timestamp = Time.now
+  timestamp = timestamp.strftime("%d-%m-%Y-%H-%M-%S")
+  timestamp = timestamp.to_s
+  old_prject_name = project_name
+  new_project_name = project_name+'_'+timestamp
+  File.rename(old_prject_name, new_project_name)
+  puts "\n#{old_prject_name} HAS BEEN MOVED TO #{new_project_name} \n\n"
+  puts "Creating new project as #{project_name}..."
+  create_dir(project_name, project_directory_path, project_directory_path)
+  Dir.chdir(project_directory_path + "/" + project_name)
+
+  project_main_file = project_name + ".rb"
+  FileUtils.touch project_main_file
+  source = File.expand_path File.dirname(__FILE__).to_s + "/copyfiles/project_file.rb"
+  destination = project_directory_path + "/" + project_name + "/" + project_main_file
+  FileUtils.copy_file(source,destination)
+  outdata = File.read(destination).gsub("Project", project_name.capitalize)
+  File.open(destination, 'w') do |out|
+    out << outdata
+  end
+  print_path(project_main_file, project_directory_path + "/" + project_name, project_directory_path)
+
+  FileUtils.touch "include.rb"
+  source = File.expand_path File.dirname(__FILE__).to_s + "/copyfiles/include.rb"
+  destination = project_directory_path + "/" + project_name + "/include.rb"
+  FileUtils.copy_file(source,destination)
+  print_path("include.rb", project_directory_path + "/" + project_name, project_directory_path)
+
+  FileUtils.touch "Gemfile"
+  source = File.expand_path File.dirname(__FILE__).to_s + "/copyfiles/Gemfile"
+  destination = project_directory_path + "/" + project_name + "/Gemfile"
+  FileUtils.copy_file(source,destination)
+  print_path("Gemfile", project_directory_path + "/" + project_name, project_directory_path)
+
+  Dir.chdir(project_directory_path)
+# internal_dir -- array for storing framework directory names
+  internal_dir = ["libraries", "testcases", "logs", "reports", "screenshots"]
+  directory_path = project_directory_path + "/" + project_name
+# dir_counter -- iterator for the loop
+  for dir_counter in 0..internal_dir.length-1
+    create_dir(internal_dir[dir_counter], directory_path, project_directory_path)
+  end
+  puts "\nFramework for #{project_name} is created..."
+  puts "\nbundle install"
+  Dir.chdir(project_directory_path + "/" + project_name)
+  system("bundle install")
+  Dir.chdir(project_directory_path)
+end
+
+if exist_flag == 3
+  puts "\nThe framework will be created in existing directory. Do you want to continue? Enter y/yes to continue."
+  confirm_flag = Readline.readline(":", true)
+  confirm_flag = confirm_flag.to_s.upcase
+  if ("Y".casecmp confirm_flag) == 0 || ("YES".casecmp confirm_flag) == 0
+    Dir.chdir(project_directory_path + "/" + project_name)
+    project_main_file = project_name + ".rb"
+    unless  (File.exists?(project_main_file))
+      FileUtils.touch project_main_file
+      source = File.expand_path File.dirname(__FILE__).to_s + "/copyfiles/project_file.rb"
+      destination = project_directory_path + "/" + project_name + "/" + project_main_file
+      FileUtils.copy_file(source,destination)
+      outdata = File.read(destination).gsub("Project", project_name.capitalize)
+      File.open(destination, 'w') do |out|
+        out << outdata
+      end
+      print_path(project_main_file, project_directory_path + "/" + project_name, project_directory_path)
+    end
+    unless  (File.exists?("include.rb"))
+      FileUtils.touch "include.rb"
+      source = File.expand_path File.dirname(__FILE__).to_s + "/copyfiles/include.rb"
+      destination = project_directory_path + "/" + project_name + "/include.rb"
+      FileUtils.copy_file(source,destination)
+      print_path("include.rb", project_directory_path + "/" + project_name, project_directory_path)
+    end
+    unless  (File.exists?("Gemfile"))
+      FileUtils.touch "Gemfile"
+      source = File.expand_path File.dirname(__FILE__).to_s + "/copyfiles/Gemfile"
+      destination = project_directory_path + "/" + project_name + "/Gemfile"
+      FileUtils.copy_file(source,destination)
+      print_path("Gemfile", project_directory_path + "/" + project_name, project_directory_path)
+    end
+
+    Dir.chdir(project_directory_path)
+# internal_dir -- array for storing framework directory names
+    internal_dir = ["libraries", "testcases", "logs", "reports", "screenshots"]
+    directory_path = project_directory_path + "/" + project_name
+# dir_counter -- iterator for the loop
+    for dir_counter in 0..internal_dir.length-1
+      create_dir(internal_dir[dir_counter], directory_path, project_directory_path)
+    end
+    puts "\nFramework for #{project_name} is created..."
+    puts "\nbundle install"
+    Dir.chdir(project_directory_path + "/" + project_name)
+    system("bundle install")
+    Dir.chdir(project_directory_path)
+  else
+    puts "Not continuing. Exiting creation of framework..."
+    exit
+  end
+end
+
+if exist_flag == 4
+  puts "Project exist !!! So exiting..."
+  exit
+end
+
+if update_flag ==1
+  unless File.exists?(project_name)
+    puts "\n#{project_name} does not exist in current location...\nSo exiting ..."
+    exit
+  end
+  Dir.chdir(project_directory_path + "/" + project_name)
+  source = File.expand_path File.dirname(__FILE__).to_s + "/copyfiles/include.rb"
+  destination = "include.rb"
+  compare_result_1 =  FileUtils.compare_file(source, destination).to_s
+  source = File.expand_path File.dirname(__FILE__).to_s + "/copyfiles/Gemfile"
+  destination = "Gemfile"
+  compare_result_2 =  FileUtils.compare_file(source, destination).to_s
+
+  if ("true".casecmp compare_result_1) == 0 && ("true".casecmp compare_result_2) == 0
+    puts "\nFramework for #{project_name} is already updated..."
+    puts "\nbundle install"
+    Dir.chdir(project_directory_path + "/" + project_name)
+    system("bundle install")
+    Dir.chdir(project_directory_path)
+    exit
+  else
+    puts "\nFramework for #{project_name} needs to be updated..."
+    source = File.expand_path File.dirname(__FILE__).to_s + "/copyfiles/include.rb"
+    destination = "include.rb"
+    source_data = Array.new
+    source_data = IO.readlines(source)
+    destination_data = Array.new
+    destination_data = IO.readlines(destination)
+    source_data.each do |thing|
+      present_flag = destination_data.include? thing
+      present_flag = present_flag.to_s
+      if ("false".casecmp present_flag) == 0
+        #File.open(destination, 'a+') { |file| file.write(thing.to_s) }
+        f = File.open(destination, "r+")
+        lines = f.readlines
+        f.close
+        lines = [thing] + lines
+        output = File.new(destination, "w")
+        lines.each { |line| output.write line }
+        output.close
+      end
+    end
+    print_path("include.rb", project_directory_path + "/" + project_name, project_directory_path)
+
+    source = File.expand_path File.dirname(__FILE__).to_s + "/copyfiles/Gemfile"
+    destination = "Gemfile"
+    source_data = Array.new
+    source_data = IO.readlines(source)
+    destination_data = Array.new
+    destination_data = IO.readlines(destination)
+    source_data.each do |thing|
+      present_flag = destination_data.include? thing
+      present_flag = present_flag.to_s
+      if ("false".casecmp present_flag) == 0
+        #File.open(destination, 'a+') { |file| file.write(thing.to_s) }
+        f = File.open(destination, "r+")
+        lines = f.readlines
+        f.close
+        lines = [thing] + lines
+        output = File.new(destination, "w")
+        lines.each { |line| output.write line }
+        output.close
+      end
+    end
+    print_path("Gemfile", project_directory_path + "/" + project_name, project_directory_path)
+
+    puts "\nFramework for #{project_name} is updated..."
+    puts "\nbundle install"
+    Dir.chdir(project_directory_path + "/" + project_name)
+    system("bundle install")
+    Dir.chdir(project_directory_path)
+  end
+end
+

data/lib/modules/login/login.rb

@@ -0,0 +1,14 @@
+class Login
+
+  def self.login(user_loc_type, user_locator, username, pass_loc_type, pass_locator, password, submit_loc_type, submit_locator)
+    $driver.find_element(user_loc_type.to_sym, user_locator).send_keys username
+    $driver.find_element(pass_loc_type.to_sym, pass_locator).send_keys password
+    $driver.find_element(submit_loc_type.to_sym, submit_locator).click
+  end
+
+  def self.forgot_password(user_loc_type, user_locator, username, submit_loc_type, submit_locator)
+    $driver.find_element(user_loc_type.to_sym, user_locator).send_keys username
+    $driver.find_element(submit_loc_type.to_sym, submit_locator).click
+  end
+
+end

data/lib/selenium-framework.rb

@@ -0,0 +1,10 @@
+require 'selenium-framework'
+require 'userextension/user_extension.rb'
+require 'modules/login/login.rb'
+require 'time'
+require 'fileutils'
+require 'csv'
+require 'faker'
+require 'headless'
+
+

data/lib/userextension/user_extension.rb

@@ -0,0 +1,239 @@
+class UserExtension
+
+  # Call this function this way "generate_mail_id(length, domain)".
+  # This function will generate a random Yopmail id and return it.
+  def self.generate_mail_id(length, domain)
+    yopmailid = (1..length).map { ('a'..'z').to_a[rand(26)] }.join+"@"+domain.to_s
+    return yopmailid
+  end
+
+  # Call this function this way "generate_string(length)".
+  # This function will generate a random string and return it.
+  def self.generate_string(length)
+    str = (1..length).map { ('a'..'z').to_a[rand(26)] }.join
+    return str
+  end
+
+  # Call this function this way "generate_title".
+  # This function will generate a title and return it.
+  def self.generate_title
+    title = Faker::Name.prefix
+    return title
+  end
+
+  # Call this function this way "generate_name(length)".
+  # This function will generate a random name and return it.
+  def self.generate_name(length)
+    str = (1..length-1).map { ('a'..'z').to_a[rand(26)] }.join
+    str = ('A'..'Z').to_a[rand(26)] + str
+    #str = Faker::Name.first_name
+    #while str.length != length
+    #  str = Faker::Name.first_name
+    #end
+    str.capitalize
+    return str
+  end
+
+  # Call this function this way "generate_number(minrange, maxrange)".
+  # This function will generate a random number and return it.
+  def self.generate_number(minrange, maxrange)
+    number = rand(minrange..maxrange)
+    return number
+  end
+
+  # Call this function this way "generate_future_date(days)".
+  # This function will generate a future date and return it.
+  def self.generate_future_date(days)
+    date = Date.strptime(Date.today.to_s)
+    date = date + days
+    return date.strftime("%d-%m-%Y")
+  end
+
+  # Call this function this way "generate_past_date(days)".
+  # This function will generate a past date and return it.
+  def self.generate_past_date(days)
+    date = Date.strptime(Date.today.to_s)
+    date = date - days
+    return date.strftime("%d-%m-%Y")
+  end
+
+  # Call this function this way "generate_alphanumeric_string(length)".
+  # This function will generate a random alpha-numeric string and return it.
+  def self.generate_alphanumeric_string(length)
+    str = (1..length).map { rand(36).to_s(36) }.join
+    return str
+  end
+
+  # Call this function this way "generate_street_address".
+  # This function will generate a random street address and return it.
+  def self.generate_street_address
+    street_address = Faker::Address.street_address
+    return street_address
+  end
+
+  # Call this function this way "generate_address".
+  # This function will generate a random address and return it.
+  def self.generate_address
+    address = Faker::Address.secondary_address
+    return address
+  end
+
+  # Call this function this way "generate_phone_number".
+  # This function will generate a random phone number and return it.
+  def self.generate_phone_number
+    phone_number = rand(1000000000..9999999999)
+    return phone_number
+  end
+
+  # Call this function this way "generate_paragraph".
+  # This function will generate a paragraph and return it.
+  def self.generate_paragraph
+    paragraph = Faker::Lorem.paragraphs.map { |i| i.to_s }.join(" ")
+    return paragraph
+  end
+
+  # Call this function this way "generate_words(number)".
+  # This function will generate words and return it.
+  def self.generate_words(number)
+    words = Faker::Lorem.words(number).map { |i| i.to_s }.join(" ")
+    return words
+  end
+
+  # Call this function this way "generate_sentence".
+  # This function will generate a sentence and return it.
+  def self.generate_sentence
+    sentence = Faker::Lorem.sentence
+    return sentence
+  end
+
+  # Call this function this way "write_result_to_csv(report_file, test_id, test_case, result, comment="")".
+  # This function will write the result to .csv file.
+  def self.write_result_to_csv(report_file, test_id, test_case, result, comment="")
+    CSV.open(report_file, "ab") do |csv_file|
+      csv_file << [test_id, test_case, result, comment]
+    end
+  end
+
+  # Call this function this way "write_logs_to_text_file(log_file, logs)".
+  # This function will write the logs to .log file.
+  def self.write_logs_to_text_file(log_file, logs)
+    File.open(log_file, "a") do |txt_file|
+      txt_file.puts logs
+      txt_file.puts "\n"
+    end
+  end
+
+  # Call this function this way "element_present?(how, what)".
+  # This function will check if the element is present or not.
+  def self.element_present?(how, what)
+    begin
+      $driver.find_element(how, what)
+      return true
+    rescue
+      return false
+    end
+  end
+
+  # Call this function this way "pre_requisite(build_no,browser,timestamp)".
+  # This function will create the pre-requisites for the project.
+  def self.pre_requisite(build_no, browser, timestamp)
+    returning_array = Array.new
+    build_no = build_no.to_s
+    browser = browser.to_s
+    timestamp = timestamp.to_s
+    store_path = Dir.pwd
+    Dir.chdir("screenshots")
+    Dir.mkdir(build_no)
+    Dir.chdir(build_no)
+    Dir.mkdir(browser +"_"+ timestamp)
+    Dir.chdir(browser +"_"+ timestamp)
+    screenshot_path = store_path + "/screenshots/" + build_no + "/" + browser +"_"+ timestamp + "/"
+    returning_array.push(screenshot_path)
+    Dir.chdir(store_path)
+
+    Dir.chdir("reports")
+    Dir.mkdir(build_no)
+    report_path = store_path + "/reports/" + build_no + "/"
+    Dir.chdir(report_path)
+    report_file = report_path + build_no +"_" + browser +"_"+ timestamp + ".csv"
+    FileUtils.touch(report_file)
+    CSV.open(report_file, "wb") do |csv_file|
+      csv_file << ["TEST_ID", "TEST_CASE", "RESULT", "COMMENTS"]
+    end
+    returning_array.push(report_file)
+    broken_links_report_file = report_path + build_no +"_broken_links_" + timestamp + ".csv"
+    FileUtils.touch(broken_links_report_file)
+    CSV.open(broken_links_report_file, "wb") do |csv_file|
+      csv_file << ["LINK", "RESPONSE", "COMMENTS"]
+    end
+    returning_array.push(broken_links_report_file)
+    Dir.chdir(store_path)
+
+    Dir.chdir("logs")
+    Dir.mkdir(build_no)
+    log_path = store_path + "/logs/" + build_no + "/"
+    Dir.chdir(log_path)
+    log_file = log_path + build_no +"_" + browser + "_" + timestamp + ".log"
+    FileUtils.touch(log_file)
+    File.open(log_file, "wb") do |txt_file|
+      txt_file.puts "LOGS WITH RESULTS"
+    end
+    returning_array.push(log_file)
+    Dir.chdir(store_path)
+
+    return returning_array
+  end
+
+
+  def self.init_record()
+    os = RUBY_PLATFORM
+    if os.include? "linux"
+      headless_obj = Headless.new
+      headless_obj.start
+      return headless_obj
+    else
+      puts "#{RUBY_PLATFORM} is not a linux platform !!!"
+    end
+  end
+
+
+  def self.record_video_start_capture(headless_obj)
+    os = RUBY_PLATFORM
+    if os.include? "linux"
+      headless_obj.video.start_capture
+    else
+      puts "#{RUBY_PLATFORM} is not a linux platform !!!"
+    end
+  end
+
+
+  def self.record_video_stop_and_save(headless_obj,filename)
+    os = RUBY_PLATFORM
+    if os.include? "linux"
+      headless_obj.video.stop_and_save(filename)
+    else
+      puts "#{RUBY_PLATFORM} is not a linux platform !!!"
+    end
+  end
+
+
+  def self.record_video_stop_and_discard(headless_obj)
+    os = RUBY_PLATFORM
+    if os.include? "linux"
+      headless_obj.video.stop_and_discard()
+    else
+      puts "#{RUBY_PLATFORM} is not a linux platform !!!"
+    end
+  end
+
+
+  def self.capture_screenshot(selenium_diver,filename)
+    browser_name = selenium_diver.capabilities.browser_name
+    unless (browser_name.include? "safari")
+      selenium_diver.save_screenshot filename
+    else
+      puts "#{browser_name} does not support for capturing screenshot !!!"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: selenium-framework
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Suyog Sakegaonkar, Thiyagarajan Veluchamy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-31 00:00:00.000000000 Z
+dependencies: []
+description: Selenium Automation FrameWork
+email: suyogsakegaonkar@gmail.com, thiyagarajannv@gmail.com
+executables:
+- framework
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/userextension/user_extension.rb
+- lib/selenium-framework.rb
+- lib/modules/login/login.rb
+- bin/copyfiles/Gemfile
+- bin/copyfiles/include.rb
+- bin/copyfiles/project_file.rb
+- bin/framework
+homepage: https://github.com/webonise/AutomationFramework
+licenses: []
+post_install_message: ''
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: This gem is used for automation framework
+test_files: []