switch to ruff for linting

Author: gruebel

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/publish.yml

@@ -26,14 +26,8 @@ jobs:
         run: |
           make install
 
-# TODO: fix all pylint issues first
-#      - name: Pylint
-#        run: |
-#          make lint
-
-      - name: Run pytest (unit tests) and bandit (security test)
+      - name: Run pytest (unit tests)
         run: |
-          make security-test
           make test
 
 

.github/workflows/test.yml

@@ -38,9 +38,8 @@ jobs:
         run: |
           make install
 
-      - name: Run pytest (unit tests) and bandit (security test)
+      - name: Run pytest (unit tests)
         run: |
-          make security-test
           make test
 
       - name: Run mypy (static type check)
@@ -71,6 +70,6 @@ jobs:
         run: |
           make install
 
-      - name: Run pytest (unit tests) and bandit (security test)
+      - name: Run pytest (unit tests)
         run: |
           make test

.pre-commit-config.yaml

@@ -6,4 +6,6 @@ repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.5.3
     hooks:
+      - id: ruff
+        files: ^(cloudsplaining/|setup.py)
       - id: ruff-format

Makefile

@@ -53,14 +53,6 @@ test: setup-dev
 	python3 -m coverage run -m pytest -v
 	python3 -m coverage report -m
 
-# Run python security tests
-security-test: setup-dev
-	bandit -r ./${PROJECT_UNDERSCORE}/
-
-# Run Pylint to lint your code
-lint: setup-dev
-	pylint ${PROJECT_UNDERSCORE}/
-
 type-check: setup-dev
 	mypy
 

cloudsplaining/__init__.py

@@ -3,13 +3,12 @@
 import sys
 
 # Set default logging handler to avoid "No handler found" warnings.
-from logging import NullHandler
-
+# from logging import NullHandler
 # logging.getLogger(__name__).addHandler(NullHandler())
 # Uncomment to get the full debug logs.
 # 2020-10-06 10:04:17,200 - root - DEBUG - Leveraging the bundled IAM Definition.
 # Need to figure out how to get click_log to do this for me.
-from typing import Union, Optional
+from typing import Optional, Union
 
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.WARNING)
@@ -71,10 +70,10 @@ def set_log_level(verbose: int) -> None:
     :return:
     """
     if verbose == 1:
-        set_stream_logger(level=getattr(logging, "WARNING"))
+        set_stream_logger(level=logging.WARNING)
     elif verbose == 2:
-        set_stream_logger(level=getattr(logging, "INFO"))
+        set_stream_logger(level=logging.INFO)
     elif verbose >= 3:
-        set_stream_logger(level=getattr(logging, "DEBUG"))
+        set_stream_logger(level=logging.DEBUG)
     else:
-        set_stream_logger(level=getattr(logging, "CRITICAL"))
+        set_stream_logger(level=logging.CRITICAL)

cloudsplaining/bin/cli.py

@@ -9,6 +9,7 @@
 """
 
 import click
+
 from cloudsplaining import command
 from cloudsplaining.bin.version import __version__
 

cloudsplaining/command/__init__.py

@@ -1,8 +1,11 @@
+# ruff: noqa: F401
 # pylint: disable=missing-module-docstring
-from cloudsplaining.command import create_exclusions_file
-from cloudsplaining.command import create_multi_account_config_file
-from cloudsplaining.command import expand_policy
-from cloudsplaining.command import download
-from cloudsplaining.command import scan
-from cloudsplaining.command import scan_multi_account
-from cloudsplaining.command import scan_policy_file
+from cloudsplaining.command import (
+    create_exclusions_file,
+    create_multi_account_config_file,
+    download,
+    expand_policy,
+    scan,
+    scan_multi_account,
+    scan_policy_file,
+)

cloudsplaining/command/create_exclusions_file.py

@@ -8,12 +8,14 @@
 # Licensed under the BSD 3-Clause license.
 # For full license text, see the LICENSE file in the repo root
 # or https://opensource.org/licenses/BSD-3-Clause
-import os
 import logging
+import os
+
 import click
-from cloudsplaining.shared.constants import EXCLUSIONS_TEMPLATE
+
 from cloudsplaining import set_log_level
 from cloudsplaining.shared import utils
+from cloudsplaining.shared.constants import EXCLUSIONS_TEMPLATE
 
 logger = logging.getLogger(__name__)
 
@@ -38,7 +40,7 @@ def create_exclusions_file(output_file: str, verbosity: int) -> None:
     """
     set_log_level(verbosity)
 
-    with open(output_file, "a") as file_obj:
+    with open(output_file, "a", encoding="utf-8") as file_obj:
         for line in EXCLUSIONS_TEMPLATE:
             file_obj.write(line)
     utils.print_green(f"Success! Exclusions template file written to: {output_file}")

cloudsplaining/command/create_multi_account_config_file.py

@@ -8,12 +8,14 @@
 # Licensed under the BSD 3-Clause license.
 # For full license text, see the LICENSE file in the repo root
 # or https://opensource.org/licenses/BSD-3-Clause
-import os
 import logging
+import os
+
 import click
-from cloudsplaining.shared.constants import MULTI_ACCOUNT_CONFIG_TEMPLATE
+
 from cloudsplaining import set_log_level
 from cloudsplaining.shared import utils
+from cloudsplaining.shared.constants import MULTI_ACCOUNT_CONFIG_TEMPLATE
 
 logger = logging.getLogger(__name__)
 OK_GREEN = "\033[92m"
@@ -44,7 +46,7 @@ def create_multi_account_config_file(output_file: str, verbosity: int) -> None:
         logger.debug("%s exists. Removing the file and replacing its contents.", output_file)
         os.remove(output_file)
 
-    with open(output_file, "a") as file_obj:
+    with open(output_file, "a", encoding="utf-8") as file_obj:
         for line in MULTI_ACCOUNT_CONFIG_TEMPLATE:
             file_obj.write(line)
     utils.print_green(f"Success! Multi-account config file written to: {os.path.relpath(output_file)}")

cloudsplaining/command/download.py

@@ -11,7 +11,7 @@
 import json
 import logging
 import os
-from typing import Dict, List, Any, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, Dict, List
 
 import boto3
 import click
@@ -68,7 +68,7 @@ def download(profile: str, output: str, include_non_default_policy_versions: boo
         output_filename = os.path.join(output, "default.json")
 
     results = get_account_authorization_details(session_data, include_non_default_policy_versions)
-    with open(output_filename, "w") as f:
+    with open(output_filename, "w", encoding="utf-8") as f:
         json.dump(results, f, indent=4, default=str)
     # output_filename.write_text(json.dumps(results, indent=4, default=str))
     print(f"Saved results to {output_filename}")

cloudsplaining/command/expand_policy.py

@@ -7,10 +7,12 @@
 # Licensed under the BSD 3-Clause license.
 # For full license text, see the LICENSE file in the repo rootgit pus
 # or https://opensource.org/licenses/BSD-3-Clause
-import logging
 import json
+import logging
+
 import click
 from policy_sentry.analysis.expand import get_expanded_policy
+
 from cloudsplaining import set_log_level
 
 logger = logging.getLogger(__name__)
@@ -31,7 +33,7 @@ def expand_policy(input_file: str, verbosity: int) -> None:
     """
     set_log_level(verbosity)
 
-    with open(input_file) as json_file:
+    with open(input_file, encoding="utf-8") as json_file:
         logger.debug(f"Opening {input_file}")
         data = json.load(json_file)
         policy = get_expanded_policy(data)