admin_module 0.1.4

data/lib/admin_module/guideline.rb

@@ -0,0 +1,86 @@
+##############################################################################
+# File::    guideline.rb
+# Purpose:: Interface to guideline functionality in admin module
+# 
+# Author::    Jeff McAffee 06/30/2014
+# Copyright:: Copyright (c) 2014, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'admin_module/pages'
+
+module AdminModule
+
+  class Guideline
+    attr_reader :page_factory
+
+    def initialize(page_factory)
+      @page_factory = page_factory
+    end
+
+    def deploy srcdir, comments = nil
+      files = Pathname(srcdir).each_child.select { |f| f.file? && f.extname == '.xml' }
+
+      files.each do |file|
+        deploy_file file, comments
+      end
+    end
+
+    def deploy_file xmlfile, comments = nil
+      gdlname = mapped_guideline(xmlfile)
+
+      page = guidelines_page
+        .open_guideline(gdlname)
+        .add_version
+        .upload(xmlfile.expand_path, comments_or_default(comments))
+    end
+
+    def version gdls, comments = nil
+      gdls = Array(gdls)
+      page = guidelines_page
+        .version_all
+
+      gdl_list = page.get_guidelines
+
+      version_list = []
+      not_found_list = []
+      gdls.each do |gdl|
+        if gdl_list.include? gdl
+          version_list << gdl
+        else
+          mapped_name = mapped_guideline gdl
+          if mapped_name.nil?
+            not_found_list << gdl
+          else
+            version_list << mapped_name
+          end
+        end
+      end
+
+      if not_found_list.count > 0
+        puts "Can't find the following guidelines in the available list:"
+        not_found_list.each do |nf|
+          puts "  #{nf}"
+        end
+        return page
+      end
+
+      page.version(version_list, comments_or_default(comments))
+    end
+
+  private
+
+    def guidelines_page
+      page_factory.guidelines_page
+    end
+
+    def mapped_guideline xmlfile
+      AdminModule.configuration.xmlmap Pathname(xmlfile).basename('.xml').to_s
+    end
+
+    def comments_or_default comments
+      return AdminModule.configuration.default_comment if comments.nil? || comments.empty?
+      comments
+    end
+  end # class Guideline
+end # module

data/lib/admin_module/locks.rb

@@ -0,0 +1,142 @@
+##############################################################################
+# File::    locks.rb
+# Purpose:: Interface to locks functionality in admin module
+# 
+# Author::    Jeff McAffee 2014-07-18
+# Copyright:: Copyright (c) 2014, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'admin_module/pages'
+
+module AdminModule
+
+  class Locks
+    attr_reader :page_factory
+
+    def initialize(page_factory)
+      @page_factory = page_factory
+    end
+
+    def rename src, dest
+      src = assert_lock_exists( extract_lock_name(src) )
+      dest = assert_lock_does_not_exist( extract_lock_name(dest) )
+
+      locks_page
+        .modify(src)
+        .set_name(dest)
+        .save
+    end
+
+    def list
+      locks_page.get_locks
+    end
+
+    def create lock
+      lock_name = assert_lock_does_not_exist( extract_lock_name(lock) )
+
+      locks_page
+        .add
+        .set_lock_data(lock)
+        .save
+    end
+
+    def read lock
+      lock_name = assert_lock_exists( extract_lock_name(lock) )
+
+      locks_page
+        .modify( lock_name )
+        .get_lock_data
+    end
+
+    def update lock
+      lock_name = assert_lock_exists( extract_lock_name(lock) )
+
+      locks_page
+        .modify( lock_name )
+        .set_lock_data(lock)
+        .save
+    end
+
+    #
+    # No functionality exists to DELETE locks.
+    #
+
+    def export file_path
+      locks = list
+      export_data = {}
+
+      locks.each do |lock|
+        export_data[lock] = read lock
+      end
+
+      File.open(file_path, 'w') do |f|
+        f.write export_data.to_yaml
+      end
+
+    rescue Exception => e
+      if e.message.include? 'No such file or directory'
+        raise IOError, "No such directory - #{file_path}"
+      else
+        raise e
+      end
+    end
+
+    ##
+    # Import lock configurations into the current environment from a file.
+
+    def import file_path, allow_create = false
+      raise IOError, "File not found: #{file_path}" unless File.exists?(file_path)
+
+      locks = {}
+      File.open(file_path, 'r') do |f|
+        # Read array of lock hashes.
+        locks = YAML.load(f)
+      end
+
+      existing_locks = list
+
+      locks.each do |name, data|
+        if existing_locks.include?(name)
+          update(data)
+        else
+          if allow_create
+            create(data)
+          else
+            puts "Unable to create #{name}. allow_create = false"
+          end
+        end
+      end
+    end
+
+  private
+
+    def locks_page
+      page_factory.locks_page
+    end
+
+    def extract_lock_name lock
+      lock_name = if lock.is_a? Hash
+                    lock[:name]
+                  else
+                    String(lock)
+                  end
+    end
+
+    def assert_lock_exists lock_name
+      unless list.include? lock_name
+        fail ArgumentError.new("A lock named '#{lock_name}' does not exist")
+      end
+
+      lock_name
+    end
+
+    def assert_lock_does_not_exist lock_name
+      if list.include? lock_name
+        fail ArgumentError.new("A lock named '#{lock_name}' already exists")
+      end
+
+      lock_name
+    end
+  end # class Locks
+end # module

data/lib/admin_module/page_factory.rb

@@ -0,0 +1,55 @@
+##############################################################################
+# File::    page_factory.rb
+# Purpose:: Provides Page objects
+#
+# Author::    Jeff McAffee 06/30/2014
+#
+##############################################################################
+
+require 'admin_module/pages'
+
+module AdminModule
+  class PageFactory
+    include AdminModule::Pages
+
+    def login_page(goto_page = true)
+      return Pages::LoginPage.new(browser, goto_page)
+    end
+
+    def guidelines_page(goto_page = true)
+      return Pages::GuidelinesPage.new(browser, goto_page)
+    end
+
+    def rulesets_page(goto_page = true)
+      return Pages::RulesetsPage.new(browser, goto_page)
+    end
+
+    def rules_page(goto_page = true)
+      return Pages::RulesPage.new(browser, goto_page)
+    end
+
+    def locks_page(goto_page = true)
+      return Pages::LockDefinitionsPage.new(browser, goto_page)
+    end
+
+    def stages_page(goto_page = true)
+      return Pages::WorkflowDetailsPage.new(browser, goto_page)
+    end
+
+    def dc_definitions_page(goto_page = true)
+      return Pages::DcDefinitionsPage.new(browser, goto_page)
+    end
+
+    def snapshot_definitions_page(goto_page = true)
+      return Pages::SnapshotDefinitionsPage.new(browser, goto_page)
+    end
+
+    def tasks_page(goto_page = true)
+      return Pages::WorkflowTasksPage.new(browser, goto_page)
+    end
+
+    def ppms_page(goto_page = true)
+      return Pages::PpmsPage.new(browser, goto_page)
+    end
+  end
+end # AdminModule

data/lib/admin_module/pages.rb

@@ -0,0 +1,120 @@
+##############################################################################
+# 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 = 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}"
+
+    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

data/lib/admin_module/pages/dc_definitions_page.rb

@@ -0,0 +1,73 @@
+##############################################################################
+# File::    dc_definitions_page.rb
+# Purpose:: Data Clearing Definitions page
+#
+#           Note that the admin module has at least 3 pages that all reference
+#           the same url with the difference being the 'type' parameter.
+#
+#           The DataClearing page has a type of 3:
+#
+#             admin/security/ViewDefinitions.aspx?type=3
+#
+# Author::    Jeff McAffee 04/01/2015
+#
+##############################################################################
+require 'page-object'
+
+module AdminModule
+  module Pages
+    class DcDefinitionsPage
+      include PageObject
+
+      page_url(:get_dynamic_url)
+
+      def get_dynamic_url
+        AdminModule.configuration.base_url + "/admin/security/ViewDefinitions.aspx?type=3"
+      end
+
+      select_list(:definitions,
+                  id: 'ctl00_cntPlh_elViews_lstItems')
+
+      button(:add_button,
+            id: 'ctl00_cntPlh_elViews_btnAdd')
+
+      button(:modify_button,
+            id: 'ctl00_cntPlh_elViews_btnModify')
+
+      button(:delete_button,
+            id: 'ctl00_cntPlh_elViews_btnDelete')
+
+      def get_definitions
+        defn_list = []
+        Nokogiri::HTML(@browser.html).css("select#ctl00_cntPlh_elViews_lstItems>option").each do |elem|
+          defn_list << elem.text
+        end
+
+        defn_list
+      end
+
+      def modify dc_name
+        definitions_element.select dc_name
+        self.modify_button
+
+        # Return the page object of the next page.
+        detail_page
+      end
+
+      def add
+        self.add_button
+
+
+        # Return the page object of the next page.
+        detail_page
+      end
+
+    private
+
+      def detail_page
+        DcDetailPage.new(@browser, false)
+      end
+    end
+  end
+end
+