-
Notifications
You must be signed in to change notification settings - Fork 101
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
Refactor end to end test #37
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zugzwang
commented
Oct 25, 2019
twiss
reviewed
Nov 1, 2019
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.
Looks good to me, other than nits below 👍
zugzwang
commented
Nov 1, 2019
zugzwang
pushed a commit
to zugzwang/crypto
that referenced
this pull request
Nov 2, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refactor end-to-end tests
TestEndToEnd
acts like the functional tests of theopenpgp
package: Take any key (generated on-the-fly or external), encrypt/sign messages to other keys, and decrypt/verify.Currently, every end-to-end test is happening in
end_to_end_test.go
, inside theopenpgp
package. This needs some refactoring:openpgp
package API is used.Separate integrationtests package
Create a separate package that imports
openpgp
and gives a clear idea on how to use the API, while improving readability. Future integration tests with other libraries (such as OpenPGPjs) should be included here.Split file
end_to_end_test.go
containsTestEndToEnd
and other helper functions that involve objects from thetesting
package.utils.go
contains helper functions (mostly format functions).test_vectors.go
contains test vectors such as external keys and string constants.JSON test vectors instead of global variables
end_to_end_test.go
contains large strings as global variables. It is better to have this data as a separate JSON. Also, this serves the purpose of exporting/importing test vectors easier fro cross-library testing.The only caveat is that
encoding/json
can only handle structs with exported fields, therefore, all relevant keys in JSON maps must start with a capital letter.