kuali-sakai-common-lib 0.0.1 → 0.0.6

data/kuali-sakai-common-lib.gemspec

@@ -1,14 +1,13 @@
-require 'rubygems'
-
 spec = Gem::Specification.new do |s|
   s.name = 'kuali-sakai-common-lib'
-  s.version = '0.0.1'
+  s.version = '0.0.6'
   s.summary = %q{Modules and methods common to the rSmart testing gems}
   s.description = %q{This gem provides a set of modules and methods that are common to the Kuali and Sakai open source project's rSmart functional testing API gems.\n\nThis gem is not useful except in the context of one of the other rSmart Kuali/Sakai testing API gems.}
   s.files = Dir.glob("**/**/**")
   s.test_files = Dir.glob("test/*test_rb")
   s.authors = ["Abraham Heward"]
-  s.email = ["aheward@rsmart.com"]
-  #s.rubyforge_project = "kuali-sakai-common-lib"
+  s.email = %w{"aheward@rsmart.com"}
+  s.homepage = 'https://github.com/aheward/Kuali-Sakai-Functional-Test-Automation-Framework/tree/Sakai-CLE/Common'
+  s.add_dependency 'page-object', '>= 0.6.6'
   s.required_ruby_version = '>= 1.9.2'
 end

data/lib/kuali-sakai-common-lib.rb

@@ -1,2 +1,3 @@
-require 'core-ext'
-require 'utilities'
+require 'watir-webdriver'
+require 'page-object'
+Dir["#{File.dirname(__FILE__)}/kuali-sakai-common-lib/*.rb"].each {|f| require f }

data/lib/kuali-sakai-common-lib/add_files.rb

@@ -0,0 +1,260 @@
+# This class consolidates the code that can be shared among all the
+# File Upload and Attachment pages.
+#
+# Not every method in this class will be appropriate for every attachment page.
+class AddFiles
+
+  @@classes = { :this=>"Superclassdummy", :parent=>"Superclassdummy" }
+
+  # Use this for debugging purposes only...
+  def what_is_parent?
+    puts @@classes[:parent]
+  end
+
+  # Returns an array of the displayed folder names.
+  def folder_names
+    names = []
+    frm.table(:class=>/listHier lines/).rows.each do |row|
+      next if row.td(:class=>"specialLink").exist? == false
+      next if row.td(:class=>"specialLink").link(:title=>"Folder").exist? == false
+      names << row.td(:class=>"specialLink").link(:title=>"Folder").text
+    end
+    return names
+  end
+
+  # Returns an array of the file names currently listed
+  # on the page.
+  #
+  # It excludes folder names.
+  def file_names
+    names = []
+    frm.table(:class=>/listHier lines/).rows.each do |row|
+      next if row.td(:class=>"specialLink").exist? == false
+      next if row.td(:class=>"specialLink").link(:title=>"Folder").exist?
+      names << row.td(:class=>"specialLink").link(:href=>/access.content/, :index=>1).text
+    end
+    return names
+  end
+
+  # Clicks the Select button next to the specified file.
+  def select_file(filename)
+    frm.table(:class=>/listHier lines/).row(:text, /#{Regexp.escape(filename)}/).link(:text=>"Select").click
+  end
+
+  # Clicks the Remove button.
+  def remove
+    frm.button(:value=>"Remove").click
+  end
+
+  # Clicks the remove link for the specified item in the attachment list.
+  def remove_item(file_name)
+    frm.table(:class=>/listHier/).row(:text=>/#{Regexp.escape(file_name)}/).link(:href=>/doRemoveitem/).click
+  end
+
+  # Clicks the Move button.
+  def move
+    frm.button(:value=>"Move").click
+  end
+
+  # Clicks the Show Other Sites link.
+  def show_other_sites
+    frm.link(:text=>"Show other sites").click
+  end
+
+  # Clicks on the specified folder image, which
+  # will open the folder tree and remain on the page.
+  def open_folder(foldername)
+    frm.table(:class=>/listHier lines/).row(:text=>/#{Regexp.escape(foldername)}/).link(:title=>"Open this folder").click
+  end
+
+  # Clicks on the specified folder name, which should open
+  # the folder contents on a refreshed page.
+  def go_to_folder(foldername)
+    frm.link(:text=>foldername).click
+  end
+
+  # Sets the URL field to the specified value.
+  def url=(url_string)
+    frm.text_field(:id=>"url").set(url_string)
+  end
+
+  # Clicks the Add button next to the URL field.
+  def add
+    frm.button(:value=>"Add").click
+  end
+
+  # Gets the value of the access level cell for the specified
+  # file.
+  def access_level(filename)
+    frm.table(:class=>/listHier lines/).row(:text=>/#{Regexp.escape(filename)}/)[6].text
+  end
+
+  def edit_details(name)
+    frm.table(:class=>/listHier lines/).row(:text=>/#{Regexp.escape(name)}/).li(:text=>/Action/, :class=>"menuOpen").fire_event("onclick")
+    frm.table(:class=>/listHier lines/).row(:text=>/#{Regexp.escape(name)}/).link(:text=>"Edit Details").click
+    instantiate_class(:file_details)
+  end
+
+  # Clicks the Create Folders menu item in the
+  # Add menu of the specified folder.
+  def create_subfolders_in(folder_name)
+    frm.table(:class=>/listHier lines/).row(:text=>/#{Regexp.escape(folder_name)}/).link(:text=>"Start Add Menu").fire_event("onfocus")
+    frm.table(:class=>/listHier lines/).row(:text=>/#{Regexp.escape(folder_name)}/).link(:text=>"Create Folders").click
+    instantiate_class(:create_folders)
+  end
+
+  # Enters the specified file into the file field name (assuming it's in the
+  # data/sakai-cle-test-api folder or a subfolder therein)
+  #
+  # Does NOT instantiate any class, so use only when no page refresh occurs.
+  def upload_file(filename, filepath="")
+    frm.file_field(:id=>"upload").set(filepath + filename)
+    if frm.div(:class=>"alertMessage").exist?
+      sleep 2
+      upload_file(filename)
+    end
+  end
+
+  # Enters the specified file into the file field name (assuming it's in the
+  # data/sakai-cle-test-api folder or a subfolder therein)
+  #
+  # Use this method ONLY for instances where there's a file field on the page
+  # with an "upload" id.
+  def upload_local_file(filename, filepath="")
+    frm.file_field(:id=>"upload").set(filepath + filename)
+    if frm.div(:class=>"alertMessage").exist?
+      sleep 2
+      upload_local_file(filename)
+    end
+    instantiate_class(:this)
+  end
+
+  # Clicks the Add Menu for the specified
+  # folder, then selects the Upload Files
+  # command in the menu that appears.
+  def upload_file_to_folder(folder_name)
+    upload_files_to_folder(folder_name)
+  end
+
+  # Clicks the Add Menu for the specified
+  # folder, then selects the Upload Files
+  # command in the menu that appears.
+  def upload_files_to_folder(folder_name)
+    if frm.li(:text=>/A/, :class=>"menuOpen").exist?
+      frm.table(:class=>/listHier lines/).row(:text=>/#{Regexp.escape(folder_name)}/).li(:text=>/A/, :class=>"menuOpen").fire_event("onclick")
+    else
+      frm.table(:class=>/listHier lines/).row(:text=>/#{Regexp.escape(folder_name)}/).link(:text=>"Start Add Menu").fire_event("onfocus")
+    end
+    frm.table(:class=>/listHier lines/).row(:text=>/#{Regexp.escape(folder_name)}/).link(:text=>"Upload Files").click
+    instantiate_class(:upload_files)
+  end
+
+  # Clicks the "Attach a copy" link for the specified
+  # file, then reinstantiates the Class.
+  # If an alert box appears, the method will call itself again.
+  # Note that this can lead to an infinite loop. Will need to fix later.
+  def attach_a_copy(file_name)
+    frm.table(:class=>/listHier lines/).row(:text=>/#{Regexp.escape(file_name)}/).link(:href=>/doAttachitem/).click
+    if frm.div(:class=>"alertMessage").exist?
+      sleep 1
+      attach_a_copy(file_name) # TODO - This can loop infinitely
+    end
+    instantiate_class(:this)
+  end
+
+  # Clicks the Create Folders menu item in the
+  # Add menu of the specified folder.
+  def create_subfolders_in(folder_name)
+    frm.table(:class=>/listHier lines/).row(:text=>/#{Regexp.escape(folder_name)}/).link(:text=>"Start Add Menu").fire_event("onfocus")
+    frm.table(:class=>/listHier lines/).row(:text=>/#{Regexp.escape(folder_name)}/).link(:text=>"Create Folders").click
+    instantiate_class(:create_folders)
+  end
+
+  # Takes the specified array object containing pointers
+  # to local file resources, then uploads those files to
+  # the folder specified, checks if they all uploaded properly and
+  # if not, re-tries the ones that failed the first time.
+  #
+  # Finally, it re-instantiates the appropriate page class.
+  # Note that it expects all files to be located in the same folder (can be in subfolders of that folder).
+  def upload_multiple_files_to_folder(folder, file_array, file_path="")
+
+    upload = upload_files_to_folder folder
+
+    file_array.each do |file|
+      upload.file_to_upload(file, file_path)
+      upload.add_another_file
+    end
+
+    resources = upload.upload_files_now
+
+    file_array.each do |file|
+      file =~ /(?<=\/).+/
+      # puts $~.to_s # For debugging purposes
+      unless resources.file_names.include?($~.to_s)
+        upload_files = resources.upload_files_to_folder(folder)
+        upload_files.file_to_upload(file, file_path)
+        resources = upload_files.upload_files_now
+      end
+    end
+    instantiate_class(:this)
+  end
+
+  # Clicks the Continue button then
+  # decides which page class to instantiate
+  # based on the page that appears. This is going to need to be fixed.
+  def continue
+    frm.div(:class=>"highlightPanel").span(:id=>"submitnotifxxx").wait_while_present
+    frm.button(:value=>"Continue").click
+    page_title = @browser.div(:class=>"title").text
+    case(page_title)
+      when "Lessons"
+        instantiate_class(:parent)
+      when "Assignments"
+        if frm.div(:class=>"portletBody").h3.text=~/In progress/ || frm.div(:class=>"portletBody").h3.text == "Select supporting files"
+          instantiate_class(:second)
+        elsif frm.div(:class=>"portletBody").h3.text=~/edit/i || frm.div(:class=>"portletBody").h3.text=~/add/i
+          instantiate_class(:parent)
+        elsif frm.form(:id=>"gradeForm").exist?
+          instantiate_class(:third)
+        end
+      when "Forums"
+        if frm.div(:class=>"portletBody").h3.text == "Forum Settings"
+          instantiate_class(:second)
+        else
+          instantiate_class(:parent)
+        end
+      when "Messages"
+        if frm.div(:class=>/breadCrumb/).text =~ /Reply to Message/
+          instantiate_class(:second)
+        else
+          instantiate_class(:parent)
+        end
+      when "Calendar"
+        frm.frame(:id, "description___Frame").td(:id, "xEditingArea").frame(:index=>0).wait_until_present
+        instantiate_class(:parent)
+      when "Portfolio Templates"
+        if frm.div(:class=>"portletBody").h3.text=="Select supporting files"
+          instantiate_class(:second)
+        else
+          instantiate_class(:parent)
+        end
+      else
+        instantiate_class(:parent)
+    end
+  end
+
+  private
+
+  # This is a private method that is only used inside this superclass.
+  def instantiate_class(key)
+    eval(@@classes[key]).new(@browser)
+  end
+
+  # This is another private method--a better way to
+  # instantiate the @@classes hash variable.
+  def set_classes_hash(hash_object)
+    @@classes = hash_object
+  end
+
+end

data/lib/kuali-sakai-common-lib/announcements.rb

@@ -0,0 +1,301 @@
+#================
+# Announcements Pages
+#================
+
+# The Announcements list page for a Site.
+module AnnouncementsMethods
+
+  # Clicks the add button, instantiates the AddEditAnnouncements class.
+  def add
+    frm.div(:class=>"portletBody").link(:title=>"Add").click
+    frm.frame(:id, "body___Frame").td(:id, "xEditingArea").frame(:index=>0).wait_until_present(60)
+    AddEditAnnouncements.new(@browser)
+  end
+
+  # Edits the specified announcement in the list.
+  # @param subject [String] the text of the announcement listing link.
+  def edit(subject)
+    frm.table(:class=>"listHier").row(:text=>/#{Regexp.escape(subject)}/).link(:text=>"Edit").click
+    AddEditAnnouncements.new(@browser)
+  end
+
+  # Returns an array of the subject strings of the announcements
+  # listed on the page.
+  def subjects
+    links = frm.table(:class=>"listHier").links.find_all { |link| link.title=~/View announcement/ }
+    subjects = []
+    links.each { |link| subjects << link.text }
+    return subjects
+  end
+
+  # Returns true or false depending on whether the specified announcement has an attachment.
+  # @param subject [String] the text of the announcement listing link.
+  def has_attachment?(subject)
+    if frm.table(:class=>"listHier").row(:text=>/#{Regexp.escape(subject)}/).exist?
+      return frm.table(:class=>"listHier").row(:text=>/#{Regexp.escape(subject)}/).image(:alt=>"attachment").exist?
+    else
+      puts "Can't find your target row. Your test is faulty."
+      return false
+    end
+  end
+
+  # Returns the text of the "For" column for
+  # the specified announcement.
+  # @param subject [String] the text of the announcement listing link.
+  def for_column(subject)
+    frm.table(:class=>"listHier").row(:text=>/#{Regexp.escape(subject)}/)[4].text
+  end
+
+  # Clicks the specified announcement link and instantiates the PreviewAnnouncements class.
+  # @param subject [String] the text of the announcement listing link.
+  def preview_announcement(subject)
+    frm.link(:text=>subject).click
+    PreviewAnnouncements.new(@browser)
+  end
+
+  # Selects the specified list item from the View selection list.
+  # @param list_item [String] the text of the option in the selection list.
+  def view=(list_item)
+    frm.select(:id=>"view").set(list_item)
+  end
+
+  # Clicks the Merge link and instantiates the AnnouncementsMerge class.
+  def merge
+    frm.link(:text=>"Merge").click
+    AnnouncementsMerge.new(@browser)
+  end
+
+end
+
+# Show Announcements from Another Site. On this page you select what announcements
+# you want to merge into the current Site. This module contains definitions for the
+# page elements that are common between OAE and CLE.
+module AnnouncementsMergeMethods
+
+  # Checks the checkbox for the specified site name
+  # @param site_name [String] the name of the relevant site displayed in the table
+  def check(site_name)
+    frm.table(:class=>"listHier lines nolines").row(:text=>/#{Regexp.escape(site_name)}/).checkbox(:id=>/site/).set
+  end
+
+  # Clicks the Save button and returns the Announcements class.
+  def save
+    frm.button(:value=>"Save").click
+    Announcements.new(@browser)
+  end
+
+end
+
+# Contains the common page elements for the Announcements Preview page
+module PreviewAnnouncementsMethods
+
+  # Clicks the Return to list button and returns the Announcements class.
+  def return_to_list
+    frm.button(:value=>"Return to List").click
+    Announcements.new(@browser)
+  end
+
+  # Clicks the Save changes button and returns the Announcements class.
+  def save_changes
+    frm.button(:value=>"Save Changes").click
+    Announcements.new(@browser)
+  end
+
+  # Clicks the Edit button and returns the AddEditAnnouncements class.
+  def edit
+    frm.button(:value=>"Edit").click
+    AddEditAnnouncements.new(@browser)
+  end
+
+end
+
+# Contains the common page elements for the Add/Edit Announcements page.
+module AddEditAnnouncementsMethods
+
+  # Clicks the Add Announcement button and then determines whether to return
+  # AddEditAnnouncements or Announcements class.
+  def add_announcement
+    frm.button(:value=>"Add Announcement").click
+    if frm.div(:class=>"portletBody").h3.text=~/Add Announcement/
+      AddEditAnnouncements.new(@browser)
+    else
+      Announcements.new(@browser)
+    end
+  end
+
+  # Clicks the Save changes button and returns the Announcements class.
+  def save_changes
+    frm.button(:value=>"Save Changes").click
+    Announcements.new(@browser)
+  end
+
+  # Clicks the Preview button and returns the PreviewAnnouncements class.
+  def preview
+    frm.button(:value=>"Preview").click
+    PreviewAnnouncements.new(@browser)
+  end
+
+  # Sends the specified text block to the rich text editor
+  # @param text [String] the text that you want to add to the editor.
+  def body=(text)
+    frm.frame(:id, "body___Frame").td(:id, "xEditingArea").frame(:index=>0).send_keys(text)
+  end
+
+  # Clicks the Add attachments button and returns the Announcments Attach class.
+  def add_attachments
+    frm.button(:value=>"Add Attachments").click
+    AnnouncementsAttach.new(@browser)
+  end
+
+  # Clicks the checkbox for the specified group name
+  # when you've set the announcement access to display
+  # to groups.
+  # @param group_name [String] the name of the group in the table that you intend to select.
+  def check_group(group_name)
+    frm.table(:id=>"groupTable").row(:text=>/#{Regexp.escape(group_name)}/).checkbox(:name=>"selectedGroups").set
+  end
+
+  # Sets the Announcement Title field to the specified
+  # string value.
+  # @param string [String] the text you want to put in the title field.
+  def title=(string)
+    frm.text_field(:id=>"subject").set(string)
+  end
+
+  # Clicks the radio button for "Only members of this site can see this announcement"
+  def select_site_members
+    frm.radio(:id=>"site").set
+  end
+
+  # Clicks the radio button for "This announcement is publicly viewable"
+  def select_publicly_viewable
+    frm.radio(:id=>"pubview").set
+  end
+
+  # Clicks the radio button for "Displays this announcement to selected groups only."
+  def select_groups
+    frm.radio(:id=>"groups").set
+  end
+
+  # Clicks the radio button for "Show - (Post and display this announcement immediately)"
+  def select_show
+    frm.radio(:id=>"hidden_false").set
+  end
+
+  # Clicks the radio button for "Hide - (Draft mode - Do not display this announcement at this time)"
+  def select_hide
+    frm.radio(:id=>"hidden_true").set
+  end
+
+  # Clicks the radio button for "Specify Dates - (Choose when this announcement will be displayed)"
+  def select_specify_dates
+    frm.radio(:id=>"hidden_specify").set
+  end
+
+  # Checks the checkbox for "Beginning"
+  def check_beginning
+    frm.checkbox(:id=>"use_start_date").set
+  end
+
+  # Checks the checkbox for "Ending"
+  def check_ending
+    frm.checkbox(:id=>"use_end_date").set
+  end
+
+  # Checks the checkbox for selecting all Groups
+  def check_all
+    frm.checkbox(:id=>"selectall").set
+  end
+
+  # Sets the Beginning Month selection to the
+  # specified string.
+  def beginning_month=(string)
+    frm.select(:id=>"release_month").select(string)
+  end
+
+  # Sets the Beginning Day selection to the
+  # specified string.
+  def beginning_day=(string)
+    frm.select(:id=>"release_day").select(string)
+  end
+
+  # Sets the Beginning Year selection to the
+  # specified string.
+  def beginning_year=(string)
+    frm.select(:id=>"release_year").select(string)
+  end
+
+  # Sets the Beginning Hour selection to the
+  # specified string
+  def beginning_hour=(string)
+    frm.select(:id=>"release_hour").select(string)
+  end
+
+  # Sets the Beginning Minute selection to the
+  # specified string
+  def beginning_minute=(string)
+    frm.select(:id=>"release_minute").select(string)
+  end
+
+  # Sets the AM or PM value to the specified string.
+  # Obviously the string should be either "AM" or "PM".
+  def beginning_meridian=(string)
+    frm.select(:id=>"release_ampm").select(string)
+  end
+
+  # Sets the Ending Month selection to the specified
+  # string.
+  def ending_month=(string)
+    frm.select(:id=>"retract_month").select(string)
+  end
+
+  # Sets the Ending Day selection to the specified
+  # string.
+  def ending_day=(string)
+    frm.select(:id=>"retract_day").select(string)
+  end
+
+  # Sets the Ending Year selection to the specified
+  # string.
+  def ending_year=(string)
+    frm.select(:id=>"retract_year").select(string)
+  end
+
+  # Sets the Ending Hour selection to the specified
+  # string.
+  def ending_hour=(string)
+    frm.select(:id=>"retract_hour").select(string)
+  end
+
+  # Sets the Ending Minute selection to the specified
+  # string.
+  def ending_minute=(string)
+    frm.select(:id=>"retract_minute").select(string)
+  end
+
+  # Sets the Ending AM/PM selection to the specified
+  # value.
+  def ending_meridian=(string)
+    frm.select(:id=>"retract_ampm").select(string)
+  end
+
+  # Gets the text of the alert message when it appears on
+  # the page
+  def alert_message
+    frm.div(:class=>"alertMessage").text
+  end
+
+end
+
+module AnnouncementsMergeMethods
+
+end
+
+module AnnouncementsOptionsMethods
+
+
+end
+
+module AnnouncementsPermissionsMethods
+
+end