Skip to content

Commit 812a3ac

Browse files
authored
Merge pull request #5 from bunq/feature/test_readme
Readme for tests
2 parents ae74699 + 26a5ec3 commit 812a3ac

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,3 +179,8 @@ $ python3 run.py examples/api_context_save_example.py
179179

180180
Please do not forget to set the `_API_KEY` constant in
181181
`api_context_save_example.py` to your actual API key before running the sample!
182+
183+
## Running Tests
184+
185+
Information regarding the test cases can be found in the [README.md](./tests/README.md)
186+
located in [test](/tests)

tests/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# bunq Python SDK
2+
Version 0.9.0 **BETA**
3+
4+
## Introduction
5+
Hi developers!
6+
7+
8+
Welcome to the bunq Python SDK integration tests. Currently we are not
9+
targeting the 100% test coverage, but rather want to be certain that the most
10+
common scenarios can run without any errors.
11+
12+
13+
## Scenarios
14+
15+
These are the scenarios that are currently being tested:
16+
* Create installation, session-server and device server
17+
* Create a new MonetaryAccount
18+
* Create a tab
19+
* Update the tab
20+
* Create attachment and avatar
21+
* Request money from first MA to second MA
22+
* Accept the request
23+
* Make a transaction from first MA to second MA
24+
* Create connect gr code
25+
* Make a payment to another sandbox user
26+
* Send a chat message in a recent payment
27+
* Delete the current session
28+
* Order a card with a second line
29+
30+
Besides these scenarios, some code of ApiContext, ApiClient and the JSON module
31+
are also tested :thumbs_up:.
32+
33+
## Configuration
34+
35+
To run the tests you must first setup the test configuration JSON. The example
36+
of a configuration file is located at [`tests/assets/config.example.json`](./assets/config.example.json).
37+
In order to make use of the configuration file, please copy the example to the
38+
same directory, fill in your sandbox user data and rename the copy to config.json.
39+
40+
## Execution
41+
42+
You can run the tests via command line:
43+
44+
```
45+
python -m unittest discover -s tests/model/generated
46+
```
47+
48+
or via PyCharm, but first you must configure PyCharm by doing the following:
49+
* Got to preferences --> tools --> Python integrated tools and change default
50+
test runner to `unittests`.
51+
* Configure your Python interpreter to an supported Python version. Python 3 is
52+
recommended.
53+
54+
Afterwards you can right click on the tests folders and should be able to run
55+
the tests cases form the IDE.

0 commit comments

Comments
 (0)