pretest 1.12.0

data/README.md

@@ -0,0 +1,69 @@
+
+<h1>Pretest</h1>
+
+<p>
+Pretest is a gem that helps you to start your automation projects. With pretest you can start and configure your environment for web and mobile automation projects with just a few commands.
+</p>
+
+[![Gem Version](https://badge.fury.io/rb/pretest@2x.png)](https://badge.fury.io/rb/pretest)
+
+<h2>Requirements</h2>
+
+<p>
+Ruby installed in your machine (we recommend ruby 32 bits version if you're using Windows, and at least Windows 7 or a newer version) and the browsers that you want to use in your web automation (except for the phantomjs, that is installed automatically if the command "pretest environment" is used).
+
+If you're having problems with firefox, we recommend to use the version 47.0.1 (https://ftp.mozilla.org/pub/firefox/releases/) due to issues with webdriver on newer versions.
+</p>
+
+<h2>Installation</h2>
+
+    gem install pretest
+
+<h2>How to use</h2>
+
+<p>
+For this we have some commands that can configure your environment for tests with chromedriver / phantomjs / IEDriverServer, and then its created a new folder that can be used to store others Webdriver's that you can use for your automations projects.
+We have commands to create a new project structure, and a new project scaffold with examples of steps / features / and pages already created, that you can use to start to learn and create your own projects.
+</p>
+
+<h2>Commands</h2>
+
+<ul>
+<li>pretest</li>
+<li>pretest help [COMMAND]</li>
+<li>pretest environment</li>
+<li>pretest create project_name</li>
+<li>pretest create project_name --web_scaffold</li>
+<li>pretest create project_name --api</li>
+<li>pretest create project_name --api_scaffold</li>
+</ul>
+
+<h2>Usage</h2>
+
+<p>
+<strong>pretest:</strong> This command is used to list all the actual commands released in pretest
+</p>
+
+<p>
+<strong>pretest help [COMMAND]:</strong> This command is used to list the actual command options (example: "pretest help create")
+</p>
+
+<p>
+<strong>pretest environment:</strong> This command is used to configure your environment variables, download the webdrivers that can be use in your projects and install a development tool to compile your code (just if needed).
+</p>
+
+<p>
+<strong>pretest create project_name:</strong> This command is used to create a new project for web automation with all the structure already created and environment configured.
+</p>
+
+<p>
+<strong>pretest create project_name --web_scaffold:</strong> This command is used to create a new project for web automation with all the structure already created and environment configured, including some steps, features and pages with examples that can be used to develop new tests cases.
+</p>
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Lemon-Studio/pretest.
+
+## License
+
+The code licensed here under the GNU Affero General Public License, version 3 AGPL-3.0. [GNU AGPL 3.0 License](https://github.com/Lemon-Studio/pretest/blob/master/LICENSE.txt). Pretest has been developed by the LemonStudioLTDA team (Lucas Machado and Murilo Machado), as detailed in [LemonStudioLTDA Website](http://www.vilasboasit.com).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pretest'
+
+# 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

data/bin/pretest

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby -U
+
+require 'pretest/cli'
+
+Pretest::StructureGenerator.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/pretest.rb

@@ -0,0 +1,2 @@
+require 'pretest/version'
+require 'pretest/cli'

data/lib/pretest/cli.rb

@@ -0,0 +1,59 @@
+require 'thor'
+require 'pretest/structure/clone'
+require 'pretest/environment/check'
+require 'pretest/mobile/environment'
+
+module Pretest
+  class StructureGenerator < Thor
+    desc 'create [NAME]', 'This will generate your project structure'
+    method_option :web, type: :boolean, desc:
+      'Create a Web Automation Project Structure'
+    method_option :web_scaffold, type: :boolean, desc:
+      'Creates a Web Automation Project Structure with some steps,' \
+      ' pages and features already created'
+    method_option :api, type: :boolean, desc:
+      'Create a API Automation Project Structure'
+    method_option :api_scaffold, type: :boolean, desc:
+      'Creates a API Automation Project Structure with some steps ' \
+      'and features already created'
+    method_option :clean_install, type: :boolean, desc:
+      'Creates a Clean Web Automation Project Structure'
+    method_option :ios, type: :boolean, desc:
+      'Create a iOS Mobile Automation Project Structure'
+    method_option :android, type: :boolean, desc:
+      'Create a Android Mobile Automation Project Structure'
+
+    def create(name)
+      web           = options[:web]           ? 'true' : 'false'
+      web_scaffold  = options[:web_scaffold]  ? 'true' : 'false'
+      api           = options[:api]           ? 'true' : 'false'
+      api_scaffold  = options[:api_scaffold]  ? 'true' : 'false'
+      clean_install = options[:clean_install] ? 'true' : 'false'
+      ios           = options[:ios]           ? 'true' : 'false'
+      android       = options[:android]       ? 'true' : 'false'
+
+      Pretest::Structure::Clone.start([name,
+                                       web,
+                                       web_scaffold,
+                                       api,
+                                       api_scaffold,
+                                       clean_install,
+                                       ios,
+                                       android])
+    end
+
+    desc 'environment', 'Check, configure, and install environment ' \
+                        'variables and webdrivers in the current OS'
+
+    def environment
+      Pretest::Environment::Check.start
+    end
+
+    desc 'mobile_environment [ENVIRONMENT]', 'Check, configure and' \
+                                             ' install environment variables and sdk path in the current OS'
+
+    def mobile_environment(env)
+      Pretest::Mobile::Environment.start([env])
+    end
+  end
+end

data/lib/pretest/config/linux.rb

@@ -0,0 +1,60 @@
+require_relative 'unix'
+
+module Linux
+  include Unix
+  def set_linux_env
+    puts 'Installing ChromeDriver'
+    set_linux_chromedriver
+    puts 'Installing PhantomJS'
+    set_linux_phantomjs
+    puts 'Installing GeckoDriver'
+    set_linux_geckodriver
+  end
+
+  private
+
+  def set_linux_chromedriver
+    remove_bin('chromedriver')
+    system "sudo rm -rf chromedriver_linux#{@bits}.zip" if Dir.entries('.').include?("chromedriver_linux#{@bits}.zip")
+    system "sudo rm -rf chromedriver_linux#{@bits}" if Dir.entries('.').include?("chromedriver_linux#{@bits}")
+    system "sudo curl -OL http://chromedriver.storage.googleapis.com/2.45/chromedriver_linux#{@bits}.zip"
+    system "sudo unzip chromedriver_linux#{@bits}.zip"
+    system 'sudo chmod +x chromedriver'
+    system 'sudo mv -f chromedriver /usr/local/bin/chromedriver'
+    system "sudo rm -rf chromedriver_linux#{@bits}.zip"
+    puts 'done!'
+  rescue StandardError => e
+    puts "Something went wrong with chromedriver instalation, if the following message did not help with the solution, please submit this message to our Repository in 'https://github.com/Lemon-Studio/pretest/issues'\n\n" \
+         "#{e}\n\n"
+  end
+
+  def set_linux_geckodriver
+    remove_bin('geckodriver')
+    system 'sudo rm -rf geckodriver-v0.23.0-linux64.tar.gz' if Dir.entries('.').include?('geckodriver-v0.23.0-linux64.tar.gz')
+    system 'sudo rm -rf geckodriver-v0.23.0-linux64' if Dir.entries('.').include?('geckodriver-v0.23.0-linux64')
+    system 'sudo curl -OL https://github.com/mozilla/geckodriver/releases/download/v0.23.0/geckodriver-v0.23.0-linux64.tar.gz'
+    system 'sudo tar -xvzf geckodriver-v0.23.0-linux64.tar.gz'
+    system 'sudo chmod +x geckodriver'
+    system 'sudo mv -f geckodriver /usr/local/bin/geckodriver'
+    system 'sudo rm -rf geckodriver-v0.23.0-linux64.tar.gz'
+    puts 'done!'
+  rescue StandardError => e
+    puts "Something went wrong with geckodriver instalation, if the following message did not help with the solution, please submit this message to our Repository in 'https://github.com/Lemon-Studio/pretest/issues'\n\n" \
+         "#{e}\n\n"
+  end
+
+  def set_linux_phantomjs
+    remove_bin('phantomjs')
+    system "sudo rm -rf phantomjs-2.1.1-#{@phantomjs_bits}.tar.bz2" if Dir.entries('.').include?("phantomjs-2.1.1-#{@phantomjs_bits}.tar.bz2")
+    system "sudo rm -rf phantomjs-2.1.1-#{@phantomjs_bits}" if Dir.entries('.').include?("phantomjs-2.1.1-#{@phantomjs_bits}")
+    system "sudo curl -OL https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-2.1.1-#{@phantomjs_bits}.tar.bz2"
+    system "sudo tar xvjf phantomjs-2.1.1-#{@phantomjs_bits}.tar.bz2 > /dev/null"
+    system "sudo chmod +x phantomjs-2.1.1-#{@phantomjs_bits}/bin/phantomjs"
+    system "sudo mv -f phantomjs-2.1.1-#{@phantomjs_bits}/bin/phantomjs /usr/local/bin"
+    system "sudo rm -rf phantomjs-2.1.1-#{@phantomjs_bits}.tar.bz2"
+    puts 'done!'
+  rescue StandardError => e
+    puts "Something went wrong with phantomjs instalation, if the following message did not help with the solution, please submit this message to our Repository in 'https://github.com/Lemon-Studio/pretest/issues'\n\n" \
+         "#{e}\n\n"
+  end
+end

data/lib/pretest/config/mac.rb

@@ -0,0 +1,74 @@
+require_relative 'unix'
+
+module MacOS
+  include Unix
+  def set_mac_env
+    puts 'Installing/checking HomeBrew'
+    mac_update_brew
+    puts 'Installing PhantomJS'
+    mac_phantomjs_installer
+    puts 'Installing ChromeDriver'
+    mac_chromedriver_installer
+    puts 'Installing/Checking Xcode'
+    system 'xcode-select --install > /dev/null'
+    puts 'done!'
+    puts 'Installing GeckoDriver'
+    mac_gecko_installer
+  end
+
+  private
+
+  def mac_update_brew
+    system "which -s brew
+    if [[ $? != 0  ]] ; then
+    ruby -e '$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)'
+    fi > /dev/null"
+    puts 'done!'
+  end
+
+  def mac_chromedriver_installer
+    remove_bin('chromedriver')
+    system 'sudo rm -rf chromedriver_mac64.zip' if Dir.entries('.').include?('chromedriver_mac64.zip')
+    system 'sudo rm -rf chromedriver_mac64' if Dir.entries('.').include?('chromedriver_mac64')
+    system 'sudo curl -OL https://chromedriver.storage.googleapis.com/2.45/chromedriver_mac64.zip'
+    system 'sudo unzip chromedriver_mac64.zip > /dev/null'
+    system 'sudo chmod +x chromedriver'
+    system 'sudo mv -f chromedriver /usr/local/bin'
+    system 'sudo rm -rf chromedriver_mac64.zip'
+    puts 'done!'
+  rescue StandardError => e
+    puts "Something went wrong with chromedriver instalation, if the following message did not help with the solution, please submit this message to our Repository in 'https://github.com/Lemon-Studio/pretest/issues'\n\n" \
+         "#{e}\n\n"
+  end
+
+  def mac_gecko_installer
+    remove_bin('geckodriver')
+    system 'sudo rm -rf geckodriver-v0.23.0-macos.tar.gz' if Dir.entries('.').include?('geckodriver-v0.23.0-macos.tar.gz')
+    system 'sudo rm -rf geckodriver' if Dir.entries('.').include?('geckodriver')
+    system 'curl -OL https://github.com/mozilla/geckodriver/releases/download/v0.23.0/geckodriver-v0.23.0-macos.tar.gz'
+    system 'sudo tar xvjf geckodriver-v0.23.0-macos.tar.gz'
+    system 'sudo chmod +x geckodriver'
+    system 'sudo mv -f geckodriver /usr/local/bin'
+    system 'sudo rm -rf geckodriver-v0.23.0-macos.tar.gz'
+    puts 'done!'
+  rescue StandardError => e
+    puts "Something went wrong with geckodriver instalation, if the following message did not help with the solution, please submit this message to our Repository in 'https://github.com/Lemon-Studio/pretest/issues'\n\n" \
+         "#{e}\n\n"
+  end
+
+  def mac_phantomjs_installer
+    remove_bin('phantomjs')
+    system 'sudo rm -rf phantomjs-2.1.1-macosx.zip' if Dir.entries('.').include?('phantomjs-2.1.1-macosx.zip')
+    system 'sudo rm -rf phantomjs-2.1.1-macosx' if Dir.entries('.').include?('phantomjs-2.1.1-macosx')
+    system 'sudo curl -OL https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-2.1.1-macosx.zip'
+    system 'unzip phantomjs-2.1.1-macosx.zip > /dev/null'
+    system 'sudo chmod +x phantomjs-2.1.1-macosx/bin/phantomjs'
+    system 'sudo mv -f phantomjs-2.1.1-macosx/bin/phantomjs /usr/local/bin'
+    system 'sudo rm -rf phantomjs-2.1.1-macosx.zip'
+    system 'sudo rm -rf phantomjs-2.1.1-macosx'
+    puts 'done!'
+  rescue StandardError => e
+    puts "Something went wrong with phantomjs instalation, if the following message did not help with the solution, please submit this message to our Repository in 'https://github.com/Lemon-Studio/pretest/issues'\n\n" \
+         "#{e}\n\n"
+  end
+end

data/lib/pretest/config/operational_system.rb

@@ -0,0 +1,34 @@
+require_relative 'mac'
+require_relative 'linux'
+require_relative 'windows'
+require_relative 'unix'
+
+module Config
+  include MacOS
+  include Linux
+  include Windows
+  # include Unix
+  def mac?
+    !(/darwin/ =~ RUBY_PLATFORM).nil?
+  end
+
+  def windows?
+    !(/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM).nil?
+  end
+
+  def unix?
+    !windows?
+  end
+
+  def linux?
+    unix? && !mac?
+  end
+
+  def set_bits
+    if RUBY_PLATFORM.include?('32') && !RUBY_PLATFORM.include?('64')
+      (@bits = '32') && (@phantomjs_bits = 'linux-i686') && (@devkit = '32-4.7.2-20130224-1151')
+    else
+      (@bits = '64') && (@phantomjs_bits = 'linux-x86_64') && (@devkit = '64-4.7.2-20130224-1432')
+    end
+  end
+end

data/lib/pretest/config/unix.rb

@@ -0,0 +1,21 @@
+require 'rest-client'
+require 'open-uri'
+require 'fileutils'
+require 'open3'
+require 'pry'
+
+module Unix
+  def remove_bin(file)
+    output, _status = Open3.capture2("which #{file}")
+    return false if output.nil?
+    return false if output.empty?
+
+    output = output.delete("\n") unless output.empty?
+    until output.empty?
+      system "sudo rm -rf #{output}"
+      output, _status = Open3.capture2("which #{file}").delete("\n")
+      output = '' if output.nil?
+      output = output.delete("\n") unless output.empty?
+    end
+  end
+end

data/lib/pretest/config/windows.rb

@@ -0,0 +1,135 @@
+require 'fileutils'
+
+module Windows
+  def set_windows_env
+    Dir.mkdir('C:\\env_folder') unless Dir.entries('C:\\').include?('env_folder')
+    Dir.chdir('C:\\env_folder')
+    @ruby = get_ruby_path
+    puts "We're going to move the webdrivers to '#{@ruby}'"
+    puts 'Downloading webdrivers to C:\\env_folder'
+    windows_download
+    puts 'Unziping webdrivers files'
+    unzip_windows_files
+    puts 'Checking Ruby Development Kit...'
+    dk_check_and_install
+    move_webdrivers
+  end
+
+  private
+
+  def unzip_file(file, destination)
+    Zip::File.open(file) do |zip_file|
+      zip_file.each do |f|
+        f_path = File.join(destination, f.name)
+        FileUtils.mkdir_p(File.dirname(f_path))
+        f.extract(f_path)
+      end
+    end
+    system "del #{file}"
+  end
+
+  def zip_download(name, url)
+    zipfile = url
+    resource = RestClient::Resource.new(
+      zipfile,
+      timeout: 120,
+      open_timeout: 60
+    )
+    response = resource.get
+    if response.code == 200
+      f = File.new(name, 'wb')
+      f << response.body
+      f.close
+      puts "#{name} Download Complete"
+    else
+      puts "#{name} Download Failed"
+      raise("Response Code was not 200: Response Code #{response.code}")
+    end
+  end
+
+  def windows_download
+    set_bits
+    Dir.chdir('C:\\env_folder')
+
+    FileUtils.rm_rf('C:\\env_folder\\phantomjs-2.1.1-windows.zip') if Dir.entries('C:\\env_folder').include?('phantomjs-2.1.1-windows.zip')
+    FileUtils.rm_rf('C:\\env_folder\\IEDriverServer_Win32_3.4.0.zip') if Dir.entries('C:\\env_folder').include?('IEDriverServer_Win32_3.4.0.zip')
+    FileUtils.rm_rf("C:\\env_folder\\geckodriver-v0.23.0-win#{@bits}.zip") if Dir.entries('C:\\env_folder').include?("geckodriver-v0.23.0-win#{@bits}.zip")
+    FileUtils.rm_rf('C:\\env_folder\\chromedriver_win32.zip') if Dir.entries('C:\\env_folder').include?('chromedriver_win32.zip')
+
+    FileUtils.rm_rf('C:\\env_folder\\chromedriver.exe') if Dir.entries('C:\\env_folder').include?('chromedriver.exe')
+    FileUtils.rm_rf('C:\\env_folder\\IEDriverServer.exe') if Dir.entries('C:\\env_folder').include?('IEDriverServer.exe')
+    FileUtils.rm_rf('C:\\env_folder\\geckodriver.exe') if Dir.entries('C:\\env_folder').include?('geckodriver.exe')
+    FileUtils.rm_rf('C:\\env_folder\\phantomjs-2.1.1-windows') if Dir.entries('C:\\env_folder').include?('phantomjs-2.1.1-windows')
+    FileUtils.rm_rf('C:\\env_folder\\phantomjs.exe') if Dir.entries('C:\\env_folder').include?('phantomjs.exe')
+
+    zip_download('chromedriver_win32.zip', 'https://chromedriver.storage.googleapis.com/2.45/chromedriver_win32.zip') unless Dir.entries('.').include?('chromedriver_win32.zip') || Dir.entries('.').include?('chrome.exe')
+    zip_download('phantomjs-2.1.1-windows.zip', 'https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-2.1.1-windows.zip') unless Dir.entries('.').include?('phantomjs-2.1.1-windows.zip') || Dir.entries('.').include?('phantomjs.exe')
+    zip_download('IEDriverServer_Win32_3.4.0.zip', 'http://selenium-release.storage.googleapis.com/3.4/IEDriverServer_Win32_3.4.0.zip') unless Dir.entries('.').include?('IEDriverServer_Win32_3.4.0.zip') || Dir.entries('.').include?('IEDriverServer.exe')
+    zip_download("geckodriver-v0.23.0-win#{@bits}.zip", "https://github.com/mozilla/geckodriver/releases/download/v0.23.0/geckodriver-v0.23.0-win#{@bits}.zip") unless Dir.entries('.').include?("geckodriver-v0.23.0-win#{@bits}") || Dir.entries('.').include?('geckodriver.exe')
+  end
+
+  def unzip_windows_files
+    set_bits
+    unzip_file('chromedriver_win32.zip', '.') unless Dir.entries('.').include?('chromedriver.exe')
+    unzip_file('phantomjs-2.1.1-windows.zip', '.') unless Dir.entries('.').include?('phantomjs.exe') || File.directory?('phantomjs-2.1.1-windows')
+    unzip_file('IEDriverServer_Win32_3.4.0.zip', '.') unless Dir.entries('.').include?('IEDriverServer.exe')
+    unzip_file("geckodriver-v0.23.0-win#{@bits}.zip", '.') unless Dir.entries('.').include?('geckodriver.exe')
+  end
+
+  def dk_check_and_install
+    set_bits
+    rbenv  = ''
+    rbpath = ''
+    rblist = ''
+    rbenv += ENV['PATH']
+    raise 'There is no Ruby environment variable defined in current PATH' if ENV['PATH'].include?('Ruby') == false
+
+    rbenv = rbenv.split(';')
+    rbenv.each do |rb|
+      rbpath = rb if rb.include?('Ruby')
+    end
+    rbpath = rbpath.gsub!('bin', 'lib\\ruby\\site_ruby\\')
+    Dir.entries(rbpath).each { |files| rblist << files.to_s }
+    if rblist.include?('devkit')
+    else
+      zip_download("DevKit-mingw64-#{@devkit}-sfx.exe", "http://dl.bintray.com/oneclick/rubyinstaller/DevKit-mingw64-#{@devkit}-sfx.exe")
+      unzip_install_dk("DevKit-mingw64-#{@devkit}-sfx.exe")
+    end
+  end
+
+  def unzip_install_dk(file)
+    Dir.chdir('C:\\env_folder')
+    FileUtils.rm_rf('C:\\env_folder\\devkit') if Dir.entries('C:\\env_folder').include?('devkit')
+    Dir.mkdir('devkit')
+    FileUtils.mv(file.to_s, 'C:\\env_folder\\devkit\\')
+    Dir.chdir('devkit')
+    system "#{file} -o '.' -y"
+    system "del #{file}"
+    system 'ruby dk.rb init'
+    system 'ruby dk.rb install'
+  end
+
+  def move_webdrivers
+    FileUtils.rm_rf("#{@ruby}}\\phantomjs.exe") if Dir.entries(@ruby).include?('phantomjs.exe')
+    FileUtils.rm_rf("#{@ruby}}\\geckodriver.exe") if Dir.entries(@ruby).include?('geckodriver.exe')
+    FileUtils.rm_rf("#{@ruby}}\\chromedriver.exe") if Dir.entries(@ruby).include?('chromedriver.exe')
+    FileUtils.rm_rf("#{@ruby}}\\IEDriverServer.exe") if Dir.entries(@ruby).include?('IEDriverServer.exe')
+
+    FileUtils.mv('C:\\env_folder\\phantomjs-2.1.1-windows\\bin\\phantomjs.exe', @ruby)
+    FileUtils.mv('C:\\env_folder\\chromedriver.exe', @ruby)
+    FileUtils.mv('C:\\env_folder\\IEDriverServer.exe', @ruby)
+    FileUtils.mv('C:\\env_folder\\geckodriver.exe', @ruby)
+
+    FileUtils.rm_rf('C:\\env_folder\\phantomjs-2.1.1-windows') if Dir.entries('.').include?('phantomjs-2.1.1-windows')
+  end
+
+  def get_ruby_path
+    env = ENV['PATH'].split(';')
+    rb_path = env.each do |path|
+      return path if path.upcase.include?('RUBY') && path.upcase.include?('BIN')
+    end
+    raise "We couldn't locate the ruby installed on the current machine" if rb_path.nil?
+
+    rb_path
+  end
+end