Add a section to readme detailing TESTING

HewlettPackard / oneview-puppet

This project is no longer being developed and has limited support. In the near future this repository will be fully deprecated. Please consider using other OneView projects, such as Terraform and Ansible Collection

https://forge.puppet.com/hewlettpackard/oneview

Apache License 2.0

8 stars 17 forks source link

Add a section to readme detailing TESTING #166

Closed fgbulsoni closed 6 years ago

fgbulsoni commented 7 years ago

Description

Added TESTING.md and testing section to README

Check List

[X] New functionality has been documented in the README if applicable.
- [X] New functionality has been thoroughly documented in the examples (please include helpful comments).
[X] Changes are documented in the CHANGELOG.

fgbulsoni commented 7 years ago

Again if your "integration tests" are the "examples", please call them examples and comment they serve as "integration/functional tests". I've seen a lot of mention to them all over the code that may be confusing.

Rewrote a few things, hopefully it's clearer now. Let me know.

The basics are:

Examples: mandatory, can be used as functional/integration tests
Unit tests: mandatory, should achieve 100% path coverage
Integration tests: not mandatory, can be used as a way to achieve a broader path coverage against an actual appliance while keeping the examples clear and concise.

tmiotto commented 7 years ago

Just a concern... Which tool will inform the path coverage percentage?

fgbulsoni commented 7 years ago

Just a concern... Which tool will inform the path coverage percentage?

Simplecov. Mentioned in:

### Coverage
The unit tests issue a coverage report generated by `SimpleCov` and validated with `Coveralls`.

tmiotto commented 7 years ago

As far as I know SimpleCov only informs the line coverage, not the path coverage.