Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/MarketSquare/Robotframework-Database-Library

The Database Library for Robot Framework allows you to query a database and verify the results using different Python DB modules (installed separately).
https://github.com/MarketSquare/Robotframework-Database-Library

Last synced: about 2 months ago
JSON representation

The Database Library for Robot Framework allows you to query a database and verify the results using different Python DB modules (installed separately).

Host: GitHub
URL: https://github.com/MarketSquare/Robotframework-Database-Library
Owner: MarketSquare
License: other
Created: 2010-11-28T04:37:50.000Z (almost 14 years ago)
Default Branch: master
Last Pushed: 2024-02-28T15:36:02.000Z (7 months ago)
Last Synced: 2024-03-25T20:56:40.820Z (6 months ago)
Language: RobotFramework
Homepage: http://marketsquare.github.io/Robotframework-Database-Library/
Size: 2.35 MB
Stars: 146
Watchers: 27
Forks: 173
Open Issues: 22
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Robot Framework Database Library

The Database Library for [Robot Framework](https://robotframework.org) allows you to query a database and verify the results.

It requires an appropriate **Python module to be installed separately** - depending on your database, like e.g. `oracledb` or `pymysql`. 

The library consists of some keywords designed to perform different checks on your database.

Here you can find the [keyword docs](http://marketsquare.github.io/Robotframework-Database-Library/).

Wath the [talk at Robocon 2024 about the Database Library update](https://youtu.be/A96NTUps8sU)

[![Talk at Robocon 2024 about the Database Library update](http://img.youtube.com/vi/A96NTUps8sU/0.jpg)](https://youtu.be/A96NTUps8sU)

# Requirements

- Python

- Robot Framework

- Python database module you're going to use - e.g. `oracledb`

# Installation

```

pip install robotframework-databaselibrary

```

# Usage examples

## Basic usage

```RobotFramework

*** Settings ***

Library       DatabaseLibrary

Test Setup    Connect To My Oracle DB

*** Keywords ***

Connect To My Oracle DB

    Connect To Database

    ...    oracledb

    ...    dbName=db

    ...    dbUsername=my_user

    ...    dbPassword=my_pass

    ...    dbHost=127.0.0.1

    ...    dbPort=1521

*** Test Cases ***

Person Table Contains Expected Records

    ${output}=    Query    select LAST_NAME from person

    Length Should Be    ${output}    2

    Should Be Equal    ${output}[0][0]    See

    Should Be Equal    ${output}[1][0]    Schneider

Person Table Contains No Joe

    ${sql}=    Catenate    SELECT id FROM person

    ...                    WHERE FIRST_NAME= 'Joe'    

    Check If Not Exists In Database    ${sql}

```

## Handling multiple database connections

```RobotFramework

*** Settings ***

Library          DatabaseLibrary

Test Setup       Connect To All Databases

Test Teardown    Disconnect From All Databases

*** Keywords ***

Connect To All Databases

    Connect To Database    psycopg2    db    db_user    pass    127.0.0.1    5432

    ...    alias=postgres

    Connect To Database    pymysql    db    db_user    pass    127.0.0.1    3306

    ...    alias=mysql

*** Test Cases ***

Using Aliases

    ${names}=    Query    select LAST_NAME from person    alias=postgres

    Execute Sql String    drop table XYZ                  alias=mysql

Switching Default Alias

    Switch Database    postgres

    ${names}=    Query    select LAST_NAME from person

    Switch Database    mysql

    Execute Sql String    drop table XYZ

```

See more examples in the folder `tests`.

# Database modules compatibility

The library is basically compatible with any [Python Database API Specification 2.0](https://peps.python.org/pep-0249/) module.

However, the actual implementation in existing Python modules is sometimes quite different, which requires custom handling in the library.

Therefore there are some modules, which are "natively" supported in the library - and others, which may work and may not.

## Python modules currently "natively" supported

### Oracle

- [oracledb](https://oracle.github.io/python-oracledb/)

    - Both thick and thin client modes are supported - you can select one using the `driverMode` parameter.

    - However, due to current limitations of the oracledb module, **it's not possible to switch between thick and thin modes during a test execution session** - even in different suites.

- [cx_Oracle](https://oracle.github.io/python-cx_Oracle/)

### MySQL

- [pymysql](https://github.com/PyMySQL/PyMySQL)

- [MySQLdb](https://mysqlclient.readthedocs.io/index.html)

### PostgreSQL

- [psycopg2](https://www.psycopg.org/docs/)

### MS SQL Server

- [pymssql](https://github.com/pymssql/pymssql)

### SQLite

- [sqlite3](https://docs.python.org/3/library/sqlite3.html)

### Teradata

- [teradata](https://github.com/teradata/PyTd)

### IBM DB2

- [ibm_db](https://github.com/ibmdb/python-ibmdb)

- [ibm_db_dbi](https://github.com/ibmdb/python-ibmdb)

### ODBC

- [pyodbc](https://github.com/mkleehammer/pyodbc)

- [pypyodbc](https://github.com/pypyodbc/pypyodbc)

### Kingbase

- ksycopg2

# Further references (partly outdated)

- [List of Python DB interfaces](https://wiki.python.org/moin/DatabaseInterfaces)

- [Python DB programming](https://wiki.python.org/moin/DatabaseProgramming)