Recent changes to Home

Home modified by Olivier Meurice

Olivier Meurice — Mon, 01 Jun 2015 10:57:25 -0000

--- v62
+++ v63
@@ -402,6 +402,16 @@
 click: send a lick event if set to true
 dbclick: send a double click event if set to true
 widget: optional parameter for the widget name
+
+**screen** (release >= 1.2)
+*Description*
+Take a screen snapshot and compare it with the snapshot file at the specified location. If none exists yet then the image is saved at the specified path and may be used for comparison at next test run.
+*Syntax*
+screen file:'filename', name:'name', threshold:n
+*Parameters*
+file:path and file name of the snapshot image.
+name: name of the image
+threshold (optional): percentage as a double value. It specifies the threshold as from the image difference must be reported. For instance if threshold value is '1' than a difference lower of equal to 1% between images won't be reported. Default value if not specified is '0'.

 **Locator parameters**
 These attributes are used to find the element on the page.

Home modified by Olivier Meurice

Olivier Meurice — Mon, 01 Jun 2015 10:50:59 -0000

--- v61
+++ v62
@@ -241,7 +241,7 @@
 *Remark*
 May have child elements of type <input>, <button> or <block> and therefore is the most important element to compose <xwidget> elements.

-**<screen>** (release > 1.2)
+**<screen>** (release >= 1.2)
 *Description*
 Take a screen snapshot and compare it with the snapshot file at the specified location. If none exists yet then the image is saved at the specified path and may be used for comparison at next test run.
 *Specific attributes*

Home modified by Olivier Meurice

Olivier Meurice — Tue, 07 Apr 2015 11:40:07 -0000

--- v60
+++ v61
@@ -331,7 +331,8 @@
 *Syntax*
 click any_locator_parameter
 *Parameter*
-A single parameter that may be any of the locator parameter (see below).
+A parameter that may be any of the locator parameter (see below).
+widget: optional parameter for the widget name
 *Examples*
 click id:'buttonId'
 click className:'buttonClassId', widget:'SomeFramework'
@@ -343,7 +344,8 @@
 input any_locator_parameter, value:'text value'|checked:[true|false]
 *Parameters*
 A parameter from the locator parameter list
-value|checked: set the input text value with value parameter or the boolean value for a box with checked parameter
+value|checked: set the input text value with value parameter or the boolean value for a box with checked parameter.
+widget: optional parameter for the widget name
 *Examples*
 input id:'textInputId', value:'some text', timeout:1
 input id:'radioId', checked:true, timeout:1
@@ -357,6 +359,7 @@
 Any parameter from the locator parameter list.
 visibleText: a text value for the select item text displayed that should be selected.
 value: the value as string for the select item to be selected.
+widget: optional parameter for the widget name
 *Example*
 select id:'listId', visibleText:'item text'

@@ -398,6 +401,7 @@
 A parameter from the locator parameter list.
 click: send a lick event if set to true
 dbclick: send a double click event if set to true
+widget: optional parameter for the widget name

 **Locator parameters**
 These attributes are used to find the element on the page.

Home modified by Olivier Meurice

Olivier Meurice — Tue, 07 Apr 2015 11:37:28 -0000

--- v59
+++ v60
@@ -378,10 +378,10 @@
 If the timeout exceeds before the element value or the checked, readOnly or enabled attribute is not equal to the value specified as parameter than the test exists with a failure status.
 Function *expect* does not aim to detect the presence of an element on the page.  For that purpose function wait must be used.
 *Syntax*
-expect any_locator_parameter, value='text value'|checked:[true|false]|readOnly:[true|false]|enabled[true|false], timeout:n
+expect any_locator_parameter, text:'text value', value:'text value'|checked:[true|false]|readOnly:[true|false]|enabled[true|false], timeout:n
 *Parameters*
 A parameter from the locator parameter list.
-value|checked|readOnly|enabled: depending on the type of input a text or a boolean value can be provided. The readOnly parameter takes a boolean value and is used to check that the tested field is writable or not. Enabled is also of boolean type and is used to checked that the tested field is enabled or not.
+text|value|checked|readOnly|enabled: depending on the type of input a text or a boolean value can be provided. The readOnly parameter takes a boolean value and is used to check that the tested field is writable or not. Enabled is also of boolean type and is used to checked that the tested field is enabled or not. Parameter text is used to match any element text (<any_element>text_to_match</any_element>).
 timeout: numerical value, if the timeout exceeds and the tested value (value|checked|readOnly|enabled) does not match that the test fails.
 *Example*
 expect id:'textElementId', value:'expected text value'

Home modified by Olivier Meurice

Olivier Meurice — Tue, 07 Apr 2015 11:33:57 -0000

--- v58
+++ v59
@@ -365,6 +365,9 @@
 This instruction refers to an XML file that describes the processing of a HTML element. Further information on this is available in section "Extending the capabilities"
 *Syntax*
 xwidget file:'file path', vars:'key/value list'
+*Parameters*
+file: the file path and name of the XML file that contains the widget definition.
+vars: parameters that are passed to the XML.
 *Example*
 xwidget file:'/home/project/customWidget.xml', vars:'value=some_value,text=someText'
 Warning: always use forward slashes in any OS.
@@ -376,6 +379,10 @@
 Function *expect* does not aim to detect the presence of an element on the page.  For that purpose function wait must be used.
 *Syntax*
 expect any_locator_parameter, value='text value'|checked:[true|false]|readOnly:[true|false]|enabled[true|false], timeout:n
+*Parameters*
+A parameter from the locator parameter list.
+value|checked|readOnly|enabled: depending on the type of input a text or a boolean value can be provided. The readOnly parameter takes a boolean value and is used to check that the tested field is writable or not. Enabled is also of boolean type and is used to checked that the tested field is enabled or not.
+timeout: numerical value, if the timeout exceeds and the tested value (value|checked|readOnly|enabled) does not match that the test fails.
 *Example*
 expect id:'textElementId', value:'expected text value'
 expect id:'textElementId', enabled:true, timeout:3
@@ -386,7 +393,11 @@
 *Description*
 Instruction used to interact with any element other than an input element. Also useful when the widget attribute is specified, to execute custom action strategy for specific elements See "Extending the capabilities" for further information. It is also the only instruction capable of sending a double click event to an element.
 *Syntax*
-block any_locator_parameter, widget:'wigdetId', text:'some text', click:[true|false], dbclick:[true|false], timeout:n
+block any_locator_parameter, widget:'wigdetId', click:[true|false], dbclick:[true|false], timeout:n
+*Parameters*
+A parameter from the locator parameter list.
+click: send a lick event if set to true
+dbclick: send a double click event if set to true

 **Locator parameters**
 These attributes are used to find the element on the page.

Home modified by Olivier Meurice

Olivier Meurice — Tue, 07 Apr 2015 11:22:44 -0000

--- v57
+++ v58
@@ -353,6 +353,10 @@
 Its purpose is to interact with a list box. It also accepts the widget parameter.
 *Syntax*
 select any_locator_parameter, visibleText:'text item'|value:'value item'
+*Parameters*
+Any parameter from the locator parameter list.
+visibleText: a text value for the select item text displayed that should be selected.
+value: the value as string for the select item to be selected.
 *Example*
 select id:'listId', visibleText:'item text'

Home modified by Olivier Meurice

Olivier Meurice — Tue, 07 Apr 2015 11:04:27 -0000

--- v56
+++ v57
@@ -340,7 +340,10 @@
 *Description*
 Used to provide a value to a text input element or to check/uncheck a box. It also accepts the widget parameter.
 *Syntax*
-input any_locator_parameter, value:'text value'|checked:[true|false], timeout:n
+input any_locator_parameter, value:'text value'|checked:[true|false]
+*Parameters*
+A parameter from the locator parameter list
+value|checked: set the input text value with value parameter or the boolean value for a box with checked parameter
 *Examples*
 input id:'textInputId', value:'some text', timeout:1
 input id:'radioId', checked:true, timeout:1

Home modified by Olivier Meurice

Olivier Meurice — Fri, 03 Apr 2015 06:09:37 -0000

--- v55
+++ v56
@@ -366,7 +366,7 @@
 *Description*
 Aims to perform a validation on a page element. It may be used to check an input text element value, if a box is checked or not or if an element is read only or enabled.
 If the timeout exceeds before the element value or the checked, readOnly or enabled attribute is not equal to the value specified as parameter than the test exists with a failure status.
-Function expect does not aim to detect the presence of an element on the page.  For that purpose function wait must be used.
+Function *expect* does not aim to detect the presence of an element on the page.  For that purpose function wait must be used.
 *Syntax*
 expect any_locator_parameter, value='text value'|checked:[true|false]|readOnly:[true|false]|enabled[true|false], timeout:n
 *Example*

Home modified by Olivier Meurice

Olivier Meurice — Fri, 03 Apr 2015 06:08:19 -0000

--- v54
+++ v55
@@ -12,7 +12,7 @@
 Thanks to the fact that its code was easily extensible I could quickly add elements to its XML element library for solving specific cases.  Step by step I improved the tool and re-factored the code so that a minimum set of elements was required, keeping the possibility to add Java code for writing specific elements for particular cases if needed. I also improved the integration with Picvert for writing complete end-user test plan and integrate with Jenkins.
 The possibility of designing reusable elements with XML was also developed.  That reduced the effort for automating the test of some complex elements since no Java code was required for extending the test capabilities.
 As of release 1.2 screen comparison and a true DSL were added.
-Aigrette is now an open source project freely available.
+Aigrette is now an open source project freely available that may be handy when no other testing tool is proposed with your development framework.

 #Purpose

@@ -305,49 +305,51 @@

 **wait**
 *Description*
-Wait until the element is visible on the page.
-*Syntax*
-wait any_locator_attribute, timeout:n
+Wait until the element is visible on the page. This function aims to suspend the test until a certain element is available on the page. It is used to detect that a page is loaded or to ensure that an element is actually on the page before trying to interact with it. This second use case is very common with applications that dynamically add elements in response of user action for example.
+*Syntax*
+wait any_locator_parameter, timeout:n
 *Parameters*
-The first parameter is any of the locator attribute (see below)
+The first parameter is any of the locator parameter (see below)
 timeout: value in second, if the timeout exceeds before the element is found than the test exits with a failure status.
 *Example*
 wait id:'elementId', timeout:3

 **uwait**
 *Description*
-Similar to the wait instruction it waits until the located element has disappeared.
-*Syntax*
-uwait any_locator_attribute, timeout:n
+Similar to the wait instruction it waits until the located element has disappeared. It may be used for example to detect that a popup has disappeared before being able to interact with the parent page.
+*Syntax*
+uwait any_locator_parameter, timeout:n
 *Parameters*
-One of the parameter must be one of the locator attribute (see below)
+One of the parameter must be one of the locator parameter (see below)
 timeout: value in second, if the timeout exceeds before the element is removed from the page than the test exits with a failure status.
 *Example*
 uwait id:'elementId', timeout:10

 **click**
 *Description*
-Triggers the click event on the located element.  It also accepts the widget attribute.
-*Syntax*
-click any_locator_attribute
+Triggers the click event on the located element.  It also accepts the widget parameter. Main purpose is to trigger a click event on a button but it may be used for any element on the page on which a click event must be triggered.
+*Syntax*
+click any_locator_parameter
+*Parameter*
+A single parameter that may be any of the locator parameter (see below).
 *Examples*
 click id:'buttonId'
 click className:'buttonClassId', widget:'SomeFramework'

 **input**
 *Description*
-Used to provide a value to a text input element or to check/uncheck a box. It also accepts the widget attribute.
-*Syntax*
-input any_locator_attribute, value:'text value'|checked:[true|false], timeout:n
+Used to provide a value to a text input element or to check/uncheck a box. It also accepts the widget parameter.
+*Syntax*
+input any_locator_parameter, value:'text value'|checked:[true|false], timeout:n
 *Examples*
 input id:'textInputId', value:'some text', timeout:1
 input id:'radioId', checked:true, timeout:1

 **select**
 *Description*
-Its purpose is to interact with a list box. It also accepts the widget attribute.
-*Syntax*
-select any_locator_attribute, visibleText:'text item'|value:'value item'
+Its purpose is to interact with a list box. It also accepts the widget parameter.
+*Syntax*
+select any_locator_parameter, visibleText:'text item'|value:'value item'
 *Example*
 select id:'listId', visibleText:'item text'

@@ -363,8 +365,10 @@
 **expect**
 *Description*
 Aims to perform a validation on a page element. It may be used to check an input text element value, if a box is checked or not or if an element is read only or enabled.
-*Syntax*
-expect any_locator_attribute, value='text value'|checked:[true|false]|readOnly:[true|false]|enabled[true|false], timeout:n
+If the timeout exceeds before the element value or the checked, readOnly or enabled attribute is not equal to the value specified as parameter than the test exists with a failure status.
+Function expect does not aim to detect the presence of an element on the page.  For that purpose function wait must be used.
+*Syntax*
+expect any_locator_parameter, value='text value'|checked:[true|false]|readOnly:[true|false]|enabled[true|false], timeout:n
 *Example*
 expect id:'textElementId', value:'expected text value'
 expect id:'textElementId', enabled:true, timeout:3
@@ -375,9 +379,9 @@
 *Description*
 Instruction used to interact with any element other than an input element. Also useful when the widget attribute is specified, to execute custom action strategy for specific elements See "Extending the capabilities" for further information. It is also the only instruction capable of sending a double click event to an element.
 *Syntax*
-block any_locator_attribute, widget:'wigdetId', text:'some text', click:[true|false], dbclick:[true|false], timeout:n
-
-**Locator atributes**
+block any_locator_parameter, widget:'wigdetId', text:'some text', click:[true|false], dbclick:[true|false], timeout:n
+
+**Locator parameters**
 These attributes are used to find the element on the page.
 **id**: element id
 **name**: element name

Home modified by Olivier Meurice

Olivier Meurice — Fri, 03 Apr 2015 05:50:46 -0000

--- v53
+++ v54
@@ -282,7 +282,7 @@
 *Example*
 driver browser:Chrome, size:'1200,800'
 To test against a Selenium Grid additional url parameter must be provided.
-*Example*
+*Example for server test*
 driver browser:Chrome, size:'1200,800', url:'http://localhost:4444/wd/hub'

 **get**
@@ -298,6 +298,8 @@
 Explicit delay in second
 *Syntax*
 delay n
+*Parameter*
+This function takes a single anonymous parameter for the delay value in second.
 *Example*
 delay 5

@@ -306,6 +308,9 @@
 Wait until the element is visible on the page.
 *Syntax*
 wait any_locator_attribute, timeout:n
+*Parameters*
+The first parameter is any of the locator attribute (see below)
+timeout: value in second, if the timeout exceeds before the element is found than the test exits with a failure status.
 *Example*
 wait id:'elementId', timeout:3

@@ -314,6 +319,9 @@
 Similar to the wait instruction it waits until the located element has disappeared.
 *Syntax*
 uwait any_locator_attribute, timeout:n
+*Parameters*
+One of the parameter must be one of the locator attribute (see below)
+timeout: value in second, if the timeout exceeds before the element is removed from the page than the test exits with a failure status.
 *Example*
 uwait id:'elementId', timeout:10