cloud_test 1.0.7

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cloud_test"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cloud_test.gemspec

@@ -0,0 +1,48 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cloud_test/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cloud_test"
+  spec.version       = CloudTest::VERSION
+  spec.authors       = ["Philipp Häusele"]
+  spec.email         = ["philipp.haeusele@makandra.de"]
+
+  spec.summary       = %q{Enables automated Cloud-Testing with various providers. }
+  spec.description   = %q{Enables cross-browser-testing with by the integration of the following providers Browserstack, Crossbrowsertesting, Saucelabs and lambdatest. Based on cucumber and capybara}
+  spec.homepage      = "https://github.com/makandra/cloud_test"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "RubyGems.org"
+
+    spec.metadata["homepage_uri"] = "https://github.com/makandra/cloud_test"
+    spec.metadata["source_code_uri"] = "https://github.com/makandra/cloud_test"
+    spec.metadata["changelog_uri"] = "https://github.com/makandra/cloud_test/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_development_dependency "aruba"
+
+  spec.add_dependency "thor"
+  spec.add_dependency 'capybara'
+  spec.add_dependency "cucumber"
+  spec.add_development_dependency "selenium-webdriver"
+end

data/config/cloudtest.config.bak.yml

@@ -0,0 +1,19 @@
+server: "hub-cloud.browserstack.com"
+user: "philipp127"
+key: "vJwJsjXGMKeQw6vDus5x"
+
+common_caps:
+  "browserstack.local": true
+  "browserstack.debug": true # Visual log
+  "acceptSslCerts": true # allow self signed certificates
+  "name": "Bstack-[Capybara] Local Test"
+
+browser_caps:
+  IE:
+    "browser": "IE"
+    "browser_version": "11.0"
+    "os": "Windows"
+    "os_version": "7"
+
+#
+#curl -u "philipp127:vJwJsjXGMKeQw6vDus5x" -X PUT -H "Content-Type: application/json" -d "{\"status\":\"<new-status>\", \"reason\":\"<reason text>\"}" https://api.browserstack.com/automate/sessions/<session-id>.json

data/exe/cloud_test

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/cloud_test/cli'
+# 'cloud_test/cli'
+CloudTest::CLI.start

data/lib/cloud_test.rb

@@ -0,0 +1,34 @@
+require "cloud_test/version"
+require "cloud_test/core"
+
+
+module CloudTest
+  class Error < StandardError; end
+  def self.enabled?
+    ENV.has_key?('CLOUD_TEST')
+  end
+
+  def self.upload_status_to_provider(success:, session_id:, reason: "Unknown")
+    begin
+      Core.upload_status success: success, session_id: session_id, reason: reason
+    rescue StandardError => e
+      puts e.message
+      end
+  end
+  if enabled?
+    config = Core.load_config
+    CloudTest::Core.get_provider_class(config).init config
+  end
+
+  at_exit do # is this better in here or in the cloud_test.rb file with the Before tag?
+    if enabled?
+      if $!.nil? || $!.is_a?(SystemExit) && $!.success? # if test was successful
+        Core.list_dashboard_link
+      else
+        code = $!.is_a?(SystemExit) ? $!.status : 1 #if test was not successful, keep exit code
+        Core.list_dashboard_link
+        exit code
+      end
+    end
+  end
+end

data/lib/cloud_test/browserstack.rb

@@ -0,0 +1,77 @@
+require_relative 'core'
+
+module CloudTest
+  class Browserstack < Core
+    # do anything browserstack specific
+    SERVER = "hub-cloud.browserstack.com/wd/hub"
+    ENV_USER ='BROWSERSTACK_USERNAME'
+    ENV_PWD = 'BROWSERSTACK_ACCESS_KEY'
+    DASHBOARD_LINK = "https://automate.browserstack.com/dashboard"
+    REST_STATUS_SERVER = "https://api.browserstack.com/automate/sessions/"
+
+    def self.init(config=nil)
+      @config = config || Core.load_config(ENV_USER, ENV_PWD)
+      @caps = Core.get_default_caps
+
+      @caps["browserstack.local"] = true
+      @caps["browserstack.debug"] = true # Visual log
+      @caps['os_version']      = '10'
+      @caps['os']              = 'WINDOWS'
+      @caps['browser']         = 'CHROME'
+
+      @caps = Core.merge_caps(@caps, @config, 'browserstack')
+      Capybara.app_host = "http://127.0.0.1:38946"
+      Capybara.server_port = 38946
+      if !config.nil?
+        start()
+      end
+    end
+
+    def self.start
+      puts '> Running features on browserstack.com'
+      begin
+        require 'browserstack/local'
+      rescue LoadError
+        puts 'Please add gem "browserstack-local" to your gemfile!'
+        raise LoadError
+      end
+      # Code to start browserstack local (tunnel) before start of test
+      @bs_local = BrowserStack::Local.new
+      bs_local_args = {"key" => "#{@config['key']}", "logfile" => "log/browserstack-local-logs.log"}
+      @bs_local.start(bs_local_args)
+      register_driver(@caps, @config['user'], @config['key'], SERVER)
+      # Code to stop browserstack local after end of test
+      at_exit do
+        @bs_local.stop unless @bs_local.nil?
+      end
+    end
+
+    def self.list_caps # defaults
+      Core.list_caps
+      puts "Browserstack specific defaults:"
+      puts "\tbrowserstack.local: true"
+      puts "\tbrowserstack.debug: true "
+      puts 'you can generate capabilities here https://www.browserstack.com/automate/capabilities?tag=selenium-2-3'
+    end
+
+    def self.get_all_caps # dry run
+      @caps.kind_of?(Hash) || init()
+      puts "Capabilities: "
+      Core.list_these_caps(@caps)
+    end
+
+    def self.get_status_msg(failed, reason)
+      {
+          "status" => failed ? "passed" : "failed",
+          "reason" => reason
+      }
+    end
+
+    def self.check_session_id(session_id)
+      unless session_id =~ Regexp.new('^[0-9a-z]{40}$')
+        puts session_id << "length: " << session_id.length
+        raise "session_id is invalid!"
+      end
+    end
+  end
+end

data/lib/cloud_test/cli.rb

@@ -0,0 +1,150 @@
+require 'thor'
+require 'cloud_test/generators/config'
+require 'cloud_test/generators/cloud_test_env'
+require_relative 'browserstack'
+require_relative 'lambdatest'
+require_relative 'cross_browser_testing'
+require_relative 'saucelabs'
+
+
+module CloudTest
+  class CLI < Thor
+    desc "list-caps PROVIDER", "Shows the currently applied capabilities of that provider"
+    def list_caps(provider)
+      hash = {"provider" => provider}
+      Core.get_provider_class(hash).get_all_caps
+    end
+
+    desc "list-default-caps PROVIDER", "Shows the default capabilities for that provider"
+    def list_default_caps(provider)
+      hash = {"provider" => provider}
+      Core.get_provider_class(hash).list_caps
+    end
+
+    desc "generate config", "Puts a sample config yml file into /config directory"
+    def generate_config(config)
+      CloudTest::Generators::Config.start([config])
+    end
+
+    desc "generate", "Puts a sample config yml file into /config directory, and additionally put a cloud_test.rb in features/support"
+    option :provider, :aliases => '-p', :default => 'browserstack'
+    def generate()
+      case options[:provider].to_s.downcase
+      when 'lambdatest', 'lt', 'l'
+        provider = 'lambdatest'
+      when 'crossbrowsertesting', 'cbs', 'ct', 'cbt', 'c'
+        provider = 'crossbrowsertesting'
+      when 'saucelabs', 'sauce', 'sc', 'sl', 's'
+        provider = 'saucelabs'
+      else
+        provider = 'browserstack'
+      end
+      CloudTest::Generators::Config.start([provider])
+      CloudTest::Generators::Support.start()
+    end
+
+    desc "cucumber", "Runs bundle exec cucumber sequentially for all defined browsers. Uses the cucumber tag. With -q hide output."
+    option :q
+    def start()
+      require 'open3'
+      config = Core.load_config
+      config['browsers'].keys.each { |browser_config_name|
+        Open3.popen2e({'CLOUD_TEST' =>browser_config_name.to_s}, "bundle" ,"exec", "cucumber", "-t","#{config['cucumber_tag'].to_s}") do |stdin, stdout_err, wait_thr|
+          unless options[:q]
+            while line = stdout_err.gets
+              puts line
+            end
+          end
+          exit_status = wait_thr.value
+          if exit_status == 0
+            puts "Test on browser: #{browser_config_name} was successful!"
+          else
+            puts "Test on browser: #{browser_config_name} was not successful!"
+            puts stdout_err
+            raise "did not work"
+          end
+        end
+      }
+    end
+
+    desc "each COMMANDS", "Runs the COMMAND sequentially for all defined browsers. With -q hide output."
+    option :q
+    def each(*commands)
+      require 'open3'
+      config = Core.load_config
+      config['browsers'].keys.each { |browser_config_name|
+        Open3.popen2e({'CLOUD_TEST' =>browser_config_name.to_s}, commands.join(" ")) do |stdin, stdout_err, wait_thr|
+          unless options[:q]
+            while line = stdout_err.gets
+              puts line
+            end
+          end
+          exit_status = wait_thr.value
+          if exit_status == 0
+            puts "Test on browser: #{browser_config_name} was successful!"
+          else
+            puts "Error on browser: #{browser_config_name}!"
+            puts stdout_err.read
+            puts "Error on browser: #{browser_config_name}!"
+          end
+        end
+      }
+    end
+
+    desc "test-connection", "Test whether the provider and credentials work, by connectiong to the api"
+    def test_connection()
+      require 'net/http'
+      require 'uri'
+      config = CloudTest::Core.load_config
+      request, uri, request, server = Hash.new
+      if config.has_key?('provider') && config.has_key?('user') && config.has_key?('key')
+        case config.delete 'provider'.to_s.downcase
+          when 'browserstack', 'bs', 'b'
+            server = "https://www.browserstack.com/local/v1/list?auth_token=#{config['key']}&last=1"
+          when 'lambdatest', 'lt', 'l'
+            server = "https://api.lambdatest.com/automation/api/v1/tunnels"
+            uri = URI.parse(server)
+            request = Net::HTTP::Get.new(uri)
+            request.basic_auth(config['user'], config['key'])
+          when 'crossbrowsertesting', 'cbs', 'ct', 'cbt', 'c'
+            server = "https://crossbrowsertesting.com/api/v3/tunnels"
+            uri = URI.parse(server)
+            request = Net::HTTP::Get.new(uri)
+            request.basic_auth(config['user'].sub("@", "%40"), config['key'])
+          when 'saucelabs', 'sauce', 'sc', 'sl', 's'
+            server = "https://saucelabs.com/rest/v1/#{config['user']}/tunnels"
+            uri = URI.parse(server)
+            request = Net::HTTP::Get.new(uri)
+            request.basic_auth(config['user'], config['key'])
+        else
+          puts "Unknown provider!"
+          return
+        end
+        uri ||= URI.parse(server)
+        request ||= Net::HTTP::Get.new(uri)
+        request["Accept"] = "application/json"
+        req_options = {
+            use_ssl: uri.scheme == "https",
+        }
+        response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+          http.request(request)
+        end
+        if response.code == '200'
+          puts "Connection successful!"
+        else
+          puts "Connection was not successful! :("
+          puts response.code
+        end
+      else
+        puts "You have not all necessary keys in your config file. `provider`, `user`, `key` are necessary"
+      end
+    end
+    desc 'version', 'Display version'
+    map %w[-v --version] => :version
+
+    def version
+      say "cloud_test version: #{CloudTest::VERSION}"
+    end
+  end
+end
+

data/lib/cloud_test/core.rb

@@ -0,0 +1,180 @@
+require 'selenium/webdriver'
+require 'capybara'
+require 'yaml'
+
+module CloudTest
+  class Core
+    CONFIG_NAME = 'cloud_test'
+
+    def self.get_default_caps
+      @caps = Hash.new
+      @caps['project'] = File.split(Dir.getwd)[-1] # folder name
+      @caps['build'] =   `git rev-parse HEAD || echo buildname` # HEAD commit hash
+      @caps['name'] =    `git log -1 --pretty=%B || echo testname` # HEAD commit message
+      return @caps
+    end
+
+    def self.check_if_input_is_valid?(str)
+      #for all relevant config user input only allow an optional '@' for the cucumber_tag, then some letters, followed by
+      # optional digits
+      # this should enhance security
+      Regexp.new('^@?[A-z]+\d*$') =~ str
+    end
+
+    # the optional parameter could be deleted, or used if someone does not want to put there credentials in the config
+    def self.load_config(env_user='CLOUD_TEST_USER', env_pw='CLOUD_TEST_PW')
+      config = Hash.new
+
+      @caps = self.get_default_caps
+      path = `pwd`.to_s.gsub(/\s+/, "") + "/config/#{CONFIG_NAME}.yml" # complete path to the config file
+      begin
+        config = YAML.load_file(File.absolute_path path)
+        if ENV.has_key?(env_user) && ENV.has_key?(env_pw)
+          config['key'] = ENV[env_pw]
+          config['user'] = ENV[env_user]
+        end
+      rescue SystemCallError
+        puts 'Error: no config file found at: ' + path
+        puts 'Tip: You should run your tests from your main project directory'
+        puts 'Error: I need a config yml file, named ENV["CONFIG_NAME"] or "cloud_test.yml" which has at least a "user" and and "key" pair, thank you!'
+      else
+        if config.has_key?('user') && config.has_key?('key') && config.has_key?('provider') # check wether all the necessary keys exist
+          list_to_check_input = [config['browsers'].keys, (config['cucumber_tag'] if config.has_key?('cucumber_tag')), config['provider']].flatten
+          list_to_check_input.each do |str|
+            if !check_if_input_is_valid?(str)
+              raise "Invalid value: #{str}. Only characters followed by digits are allowed!"
+            end
+          end
+          return config
+        else
+          puts 'Error: I have a config yml file, but no user, key or provider value :('
+          puts "Keys: " + config.keys.to_s
+        end
+      end
+    end
+
+    def self.register_driver(capsArray, user, key, server)
+      # some debugging options
+      url =  "https://#{user.sub("@", "%40")}:#{key}@#{server}"
+      if capsArray.has_key?('cloud_test_debug') and capsArray['cloud_test_debug']
+        puts "Capybara.app_host = #{Capybara.app_host}"
+        puts "Hub url: #{url}"
+        list_these_caps capsArray
+      end
+        Capybara.register_driver :cloud_test do |app|
+          Capybara::Selenium::Driver.new(app,
+                                       :browser => :remote,
+                                       :url => url,
+                                       :desired_capabilities => capsArray
+          )
+        end
+    end
+
+    def self.list_caps # print defaults
+      # this output could be reformatted
+      puts 'These are the defaults:' + """
+      PROJECT : # name of the folder
+      BUILD :  # HEAD commit hash
+      NAME : # HEAD commit message
+      OS : '10'
+      PLATFORM : 'WINDOWS'
+      BROWSER : 'CHROME'"""
+      puts 'Please add additional capabilities in the cloud_test.yml file'
+    end
+
+    def self.list_these_caps(caps)
+      if caps.kind_of?(Enumerable)
+        caps.each do |key, value|
+          puts "|#{key.to_s.ljust(25)}|#{value.to_s.ljust(44)}|\n" # make a nice table like layout
+        end
+      else
+        puts "Error: No caps"
+      end
+    end
+
+    def self.copy_keys(caps, config, keys=config.keys) # a small helper method, to copy keys
+      keys.each do |key|
+        caps[key] = config[key]
+      end
+    end
+
+    def self.merge_caps(caps, config, provider=nil, browser=ENV['CLOUD_TEST']) # config overwrites in case of conflict
+      if !config.kind_of?(Hash)
+        return caps
+      end
+      keys = config.keys - ['common_caps', 'browsers'] # handle those seperatly
+      copy_keys caps, config, keys
+      if provider && config.has_key?(provider) && config[provider].class.included_modules.include?(Enumerable)
+        copy_keys caps, config[provider]
+      end
+      if config.has_key?('common_caps')
+        caps = caps.merge(config['common_caps'])
+      end
+      if config.has_key?('browsers')
+        if config['browsers'].kind_of?(Hash)
+          if !browser.nil? && config['browsers'][browser].nil?
+            puts "There is no browser with the key:#{browser} in your config file!"
+            raise "No matching browser key found!"
+          end
+          caps = caps.merge(config['browsers'][browser || config['browsers'].keys[0]])
+        else
+          caps = caps.merge(config['browsers'])
+        end
+      end
+      return caps
+    end
+
+    def self.get_provider_class(config=load_config)
+      case config.delete('provider').to_s.downcase
+      when 'browserstack', 'bs', 'b'
+        require 'cloud_test/browserstack'
+        return Browserstack
+      when 'lambdatest', 'lt', 'l'
+        require 'cloud_test/lambdatest'
+        return Lambdatest
+      when 'crossbrowsertesting', 'cbs', 'ct', 'cbt', 'c'
+        require 'cloud_test/cross_browser_testing'
+        return CrossBrowserTesting
+      when 'saucelabs', 'sauce', 'sc', 'sl', 's'
+        require 'cloud_test/saucelabs'
+        return Saucelabs
+      else
+        puts "Error: Please add a valid provider to your config file!"
+      end
+    end
+
+    def self.list_dashboard_link
+      puts "link to the dashboard: #{get_provider_class::DASHBOARD_LINK}"
+    end
+
+    def self.upload_status(success:, session_id:, reason: "Unknown")
+      config = load_config
+      provider = get_provider_class config
+      provider.check_session_id session_id
+      puts session_id
+      unless provider::REST_STATUS_SERVER.present?
+        puts "skipping upload, not implementet for your provider yet."
+        return
+      end
+      require 'net/http'
+      require 'uri'
+      require 'json'
+      uri = URI.parse(provider::REST_STATUS_SERVER + session_id )
+      request = Net::HTTP::Put.new(uri)
+      request.basic_auth(config['user'], config['key'])
+      request.content_type = "application/json"
+      request.body = JSON.dump(provider.get_status_msg(success, reason))
+      req_options = {
+          use_ssl: uri.scheme == "https",
+      }
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+      if response.code != '200'
+        puts "Response Code: #{response.code}"
+        puts "Status upload error!"
+      end
+
+    end
+  end
+end