SimpliTest 0.0.1

data/lib/SimpliTest/config/directory_paths.rb

@@ -0,0 +1,36 @@
+require 'yaml'
+require 'pathname'
+require 'SimpliTest/helpers/project_setup'
+# exports instance variables for various directories of interest in the gem and the satelite projects
+module SimpliTest
+  extend ProjectSetupHelpers
+  @config_dir = File.dirname(__FILE__)
+  @SimpliTest_dir = Pathname.new( @config_dir).parent.to_s
+  @helpers_dir = File.join(@SimpliTest_dir, 'helpers')
+  @steps_dir = File.join(@SimpliTest_dir, 'steps')
+  @step_helpers_dir = File.join(@helpers_dir, 'step_helpers')
+  @templates_dir = File.join(@SimpliTest_dir, 'templates')
+  @lib_dir = Pathname.new(@SimpliTest_dir).parent.to_s
+  @tasks_dir = File.join(@SimpliTest_dir, 'tasks')
+  @gem_dir = Pathname.new(@lib_dir).parent.to_s
+  class << self
+    #TODO: Using method missing despite all the reasons not to
+    #FIXME: Get rid of this
+    def method_missing(meth, *args, &block)
+      if match = meth.to_s.match(/^config_(.+)$/)
+        config[match[1].to_sym]
+      elsif match = meth.to_s.match(/^path_to_(.+)$/)
+        instance_variable_get("@#{match[1]}")
+      else
+        super # You *must* call super if you don't handle the
+        # method, otherwise you'll mess up Ruby's method
+        # lookup.
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      method_name.to_s.start_with?('config_') || meth.to_s.start_with?('path_to_') || super
+    end
+  end
+
+end

data/lib/SimpliTest/config/environment.rb

@@ -0,0 +1,67 @@
+require 'capybara'
+require 'capybara/cucumber'
+require 'capybara/dsl'
+require 'rspec'
+require "nokogiri"
+require 'open-uri'
+require_relative './local_environment'
+require_relative './screen_size'
+require_relative './steps'
+require File.join(SimpliTest.path_to_helpers_dir, 'project_setup')
+RSpec.configure do |config|
+  config.include Capybara::DSL
+end
+
+Capybara.save_and_open_page_path = File.expand_path(File.join(SimpliTest.config_support_directory,'../../tmp')) if SimpliTest.config[:support_directory]
+Capybara.default_max_wait_time = 2
+
+driver = SimpliTest.driver #default is selenium
+profiles_dir = File.join(File.dirname(__FILE__), 'profiles')
+profiles = {
+  'phantomjs' => 'phantom',
+  'phantom_debug' => 'phantom_debug',
+  'chrome' => 'chrome',
+  'selenium' => 'selenium',
+  'ie' => 'internet_explorer',
+  'fire' => 'firefox'
+}
+profile = File.join profiles_dir, profiles[driver]
+require profile
+puts "Loaded Environment"
+
+
+
+#Leave the window open after a test fails if this tag is provided
+After('@leave_the_window_open') do |scenario|
+  if scenario.respond_to?(:status) && scenario.status == :failed
+    print "Step Failed. Press Return to close browser"
+    STDIN.getc
+  end
+end
+
+Before do |s|
+#  if SimpliTest.env_or_setting('JIRA_INTEGRATION_ENABLED') && SimpliTest.env_or_setting('JIRA_URL')
+ #   $has_jira_info ||= false
+ #   return $has_jira_info if $has_jira_info
+ #   $jira = SimpliTest::JiraIntegration.load_project_details
+ #   $has_jira_info = true
+ # end
+end
+
+After do |s|
+
+  #Reuse Browser sessions
+if SimpliTest.config[:settings]['REUSE_BROWSER_SESSIONS']
+  Capybara.current_session.instance_variable_set('@touched', !SimpliTest.config[:settings]['REUSE_BROWSER_SESSIONS'])
+else
+  Capybara.current_session.instance_variable_set('@touched', true)
+end  
+
+  # Tell Cucumber to quit after this scenario is done - if it failed.
+        #Cucumber.wants_to_quit = true if SimpliTest.config[:settings][QUIT_ON_FAIL] && s.failed?
+        #zephyr_reporter = SimpliTest::JiraIntegration.new(s)
+        #zephyr_reporter.report
+end
+
+
+

data/lib/SimpliTest/config/local_environment.rb

@@ -0,0 +1,20 @@
+module SimpliTest
+  def self.gems_installed?(list)
+    specs = []
+    list.each do |gem|
+      dep = Gem::Dependency.new(gem)
+      specs << !dep.matching_specs.empty?
+    end
+    specs.uniq == [true]
+  end
+
+  def self.chromedriver_detected?
+    installed = `chromedriver --help` rescue false
+    installed ? true : false
+  end
+
+  def self.env_or_setting(setting_name)
+    ENV[setting_name] || SimpliTest.config_settings[setting_name]
+  end
+end
+

data/lib/SimpliTest/config/profiles/chrome.rb

@@ -0,0 +1,18 @@
+if SimpliTest.chromedriver_detected?
+  require 'selenium/webdriver'
+  Capybara.register_driver :chrome do |app|
+    Capybara::Selenium::Driver.new(app, :browser => :chrome)
+  end
+
+  Before do
+    Capybara.current_driver = :chrome
+    Capybara.javascript_driver = :chrome
+  end
+
+  World(CustomSeleniumHelpers)
+  World(CustomChromeHelpers)
+else
+  alert "Could not find ChromeDriver. Please make sure it is installed and try again"
+end
+
+

data/lib/SimpliTest/config/profiles/firefox.rb

@@ -0,0 +1,14 @@
+
+Capybara.register_driver :firefox do |app|
+ require 'selenium/webdriver'
+  profile = Selenium::WebDriver::Firefox::Profile.new
+  profile.native_events = true
+ Capybara::Selenium::Driver.new(app, :browser => :firefox)
+end
+
+Before do
+  Capybara.current_driver = :firefox
+  SimpliTest.driver = 'firefox'
+end
+
+World(CustomSeleniumHelpers)

data/lib/SimpliTest/config/profiles/internet_explorer.rb

@@ -0,0 +1,12 @@
+
+Capybara.register_driver :internet_explorer do |app|
+ require 'selenium/webdriver'
+ Capybara::Selenium::Driver.new(app, :browser => :internet_explorer)
+end
+
+Before do
+  Capybara.current_driver = :internet_explorer
+  SimpliTest.driver = 'internet_explorer'
+end
+
+World(CustomSeleniumHelpers)

data/lib/SimpliTest/config/profiles/phantom.rb

@@ -0,0 +1,9 @@
+require 'capybara/poltergeist'
+Before do
+  Capybara.current_driver = :poltergeist
+  Capybara.javascript_driver = :poltergeist
+  SimpliTest.driver= 'poltergeist'
+end
+
+World(CustomPhantomjsHelpers)
+

data/lib/SimpliTest/config/profiles/phantom_debug.rb

@@ -0,0 +1,12 @@
+require 'capybara/poltergeist'
+Capybara.register_driver :poltergeist_debug do |app|
+  Capybara::Poltergeist::Driver.new(app, :inspector => true)
+end
+
+Before do
+  Capybara.current_driver = :poltergeist_debug
+  Capybara.javascript_driver = :poltergeist_debug
+  SimpliTest.driver = 'poltergeist'
+end
+
+World(CustomPhantomjsHelpers)

data/lib/SimpliTest/config/profiles/selenium.rb

@@ -0,0 +1,13 @@
+Capybara.register_driver :selenium do |app|
+  require 'selenium/webdriver'
+  profile = Selenium::WebDriver::Firefox::Profile.new
+  profile.native_events = true
+  Capybara::Selenium::Driver.new(app, :browser => :firefox, profile: profile)
+end
+
+Before do
+  Capybara.current_driver = :selenium
+  SimpliTest.driver = 'selenium'
+end
+
+World(CustomSeleniumHelpers)

data/lib/SimpliTest/config/screen_size.rb

@@ -0,0 +1,25 @@
+
+desktop_max_height = SimpliTest.config[:settings]["DESKTOP_MAX_HEIGHT"] || 980
+desktop_max_width = SimpliTest.config[:settings]["DESKTOP_MAX_WIDTH"] || 1045
+mobile_max_height = SimpliTest.config[:settings]["MOBILE_MAX_HEIGHT"] || 868
+mobile_max_width = SimpliTest.config[:settings]["MOBILE_MAX_WIDTH"] || 362
+tablet_max_height= SimpliTest.config[:settings]["TABLET_MAX_HEIGHT"] || 868
+tablet_max_width = SimpliTest.config[:settings]["TABLET_MAX_WIDTH"] || 814
+landscape_max_height = SimpliTest.config[:settings]["LANDSCAPE_MAX_HEIGHT"] || 362
+landscape_max_width = SimpliTest.config[:settings]["LANDSCAPE_MAX_WIDTH"] || 522
+
+
+case SimpliTest.screen_size
+when "Mobile"
+  MAX_HEIGHT = mobile_max_height
+  MAX_WIDTH =  mobile_max_width
+when "Tablet"
+  MAX_HEIGHT = tablet_max_height
+  MAX_WIDTH =  tablet_max_width
+when "Desktop"
+  MAX_HEIGHT = desktop_max_height
+  MAX_WIDTH =  desktop_max_width
+when "Landscape"
+  MAX_HEIGHT = landscape_max_height
+  MAX_WIDTH =  landscape_max_width
+end

data/lib/SimpliTest/config/steps.rb

@@ -0,0 +1,8 @@
+require 'uri'
+require 'cgi'
+load_directories =  [File.join(SimpliTest.path_to_steps_dir, '*.rb'), File.join(SimpliTest.path_to_step_helpers_dir, '*.rb')]
+load_directories.each do |dir|
+  Dir[dir].each {|file| require file }
+end
+
+

data/lib/SimpliTest/helpers/data_validation.rb

@@ -0,0 +1,60 @@
+require 'json'
+require 'erb'
+require 'ostruct'
+require 'net/http'
+# monkey patching Hash for an intersection method
+class Hash
+  def &(other)
+    reject { |k, v| !(other.include?(k) && other[k] == v) }
+  end
+end
+
+
+module SimpliTest
+  module DataValidationHelpers
+    def validate_service_against(db, service_dir, variables)
+      require File.join(service_dir, 'mapper')
+      #TODO: Horrible hard coding temporarily...will fix later
+      SimpliTest.configure( {:support_directory => File.join(@project_path, 'features', 'support')})
+      @service_dir = service_dir
+      query_results = get_data_from_db(db, variables)
+      if defined?(map_service_results)
+        service_results = map_service_results(get_data_from_service(variables))
+        query_results.each_with_index do |result, index|
+          if result & service_results[index] == service_results[index]
+            puts "Passed"
+          else
+            raise "Test Failed for #{service_results[index]}"
+          end
+        end
+      else
+        raise "It seems you have not defined a mapper for this service yet!"
+      end
+    end
+
+    def get_data_from_db(db, variables)
+      query = preprocess_template('query.sql', variables)
+      db.execute query
+    end
+
+    def get_data_from_service(variables)
+      service = YAML.load(preprocess_template('service.yml', variables))
+      service_path = service['url']
+      uri = service_url_for service_path
+      JSON.parse Net::HTTP.get(uri)
+    end
+
+    def preprocess_template(file, variables)
+      template = File.read(File.join(@service_dir, file))
+      ERB.new(template).result(OpenStruct.new(variables).instance_eval { binding })
+    end
+
+    def service_url_for(path)
+      uri = URI.parse(path)
+      service_host = SimpliTest.config[:environments][SimpliTest.config_environment + "_Services"]
+      service_host = SimpliTest.config[:environments][SimpliTest.config_environment] unless service_host
+      uri.absolute? ? uri : URI.parse(service_host + path)
+    end
+
+  end
+end

data/lib/SimpliTest/helpers/file.rb

@@ -0,0 +1,38 @@
+module FileHelpers
+  require 'fileutils'
+
+  def make_directory(dirname)
+    FileUtils.mkdir_p(dirname)
+  end
+
+  def copy_file(source, target)
+    FileUtils.cp(source, target)
+  end
+
+  def copy_folder(source, target)
+    FileUtils.copy_entry(source, target)
+  end
+
+  def make_subdirectories_in(directory, *subdirectories)
+    subdirectories.each do |subdir|
+      FileUtils.mkdir_p(File.join(directory, subdir))
+    end
+  end
+
+  def template_path_to(*args)
+    relative_path = args.join(File::Separator)
+    File.join(SimpliTest.path_to_templates_dir, relative_path)
+  end
+
+  def copy_file_with_replacement_args(template_name, target_location, args={})
+    file = File.open(template_path_to(template_name))
+    content = file.read
+    target_location = File.join(@pwd, template_name) unless target_location
+    args.each do |key, value|
+      content = content.gsub(/#{key}/,value )
+    end
+    File.open(target_location, 'w') { |f| f.write(content) }
+  end
+
+
+end

data/lib/SimpliTest/helpers/project_setup.rb

@@ -0,0 +1,186 @@
+module ProjectSetupHelpers
+
+  #*****************************REQUIRES/INCLUDE/EXTEND******************************************
+  require 'rbconfig'
+  require File.join(File.dirname(__FILE__), 'file.rb')
+  require File.join(File.dirname(__FILE__), 'windows_ui.rb') 
+
+  def self.included klass #always include FileHelpers/WindowsUIHelpers with this module
+    klass.class_eval do
+      include FileHelpers
+      include WindowsUIHelpers
+    end
+  end
+
+  def self.extended klass #always extend FileHelpers/WindowsUIHelpers with this module
+    klass.class_eval do
+      extend FileHelpers
+      extend WindowsUIHelpers
+    end
+  end
+
+  #**********************************PLATFORM****************************************************
+
+  def windows?
+    @windows = RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+  end
+
+  #**********************************PROJECT******************************************************
+
+
+  #TODO: Need a massive fix...some of this stuff isn't even right...
+  #We shouldnt just be taking the last features directory in path...this could be a big problem
+  def project_path_for(directory)
+    project_not_found unless project_exists_in?(directory)
+    @project_path = directory if @features_sub_dir_exists
+    @project_path = File.expand_path('..', directory) if @is_in_the_same_dir_as_features
+    @project_path = last_features_dir_in_path if (@feature_files_exist || @index_of_features_dir_in_path)
+    if @project_path
+      return @project_path
+    else
+      project_not_found
+    end
+  end
+
+  def project_exists_in?(directory)
+    # see if current_dir == features
+    # see if current_dir.sub_dir.include?(features)
+    # see if parent_dir == features
+    # see if parent_dir == features/support features/specifications
+    # see if parent_dir == features/support/config
+    # see if parent_dir == features/support/config/selectors.yml
+    # see if sibling_dir == features example: project/documentation and project/features
+    @directory ||= directory
+    features_sub_dir_exists_in? ||
+      is_in_the_same_dir_as_features? ||
+      feature_files_exist_in? ||
+      is_a_nested_subdirectory_of_features?
+  end
+
+
+
+  def project_not_found
+    alert "Could not find the project. Try running this from the main project directory that has the features directory in it"
+    raise "Project Not Found Error"
+  end
+
+  def features_sub_dir_exists_in?(directory=@directory)
+    @features_sub_dir_exists = has_sub_dir?(directory, 'features')
+  end
+
+  def has_sub_dir?(dir, sub_dir)
+    file = File.join(dir, sub_dir)
+    File.directory? file
+  end
+
+  def feature_files_exist_in?(dir=@directory)
+    @feature_files_exist = Dir[File.join(dir, '*.feature')].any?
+  end
+
+  def is_a_nested_subdirectory_of_features?(directory=@directory)
+    @index_of_features_dir_in_path = directories_in_path(directory).rindex('features')
+  end
+
+  def last_features_dir_in_path(directory=@directory)
+    directories = directories_in_path(directory)
+    index = @index_of_features_dir_in_path || is_a_nested_subdirectory_of_features?(directory)
+    File.expand_path directories[0,index].join(File::SEPARATOR)
+  end
+
+  def directories_in_path(directory=@directory)
+    @directories_in_path = directory.split(File::SEPARATOR)
+  end
+
+  def feature_dir_for(dir=@directory)
+    index = is_a_nested_subdirectory_of_features?(dir)
+    raise "Invalid Project. It seems your feature is not part of a proper project" unless index
+    directories_in_path(dir)[0,index].join(File::SEPARATOR)
+  end
+
+  def is_in_the_same_dir_as_features?(directory=@directory)
+    parent = File.expand_path('..', directory)
+    @is_in_the_same_dir_as_features = features_sub_dir_exists_in?(parent)
+  end
+
+  #*****************************USER ALERTS/CONFIRMATION************************************************
+
+  def alert(message)
+    windows? ? user_informed_via_prompt?(message) : puts(message)
+  end
+
+  def user_consents?
+    question = initialization_message + "\nThis will create new files and folders in the current directory. \nWould you still like to proceed?(Y/n)"
+    windows? ? user_consents_via_prompt?(question) : user_consents_via_console?(question)
+  end
+
+  def user_consents_via_console?(question)
+    STDOUT.puts question
+    response = STDIN.gets.strip
+    %w[y yes].include?(response.downcase)
+  end
+
+
+  #*****************************TEMPLATES****************************************************
+
+  def get_templates_from(*directories)
+    templates = []
+    directories.each do |dir|
+      templates << templates_in(dir)
+    end
+    templates = templates.flatten
+    templates = templates.select { |f| File.file?(f) } #only select files, ignore directories
+    templates
+  end
+
+
+  def relative_path_for(template)
+    path = template.gsub("#{@templates_dir}/features", '')
+    path = File.join(@features_dir, path)
+    path = File.join(Pathname.new(File.expand_path(@features_dir)).parent.to_s, 'cucumber.yml') if template =~ /cucumber.yml/
+    path
+  end
+
+  def templates_in( directory)
+    Dir.glob(File.join(@templates_dir, directory, '**/*'))
+  end
+
+
+  #********************************MESSAGES*************************************************
+
+
+  def directory_exists_message
+    %Q{ You already have a features directory!!
+Your features directory may contain settings, configuration, test cases and code that you will lose if you choose to delete this directory.
+If you are sure you need a fresh start, please delete the features directory and re run this command.
+Don't forget to backup any files you might need in the future before you delete the features directory."}
+  end
+
+  def initialization_message
+    "Initializing a new SimpliTest Project in #{Dir.pwd} \n"
+  end
+
+  def abort_message
+    "No modifications were made. SimpliTest Project initialization has been aborted"
+  end
+
+  def problem_creating_directories_message
+    "There was a problem creating a file or directory required for the new SimpliTest project. This is most likely a file permissions issue. Try running this command as an administrator"
+  end
+
+  def success_message
+    "You have successfully initialized a new SimpliTest project!! See sample files in the features directory"
+  end
+
+  def npp_plugin_generated_message
+    "A gherkin.xml file has been placed in the current directory.\n" +
+      "Now, within Notepad++ open the User Defined dialogue from the View menu.\n" +
+      "Click on import and browse to the generated gherkin.xml file.\n" +
+      "If you open a .feature file from Notepad++ now, it should now have some color coding."
+  end
+
+  def framework_correctly_installed_message
+    "Version: #{SimpliTest::VERSION} is correctly installed! Please read the documentation to get started"
+  end
+
+end
+