ODOOFX: Odoo library for Robot Framework

pip install robotframework-odoofx

OdooFxLibrary brings Odoo test automation to Robot Framework through two channels under one keyword vocabulary: the Odoo web client, driven through the Browser library, and Odoo's external API (XML-RPC up to Odoo 18, JSON-2 from Odoo 19). A suite can cross them: prepare or check data over the API, drive the screen for what you actually test. It targets Odoo Community and Enterprise, and is proven live on Odoo 16 and Odoo 19 Community (it is designed for Odoo 14 and later; 14, 15, 17 and 18 are not measured yet).

Status: alpha. Both channels work and are proven live on Odoo 16 and 19. Not covered yet: buttons that open a wizard, section and note lines, line deletion. Signatures may still change before 1.0.

Install

Requirements: Python 3.10 or later, Robot Framework 7.4 or later, and an Odoo instance reachable over HTTP. The RPC channel needs nothing more. The web extra (pip install "robotframework-odoofx[web]", then rfbrowser init once for the Playwright browsers) brings the Browser library the web channel is built on; all installs every extra.

Keyword documentation: cyrilm29.github.io/robotframework-odoofx.

Quick start

Over the API, reading a quotation's state:

*** Settings ***
Library    OdooFxLibrary

*** Test Cases ***
Read A Quotation State
    Connect To Odoo    http://localhost:8069    my_database    admin    ${PASSWORD}    channel=xmlrpc
    Assert Quotation Status Is    sale    S00004
    [Teardown]    Disconnect From Odoo

On screen, entering a contact in the web client and reading it back independently:

*** Settings ***
Library     Browser
Library     OdooFxLibrary

*** Test Cases ***
Enter A Company Contact
    ${marker}=    New Odoo Run Marker    prefix=DEMO
    New Browser    chromium    headless=${TRUE}
    New Page    about:blank
    Log In To Odoo Web Client    http://localhost:8069    my_database    admin    ${PASSWORD}
    ...    expected_series=19    allow_write=${TRUE}
    Navigate To Menu    contacts.menu_contacts
    Open New Odoo Web Form
    Fill Odoo Web Field    company_type    company
    Fill Odoo Web Field    name    ${marker} Company
    ${contact_id}=    Save Odoo Web Record
    ${found}=    Search Read Odoo Records Through Web Session    res.partner
    ...    ${{[["id", "=", $contact_id]]}}    fields=${{["name"]}}
    Should Be Equal    ${found}[0][name]    ${marker} Company
    [Teardown]    Run Keywords    Run Keyword And Ignore Error    Discard Odoo Web Changes
    ...    AND    Close Browser

Credentials never live in a suite: pass them on the command line (robot -v "PASSWORD: Secret:..." suite.robot, the Robot Framework 7.4 typed variable keeps them out of the logs) or through the environment.

How it behaves

• The target is proven first. Get Odoo Server Version needs no session; Connect To Odoo and Log In To Odoo Web Client check the database and the Odoo series, and expected_series refuses another Odoo version before anything happens (two Odoo versions often run side by side).
• Technical names and codes, never labels. Labels are translated and change between versions. Menus are opened by external id (sale.sale_menu_root), fields are named by technical name, a radio or selection option is given by its code (one, not its label), states are compared by code (draft, sent, sale, cancel). A label fails an assertion as "not a state code".
• Writes are off unless you opt in (allow_write), on both channels, and every write is journaled with its phase: planned, done, failed or unknown. An unknown write (the answer was lost) is read back and reconciled, never sent again.
• A value is read back as it is typed. A field the web client did not take fails the keyword at once. Relational values are picked among the client's proposals, never through Create or Search more, which would write or open a dialog.
• A form left half-typed is never saved by accident. Odoo saves a form it leaves, so Navigate To Menu, Go Back Through Odoo Web Breadcrumb and Log Out Of Odoo Web Client refuse to leave one with unsaved changes (save or discard first): a failed test never writes what it left behind.

Keywords

Connection, reads and state codes (RPC channel):

Writes and their journal (both channels journal):

Structure of the database (RPC channel):

Web client: session, navigation and reads (built on the Browser library, which opens the browser, the context and the page):

Web client: form entry (screen writes need allow_write at the login and are journaled):

Create New Quotation is a skeleton that only warns: do not rely on it.

Layout

src/OdooFxLibrary/    the library

Issues

Bug reports and suggestions are welcome as GitHub issues.

License

Apache 2.0. See LICENSE and NOTICE.

Trademarks

Odoo is a trademark of Odoo S.A. Robot Framework is a trademark of the Robot Framework Foundation. ODOOFX is an independent project, not affiliated with, sponsored or endorsed by Odoo S.A. or the Robot Framework Foundation.