sakai-oae-test-api 0.0.3 → 0.0.6

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.7)
+    childprocess (0.3.1)
+      ffi (~> 1.0.6)
+    ffi (1.0.9)
+    kuali-sakai-common-lib (0.0.1)
+    libwebsocket (0.1.3)
+      addressable
+    multi_json (1.2.0)
+    page-object (0.6.6)
+      selenium-webdriver (>= 2.21.2)
+      watir-webdriver (>= 0.5.5)
+    rake (0.9.2)
+    rubyzip (0.9.7)
+    selenium-webdriver (2.21.2)
+      childprocess (>= 0.2.5)
+      ffi (~> 1.0)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
+    watir-webdriver (0.5.5)
+      selenium-webdriver (>= 2.18.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  kuali-sakai-common-lib
+  page-object
+  rake
+  selenium-webdriver
+  watir-webdriver

data/README.md

@@ -7,6 +7,10 @@ This is the development project for the Sakai OAE Functional Testing API gem for
 This API provides a framework for interacting with web sites for Sakai-OAE, using
 Ruby and Watir-webdriver--but without needing to know either in detail.
 
+## Documentation:
+
+RDocs for this project can be found at [rubydoc.info](http://rubydoc.info/gems/sakai-oae-test-api)
+
 ## Requirements:
 
 ### Ruby 1.9.2 or higher
@@ -17,73 +21,77 @@ This repo is here if you're going to take part in extending the API's capabiliti
 
 ## A Basic Usage Example for OAE:
 
+Require the gem...
 ````ruby
 #!/usr/bin/env ruby
 require 'sakai-oae-test-api'
+````
 
-# Create an instance of the SakaiOAE class, specifying your test browser
-# and the URL of your test site's OAE welcome page.
+Create an instance of the SakaiOAE class, specifying your test browser and the URL of your test site's OAE welcome page.
+````ruby
 sakai = SakaiOAE.new(:firefox, "https://academic.rsmart.com/")
+````
 
-# define the LoginPage class object, which allows you to interact with elements
-# on the login page. This is available via the SakaiOAE class, "page" method...
+Define the LoginPage class object, which allows you to interact with elements on the login page. This is available via the `SakaiOAE` class, "page" method...
+````ruby
 login_page = sakai.page
+````
 
-# Define the browser object using SakaiOAE's 'browser' method. This is Ruby/Watir's
-# representation of the test browser itself and is used by every page class in the
-# Sakai-OAE-test-api, so it *must* be explicitly defined here as "@browser"...
+Define the browser object using the `SakaiOAE` 'browser' method. This is Ruby/Watir's representation of the test browser itself and is used by every page class in the Sakai-OAE-test-api, so it **must** be explicitly defined here as `@browser` ...
+````ruby
 @browser = sakai.browser
+````
 
-# The above code is all necessary for proper setup and usage of the API. Below, we
-# present a short and simple example of how you can use the API to interact with
-# the Open Academic Environment...
+The above code is all necessary for proper setup and usage of the API. Below, we present a short and simple example of how you can use the API to interact with the Open Academic Environment...
+
+First, log in...
+````ruby
 dash = login_page.login("username", "password")
+````
 
-# There are two ways to invoke page classes. The first way, hinted at in the code
-# above, will be explained below. The second way uses the "on_page" method,
-# and is most useful when you are going to stay on the given page for a while. It
-# requires that you know the name of the relevant page class..
+Next, invoke the current page's 'class'. Note that there are two ways to invoke page classes. The first way, hinted at in the code above, will be explained below. The second way uses the "on_page" method, and is most useful when you are going to stay on the given page for a while. It requires that you know the name of the page class you want...
+````ruby
 on_page MyDashboard do |page|
-  page.add_content
-  page.upload_file=("filename.doc", "Full/Path/To/File")
-  page.file_title="Title"
-  page.file_description="This is a file description."
-  page.tags_and_categories="document"
-  page.add
-  page.done_add_collected
+  page.add_content  # Click the 'Add content' button
+  page.upload_file=("filename.doc", "Full/Path/To/File")  # Enter the filename and full path. The path value is an optional parameter (but recommended)
+  page.file_title="Title"  # Enter 'Title' in the title field.
+  page.file_description="This is a file description."  # Enter the file description.
+  page.tags_and_categories="document"  # Enter the tag 'document'
+  page.add  # Click the 'Add' button
+  page.done_add_collected  # Click the 'Done, add collected' button
 end
+````
 
-# So, back to the first way, which is most useful when you're doing lots of quick
-# navigating around the site, not staying on a given page for too long.
-# You'll notice by looking at the available methods in the page classes that those
-# methods involving navigating to new pages will return the target page's page class.
-# So, for example, going from My Dashboard to Explore Content (notice we're using
-# the "dash" object defined earlier, here...
-explore = dash.explore_content
+So, back to the first way to invoke a page's class, which is most useful when you're doing lots of quick navigating around the site, not staying on a given page for too long. You'll notice by looking at the available methods in the page classes that those methods involving navigating to new pages will return the target page's page class. So, for example, going from My Dashboard to Explore Content (notice we're using the "dash" object defined earlier, here)...
+````ruby
+explore = dash.explore_content  # Click the 'Explore Content' command in the drop-down menu
+````
 
-# Now we can use the "explore" object to interact with the "Explore Content" page...
-explore.search_for="Title"
+Now we can use the "explore" object to interact with the "Explore Content" page...
+````ruby
+explore.search_for="Title"  # Enter 'Title' in the Search field and search
+````
 
-# A bit of verification code (use your own favorite test framework, here, if
-# writing Ruby conditionals isn't too your liking)...
+A bit of verification code (use your own favorite test framework, here, if writing Ruby conditionals isn't to your liking)...
+````
 if explore.results.include?("Title")
   puts "Passed"
 else
   puts "Failed"
 end
-
-# Enjoy!
 ````
 
-For much more extensive usage examples, please see the OAE Cucumber directory in this repo.
+For much more extensive usage examples, please see the tests created by rSmart and current kept at the github repository here:
+[https://github.com/aheward/Kuali-Sakai-Functional-Test-Automation-Framework](https://github.com/aheward/Kuali-Sakai-Functional-Test-Automation-Framework)
+
+## Support
+
+If you have questions, bugs to report, or requests to add any page elements that are currently missing (and there are many) then please contact us.
 
 ## Contribute
 
 * Fork the project.
-* Test drive your feature addition or bug fix. Adding specs is important and I will not accept a pull request that does not have tests.
-* Make sure you describe your new feature with a cucumber scenario.
-* Make sure you provide RDoc comments for any new public method you add. Remember, others will be using this gem.
-* Commit, do not mess with Rakefile, version, or ChangeLog.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Additional or bug-fixed Classes, Elements, or Methods should be demonstrated in accompanying tests. Pull requests that do not include test scripts that use the new code won't be accepted.
+* Make sure you provide RDoc comments for any new public method or page class you add. Remember, others will be using this gem.
 * Send me a pull request. Bonus points for topic branches.
 

data/lib/sakai-oae-test-api.rb

@@ -1,6 +1,4 @@
 require 'kuali-sakai-common-lib'
-require 'watir-webdriver'
-require 'page-object'
 require 'cgi'
 
 PageObject.javascript_framework = :jquery
@@ -11,7 +9,13 @@ require 'sakai-oae-test-api/pop_up_dialogs'
 require 'sakai-oae-test-api/toolbars_and_menus'
 require 'sakai-oae-test-api/widgets'
 require 'sakai-oae-test-api/page_classes'
-require 'sakai-oae-test-api/cle_frame_classes'
+=begin
+require 'sakai-oae-test-api/cle_assessments'
+require 'sakai-oae-test-api/cle_assignments'
+require 'sakai-oae-test-api/cle_forums'
+require 'sakai-oae-test-api/cle_gradebook2'
+=end
+Dir["#{File.dirname(__FILE__)}/sakai-oae-test-api/cle_*.rb"].each {|f| require f }
 
 # Initialize this class at the start of your test cases to
 # open the specified test browser at the specified Sakai welcome page URL.

data/lib/sakai-oae-test-api/cle_assessments.rb

@@ -0,0 +1,146 @@
+# TODO - describe class
+module AssessmentsFrame
+
+  include PageObject
+  include GlobalMethods
+  include HeaderFooterBar
+  include LeftMenuBar
+  include HeaderBar
+  include DocButtons
+
+  # The frame object that contains all of the CLE Tests and Quizzes objects
+  def frm
+    self.frame(:src=>/sakai2samigo.launch.html/)
+  end
+
+end
+
+class AssessmentsList
+  include AssessmentsFrame
+  CLEElements.modularize(AssessmentsListMethods, :index=>2)
+end
+
+class PreviewOverview
+  include AssessmentsFrame
+  CLEElements.modularize(PreviewOverviewMethods, :index=>2)
+end
+
+class AssessmentSettings
+  include AssessmentsFrame
+  CLEElements.modularize(AssessmentSettingsMethods, :index=>2)
+end
+
+class AssessmentTotalScores
+  include AssessmentsFrame
+  include AssessmentTotalScoresMethods
+end
+
+class EditAssessment
+  include AssessmentsFrame
+  CLEElements.modularize(EditAssessmentMethods, :index=>2)
+end
+
+class AddEditAssessmentPart
+  include AssessmentsFrame
+  CLEElements.modularize(AddEditAssessmentPartMethods, :index=>2)
+end
+
+class PublishAssessment
+  include AssessmentsFrame
+  CLEElements.modularize(PublishAssessmentMethods, :index=>2)
+end
+
+class MultipleChoice
+  include AssessmentsFrame
+  CLEElements.modularize(MultipleChoiceMethods, :index=>2)
+end
+
+class Survey
+  include AssessmentsFrame
+  CLEElements.modularize(SurveyMethods, :index=>2)
+end
+
+class ShortAnswer
+  include AssessmentsFrame
+  CLEElements.modularize(ShortAnswerMethods, :index=>2)
+end
+
+class FillInBlank
+  include AssessmentsFrame
+  CLEElements.modularize(FillInBlankMethods, :index=>2)
+end
+
+class NumericResponse
+  include AssessmentsFrame
+  CLEElements.modularize(NumericResponseMethods, :index=>2)
+end
+
+class Matching
+  include AssessmentsFrame
+  CLEElements.modularize(MatchingMethods, :index=>2)
+end
+
+class TrueFalse
+  include AssessmentsFrame
+  CLEElements.modularize(TrueFalseMethods, :index=>2)
+end
+
+class AudioRecording
+  include AssessmentsFrame
+  CLEElements.modularize(AudioRecordingMethods, :index=>2)
+end
+
+class FileUpload
+  include AssessmentsFrame
+  CLEElements.modularize(FileUploadMethods, :index=>2)
+end
+
+class EditAssessmentType
+  include AssessmentsFrame
+  CLEElements.modularize(EditAssessmentTypeMethods, :index=>2)
+end
+
+class AddQuestionPool
+  include AssessmentsFrame
+  CLEElements.modularize(AddQuestionPoolMethods, :index=>2)
+end
+
+class EditQuestionPool
+  include AssessmentsFrame
+  CLEElements.modularize(EditQuestionPoolMethods, :index=>2)
+end
+
+class QuestionPoolsList
+  include AssessmentsFrame
+  CLEElements.modularize(QuestionPoolsListMethods, :index=>2)
+end
+
+class PoolImport
+  include AssessmentsFrame
+  include PoolImportMethods
+end
+
+class SelectQuestionType
+  include AssessmentsFrame
+  CLEElements.modularize(SelectQuestionTypeMethods, :index=>2)
+end
+
+class TakeAssessmentList
+  include AssessmentsFrame
+  include TakeAssessmentListMethods
+end
+
+class BeginAssessment
+  include AssessmentsFrame
+  include BeginAssessmentMethods
+end
+
+class ConfirmSubmission
+  include AssessmentsFrame
+  CLEElements.modularize(ConfirmSubmissionMethods, :index=>2)
+end
+
+class SubmissionSummary
+  include AssessmentsFrame
+  CLEElements.modularize(SubmissionSummaryMethods, :index=>2)
+end

data/lib/sakai-oae-test-api/cle_assignments.rb

@@ -0,0 +1,87 @@
+module AssignmentsFrame
+
+  include PageObject
+  include GlobalMethods
+  include HeaderFooterBar
+  include LeftMenuBar
+  include HeaderBar
+  include DocButtons
+
+  # The frame object that contains all of the CLE Tests and Quizzes objects
+  def frm
+    self.frame(:src=>/sakai2assignments.launch.html/)
+  end
+
+end
+
+#
+class AssignmentsList
+  include AssignmentsFrame
+  CLEElements.modularize( AssignmentsListMethods, :index=>2)
+end
+
+#
+class AssignmentAdd
+  include AssignmentsFrame
+  CLEElements.modularize( AssignmentAddMethods, :index=>2)
+end
+
+#
+class AssignmentsPermissions
+  include AssignmentsFrame
+  CLEElements.modularize( AssignmentsPermissionsMethods, :index=>2)
+end
+
+#
+class AssignmentsPreview
+  include AssignmentsFrame
+  CLEElements.modularize( AssignmentsPreviewMethods, :index=>2)
+end
+
+#
+class AssignmentsReorder
+  include AssignmentsFrame
+  CLEElements.modularize( AssignmentsReorderMethods, :index=>2)
+end
+
+#
+class AssignmentStudent
+  include AssignmentsFrame
+  CLEElements.modularize( AssignmentStudentMethods, :index=>2)
+end
+
+#
+class AssignmentStudentPreview
+  include AssignmentsFrame
+  include AssignmentStudentPreviewMethods
+end
+
+#
+class SubmissionConfirmation
+  include AssignmentsFrame
+  include SubmissionConfirmationMethods
+end
+
+#
+class AssignmentSubmissionList
+  include AssignmentsFrame
+  CLEElements.modularize( AssignmentSubmissionListMethods, :index=>2)
+end
+
+#
+class AssignmentSubmission
+  include AssignmentsFrame
+  CLEElements.modularize( AssignmentSubmissionMethods, :index=>2)
+end
+
+#
+class GradeReport
+  include AssignmentsFrame
+  include GradeReportMethods
+end
+
+#
+class StudentView
+  include AssignmentsFrame
+  CLEElements.modularize( StudentViewMethods, :index=>2)
+end

data/lib/sakai-oae-test-api/cle_calendar.rb

@@ -0,0 +1,65 @@
+# TODO - Write a description
+module CalendarFrame
+
+  include PageObject
+  include HeaderFooterBar
+  include LeftMenuBar
+  include HeaderBar
+  include DocButtons
+  include GlobalMethods
+
+  def calendar_frame
+    self.frame(:src=>/sakai2calendar.launch.html/)
+  end
+
+end
+
+# Top page of the Calendar
+# For now it includes all views, though that probably
+# means it will have to be re-instantiated every time
+# a new view is selected.
+class Calendar
+  include CalendarFrame
+  include CalendarTools
+  include CalendarMethods
+end
+
+# The page that appears when you click on an event in the Calendar
+class EventDetail
+  include CalendarFrame
+  include CalendarTools
+  include EventDetailMethods
+end
+
+#
+class AddEditEvent
+  include CalendarFrame
+  CLEElements.modularize(AddEditEventMethods, :class=>"portletMainIframe")
+end
+
+# The page that appears when the Frequency button is clicked on the Add/Edit
+# Event page.
+class EventFrequency
+  include CalendarFrame
+  CLEElements.modularize(EventFrequencyMethods, :class=>"portletMainIframe")
+end
+
+class AddEditFields
+  include CalendarFrame
+  CLEElements.modularize(AddEditFieldsMethods, :class=>"portletMainIframe")
+end
+
+class ImportStepOne
+  include CalendarFrame
+  CLEElements.modularize(ImportStepOneMethods, :class=>"portletMainIframe")
+end
+
+class ImportStepTwo
+  include CalendarFrame
+  include ImportStepTwoMethods
+end
+
+class ImportStepThree
+  include CalendarFrame
+  CLEElements.modularize(ImportStepThreeMethods, :class=>"portletMainIframe")
+end