autospec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 826e093752e432a327554f83c84a237b38abd31a
+  data.tar.gz: 1b72c6ed4f73cd02b35b3cb8ad321bb6eff30428
+SHA512:
+  metadata.gz: c6cee272b9648fd42efc029932e16034c3f5c8630b19c2f6da9838d8a221a58ba7f7bb44738fe6261d6619c8a7850f9289ca3934410ea4953e1b738599a02c93
+  data.tar.gz: f3065602f80fa5e88a2a65e66a06bebe74fc73017fc0f6f259908e6731ce6eaac375090afaacff49f9ff498073af17eed7bcffdd809dd1e4025f2dc5415e8fa5

data/.gitignore

@@ -0,0 +1,14 @@
+# Ignore project files. Project files should never be committed.
+.idea
+.project
+.projects
+.settings
+*.sublime-*
+
+# YARDoc files
+.yardoc
+doc
+
+# Log files and temporary files
+logs
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.1.3

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+gem 'capybara'
+gem 'selenium-webdriver', '~> 2.46'
+gem 'activesupport', '~> 4.0.0'
+gem 'rake'
+gem 'rest-client'
+gem 'capybara-webkit'
+
+group :development do
+  gem 'rspec'
+  # gem 'parallel_tests'
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,82 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.13)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    capybara (2.4.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    capybara-webkit (1.5.2)
+      capybara (>= 2.3.0, < 2.5.0)
+      json
+    childprocess (0.5.6)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.8)
+    i18n (0.7.0)
+    json (1.8.3)
+    method_source (0.8.2)
+    mime-types (2.6.1)
+    mini_portile (0.6.2)
+    minitest (4.7.5)
+    multi_json (1.11.1)
+    netrc (0.10.3)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rake (10.4.2)
+    rest-client (1.7.3)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    rubyzip (1.1.7)
+    selenium-webdriver (2.46.2)
+      childprocess (~> 0.5)
+      multi_json (~> 1.0)
+      rubyzip (~> 1.0)
+      websocket (~> 1.0)
+    slop (3.6.0)
+    thread_safe (0.3.4)
+    tzinfo (0.3.43)
+    websocket (1.2.2)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 4.0.0)
+  capybara
+  capybara-webkit
+  pry
+  rake
+  rest-client
+  rspec
+  selenium-webdriver (~> 2.46)

data/README.md

@@ -0,0 +1,119 @@
+# Autospec
+
+Gem prototype abstracted from [automation-rspec](https://github.com/peijiehu/automation-rspec)
+
+## Installation
+
+Install this gem.
+In your spec_helper.rb, add the following lines before Rspec.configure:
+```
+
+    require 'capybara'
+    require 'capybara/rspec'
+    require 'site_prism'
+    require 'autospec'
+
+    # if you want to include Autospec::PageHelperModule for your pages
+    # require 'page_objects/all_page_objects'
+
+    Capybara.run_server = false
+
+    # set default js enabled driver based on user input(env variable),
+    # which applies to all tests marked with :type => :feature
+    # default is :selenium, and selenium uses :firefox by default
+    driver_helper = Autospec::DriverHelper.new("#{Dir.pwd}/config/autospec/saucelabs.yml")
+    driver_to_use = driver_helper.driver
+    Capybara.javascript_driver = driver_to_use.to_sym
+
+    # sets app_host based on user input(env variable)
+    app_host = ENV['r_env'] || begin
+      Autospec.logger.debug "r_env is not set, using default env 'qa'"
+      'qa'
+    end
+    env_yaml = YAML.load_file("#{Dir.pwd}/config/autospec/env.yml")
+    Capybara.app_host = env_yaml[app_host]
+
+```
+And, add this in your Rspec.configure in spec_helper.rb,
+```
+
+  config.before :each do |example|
+    example_full_description = example.full_description
+    begin
+      driver_helper.set_sauce_session_name(example_full_description) if driver_to_use.include?('saucelabs') && !driver_to_use.nil?
+      Autospec.logger.debug "Finished setting saucelabs session name for #{example_full_description}"
+    rescue
+      Autospec.logger.debug "Failed setting saucelabs session name for #{example_full_description}"
+    end
+    page.driver.allow_url '*' if driver_to_use == 'webkit'
+  end
+
+```
+#### config/autospec/saucelabs.yml
+
+```
+
+    ---
+    driver: 'remote'
+    hub:
+        url: 'http://ondemand.saucelabs.com/wd/hub'
+        user: 'qa'
+        pass: 'key'
+
+    timeouts:
+        driver: 120
+        implicit_wait: 120
+        page_load: 60
+        script_timeout: 120
+
+    overrides:
+        peijie:
+            hub:
+                user: 'peijiehu'
+                pass: 'key'
+
+        smoke:
+            hub:
+                user:  'smoketest'
+                pass:  'key'
+
+        # Platforms and browsers we support
+        android_4_phone:
+            archetype: 'android'
+            capabilities:
+                browserName: 'Browser'
+                platformVersion: '4.4'
+                appium-version: '1.2.2'
+                platformName: 'Android'
+                deviceName: 'Android Emulator'
+                device-orientation: 'portrait'
+
+        osx10_safari8:
+            archetype: 'safari'
+            capabilities:
+                version: '8'
+                platform: 'OS X 10.9'
+                screen-resolution: '1600x1200'
+                safariIgnoreFraudWarning: true
+
+        win7_ff38:
+            archetype: 'firefox'
+            capabilities:
+                version: '38'
+                platform: 'Windows 7'
+                screen-resolution: '1600x1200'
+
+```
+
+#### config/autospec/env.yml
+```
+
+    ---
+    qa: 'http://www.qa.xxx.com'
+    prod: 'http://www.xxx.com'
+    duck: 'https://duckduckgo.com'
+
+```
+
+#### logs/autospec.log
+(empty file, add it to gitignore)

data/Rakefile

@@ -0,0 +1,6 @@
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :test
+rescue LoadError
+end

data/autospec.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'autospec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "autospec"
+  spec.version       = Autospec::VERSION
+  spec.authors       = ["Peijie Hu"]
+  spec.email         = ["tradev.pj@gmail.com"]
+
+  spec.summary       = %q{Helper to build test automation framework with rspec and capybara}
+  spec.description   = %q{Helper to build test automation framework with rspec and capybara}
+  spec.homepage      = "https://github.com/peijiehu/autospec"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'capybara', '~> 2.4.4'
+  spec.add_dependency 'selenium-webdriver', '~> 2.46'
+  spec.add_dependency 'activesupport', '~> 4.0.0'
+  spec.add_dependency 'rest-client', '~> 1.7.3'
+  spec.add_dependency 'capybara-webkit', '~> 1.5.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+end

data/lib/autospec/driver_helper.rb

@@ -0,0 +1,87 @@
+module Autospec
+  class DriverHelper
+
+    LOCAL_DRIVERS = [:firefox]
+    attr_accessor :user, :pass, :driver_to_use
+    attr_accessor :sauce_config
+
+    def initialize(sauce_config)
+      self.sauce_config = sauce_config
+    end
+
+    def driver
+      # Local drivers registration
+      LOCAL_DRIVERS.each do |driver|
+        Capybara.register_driver driver do |app|
+          Capybara::Selenium::Driver.new(app, :browser => driver)
+        end
+      end
+
+      if ENV['r_driver'].nil?
+        # set default_driver to a local firefox
+        driver_to_use = 'firefox'
+      else
+        # cmd_r_driver may be 'chrome' or ['saucelabs', 'phu', 'win7_ff34'], etc
+        cmd_r_driver = ENV['r_driver'].split(':')
+
+        # Remote driver registration
+        # Retrieve hub url, user credentials and browser info from saucelabs.yml
+        if ENV['r_driver'].include?('saucelabs')
+          remote_driver_yaml = self.sauce_config
+          remote_capabilities = Selenium::WebDriver::Remote::Capabilities.new
+          overrides_hash = remote_driver_yaml['overrides']
+          if cmd_r_driver[1].nil?
+            # set default
+            self.user = remote_driver_yaml['hub']['user']
+            self.pass = remote_driver_yaml['hub']['pass']
+            remote_capabilities = {
+                'browserName' => 'firefox',
+                'version' => '34',
+                'platform' => 'Windows 7'
+            }
+          else
+            # set by overrides
+            self.user = overrides_hash[cmd_r_driver[1]]['hub']['user']
+            self.pass = overrides_hash[cmd_r_driver[1]]['hub']['pass']
+            remote_capabilities = overrides_hash[cmd_r_driver[2]]['capabilities']
+          end
+
+          Autospec.logger.debug "remote_capabilities: #{remote_capabilities}"
+
+          default_remote_options = {
+              :browser => :remote,
+              :url => "http://#{self.user}:#{self.pass}@ondemand.saucelabs.com/wd/hub",
+              :desired_capabilities => remote_capabilities
+          }
+          Capybara.register_driver :saucelabs do |app|
+            Capybara::Selenium::Driver.new(app, default_remote_options)
+          end
+        end
+        # set default_driver to a local browser or saucelabs
+        driver_to_use = cmd_r_driver[0]
+      end
+
+      driver_to_use
+    end
+
+
+    # update session name on saucelabs
+    def set_sauce_session_name(new_name)
+      new_tags = "started by #{self.user}"
+      require 'json'
+      # current session is a wrapper of Capybara::Selenium::Driver,
+      # Capybara::Selenium::Driver instantiates a browser from Selenium::Webdriver
+      # then bridge is a private method in Selenium::Webdriver::Driver
+      bridge = Capybara.current_session.driver.browser.send :bridge
+      session_id = bridge.session_id
+      Autospec.logger.debug "bridge session_id: #{session_id}"
+      http_auth = "https://#{self.user}:#{self.pass}@saucelabs.com/rest/v1/#{self.user}/jobs/#{session_id}"
+      # to_json need to: require "active_support/core_ext", but will mess up the whole framework, require 'json' in this method solved it
+      body = {"name" => new_name, "tags" => [new_tags]}.to_json
+      # gem 'rest-client'
+      Autospec.logger.debug "About to send request to saucelabs with url as #{http_auth} and body as #{body}"
+      RestClient.put(http_auth, body, {:content_type => "application/json"})
+    end
+
+  end
+end

data/lib/autospec/general_helper_module.rb

@@ -0,0 +1,14 @@
+module Autospec
+  module GeneralHelperModule
+
+    # Generate a unique id with a random hex string and time stamp string
+    def generate_unique_id
+      SecureRandom.hex(3) + Time.now.to_i.to_s
+    end
+
+    def generate_new_email
+      [generate_unique_id, 'pj@mailinator.com'].join('.')
+    end
+
+  end
+end

data/lib/autospec/logger.rb

@@ -0,0 +1,24 @@
+module Autospec
+  class MyLogger < ActiveSupport::Logger
+    def initialize
+      log_file_path = "#{Dir.pwd}/logs/autospec.log"
+      log_file = File.open(log_file_path, File::WRONLY | File::APPEND | File::CREAT) unless log_file_path.respond_to?(:write)
+      super(log_file)
+    end
+  end
+
+  # module method for Autospec
+  def logger
+    logger = MyLogger.new
+    my_format = "[%s#%d] %5s -- %s: %s\n"
+    original_formatter = ActiveSupport::Logger::Formatter.new
+    logger.formatter = proc { |severity, datetime, progname, msg|
+      formatted_datetime = original_formatter.send :format_datetime, datetime
+      str_msg = original_formatter.send :msg2str, msg
+      my_format % [formatted_datetime, $$, severity, progname, str_msg]
+    }
+    logger
+  end
+
+  module_function :logger
+end

data/lib/autospec/page_helper_module.rb

@@ -0,0 +1,43 @@
+module Autospec
+  module PageHelperModule
+
+    def current_session
+      Capybara.current_session
+    end
+
+    # Wait on all DOM events to finish
+    # Note that #find(from Capybara::Node::Finders) continuously retry finding an element
+    # and timeout for #find is controlled by Capybara.default_wait_time
+    def wait_for_dom
+      uuid = SecureRandom.uuid
+      current_session.find("body")
+      current_session.evaluate_script <<-EOS
+        _.defer(function() {
+          $('body').append("<div id='#{uuid}'></div>");
+        });
+      EOS
+      current_session.find("div##{uuid}")
+    end
+
+    # Wait on all AJAX requests to finish
+    def wait_for_ajax(timeout = Capybara.default_wait_time)
+      wait(timeout: timeout, msg: "Timeout after waiting #{timeout} for all ajax requests to finish") do
+        current_session.evaluate_script 'jQuery.active == 0'
+      end
+    end
+
+    # Explicitly wait for a certain condition to be true:
+    #   wait.until { driver.find_element(:css, 'body.tmpl-srp') }
+    # when timeout is not specified, default timeout 5 sec will be used
+    # when timeout is larger than 15, max timeout 15 sec will be used
+    def wait(opts = {})
+      if !opts[:timeout].nil? && opts[:timeout] > 15
+        puts "WARNING: #{opts[:timeout]} sec timeout is NOT supported by wait method,
+                max timeout 15 sec will be used instead"
+        opts[:timeout] = 15
+      end
+      Selenium::WebDriver::Wait.new(opts)
+    end
+
+  end
+end

data/lib/autospec/spec_helper_module.rb

@@ -0,0 +1,4 @@
+module Autospec
+  module SpecHelperModule
+  end
+end

data/lib/autospec/version.rb

@@ -0,0 +1,3 @@
+module Autospec
+  VERSION = "0.0.1"
+end

data/lib/autospec.rb

@@ -0,0 +1,16 @@
+require 'capybara'
+require 'yaml'
+require 'pry'
+require 'selenium-webdriver'
+require 'capybara-webkit'
+require 'rest-client'
+require 'active_support'
+
+require_relative  'autospec/driver_helper'
+require_relative  'autospec/general_helper_module'
+require_relative  'autospec/logger'
+require_relative  'autospec/page_helper_module'
+require_relative  'autospec/spec_helper_module'
+
+module Autospec
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: autospec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peijie Hu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.46'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.46'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+- !ruby/object:Gem::Dependency
+  name: capybara-webkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Helper to build test automation framework with rspec and capybara
+email:
+- tradev.pj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- autospec.gemspec
+- lib/autospec.rb
+- lib/autospec/driver_helper.rb
+- lib/autospec/general_helper_module.rb
+- lib/autospec/logger.rb
+- lib/autospec/page_helper_module.rb
+- lib/autospec/spec_helper_module.rb
+- lib/autospec/version.rb
+homepage: https://github.com/peijiehu/autospec
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Helper to build test automation framework with rspec and capybara
+test_files: []
+has_rdoc: