Merge pull request aws#131 from mattsb42-aws/linting

Decrypt oracle linting

Author: mattsb42-aws

.travis.yml

@@ -285,23 +285,26 @@ matrix:
     #  env:
     #    DECRYPT_ORACLE=1
     #    TOXENV=doc8
-    # Pending linting cleanup
-    #- python: 3.6
-    #  env:
-    #    DECRYPT_ORACLE=1
-    #    TOXENV=flake8
-    #- python: 3.6
-    #  env:
-    #    DECRYPT_ORACLE=1
-    #    TOXENV=pylint
-    #- python: 3.6
-    #  env:
-    #    DECRYPT_ORACLE=1
-    #    TOXENV=flake8-tests
-    #- python: 3.6
-    #  env:
-    #    DECRYPT_ORACLE=1
-    #    TOXENV=pylint-tests
+    - python: 3.6
+      env:
+        DECRYPT_ORACLE=1
+        TOXENV=flake8
+      stage: Decrypt Oracle Formatting Checks
+    - python: 3.6
+      env:
+        DECRYPT_ORACLE=1
+        TOXENV=pylint
+      stage: Decrypt Oracle Formatting Checks
+    - python: 3.6
+      env:
+        DECRYPT_ORACLE=1
+        TOXENV=flake8-tests
+      stage: Decrypt Oracle Formatting Checks
+    - python: 3.6
+      env:
+        DECRYPT_ORACLE=1
+        TOXENV=pylint-tests
+      stage: Decrypt Oracle Formatting Checks
 install: pip install tox
 script:
   - |

decrypt_oracle/.chalice/pipeline.py

@@ -1,6 +1,4 @@
-"""
-Generate the CloudFormation template for the deployment pipeline.
-"""
+"""Generate the CloudFormation template for the deployment pipeline."""
 import argparse
 import getpass
 import logging
@@ -36,6 +34,7 @@ class AllowEverywhere(AWS.Statement):
     """Shortcut for creating IAM Statements that Allow to Resource "*"."""
 
     def __init__(self, *args, **kwargs):
+        """Set up override values."""
         my_kwargs = dict(Effect=AWS.Allow, Resource=["*"])
         my_kwargs.update(kwargs)
         super(AllowEverywhere, self).__init__(*args, **my_kwargs)
@@ -155,6 +154,7 @@ def _pipeline(
     github_branch: str,
     github_access_token: troposphere.AWSProperty,
 ) -> codepipeline.Pipeline:
+    # pylint: disable=too-many-locals,too-many-arguments
     """Build and return the CodePipeline pipeline resource."""
     _source_output = "SourceOutput"
     get_source = codepipeline.Stages(

decrypt_oracle/app.py

@@ -11,4 +11,4 @@
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 """Shim to pull decryption oracle app into expected location for Chalice."""
-from aws_encryption_sdk_decrypt_oracle.app import APP as app
+from aws_encryption_sdk_decrypt_oracle.app import APP as app  # noqa pylint: disable=unused-import

decrypt_oracle/setup.cfg

@@ -20,8 +20,8 @@ import_order_style = google
 application_import_names = aws_encryption_sdk_decryption_oracle
 builtins = raw_input
 ignore =
-    # Ignoring D205 and D400 because of false positives
-    D205, D400,
+    # Ignoring D205, D400, and D401 because of false positives
+    D205, D400, D401,
     # E203 is not PEP8 compliant https://github.com/ambv/black#slices
     E203,
     # W503 is not PEP8 compliant https://github.com/ambv/black#line-breaks--binary-operators

decrypt_oracle/src/aws_encryption_sdk_decrypt_oracle/app.py

@@ -10,7 +10,7 @@
 # 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.
-"""Decrypt Oracle using the AWS Encryption SDK for Python."""
+"""Decrypt Oracle powered by the AWS Encryption SDK for Python."""
 import json
 import logging
 import os

decrypt_oracle/src/aws_encryption_sdk_decrypt_oracle/key_providers/counting.py

@@ -34,7 +34,7 @@ def __init__(self) -> None:
 
 
 class CountingMasterKey(MasterKey):
-    """Master key that generates deterministic data keys and decrypts a pre-defined
+    r"""Master key that generates deterministic data keys and decrypts a pre-defined
     encrypted data key value to that deterministic data keys.
 
     Generated/decrypted data keys are of the form: ``\01\02\03\04...`` counting

decrypt_oracle/src/aws_encryption_sdk_decrypt_oracle/key_providers/null.py

@@ -67,7 +67,7 @@ def _null_plaintext_data_key(algorithm: AlgorithmSuite) -> bytes:
         return b"\x00" * algorithm.data_key_len
 
     def _generate_data_key(self, algorithm: AlgorithmSuite, encryption_context: Dict[Text, Text]) -> DataKey:
-        """NullMasterKey does not support generate_data_key
+        """:class:`NullMasterKey` does not support generate_data_key
 
         :param algorithm: Algorithm on which to base data key
         :type algorithm: aws_encryption_sdk.identifiers.Algorithm
@@ -81,7 +81,7 @@ def _generate_data_key(self, algorithm: AlgorithmSuite, encryption_context: Dict
     def _encrypt_data_key(
         self, data_key: DataKey, algorithm: AlgorithmSuite, encryption_context: Dict[Text, Text]
     ) -> NoReturn:
-        """NullMasterKey does not support encrypt_data_key
+        """:class:`NullMasterKey` does not support encrypt_data_key
 
         :param data_key: Unencrypted data key
         :type data_key: :class:`aws_encryption_sdk.structures.RawDataKey`

decrypt_oracle/test/pylintrc

@@ -0,0 +1,13 @@
+[MESSAGES CONTROL]
+# Disabling messages that we either don't care about for tests or are necessary to break for tests.
+disable =
+    invalid-name,  # we prefer long, descriptive, names for tests
+    missing-docstring,  # we don't write docstrings for tests
+    bad-continuation,  # we let black handle this
+    ungrouped-imports,  # we let isort handle this
+
+[FORMAT]
+max-line-length = 120
+
+[REPORTS]
+msg-template = {path}:{line}: [{msg_id}({symbol}), {obj}] {msg}

decrypt_oracle/tox.ini

@@ -161,7 +161,9 @@ deps =
 commands =
     flake8 \
         src/aws_encryption_sdk_decrypt_oracle/ \
+        app.py \
         setup.py \
+        .chalice/pipeline.py \
         #doc/conf.py \
         {posargs}
 
@@ -182,13 +184,16 @@ commands =
 basepython = python3
 deps =
     -rtest/requirements.txt
+    {[testenv:generate-pipeline]deps}
     pyflakes
     pylint
 commands =
     pylint \
         --rcfile=src/pylintrc \
         src/aws_encryption_sdk_decrypt_oracle/  \
+        app.py \
         setup.py \
+        .chalice/pipeline.py \
         {posargs}
 
 [testenv:pylint-tests]
@@ -198,7 +203,6 @@ commands =
     pylint \
         --rcfile=test/pylintrc \
         test/unit/ \
-        test/functional/ \
         test/integration/ \
         {posargs}
 
@@ -210,6 +214,7 @@ commands =
     black --line-length 120 \
         src/aws_encryption_sdk_decrypt_oracle/ \
         setup.py \
+        app.py \
         #doc/conf.py \
         test/ \
         .chalice/pipeline.py \
@@ -244,6 +249,7 @@ commands = isort -rc \
     #doc \
     setup.py \
     .chalice/pipeline.py \
+    app.py \
     {posargs}
 
 [testenv:isort-check]