QA/Execution/Web Testing/Selenium Python: Difference between revisions

← Older edit

QA/Execution/Web Testing/Selenium Python (view source)

Revision as of 22:54, 14 March 2010

2,434 bytes added , 14 March 2010

→‎Shared Libraries

Twsmith

1,072

edits

@@ Line 12: / Line 12: @@
 #Open the .htm script in Selenium IDE.<br>
-#Select File &gt; Export Test Case As &gt; Python - Selenium RC. A .py file extension associates the file with Python.&nbsp; Because the exporter creates class names based on the Python script file name, the file name should be limited to "safe" characters such as letters, numbers and underscores.<br>
+#Select File &gt; Export Test Case As &gt; Python - Selenium RC. A .py file extension associates the file with Python.&nbsp; Because the exporter creates class names based on the Python script file name, the file name should be limited to "safe" characters such as letters, numbers and underscores. A dash will create an invalid class name, as will other 'operator' characters. <br>
 #Edit the Python script as needed in Python IDLE&nbsp;or a text editor.<br>
 <blockquote>
 *The '''setUp def''' may require changes to parameters in ''self.selenium = selenium( )'', which is the call that launches the browser. The 3rd parameter is the browser type. The 4th parameter is the base URL when starting the script. For more information see the Selenium RC doc [http://seleniumhq.org/docs/05_selenium_rc.html#starting-the-browser Starting the Browser].<br>
 *Comments on how specific IDE commands are converted to Python can be found below.
 </blockquote>
+==== Method B - Build a Python script from scratch.  ====
+The [http://docs.python.org/library/unittest.html Python unit testing framework] is the foundation of the tests.
+*The Python documentation has a [http://docs.python.org/library/unittest.html#basic-example basic example] that demonstrates its usage.
+*Selenium org's RC documentation has an example of a [http://seleniumhq.org/docs/05_selenium_rc.html#python Python script], which is the same structure created by the IDE exporter to Python.
+The Python unit testing framework is separate from the Selenium class which interacts with the browser.
+*The Python code [http://seleniumhq.org/docs/05_selenium_rc.html#starting-the-browser here] are the commands that create the selenium instance and start the browser.
+*The Python Selenium class documentation is on the client in the RC directory at selenium-remote-control-1.0.1\selenium-python-client-driver-1.0.1\doc\index.html. Generally every Selenium IDE command has similarly named command in Python, although there are exceptions as noted in the next point.
-==== Method B - Build a Python script from scratch.  ====
+*The Selenium IDE can generate Python code for individual SIDE commands by exporting a "script" to Python that contains only one or a few commands. The exporter does not require a fully operational script. An single SIDE command may be translated to one or more Python functions. For example, the verifyXYZ IDE commands are generally translated to a get_xyz( ) passed to an assertion function.
-Selenium org's RC documentation contains an example of a [http://seleniumhq.org/docs/05_selenium_rc.html#python script in Python] which uses the [http://docs.python.org/library/unittest.html Python unit testing framework] and includes the call that [http://seleniumhq.org/docs/05_selenium_rc.html#starting-the-browser starts the browser]. It uses the same structure created by the IDE exporter.
+==== Shared Libraries  ====
-The Python selenium class documentation is on the client in the RC directory at selenium-remote-control-1.0.1\selenium-python-client-driver-1.0.1\doc\index.html
+[[Code libraries for AMO pages]] are available to help centralize code and simplify python scripts. &nbsp;They contain functions that execute features and locators for page elements.<br>
 <br>
 === Setting Up Selenium RC  ===
@@ Line 64: / Line 77: @@
 *To start a script in the debugger enter<br>
 <blockquote>python -m pdb ''myscript''<br> where ''myscript'' is the script file.&nbsp; More information about the debugger [http://docs.python.org/library/pdb.html here]. </blockquote>
 <br>
 === Things we don't understand yet  ===
@@ Line 81: / Line 94: @@
 === Comments on the SIDE script exporter for Python  ===
-*'''Indent the body of the script.&nbsp; '''A code block in Python is defined by indention rather than delimiters such as {&nbsp;}.&nbsp; While the exporter correctly indents the Python testing functions that drive the script, most of the converted IDE commands are not.&nbsp; Those statements need to be indented to the same level as the sel = self.selenium statement - 8 spaces. &nbsp;Note that the indention is in spaces and not tabs. Mixing them causes errors.
+*'''Indent the body of the script.&nbsp; '''A code block in Python is defined by indention rather than delimiters such as {&nbsp;}.&nbsp; While the exporter correctly indents the Python testing functions that drive the script, most of the converted IDE commands are not.&nbsp; Those statements need to be indented to the same level as the sel = self.selenium statement. &nbsp;Note that indention is in spaces and not tabs. Mixing them causes errors.
-<blockquote>The VI editor can insert spaces at the beginning of lines as follows: 1) in visual mode type capital V and highlight the lines to indent. 2) in command mode enter <pre>'&lt;,'&gt;s/^/        /</pre>
+<blockquote>
-which will insert at the beginning of each highlighted line the spaces between the last two slashes.
+*The Python IDLE&nbsp;editor has a simple block indention command:&nbsp;1)&nbsp;highlight the lines to indent, 2)&nbsp;select from the menu Format &gt;&nbsp;Indent Region.&nbsp; The Format menu also has Dedent, which is a reverse indent.
-</blockquote>
+</blockquote> <blockquote>
-*'''while, whileEnd, goto, gotoIf, label''' and other commands that are not Selenium built-ins are converted as a call to the selenium class and marked as a comment. The commands can be found by searching for "# sel."<br>
+*The VI editor can insert with spaces as follows: 1) in visual mode type capital V and highlight the lines to indent. 2) in command mode enter
+<blockquote><pre>'&lt;,'&gt;s/^/        /</pre></blockquote> <blockquote>which inserts at the beginning of each highlighted line the spaces between the last two slashes.&nbsp; Identation within functions, while-loops, if-then statements, etc is normally 4 spaces.</blockquote></blockquote> <blockquote>
+*The VI&nbsp;editor can be set to use 4 spaces in place of a tab with the following entered in command&nbsp; mode:
+<blockquote><pre>set tabstop=4 expandtab shiftwidth=4 softtabstop=4
+</pre></blockquote> <blockquote>(can someone explains what this means?)</blockquote></blockquote>
+*'''while, whileEnd, goto, gotoIf, label''' and other commands that are not Selenium built-ins are converted as a call to the selenium instance and marked as a comment. They can be found by searching for "# sel." All comments that begin this way will likely need a Python equivalent.<br>
 *'''gotoIf '''and '''goto''' commands in an IDE script were perhaps a substitute for a if-else statement or other high-level language control flow.
-*'''Review sel.get_eval( ) calls''' since most can be simplified.&nbsp;&nbsp; The IDE exporter converts the 1st parameter of an storeEval, store or storeExpression command to a string for the Python get_eval( ).&nbsp; Although get_eval stills executes the string as JavaScript, it may not create the same results as in IDE and generally should be rewritten in Python anyway.&nbsp; In particular, ''storedVars['myVar']'' will not reference the variable ''myVar''.
+*'''Replace sel.get_eval( )''' with appropriate Python statements.&nbsp; The IDE exporter converts the 1st parameter of an storeEval, store or storeExpression command to a string for the Python get_eval( ) which executes the string as JavaScript. It may not create the same results as in IDE and generally will be simpler in Python anyway.&nbsp; In particular, ''storedVars['myVar']'' will not reference the variable ''myVar''.
 *'''Review print( ) calls'''. Although the IDE exporter seperates literal text from variables names, the '+' operator may not always be desired.
 *'''wait_for_page_to_load( )''' is given a string value.&nbsp; It makes sense for it to be a numeric value, perhaps a constant.
@@ Line 94: / Line 111: @@
 <blockquote>
 *the Python statement may not have the same verification functionality as the IDE command since the IDE pattern parameter is converted without parsing the prefix (ex: regexpi: ).&nbsp; The Python module for regular expressions is named [http://docs.python.org/library/re.html?highlight=regular%20expressions#module-contents re].
 *changing the failXYZ calls to assertABC could make the script easier to read.
+*element verification errors are reported by a ''try-except'' statement that surrounds each assert/fail call and appends an error message to a verificationErrors list.&nbsp; At the end of the script, in the tearDown function, the list is dumped and the Python traceback is called if the list is not null.
+*TBD: other information to include in error message, such as element identifier/locator, regular expressions, expected and actual values, add-on/persona name, category.
+*TBD: formating and printing the verification errors for post-runtime processing by the test execution framework.<br>
 </blockquote>