Keyring reorg (#198)

* reorganize keyring tests to match #100 and keyring namespace to simplify names

* change aws_encryption_sdk.keyring to aws_encryption_sdk.keyrings for consistency in namespace names

* autoformat

* disable pylint similarity checks on imports

Because we provide multiple implementations of certain types of things (keyrings, etc),
this was triggering pylint due to them all needing to import the same types in order to function.

* remove aws_encryption_sdk namespace layer in test reorg

Author: mattsb42-aws

src/aws_encryption_sdk/keyring/__init__.py renamed to src/aws_encryption_sdk/keyrings/__init__.py

@@ -11,13 +11,11 @@
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 """Base class interface for Keyrings."""
-from aws_encryption_sdk.materials_managers import (  # only used for mypy; pylint: disable=unused-import,duplicate-code
+from aws_encryption_sdk.materials_managers import (  # only used for mypy; pylint: disable=unused-import
     DecryptionMaterials,
     EncryptionMaterials,
 )
-from aws_encryption_sdk.structures import (  # only used for mypy; pylint: disable=unused-import,duplicate-code
-    EncryptedDataKey,
-)
+from aws_encryption_sdk.structures import EncryptedDataKey  # only used for mypy; pylint: disable=unused-import
 
 try:  # Python 3.5.0 and 3.5.1 have incompatible typing modules
     from typing import Iterable  # noqa pylint: disable=unused-import

src/aws_encryption_sdk/keyring/base.py renamed to src/aws_encryption_sdk/keyrings/base.py

@@ -17,10 +17,13 @@
 from attr.validators import deep_iterable, instance_of, optional
 
 from aws_encryption_sdk.exceptions import EncryptKeyError, GenerateKeyError
-from aws_encryption_sdk.keyring.base import DecryptionMaterials  # only used for mypy so pylint: disable=unused-import
-from aws_encryption_sdk.keyring.base import EncryptionMaterials  # only used for mypy so pylint: disable=unused-import
-from aws_encryption_sdk.keyring.base import Keyring
-from aws_encryption_sdk.structures import EncryptedDataKey  # only used for mypy so pylint: disable=unused-import
+from aws_encryption_sdk.keyrings.base import Keyring
+
+from aws_encryption_sdk.materials_managers import (  # only used for mypy; pylint: disable=unused-import
+    DecryptionMaterials,
+    EncryptionMaterials,
+)
+from aws_encryption_sdk.structures import EncryptedDataKey  # only used for mypy; pylint: disable=unused-import
 
 try:  # Python 3.5.0 and 3.5.1 have incompatible typing modules
     from typing import Iterable  # noqa pylint: disable=unused-import

src/aws_encryption_sdk/keyring/multi_keyring.py renamed to src/aws_encryption_sdk/keyrings/multi.py

@@ -11,7 +11,6 @@
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 """Resources required for Raw Keyrings."""
-
 import logging
 import os
 
@@ -28,13 +27,18 @@
 from aws_encryption_sdk.internal.formatting.deserialize import deserialize_wrapped_key
 from aws_encryption_sdk.internal.formatting.serialize import serialize_raw_master_key_prefix, serialize_wrapped_key
 from aws_encryption_sdk.key_providers.raw import RawMasterKey
-from aws_encryption_sdk.keyring.base import Keyring
-from aws_encryption_sdk.materials_managers import (  # only used for mypy so pylint: disable=unused-import
+from aws_encryption_sdk.keyrings.base import Keyring
+from aws_encryption_sdk.structures import (  # pylint: disable=unused-import
+    EncryptedDataKey,
+    KeyringTrace,
+    MasterKeyInfo,
+    RawDataKey,
+)
+
+from aws_encryption_sdk.materials_managers import (  # only used for mypy; pylint: disable=unused-import
     DecryptionMaterials,
     EncryptionMaterials,
 )
-from aws_encryption_sdk.structures import EncryptedDataKey  # only used for mypy so pylint: disable=unused-import
-from aws_encryption_sdk.structures import KeyringTrace, MasterKeyInfo, RawDataKey
 
 try:  # Python 3.5.0 and 3.5.1 have incompatible typing modules
     from typing import Iterable  # noqa pylint: disable=unused-import

src/aws_encryption_sdk/keyring/raw_keyring.py renamed to src/aws_encryption_sdk/keyrings/raw.py

@@ -33,6 +33,9 @@ additional-builtins = raw_input
 [DESIGN]
 max-args = 10
 
+[SIMILARITIES]
+ignore-imports = yes
+
 [FORMAT]
 max-line-length = 120
 

src/pylintrc

@@ -0,0 +1,13 @@
+# Copyright 2019 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.
+"""Dummy stub to make linters work better."""

test/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2019 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.
+"""Dummy stub to make linters work better."""

test/functional/keyrings/__init__.py

@@ -24,7 +24,7 @@
 from aws_encryption_sdk.internal.crypto import WrappingKey
 from aws_encryption_sdk.internal.formatting.serialize import serialize_raw_master_key_prefix
 from aws_encryption_sdk.key_providers.raw import RawMasterKey
-from aws_encryption_sdk.keyring.raw_keyring import RawAESKeyring
+from aws_encryption_sdk.keyrings.raw import RawAESKeyring
 from aws_encryption_sdk.materials_managers import DecryptionMaterials, EncryptionMaterials
 from aws_encryption_sdk.structures import KeyringTrace, MasterKeyInfo, RawDataKey
 

test/functional/keyrings/raw/__init__.py

@@ -26,7 +26,7 @@
 )
 from aws_encryption_sdk.internal.crypto import WrappingKey
 from aws_encryption_sdk.key_providers.raw import RawMasterKey
-from aws_encryption_sdk.keyring.raw_keyring import RawRSAKeyring
+from aws_encryption_sdk.keyrings.raw import RawRSAKeyring
 from aws_encryption_sdk.materials_managers import DecryptionMaterials, EncryptionMaterials
 from aws_encryption_sdk.structures import KeyringTrace, MasterKeyInfo, RawDataKey
 

test/functional/test_f_keyring_raw_aes.py renamed to test/functional/keyrings/raw/test_raw_aes.py

@@ -18,8 +18,8 @@
 
 from aws_encryption_sdk.identifiers import KeyringTraceFlag, WrappingAlgorithm
 from aws_encryption_sdk.internal.defaults import ALGORITHM
-from aws_encryption_sdk.keyring.multi_keyring import MultiKeyring
-from aws_encryption_sdk.keyring.raw_keyring import RawAESKeyring, RawRSAKeyring
+from aws_encryption_sdk.keyrings.multi import MultiKeyring
+from aws_encryption_sdk.keyrings.raw import RawAESKeyring, RawRSAKeyring
 from aws_encryption_sdk.materials_managers import DecryptionMaterials, EncryptionMaterials
 from aws_encryption_sdk.structures import KeyringTrace, MasterKeyInfo, RawDataKey
 

test/functional/test_f_keyring_raw_rsa.py renamed to test/functional/keyrings/raw/test_raw_rsa.py

@@ -0,0 +1,13 @@
+# Copyright 2019 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.
+"""Dummy stub to make linters work better."""

test/functional/test_f_multi_keyring.py renamed to test/functional/keyrings/test_multi.py

@@ -0,0 +1,13 @@
+# Copyright 2019 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.
+"""Dummy stub to make linters work better."""

test/unit/keyrings/__init__.py

@@ -19,15 +19,15 @@
 from pytest_mock import mocker  # noqa pylint: disable=unused-import
 
 import aws_encryption_sdk.key_providers.raw
-import aws_encryption_sdk.keyring.raw_keyring
+import aws_encryption_sdk.keyrings.raw
 from aws_encryption_sdk.identifiers import Algorithm, KeyringTraceFlag, WrappingAlgorithm
 from aws_encryption_sdk.internal.crypto.wrapping_keys import WrappingKey
-from aws_encryption_sdk.keyring.base import Keyring
-from aws_encryption_sdk.keyring.raw_keyring import GenerateKeyError, RawAESKeyring, _generate_data_key
+from aws_encryption_sdk.keyrings.base import Keyring
+from aws_encryption_sdk.keyrings.raw import GenerateKeyError, RawAESKeyring, _generate_data_key
 from aws_encryption_sdk.materials_managers import EncryptionMaterials
 from aws_encryption_sdk.structures import MasterKeyInfo
 
-from .unit_test_utils import (
+from ...unit_test_utils import (
     _DATA_KEY,
     _ENCRYPTED_DATA_KEY_AES,
     _ENCRYPTED_DATA_KEY_NOT_IN_KEYRING,
@@ -57,8 +57,8 @@ def raw_aes_keyring():
 
 @pytest.fixture
 def patch_generate_data_key(mocker):
-    mocker.patch.object(aws_encryption_sdk.keyring.raw_keyring, "_generate_data_key")
-    return aws_encryption_sdk.keyring.raw_keyring._generate_data_key
+    mocker.patch.object(aws_encryption_sdk.keyrings.raw, "_generate_data_key")
+    return aws_encryption_sdk.keyrings.raw._generate_data_key
 
 
 @pytest.fixture

test/unit/keyrings/raw/__init__.py

@@ -17,14 +17,14 @@
 from pytest_mock import mocker  # noqa pylint: disable=unused-import
 
 import aws_encryption_sdk.key_providers.raw
-import aws_encryption_sdk.keyring.raw_keyring
+import aws_encryption_sdk.keyrings.raw
 from aws_encryption_sdk.identifiers import KeyringTraceFlag, WrappingAlgorithm
 from aws_encryption_sdk.internal.crypto.wrapping_keys import WrappingKey
-from aws_encryption_sdk.keyring.base import Keyring
-from aws_encryption_sdk.keyring.raw_keyring import RawRSAKeyring
+from aws_encryption_sdk.keyrings.base import Keyring
+from aws_encryption_sdk.keyrings.raw import RawRSAKeyring
 
-from .test_values import VALUES
-from .unit_test_utils import (
+from ...test_values import VALUES
+from ...unit_test_utils import (
     _BACKEND,
     _DATA_KEY,
     _ENCRYPTED_DATA_KEY_RSA,
@@ -58,8 +58,8 @@ def raw_rsa_private_key():
 
 @pytest.fixture
 def patch_generate_data_key(mocker):
-    mocker.patch.object(aws_encryption_sdk.keyring.raw_keyring, "_generate_data_key")
-    return aws_encryption_sdk.keyring.raw_keyring._generate_data_key
+    mocker.patch.object(aws_encryption_sdk.keyrings.raw, "_generate_data_key")
+    return aws_encryption_sdk.keyrings.raw._generate_data_key
 
 
 @pytest.fixture

test/unit/test_keyring_raw_aes.py renamed to test/unit/keyrings/raw/test_raw_aes.py

@@ -15,7 +15,7 @@
 import pytest
 
 from aws_encryption_sdk.identifiers import Algorithm
-from aws_encryption_sdk.keyring.base import Keyring
+from aws_encryption_sdk.keyrings.base import Keyring
 from aws_encryption_sdk.materials_managers import DecryptionMaterials, EncryptionMaterials
 
 pytestmark = [pytest.mark.unit, pytest.mark.local]

test/unit/test_keyring_raw_rsa.py renamed to test/unit/keyrings/raw/test_raw_rsa.py

@@ -19,11 +19,11 @@
 from aws_encryption_sdk.exceptions import EncryptKeyError, GenerateKeyError
 from aws_encryption_sdk.identifiers import WrappingAlgorithm
 from aws_encryption_sdk.internal.formatting import serialize
-from aws_encryption_sdk.keyring.base import Keyring
-from aws_encryption_sdk.keyring.multi_keyring import MultiKeyring
-from aws_encryption_sdk.keyring.raw_keyring import RawAESKeyring
+from aws_encryption_sdk.keyrings.base import Keyring
+from aws_encryption_sdk.keyrings.multi import MultiKeyring
+from aws_encryption_sdk.keyrings.raw import RawAESKeyring
 
-from .unit_test_utils import (
+from ..unit_test_utils import (
     IdentityKeyring,
     OnlyGenerateKeyring,
     get_decryption_materials_with_data_key,
@@ -139,10 +139,10 @@ def test_keyring_with_no_generator_no_children():
 def test_keyring_with_invalid_parameters(generator, children):
     with pytest.raises(TypeError) as exc_info:
         MultiKeyring(generator=generator, children=children)
-    assert exc_info.match("('children'|'generator') must be <class 'aws_encryption_sdk.keyring.base.Keyring'>.*")
+    assert exc_info.match("('children'|'generator') must be <class 'aws_encryption_sdk.keyrings.base.Keyring'>.*")
 
 
-def test_decryption_keyrings():
+def test_decryption_keyring():
     test_multi_keyring = get_multi_keyring_with_generator_and_children()
     assert test_multi_keyring.generator in test_multi_keyring._decryption_keyrings
     for child_keyring in test_multi_keyring.children:

test/unit/test_keyring_base.py renamed to test/unit/keyrings/test_base.py

@@ -21,7 +21,7 @@
 import aws_encryption_sdk.internal.utils
 from aws_encryption_sdk.exceptions import InvalidDataKeyError, SerializationError, UnknownIdentityError
 from aws_encryption_sdk.internal.defaults import MAX_FRAME_SIZE, MESSAGE_ID_LENGTH
-from aws_encryption_sdk.keyring.base import EncryptedDataKey
+from aws_encryption_sdk.keyrings.base import EncryptedDataKey
 from aws_encryption_sdk.structures import DataKey, MasterKeyInfo, RawDataKey
 
 from .test_values import VALUES

test/unit/test_keyring_multi.py renamed to test/unit/keyrings/test_multi.py

@@ -21,9 +21,9 @@
 
 from aws_encryption_sdk.identifiers import Algorithm, KeyringTraceFlag, WrappingAlgorithm
 from aws_encryption_sdk.internal.utils.streams import InsistentReaderBytesIO
-from aws_encryption_sdk.keyring.base import Keyring
-from aws_encryption_sdk.keyring.multi_keyring import MultiKeyring
-from aws_encryption_sdk.keyring.raw_keyring import RawAESKeyring, RawRSAKeyring
+from aws_encryption_sdk.keyrings.base import Keyring
+from aws_encryption_sdk.keyrings.multi import MultiKeyring
+from aws_encryption_sdk.keyrings.raw import RawAESKeyring, RawRSAKeyring
 from aws_encryption_sdk.materials_managers import DecryptionMaterials, EncryptionMaterials
 from aws_encryption_sdk.structures import EncryptedDataKey, KeyringTrace, MasterKeyInfo, RawDataKey