Docs Help

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

Sencha Test 2.2.0


top

Sencha Test CLI (STC)

In order to provide integration with continuous integration (CI) servers like Jenkins and Teamcity, Sencha Test allows you to execute tests for an existing scenario from the command-line. The command-line tool doesn't support launching of local browsers, which means a browser farm and browser pool must be configured for the target scenario.

Let's walk through executing a test via CLI.

Command Line Syntax

The basic command-line syntax for executing a test from the command line is as follows:

stc run -o output -p pool -s scenario

Required Flags

Here are the optional flags that may be passed along via your command line execution:

-o <output> - Output format. Supported values are text, teamcity and junit

-p <pool> - Name of the pool from whence tests will be executed. This must be a pool associated with a browser farm

-s <scenario> - Path to the scenario to be executed. If unspecified, defaults to the current directory.

In the following example to be run from a Windows command line, we are executing tests for:

  • The scenario located at tests\unit_tests
  • In the browser pool called My WebDriver Pool
  • Providing output in TeamCity format

      stc run -o teamcity -p "My WebDriver Pool" -s tests\unit_tests
    

Optional Flags

Here are some optional flags that can be used:

--debug - Sets log level to a higher verbosity

Code Coverage

Code coverage can be enabled for In-Browser Scenarios as follows:

-C - Enables code coverage for this session

To exclude files/folders from the scope of the code coverage report, use the Project Settings screen in Sencha Studio. For example, the Ext JS SDK directory should be excluded, as you would want to focus the code coverage analysis on just your own application code. To exclude all code files within the ext directory, use this code coverage filter:

^/ext/.*?$

To access the Code Coverage reports, use Sencha Studio to view test results that have been saved in an Archive Server.

Screenshot Comparison

To perform image comparisons from screenshots, Sencha Test will use an existing run as the reference (baseline) against which each image will be compared. If a baseline for comparison is not present, all comparisons will pass, and the resulting archive directory can then be specified as the baseline for future comparisons.

To use a specific result archive as baseline, it has to be copied or renamed to ${workspace.dir}/reports/baseline. Alternatively, the -b switch can be used to specify any arbitrary result archive directory.

-b <baseline> - Path to the result archive directory to be used as baseline for image comparisons

By default, Sencha Studio will assign a dynamically generated build number to each test execution. To specify the build number for a given test run, the -n switch can be used.

-n <build_number> - Build number for the test execution

By specifying the baseline directory and the build number, it's possible to control all the directory and file names associated with the test execution. This way, one can easily archive test results and fetch arbitrary baselines in a CI system.

Cloud-based Browser Farm Options

In order to execute tests in a cloud-based browser farm such as SauceLabs or BrowserStack, you can specify credentials and callback address. Here are the options that may be applied:

-u <username> - Username for the browser farm

-k <key> - Access key for the browser farm

--notunnel - If specified, disables the automatic launch and teardown of the tunnel to the specified cloud provider. When this switch is used, a tunnel for the specified username must be already running, either in the local machine or in a dedicated host in the same network.

Note: The auto-connecting tunnel feature is not currently available in the product. All tunnels will need to be manually created until auto-tunnel creation is built-in.

-c <callback_address> - Callback address - host or IP by which the farm browsers can dial back to Sencha Test's proxy. If unspecified, defaults to localhost. This switch is particularly useful when a dedicated tunnel is being used. In such case, it's likely to be the local machine's LAN IP address.

In the following example to be run from a Linux command line, we are executing tests for:

  • Tests found within tests\unit-tests

  • In the pool named SauceLabs pool

  • Providing output in Jenkins format

  • Using the credentials username:xxxxx-xxxx-xxxx-xxxx-xxxxx will be used

  • A SauceConnect tunnel will not be launched automatically. This means the user is responsible for starting one manually.

  • All browsers will attempt to connect to http://192.168.1.42

Example:

stc run -o junit -p "SauceLabs pool" -s tests\unit_tests -u user -k *x-x-x-x-x* --notunnel -c *192.168.1.42*

Sencha Test 2.2.0