diff --git a/libs/cloudsdk/README.md b/libs/cloudsdk/README.md index 2fc894568..7c2259cde 100644 --- a/libs/cloudsdk/README.md +++ b/libs/cloudsdk/README.md @@ -1,5 +1,8 @@ ## Cloud SDK Library -Using Swagger Autogenerated CloudSDK Library as a pip installer. +Using Swagger Autogenerated CloudSDK Library pypi package (implemented with [swagger codegen](https://github.com/swagger-api/swagger-codegen)). +Using [pytest] as the test execution framework. +Using [pylint](http://pylint.pycqa.org) for code quality monitoring. +Using [allure](https://docs.qameta.io/allure/#_about) with Github Pages to report test outcome. ### Follow the setps below to setup the environment for your development Environment @@ -70,8 +73,12 @@ pylint --fail-under=7 *py the command above would produce a non-zero exit code if the score drops below 7. +### Reporting + +Currently the plan is to use pytest integrated with [allure](https://docs.qameta.io/allure/#_pytest) to create visual reports for the test outcomes + ### Miscelanneous 1. Do not use old style string formatting: `"Hello %s" % var`; use `f"Hello {var}` instead 2. use `"""` in Docstrings -3. todo \ No newline at end of file +3. todo diff --git a/libs/cloudsdk/requirements.txt b/libs/cloudsdk/requirements.txt index 688d28f8d..b20693cf9 100644 --- a/libs/cloudsdk/requirements.txt +++ b/libs/cloudsdk/requirements.txt @@ -1,7 +1,12 @@ +# actual code package dependencies tip_wlan_cloud >= 0.0.3 certifi >= 14.05.14 six >= 1.10 python_dateutil >= 2.5.3 setuptools >= 21.0.0 urllib3 >= 1.15.1 -pylint \ No newline at end of file +pytest + +# style\reporting package dependencies +pylint +allure-pytest \ No newline at end of file