sambal-cle 0.1.3

data/README.md

@@ -0,0 +1,4 @@
+sambal-cle
+==========
+
+Open source test automation framework for Sakai CLE

data/lib/sambal-cle/base_page.rb

@@ -0,0 +1,20 @@
+class BasePage < PageMaker
+
+  class << self
+
+    def frame_element
+      element(:frm) { |b| b.frame(:class=>"portletMainIframe") }
+    end
+
+    def basic_page_elements
+      # Returns the text of the error message box
+      value(:alert_box) { |b| b.frm.div(:class=>"alertMessage").text }
+      # Returns the text of the header.
+      value(:header) { |b| b.frm.div(:class=>"portletBody").h3.text }
+    end
+
+    # More element group defs go here...
+
+  end
+
+end

data/lib/sambal-cle/core-ext.rb

@@ -0,0 +1,90 @@
+class Time
+
+  # Using the :year_range option (or no option), this method creates a
+  # Time object of a random value, within
+  # the year range specified (default is 5 years in the past).
+  #
+  # Using the :series option, this method returns an array
+  # containing a randomized Time object as its first element (limited by
+  # the specified :year_range value). Subsequent elements will be Time objects
+  # with values putting them later than the prior element, within the specified
+  # range value (see examples).
+  #
+  # Usage Examples:
+  # @example
+  #   a random date...
+  #   ?> Time.random
+  #   => Tue Aug 05 00:00:00 EDT 2007
+  #
+  #   birthdays, anyone?...
+  #   5.times { p Time.random(:year_range=>80) }
+  #   Wed Feb 06 00:00:00 EDT 1974
+  #   Tue Dec 22 00:00:00 EST 1992
+  #   Fri Apr 14 00:00:00 EWT 1944
+  #   Thu Jul 01 00:00:00 EDT 1993
+  #   Wed Oct 02 00:00:00 EDT 2002
+  #
+  #   A series of dates are useful for account-related info...
+  #   ?> Time.random(:series=>[20.days, 3.years])
+  #   => [Sat Jan 22 00:00:00 EST 2005,
+  #   Sat Jan 29 12:58:45 EST 2005,
+  #   Fri Sep 08 09:34:58 EDT 2006]
+  #
+  #   or maybe to simulate events during an hour?...
+  #   ?> Time.random(:series=>[1.hour,1.hour,1.hour])
+  #   => [Wed Apr 21 00:00:00 EDT 2004,
+  #   Wed Apr 21 00:45:59 EDT 2004,
+  #   Wed Apr 21 01:02:47 EDT 2004,
+  #   Wed Apr 21 01:31:00 EDT 2004]
+  def self.random(params={})
+    years_back = params[:year_range] || 5
+    year = (rand * (years_back)).ceil + (Time.now.year - years_back)
+    month = (rand * 12).ceil
+    day = (rand * 31).ceil
+    series = [date = Time.local(year, month, day)]
+    if params[:series]
+      params[:series].each do |some_time_after|
+        series << series.last + (rand * some_time_after).ceil
+      end
+      return series
+    end
+    date
+  end
+
+end  # Time
+
+module Enumerable
+
+  # Use for getting a natural sort order instead of the ASCII
+  # sort order.
+  def alphabetize
+    sort { |a, b| grouped_compare(a, b) }
+  end
+
+  # Use for sorting an Enumerable object in place.
+  def alphabetize!
+    sort! { |a, b| grouped_compare(a, b) }
+  end
+
+  private
+  def grouped_compare(a, b)
+    loop {
+      a_chunk, a = extract_alpha_or_number_group(a)
+      b_chunk, b = extract_alpha_or_number_group(b)
+      ret = a_chunk <=> b_chunk
+      return -1 if a_chunk == ''
+      return ret if ret != 0
+    }
+  end
+
+  def extract_alpha_or_number_group(item)
+    test_item = item.downcase
+    matchdata = /([a-z]+|[\d]+)/.match(test_item)
+    if matchdata.nil?
+      ["", ""]
+    else
+      [matchdata[0], test_item = test_item[matchdata.offset(0)[1] .. -1]]
+    end
+  end
+
+end # Enumerable

data/lib/sambal-cle/data_objects/announcement.rb

@@ -0,0 +1,82 @@
+class AnnouncementObject
+
+  include Utilities
+  include PageHelper
+  include Workflows
+
+  attr_accessor :title, :body, :site, :link, :access, :availability,
+                :subject, :saved_by, :date, :creation_date, :groups,
+                :message, :message_html, :id
+
+  def initialize(browser, opts={})
+    @browser = browser
+
+    defaults = {
+        :title=>random_alphanums,
+        :body=>random_multiline(500, 10, :alpha)
+    }
+    options = defaults.merge(opts)
+    @title=options[:title]
+    @body=options[:body]
+    @site=options[:site]
+    raise "You must specify a Site for the announcement" if @site==nil
+  end
+
+  alias :name :title
+
+  def create
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    announcements unless @browser.title=~/Announcements$/
+    on_page Announcements do |page|
+      page.add
+    end
+    on_page AddEditAnnouncements do |page|
+      page.title.set @title
+      page.enter_source_text page.editor, @body
+      page.add_announcement
+      @creation_date=make_date Time.now
+    end
+    on_page Announcements do |page|
+      @link = page.href(@title)
+      @id = @link[/(?<=msg\/).+(?=\/main\/)/]
+    end
+  end
+
+  def edit opts={}
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    announcements unless @browser.title=~/Announcements$/
+    on_page Announcements do |list|
+      list.edit @title
+    end
+    on AddEditAnnouncements do |edit|
+      edit.title.set opts[:title] unless opts[:title]==nil
+      edit.send(opts[:access]) unless opts[:access]==nil
+      edit.send(opts[:availability]) unless opts[:availability]==nil
+      unless opts[:body]==nil
+        edit.enter_source_text edit.editor, opts[:body]
+      end
+      edit.save_changes
+    end
+    @title=opts[:title] unless opts[:title]==nil
+    @body=opts[:body] unless opts[:body]==nil
+    @access=opts[:access]
+    @availability=opts[:availability]
+  end
+
+  def view
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    announcements unless @browser.title=~/Announcements$/
+    on Announcements do |list|
+      list.view @title
+    end
+    on ViewAnnouncement do |view|
+      @subject=view.subject
+      @saved_by=view.saved_by
+      @date=view.date
+      @groups=view.groups
+      @message=view.message
+      @message_html=view.message_html
+    end
+  end
+
+end

data/lib/sambal-cle/data_objects/assessment.rb

@@ -0,0 +1,32 @@
+class AssessmentObject
+
+  include PageHelper
+  include Utilities
+  include Workflows
+
+  attr_accessor :title, :site
+
+  def initialize(browser, opts={})
+    @browser = browser
+
+    defaults = {
+      :title=>random_alphanums,
+      :site=>"placeholder"
+    }
+    options = defaults.merge(opts)
+    @title=options[:title]
+    @site=options[:site]
+    raise "You must specify a Site for your Assessment" if @site==nil
+  end
+
+  def create
+    my_workspace.open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    tests_and_quizzes unless @browser.title=~/Tests & Quizzes$/
+    on_page AssessmentsList do |page|
+      page.title.set @title
+      page.create
+    end
+    # Do more here eventually...
+  end
+
+end

data/lib/sambal-cle/data_objects/assignment.rb

@@ -0,0 +1,205 @@
+class AssignmentObject
+
+  include PageHelper
+  include Utilities
+  include Randomizers
+  include DateMakers
+  include Workflows
+
+  attr_accessor :title, :site, :instructions, :id, :link, :status, :grade_scale,
+                :max_points, :allow_resubmission, :num_resubmissions, :open,
+                :due, :accept_until, :student_submissions, :resubmission,
+                :add_due_date, :add_open_announcement, :add_to_gradebook,
+                # Note the following variables are taken from the Entity picker's
+                # Item Info list
+                :retract_time, :time_due, :time_modified, :url, :portal_url,
+                :description, :time_created, :direct_url
+
+  def initialize(browser, opts={})
+    @browser = browser
+
+    defaults = {
+        :title=>random_alphanums,
+        :instructions=>random_multiline(250, 10, :string),
+        :resubmission=>{},
+        :open=>{},
+        :due=>{},
+        :accept_until=>{}
+    }
+    options = defaults.merge(opts)
+
+    @title=options[:title]
+    @instructions=options[:instructions]
+    @site=options[:site]
+    @grade_scale=options[:grade_scale]
+    @max_points=options[:max_points]
+    @allow_resubmission=options[:allow_resubmission]
+    @num_resubmissions=options[:num_resubmissions]
+    @open=options[:open]
+    @due=options[:due]
+    @accept_until=options[:accept_until]
+    @resubmission=options[:resubmission]
+    @student_submissions=options[:student_submissions]
+    @add_due_date=options[:add_due_date]
+    @add_open_announcement=options[:add_open_announcement]
+    @add_to_gradebook=options[:add_to_gradebook]
+    @status=options[:status]
+    raise "You must specify a Site for your Assignment" if @site==nil
+    raise "You must specify max points if your grade scale is 'points'" if @max_points==nil && @grade_scale=="Points"
+  end
+
+  alias :name :title
+
+  def create
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+
+    # Go to assignments page
+    assignments unless @browser.title=~/Assignments$/
+
+    on_page AssignmentsList do |list|
+      list.add
+    end
+    on_page AssignmentAdd do |add|
+      @allow_resubmission==nil ? @allow_resubmission=checkbox_setting(add.allow_resubmission) : add.allow_resubmission.send(@allow_resubmission)
+      if @allow_resubmission==:set
+        add.num_resubmissions.wait_until_present
+        @num_resubmissions==nil ? @num_resubmissions=add.num_resubmissions.selected_options[0].text : add.num_resubmissions.select(@num_resubmissions)
+        @resubmission[:MON]==nil ? @resubmission[:MON]=add.resub_until_month.selected_options[0].text : add.resub_until_month.select(@resubmission[:MON])
+        @resubmission[:day_of_month]==nil ? @resubmission[:day_of_month]=add.resub_until_day.selected_options[0].text : add.select(@resubmission[:day_of_month])
+        @resubmission[:year]==nil ? @resubmission[:year]=add.resub_until_year.selected_options[0].text : add.select(@resubmission[:year])
+        @resubmission[:hour]==nil ? @resubmission[:hour]=add.resub_until_hour.selected_options[0].text : add.select(@resubmission[:hour])
+        @resubmission[:minute_rounded]==nil ? @resubmission[:minute_rounded]=add.resub_until_minute.selected_options[0].text : add.select(@resubmission[:minute_rounded])
+        @resubmission[:MERIDIAN]==nil ? @resubmission[:MERIDIAN]=add.resub_until_meridian.selected_options[0].text : add.select(@resubmission[:MERIDIAN])
+      end
+      add.title.set @title
+      add.instructions=@instructions
+      @student_submissions==nil ? @student_submissions=add.student_submissions.selected_options[0].text : add.student_submissions.select(@student_submissions)
+      @grade_scale==nil ? @grade_scale=add.grade_scale.selected_options[0].text : add.grade_scale.select(@grade_scale)
+      @open[:MON]==nil ? @open[:MON]=add.open_month.selected_options[0].text : add.open_month.select(@open[:MON])
+      add.max_points.set(@max_points) unless @max_points==nil
+      @open[:year]==nil ? @open[:year]=add.open_year.selected_options[0].text : add.open_year.select(@open[:year])
+      @open[:day_of_month]==nil ? @open[:day_of_month]=add.open_day.selected_options[0].text : add.open_day.select(@open[:day_of_month])
+      @open[:hour]==nil ? @open[:hour]=add.open_hour.selected_options[0].text : add.open_hour.select(@open[:hour])
+      @open[:minute_rounded]==nil ? @open[:minute_rounded]=add.open_minute.selected_options[0].text : add.open_minute.select(@open[:minute_rounded])
+      @open[:MERIDIAN]==nil ? @open[:MERIDIAN]=add.open_meridian.selected_options[0].text : add.open_meridian.select(@open[:MERIDIAN])
+      @add_due_date==nil ? @add_due_date=checkbox_setting(add.add_due_date) : add.add_due_date.send(@add_due_date)
+      @add_open_announcement==nil ? @add_open_announcement=checkbox_setting(add.add_open_announcement) : add.add_open_announcement.send(@add_open_announcement)
+      @add_to_gradebook==nil ? @add_to_gradebook=radio_setting(add.add_to_gradebook) : add.add_to_gradebook.send(@add_to_gradebook)
+      @due[:MON]==nil ? @due[:MON]=add.due_month.selected_options[0].text : add.due_month.select(@due[:MON])
+      @due[:year]==nil ? @due[:year]=add.due_year.selected_options[0].text : add.due_year.select(@due[:year])
+      @due[:day_of_month]==nil ? @due[:day_of_month]=add.due_day.selected_options[0].text : add.due_day.select(@due[:day_of_month])
+      @due[:hour]==nil ? @due[:hour]=add.due_hour.selected_options[0].text : add.due_hour.select(@due[:hour])
+      @due[:minute_rounded]==nil ? @due[:minute_rounded]=add.due_minute.selected_options[0].text : add.due_minute.select(@due[:minute_rounded])
+      @due[:MERIDIAN]==nil ? @due[:MERIDIAN]=add.due_meridian.selected_options[0].text : add.due_meridian.select(@due[:MERIDIAN])
+      @accept_until[:MON]==nil ? @accept_until[:MON]=add.accept_month.selected_options[0].text : add.accept_month.select(@accept_until[:MON])
+      @accept_until[:year]==nil ? @accept_until[:year]=add.accept_year.selected_options[0].text : add.accept_year.select(@accept_until[:year])
+      @accept_until[:day_of_month]==nil ? @accept_until[:day_of_month]=add.accept_day.selected_options[0].text : add.accept_day.select(@accept_until[:day_of_month])
+      @accept_until[:hour]==nil ? @accept_until[:hour]=add.accept_hour.selected_options[0].text : add.accept_hour.select(@accept_until[:hour])
+      @accept_until[:minute_rounded]==nil ? @accept_until[:minute_rounded]=add.accept_minute.selected_options[0].text : add.accept_minute.select(@accept_until[:minute_rounded])
+      @accept_until[:MERIDIAN]==nil ? @accept_until[:MERIDIAN]=add.accept_meridian.selected_options[0].text : add.accept_meridian.select(@accept_until[:MERIDIAN])
+      #@do_not_add_to_gradebook==nil ? @do_not_add_to_gradebook=radio_setting(add.do_not_add_gradebook.set?) :
+      if @status=="Draft"
+        add.save_draft
+      else
+        add.post
+      end
+    end
+    on_page AssignmentsList do |list|
+      @id = list.get_assignment_id @title
+      @link = list.assignment_href @title
+      @status = list.status_of @title
+    end
+  end
+
+  def edit opts={}
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    assignments unless @browser.title=~/Assignments$/
+    on AssignmentsList do |list|
+      if @status=="Draft"
+        list.edit_assignment "Draft - #{@title}"
+      else
+        list.edit_assignment @title
+      end
+    end
+    on AssignmentAdd do |edit|
+      edit.title.set opts[:title] unless opts[:title]==nil
+      unless opts[:instructions]==nil
+        edit.enter_source_text edit.editor, opts[:instructions]
+      end
+      edit.grade_scale.select opts[:grade_scale] unless opts[:grade_scale]==nil
+      edit.max_points.set opts[:max_points] unless opts[:max_points]==nil
+      # This should be one of the last items edited...
+      edit.add_to_gradebook.send(opts[:add_to_gradebook]) unless opts[:add_to_gradebook]==nil
+
+      #TODO: All the rest goes here
+
+      if (@status=="Draft" && opts[:status]==nil) || opts[:status]=="Draft"
+        edit.save_draft
+      elsif opts[:status]=="Editing"
+        # Stay on the page
+      else
+        edit.post
+      end
+    end
+    @title=opts[:title] unless opts[:title] == nil
+    @instructions=opts[:instructions] unless opts[:instructions] == nil
+    @grade_scale=opts[:grade_scale] unless opts[:grade_scale] == nil
+    @max_points=opts[:max_points] unless opts[:title] == nil
+    @add_to_gradebook==opts[:add_to_gradebook]
+    # TODO: Add all the rest of the elements here
+
+    unless opts[:status]=="Editing"
+      on AssignmentsList do |list|
+        @status=list.status_of @title
+      end
+    end
+  end
+
+  def get_info
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    assignments unless @browser.title=~/Assignments$/
+    on AssignmentsList do |list|
+      @id = list.get_assignment_id @title
+      @status=list.status_of @title
+      @link=list.assignment_href @title
+      if @status=="Draft"
+        list.open_assignment "Draft - #{@title}"
+      else
+        list.edit_assignment @title
+      end
+    end
+
+    # TODO: Add more stuff here as needed...
+
+    on AssignmentAdd do |edit|
+
+      @instructions=edit.get_source_text edit.editor
+      edit.source edit.editor
+      edit.entity_picker(edit.editor)
+    end
+    on EntityPicker do |info|
+      info.view_assignment_details @title
+      @retract_time=info.retract_time
+      @time_due=info.time_due
+      @time_modified=info.time_modified
+      @url=info.url
+      @portal_url=info.portal_url
+      @description=info.description
+      @time_created=info.time_created
+      @direct_url=info.direct_link
+      info.close_picker
+    end
+    on AssignmentAdd do |edit|
+      edit.cancel
+    end
+  end
+
+  def submit
+    # TODO: Create this method
+  end
+
+  def grade
+    # TODO: Create this method
+  end
+
+end

data/lib/sambal-cle/data_objects/blog.rb

@@ -0,0 +1,46 @@
+class BlogEntryObject
+
+  include PageHelper
+  include Utilities
+  include Workflows
+  
+  attr_accessor :title, :content, :site, :permissions
+  
+  def initialize(browser, opts={})
+    @browser = browser
+    
+    defaults = {
+      :title=>random_alphanums,
+      :content=>random_alphanums,
+      :permissions=>:publicly_viewable
+    }
+    options = defaults.merge(opts)
+    
+    @title=options[:title]
+    @content=options[:content]
+    @site=options[:site]
+    @permissions=options[:permissions]
+    raise "You need to specify a site for your blog entry" if @site==nil
+  end
+    
+  def create
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    blogs unless @browser.title=~/Blogs$/
+    # TODO: More needed here
+  end
+    
+  def edit opts={}
+    
+  end
+    
+  def view
+    
+  end
+    
+  def delete
+    
+  end
+  
+end
+    
+      

data/lib/sambal-cle/data_objects/blogger.rb

@@ -0,0 +1,49 @@
+class BloggerPostObject
+
+  include PageHelper
+  include Utilities
+  include Workflows
+  
+  attr_accessor :title, :abstract, :site, :text, :read_only, :access, :allow_comments
+  
+  def initialize(browser, opts={})
+    @browser = browser
+    
+    defaults = {
+      :title=>random_alphanums,
+      :abstract=>random_alphanums,
+      :text=>random_alphanums
+    }
+    options = defaults.merge(opts)
+    
+    @title=options[:title]
+    @abstract=options[:abstract]
+    @site=options[:site]
+    @text=options[:text]
+    @read_only=options[:read_only]
+    @access=options[:access]
+    @allow_comments=options[:allow_comments]
+    raise "You need to specify a site for your blogger post" if @site==nil
+  end
+    
+  def create
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    blogs unless @browser.title=~/Blogs$/
+    # TODO: More needed here
+  end
+    
+  def edit opts={}
+    
+  end
+    
+  def view
+    
+  end
+    
+  def delete
+    
+  end
+  
+end
+    
+      

data/lib/sambal-cle/data_objects/chat_room.rb

@@ -0,0 +1,54 @@
+class ChatRoomObject
+
+  include PageHelper
+  include Utilities
+  include Workflows
+  
+  attr_accessor :title, :description, :chat_display, :allow_change, :site
+  
+  def initialize(browser, opts={})
+    @browser = browser
+    
+    defaults = {
+      :title=>random_alphanums,
+      :description=>random_alphanums,
+      :chat_display=>:show_all_messages,
+      :allow_change=>:set
+    }
+    options = defaults.merge(opts)
+    
+    @title=options[:title]
+    @description=options[:description]
+    @chat_display=options[:chat_display]
+    @allow_change=options[:allow_change]
+    @site=options[:site]
+    raise "You need to specify a site for your chat room" if @site==nil
+  end
+    
+  def create
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    chat_room unless @browser.title=~/Chat Room$/
+    on ChatRoom do |chat|
+      chat.options
+    end
+    on ManageRooms do |manage|
+      manage.add_room
+    end
+    #TODO: finish this method
+  end
+    
+  def edit opts={}
+    
+  end
+    
+  def view
+    
+  end
+    
+  def delete
+    
+  end
+  
+end
+    
+      

data/lib/sambal-cle/data_objects/event.rb

@@ -0,0 +1,89 @@
+class EventObject
+
+  include PageHelper
+  include Utilities
+  include Workflows
+
+  attr_accessor :title, :month, :day, :year, :start_hour, :start_minute,
+                :start_meridian, :duration_hours, :duration_minutes, :end_hour,
+                :end_minute, :end_meridian, :message, :site, :link, :message_html
+
+  def initialize(browser, opts={})
+    @browser = browser
+
+    defaults = {
+        :title=>random_alphanums,
+        :month=>in_15_minutes[:month_str],
+        :day=>in_15_minutes[:day],
+        :year=>in_15_minutes[:year],
+        :start_hour=>in_15_minutes[:hour],
+        :start_minute=>in_15_minutes[:minute],
+        :start_meridian=>in_15_minutes[:meridian],
+        :message=>random_multiline(400,20, :alpha)
+    }
+    options = defaults.merge(opts)
+
+    @title=options[:title]
+    @month=options[:month]
+    @day=options[:day]
+    @year=options[:year]
+    @start_hour=options[:start_hour]
+    @start_minute=options[:start_minute]
+    @start_meridian=options[:start_meridian]
+    @duration_hours=options[:duration_hours]
+    @duration_minutes=options[:duration_minutes]
+    @end_hour=options[:end_hour]
+    @end_minute=options[:end_minute]
+    @end_meridian=options[:end_meridian]
+    @message=options[:message]
+    @site=options[:site]
+    raise "You need to specify a site for your wiki" if @site==nil
+  end
+
+  def create
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    calendar unless @browser.title=~/Calendar$/
+    on Calendar do |cal|
+      cal.add_event
+    end
+    on AddEditEvent do |add_event|
+      add_event.enter_source_text add_event.editor, @message
+      add_event.title.set @title
+      add_event.month.select @month
+      add_event.day.select @day
+      add_event.year.select @year
+      add_event.start_hour.select @start_hour
+      add_event.start_minute.select @start_minute
+      add_event.start_meridian.select @start_meridian
+      if @end_hour == nil && @duration_hours == nil
+        @duration_hours = add_event.hours.value
+        @duration_minutes = add_event.minutes.value
+        @end_hour = add_event.end_hour.value
+        @end_minute = add_event.end_minute.value
+        @end_meridian = add_event.end_meridian.value
+      elsif @end_hour == nil
+        # Todo: Add this later
+      elsif @duration_hours == nil
+        # Todo: Add this later
+      end
+      add_event.save_event
+    end
+    on Calendar do |cal|
+      @link = cal.event_href @title
+    end
+  end
+
+  def view
+    open_my_site_by_name @site unless @browser.title=~/#{@site}/
+    calendar unless @browser.title=~/Calendar$/
+    on Calendar do |cal|
+      cal.open_event @title
+    end
+    on EventDetail do |event|
+      @message_html = event.message_html
+      # TODO: Lots of stuff to add here...
+      # ...event.details...
+    end
+  end
+
+end