enable pylint pre-commit hook

Author: dcernag

.pre-commit-config.yaml

@@ -16,3 +16,7 @@ repos:
     rev: v1.4.0
     hooks:
       - id: doctoc
+  - repo: [email protected]:PyCQa/pylint
+    rev: pylint-2.5.3
+    hooks:
+      - id: pylint

.pylintrc

@@ -1,5 +1,8 @@
 [MASTER]
 
+# Specify a score threshold to be exceeded before program exits with error.
+fail-under=9
+
 # List of plugins (as comma separated values of python module names) to load,
 # usually to register additional checkers.
 load-plugins=
@@ -36,85 +39,8 @@ confidence=
 # --disable=W".
 disable=missing-function-docstring,
         missing-module-docstring,
-        parameter-unpacking,
-        unpacking-in-except,
-        old-raise-syntax,
-        backtick,
-        long-suffix,
-        old-ne-operator,
-        old-octal-literal,
-        import-star-module-level,
-        non-ascii-bytes-literal,
-        raw-checker-failed,
-        bad-inline-option,
-        locally-disabled,
-        file-ignored,
         line-too-long,
-        suppressed-message,
-        useless-suppression,
-        deprecated-pragma,
-        use-symbolic-message-instead,
-        apply-builtin,
-        basestring-builtin,
-        buffer-builtin,
-        cmp-builtin,
-        coerce-builtin,
-        execfile-builtin,
-        file-builtin,
-        long-builtin,
-        raw_input-builtin,
-        reduce-builtin,
-        standarderror-builtin,
-        unicode-builtin,
-        xrange-builtin,
-        coerce-method,
-        delslice-method,
-        getslice-method,
-        setslice-method,
-        no-absolute-import,
-        old-division,
-        dict-iter-method,
-        dict-view-method,
-        next-method-called,
-        metaclass-assignment,
-        indexing-exception,
-        raising-string,
-        reload-builtin,
-        oct-method,
-        hex-method,
-        nonzero-method,
-        cmp-method,
-        input-builtin,
-        round-builtin,
-        intern-builtin,
-        unichr-builtin,
-        map-builtin-not-iterating,
-        zip-builtin-not-iterating,
-        range-builtin-not-iterating,
-        filter-builtin-not-iterating,
-        using-cmp-argument,
-        eq-without-hash,
-        div-method,
-        idiv-method,
-        rdiv-method,
-        exception-message-attribute,
-        invalid-str-codec,
-        sys-max-int,
-        bad-python3-import,
-        deprecated-string-function,
-        deprecated-str-translate-call,
-        deprecated-itertools-function,
-        deprecated-types-field,
-        next-method-defined,
-        dict-items-not-iterating,
-        dict-keys-not-iterating,
-        dict-values-not-iterating,
-        deprecated-operator-function,
-        deprecated-urllib-function,
-        xreadlines-attribute,
-        deprecated-sys-function,
-        exception-escape,
-        comprehension-escape
+        duplicate-code
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

k8t/filters.py

@@ -68,8 +68,8 @@ def b64decode(value: Any) -> str:
 def hashf(value, method="sha256"):
     try:
         hash_method = getattr(hashlib, method)()
-    except AttributeError:
-        raise RuntimeError("No such hash method: {}".format(method))
+    except AttributeError as no_hash_method:
+        raise RuntimeError("No such hash method: {}".format(method)) from no_hash_method
 
     if isinstance(value, str):
         hash_method.update(value.encode())
@@ -90,8 +90,8 @@ def get_secret(key: str, length: int = None) -> str:
     provider_name = str(provider_name).lower()
     try:
         provider = getattr(secret_providers, provider_name)
-    except AttributeError:
-        raise NotImplementedError("secret provider {} does not exist.".format(provider_name))
+    except AttributeError as no_secret_provider:
+        raise NotImplementedError("secret provider {} does not exist.".format(provider_name)) from no_secret_provider
 
     return provider(key, length)
 

k8t/secret_providers.py

@@ -10,8 +10,8 @@
 import logging
 import string
 
-import boto3
-import botocore
+import boto3  # pylint: disable=E0401
+import botocore  # pylint: disable=E0401
 from k8t import config
 
 try:
@@ -50,7 +50,7 @@ def ssm(key: str, length: int = None) -> str:
         client.exceptions.ParameterNotFound,
         botocore.exceptions.ClientError,
     ) as exc:
-        raise RuntimeError(f"Failed to retrieve secret {key}: {exc}")
+        raise RuntimeError(f"Failed to retrieve secret {key}: {exc}") from exc
 
 
 def random(key: str, length: int = None) -> str:

k8t/templates.py

@@ -8,11 +8,10 @@
 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 import logging
-import os
 from typing import Set, Tuple
 
-import yaml
-from jinja2 import Environment, meta, nodes
+import yaml  # pylint: disable=E0401
+from jinja2 import Environment, meta, nodes  # pylint: disable=E0401
 
 from k8t import config
 
@@ -113,6 +112,6 @@ def render(template_path: str, values: dict, engine: Environment) -> str:
     try:
         yaml.safe_load_all(output)
     except (yaml.scanner.ScannerError, yaml.parser.ParserError) as err:
-        raise YamlValidationError(err)
+        raise YamlValidationError(err) from err
 
     return output

tests/cli.py

@@ -12,10 +12,11 @@
 from click.testing import CliRunner
 
 import boto3
+from moto import mock_ssm  # pylint: disable=E0401
+
 from k8t import __license__, __version__
 from k8t.cli import root
 from k8t.scaffolding import list_available_templates
-from moto import mock_ssm
 
 
 def test_print_version():
@@ -25,13 +26,15 @@ def test_print_version():
     assert result.exit_code == 0
     assert __version__ in result.output
 
+
 def test_print_license():
     runner = CliRunner()
 
     result = runner.invoke(root, ['license'])
     assert result.exit_code == 0
     assert __license__ in result.output
 
+
 def test_new_project():
     runner = CliRunner()
 
@@ -46,6 +49,7 @@ def test_new_project():
         assert os.path.exists('test/values.yaml')
         assert os.path.exists('test/config.yaml')
 
+
 def test_new_cluster():
     runner = CliRunner()
 
@@ -60,6 +64,7 @@ def test_new_cluster():
         assert os.path.exists('./clusters/cluster-1/values.yaml')
         assert os.path.exists('./clusters/cluster-1/config.yaml')
 
+
 def test_new_environment():
     runner = CliRunner()
 
@@ -84,6 +89,7 @@ def test_new_environment():
         assert os.path.exists('./clusters/cluster-1/environments/production/values.yaml')
         assert os.path.exists('./clusters/cluster-1/environments/production/config.yaml')
 
+
 def test_new_template():
     template_type = list(list_available_templates())[0]
     runner = CliRunner()
@@ -137,15 +143,16 @@ def test_new_template():
             assert f'Template created: ./templates/{template_type}.yaml.j2' in result.output
             assert os.path.exists(f'./templates/{template_type}.yaml.j2')
 
+
 def test_get_clusters():
     runner = CliRunner()
 
     result = runner.invoke(root, ['get', 'clusters', 'tests/resources/good'])
     assert result.exit_code == 0
-    # TODO: Fix that, should return clusters, not environments
     assert 'cluster-1' in result.output
     assert 'cluster-2' in result.output
 
+
 def test_get_environments():
     runner = CliRunner()
 
@@ -165,7 +172,8 @@ def test_get_environments():
     assert result.exit_code == 0
     assert not result.output
 
-def test_get_templates():
+
+def test_get_templates():  # pylint: disable=R0915
     runner = CliRunner()
 
     result = runner.invoke(root, ['get', 'templates', 'tests/resources/good'])
@@ -224,7 +232,8 @@ def test_get_templates():
     assert 'cluster-1-env-template.yaml.j2' not in result.output
     assert 'composite-template.yaml.j2' in result.output
 
-def test_validate_successful():
+
+def test_validate_successful():  # pylint: disable=R0915
     runner = CliRunner()
 
     result = runner.invoke(root, ['validate', 'tests/resources/good'])
@@ -283,11 +292,12 @@ def test_validate_successful():
     assert 'cluster-1-env-template.yaml.j2: ✔' not in result.output
     assert 'composite-template.yaml.j2: ✔' in result.output
 
+
 def test_validate_with_values():
     runner = CliRunner()
 
     result = runner.invoke(root, ['validate', 'tests/resources/missing_values'])
-    assert result.exit_code # TODO: Should be 1
+    assert result.exit_code == 1
     assert 'template.yaml.j2: ✗' in result.output
     assert '- undefined variable: test' in result.output
 
@@ -302,6 +312,7 @@ def test_validate_with_values():
     assert result.exit_code == 0
     assert 'template.yaml.j2: ✔' in result.output
 
+
 def test_validate_failure():
     runner = CliRunner()
 
@@ -310,7 +321,7 @@ def test_validate_failure():
     # assert 'filter-template.yaml.j2: ✗' in result.output
     # assert 'nested-value-adding-template.yaml.j2: ✗' in result.output
     # assert 'nested-value-template.yaml.j2: ✗' in result.output
-    assert 'secret-template.yaml.j2: ✗' in result.output # TODO: Crushes, check file
+    assert 'secret-template.yaml.j2: ✗' in result.output
     assert 'several-template.yaml.j2: ✗' in result.output
     assert 'value-template.yaml.j2: ✗' in result.output
     assert 'composite-template.yaml.j2: ✗' in result.output

tests/config.py

@@ -7,4 +7,4 @@
 #
 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-from k8t import config
+from k8t import config  # pylint: disable=W0611

tests/engine.py

@@ -11,6 +11,6 @@
 # Copyright © 2020 Clark Germany GmbH
 # Author: Aljosha Friemann <[email protected]>
 
-from k8t.engine import build
+from k8t.engine import build  # pylint: disable=W0611
 
 # vim: fenc=utf-8:ts=4:sw=4:expandtab

tests/examples.py

@@ -6,9 +6,7 @@
 #
 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-import os
-
-from click.testing import CliRunner
+from click.testing import CliRunner # pylint: disable=E0401
 
 from k8t.cli import root
 

tests/filters.py

@@ -12,8 +12,8 @@
 # Author: Aljosha Friemann <[email protected]>
 
 import random
-import pytest
-from mock import patch
+import pytest  # pylint: disable=E0401
+from mock import patch  # pylint: disable=E0401
 
 from k8t import config, secret_providers
 from k8t.filters import b64decode, b64encode, hashf, random_password, to_bool, get_secret

tests/secret_providers.py

@@ -8,11 +8,11 @@
 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 import boto3
-import pytest
+import pytest  # pylint: disable=E0401
+from moto import mock_ssm  # pylint: disable=E0401
+
 from k8t import config
 from k8t.secret_providers import random, ssm
-from moto import mock_ssm
-
 
 def test_random():
     config.CONFIG = {"secrets": {"provider": "random"}}

tests/templates.py

@@ -11,6 +11,6 @@
 # Copyright © 2020 Clark Germany GmbH
 # Author: Aljosha Friemann <[email protected]>
 
-from k8t.templates import analyze
+from k8t.templates import analyze  # pylint: disable=W0611
 
 # vim: fenc=utf-8:ts=4:sw=4:expandtab

tests/util.py

@@ -7,8 +7,6 @@
 #
 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-import random
-
 from k8t.util import deep_merge, merge