diff --git a/common/test/acceptance/edxapp_pages/lms/course_about.py b/common/test/acceptance/edxapp_pages/lms/course_about.py index db88513b2e..b7dacd4ba6 100644 --- a/common/test/acceptance/edxapp_pages/lms/course_about.py +++ b/common/test/acceptance/edxapp_pages/lms/course_about.py @@ -2,33 +2,28 @@ Course about page (with registration button) """ -from bok_choy.page_object import PageObject -from . import BASE_URL +from .course_page import CoursePage +from .register import RegisterPage -class CourseAboutPage(PageObject): +class CourseAboutPage(CoursePage): """ Course about page (with registration button) """ - name = "lms.course_about" - def url(self, course_id=None): #pylint: disable=W0221 - """ - URL for the about page of a course. - Course ID is currently of the form "edx/999/2013_Spring" - but this format could change. - """ - if course_id is None: - raise NotImplementedError("Must provide a course ID to access about page") - - return BASE_URL + "/courses/" + course_id + "/about" + URL_PATH = "about" def is_browser_on_page(self): return self.is_css_present('section.course-info') def register(self): """ - Register for the course on the page. + Navigate to the registration page. + Waits for the registration page to load, then + returns the registration page object. """ self.css_click('a.register') - self.ui.wait_for_page('lms.register') + + registration_page = RegisterPage(self.browser, self.course_id) + registration_page.wait_for_page() + return registration_page diff --git a/common/test/acceptance/edxapp_pages/lms/course_info.py b/common/test/acceptance/edxapp_pages/lms/course_info.py index 97ffe5a6f3..cdccf7343b 100644 --- a/common/test/acceptance/edxapp_pages/lms/course_info.py +++ b/common/test/acceptance/edxapp_pages/lms/course_info.py @@ -2,33 +2,27 @@ Course info page. """ -from bok_choy.page_object import PageObject -from . import BASE_URL +from .course_page import CoursePage -class CourseInfoPage(PageObject): +class CourseInfoPage(CoursePage): """ Course info. """ - name = "lms.course_info" - - def url(self, course_id=None): #pylint: disable=W0221 - """ - Go directly to the course info page for `course_id`. - (e.g. "edX/Open_DemoX/edx_demo_course") - """ - return BASE_URL + "/courses/" + course_id + "/info" + URL_PATH = "info" def is_browser_on_page(self): return self.is_css_present('section.updates') + @property def num_updates(self): """ Return the number of updates on the page. """ return self.css_count('section.updates ol li') + @property def handout_links(self): """ Return a list of handout assets links. diff --git a/common/test/acceptance/edxapp_pages/lms/course_nav.py b/common/test/acceptance/edxapp_pages/lms/course_nav.py index b8d6c8b023..9fb7bcc4f6 100644 --- a/common/test/acceptance/edxapp_pages/lms/course_nav.py +++ b/common/test/acceptance/edxapp_pages/lms/course_nav.py @@ -12,14 +12,7 @@ class CourseNavPage(PageObject): Navigate sections and sequences in the courseware. """ - name = "lms.course_nav" - - def url(self, **kwargs): - """ - Since course navigation appears on multiple pages, - it doesn't have a particular URL. - """ - raise NotImplementedError + url = None def is_browser_on_page(self): return self.is_css_present('section.course-index') diff --git a/common/test/acceptance/edxapp_pages/lms/course_page.py b/common/test/acceptance/edxapp_pages/lms/course_page.py new file mode 100644 index 0000000000..40c5fd031c --- /dev/null +++ b/common/test/acceptance/edxapp_pages/lms/course_page.py @@ -0,0 +1,31 @@ +""" +Base class for pages in courseware. +""" + +from bok_choy.page_object import PageObject +from . import BASE_URL + + +class CoursePage(PageObject): + """ + Abstract base class for page objects within a course. + """ + + # Overridden by subclasses to provide the relative path within the course + # Paths should not include the leading forward slash. + URL_PATH = "" + + def __init__(self, browser, course_id): + """ + Course ID is currently of the form "edx/999/2013_Spring" + but this format could change. + """ + super(CoursePage, self).__init__(browser) + self.course_id = course_id + + @property + def url(self): + """ + Construct a URL to the page within the course. + """ + return BASE_URL + "/courses/" + self.course_id + "/" + self.URL_PATH diff --git a/common/test/acceptance/edxapp_pages/lms/dashboard.py b/common/test/acceptance/edxapp_pages/lms/dashboard.py index acf2556ac1..0f768af60d 100644 --- a/common/test/acceptance/edxapp_pages/lms/dashboard.py +++ b/common/test/acceptance/edxapp_pages/lms/dashboard.py @@ -12,19 +12,22 @@ class DashboardPage(PageObject): courses she/he has registered for. """ - name = "lms.dashboard" - - def url(self, **kwargs): - return BASE_URL + "/dashboard" + url = BASE_URL + "/dashboard" def is_browser_on_page(self): return self.is_css_present('section.my-courses') + @property def available_courses(self): """ Return list of the names of available courses (e.g. "999 edX Demonstration Course") """ - return self.css_text('section.info > hgroup > h3 > a') + def _get_course_name(el): + # The first component in the link text is the course number + _, course_name = el.text.split(' ', 1) + return course_name + + return self.css_map('section.info > hgroup > h3 > a', _get_course_name) def view_course(self, course_id): """ diff --git a/common/test/acceptance/edxapp_pages/lms/find_courses.py b/common/test/acceptance/edxapp_pages/lms/find_courses.py index 55fb883787..33f2c02b35 100644 --- a/common/test/acceptance/edxapp_pages/lms/find_courses.py +++ b/common/test/acceptance/edxapp_pages/lms/find_courses.py @@ -12,50 +12,15 @@ class FindCoursesPage(PageObject): Find courses page (main page of the LMS). """ - name = "lms.find_courses" - - def url(self): - return BASE_URL + url = BASE_URL def is_browser_on_page(self): return self.browser.title == "edX" + @property def course_id_list(self): """ Retrieve the list of available course IDs on the page. """ return self.css_map('article.course', lambda el: el['id']) - - def go_to_course(self, course_id): - """ - Navigate to the course with `course_id`. - Currently the course id has the form - edx/999/2013_Spring, but this could change. - """ - - # Try clicking the link directly - try: - css = 'a[href="/courses/{0}/about"]'.format(course_id) - - # In most browsers, there are multiple links - # that match this selector, most without text - # In IE 10, only the second one works. - # In IE 9, there is only one link - if self.css_count(css) > 1: - index = 1 - else: - index = 0 - - self.css_click(css + ":nth-of-type({0})".format(index)) - - # Chrome gives an error that another element would receive the click. - # So click higher up in the DOM - except BrokenPromise: - # We need to escape forward slashes in the course_id - # to create a valid CSS selector - course_id = course_id.replace('/', r'\/') - self.css_click('article.course#{0}'.format(course_id)) - - # Ensure that we end up on the next page - self.ui.wait_for_page('lms.course_about') diff --git a/common/test/acceptance/edxapp_pages/lms/login.py b/common/test/acceptance/edxapp_pages/lms/login.py index 5012b32935..c2691e1532 100644 --- a/common/test/acceptance/edxapp_pages/lms/login.py +++ b/common/test/acceptance/edxapp_pages/lms/login.py @@ -12,10 +12,7 @@ class LoginPage(PageObject): Login page for the LMS. """ - name = "lms.login" - - def url(self): - return BASE_URL + "/login" + url = BASE_URL + "/login" def is_browser_on_page(self): return any([ diff --git a/common/test/acceptance/edxapp_pages/lms/open_response.py b/common/test/acceptance/edxapp_pages/lms/open_response.py index c61b6017bd..cc042d1199 100644 --- a/common/test/acceptance/edxapp_pages/lms/open_response.py +++ b/common/test/acceptance/edxapp_pages/lms/open_response.py @@ -11,13 +11,7 @@ class OpenResponsePage(PageObject): Open-ended response in the courseware. """ - name = "lms.open_response" - - def url(self): - """ - Open-response isn't associated with a particular URL. - """ - raise NotImplementedError + url = None def is_browser_on_page(self): return self.is_css_present('section.xmodule_CombinedOpenEndedModule') @@ -116,6 +110,19 @@ class OpenResponsePage(PageObject): return map(map_feedback, labels) + @property + def written_feedback(self): + """ + Return the written feedback from the grader (if any). + If no feedback available, returns None. + """ + feedback = self.css_text('div.written-feedback') + + if len(feedback) > 0: + return feedback[0] + else: + return None + @property def alert_message(self): """ diff --git a/common/test/acceptance/edxapp_pages/lms/progress.py b/common/test/acceptance/edxapp_pages/lms/progress.py index af496234e1..9a6d8882a1 100644 --- a/common/test/acceptance/edxapp_pages/lms/progress.py +++ b/common/test/acceptance/edxapp_pages/lms/progress.py @@ -2,19 +2,15 @@ Student progress page """ -from bok_choy.page_object import PageObject -from . import BASE_URL +from .course_page import CoursePage -class ProgressPage(PageObject): +class ProgressPage(CoursePage): """ Student progress page. """ - name = "lms.progress" - - def url(self, course_id=None): #pylint: disable=W0221 - return BASE_URL + "/courses/" + course_id + "/progress" + URL_PATH = "progress" def is_browser_on_page(self): has_course_info = self.is_css_present('section.course-info') diff --git a/common/test/acceptance/edxapp_pages/lms/register.py b/common/test/acceptance/edxapp_pages/lms/register.py index 0e722b9657..c39a5e4ee4 100644 --- a/common/test/acceptance/edxapp_pages/lms/register.py +++ b/common/test/acceptance/edxapp_pages/lms/register.py @@ -4,6 +4,7 @@ Registration page (create a new account) from bok_choy.page_object import PageObject from . import BASE_URL +from .dashboard import DashboardPage class RegisterPage(PageObject): @@ -11,18 +12,23 @@ class RegisterPage(PageObject): Registration page (create a new account) """ - name = "lms.register" - - def url(self, course_id=None): #pylint: disable=W0221 + def __init__(self, browser, course_id): """ - URL for the registration page of a course. Course ID is currently of the form "edx/999/2013_Spring" but this format could change. """ - if course_id is None: - raise NotImplementedError("Must provide a course ID to access about page") + super(RegisterPage, self).__init__(browser) + self._course_id = course_id - return BASE_URL + "/register?course_id=" + course_id + "&enrollment_action=enroll" + def url(self): + """ + URL for the registration page of a course. + """ + return "{base}/register?course_id={course_id}&enrollment_action={action}".format( + base=BASE_URL, + course_id=self._course_id, + action="enroll", + ) def is_browser_on_page(self): return any([ @@ -30,16 +36,15 @@ class RegisterPage(PageObject): for title in self.css_text('span.title-sub') ]) - def provide_info(self, credentials): + def provide_info(self, email, password, username, full_name): """ Fill in registration info. - - `credentials` is a `TestCredential` object. + `email`, `password`, `username`, and `full_name` are the user's credentials. """ - self.css_fill('input#email', credentials.email) - self.css_fill('input#password', credentials.password) - self.css_fill('input#username', credentials.username) - self.css_fill('input#name', credentials.full_name) + self.css_fill('input#email', email) + self.css_fill('input#password', password) + self.css_fill('input#username', username) + self.css_fill('input#name', full_name) self.css_check('input#tos-yes') self.css_check('input#honorcode-yes') @@ -48,3 +53,8 @@ class RegisterPage(PageObject): Submit registration info to create an account. """ self.css_click('button#submit') + + # The next page is the dashboard; make sure it loads + dashboard = DashboardPage(self.browser) + dashboard.wait_for_page() + return dashboard diff --git a/common/test/acceptance/edxapp_pages/lms/tab_nav.py b/common/test/acceptance/edxapp_pages/lms/tab_nav.py index 9b4b4ccd11..e72e89d19c 100644 --- a/common/test/acceptance/edxapp_pages/lms/tab_nav.py +++ b/common/test/acceptance/edxapp_pages/lms/tab_nav.py @@ -11,14 +11,7 @@ class TabNavPage(PageObject): High-level tab navigation. """ - name = "lms.tab_nav" - - def url(self, **kwargs): - """ - Since tab navigation appears on multiple pages, - it doesn't have a particular URL. - """ - raise NotImplementedError + url = None def is_browser_on_page(self): return self.is_css_present('ol.course-tabs') @@ -40,6 +33,19 @@ class TabNavPage(PageObject): else: self.warning("No tabs found for '{0}'".format(tab_name)) + def is_on_tab(self, tab_name): + """ + Return a boolean indicating whether the current tab is `tab_name`. + """ + current_tab_list = self.css_text('ol.course-tabs>li>a.active') + + if len(current_tab_list) == 0: + self.warning("Could not find current tab") + return False + + else: + return (current_tab_list[0].strip().split('\n')[0] == tab_name) + def _tab_css(self, tab_name): """ Return the CSS to click for `tab_name`. @@ -58,19 +64,6 @@ class TabNavPage(PageObject): Return a `Promise` that the user is on the tab `tab_name`. """ return EmptyPromise( - lambda: self._is_on_tab(tab_name), + lambda: self.is_on_tab(tab_name), "{0} is the current tab".format(tab_name) ) - - def _is_on_tab(self, tab_name): - """ - Return a boolean indicating whether the current tab is `tab_name`. - """ - current_tab_list = self.css_text('ol.course-tabs>li>a.active') - - if len(current_tab_list) == 0: - self.warning("Could not find current tab") - return False - - else: - return (current_tab_list[0].strip().split('\n')[0] == tab_name) diff --git a/common/test/acceptance/edxapp_pages/lms/video.py b/common/test/acceptance/edxapp_pages/lms/video.py index 865664a61b..6adc2a44ee 100644 --- a/common/test/acceptance/edxapp_pages/lms/video.py +++ b/common/test/acceptance/edxapp_pages/lms/video.py @@ -5,20 +5,16 @@ Video player in the courseware. import time from bok_choy.page_object import PageObject from bok_choy.promise import EmptyPromise, fulfill_after +from bok_choy.javascript import wait_for_js, js_defined +@js_defined('window.Video') class VideoPage(PageObject): """ Video player in the courseware. """ - name = "lms.video" - - def url(self): - """ - Video players aren't associated with a particular URL. - """ - raise NotImplementedError + url = None def is_browser_on_page(self): return self.is_css_present('section.xmodule_VideoModule') @@ -53,22 +49,20 @@ class VideoPage(PageObject): """ return self.is_css_present('a.video_control') and self.is_css_present('a.video_control.play') + @wait_for_js def play(self): """ Start playing the video. """ - with fulfill_after( - EmptyPromise(lambda: self.is_playing, "Video is playing") - ): + with fulfill_after(EmptyPromise(lambda: self.is_playing, "Video is playing")): self.css_click('a.video_control.play') + @wait_for_js def pause(self): """ Pause the video. """ - with fulfill_after( - EmptyPromise(lambda: self.is_paused, "Video is paused") - ): + with fulfill_after(EmptyPromise(lambda: self.is_paused, "Video is paused")): self.css_click('a.video_control.pause') def _video_time(self): diff --git a/common/test/acceptance/edxapp_pages/studio/asset_index.py b/common/test/acceptance/edxapp_pages/studio/asset_index.py index 4e20bb12b7..805852f201 100644 --- a/common/test/acceptance/edxapp_pages/studio/asset_index.py +++ b/common/test/acceptance/edxapp_pages/studio/asset_index.py @@ -2,28 +2,15 @@ The Files and Uploads page for a course in Studio """ -from bok_choy.page_object import PageObject -from .helpers import parse_course_id -from . import BASE_URL +from .course_page import CoursePage -class AssetIndexPage(PageObject): +class AssetIndexPage(CoursePage): """ The Files and Uploads page for a course in Studio """ - name = "studio.uploads" - - def url(self, course_id=None): #pylint: disable=W0221 - """ - URL to the files and uploads page for a course. - `course_id` is a string of the form "org.number.run", and it is required - """ - _, _, course_run = parse_course_id(course_id) - - return "{0}/assets/{1}/branch/draft/block/{2}".format( - BASE_URL, course_id, course_run - ) + URL_PATH = "assets" def is_browser_on_page(self): return self.is_css_present('body.view-uploads') diff --git a/common/test/acceptance/edxapp_pages/studio/auto_auth.py b/common/test/acceptance/edxapp_pages/studio/auto_auth.py index 29df6fc632..041cbb2e50 100644 --- a/common/test/acceptance/edxapp_pages/studio/auto_auth.py +++ b/common/test/acceptance/edxapp_pages/studio/auto_auth.py @@ -14,9 +14,7 @@ class AutoAuthPage(PageObject): this url will create a user and log them in. """ - name = "studio.auto_auth" - - def url(self, username=None, email=None, password=None, staff=None, course_id=None): #pylint: disable=W0221 + def __init__(self, browser, username=None, email=None, password=None, staff=None, course_id=None): """ Auto-auth is an end-point for HTTP GET requests. By default, it will create accounts with random user credentials, @@ -29,31 +27,34 @@ class AutoAuthPage(PageObject): Note that "global staff" is NOT the same as course staff. """ - - # The base URL, used for creating a random user - url = BASE_URL + "/auto_auth" + super(AutoAuthPage, self).__init__(browser) # Create query string parameters if provided - params = {} + self._params = {} if username is not None: - params['username'] = username + self._params['username'] = username if email is not None: - params['email'] = email + self._params['email'] = email if password is not None: - params['password'] = password + self._params['password'] = password if staff is not None: - params['staff'] = "true" if staff else "false" + self._params['staff'] = "true" if staff else "false" if course_id is not None: - params['course_id'] = course_id + self._params['course_id'] = course_id - query_str = urllib.urlencode(params) + @property + def url(self): + """ + Construct the URL. + """ + url = BASE_URL + "/auto_auth" + query_str = urllib.urlencode(self._params) - # Append the query string to the base URL if query_str: url += "?" + query_str diff --git a/common/test/acceptance/edxapp_pages/studio/checklists.py b/common/test/acceptance/edxapp_pages/studio/checklists.py index 981f258a4d..3a541cc724 100644 --- a/common/test/acceptance/edxapp_pages/studio/checklists.py +++ b/common/test/acceptance/edxapp_pages/studio/checklists.py @@ -2,28 +2,15 @@ Course checklists page. """ -from bok_choy.page_object import PageObject -from .helpers import parse_course_id -from . import BASE_URL +from .course_page import CoursePage -class ChecklistsPage(PageObject): +class ChecklistsPage(CoursePage): """ Course Checklists page. """ - name = "studio.checklists" - - def url(self, course_id=None): # pylint: disable=W0221 - """ - URL to the checklist page in a course. - `course_id` is a string of the form "org.number.run", and it is required - """ - _, _, course_run = parse_course_id(course_id) - - return "{0}/checklists/{1}/branch/draft/block/{2}".format( - BASE_URL, course_id, course_run - ) + URL_PATH = "checklists" def is_browser_on_page(self): return self.is_css_present('body.view-checklists') diff --git a/common/test/acceptance/edxapp_pages/studio/course_import.py b/common/test/acceptance/edxapp_pages/studio/course_import.py index 504594cd59..c4fc4c6c04 100644 --- a/common/test/acceptance/edxapp_pages/studio/course_import.py +++ b/common/test/acceptance/edxapp_pages/studio/course_import.py @@ -2,28 +2,15 @@ Course Import page. """ -from bok_choy.page_object import PageObject -from .helpers import parse_course_id -from . import BASE_URL +from .course_page import CoursePage -class ImportPage(PageObject): +class ImportPage(CoursePage): """ Course Import page. """ - name = "studio.import" - - def url(self, course_id=None): #pylint: disable=W0221 - """ - URL for the import page of a course. - `course_id` is a string of the form "org.number.run" and is required. - """ - _, _, course_run = parse_course_id(course_id) - - return "{0}/import/{1}/branch/draft/block/{2}".format( - BASE_URL, course_id, course_run - ) + URL_PATH = "import" def is_browser_on_page(self): return self.is_css_present('body.view-import') diff --git a/common/test/acceptance/edxapp_pages/studio/course_info.py b/common/test/acceptance/edxapp_pages/studio/course_info.py index 7baa4425b2..8fadb3f748 100644 --- a/common/test/acceptance/edxapp_pages/studio/course_info.py +++ b/common/test/acceptance/edxapp_pages/studio/course_info.py @@ -2,28 +2,15 @@ Course Updates page. """ -from bok_choy.page_object import PageObject -from .helpers import parse_course_id -from . import BASE_URL +from .course_page import CoursePage -class CourseUpdatesPage(PageObject): +class CourseUpdatesPage(CoursePage): """ Course Updates page. """ - name = "studio.updates" - - def url(self, course_id=None): #pylint: disable=W0221 - """ - URL for the course team page of a course. - `course_id` is a string of the form "org.number.run" and is required. - """ - _, _, course_run = parse_course_id(course_id) - - return "{0}/course_info/{1}/branch/draft/block/{2}".format( - BASE_URL, course_id, course_run - ) + URL_PATH = "course_info" def is_browser_on_page(self): return self.is_css_present('body.view-updates') diff --git a/common/test/acceptance/edxapp_pages/studio/course_page.py b/common/test/acceptance/edxapp_pages/studio/course_page.py new file mode 100644 index 0000000000..4f80984dc0 --- /dev/null +++ b/common/test/acceptance/edxapp_pages/studio/course_page.py @@ -0,0 +1,41 @@ +""" +Base class for pages specific to a course in Studio. +""" + +from bok_choy.page_object import PageObject +from . import BASE_URL + + +class CoursePage(PageObject): + """ + Abstract base class for page objects specific to a course in Studio. + """ + + # Overridden by subclasses to provide the relative path within the course + # Does not need to include the leading forward or trailing slash + URL_PATH = "" + + def __init__(self, browser, course_org, course_num, course_run): + """ + Initialize the page object for the course located at + `{course_org}.{course_num}.{course_run}` + + These identifiers will likely change in the future. + """ + super(CoursePage, self).__init__(browser) + self.course_info = { + 'course_org': course_org, + 'course_num': course_num, + 'course_run': course_run + } + + @property + def url(self): + """ + Construct a URL to the page within the course. + """ + return "/".join([ + BASE_URL, self.URL_PATH, + "{course_org}.{course_num}.{course_run}".format(**self.course_info), + "branch", "draft", "block", self.course_info['course_run'] + ]) diff --git a/common/test/acceptance/edxapp_pages/studio/edit_subsection.py b/common/test/acceptance/edxapp_pages/studio/edit_subsection.py index 32ac69236f..32f20c1a16 100644 --- a/common/test/acceptance/edxapp_pages/studio/edit_subsection.py +++ b/common/test/acceptance/edxapp_pages/studio/edit_subsection.py @@ -10,10 +10,5 @@ class SubsectionPage(PageObject): Edit Subsection page in Studio """ - name = "studio.subsection" - - def url(self): - raise NotImplementedError - def is_browser_on_page(self): return self.is_css_present('body.view-subsection') diff --git a/common/test/acceptance/edxapp_pages/studio/edit_tabs.py b/common/test/acceptance/edxapp_pages/studio/edit_tabs.py index 3339374c1c..516e7d772a 100644 --- a/common/test/acceptance/edxapp_pages/studio/edit_tabs.py +++ b/common/test/acceptance/edxapp_pages/studio/edit_tabs.py @@ -2,28 +2,15 @@ Static Pages page for a course. """ -from bok_choy.page_object import PageObject -from .helpers import parse_course_id -from . import BASE_URL +from .course_page import CoursePage -class StaticPagesPage(PageObject): +class StaticPagesPage(CoursePage): """ Static Pages page for a course. """ - name = "studio.tabs" - - def url(self, course_id=None): #pylint: disable=W0221 - """ - URL to the static pages UI in a course. - `course_id` is a string of the form "org.number.run", and it is required - """ - _, _, course_run = parse_course_id(course_id) - - return "{0}/tabs/{1}/branch/draft/block/{2}".format( - BASE_URL, course_id, course_run - ) + URL_PATH = "tabs" def is_browser_on_page(self): return self.is_css_present('body.view-static-pages') diff --git a/common/test/acceptance/edxapp_pages/studio/export.py b/common/test/acceptance/edxapp_pages/studio/export.py index 3de953576d..c4e5644068 100644 --- a/common/test/acceptance/edxapp_pages/studio/export.py +++ b/common/test/acceptance/edxapp_pages/studio/export.py @@ -2,28 +2,15 @@ Course Export page. """ -from bok_choy.page_object import PageObject -from .helpers import parse_course_id -from . import BASE_URL +from .course_page import CoursePage -class ExportPage(PageObject): +class ExportPage(CoursePage): """ Course Export page. """ - name = "studio.export" - - def url(self, course_id=None): #pylint: disable=W0221 - """ - URL for the export page of a course. - `course_id` is a string of the form "org.number.run" and is required. - """ - _, _, course_run = parse_course_id(course_id) - - return "{0}/export/{1}/branch/draft/block/{2}".format( - BASE_URL, course_id, course_run - ) + URL_PATH = "export" def is_browser_on_page(self): return self.is_css_present('body.view-export') diff --git a/common/test/acceptance/edxapp_pages/studio/helpers.py b/common/test/acceptance/edxapp_pages/studio/helpers.py deleted file mode 100644 index ae64e889c8..0000000000 --- a/common/test/acceptance/edxapp_pages/studio/helpers.py +++ /dev/null @@ -1,28 +0,0 @@ -""" -Helper functions for Studio page objects. -""" - -class InvalidCourseID(Exception): - """ - The course ID does not have the correct format. - """ - pass - - -def parse_course_id(course_id): - """ - Parse a `course_id` string of the form "org.number.run" - and return the components as a tuple. - - Raises an `InvalidCourseID` exception if the course ID is not in the right format. - """ - if course_id is None: - raise InvalidCourseID("Invalid course ID: '{0}'".format(course_id)) - - elements = course_id.split('.') - - # You need at least 3 parts to a course ID: org, number, and run - if len(elements) < 3: - raise InvalidCourseID("Invalid course ID: '{0}'".format(course_id)) - - return tuple(elements) diff --git a/common/test/acceptance/edxapp_pages/studio/howitworks.py b/common/test/acceptance/edxapp_pages/studio/howitworks.py index 0b17100030..d5ceb24de4 100644 --- a/common/test/acceptance/edxapp_pages/studio/howitworks.py +++ b/common/test/acceptance/edxapp_pages/studio/howitworks.py @@ -11,10 +11,7 @@ class HowitworksPage(PageObject): Home page for Studio when not logged in. """ - name = "studio.howitworks" - - def url(self): - return BASE_URL + "/howitworks" + url = BASE_URL + "/howitworks" def is_browser_on_page(self): return self.is_css_present('body.view-howitworks') diff --git a/common/test/acceptance/edxapp_pages/studio/index.py b/common/test/acceptance/edxapp_pages/studio/index.py index f98271fe77..8f8dcb69b2 100644 --- a/common/test/acceptance/edxapp_pages/studio/index.py +++ b/common/test/acceptance/edxapp_pages/studio/index.py @@ -11,10 +11,7 @@ class DashboardPage(PageObject): My Courses page in Studio """ - name = "studio.dashboard" - - def url(self): - return BASE_URL + "/course" + url = BASE_URL + "/course" def is_browser_on_page(self): return self.is_css_present('body.view-dashboard') diff --git a/common/test/acceptance/edxapp_pages/studio/login.py b/common/test/acceptance/edxapp_pages/studio/login.py index 946a918cd8..ed2ff278cc 100644 --- a/common/test/acceptance/edxapp_pages/studio/login.py +++ b/common/test/acceptance/edxapp_pages/studio/login.py @@ -12,10 +12,7 @@ class LoginPage(PageObject): Login page for Studio. """ - name = "studio.login" - - def url(self): - return BASE_URL + "/signin" + url = BASE_URL + "/signin" def is_browser_on_page(self): return self.is_css_present('body.view-signin') diff --git a/common/test/acceptance/edxapp_pages/studio/manage_users.py b/common/test/acceptance/edxapp_pages/studio/manage_users.py index 8c253532fc..3521a18fcc 100644 --- a/common/test/acceptance/edxapp_pages/studio/manage_users.py +++ b/common/test/acceptance/edxapp_pages/studio/manage_users.py @@ -2,28 +2,15 @@ Course Team page in Studio. """ -from bok_choy.page_object import PageObject -from .helpers import parse_course_id -from . import BASE_URL +from .course_page import CoursePage -class CourseTeamPage(PageObject): +class CourseTeamPage(CoursePage): """ Course Team page in Studio. """ - name = "studio.team" - - def url(self, course_id=None): #pylint: disable=W0221 - """ - URL for the course team page of a course. - `course_id` is a string of the form "org.number.run" and is required. - """ - _, _, course_run = parse_course_id(course_id) - - return "{0}/course_team/{1}/branch/draft/block/{2}".format( - BASE_URL, course_id, course_run - ) + URL_PATH = "course_team" def is_browser_on_page(self): return self.is_css_present('body.view-team') diff --git a/common/test/acceptance/edxapp_pages/studio/overview.py b/common/test/acceptance/edxapp_pages/studio/overview.py index f94d232d36..6e67e7b81f 100644 --- a/common/test/acceptance/edxapp_pages/studio/overview.py +++ b/common/test/acceptance/edxapp_pages/studio/overview.py @@ -2,28 +2,15 @@ Course Outline page in Studio. """ -from bok_choy.page_object import PageObject -from .helpers import parse_course_id -from . import BASE_URL +from .course_page import CoursePage -class CourseOutlinePage(PageObject): +class CourseOutlinePage(CoursePage): """ Course Outline page in Studio. """ - name = "studio.outline" - - def url(self, course_id=None): #pylint: disable=W0221 - """ - URL for the course team page of a course. - `course_id` is a string of the form "org.number.run" and is required. - """ - _, _, course_run = parse_course_id(course_id) - - return "{0}/course/{1}/branch/draft/block/{2}".format( - BASE_URL, course_id, course_run - ) + URL_PATH = "course" def is_browser_on_page(self): return self.is_css_present('body.view-outline') diff --git a/common/test/acceptance/edxapp_pages/studio/settings.py b/common/test/acceptance/edxapp_pages/studio/settings.py index f24c89c2e9..7134660d7b 100644 --- a/common/test/acceptance/edxapp_pages/studio/settings.py +++ b/common/test/acceptance/edxapp_pages/studio/settings.py @@ -2,28 +2,15 @@ Course Schedule and Details Settings page. """ -from bok_choy.page_object import PageObject -from .helpers import parse_course_id -from . import BASE_URL +from .course_page import CoursePage -class SettingsPage(PageObject): +class SettingsPage(CoursePage): """ Course Schedule and Details Settings page. """ - name = "studio.settings" - - def url(self, course_id=None): #pylint: disable=W0221 - """ - URL for the settings page of a particular course. - `course_id` is a string of the form "org.number.run" and is required. - """ - _, _, course_run = parse_course_id(course_id) - - return "{0}/settings/details/{1}/branch/draft/block/{2}".format( - BASE_URL, course_id, course_run - ) + URL_PATH = "settings/details" def is_browser_on_page(self): return self.is_css_present('body.view-settings') diff --git a/common/test/acceptance/edxapp_pages/studio/settings_advanced.py b/common/test/acceptance/edxapp_pages/studio/settings_advanced.py index 916ec70def..4f6b8893a1 100644 --- a/common/test/acceptance/edxapp_pages/studio/settings_advanced.py +++ b/common/test/acceptance/edxapp_pages/studio/settings_advanced.py @@ -2,28 +2,15 @@ Course Advanced Settings page """ -from bok_choy.page_object import PageObject -from .helpers import parse_course_id -from . import BASE_URL +from .course_page import CoursePage -class AdvancedSettingsPage(PageObject): +class AdvancedSettingsPage(CoursePage): """ Course Advanced Settings page. """ - name = "studio.advanced" - - def url(self, course_id=None): #pylint: disable=W0221 - """ - URL to the advanced setting page in a course. - `course_id` is a string of the form "org.number.run", and it is required - """ - _, _, course_run = parse_course_id(course_id) - - return "{0}/settings/advanced/{1}/branch/draft/block/{2}".format( - BASE_URL, course_id, course_run - ) + URL_PATH = "settings/advanced" def is_browser_on_page(self): return self.is_css_present('body.advanced') diff --git a/common/test/acceptance/edxapp_pages/studio/settings_graders.py b/common/test/acceptance/edxapp_pages/studio/settings_graders.py index 24c9623d77..af6194fcc5 100644 --- a/common/test/acceptance/edxapp_pages/studio/settings_graders.py +++ b/common/test/acceptance/edxapp_pages/studio/settings_graders.py @@ -2,28 +2,15 @@ Course Grading Settings page. """ -from bok_choy.page_object import PageObject -from .helpers import parse_course_id -from . import BASE_URL +from .course_page import CoursePage -class GradingPage(PageObject): +class GradingPage(CoursePage): """ Course Grading Settings page. """ - name = "studio.grading" - - def url(self, course_id=None): #pylint: disable=W0221 - """ - URL for the course team page of a course. - `course_id` is a string of the form "org.number.run" and is required. - """ - _, _, course_run = parse_course_id(course_id) - - return "{0}/settings/grading/{1}/branch/draft/block/{2}".format( - BASE_URL, course_id, course_run - ) + URL_PATH = "settings/grading" def is_browser_on_page(self): return self.is_css_present('body.grading') diff --git a/common/test/acceptance/edxapp_pages/studio/signup.py b/common/test/acceptance/edxapp_pages/studio/signup.py index 8847fb8416..3e5f731597 100644 --- a/common/test/acceptance/edxapp_pages/studio/signup.py +++ b/common/test/acceptance/edxapp_pages/studio/signup.py @@ -7,10 +7,7 @@ class SignupPage(PageObject): Signup page for Studio. """ - name = "studio.signup" - - def url(self): - return BASE_URL + "/signup" + url = BASE_URL + "/signup" def is_browser_on_page(self): return self.is_css_present('body.view-signup') diff --git a/common/test/acceptance/edxapp_pages/studio/textbooks.py b/common/test/acceptance/edxapp_pages/studio/textbooks.py index 0c0dd579e8..460a83df13 100644 --- a/common/test/acceptance/edxapp_pages/studio/textbooks.py +++ b/common/test/acceptance/edxapp_pages/studio/textbooks.py @@ -2,28 +2,15 @@ Course Textbooks page. """ -from bok_choy.page_object import PageObject -from .helpers import parse_course_id -from . import BASE_URL +from .course_page import CoursePage -class TextbooksPage(PageObject): +class TextbooksPage(CoursePage): """ Course Textbooks page. """ - name = "studio.textbooks" - - def url(self, course_id=None): #pylint: disable=W0221 - """ - URL to the textbook UI in a course. - `course_id` is a string of the form "org.number.run", and it is required - """ - _, _, course_run = parse_course_id(course_id) - - return "{0}/textbooks/{1}/branch/draft/block/{2}".format( - BASE_URL, course_id, course_run - ) + URL_PATH = "textbooks" def is_browser_on_page(self): return self.is_css_present('body.view-textbooks') diff --git a/common/test/acceptance/edxapp_pages/studio/unit.py b/common/test/acceptance/edxapp_pages/studio/unit.py index 2a9294c9f7..530ebe9ef3 100644 --- a/common/test/acceptance/edxapp_pages/studio/unit.py +++ b/common/test/acceptance/edxapp_pages/studio/unit.py @@ -10,10 +10,5 @@ class UnitPage(PageObject): Unit page in Studio """ - name = "studio.unit" - - def url(self): - raise NotImplementedError - def is_browser_on_page(self): return self.is_css_present('body.view-unit') diff --git a/common/test/acceptance/fixtures/base.py b/common/test/acceptance/fixtures/base.py deleted file mode 100644 index 6ee4fb07e7..0000000000 --- a/common/test/acceptance/fixtures/base.py +++ /dev/null @@ -1,30 +0,0 @@ -""" -Base fixtures. -""" -from bok_choy.web_app_fixture import WebAppFixture -from django.core.management import call_command - - -class DjangoCmdFixture(WebAppFixture): - """ - Install a fixture by executing a Django management command. - """ - - def __init__(self, cmd, *args, **kwargs): - """ - Configure the fixture to call `cmd` with the specified - positional and keyword arguments. - """ - self._cmd = cmd - self._args = args - self._kwargs = kwargs - - def install(self): - """ - Call the Django management command. - """ - # We do not catch exceptions here. Since management commands - # execute arbitrary Python code, any exception could be raised. - # So it makes sense to let those go all the way up to the test runner, - # where they can quickly be found and fixed. - call_command(self._cmd, *self._args, **self._kwargs) diff --git a/common/test/acceptance/fixtures/course.py b/common/test/acceptance/fixtures/course.py index 54af80aacb..bcc998eb63 100644 --- a/common/test/acceptance/fixtures/course.py +++ b/common/test/acceptance/fixtures/course.py @@ -5,34 +5,49 @@ Fixture to create a course and course components (XBlocks). import json import datetime from textwrap import dedent +from collections import namedtuple import requests from lazy import lazy -from bok_choy.web_app_fixture import WebAppFixture, WebAppFixtureError from . import STUDIO_BASE_URL -class StudioApiFixture(WebAppFixture): +class StudioApiLoginError(Exception): + """ + Error occurred while logging in to the Studio API. + """ + pass + + +class StudioApiFixture(object): """ Base class for fixtures that use the Studio restful API. """ @lazy - def session_cookies(self): + def session(self): """ - Log in as a staff user, then return the cookies for the session (as a dict) - Raises a `WebAppFixtureError` if the login fails. + Log in as a staff user, then return a `requests` `session` object for the logged in user. + Raises a `StudioApiLoginError` if the login fails. """ + # Use auto-auth to retrieve session for a logged in user + session = requests.Session() + response = session.get(STUDIO_BASE_URL + "/auto_auth?staff=true") - # Use auto-auth to retrieve session cookies for a logged in user - response = requests.get(STUDIO_BASE_URL + "/auto_auth?staff=true") - - # Return the cookies from the request + # Return the session from the request if response.ok: - return {key: val for key, val in response.cookies.items()} + return session else: msg = "Could not log in to use Studio restful API. Status code: {0}".format(response.status_code) - raise WebAppFixtureError(msg) + raise StudioApiLoginError(msg) + + @lazy + def session_cookies(self): + """ + Log in as a staff user, then return the cookies for the session (as a dict) + Raises a `StudioApiLoginError` if the login fails. + """ + return {key: val for key, val in self.session.cookies.items()} @lazy def headers(self): @@ -96,6 +111,11 @@ class XBlockFixtureDesc(object): 'publish': self.publish } + # Need to handle detached categories differently, since they are not published + # This may change in the future. + if self.category in ['static_tab']: + del payload['publish'] + if parent_loc is not None: payload['parent_locator'] = parent_loc @@ -121,6 +141,19 @@ class XBlockFixtureDesc(object): ) +# Description of course updates to add to the course +# `date` is a str (e.g. "January 29, 2014) +# `content` is also a str (e.g. "Test course") +CourseUpdateDesc = namedtuple("CourseUpdateDesc", ['date', 'content']) + + +class CourseFixtureError(Exception): + """ + Error occurred while installing a course fixture. + """ + pass + + class CourseFixture(StudioApiFixture): """ Fixture for ensuring that a course exists. @@ -160,6 +193,8 @@ class CourseFixture(StudioApiFixture): if end_date is not None: self._course_details['end_date'] = end_date.isoformat() + self._updates = [] + self._handouts = [] self._children = [] def __str__(self): @@ -178,14 +213,33 @@ class CourseFixture(StudioApiFixture): self._children.extend(args) return self + def add_update(self, update): + """ + Add an update to the course. `update` should be a `CourseUpdateDesc`. + """ + self._updates.append(update) + + def add_handout(self, asset_name): + """ + Add the handout named `asset_name` to the course info page. + Note that this does not actually *create* the static asset; it only links to it. + """ + self._handouts.append(asset_name) + def install(self): """ Create the course and XBlocks within the course. This is NOT an idempotent method; if the course already exists, this will - raise a `WebAppFixtureError`. You should use unique course identifiers to avoid + raise a `CourseFixtureError`. You should use unique course identifiers to avoid conflicts between tests. """ self._create_course() + + # Remove once STUD-1248 is resolved + self._update_loc_map() + + self._install_course_updates() + self._install_course_handouts() self._configure_course() self._create_xblock_children(self._course_loc, self._children) @@ -196,33 +250,46 @@ class CourseFixture(StudioApiFixture): """ return "{org}.{number}.{run}/branch/draft/block/{run}".format(**self._course_dict) + @property + def _updates_loc(self): + """ + Return the locator string for the course updates + """ + return "{org}.{number}.{run}/branch/draft/block/updates".format(**self._course_dict) + + @property + def _handouts_loc(self): + """ + Return the locator string for the course handouts + """ + return "{org}.{number}.{run}/branch/draft/block/handouts".format(**self._course_dict) + def _create_course(self): """ Create the course described in the fixture. """ # If the course already exists, this will respond # with a 200 and an error message, which we ignore. - response = requests.post( + response = self.session.post( STUDIO_BASE_URL + '/course', data=self._encode_post_dict(self._course_dict), - headers=self.headers, - cookies=self.session_cookies + headers=self.headers ) try: err = response.json().get('ErrMsg') except ValueError: - raise WebAppFixtureError( + raise CourseFixtureError( "Could not parse response from course request as JSON: '{0}'".format( response.content)) # This will occur if the course identifier is not unique if err is not None: - raise WebAppFixtureError("Could not create course {0}. Error message: '{1}'".format(self, err)) + raise CourseFixtureError("Could not create course {0}. Error message: '{1}'".format(self, err)) if not response.ok: - raise WebAppFixtureError( + raise CourseFixtureError( "Could not create course {0}. Status was {1}".format( self._course_dict, response.status_code)) @@ -233,17 +300,17 @@ class CourseFixture(StudioApiFixture): url = STUDIO_BASE_URL + '/settings/details/' + self._course_loc # First, get the current values - response = requests.get(url, headers=self.headers, cookies=self.session_cookies) + response = self.session.get(url, headers=self.headers) if not response.ok: - raise WebAppFixtureError( + raise CourseFixtureError( "Could not retrieve course details. Status was {0}".format( response.status_code)) try: details = response.json() except ValueError: - raise WebAppFixtureError( + raise CourseFixtureError( "Could not decode course details as JSON: '{0}'".format(old_details) ) @@ -251,17 +318,75 @@ class CourseFixture(StudioApiFixture): details.update(self._course_details) # POST the updated details to Studio - response = requests.post( + response = self.session.post( url, data=self._encode_post_dict(details), headers=self.headers, - cookies=self.session_cookies ) if not response.ok: - raise WebAppFixtureError( + raise CourseFixtureError( "Could not update course details to '{0}'. Status was {1}.".format( self._course_details, response.status_code)) + def _install_course_handouts(self): + """ + Add handouts to the course info page. + """ + url = STUDIO_BASE_URL + '/xblock/' + self._handouts_loc + + # Construct HTML with each of the handout links + handouts_li = [ + '
Some edX courses ask you to enter an algebraic expression as an answer. Try entering the following algebraic expression in the box below. It’s easier than it looks.
+\(A \cdot x^2 + \sqrt{y}\) +
++The entry is case sensitive. The product must be indicated with an asterisk, and the exponentiation with a caret, so you would write +"A*x^2 + sqrt(y)".
+Many edX courses have homework or exercises you need to complete. Notice the clock image to the left? That means this homework or exercise needs to be completed for you to pass the course. (This can be a bit confusing; the exercise may or may not have a due date prior to the end of the course.)
+We’ve provided eight (8) examples of how a professor might ask you questions. While the multiple choice question types below are somewhat standard, explore the other question types in the sequence above, like the formula builder- try them all out.
+As you go through the question types, notice how edX gives you immediate feedback on your responses - it really helps in the learning process.
+What color is the open ocean on a sunny day?
+Which piece of furniture is built for sitting?
+Which of the following are musical instruments?
++