Examples refresh, take 1 by mattsb42-aws · Pull Request #219 · aws/aws-encryption-sdk-python

mattsb42-aws · 2020-03-09T20:10:40Z

Issue #, if available:
#156
#213
resolves: #177

Description of changes:

There are three main things going on here:

Forcing every example author to also write a test is cumbersome. To get away from this, I reworked how we test the examples so that as long as the example function has the right name and signature (outlined in the new examples readme) it will Just Work.
In preparation for all of the revised examples, I pulled all of the existing examples into a legacy module. I'll be pulling some of them out into their appropriate place later, pending the next item.
- As part of this, I also pulled in the example that @caitlin-tibbetts added in Example for using multiple keys in multiple regions #177 to avoid churn.
I added some initial new-format examples to show how to use the high-level APIs. I want to make sure we like this format (guiding comments, layout, flow, etc) before writing the couple dozen more examples that we need so that I don't need to copy-paste the same changes into dozens of files.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Check any applicable:

Were any files moved? Moving files changes their URL, which breaks all hyperlinks to the files.

* Added a check for max_age being greater than 0 * Fixed flake8 by adding missing pydocstyle dependency * Added the dependency to decrypt_oracle as well * Added test for max_age<=0 ValueError * Updated test for max_age<=0.0 ValueError * Added negative test case

Update PR template

…o a1b1c1-example

…yption-sdk-python into a1b1c1-example

… still working on populating the tests correctly, so the CI will fail, but I tested the code with my own KMS CMK ARNs, so I know it will work once the tests are populated (working with Tejeswini on this)

is cleared up

…d test keys in different regions for this example

…ured (#179) * Fixed KMS master key provider tests for users who have their default AWS region configured * created fixture for botocore session with no region set * add auto-used fixture in KMS master key provider unit tests to test against both with and without default region

…o a2b1c1-example

…o a1b1c1-example

…for consistency

juneb

Got through the intro + streaming example. If you accept a change, please propagate that change throughout the file. I'll review again when you've rev'd the PR.

examples/README.md

juneb · 2020-03-09T22:18:01Z

examples/src/file_streaming_defaults.py

+            for chunk in encryptor:
+                ciphertext.write(chunk)
+
+    # Verify that the ciphertext and plaintext are different.


Kind of a low bar ...

It is, but I'm not sure what else we can really make a concrete statement about to demonstrate that "yes, this is encrypted" without getting really complicated.

examples/src/file_streaming_defaults.py

Co-Authored-By: June Blender <juneb@users.noreply.github.com>

juneb

Reviewed until MK/MKP legacy examples. If you need more, let me know.

examples/README.md

examples/src/in_memory_streaming_defaults.py

examples/src/legacy/__init__.py

examples/src/legacy/basic_encryption.py

Co-Authored-By: June Blender <juneb@users.noreply.github.com>

…tional" naming

acioc

Looks good!

in aws/aws-encryption-sdk-python#219

* Adding new examples and example test runner to follow the format set in aws/aws-encryption-sdk-python#219 * Updated wording and copyright notice * Adding periods * Adding NIST recommendation for RSA * Adding example for DER formatted RSA keys * Wording changes based on feedback

johnwalker and others added 30 commits July 15, 2019 11:08

Update PR template

0938325

Merge branch 'master' into prtemplate

9351933

Testing something, want AppVeyor to run

3b62bc3

Quick change

626d5ba

Running AppVeyor

83f4ff8

Merge pull request #171 from johnwalker/prtemplate

d3383c6

Update PR template

Added example for using multiple keyrings in multiple regions

534e225

Undid something quickly

42e86ab

Merge branch 'master' into a1b1c1-example

6b84d3a

Merge branch 'master' of github.com:aws/aws-encryption-sdk-python int…

2dfe2d0

…o a1b1c1-example

Fixed importerror

fabc5e3

Merge branch 'a1b1c1-example' of github.com:caitlin-tibbetts/aws-encr…

67f0ddc

…yption-sdk-python into a1b1c1-example

Formatting fix

30eab33

Update tox.ini

453b82d

Update tox.ini

2208890

Made some changes to the multiple_kms_cmk_regions example/test

d724335

This is my next interation of the code for the example; however, I am…

306d1a9

… still working on populating the tests correctly, so the CI will fail, but I tested the code with my own KMS CMK ARNs, so I know it will work once the tests are populated (working with Tejeswini on this)

Changed the example to test two CMKs in the same region until Issue #178

bde7a56

is cleared up

Found out how to make a new valid test key, so now there are two vali…

b7e9dd1

…d test keys in different regions for this example

Ran autoformat

4d8c7a0

Added some docstrings

1fdbb32

Formatting will be the death of me

d3240eb

Used correct keys in test

4eb5fde

Updated some comments

bb6c650

Wrote example and test for using one kms cmk with an unsigned algorithm

baf1164

Merge branch 'master' into a2b1c1-example

d89e6dc

Merge branch 'master' of github.com:aws/aws-encryption-sdk-python int…

3af7795

…o a2b1c1-example

Merge branch 'master' of github.com:aws/aws-encryption-sdk-python int…

a833f52

…o a1b1c1-example

mattsb42-aws added 3 commits March 9, 2020 14:57

chore: address PR comments

95047f1

chore: change examples parameter from aws_kms_cmk_arn to aws_kms_cmk …

1815399

…for consistency

docs: clarify integration tests readme

b0c7c80

acioc previously approved these changes Mar 9, 2020

View reviewed changes

juneb reviewed Mar 9, 2020

View reviewed changes

Apply suggestions from code review

c54f21a

Co-Authored-By: June Blender <juneb@users.noreply.github.com>

mattsb42-aws dismissed stale reviews from acioc via c54f21a March 9, 2020 23:55

mattsb42-aws and others added 4 commits March 9, 2020 17:03

Apply suggestions from code review

727ebab

Co-Authored-By: June Blender <juneb@users.noreply.github.com>

docs: change from "one-shot" term to "one-step"

0af1cf9

chore: apply changes based on PR comments

68b35c3

docs: reword parameter description

f054b12

juneb reviewed Mar 10, 2020

View reviewed changes

mattsb42-aws and others added 6 commits March 10, 2020 11:45

Apply suggestions from code review

d31b40d

Co-Authored-By: June Blender <juneb@users.noreply.github.com>

chore: rename examples input parameters to move from "child" to "addi…

57077b1

…tional" naming

docs: clarify configuration intro

f1469f1

docs: apply examples comments consistently

586f88e

chore: fix line length

bf2e6c9

fix: fix typo

3c19f1f

mattsb42-aws requested review from acioc and juneb March 12, 2020 18:54

juneb approved these changes Mar 12, 2020

View reviewed changes

acioc approved these changes Mar 12, 2020

View reviewed changes

mattsb42-aws merged commit 9402826 into aws:keyring Mar 12, 2020

mattsb42-aws deleted the keyring-examples-reorg branch March 12, 2020 19:03

This was referenced Mar 12, 2020

Example for using multiple keys in multiple regions #177

Closed

docs: add keyring examples #221

Merged

WesleyRosenblum added a commit to aws/aws-encryption-sdk-java that referenced this pull request Mar 20, 2020

Adding new examples and example test runner to follow the format set

81091ae

in aws/aws-encryption-sdk-python#219

WesleyRosenblum mentioned this pull request Mar 20, 2020

Adding new examples and example test runner aws/aws-encryption-sdk-java#165

Merged

1 task

Conversation

mattsb42-aws commented Mar 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Check any applicable:

Uh oh!

juneb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

juneb Mar 9, 2020

Choose a reason for hiding this comment

Uh oh!

mattsb42-aws Mar 10, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

juneb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

acioc left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

mattsb42-aws commented Mar 9, 2020 •

edited

Loading