portal_module 0.0.2

data/lib/portal_module/pages/login_page.rb

@@ -0,0 +1,73 @@
+##############################################################################
+# File::    login_page.rb
+# Purpose:: Login page for Portal Module
+#
+# Author::    Jeff McAffee 2015-03-28
+##############################################################################
+
+require 'page-object'
+
+module PortalModule::Pages
+
+class LoginPage
+  include PageObject
+
+  page_url(:get_dynamic_url)
+
+  def get_dynamic_url
+    PortalModule.configuration.base_url
+  end
+
+  text_field(:username, :id => "ctl00_ContentPlaceHolder1_Login1_txtUserName" )
+  text_field(:password_mask, :id => "ctl00_ContentPlaceHolder1_Login1_txtPasswordMask" )
+  text_field(:password, :id => "ctl00_ContentPlaceHolder1_Login1_txtPassword" )
+  button(:login, :id => "ctl00_ContentPlaceHolder1_Login1_btnLogin" )
+
+  def login_as(username, password)
+    if !self.username? && current_url == PortalModule.configuration.base_url + '/User/AppLogin.aspx'
+      # We're still logged in.
+      return
+    end
+
+    raise ArgumentError.new("Missing username for login.\nHave you set the HSBC_envname_USER environment variable?") if username.nil?
+
+    raise ArgumentError.new("Missing password for login.\nHave you set the HSBC_envname_PASSWORD environment variable?") if password.nil?
+
+    unless current_url.downcase.include? get_dynamic_url.downcase
+      navigate_to get_dynamic_url
+    end
+
+    self.username = username
+
+    allow_password_entry
+
+    self.password = password
+    login
+  end
+
+  def logout
+    navigate_to get_dynamic_url + '/User/AppLogout.aspx'
+  end
+
+  def allow_password_entry
+    # We used to have to click on the password mask before the page would let us enter the password itself:
+    #
+    # # For some unknown reason, we must click on a password mask input before
+    # # we can access the password field itself.
+    #   password_mask_element.click
+    #
+    # Now, we have to use javascript to hide the mask and display the password field.
+    hide_mask_script = <<EOS
+pwdmasks = document.getElementsByClassName('passwordmask');
+pwdmasks[0].style.display = 'none';
+pwds = document.getElementsByClassName('password');
+pwds[0].style.display = 'block';
+EOS
+
+    @browser.execute_script(hide_mask_script)
+  end
+
+end
+
+end # module Pages
+

data/lib/portal_module/pages/prequal_setup_page.rb

@@ -0,0 +1,77 @@
+##############################################################################
+# File::    prequal_setup_page.rb
+# Purpose:: Loan Entry Setup page for PortalModule
+# 
+# Author::    Jeff McAffee 2015-03-28
+##############################################################################
+require 'page-object'
+
+module PortalModule::Pages
+
+  class PrequalSetupPage
+    include PageObject
+
+    # If page_url is not set, page_object will not navigate to this page
+    # when visit is true.
+    page_url(:get_dynamic_url)
+
+    def get_dynamic_url
+      PortalModule.configuration.url(PrequalSetupPage)
+    end
+
+    span(:viewing_span,
+          id: 'ctl00_ContentPlaceHolder1_lblOrganizationName')
+
+    button(:activate_button,
+          id: 'ctl00_ContentPlaceHolder1_btnVersion')
+
+    button(:download_button,
+          id: 'ctl00_ContentPlaceHolder1_btnDownload')
+
+    # Search Orgs
+    text_field(:search_text,
+          id: 'ctl00_ContentPlaceHolder1_txtSrchText')
+
+    button(:search_button,
+          id: 'ctl00_ContentPlaceHolder1_btnSearch')
+
+    # File Upload
+    file_field(:file_input,
+          id: 'ctl00_ContentPlaceHolder1_hdnFileUploader')
+
+    button(:upload_button,
+          id: 'ctl00_ContentPlaceHolder1_btnUploadXMLFile')
+
+
+    def activate
+      self.activate_button
+      self
+    end
+
+    def download
+      self.download_button
+      self
+    end
+
+    def load_org org_string
+      org_name = org_string.split('~')[1]
+      return self if viewing_span == org_name
+
+      self.search_text = org_string
+      self.search_button
+
+      viewing_span_element.wait_until(120, "Org not loaded - #{org_name}") do
+        viewing_span == org_name
+      end
+
+      self
+    end
+
+    def upload file_path
+      self.file_input = file_path
+      self.upload_button
+      self
+    end
+  end
+end # module
+

data/lib/portal_module/pages.rb

@@ -0,0 +1,90 @@
+##############################################################################
+# File::    pages.rb
+# Purpose:: Require all Page classes
+#
+# Author::    Jeff McAffee 2015-03-28
+##############################################################################
+
+require 'watir-webdriver'
+require 'ktutils/os'
+require 'portal_module/pages/login_page'
+require 'portal_module/pages/data_transformation_page'
+require 'portal_module/pages/prequal_setup_page'
+
+module PortalModule::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 = File.absolute_path(File.join(__FILE__, '../../../bin/chrome-win32/chrome.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}"
+
+    # 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 = PortalModule.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

data/lib/portal_module/rake/dts_tasks.rb

@@ -0,0 +1,166 @@
+##############################################################################
+# File::    dts_tasks.rb
+# Purpose:: DtsTasks definition
+#
+# Author::    Jeff McAffee 2015-03-29
+#
+##############################################################################
+
+require 'portal_module'
+require 'rake/dsl_definition'
+require 'rake'
+
+module PortalModule::Rake
+
+  class DtsTasks
+    include ::Rake::DSL if defined?(::Rake::DSL)
+
+    attr_accessor :env
+    attr_accessor :org
+    attr_accessor :path
+    attr_reader   :action
+    attr_reader   :valid_actions
+    attr_reader   :stop_on_exception
+
+    def initialize(task_name = 'dts_task', desc = "Modify a DTS configuration")
+      @valid_actions = ['upload', 'download']
+      @task_name, @desc = task_name, desc
+
+      @stop_on_exception = true
+
+      yield self if block_given?
+
+      define_task
+    end
+
+    def define_task #:nodoc:
+      desc @desc
+      task(@task_name, required_args_for_action) do |t,args|
+        set_vars args
+        commit  # Call method to perform when invoked.
+      end
+    end
+
+    def set_vars args
+      args.each do |arg,val|
+        instance_variable_set "@#{arg}", val
+      end
+
+      args
+    end
+
+    def action=(task_action)
+      raise "action must be one of #{valid_types.join(', ')}" unless valid_actions.include?(task_action.downcase)
+      @action = task_action
+    end
+
+    def stop_on_exception=(do_stop)
+      raise ArgumentError, 'Expecting true or false' unless do_stop === true || do_stop === false
+      @stop_on_exception = do_stop
+    end
+
+    def commit
+      validate_params
+
+      client = PortalModule::Client.new
+      client.env = env
+
+      if self.respond_to? action
+        self.send(action, client)
+        return
+      else
+        raise "Unknown action - #{action}"
+      end
+
+    rescue Exception => e
+      raise e if stop_on_exception == true
+    ensure
+      client.quit unless client.nil?
+    end
+
+    def upload client
+      client.dts.upload org, path
+    end
+
+    def download client
+      client.dts.download org, path
+    end
+
+    def default_params
+    end
+
+    def validate_params
+      assert_provided env, 'Missing "env"'
+      assert_provided action, 'Missing "action"'
+
+      default_params
+
+      assert_provided path, 'Missing "path"'
+      assert_provided org, 'Missing "org"'
+
+      assert_env_is_configured env
+      assert_org_is_configured org
+    end
+
+    def assert_provided value, msg
+      if value.nil? || value.empty?
+        raise msg
+      end
+    end
+
+    def assert_env_is_configured arg
+      unless PortalModule.configuration.credentials.key? arg
+        init_msg = "Have you initialized your config file?\n Try: portal_module config init <filedir>"
+        env_msg = "Have you configured your environments?\n Try: portal_module config add env <envname> <url>"
+        raise "Unknown environment: #{arg}\n#{init_msg}\n\n#{env_msg}"
+      end
+    end
+
+    def assert_org_is_configured arg
+      unless PortalModule.configuration.orgs.key? arg
+        init_msg = "Have you initialized your config file?\n Try: portal_module config init <filedir>"
+        env_msg = "Have you configured your orgs?\n Try: portal_module config add org <orgname> <orgid>"
+        raise "Unknown org: #{arg}\n#{init_msg}\n\n#{env_msg}"
+      end
+    end
+
+    def required_args_for_action
+      args = []
+
+      case action
+      when 'upload'
+        args << :org
+        args << :path
+
+      when 'download'
+        args << :org
+        args << :path
+
+      else
+        # Noop
+      end
+
+      args
+    end
+
+    class << self
+      def install
+        new.install
+      end
+    end
+
+    def install
+      PortalModule.configuration.credentials.keys.each do |e|
+        valid_actions.each do |action|
+          PortalModule::Rake::DtsTasks.new("pm:#{e}:dts:#{action}", "#{action} a #{e} DTS configuration") do |t|
+            t.env = e
+            t.action = action
+          end
+        end
+      end
+    end
+  end # class
+end # module
+
+PortalModule::Rake::DtsTasks.install
+

data/lib/portal_module/rake/loan_entry_tasks.rb

@@ -0,0 +1,166 @@
+##############################################################################
+# File::    loan_entry_tasks.rb
+# Purpose:: LoanEntryTasks definition
+#
+# Author::    Jeff McAffee 2015-03-29
+#
+##############################################################################
+
+require 'portal_module'
+require 'rake/dsl_definition'
+require 'rake'
+
+module PortalModule::Rake
+
+  class LoanEntryTasks
+    include ::Rake::DSL if defined?(::Rake::DSL)
+
+    attr_accessor :env
+    attr_accessor :org
+    attr_accessor :path
+    attr_reader   :action
+    attr_reader   :valid_actions
+    attr_reader   :stop_on_exception
+
+    def initialize(task_name = 'loan_entry_task', desc = "Modify a Loan Entry configuration")
+      @valid_actions = ['upload', 'download']
+      @task_name, @desc = task_name, desc
+
+      @stop_on_exception = true
+
+      yield self if block_given?
+
+      define_task
+    end
+
+    def define_task #:nodoc:
+      desc @desc
+      task(@task_name, required_args_for_action) do |t,args|
+        set_vars args
+        commit  # Call method to perform when invoked.
+      end
+    end
+
+    def set_vars args
+      args.each do |arg,val|
+        instance_variable_set "@#{arg}", val
+      end
+
+      args
+    end
+
+    def action=(task_action)
+      raise "action must be one of #{valid_types.join(', ')}" unless valid_actions.include?(task_action.downcase)
+      @action = task_action
+    end
+
+    def stop_on_exception=(do_stop)
+      raise ArgumentError, 'Expecting true or false' unless do_stop === true || do_stop === false
+      @stop_on_exception = do_stop
+    end
+
+    def commit
+      validate_params
+
+      client = PortalModule::Client.new
+      client.env = env
+
+      if self.respond_to? action
+        self.send(action, client)
+        return
+      else
+        raise "Unknown action - #{action}"
+      end
+
+    rescue Exception => e
+      raise e if stop_on_exception == true
+    ensure
+      client.quit unless client.nil?
+    end
+
+    def upload client
+      client.loan_entry.upload org, path
+    end
+
+    def download client
+      client.loan_entry.download org, path
+    end
+
+    def default_params
+    end
+
+    def validate_params
+      assert_provided env, 'Missing "env"'
+      assert_provided action, 'Missing "action"'
+
+      default_params
+
+      assert_provided path, 'Missing "path"'
+      assert_provided org, 'Missing "org"'
+
+      assert_env_is_configured env
+      assert_org_is_configured org
+    end
+
+    def assert_provided value, msg
+      if value.nil? || value.empty?
+        raise msg
+      end
+    end
+
+    def assert_env_is_configured arg
+      unless PortalModule.configuration.credentials.key? arg
+        init_msg = "Have you initialized your config file?\n Try: portal_module config init <filedir>"
+        env_msg = "Have you configured your environments?\n Try: portal_module config add env <envname> <url>"
+        raise "Unknown environment: #{arg}\n#{init_msg}\n\n#{env_msg}"
+      end
+    end
+
+    def assert_org_is_configured arg
+      unless PortalModule.configuration.orgs.key? arg
+        init_msg = "Have you initialized your config file?\n Try: portal_module config init <filedir>"
+        env_msg = "Have you configured your orgs?\n Try: portal_module config add org <orgname> <orgid>"
+        raise "Unknown org: #{arg}\n#{init_msg}\n\n#{env_msg}"
+      end
+    end
+
+    def required_args_for_action
+      args = []
+
+      case action
+      when 'upload'
+        args << :org
+        args << :path
+
+      when 'download'
+        args << :org
+        args << :path
+
+      else
+        # Noop
+      end
+
+      args
+    end
+
+    class << self
+      def install
+        new.install
+      end
+    end
+
+    def install
+      PortalModule.configuration.credentials.keys.each do |e|
+        valid_actions.each do |action|
+          PortalModule::Rake::LoanEntryTasks.new("pm:#{e}:loan_entry:#{action}", "#{action} a #{e} loan entry configuration") do |t|
+            t.env = e
+            t.action = action
+          end
+        end
+      end
+    end
+  end # class
+end # module
+
+PortalModule::Rake::LoanEntryTasks.install
+