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

Merge in backend-explicit-tests #129

Merged
merged 53 commits into from
Apr 8, 2019
Merged

Merge in backend-explicit-tests #129

merged 53 commits into from
Apr 8, 2019

Conversation

mattsb42-aws
Copy link
Contributor

@mattsb42-aws mattsb42-aws commented Apr 7, 2019

Ok, now the big one.

I am intentionally merging from the mpdavis fork to verify that nothing was changed on my end. All of these changes have been handled through PRs into the mpdavis/backend-explicit-tests dev branch, terminating in a final merge of master into backend-explicit-tests.

I also have a readme change that I want to make to better frame these changes once they are released, but I'll get that into master after this.

Open question to the maintainers @zejn @mpdavis : what version will the first release to incorporate these changes be? I don't see a versioning policy explicitly stated anywhere, and as noted in #99 there aren't currently any release notes that I could look though to infer a versioning policy. Would the next release be a good time to address both of those gaps?

mattsb42-aws and others added 30 commits October 12, 2018 00:02
NOTE: This identified a few bugs with the python-rsa and pyca/cryptography backends. Those will fail for now.
Cryptographic backend isolation tests
test_pycrypto_RSA_key_instance and test_cryptography_RSA_key_instance both test compatibility of
the backend-explicit RSAKey classes with the backend-native RSA key structures. As such, these
tests must use the backend-explicit RSAKey classes rather than the default loaded from jose.backends
to avoid breaking when multiple backends are present.
commands_pre requires tox >= 3.4.0
Python-rsa does not support certificates.
[RSA] make backend-explicit tests use backend-explicit keys
disable Firebase tests on python-rsa backend
Remove pyca/cryptography backend's dependency on python-ecdsa
Fix invalid RSA private key PKCS8 encoding
@codecov
Copy link

codecov bot commented Apr 7, 2019

Codecov Report

Merging #129 into master will increase coverage by 1.92%.
The diff coverage is 94.94%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #129      +/-   ##
==========================================
+ Coverage    94.6%   96.52%   +1.92%     
==========================================
  Files          13       14       +1     
  Lines        1000     1065      +65     
==========================================
+ Hits          946     1028      +82     
+ Misses         54       37      -17
Impacted Files Coverage Δ
jose/backends/cryptography_backend.py 98.11% <100%> (+1.22%) ⬆️
jose/backends/rsa_backend.py 96.5% <100%> (-0.7%) ⬇️
jose/backends/__init__.py 100% <100%> (+63.63%) ⬆️
jose/backends/_asn1.py 89.47% <89.47%> (ø)
jose/backends/pycrypto_backend.py 95.76% <92.3%> (-0.61%) ⬇️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cc710e0...64cb29f. Read the comment docs.

@blag
Copy link
Contributor

blag commented Apr 8, 2019

I would like to make a release that includes these changes (as well as your incoming readme PR), and my Ed25519 support PR once that is merged (I’ll have time to finish that up later this week). So in terms of time, I would estimate a release within 1-2 weeks, if @zejn doesn’t have any objections. I’ll also triage some of the outstanding PRs and issues a bit more later this week so they make it into the next release.

In terms of a versioning method, I haven’t taken a look at previous release version strings, but I imagine that SemVer is probably a good default versioning scheme.

Finally, since @zejn is a more familiar with your previous PR I’ll leave this for him to merge. Thank you for your contributions so far and keep up the good work both of you!

Ninja edit: changelog -> readme

@zejn
Copy link
Collaborator

zejn commented Apr 8, 2019

I don't think there's currently an explicit versioning policy. Whenever there were bigger changes, there was a major version increase.

I don't think current changes need a major version increase, I'd make it a 3.1. Most of the development was done in cleaning up the backends, and if some code is relying on something specific in the backend, which is not part of the API, then that's bound to break sooner or later.

The priority of the backends was changed, yes, but that should not make an existing installed backend unimportable and nonfunctional. If that happens, then it's a bug, but not an API breakage.

I'd also like to see issue #112 fixed before the next release and PR #100 has seen a lot of work and is nearing readiness.

I would like to hear what @mpdavis or @blag think about this though.

@zejn
Copy link
Collaborator

zejn commented Apr 8, 2019

This looks good and seems we agree with @blag on a rough release schedule.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants