chore(ci): pins deps and enables dependabot (#253)

josecorella · web-flow · commit b32b4b25429d · 2022-02-21T08:49:38.000-08:00
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,13 @@
+version: 2
+updates:
+  # master
+  - package-ecosystem: "pip"
+    directory: "/dev_requirements"
+    schedule:
+      interval: "daily"
+
+  # Github Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
diff --git a/.github/workflows/ci_static-analysis.yaml b/.github/workflows/ci_static-analysis.yaml
@@ -15,7 +15,6 @@ jobs:
       fail-fast: false
       matrix:
         category:
-          - mypy-py2
           - mypy-py3
           - bandit
           - doc8
@@ -24,17 +23,19 @@ jobs:
           - flake8
           - pylint
           - flake8-tests
+          - flake8-examples
           - pylint-tests
+          - pylint-examples
           - black-check
           - isort-check
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
         with:
-          python-version: 3.x
+          python-version: 3.8
       - run: |
           python -m pip install --upgrade pip
-          pip install --upgrade -r ci-requirements.txt
+          pip install --upgrade -r dev_requirements/ci-requirements.txt
       - name: check
         env:
           TOXENV: ${{ matrix.category }}
diff --git a/.github/workflows/ci_tests.yaml b/.github/workflows/ci_tests.yaml
@@ -43,7 +43,7 @@ jobs:
           architecture: ${{ matrix.platform.architecture }}
       - run: |
           python -m pip install --upgrade pip
-          pip install --upgrade -r ci-requirements.txt
+          pip install --upgrade -r dev_requirements/ci-requirements.txt
       - name: run test
         env:
           TOXENV: ${{ matrix.category }}
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -17,6 +17,6 @@ submodules:
 python:
   version: 3.8
   install:
-    - requirements: doc/requirements.txt
+    - requirements: dev_requirements/doc-requirements.txt
     - method: setuptools
       path: .
diff --git a/ci-requirements.txt b/ci-requirements.txt
diff --git a/dev_requirements/ci-requirements.txt b/dev_requirements/ci-requirements.txt
@@ -0,0 +1 @@
+tox==3.24.5
diff --git a/dev_requirements/coverage-requirements.txt b/dev_requirements/coverage-requirements.txt
@@ -0,0 +1,4 @@
+coverage==4.5.4
+mypy==0.812
+mypy-extensions==0.4.3
+typing==3.7.4.3
diff --git a/dev_requirements/doc-requirements.txt b/dev_requirements/doc-requirements.txt
diff --git a/dev_requirements/linter-requirements.txt b/dev_requirements/linter-requirements.txt
@@ -0,0 +1,18 @@
+bandit==1.7.2
+black==22.1.0
+doc8==0.10.1
+flake8==4.0.1
+flake8-docstrings==1.6.0
+flake8-print==4.0.0
+isort==5.10.1
+mock==4.0.3
+mypy==0.812
+pyflakes==2.4.0
+pylint==2.12.2
+pytest==7.0.0
+pytest-cov==3.0.0
+pytest-mock==3.6.1
+readme_renderer==32.0
+seed-isort-config==2.2.0
+sphinx==4.2.0
+vulture==2.3
diff --git a/dev_requirements/test-requirements.txt b/dev_requirements/test-requirements.txt
@@ -0,0 +1,4 @@
+mock==4.0.3
+pytest==7.0.0
+pytest-cov==3.0.0
+pytest-mock==3.6.1
diff --git a/examples/src/aws_encryption_sdk_cli_examples/command_line_roundtrip.py b/examples/src/aws_encryption_sdk_cli_examples/command_line_roundtrip.py
@@ -10,15 +10,19 @@
 # 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.
-"""Example showing basic usage of the AWS Encryption CLI to encrypt
-input from stdin and output it to stdout."""
+"""Example showing basic usage of the AWS Encryption CLI.
+
+Encrypt input from stdin and output it to stdout.
+"""
 
 import shlex
 from subprocess import PIPE, Popen
 
-from aws_encryption_sdk_cli_examples.example_test_utils import cmk_arn, is_windows, setup_file
+from aws_encryption_sdk_cli_examples.example_test_utils import cmk_arn, is_windows
+
 
 def run():
+    """Runner function for stdin and stdout encrypt example."""
     expected_plaintext = "Hello World"
     cmk = cmk_arn()
 
diff --git a/examples/src/aws_encryption_sdk_cli_examples/directory_roundtrip.py b/examples/src/aws_encryption_sdk_cli_examples/directory_roundtrip.py
@@ -10,9 +10,12 @@
 # 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.
-"""Example showing basic usage of the AWS Encryption CLI to encrypt
-and decrypt all files in a directory."""
 
+"""Example showing basic usage of the AWS Encryption CLI.
+
+Encrypt and decrypt all files in a directory.
+
+"""
 import os
 import shlex
 from subprocess import PIPE, Popen
@@ -21,6 +24,7 @@
 
 
 def run(tmpdir):
+    """Runner function for encrypt and decrypt directory example."""
     cmk = cmk_arn()
 
     # Create directories that will store plaintext, ciphertexts,
@@ -52,6 +56,6 @@ def run(tmpdir):
         with open(original_file, "r") as f1:
             original_plaintext = f1.read()
             decrypted_file = os.path.join(decrypt_directory, os.path.basename(original_file) + ".encrypted.decrypted")
-            with open (decrypted_file) as f2:
+            with open(decrypted_file) as f2:
                 decrypted_plaintext = f2.read()
                 assert decrypted_plaintext == original_plaintext
diff --git a/examples/src/aws_encryption_sdk_cli_examples/example_test_utils.py b/examples/src/aws_encryption_sdk_cli_examples/example_test_utils.py
@@ -9,33 +9,33 @@
 
 
 def cmk_arn_value(variable_name):
-    """Retrieves the target CMK ARN from environment variable."""
+    """Retrieve target CMK ARN from environment variable."""
     arn = os.environ.get(variable_name, None)
     if arn is None:
         raise ValueError(
             'Environment variable "{}" must be set to a valid KMS CMK ARN for examples to run'.format(
-               variable_name 
+                variable_name
             )
         )
     if arn.startswith("arn:") and ":alias/" not in arn:
         return arn
     raise ValueError("KMS CMK ARN provided for examples must be a key not an alias")
 
 
-def cmk_arn():
+def cmk_arn():  # noqa: D103
     return cmk_arn_value(AWS_KMS_KEY_ID_1)
 
 
-def second_cmk_arn():
+def second_cmk_arn():  # noqa: D103
     return cmk_arn_value(AWS_KMS_KEY_ID_2)
 
 
-def is_windows():
+def is_windows():  # noqa: D103
     return any(platform.win32_ver())
 
 
 def setup_file(tmpdir, plaintext):
-    """Creates a file in the given tmpdir containing the provided plaintext."""
+    """Create a file in the given tmpdir containing the provided plaintext."""
     filename = ''.join(random.choice(string.ascii_lowercase) for i in range(10))
 
     full_path = os.path.join(str(tmpdir), filename)
@@ -45,7 +45,7 @@ def setup_file(tmpdir, plaintext):
 
 
 def setup_files(tmpdir, num_files):
-    """Creates num_files files in the given tmpdir containing random plaintext."""
+    """Create num_files files in the given tmpdir containing random plaintext."""
     files = []
     for i in range(num_files):
         plaintext = ''.join(random.choice(string.ascii_lowercase) for i in range(20))
diff --git a/examples/src/aws_encryption_sdk_cli_examples/file_roundtrip.py b/examples/src/aws_encryption_sdk_cli_examples/file_roundtrip.py
@@ -10,8 +10,10 @@
 # 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.
-"""Example showing basic usage of the AWS Encryption CLI to encrypt
-and decrypt a file."""
+"""Example showing basic usage of the AWS Encryption CLI.
+
+Encrypt and decrypt a file.
+"""
 
 import shlex
 from subprocess import PIPE, Popen
@@ -20,6 +22,7 @@
 
 
 def run(tmpdir):
+    """Runner function for encrypt and decrypt file example."""
     expected_plaintext = "Hello World"
     filename = setup_file(tmpdir, expected_plaintext)
     cmk = cmk_arn()
diff --git a/examples/src/aws_encryption_sdk_cli_examples/file_roundtrip_multiple_keys.py b/examples/src/aws_encryption_sdk_cli_examples/file_roundtrip_multiple_keys.py
@@ -10,8 +10,10 @@
 # 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.
-"""Example showing basic usage of the AWS Encryption CLI to encrypt
-and decrypt a file with multiple master keys."""
+"""Example showing basic usage of the AWS Encryption CLI.
+
+Encrypt and decrypt a file with multiple master keys.
+"""
 
 import shlex
 from subprocess import PIPE, Popen
@@ -20,6 +22,7 @@
 
 
 def run(tmpdir):
+    """Runner function for encrypt and decrypt file with mulitple master keys example."""
     expected_plaintext = "Hello World"
     filename = setup_file(tmpdir, expected_plaintext)
     cmk1 = cmk_arn()
diff --git a/examples/src/pylintrc b/examples/src/pylintrc
@@ -0,0 +1,49 @@
+[MESSAGE CONTROL]
+# Disabling messages that either we don't care about we intentionally break.
+disable =
+    invalid-name,  # we prefer long, descriptive, names for examples
+    bad-continuation,  # we let black handle this
+    ungrouped-imports,  # we let isort handle this
+    no-member,  # breaks with attrs
+    no-self-use,  # interesting to keep in mind for later refactoring, but not blocking
+    useless-object-inheritance,  # we need to support Python 2, so no, not useless
+    duplicate-code,  # some examples may be similar
+    too-few-public-methods,  # does not allow value stores
+    too-many-locals,  # examples may sometimes have more locals defined for clarity than would be appropriate in code
+    no-else-return,  # we omit this on purpose for brevity where it would add no value
+    attribute-defined-outside-init,  # breaks with attrs_post_init
+    abstract-method,  # throws false positives on io.BaseIO grandchildren
+    redefined-outer-name,  # we do this on purpose in multiple places
+    consider-using-f-string, # disable until 2022-05-05; 6 months after 3.5 deprecation
+    unused-variable, # examples leave unused variables for customers to be able to print them to the console
+    missing-function-docstring, # examples use short helper function that does not need a docstring
+    unspecified-encoding,
+    consider-using-with
+
+
+[BASIC]
+# Allow function names up to 50 characters
+function-rgx = [a-z_][a-z0-9_]{2,50}$
+# Allow method names up to 50 characters
+method-rgx = [a-z_][a-z0-9_]{2,50}$
+# Allow class attribute names up to 50 characters
+# Whitelist class attribute names: iv
+class-attribute-rgx = (([A-Za-z_][A-Za-z0-9_]{2,50}|(__.*__))$)|(^iv$)
+# Whitelist attribute names: iv
+attr-rgx = ([a-z_][a-z0-9_]{2,30}$)|(^iv$)
+# Whitelist argument names: iv, b
+argument-rgx = ([a-z_][a-z0-9_]{2,30}$)|(^iv$)|(^b$)
+# Whitelist variable names: iv, b, _b, x, y, r, s
+variable-rgx = ([a-z_][a-z0-9_]{2,30}$)|(^iv$)|(^b$)|(^_b$)|(^x$)|(^y$)|(^r$)|(^s$)
+
+[VARIABLES]
+additional-builtins = raw_input
+
+[DESIGN]
+max-args = 10
+
+[FORMAT]
+max-line-length = 120
+
+[REPORTS]
+msg-template = {path}:{line}: [{msg_id}({symbol}), {obj}] {msg}
diff --git a/examples/test/pylintrc b/examples/test/pylintrc
@@ -0,0 +1,22 @@
+[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
+    wrong-import-position,  # similar to E0401, pylint does not appear to identify
+                            # unknown modules as non-standard-library. flake8 tests for this as well
+                            # and does treat them properly
+    duplicate-code,  # tests for similar things tend to be similar
+    consider-using-f-string # disable until 2022-05-05; 6 months after 3.5 deprecation
+
+[VARIABLES]
+additional-builtins = raw_input
+
+[DESIGN]
+max-args = 10
+
+[FORMAT]
+max-line-length = 120
+
+[REPORTS]
+msg-template = {path}:{line}: [{msg_id}({symbol}), {obj}] {msg}
diff --git a/examples/test/test_command_line_roundtrip.py b/examples/test/test_command_line_roundtrip.py
@@ -10,10 +10,10 @@
 # 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.
-
+"""Test ``command_line_roundtrip`` examples."""
 import pytest
 from aws_encryption_sdk_cli_examples import (
-    command_line_roundtrip 
+    command_line_roundtrip
 )
 
 pytestmark = [pytest.mark.examples]
diff --git a/examples/test/test_directory_roundtrip.py b/examples/test/test_directory_roundtrip.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.
-
+"""Test ``directory_roundtrip`` example."""
 import pytest
 from aws_encryption_sdk_cli_examples import (
     directory_roundtrip
diff --git a/examples/test/test_file_roundtrip.py b/examples/test/test_file_roundtrip.py
@@ -10,10 +10,10 @@
 # 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.
-
+"""Test ``file_roundtrip`` example."""
 import pytest
 from aws_encryption_sdk_cli_examples import (
-    file_roundtrip 
+    file_roundtrip
 )
 
 pytestmark = [pytest.mark.examples]
diff --git a/examples/test/test_file_roundtrip_multiple_keys.py b/examples/test/test_file_roundtrip_multiple_keys.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.
-
+"""Test ``file_roundtrip_multiple_keys`` examples."""
 import pytest
 from aws_encryption_sdk_cli_examples import (
     file_roundtrip_multiple_keys
diff --git a/tox.ini b/tox.ini
