admin_module 0.1.4

data/lib/admin_module/cli/cli_parameter.rb

@@ -0,0 +1,66 @@
+##############################################################################
+# File::    cli_parameter.rb
+# Purpose:: filedescription
+# 
+# Author::    Jeff McAffee 2014-03-19
+# Copyright:: Copyright (c) 2014, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'admin_module/pages'
+
+class AdminModule::CLI
+  include AdminModule::Pages
+
+
+  def get_parameters
+    login
+
+    parameters_page = ParametersPage.new(browser, base_url)
+    variables = parameters_page.get_parameters
+  end
+
+  ###
+  # Update a parameter's config values.
+  # - var_name name of parameter to update
+  # - params hash of values to update where:
+  #   - :name is name of parameter
+  #   - :type is Boolean, Date, DateTime, Money, Numeric, Percentage, or Text (case sensitive)
+  #   - :decision is DSM when true, DPM when false
+  #   - :order Fixnum value
+  #   - :precision Only valid if :type is Numeric
+  #   - :include include in app XML if true
+  #
+  def update_parameter(var_name, params)
+    raise "Missing params" unless params.size > 0
+
+    login
+
+    parameters_page_url = ParametersPage.new(browser, base_url).edit_parameter(var_name)
+    page = ParameterPage.new(browser, false)
+
+    page.parameter_name = params.delete(:name) if params.key?(:name)
+    page.parameter_type = params.delete(:type) if params.key?(:type)
+
+    if ! params.key?(:decision).nil?
+      page.decision_parameter = params[:decision] ? 'Yes' : 'No'
+      params.delete(:decision)
+    end
+
+    page.parameter_order = params.delete(:order) if params.key?(:order)
+    page.precision = params.delete(:precision) if params.key?(:precision)
+
+    if ! params.key?(:include).nil?
+
+      if params[:include]
+        page.check_include_in_application_xml
+      else
+        page.uncheck_include_in_application_xml
+      end
+    end
+    params.delete(:include)
+    raise ArgumentError, "Unexpected params: #{params.inspect}" unless params.size == 0
+
+    page.save
+  end
+end

data/lib/admin_module/cli/cli_task.rb

@@ -0,0 +1,149 @@
+##############################################################################
+# File::    cli_task.rb
+# Purpose:: filedescription
+# 
+# Author::    Jeff McAffee 11/15/2013
+# Copyright:: Copyright (c) 2013, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'admin_module/pages'
+
+
+class AdminModule::CLI
+  include AdminModule::Pages
+
+
+  ##
+  # Retrieve task configuration data from the current environment
+
+  def get_task task_name
+    login
+
+    begin
+      task_def_url = TaskDefinitionsPage.new(browser, base_url).
+        modify_task(task_name)
+    rescue Watir::Exception::NoValueFoundException => e
+      raise ArgumentError, "Task [#{task_name}] not found.\n\n#{e.message}"
+    end
+
+    task_data = WorkflowTasksPage.new(browser, task_def_url).get_task_data
+  end
+
+  ##
+  # Return a list of task names in the current environment
+
+  def current_task_names
+    login
+    TaskDefinitionsPage.new(browser, base_url).tasks_options
+  end
+
+  ##
+  # Return configuration data for all tasks in the current environment
+
+  def all_tasks
+    tasks = {}
+
+    current_task_names.each do |name|
+      tasks[name] = get_task(name)
+    end
+
+    tasks
+  end
+
+  ##
+  # Test task data structure for validity
+  #
+  # Required:
+  #   at least 1 parameter OR dts
+
+  def valid_task_data? task_data
+    if !task_data.key?(:parameters) || task_data[:parameters].empty?
+      if !task_data.key?(:dts) || task_data[:dts].empty?
+        return false
+      end
+    end
+    true
+  end
+
+  ##
+  # Test task data structure for valid name
+  #
+
+  def task_data_has_name? task_data
+    return false unless task_data.key?(:name)
+    return false if task_data[:name].empty?
+    true
+  end
+
+  ##
+  # Create a task in the current environment
+
+  def create_task task_data
+    raise ArgumentError, "Invalid task data: #{task_data.inspect}" unless valid_task_data?(task_data)
+    raise ArgumentError, "Missing task name: #{task_data.inspect}" unless task_data_has_name?(task_data)
+
+    login
+
+    task_def_url = TaskDefinitionsPage.new(browser, base_url).
+      create_task(task_data)
+
+    WorkflowTasksPage.new(browser, task_def_url).set_task_data task_data
+  end
+
+  ##
+  # Modify an existing task in the current environment
+
+  def modify_task task_data, task_name = nil
+    task_name ||= task_data[:name]
+    raise ArgumentError, "Invalid task data: #{task_data.inspect}" unless valid_task_data?(task_data)
+    raise ArgumentError, "Missing task name" if (task_name.nil? || task_name.empty?)
+
+    # Make sure we populate the data's name param if empty so we don't try to write
+    # and save an empty name.
+    if task_data[:name].nil? || task_data[:name].empty?
+      task_data[:name] = task_name
+    end
+
+    login
+
+    task_def_url = TaskDefinitionsPage.new(browser, base_url).
+      modify_task(task_name)
+
+    WorkflowTasksPage.new(browser, task_def_url).set_task_data task_data
+  end
+
+  ##
+  # Export all task configurations in the current environment to a file.
+
+  def export_tasks file_name
+    FileUtils.mkdir_p File.dirname(file_name)
+    File.open(file_name, 'w') do |f|
+      # Write array of task hashes.
+      f << YAML.dump(all_tasks)
+    end
+  end
+
+  ##
+  # Import task configurations into the current environment from a file.
+
+  def import_tasks file_name
+    raise IOError, "File not found: #{file_name}" unless File.exists?(file_name)
+
+    tasks = {}
+    File.open(file_name, 'r') do |f|
+      # Write array of task hashes.
+      tasks = YAML.load(f)
+    end
+
+    existing_tasks = current_task_names
+
+    tasks.each do |name, data|
+      if existing_tasks.include?(name)
+        modify_task(data, name)
+      else
+        create_task(data)
+      end
+    end
+  end
+end

data/lib/admin_module/cli_old.rb

@@ -0,0 +1,92 @@
+##############################################################################
+# File::    cli.rb
+# Purpose:: filedescription
+# 
+# Author::    Jeff McAffee 11/15/2013
+# Copyright:: Copyright (c) 2013, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'admin_module/pages'
+require_relative 'cli/cli_parameter'
+require_relative 'cli/cli_rule'
+require_relative 'cli/cli_ruleset'
+require_relative 'cli/cli_guideline'
+require_relative 'cli/cli_lock'
+require_relative 'cli/cli_stage'
+
+
+class AdminModule::CLI
+  include AdminModule::Pages
+
+
+  def initialize
+    # Make sure the configuration has been initialized.
+    AdminModule.configure
+  end
+
+  ##
+  # Set the current environment
+
+  def environment=(env)
+    raise "Unknown environment [#{env}]" unless AdminModule.configuration.credentials.key?(env)
+    @env = env
+    AdminModule.configure do |config|
+      config.default_environment = env
+    end
+  end
+
+  ##
+  # Return the current environment
+
+  def environment
+    @env ||= AdminModule.configuration.default_environment
+    @env
+  end
+
+  ##
+  # Return the credentials for the current environment
+
+  def credentials
+    return AdminModule.configuration.credentials[environment]
+  end
+
+  ##
+  # Return the base url for the current environment
+
+  def base_url
+    return AdminModule.configuration.base_urls[environment]
+  end
+
+  ##
+  # Login to the Admin Module
+  #
+  # If we're already logged in, do nothing unless the +force+ flag is true.
+  #
+  # +force+ force a re-login if we've already logged in
+
+  def login(force = false)
+    if force || @login_page.nil?
+      @login_page = LoginPage.new(browser, base_url)
+      @login_page.login_as(*credentials)
+    end
+
+    @login_page
+  end
+
+  def logout
+    @login_page.logout
+    @login_page = nil
+  end
+
+  ##
+  # Close the browser
+
+  def quit
+    unless @browser.nil?
+      logout
+      @browser.close
+      @browser = nil
+    end
+  end
+end

data/lib/admin_module/client.rb

@@ -0,0 +1,146 @@
+##############################################################################
+# File::    client.rb
+# Purpose:: AdminModule client object
+#
+# Author::    Jeff McAffee 07/11/2014
+#
+##############################################################################
+
+module AdminModule
+  class Client
+
+    attr_writer :page_factory
+
+    #
+    # Override credentials
+    #
+
+    attr_writer :user
+    attr_writer :password
+
+    def env=(environment)
+      AdminModule.configuration.current_env = environment
+    end
+
+    def env
+      AdminModule.configuration.current_env
+    end
+
+    def guideline
+      login
+      Guideline.new page_factory
+    end
+
+    def rulesets
+      login
+      Rulesets.new page_factory
+    end
+
+    def rules
+      login
+      Rules.new page_factory
+    end
+
+    def locks
+      login
+      Locks.new page_factory
+    end
+
+    def stages
+      login
+      Stages.new page_factory
+    end
+
+    def dcs
+      login
+      DC.new page_factory
+    end
+
+    def snapshots
+      login
+      Snapshots.new page_factory
+    end
+
+    def tasks
+      login
+      Tasks.new page_factory
+    end
+
+    def ppms
+      login
+      Ppms.new page_factory
+    end
+
+    def page_factory
+      @page_factory ||= AdminModule::PageFactory.new
+    end
+
+    ##
+    # Login to the admin module.
+    #
+    # If no credentials are provided, try to get credentials from the config object.
+    #
+
+    def login(user = nil, pass = nil)
+      if @logged_in
+        return true
+      end
+
+      user, pass = verify_credentials user, pass
+
+      logout
+      page_factory.login_page(true).login_as(user, pass)
+      @logged_in = true
+    end
+
+    ##
+    # Logout of the admin module
+    #
+
+    def logout
+      page_factory.login_page(true).logout
+      @logged_in = false
+    end
+
+    ##
+    # Logout of the admin module and quit the browser
+    #
+
+    def quit
+      logout
+      page_factory.login_page(false).browser.close
+    end
+
+  private
+
+    ##
+    # If credential args are empty, attempt to look them up,
+    #  first in the client attributes, then in the config obj.
+
+    def verify_credentials user, pass
+      return [user, pass] if valid_user_and_pass? user, pass
+
+      # Pull values stored in this client.
+      user, pass = @user, @password
+      return [user, pass] if valid_user_and_pass? user, pass
+
+      # Pull values stored in the config.
+      user, pass = AdminModule.configuration.user_credentials
+      return [user, pass] if valid_user_and_pass? user, pass
+
+      fail AuthenticationRequired.new("Missing credentials for #{env}")
+    end
+
+    def valid_user_and_pass? user, pass
+      if user.nil? || user.empty?
+        return false
+      end
+
+      if pass.nil? || pass.empty?
+        return false
+      end
+
+      true
+    end
+  end # Client
+end # AdminModule