chore(keyring examples): refactor keyring examples and deprecate master key provider examples

Author: RitvikKapila

examples/src/__init__.py

@@ -1,13 +1,3 @@
-# Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License"). You
-# may not use this file except in compliance with the License. A copy of
-# the License is located at
-#
-# http://aws.amazon.com/apache2.0/
-#
-# or in the "license" file accompanying this file. This file is
-# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
-# ANY KIND, either express or implied. See the License for the specific
-# language governing permissions and limitations under the License.
+# Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
 """Stub module indicator to make linter configuration simpler."""

examples/src/keyrings/aws_kms_discovery_keyring_example.py renamed to examples/src/aws_kms_discovery_keyring_example.py

@@ -0,0 +1,13 @@
+# Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+# http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+"""Stub module indicator to make linter configuration simpler."""

examples/src/keyrings/aws_kms_discovery_multi_keyring_example.py renamed to examples/src/aws_kms_discovery_multi_keyring_example.py

@@ -1,13 +1,3 @@
-# Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License"). You
-# may not use this file except in compliance with the License. A copy of
-# the License is located at
-#
-# http://aws.amazon.com/apache2.0/
-#
-# or in the "license" file accompanying this file. This file is
-# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
-# ANY KIND, either express or implied. See the License for the specific
-# language governing permissions and limitations under the License.
+# Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
 """Stub module indicator to make linter configuration simpler."""

examples/src/keyrings/aws_kms_keyring_example.py renamed to examples/src/aws_kms_keyring_example.py

@@ -0,0 +1,13 @@
+# Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+# http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+"""Stub module indicator to make linter configuration simpler."""

examples/src/keyrings/aws_kms_mrk_discovery_keyring_example.py renamed to examples/src/aws_kms_mrk_discovery_keyring_example.py

@@ -15,7 +15,7 @@
 import sys
 
 os.environ["AWS_ENCRYPTION_SDK_EXAMPLES_TESTING"] = "yes"
-sys.path.extend([os.sep.join([os.path.dirname(__file__), "..", "..", "test", "integration"])])
+sys.path.extend([os.sep.join([os.path.dirname(__file__), "..", "..", "..", "test", "integration"])])
 
 static_plaintext = (
     b"Lorem ipsum dolor sit amet, consectetur adipiscing elit. "

examples/src/keyrings/aws_kms_mrk_discovery_multi_keyring_example.py renamed to examples/src/aws_kms_mrk_discovery_multi_keyring_example.py

@@ -14,7 +14,7 @@
 import botocore.session
 import pytest
 
-from ..src.basic_encryption import cycle_string
+from ...src.deprecated.basic_encryption import cycle_string
 from .examples_test_utils import get_cmk_arn, static_plaintext
 
 

examples/src/keyrings/aws_kms_mrk_keyring_example.py renamed to examples/src/aws_kms_mrk_keyring_example.py

@@ -17,7 +17,7 @@
 import botocore.session
 import pytest
 
-from ..src.basic_file_encryption_with_multiple_providers import cycle_file
+from ...src.deprecated.basic_file_encryption_with_multiple_providers import cycle_file
 from .examples_test_utils import get_cmk_arn
 from .examples_test_utils import static_plaintext
 

examples/src/keyrings/aws_kms_mrk_multi_keyring_example.py renamed to examples/src/aws_kms_mrk_multi_keyring_example.py

@@ -16,7 +16,7 @@
 
 import pytest
 
-from ..src.basic_file_encryption_with_raw_key_provider import cycle_file
+from ...src.deprecated.basic_file_encryption_with_raw_key_provider import cycle_file
 from .examples_test_utils import static_plaintext
 
 

examples/src/keyrings/aws_kms_multi_keyring_example.py renamed to examples/src/aws_kms_multi_keyring_example.py

@@ -13,7 +13,7 @@
 """Unit test suite for the basic data key caching example in the AWS-hosted documentation."""
 import pytest
 
-from ..src.data_key_caching_basic import encrypt_with_caching
+from ...src.deprecated.data_key_caching_basic import encrypt_with_caching
 from .examples_test_utils import get_cmk_arn
 
 

examples/src/keyrings/aws_kms_rsa_keyring_example.py renamed to examples/src/aws_kms_rsa_keyring_example.py

@@ -15,7 +15,7 @@
 import botocore.session
 import pytest
 
-from ..src.discovery_kms_provider import encrypt_decrypt
+from ...src.deprecated.discovery_kms_provider import encrypt_decrypt
 from .examples_test_utils import get_cmk_arn
 from .examples_test_utils import static_plaintext
 

examples/src/keyrings/branch_key_id_supplier_example.py renamed to examples/src/branch_key_id_supplier_example.py

@@ -14,7 +14,7 @@
 
 import pytest
 
-from ..src.mrk_aware_kms_provider import encrypt_decrypt
+from ...src.deprecated.mrk_aware_kms_provider import encrypt_decrypt
 from .examples_test_utils import get_mrk_arn, get_second_mrk_arn
 from .examples_test_utils import static_plaintext
 

examples/src/deprecated/__init__.py

@@ -15,7 +15,7 @@
 import botocore.session
 import pytest
 
-from ..src.multiple_kms_cmk import encrypt_decrypt
+from ...src.deprecated.multiple_kms_cmk import encrypt_decrypt
 from .examples_test_utils import get_cmk_arn, get_second_cmk_arn
 from .examples_test_utils import static_plaintext
 

examples/src/basic_encryption.py renamed to examples/src/deprecated/basic_encryption.py

@@ -15,7 +15,7 @@
 import botocore.session
 import pytest
 
-from ..src.one_kms_cmk import encrypt_decrypt
+from ...src.deprecated.one_kms_cmk import encrypt_decrypt
 from .examples_test_utils import get_cmk_arn
 from .examples_test_utils import static_plaintext
 

examples/src/basic_file_encryption_with_multiple_providers.py renamed to examples/src/deprecated/basic_file_encryption_with_multiple_providers.py

@@ -17,7 +17,7 @@
 import botocore.session
 import pytest
 
-from ..src.one_kms_cmk_streaming_data import encrypt_decrypt_stream
+from ...src.deprecated.one_kms_cmk_streaming_data import encrypt_decrypt_stream
 from .examples_test_utils import get_cmk_arn, static_plaintext
 
 

examples/src/basic_file_encryption_with_raw_key_provider.py renamed to examples/src/deprecated/basic_file_encryption_with_raw_key_provider.py

@@ -15,7 +15,7 @@
 import botocore.session
 import pytest
 
-from ..src.one_kms_cmk_unsigned import encrypt_decrypt
+from ...src.deprecated.one_kms_cmk_unsigned import encrypt_decrypt
 from .examples_test_utils import get_cmk_arn
 from .examples_test_utils import static_plaintext
 

examples/src/custom_kms_client_for_kms_provider.py renamed to examples/src/deprecated/custom_kms_client_for_kms_provider.py

@@ -15,7 +15,7 @@
 import botocore.session
 import pytest
 
-from ..src.set_commitment import encrypt_decrypt
+from ...src.deprecated.set_commitment import encrypt_decrypt
 from .examples_test_utils import get_cmk_arn
 from .examples_test_utils import static_plaintext
 

examples/src/data_key_caching_basic.py renamed to examples/src/deprecated/data_key_caching_basic.py

@@ -3,7 +3,7 @@
 """Test suite for the AWS KMS Discovery keyring example."""
 import pytest
 
-from ...src.keyrings.aws_kms_discovery_keyring_example import encrypt_and_decrypt_with_keyring
+from ..src.aws_kms_discovery_keyring_example import encrypt_and_decrypt_with_keyring
 
 pytestmark = [pytest.mark.examples]
 

examples/src/discovery_kms_provider.py renamed to examples/src/deprecated/discovery_kms_provider.py

@@ -3,7 +3,7 @@
 """Test suite for the AWS KMS Discovery Multi keyring example."""
 import pytest
 
-from ...src.keyrings.aws_kms_discovery_multi_keyring_example import encrypt_and_decrypt_with_keyring
+from ..src.aws_kms_discovery_multi_keyring_example import encrypt_and_decrypt_with_keyring
 
 pytestmark = [pytest.mark.examples]
 

examples/src/keyrings/module_.py renamed to examples/src/deprecated/module_.py

@@ -3,7 +3,7 @@
 """Test suite for the AWS KMS keyring example."""
 import pytest
 
-from ...src.keyrings.aws_kms_keyring_example import encrypt_and_decrypt_with_keyring
+from ..src.aws_kms_keyring_example import encrypt_and_decrypt_with_keyring
 
 pytestmark = [pytest.mark.examples]
 

examples/src/mrk_aware_kms_provider.py renamed to examples/src/deprecated/mrk_aware_kms_provider.py

@@ -3,7 +3,7 @@
 """Test suite for the AWS KMS MRK Discovery keyring example."""
 import pytest
 
-from ...src.keyrings.aws_kms_mrk_discovery_keyring_example import encrypt_and_decrypt_with_keyring
+from ..src.aws_kms_mrk_discovery_keyring_example import encrypt_and_decrypt_with_keyring
 
 pytestmark = [pytest.mark.examples]
 

examples/src/multiple_kms_cmk.py renamed to examples/src/deprecated/multiple_kms_cmk.py

@@ -3,7 +3,7 @@
 """Test suite for the AWS KMS MRK Discovery Multi keyring example."""
 import pytest
 
-from ...src.keyrings.aws_kms_mrk_discovery_multi_keyring_example import encrypt_and_decrypt_with_keyring
+from ..src.aws_kms_mrk_discovery_multi_keyring_example import encrypt_and_decrypt_with_keyring
 
 pytestmark = [pytest.mark.examples]
 

examples/src/one_kms_cmk.py renamed to examples/src/deprecated/one_kms_cmk.py

@@ -3,7 +3,7 @@
 """Test suite for the AWS KMS MRK keyring example."""
 import pytest
 
-from ...src.keyrings.aws_kms_mrk_keyring_example import encrypt_and_decrypt_with_keyring
+from ..src.aws_kms_mrk_keyring_example import encrypt_and_decrypt_with_keyring
 
 pytestmark = [pytest.mark.examples]
 

examples/src/one_kms_cmk_streaming_data.py renamed to examples/src/deprecated/one_kms_cmk_streaming_data.py

@@ -3,7 +3,7 @@
 """Test suite for the AWS KMS MRK Multi keyring example."""
 import pytest
 
-from ...src.keyrings.aws_kms_mrk_multi_keyring_example import encrypt_and_decrypt_with_keyring
+from ..src.aws_kms_mrk_multi_keyring_example import encrypt_and_decrypt_with_keyring
 
 pytestmark = [pytest.mark.examples]
 

examples/src/one_kms_cmk_unsigned.py renamed to examples/src/deprecated/one_kms_cmk_unsigned.py

@@ -3,7 +3,7 @@
 """Test suite for the AWS KMS multi keyring example."""
 import pytest
 
-from ...src.keyrings.aws_kms_multi_keyring_example import encrypt_and_decrypt_with_keyring
+from ..src.aws_kms_multi_keyring_example import encrypt_and_decrypt_with_keyring
 
 pytestmark = [pytest.mark.examples]
 

examples/src/set_commitment.py renamed to examples/src/deprecated/set_commitment.py

@@ -3,7 +3,7 @@
 """Test suite for the AWS KMS RSA keyring example."""
 import pytest
 
-from ...src.keyrings.aws_kms_rsa_keyring_example import encrypt_and_decrypt_with_keyring
+from ..src.aws_kms_rsa_keyring_example import encrypt_and_decrypt_with_keyring
 
 pytestmark = [pytest.mark.examples]
 

examples/src/keyrings/file_streaming_example.py renamed to examples/src/file_streaming_example.py

@@ -5,7 +5,7 @@
 
 import pytest
 
-from ...src.keyrings.file_streaming_example import encrypt_and_decrypt_with_keyring
+from ..src.file_streaming_example import encrypt_and_decrypt_with_keyring
 
 pytestmark = [pytest.mark.examples]
 

examples/src/keyrings/hierarchical_keyring_example.py renamed to examples/src/hierarchical_keyring_example.py

@@ -3,7 +3,7 @@
 """Test suite for the hierarchical keyring example."""
 import pytest
 
-from ...src.keyrings.hierarchical_keyring_example import encrypt_and_decrypt_with_keyring
+from ..src.hierarchical_keyring_example import encrypt_and_decrypt_with_keyring
 
 pytestmark = [pytest.mark.examples]
 

examples/src/keyrings/__init__.py

@@ -3,7 +3,7 @@
 """Test suite for the migration_set_commitment_policy_example."""
 import pytest
 
-from ...src.keyrings.migration_set_commitment_policy_example import encrypt_and_decrypt_with_keyring
+from ..src.migration_set_commitment_policy_example import encrypt_and_decrypt_with_keyring
 
 pytestmark = [pytest.mark.examples]
 

examples/src/keyrings/migration_set_commitment_policy_example.py renamed to examples/src/migration_set_commitment_policy_example.py

@@ -3,7 +3,7 @@
 """Test suite for the multi keyring example."""
 import pytest
 
-from ...src.keyrings.multi_keyring_example import encrypt_and_decrypt_with_keyring
+from ..src.multi_keyring_example import encrypt_and_decrypt_with_keyring
 
 pytestmark = [pytest.mark.examples]
 

examples/src/keyrings/multi_keyring_example.py renamed to examples/src/multi_keyring_example.py

@@ -3,7 +3,7 @@
 """Test suite for the Raw AES keyring example."""
 import pytest
 
-from ...src.keyrings.raw_aes_keyring_example import encrypt_and_decrypt_with_keyring
+from ..src.raw_aes_keyring_example import encrypt_and_decrypt_with_keyring
 
 pytestmark = [pytest.mark.examples]
 

examples/src/keyrings/raw_aes_keyring_example.py renamed to examples/src/raw_aes_keyring_example.py

@@ -5,7 +5,7 @@
 
 import pytest
 
-from ...src.keyrings.raw_rsa_keyring_example import encrypt_and_decrypt_with_keyring, generate_rsa_keys
+from ..src.raw_rsa_keyring_example import encrypt_and_decrypt_with_keyring, generate_rsa_keys
 
 pytestmark = [pytest.mark.examples]
 

examples/src/keyrings/raw_rsa_keyring_example.py renamed to examples/src/raw_rsa_keyring_example.py

@@ -3,7 +3,7 @@
 """Test suite for the required encryption context CMM example."""
 import pytest
 
-from ...src.keyrings.required_encryption_context_cmm import encrypt_and_decrypt_with_keyring
+from ..src.required_encryption_context_cmm import encrypt_and_decrypt_with_keyring
 
 pytestmark = [pytest.mark.examples]
 

examples/src/keyrings/required_encryption_context_cmm.py renamed to examples/src/required_encryption_context_cmm.py

@@ -3,7 +3,7 @@
 """Test suite for the Set Algorithm Suite example for a Raw AES keyring."""
 import pytest
 
-from ...src.keyrings.set_encryption_algorithm_suite_example import encrypt_and_decrypt_with_keyring
+from ..src.set_encryption_algorithm_suite_example import encrypt_and_decrypt_with_keyring
 
 pytestmark = [pytest.mark.examples]