https://github.com/tilakpatidar/pytest-snowflake_bdd
Setup test data and run tests on snowflake in BDD style!
https://github.com/tilakpatidar/pytest-snowflake_bdd
bdd bdd-framework pytest pytest-plugin snowflake testing
Last synced: 24 days ago
JSON representation
Setup test data and run tests on snowflake in BDD style!
- Host: GitHub
- URL: https://github.com/tilakpatidar/pytest-snowflake_bdd
- Owner: tilakpatidar
- License: mit
- Created: 2021-12-17T07:26:01.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-05T17:56:02.000Z (over 4 years ago)
- Last Synced: 2025-12-15T11:41:50.723Z (4 months ago)
- Topics: bdd, bdd-framework, pytest, pytest-plugin, snowflake, testing
- Language: Python
- Homepage:
- Size: 59.6 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
pytest-snowflake_bdd
--------------------
.. image:: https://img.shields.io/pypi/v/pytest-snowflake_bdd.svg
:target: https://pypi.org/project/pytest-snowflake_bdd
:alt: PyPI version
.. image:: https://img.shields.io/pypi/pyversions/pytest-snowflake_bdd.svg
:target: https://pypi.org/project/pytest-snowflake_bdd
:alt: Python versions
Setup test data and run tests on snowflake in BDD style!
--------------------
Features
--------
Provides `pytest-bdd`_ step definitions for testing snow-sql scripts against a snowflake account.
Installation
------------
You can install "pytest-snowflake_bdd" via `pip`_.
$ pip install pytest-snowflake-bdd
Usage
-----
This plugin relies on `pytest-bdd`_ to run bdd tests.
You can pass your snowflake account details using the cli arguments to pytest command.
.. code:: shell
custom options:
--snowflake-user=SNOWFLAKE_USER
snowflake user for test environment
--snowflake-password=SNOWFLAKE_PASSWORD
snowflake password for test environment
--snowflake-account=SNOWFLAKE_ACCOUNT
snowflake password for test environment
--snowflake-role=SNOWFLAKE_ROLE
optional snowflake role for test environment
--snowflake-warehouse=SNOWFLAKE_WAREHOUSE
optional snowflake warehouse for test environment
Below example illustrates the usage of step definitions provided by the plugin.
.. code:: gherkin
Feature: ExampleFeature for snowflake testing
Scenario: example_scenario
Given a snowflake connection
When a temporary table called "SNOWFLAKE_LIQUIBASE.PUBLIC.DEPARTMENT" has
| dept_id: INTEGER | dept_name: STRING |
| 1 | "Computer Science" |
| 2 | "Software Engineering" |
When a temporary table called "SNOWFLAKE_LIQUIBASE.PUBLIC.PEOPLE" has
| people_id: INTEGER | name: STRING | dept_id: INTEGER |
| 10 | "tilak" | 1 |
Then a sql script "./sql/example.sql" runs and the result is
| people_id: INTEGER | name: STRING | dept_id: INTEGER | dept_name: STRING |
| 10 | "tilak" | 1 | "Computer Science" |
- ``dept_id: INTEGER``. ``dept_id`` is the column name and ``INTEGER`` is the snowflake data type.
- The step ``a temporary table called "" has``
Replaces the existing table with a `temporary` table. And adds data to the temporary table. This shadows the existing
table in snowflake for the entire session. Any changes done to the temporary table does not reflect on the actual
database. If the table does not exists creates a new temporary table.
- The step ``Then a sql script "" runs and the result is``
This runs the sql script and compares the output with given dataframe.
Available Step definitions
---------------------------
**Creating a new snowflake session**
.. code:: gherkin
Given a snowflake connection
**Setting up a temporary snowflake table for test**
* Replaces the existing table with a `temporary` table. And adds data to the temporary table. This shadows the existing
table in snowflake for the entire session. Any changes done to the temporary table does not reflect on the actual
database. If the table does not exists creates a new temporary table.
.. code:: gherkin
When a temporary table called "SNOWFLAKE_LIQUIBASE.PUBLIC.DEPARTMENT" has
| dept_id: INTEGER | dept_name: STRING |
| 1 | "Computer Science" |
| 2 | "Software Engineering" |
**Setting up a snowflake table for test**
* Creates a normal table. Will fail if table already exists.
.. code:: gherkin
When a table called "SNOWFLAKE_LIQUIBASE.PUBLIC.DEPARTMENT" has
| dept_id: INTEGER | dept_name: STRING |
| 1 | "Computer Science" |
| 2 | "Software Engineering" |
**Running a sql script and validating results**
.. code:: gherkin
Then a sql script "./sql/example.sql" runs and the result is
| people_id: INTEGER | name: STRING | dept_id: INTEGER | dept_name: STRING |
| 10 | "tilak" | 1 | "Computer Science" |
**Representing null in table data**
Use ``{null}``
.. code:: gherkin
| people_id: INTEGER | name: STRING | dept_id: INTEGER | dept_name: STRING |
| 10 | "tilak" | 1 | {null} |
**Stubbing current time related functions**
Supports stubbing the following functions with the fixture value.
current_timestamp, localtimestamp, getdate, systimestamp, sysdate, current_time, localtime
These functions will be replaced in the sql query by statements like
``CAST ('2022-01-05 04:12:17' as TIMESTAMP)`` or ``CAST ('04:12:17' as TIME)``
.. code:: gherkin
Feature: ExampleFeature for snowflake testing
Scenario: example_scenario
Given a snowflake connection
And current timestamp "2022-01-05 04:12:17"
And current time "04:12:17"
When a temporary table called "SNOWFLAKE_LIQUIBASE.PUBLIC.DEPARTMENT" has
| dept_id: INTEGER | dept_name: STRING |
| 1 | "Computer Science" |
| 2 | "Software Engineering" |
When a temporary table called "SNOWFLAKE_LIQUIBASE.PUBLIC.PEOPLE" has
| people_id: INTEGER | name: STRING | dept_id: INTEGER |
| 10 | "tilak" | 1 |
Then a sql script "./sql/example.sql" runs and the result is
| people_id: INTEGER | name: STRING | dept_id: INTEGER | dept_name: STRING |
| 10 | "tilak" | 1 | "Computer Science" |
**Representing different data types in table**
.. code:: gherkin
| a: CHAR | b: CHARACTER | c: STRING | d: TEXT | e: BINARY | f: VARBINARY |
| sample | sample | sample | sample | sample | sample |
| a: FLOAT | b: DOUBLE | c: INT | d: INTEGER | e: BIGINT | f: SMALLINT | g: TINYINT | h: BYTEINT |
| 1.0 | 1.0 | 1 | 1 | 1 | 1 | 1 | 1 |
| a: DATE | b: DATETIME | c: TIME | d: TIMESTAMP |
| 2021-05-05 | 2021-05-05 01:35:00 | 01:35:00 | 2021-05-05 01:35:00 |
Understanding data-type mismatch errors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For assertion of tables we are using pandas. Differences are shown
in-terms of pandas dataframe.
Below snowflake to pandas type table can help in understanding the
errors:
================== ===============
Snowflake datatype Pandas datatype
================== ===============
BIGINT int64
BINARY bytes
BOOLEAN bool
CHAR str
CHARACTER str
DATE object
DATETIME object
DEC object
DECIMAL object
DOUBLE float64
FIXED object
FLOAT float64
INT int64
INTEGER int64
NUMBER object
REAL float64
BYTEINT int64
SMALLINT int64
STRING str
TEXT str
TIME object
TIMESTAMP object
TINYINT int64
VARBINARY bytes
VARCHAR str
================== ===============
Contributing
------------
Contributions are very welcome. Tests can be run with `tox`_, please ensure
the coverage at least stays the same before you submit a pull request.
License
-------
Distributed under the terms of the `MIT`_ license, "pytest-snowflake_bdd" is free and open source software
Issues
------
If you encounter any problems, please `file an issue`_ along with a detailed description.
.. _`MIT`: http://opensource.org/licenses/MIT
.. _`BSD-3`: http://opensource.org/licenses/BSD-3-Clause
.. _`GNU GPL v3.0`: http://www.gnu.org/licenses/gpl-3.0.txt
.. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0
.. _`file an issue`: https://github.com/tilakpatidar/pytest-snowflake_bdd/issues
.. _`pytest`: https://github.com/pytest-dev/pytest
.. _`tox`: https://tox.readthedocs.io/en/latest/
.. _`pip`: https://pypi.org/project/pip/
.. _`pytest-bdd`: https://pypi.org/project/pytest-bdd/