itms_automation 1.0

data/project/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+gem 'report_builder'
+gem 'itms_automation'

data/project/README.md

@@ -0,0 +1,34 @@
+###itms_automation gem
+itms_automation is an open-source tool for automating GUI, RESTful, SOAP, Database and eMail.
+Importantly, itms_automation is cross-platform, it allows you to write tests against multiple platforms (Linux, Windows, MacOS) on multiple browsers (chrome, firefox ...) using the same API.
+
+###Getting Started
+These instructions will get you a copy of the project up and running on your local machine for testing purposes. See deployment for notes on how to install itms_automation gem
+###Prerequisites
+- Ruby: 2.3+
+###Installing
+`$ gem install itms_automation`
+System automatically fetch all relate automation libraries after install itms_automation gem
+###Setup
+`$ itms_automation gen`
+This command help to create a set folder structure which followed the format of BDD Cucumber and itms_automation.
+###Structure folder format
+- Screenshot folder
+Once your scenario failed, the screen will be captured and saved to this folder
+
+-  TestSuite folder
+Place to store user's feature files.
+
+- Step_definitions folder
+	- lib_steps
+		- actionword.rb
+		- steps.rb
+		two file help to create user custom steps
+	- repositories
+		- project_object.yml (all web objects will store in this file)
+	- support
+		- env.rb
+		- hook.rb
+
+- config folder
+All browser capabilities configuration

data/project/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+
+begin
+  require 'cucumber'
+  require 'cucumber/rake/task'
+  testsuite_name = ENV['TESTSUITE']
+  testcase_report_name = ENV['TESTCASE_REPORT_NAME']
+  report_path = "Reports/#{testsuite_name}"
+  debug_opts = [  "--format usage", "--out"]
+  report_opts = ["REPORT=true","--color", "--format junit", "--out #{report_path}", "--format json --out #{report_path}/#{testcase_report_name}.json"]
+  namespace :execute do
+    Cucumber::Rake::Task.new(:report, "Execute automation test with report output.") do |t|
+      t.cucumber_opts = [*report_opts, "--format progress"]
+    end
+    Cucumber::Rake::Task.new(:debug, "Debug automation test without report output.") do |t|
+      t.cucumber_opts = [*debug_opts]
+    end
+  end
+rescue LoadError
+  desc 'Cucumber rake task not available'
+  task :features do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end

data/project/config/chrome_headless_options.yaml

@@ -0,0 +1 @@
+args: ["--headless","--disable-gpu",--no-sandbox]

data/project/config/chrome_options.yaml

@@ -0,0 +1,6 @@
+args: ["--start-maximized","--disable-infobars","--incognito"]
+prefs: {
+      password_manager_enabled: false,
+      default_content_settings: {popups: 0},
+      content_settings: {pattern_pairs: {'*': {'multiple-automatic-downloads': 1}}}
+    }

data/project/config/firefox_headless_options.yaml

@@ -0,0 +1 @@
+browser.download.downloadDir: '/home/seluser'

data/project/config/firefox_options.yaml

@@ -0,0 +1 @@
+browser.download.downloadDir: '/home/seluser'

data/project/config/ie_options.yaml

@@ -0,0 +1 @@
+mobileEmulation: {deviceName: "iPhone X"}

data/project/config/remote_options.yaml

@@ -0,0 +1,6 @@
+args: ["--start-maximized","--disable-infobars","--incognito", "--user-agent='Mozilla/5.0 (iPhone; CPU iPhone OS 5_0 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile    /9A334 Safari/7534.48.3'"]
+prefs: {
+      password_manager_enabled: false,
+      default_content_settings: {popups: 0},
+      content_settings: {pattern_pairs: {'*': {'multiple-automatic-downloads': 1}}}
+    }

data/project/config/safari_options.yaml

@@ -0,0 +1 @@
+mobileEmulation: {deviceName: "iPhone X"}

data/project/cucumber.yml

@@ -0,0 +1,4 @@
+chrome: BROWSER=chrome
+firefox: BROWSER=firefox
+ie: BROWSER=internet_explorer
+parallel: parallel_cucumber

data/project/features/TestSuite/WebGUI.feature

@@ -0,0 +1,4 @@
+Feature: demo
+
+  Scenario: new scenario
+    Given I open the page "http://google.com"

data/project/features/step_definitions/lib_steps/steps_definition.rb

@@ -0,0 +1,3 @@
+And /I open the page "(.*)"/ do |url_site|
+  execute_openbrowser(url_site)
+end

data/project/features/step_definitions/repositories/project_object.yml

@@ -0,0 +1,2 @@
+signupbutton: {xpath_selector: '//li[@class="mm-listitem"]//a[@href="#"][contains(text(),"T")]'}
+

data/project/features/support/env.rb

@@ -0,0 +1,10 @@
+STDOUT.sync = true
+require 'rubygems'
+require 'capybara'
+require 'capybara/cucumber'
+require 'cucumber'
+require 'yaml'
+require 'selenium-webdriver'
+require 'itms_automation'
+require 'report_builder'
+

data/project/features/support/hooks.rb

@@ -0,0 +1,130 @@
+Before do |scenario|
+  $driver = getDriver
+  $wait_time = ENV["WAIT_TIME"] || 30
+  $print_log = ENV["PRINT_LOG"] || false
+  $browser_data = page.driver.browser.capabilities
+end
+
+AfterConfiguration do
+  $OBJECT = loadYAMLfile("features/step_definitions/repositories/project_object.yml")
+  validate_params_exist
+  if ENV['DELETE_COOKIE']
+    browser = Capybara.current_session.driver.browser
+    browser.manage.delete_all_cookies
+  end
+
+end
+
+def validate_params_exist
+  raise "❌  ERROR: Missing param SERVER_URL." if ENV['SERVER_URL'].nil?
+  raise "❌  ERROR: Missing param BROWSER." if ENV['BROWSER'].nil?
+  if ENV['REPORT']
+    raise "❌  ERROR: Missing param TESTSUITE." if ENV['TESTSUITE'].nil?
+    raise "❌  ERROR: Missing param TESTCASE_REPORT_NAME." if ENV['TESTCASE_REPORT_NAME'].nil?
+    $report_path = "Reports/#{ENV['TESTSUITE']}"
+    $testcase_report_name = ENV['TESTCASE_REPORT_NAME']
+  end
+end
+
+def getDriver
+  case ENV['BROWSER']
+  when "chrome"
+    @chrome_options = loadYAMLfile('config/chrome_options.yaml')
+    Capybara.register_driver :selenium do |app|
+       Capybara::Selenium::Driver.new(app, :url => ENV['SERVER_URL'],:desired_capabilities => Selenium::WebDriver::Remote::Capabilities.chrome(chromeOptions: @chrome_options))
+    end
+    Capybara.current_driver = :selenium
+  when "firefox"
+    @firefox_options = loadYAMLfile('config/firefox_options.yaml')
+    Capybara.register_driver :selenium do |app|
+      Capybara::Selenium::Driver.new(app, :url => ENV['SERVER_URL'], :desired_capabilities => Selenium::WebDriver::Remote::Capabilities.firefox(firefoxOptions: @firefox_options))
+    end
+    Capybara.current_driver = :selenium
+  when "safari"
+    @safari_options = loadYAMLfile('config/safari_options.yaml')
+    Capybara.register_driver :selenium do |app|
+      Capybara::Selenium::Driver.new(app, :url => ENV['SERVER_URL'], :desired_capabilities => Selenium::WebDriver::Remote::Capabilities.safari(safariOptions: @safari_options))
+    end
+    Capybara.current_driver = :selenium
+  when "ie"
+    @ie_options = loadYAMLfile('config/ie_options.yaml')
+    Capybara.register_driver :selenium do |app|
+      Capybara::Selenium::Driver.new(app, :url => ENV['SERVER_URL'], :desired_capabilities => Selenium::WebDriver::Remote::Capabilities.internet_explorer(ieOptions: @ie_options))
+    end
+    Capybara.current_driver = :selenium
+  # when "chrome_headless"
+  #   @chrome_headless_options = loadYAMLfile('config/chrome_headless_options.yaml')
+  #   Capybara.register_driver :selenium do |app|
+  #     Capybara::Selenium::Driver.new(app, :desired_capabilities => Selenium::WebDriver::Remote::Capabilities.chrome(chromeOptions: @chrome_headless_options))
+  #   end
+  #   Capybara.current_driver = :selenium_headless
+  # when "firefox_headless"
+  #   @firefox_headless_options = loadYAMLfile('config/firefox_options.yaml')
+  #   Capybara.register_driver :selenium do |app|
+  #     Capybara::Selenium::Driver.new(app, :desired_capabilities => Selenium::WebDriver::Remote::Capabilities.firefox(firefoxOptions: @firefox_headless_options))
+  #   end
+  #   Capybara.current_driver = :selenium_headless
+  when "remote"
+    @capabilities = loadYAMLfile('config/remote_options.yaml')
+    Capybara.register_driver :selenium do |app|
+      Capybara::Selenium::Driver.new(app, :url => ENV['SERVER_URL'], :desired_capabilities => @capabilities)
+    end
+    Capybara.current_driver = :selenium
+   else
+    raise "❌  ERROR: Unsupported browser: #{ENV['BROWSER']}. Available: chrome || firefox || safari || ie || remote"
+  end
+end
+
+def loadYAMLfile(filename)
+  begin
+    return YAML.load_file(filename)
+  rescue Psych::SyntaxError => ex
+    raise "❌ SyntaxError when reading file: #{ex}"
+  end
+end
+
+After do |scenario|
+  #   save_screenshot = ENV['SCREENSHOT'] || false
+  #   if save_screenshot == true
+  #     file_name = 'failed_%s.png' % rand(1000).to_s
+  #     page.save_screenshot($screenshot+file_name) if scenario.failed?
+  #     begin
+  #       Capybara.page.driver.quit
+  #       Capybara.send(:session_pool).delete_if { |key, value| key =~ /selenium/i }
+  #     rescue StandardError => myStandardError
+  #       puts "❌  Error: #{myStandardError}"
+  #       exit(1)
+  #     end
+  #   end
+  # $browser_data = page.driver.browser.capabilities
+  # p "$browser_data:#{$browser_data.inspect}"
+end
+
+at_exit do
+  if ENV['REPORT']
+    begin
+      # validateReport
+      time = Time.now.getutc
+      if $browser_data
+        browser_name = $browser_data[:browser_name]
+        browser_version = $browser_data[:browser_version]
+        platform = $browser_data[:platform_name]
+      end
+      ReportBuilder.configure do |config|
+        config.report_path = "#{$report_path}/#{$testcase_report_name}"
+        config.input_path = "#{$report_path}/#{$testcase_report_name}.json"
+        config.report_types = [:json, :html]
+        config.color = 'blue'
+        config.additional_info = {
+          'Browser' => browser_name || nil,
+          'Platform' => platform || nil,
+          'Browser Version' => browser_version || nil,
+          'Report Generated' => time
+        }
+      end
+      options = { report_title: "iTMS - Test Management System" }
+      ReportBuilder.build_report options
+    rescue NoMethodError
+    end
+  end
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: itms_automation
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Anh Pham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.29.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.29.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: parallel_tests
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+- !ruby/object:Gem::Dependency
+  name: report_builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: cucumber_priority
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+description: Behavior driven development (BDD) approach to write automation test script
+  to test GUI, RESTful, SOAP, Database, eMail.
+email:
+- anhpq.info@gmail.com
+executables:
+- itms_automation
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/console
+- bin/documentation_generator.rb
+- bin/generate.rb
+- bin/helper.rb
+- bin/itms_automation
+- bin/setup
+- lib/itms_automation.rb
+- lib/itms_automation/all_steps.rb
+- lib/itms_automation/auto_util.rb
+- lib/itms_automation/version.rb
+- lib/itms_automation/web_steps_helper.rb
+- project/Gemfile
+- project/README.md
+- project/Rakefile
+- project/config/chrome_headless_options.yaml
+- project/config/chrome_options.yaml
+- project/config/firefox_headless_options.yaml
+- project/config/firefox_options.yaml
+- project/config/ie_options.yaml
+- project/config/remote_options.yaml
+- project/config/safari_options.yaml
+- project/cucumber.yml
+- project/features/TestSuite/WebGUI.feature
+- project/features/step_definitions/lib_steps/steps_definition.rb
+- project/features/step_definitions/repositories/project_object.yml
+- project/features/support/env.rb
+- project/features/support/hooks.rb
+homepage: http://rubygems.org/gems/itms_automation
+licenses:
+- MIT
+metadata: {}
+post_install_message: Thank you for installing itms_automation gem.
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: SELENIUM WEBDRIVER WITH RUBY & CUCUMBER
+test_files: []