chore: Change MPL branch, remove PYTHONPATH workarounds (#683)

lucasmcdonald3 · web-flow · commit ca7e15905ab8 · 2024-08-05T12:24:30.000-07:00
diff --git a/.github/workflows/ci_tests.yaml b/.github/workflows/ci_tests.yaml
@@ -25,11 +25,7 @@ jobs:
       matrix:
         os:
           - ubuntu-latest
-          # Windows fails due to "No module named 'Wrappers'"
-          # This SHOULD be fixed once Dafny generates fully-qualified import statements
-          # (i.e. doo files, per-package module names)
-          # Disable for now
-          # - windows-latest
+          - windows-latest
           - macos-12
         python:
           - 3.8
diff --git a/examples/src/aws_kms_discovery_keyring_example.py b/examples/src/aws_kms_discovery_keyring_example.py
@@ -32,7 +32,6 @@
 For more information on how to use KMS Discovery keyrings, see
 https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/use-kms-keyring.html#kms-keyring-discovery
 """
-import sys
 
 import boto3
 from aws_cryptographic_materialproviders.mpl import AwsCryptographicMaterialProviders
@@ -49,11 +48,6 @@
 from aws_encryption_sdk import CommitmentPolicy
 from aws_encryption_sdk.exceptions import AWSEncryptionSDKClientError
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-MODULE_ROOT_DIR = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(MODULE_ROOT_DIR)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/examples/src/aws_kms_discovery_multi_keyring_example.py b/examples/src/aws_kms_discovery_multi_keyring_example.py
@@ -29,7 +29,6 @@
 For more information on how to use KMS Discovery keyrings, see
 https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/use-kms-keyring.html#kms-keyring-discovery
 """
-import sys
 
 import boto3
 from aws_cryptographic_materialproviders.mpl import AwsCryptographicMaterialProviders
@@ -45,11 +44,6 @@
 import aws_encryption_sdk
 from aws_encryption_sdk import CommitmentPolicy
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-MODULE_ROOT_DIR = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(MODULE_ROOT_DIR)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/examples/src/aws_kms_keyring_example.py b/examples/src/aws_kms_keyring_example.py
@@ -17,7 +17,6 @@
 For more information on how to use KMS keyrings, see
 https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/use-kms-keyring.html
 """
-import sys
 
 import boto3
 from aws_cryptographic_materialproviders.mpl import AwsCryptographicMaterialProviders
@@ -29,11 +28,6 @@
 import aws_encryption_sdk
 from aws_encryption_sdk import CommitmentPolicy
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-MODULE_ROOT_DIR = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(MODULE_ROOT_DIR)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/examples/src/aws_kms_mrk_discovery_keyring_example.py b/examples/src/aws_kms_mrk_discovery_keyring_example.py
@@ -34,7 +34,6 @@
 For more information on how to use KMS Discovery keyrings, see
 https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/use-kms-keyring.html#kms-keyring-discovery
 """
-import sys
 
 import boto3
 from aws_cryptographic_materialproviders.mpl import AwsCryptographicMaterialProviders
@@ -50,11 +49,6 @@
 import aws_encryption_sdk
 from aws_encryption_sdk import CommitmentPolicy
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-MODULE_ROOT_DIR = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(MODULE_ROOT_DIR)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/examples/src/aws_kms_mrk_discovery_multi_keyring_example.py b/examples/src/aws_kms_mrk_discovery_multi_keyring_example.py
@@ -36,7 +36,6 @@
 For more information on how to use KMS Discovery keyrings, see
 https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/use-kms-keyring.html#kms-keyring-discovery
 """
-import sys
 
 import boto3
 from aws_cryptographic_materialproviders.mpl import AwsCryptographicMaterialProviders
@@ -52,11 +51,6 @@
 import aws_encryption_sdk
 from aws_encryption_sdk import CommitmentPolicy
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-MODULE_ROOT_DIR = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(MODULE_ROOT_DIR)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/examples/src/aws_kms_mrk_keyring_example.py b/examples/src/aws_kms_mrk_keyring_example.py
@@ -21,7 +21,6 @@
 For more info on KMS MRK (multi-region keys), see the KMS documentation:
 https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html
 """
-import sys
 
 import boto3
 from aws_cryptographic_materialproviders.mpl import AwsCryptographicMaterialProviders
@@ -33,11 +32,6 @@
 import aws_encryption_sdk
 from aws_encryption_sdk import CommitmentPolicy
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-MODULE_ROOT_DIR = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(MODULE_ROOT_DIR)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/examples/src/aws_kms_mrk_multi_keyring_example.py b/examples/src/aws_kms_mrk_multi_keyring_example.py
@@ -27,7 +27,6 @@
 For more info on KMS MRK (multi-region keys), see the KMS documentation:
 https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html
 """
-import sys
 
 import boto3
 from aws_cryptographic_materialproviders.mpl import AwsCryptographicMaterialProviders
@@ -39,11 +38,6 @@
 import aws_encryption_sdk
 from aws_encryption_sdk import CommitmentPolicy
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-MODULE_ROOT_DIR = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(MODULE_ROOT_DIR)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/examples/src/aws_kms_multi_keyring_example.py b/examples/src/aws_kms_multi_keyring_example.py
@@ -36,7 +36,6 @@
 For more information on how to use Multi keyrings, see
 https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/use-multi-keyring.html
 """
-import sys
 
 import boto3
 from aws_cryptographic_materialproviders.mpl import AwsCryptographicMaterialProviders
@@ -48,11 +47,6 @@
 import aws_encryption_sdk
 from aws_encryption_sdk import CommitmentPolicy
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-MODULE_ROOT_DIR = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(MODULE_ROOT_DIR)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/examples/src/aws_kms_rsa_keyring_example.py b/examples/src/aws_kms_rsa_keyring_example.py
@@ -14,7 +14,6 @@
 # For more information on how to use KMS keyrings, see
 # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/use-kms-keyring.html
 """
-import sys
 
 import boto3
 from aws_cryptographic_materialproviders.mpl import AwsCryptographicMaterialProviders
@@ -27,11 +26,6 @@
 from aws_encryption_sdk import CommitmentPolicy
 from aws_encryption_sdk.identifiers import AlgorithmSuite
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-MODULE_ROOT_DIR = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(MODULE_ROOT_DIR)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/examples/src/branch_key_id_supplier_example.py b/examples/src/branch_key_id_supplier_example.py
@@ -25,15 +25,15 @@ def get_branch_key_id(
         """Returns branch key ID from the tenant ID in input's encryption context."""
         encryption_context: Dict[str, str] = param.encryption_context
 
-        if b"tenant" not in encryption_context:
+        if "tenant" not in encryption_context:
             raise ValueError("EncryptionContext invalid, does not contain expected tenant key value pair.")
 
-        tenant_key_id: str = encryption_context.get(b"tenant")
+        tenant_key_id: str = encryption_context.get("tenant")
         branch_key_id: str
 
-        if tenant_key_id == b"TenantA":
+        if tenant_key_id == "TenantA":
             branch_key_id = self.branch_key_id_for_tenant_A
-        elif tenant_key_id == b"TenantB":
+        elif tenant_key_id == "TenantB":
             branch_key_id = self.branch_key_id_for_tenant_B
         else:
             raise ValueError(f"Item does not contain valid tenant ID: {tenant_key_id=}")
diff --git a/examples/src/default_cryptographic_materials_manager_example.py b/examples/src/default_cryptographic_materials_manager_example.py
@@ -18,8 +18,6 @@
 For more information on Cryptographic Material Managers, see
 https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#crypt-materials-manager
 """
-import sys
-
 import boto3
 from aws_cryptographic_materialproviders.mpl import AwsCryptographicMaterialProviders
 from aws_cryptographic_materialproviders.mpl.config import MaterialProvidersConfig
@@ -33,11 +31,6 @@
 import aws_encryption_sdk
 from aws_encryption_sdk import CommitmentPolicy
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-MODULE_ROOT_DIR = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(MODULE_ROOT_DIR)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/examples/src/file_streaming_example.py b/examples/src/file_streaming_example.py
@@ -25,7 +25,6 @@
 """
 import filecmp
 import secrets
-import sys
 
 from aws_cryptographic_materialproviders.mpl import AwsCryptographicMaterialProviders
 from aws_cryptographic_materialproviders.mpl.config import MaterialProvidersConfig
@@ -36,11 +35,6 @@
 import aws_encryption_sdk
 from aws_encryption_sdk import CommitmentPolicy
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-MODULE_ROOT_DIR = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(MODULE_ROOT_DIR)
-
 
 def encrypt_and_decrypt_with_keyring(
     plaintext_filename: str,
diff --git a/examples/src/hierarchical_keyring_example.py b/examples/src/hierarchical_keyring_example.py
@@ -31,7 +31,6 @@
 This example also requires using a KMS Key. You need the following access on this key: -
 GenerateDataKeyWithoutPlaintext - Decrypt
 """
-import sys
 
 import boto3
 # Ignore missing MPL for pylint, but the MPL is required for this example
@@ -55,11 +54,6 @@
 
 from .branch_key_id_supplier_example import ExampleBranchKeyIdSupplier
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-module_root_dir = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(module_root_dir)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/examples/src/legacy/module_.py b/examples/src/legacy/module_.py
diff --git a/examples/src/migration/migration_set_commitment_policy_example.py b/examples/src/migration/migration_set_commitment_policy_example.py
@@ -20,7 +20,6 @@
 For more information on setting your commitment policy, see
 https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#commitment-policy
 """
-import sys
 
 import boto3
 from aws_cryptographic_materialproviders.mpl import AwsCryptographicMaterialProviders
@@ -32,11 +31,6 @@
 import aws_encryption_sdk
 from aws_encryption_sdk import CommitmentPolicy
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-MODULE_ROOT_DIR = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(MODULE_ROOT_DIR)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/examples/src/module_.py b/examples/src/module_.py
diff --git a/examples/src/multi_keyring_example.py b/examples/src/multi_keyring_example.py
@@ -37,7 +37,6 @@
 https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/use-multi-keyring.html
 """
 import secrets
-import sys
 
 import boto3
 from aws_cryptographic_materialproviders.mpl import AwsCryptographicMaterialProviders
@@ -54,11 +53,6 @@
 import aws_encryption_sdk
 from aws_encryption_sdk import CommitmentPolicy
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-MODULE_ROOT_DIR = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(MODULE_ROOT_DIR)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/examples/src/raw_aes_keyring_example.py b/examples/src/raw_aes_keyring_example.py
@@ -23,7 +23,6 @@
 https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/use-raw-aes-keyring.html
 """
 import secrets
-import sys
 
 from aws_cryptographic_materialproviders.mpl import AwsCryptographicMaterialProviders
 from aws_cryptographic_materialproviders.mpl.config import MaterialProvidersConfig
@@ -34,11 +33,6 @@
 import aws_encryption_sdk
 from aws_encryption_sdk import CommitmentPolicy
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-MODULE_ROOT_DIR = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(MODULE_ROOT_DIR)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/examples/src/raw_rsa_keyring_example.py b/examples/src/raw_rsa_keyring_example.py
@@ -33,7 +33,6 @@
 For more information on how to use Raw RSA keyrings, see
 https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/use-raw-rsa-keyring.html
 """
-import sys
 
 from aws_cryptographic_materialproviders.mpl import AwsCryptographicMaterialProviders
 from aws_cryptographic_materialproviders.mpl.config import MaterialProvidersConfig
@@ -48,11 +47,6 @@
 from aws_encryption_sdk import CommitmentPolicy
 from aws_encryption_sdk.exceptions import AWSEncryptionSDKClientError
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-MODULE_ROOT_DIR = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(MODULE_ROOT_DIR)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/examples/src/required_encryption_context_cmm.py b/examples/src/required_encryption_context_cmm.py
@@ -6,7 +6,6 @@
 on encrypt such that they will not be stored on the message, but WILL be included in the header signature.
 On decrypt, the client MUST supply the key/value pair(s) that were not stored to successfully decrypt the message.
 """
-import sys
 
 import boto3
 # Ignore missing MPL for pylint, but the MPL is required for this example
@@ -25,11 +24,6 @@
 from aws_encryption_sdk import CommitmentPolicy
 from aws_encryption_sdk.exceptions import AWSEncryptionSDKClientError
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks
-module_root_dir = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(module_root_dir)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/examples/src/set_encryption_algorithm_suite_example.py b/examples/src/set_encryption_algorithm_suite_example.py
@@ -39,7 +39,6 @@
 https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/use-raw-aes-keyring.html
 """
 import secrets
-import sys
 
 from aws_cryptographic_materialproviders.mpl import AwsCryptographicMaterialProviders
 from aws_cryptographic_materialproviders.mpl.config import MaterialProvidersConfig
@@ -51,11 +50,6 @@
 from aws_encryption_sdk import CommitmentPolicy
 from aws_encryption_sdk.identifiers import AlgorithmSuite
 
-# TODO-MPL: Remove this as part of removing PYTHONPATH hacks.
-MODULE_ROOT_DIR = '/'.join(__file__.split("/")[:-1])
-
-sys.path.append(MODULE_ROOT_DIR)
-
 EXAMPLE_DATA: bytes = b"Hello World"
 
 
diff --git a/performance_tests/requirements_mpl.txt b/performance_tests/requirements_mpl.txt
diff --git a/requirements_mpl.txt b/requirements_mpl.txt
diff --git a/setup.py b/setup.py
diff --git a/test_vector_handlers/requirements_mpl.txt b/test_vector_handlers/requirements_mpl.txt
diff --git a/test_vector_handlers/src/awses_test_vectors/manifests/full_message/decrypt.py b/test_vector_handlers/src/awses_test_vectors/manifests/full_message/decrypt.py
diff --git a/test_vector_handlers/src/awses_test_vectors/manifests/mpl_keyring.py b/test_vector_handlers/src/awses_test_vectors/manifests/mpl_keyring.py
