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

Add documentation of existing tests #65

Merged
merged 4 commits into from
Sep 21, 2020

Conversation

hug-dev
Copy link
Member

@hug-dev hug-dev commented Sep 16, 2020

Adds a new page in our book to describe the tests that we have on a
high-level view.
Close #35

@hug-dev hug-dev self-assigned this Sep 16, 2020
@hug-dev hug-dev added the documentation Improvements or additions to documentation label Sep 16, 2020
Adds a new page in our book to describe the tests that we have on a
high-level view.

Signed-off-by: Hugues de Valon <[email protected]>
Copy link
Member

@ionut-arm ionut-arm left a comment

Choose a reason for hiding this comment

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

Thanks, this covers our tests quite nicely!

Comment on lines 3 to 8
## Integration tests on providers

| Name | Description |
|-----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [TPM integration tests](https://github.com/parallaxsecond/parsec/tree/master/tests/providers) | These tests initialize a provider structure and perform operation using the `Provide` trait. A software crypto library, like `ring`, can be used to verify the behaviour. [Example with the TPM provider](https://github.com/parallaxsecond/parsec/blob/master/tests/providers/tpm.rs). |

Copy link
Member

Choose a reason for hiding this comment

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

Sorry to bug you with this, but I'm moving these to the E2E tests 😬 we could do it either way - you change this or change it after mine gets merged.

Copy link
Member

Choose a reason for hiding this comment

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

I guess you can just say in the "Normal tests" line below that we also verify Parsec results with 3rd party software implementations of crypto (ring, the rsa crate...)


| Name | Description |
|------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [All providers e2e tests](https://github.com/parallaxsecond/parsec/tree/master/e2e_tests/tests/all_providers) | End-to-end tests on a service with all providers. Mostly to test core operations. |
Copy link
Member

Choose a reason for hiding this comment

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

You could also mention that now we do "cross testing" - either in this line or in another one, where we test that the output of various operations from different providers is accepted by the other providers.

@hug-dev
Copy link
Member Author

hug-dev commented Sep 21, 2020

Thanks for the review! Addressed all of your points. The CI link check will fail on accessing cross.rs but will reload once your other PR is merged 🚀

Copy link
Member

@ionut-arm ionut-arm left a comment

Choose a reason for hiding this comment

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

👌

And also makes sure it fails if there was an error.

Signed-off-by: Hugues de Valon <[email protected]>
Signed-off-by: Hugues de Valon <[email protected]>
@hug-dev hug-dev merged commit 2e090a4 into parallaxsecond:master Sep 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document existing tests
2 participants