Skip to content
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

Merged
merged 3 commits into from
Aug 4, 2017
Merged

Readme for tests #5

merged 3 commits into from
Aug 4, 2017

Conversation

OGKevin
Copy link
Contributor

@OGKevin OGKevin commented Aug 4, 2017

Readme for how to configure and run tests.

@OGKevin OGKevin self-assigned this Aug 4, 2017
@OGKevin OGKevin requested a review from dnl-blkv August 4, 2017 08:41
Copy link
Contributor

@dnl-blkv dnl-blkv left a 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
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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:
Copy link
Contributor

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`
Copy link
Contributor

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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pycharm should be PyCharm

@OGKevin
Copy link
Contributor Author

OGKevin commented Aug 4, 2017

We can add a link with some context from the main readme to his one 🤔.

@OGKevin OGKevin requested a review from dnl-blkv August 4, 2017 09:00
@dnl-blkv
Copy link
Contributor

dnl-blkv commented Aug 4, 2017

@OGKevin Great idea with the link! Please do so!

Copy link
Contributor

@dnl-blkv dnl-blkv left a 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 👍

@OGKevin OGKevin requested a review from dnl-blkv August 4, 2017 10:28
Copy link
Contributor

@dnl-blkv dnl-blkv left a 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

@dnl-blkv dnl-blkv merged commit 812a3ac into develop Aug 4, 2017
@dnl-blkv dnl-blkv deleted the feature/test_readme branch August 4, 2017 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants