Robot Framework

Test Automation Training

By Julien Brunet

Available on GitHub at
http://julienbrunet.github.io/robot-training

Agenda

- Introduction
- Robot Framework concepts
- Development basics
- Robot Framework editor : RIDE
- Libraries : Database, Selenium...
- Extending Robot Framework

Introduction

Technologies

RobotFramework is a test automation framework designed for Acceptance Testing (ATDD)

Core is written in Python
Fully compatible with Java (through Jython)

History

Initiated in 2005 by Nokia Siemens Network
Open Sourced in 2008 (release 2)
Big community on the GitHub project
Last version 2.9.1 (August 2015)

http://www.robotframework.org

RobotFramework concepts

Acceptance Testing / Keyword Driven

Acceptance testing

Keyword Driven

Example : test the creation of an order on a web application

Robot Framework development basics

Install RobotFramework package

Download the standalone Robotframerwork package from Github and unzip it on your computer :

The only prerequisite to run this RobotFramework package is java 1.6 min.

Content of the RobotFramework package

This package contains the following folder tree :

robotframework-core		All necessary binaries to run RobotFramework tests
	documentation	Documentation on existing libraries and keywords
	lib	External robotFramework library binaries
	standalone-browsers	Binaries for standalone browsers
	web-drivers	Web drivers executable
tests		Where we write all the tests
	scripts	The entry point of tests
	keywords	The keyword file definition

A first script

Write the following code in a text file named myFirstTest.robot under "scripts" folder

                    
*** Test Cases ***
My First Test
    ${current_year}=    Get Time    year
    Should Start With    ${current_year}    20

Then launch the test by running robot.bat file. You should get a success in the report.html file :

Test script architecture

                        
*** Settings ***
Library    OperatingSystem

*** Variables ***
${PATH_TO_CHECK}    c:\\temp

*** Test Cases ***
Check Host Configuration
    [Documentation]    Check config...
    # Check existence of c:\temp folder
    Should Exists    ${PATH_TO_CHECK}
    Check Host Date Is    2015

*** Keywords ***
Check Host Date Is
    [Documentation]    Check date...
    [Arguments]    ${YEAR}
    ${host_year}=    Get Time    year
    Should Be Equal    ${host_year}    ${YEAR}

Create a new test case with this Robot Framework code

Test script architecture

                        
*** Settings ***
Library    OperatingSystem

*** Variables ***
${PATH_TO_CHECK}    c:\\temp

*** Test Cases ***
Check Host Configuration
    [Documentation]    Check config...
    # Check existence of c:\temp folder
    Should Exists    ${PATH_TO_CHECK}
    Check Host Date Is    2015

*** Keywords ***
Check Host Date Is
    [Documentation]    Check date...
    [Arguments]    ${YEAR}
    ${host_year}=    Get Time    year
    Should Be Equal    ${host_year}    ${YEAR}

* test cases *

List of test cases with each test steps inside. Settings of a test cases are :

[Documentation] Used for specifying the test documentation
[Tags] Used tagging test cases
[Setup], [Teardown] Specify test setup (executed before the test) and teardown (executed after the test, even if test failed)
[Template] Specify the template keyword to use for each step
[Timeout] Set the test case execution timeout (Test fails if timeout is reached)

Test script architecture

                        
*** Settings ***
Library    OperatingSystem

*** Variables ***
${PATH_TO_CHECK}    c:\\temp

*** Test Cases ***
Check Host Configuration
    [Documentation]    Check config...
    # Check existence of c:\temp folder
    Should Exists    ${PATH_TO_CHECK}
    Check Host Date Is    2015

*** Keywords ***
Check Host Date Is
    [Documentation]    Check date...
    [Arguments]    ${YEAR}
    ${host_year}=    Get Time    year
    Should Be Equal    ${host_year}    ${YEAR}

* keywords *

Contains keywords commons to your test suite. Keywords declared here can be used anywhere in the suite, even in setup and teardown calls. Keywords settings are:

[Documentation] Used for specifying the keyword documentation
[Arguments] Specify the keyword arguments
[Return] Specify the keyword return value
[Timeout] Set the keyword execution timeout (Test fails if timeout is reached)

Test script architecture

                        
*** Settings ***
Library    OperatingSystem

*** Variables ***
${PATH_TO_CHECK}    c:\\temp

*** Test Cases ***
Check Host Configuration
    [Documentation]    Check config...
    # Check existence of c:\temp folder
    Should Exists    ${PATH_TO_CHECK}
    Check Host Date Is    2015

*** Keywords ***
Check Host Date Is
    [Documentation]    Check date...
    [Arguments]    ${YEAR}
    ${host_year}=    Get Time    year
    Should Be Equal    ${host_year}    ${YEAR}

* variables *

Define variables at a "tests suite scope". Variables declared here are accessible from every test cases, keywords or settings

Test script architecture

                        
*** Settings ***
Library    OperatingSystem

*** Variables ***
${PATH_TO_CHECK}    c:\\temp

*** Test Cases ***
Check Host Configuration
    [Documentation]    Check config...
    # Check existence of c:\temp folder
    Should Exists    ${PATH_TO_CHECK}
    Check Host Date Is    2015

*** Keywords ***
Check Host Date Is
    [Documentation]    Check date...
    [Arguments]    ${YEAR}
    ${host_year}=    Get Time    year
    Should Be Equal    ${host_year}    ${YEAR}

* settings *

Import libraries

Library    libraryName    arg1    arg2...

Import External Keyword resources

Resource    ../../keywords/myKWords.robot

Setup and Teardown


Suite Setup    My Suite Setup Keyword
Suite Teardown    My Suite Setup Keyword
Test Setup    My Test Setup Keyword
Test Teardown    My Test Setup Keyword

Resource files

                        
*** Settings ***
Library    OperatingSystem

*** Variables ***
${EXPECTED_YEAR}    2015

*** Keywords ***
Check Host Date Is
    [Documentation]    Check date...
    ${host_year}=    Get Time    year
    Should Be Equal    ${host_year}    ${EXPECTED_YEAR}

No *** Test Cases *** section in resource files !

Initialization files

__init__.ext

                        
*** Settings ***
Suite setup    Do Something
Library        SeleniumLibrary
Resource       ../keywords/myKw.robot

*** Variables ***
${MY_VAR}    foo

*** Keywords ***
Do Something
    Log    ${MY_VAR}

This file is executed before each other test suites of the current folder
Resource imported in this file are also available for all the test suites in the same folder
Libraries, Variables, Keywords are NOT available for suites in the same folder

RobotFramework Editor : RIDE

RIDE (RobotFramework Integrated Development Editor) is a light-weight and intuitive editor for Robot Framework test case files written in Python.

Download RIDE here
More information on github here

RobotFramework libraries

Official Libraries

External Libraries

Built In	All RobotFramework basic keywords
Operating System	Enables various O.S. related tasks (Files, Run commands…)
Collections	Keywords for handling lists and dictionaries
Strings	String manipulation and verification
...	etc

Selenium	For web application testing
SSHLibrary	Connect and run commands on SSH remote server
DbLibrary	Common fonctionnality for testing database content
...	etc

Exercise 1 Automation with database library

Write a keyword that connect to the database and run an init sql script

Launch the H2 database exercises\ex1\tools\h2\start_server.bat
In a RobotFramework test case
- Import the library named org.robot.database.keywords.DatabaseLibrary
- Connect to the h2 database with the good driver
- Run the file exercises\ex1\init_data.sql
- Verify the number of row in table "TEST_TABLE" is 3

Use the documentation !!!

Selenium A web app test automation framework

Write a test case that connect to Wikipedia and search for RobotFramework page

Import the library named Selenium2Library
Open a firefox browser to http://en.wikipedia.org/
In the search bar write "Robot Framework" and click on search button
Verify the displayed page contains the text "Robot Framework is a generic test automation framework"

Use the documentation !!!

Selenium Locating elements

All keywords in Selenium2Library that need to find an element on the page take a locator argument. A locator is an attribute of the html tag we want to work with.

Selenium Locating elements

For example if we want to locate this element in a web page

<input id="searchInput">

Then the locator is id=searchInput

So in Robot Framework code we can write

                            Wikipedia Search
    Open Browser   http://en.wikipedia.org
    Input text    id=searchInput    Robot Framework

Selenium Locating elements with XPath

XPath (XML Path language) is a query language for selecting node in an XML document

Syntax in Robot Framework script

                            Input text    xpath="xpath value"    Robot Framework

Selenium Locating elements with XPath

                        
<html>
    <title>My Page</title>
    <body>
        <span id="welcome-msg">
            Hello World
        </span>
        <div name="form1">
            <input id="searchInput">
            <input type="button"
                   value="Valider">
        </div>
    </body>
</html>

/html/body/span

//span

//input

//input[@id='searchInput']

//*[text()='Hello World']

//*[contains(text(),'Hello']

Exercice 2 : Try it yourlself !

Open the file example.html with firefox and tests the previous XPath with Firepath extension

Exercice 3 : Locate element with XPath

Open the file fake-data.html with firefox and locate the following element with XPath :

The input field 1 by using its id
The label "field 3" by using its content text
The input field 3 by using its label on the side
The email "jhunter5@gnu.org" (using text)
The IP Address of "Juan King" by using its email text

Exercice 4 : XPath in RobotFramework script

Write a test case that open to Wikipedia page of New York city, and write keyword returning the population for a given decade

The final test case should look like :

                            
Check NY Population
    Open Browser    https://en.wikipedia.org/wiki/New_York
    ${population1910}=    Get NY Population    1910
    Should Be Equals    ${population1910}    9,113,614

You must write the keyword Get NY Population !

Extend RobotFramework

Extend RbF with Java

Your projet will need the RobotFramework Java Lib Core

                        
@RobotKeywords
public class FTPLibrary {

    public FTPLibrary(){}

    @RobotKeyword(
        "Put a file via ftp\n" +
        "Example :\n" +
        "| Ftp Put | 192.168.1.1 | user | passwd | C:\\myFile.txt | /home/user/dir |")
    @ArgumentNames({"host","user","passwd","filePath","targetDirectory"})
    public void ftpPut(String host, String user, String passwd, String filePath, String targetDirectory)
       // Your Java code
    }
}

For more information, check the Java lib core documentation

Conclusion

Any question ?

Robot Framework

Test Automation Training

Agenda

Introduction

Technologies

History

RobotFramework concepts

Acceptance Testing / Keyword Driven

Acceptance testing

Keyword Driven

Keyword Driven

Robot Framework development basics

Install RobotFramework package

Content of the RobotFramework package

A first script

Test script architecture

Test script architecture

*** test cases ***

Test script architecture

*** keywords ***

Test script architecture

*** variables ***

Test script architecture

*** settings ***

Resource files

Initialization files

RobotFramework Editor : RIDE

RobotFramework libraries

Extend RobotFramework

Conclusion

* test cases *

* keywords *

* variables *

* settings *