Code libraries for AMO pages

From MozillaWiki
Jump to navigation Jump to search

AMOlocators

The module groups locators into dictionaries named for a page or list. The dictionaries' keys are mnemonics for the element it locates.

Benefits:

  • Provide scripts writers a quick reference for time-consuming process of establishing a working locator.
  • Changes to web pages which could break many scripts could be resolved by updating the module.
  • Centralize 'best practices' for locator definition and 'tricks' to address complicated situations.

Naming convention of dictionaries

..._List[ ] references elements that appear once on a list, such as headers or sort selectors.

..._List['item'] references the item node on the list without an index, unlike the _List_Item[ ] locators described below. Could be used with an is_element_present to check if a list contains any items.

  • Suitable for: get_xpath_count()
  • Example: itemCount = sel.get_xpath_count ( AMOlocators.addonBrowsePage_List['item'] )

..._List_Item[ ] references elements on a particular item in a list. All keys require an index value into the list.

  • Suitable for: get_text(), get_attribute()
  • Example 1: addonName = get_text( addonBrowsePage_List_Item['name'] % idx ) retrieves the text for the name on the idx-th add-on in the list.
  • Example 2: addonHref = sel.get_attribute ( AMOlocator.addonCategoryLandingPage_TopRatedList_Item['link'] % idx + "@href" ) retrieves the href attribute in the link for the idx-th item on the Top Rated list on the add-on category landing page.

..._List_Item['item'] references an item node on the list using an index.


Locators that require an index value

Some locators require an index and must be followed by % value where value is the index required for them item in the list, such as add-ons in a list or options in a select.

Locators that require an index are named as followed:

  • all locators in the ..._List_Item[ ] dictionaries.
  • dictionary keys that end in Indexed.


Naming conventions for element locators and dictionary keys

Locators include the tag type at the end of the key for controls that have an action . For example: detailLink, sortSelect. Keys for static elements may use the tag type to reference a specific element, such as PreviewImg.

Dictionary keys that don't end with a tag type generally refer to a section of text or a high level node.

name

  • element with the item name.
  • Suitable for sel.get_text( )

*Link

  • Refers to a link. The last element in the locator is an <a>.  Key name may be simply link for an item with only a few elements.  Key name may be prefixed with the link destination or the element containing the link.
  • Suitable for sel.click( )
  • Example: sel.click( AMOlocator.addonBrowsePage_List_Item['detailLink'] % idx ) clicks on the detail page link for the idx-th add-on listed in the browse page.
  • Suitable for sel.get_attribute for href or other attribute in the <a> node.
  • Example 2: sel.get_attribute( AMOlocator.addonCategoryLandingPage_TopRatedList['ViewAllLink'] + "@href" ) retrieve the href attribute from the View All link of the Top Rated list on the category landing page.

*Select

  • efers to select controls. The last node in the locator is a <select>.
  • Suitable for sel.select()
  • Example: sel.select( AMO_locators.addonsSearchResults['sortSelect'], 'value=' + sortOption) selects from the add-ons search results page the sort option with the 'value' attribute specified by sortOption.
  • Option
  • Refers to options in a select control. The last node in the locator is an <option>.


AMOfunctions

This is intended as a summary of functions. Refer to the in-line function doc regarding parameters and other information.

login - login to a generic user. The parameter is mnenomic for the user type.

submitHeaderSearch - supplies data to the search panel in the AMO header and submits the search. Only the selenium instance (sel) parameter is required, and other parameter are named and optional. The script does not return the search results, rather it returns one of three strings: null string - at least one item was returned in the search results based on locators defined in AMOlocators. itself. 'no results' - the 'No Result Found' message was returned, based on locators defined in AMOlocators 'unexpected layout' - neither of the above conditions were detected using is_element_present( ) and locators for search results page.


getAdminFeaturedList - returns a dictionary of featured items from the admin control panel. Items are qualified by the application and feature type (ex: extensions, persona) specified by the parameters. The parameter values are the corresponding values found in the admin featured items list. See the in-line function doc for more information on the structure of the dictionary that is returned.

isUserURL - returns True if the parameter is the format of a user profile URL, otherwise False.

getAddonIdFromURL - returns the add-on id segment of a URL for an add-on

userURLpattern - returns the pattern for a user profile URL. defined as a function to allow more extendability.

userURLpatternGroup - returns the pattern for a user profile URL with id in a grouping to allow parsing URL id. defined as a function.

isAddonURL - returns True if the parameter is the format of a add-on URL, otherwise False.

addonURLpattern - returns the pattern for a add-on URL. defined as a function to allow more extendability.

addonURLpatternGroup - returns the pattern for a add-on URL with id in a grouping to allow parsing add-on id. defined as a function.

verifyStarsRating - confirms the stars rating elements are in agreement within the locator specified by the parameter. returns a list of strings describing the exceptions found, or an empty list if no exceptions are found.

Retrieved from "https://wiki.mozilla.org/index.php?title=Code_libraries_for_AMO_pages&oldid=208244"