-
Notifications
You must be signed in to change notification settings - Fork 26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Readme for tests #5
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few comments :)
Also... Don't we want to add this to the main README file so that it is visible? Not sure about this one, but probably would make sense.
tests/README.md
Outdated
* Create installation, session-server and device server | ||
* Create a new MonetaryAccount | ||
* Create a tab | ||
* Update the tab |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Extra space here :)
tests/README.md
Outdated
* Delete the current session | ||
* Order a card with a second line | ||
|
||
Besides these scenarios some code of ApiContext, ApiClient and the JSON module |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
comma after "scenarios"
tests/README.md
Outdated
|
||
## Configuration | ||
|
||
To run the tests you must first setup the test configuration JSON. This is |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The example of a configuration file is located at ...
In order to make use of the configuration file, please copy the example to the same directory, fill in your sandbox user data and rename the copy to config.json
.
tests/README.md
Outdated
|
||
## Execution | ||
|
||
You can run the tests via command line: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
extra space between "tests" and "via"
tests/README.md
Outdated
|
||
You can run the tests via command line: | ||
|
||
` python -m unittest discover -s tests/model/generated` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If it was intended to be on a line by itself, wouldn't it be better to make it multi-line and surround it with ``` rather than ` ?
tests/README.md
Outdated
|
||
` python -m unittest discover -s tests/model/generated` | ||
|
||
or via PyCharm, but first you must configure Pycharm by doing the following: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pycharm
should be PyCharm
We can add a link with some context from the main readme to his one 🤔. |
@OGKevin Great idea with the link! Please do so! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add the link from the main README.md to the tests README.md! Great idea 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Test README.md, welcome onboard! :D
Readme for how to configure and run tests.