https://github.com/dataiku/dataiku-plugin-tests-utils
https://github.com/dataiku/dataiku-plugin-tests-utils
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/dataiku/dataiku-plugin-tests-utils
- Owner: dataiku
- License: apache-2.0
- Created: 2021-02-02T10:25:01.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-07-22T12:49:42.000Z (9 months ago)
- Last Synced: 2025-07-22T14:42:48.742Z (9 months ago)
- Language: Python
- Size: 33.2 KB
- Stars: 0
- Watchers: 46
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# How to test your plugin
Development cycles should be supported with unit and integration tests.
To operate integration tests you will need the help of the `dataiku-plugin-tests-utils` pacakge in order
to automate their executions while targeting DSS instances that should be dedicated to them.
`dataiku-plugin-tests-utils` will be installed as a `pytest plugin`. So only install that package inside an environment dédicated for integration tests, otherwise `pytest` will complain about unused fixtures inside your unit tests.
# How to install in your plugin
To install the `dataiku-plugin-tests-utils` package for your plugins use the
following line depending on your prefered way to managed packages and situation
you are in.
## Using Requierement.txt
### Development cycle
```
git+git://github.com/dataiku/dataiku-plugin-tests-utils.git@#egg=dataiku-plugin-tests-utils
```
Replace `` by the most accurate value
### Stable release (untested for now)
```
git+git://github.com/dataiku/dataiku-plugin-tests-utils.git@releases/tag/#egg=dataiku-plugin-tests-utils
```
Replace `` by the most accurate value
## Using Pipfile
Put the following line under `[dev-packages]` section
### Development cycle
```
dku-plugin-test-utils = {git = "git://github.com/dataiku/dataiku-plugin-tests-utils.git", ref = ""}
```
### Stable release
TBD
## Dev env
### Config
First, ensure that you have Personal Api Keys generated for the DSS you want to target.
Secondly, define a config file which will give the DSS you will target.
```
{
"DSSX":
{
"url": ".......",
"users": {
"usrA": "api_key",
"usrB": "api_key",
"default": "usrA"
},
"python_interpreter": ["PYTHON27", "PYTHON36"]
},
"DSSY":
{
"url": "......",
"users": {
"usrA": "api_key",
"usrB": "api_key",
"default": "usrB"
},
"python_interpreter": ["PYTHON36", "PYTHON39"]
}
}
```
**BEWARE**: User names must be identical in the configuration file between the different DSS instances.
Then, set the environment variable `PLUGIN_INTEGRATION_TEST_INSTANCE` to point to the config file.
# How to use the package
## General information
To use the package in your test files:
```python
import dku_plugin_test_utils
import dku_plugin_test_utils.subpakcage.subsymbol
```
Look at the next section for more information about potential `subpackage` and `subsymbol`
The python integration tests files are indirections towards the "real" tests that are written as DSS scenarios on DSS instances.
The python test function triggers the targeted DSS scenario and waits either for its sucessfull or failed completion.
Thence your test function should look like the following snippet :
```python
# Mandatory imprts
from dku_plugin_test_utils import dss_scenario
def test_run_some_dss_scenario(user_dss_clients):
dss_scenario.run(user_clients, 'PROJECT_KEY', 'scenario_id', user="user1")
# [... other tests ...]
```
With:
- `user_dss_clients`: representing the dss client corresponding to the desired user.
- `PROJECT_KEY`: The project that holds the test scenarios
- `scenario_id`: The test scenario to run
- `user`: Specify the user to run the scenario with. It is an optionnal argument, by default it equalt to "default".
## How to generate a graphical report with Allure for integration tests
For each plugin, a folder named `allure_report` should exists inside the `test` folder, reports will be generated inside that folder.
To generate the graphical report, you must have allure installed on your system as described [on their installation guide](https://docs.qameta.io/allure/#_manual_installation). Once the installation is done, run the following :
```shell
allure serve path/to/the/allure_report/dir/inside/you/plugin/test/folder/
```
# Package Hierarchy
As it is a tooling package for integration test, it will aggregate different packages with different aim.
The following hierarchy exposes the different sub-package contained in `dku_plugin_test_utils` with their aim
and the list of public symbols:
- `run_config`:
- `ScenarioConfiguration`: Class exposing the parsed run configuration as a python dict.
- `PluginInfo`: Parse the plugin.json and the code-env desc.json files to extract plugin metadata as a python dict.
- `dss_scenario`:
- `run`: Run the targetted DSS scenario and wait for it completion either success or failure.