##############################################################################
# File::    pages.rb
# Purpose:: Require all Page classes
#
# Author::    Jeff McAffee 11/15/2013
#
##############################################################################

require 'watir-webdriver'
require 'ktutils/os'
require 'admin_module/pages/select_list_syncable'
require 'admin_module/pages/login_page'
require 'admin_module/pages/guidelines_page'
require 'admin_module/pages/guidelines_version_all_page'
require 'admin_module/pages/guideline_page'
require 'admin_module/pages/guideline_version_page'
require 'admin_module/pages/lock_definitions_page'
require 'admin_module/pages/lock_definition_page'
require 'admin_module/pages/workflow_details_page'
require 'admin_module/pages/workflow_detail_page'
require 'admin_module/pages/workflow_detail_task_addl_detail_page'
require 'admin_module/pages/workflow_detail_task_screens_page'
require 'admin_module/pages/workflow_detail_task_mappings_page'
require 'admin_module/pages/rules_page'
require 'admin_module/pages/rule_page'
require 'admin_module/pages/rulesets_page'
require 'admin_module/pages/ruleset_page'
require 'admin_module/pages/parameters_page'
require 'admin_module/pages/parameter_page'
require 'admin_module/pages/dc_definitions_page'
require 'admin_module/pages/dc_detail_page'
require 'admin_module/pages/snapshot_definitions_page'
require 'admin_module/pages/snapshot_detail_page'
require 'admin_module/pages/workflow_task_page'
require 'admin_module/pages/workflow_tasks_page'
require 'admin_module/pages/ppms_page'

module AdminModule::Pages

  ##
  # Return a configured browser object. If a browser has already been created,
  # this returns the existing browser.
  #
  # An +at_exit+ proc is created to close the browser when the program exits.

  def browser
    if @browser.nil?
      @browser = configure_browser

      at_exit do
        @browser.close unless @browser.nil?
      end
    end

    @browser
  end

private

  def chromium_exe
    if Ktutils::OS.windows?
      # Downloaded from http://chromium.woolyss.com/
      # Package: Chromium Package (32-bit)
      # Version: 37.0.2011.0 (272392)
      chromium_exe = ENV["chrome_browser_path"]
      unless (! chromium_exe.nil? && ! chromium_exe.empty? && File.exist?(chromium_exe))
        raise "chrome_browser_path environment variable not set"
      end
      #chromium_exe = File.absolute_path(File.join(__FILE__, '../../../bin/chrome-win32/chrome.exe'))
      chromium_exe
    else
      chromium_exe = `which chromium-browser`.chomp
    end
  end

  def configure_browser
    # Specify chrome browser capabilities.
    caps = Selenium::WebDriver::Remote::Capabilities.chrome
    caps['chromeOptions'] = {'binary' => chromium_exe }
    #caps['chromeOptions'] = {'binary' => '/opt/bin/test/chrome-27.0.1453.94.exe' }
    # See http://peter.sh/experiments/chromium-command-line-switches/ for a list of available switches.
    # See https://sites.google.com/a/chromium.org/chromedriver/capabilities for details on setting ChromeDriver caps.

    # NOTE: The only way I've found to stop the EULA from being displayed is to
    # use the user-data-dir switch and point to a dir where chrome can put the
    # data indicating it (EULA) has already been accepted.

    # Store chrome profile at test/chrome-data.
    # user_data_dir must be expanded to a full (absolute) path. A relative path
    # results in chromedriver failing to start.
    user_data_dir = File.expand_path('test/chrome-data')
    #puts "*** user_data_dir location: #{user_data_dir}"

    # Create the data dir if it doesn't exist (or chromedriver fails to start).
    unless File.exists?(user_data_dir) and File.directory?(user_data_dir)
      FileUtils.makedirs user_data_dir
    end

    # ignore-certificate-errors:  Ignores certificate-related errors.
    # disable-popup-blocking:     Disable pop-up blocking.
    # disable-translate:          Allows disabling of translate from the command line to assist with automated browser testing
    # no-first-run:               Skip First Run tasks, whether or not it's actually the First Run.
    # log-level:                  Sets the minimum log level. Valid values are from 0 to 3: INFO = 0, WARNING = 1, LOG_ERROR = 2, LOG_FATAL = 3.
    switches = %w[--ignore-certificate-errors --disable-popup-blocking --disable-translate --no-first-run --log-level=3]
    switches << "--user-data-dir=#{user_data_dir}"

    proxy_port = ENV['BROWSER_PROXY_PORT']
    unless proxy_port.nil? || proxy_port.empty?
      proxy_connection_string = "socks://localhost:#{proxy_port}"
      switches << "--proxy-server=#{proxy_connection_string}"
    end

    # Create a client so we can adjust the timeout period.
    client = Selenium::WebDriver::Remote::Http::Default.new

    # Set the browser timeout. Default is 60 seconds.
    client.timeout = AdminModule.configuration.browser_timeout

    browser = Watir::Browser.new :chrome,
      :switches => switches,
      :http_client => client,
      :service_log_path => user_data_dir + '/chromedriver.out',
      :desired_capabilities => caps
  end
end