feature: add ruff support instead of flake8, yapf and isort (#756)

Co-authored-by: Ran Isenberg <[email protected]>

Author: ran-isenberg

.flake8

@@ -24,3 +24,11 @@ repos:
         name: Tests should begin with test_
         args: ["--django"]
         exclude: "^(?!helpers/)"
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.1.2
+    hooks:
+      # Run the Ruff linter.
+      - id: ruff
+      # Run the Ruff formatter.
+      - id: ruff-format

.pre-commit-config.yaml

@@ -10,17 +10,13 @@ dev:
 	poetry install
 	npm ci
 
-format-fix:
-	poetry run isort .
-	poetry run yapf -vv --style=./.style -r --in-place .
-
 format:
-	poetry run isort .
-	poetry run yapf -d -vv --style=./.style -r .
+	poetry run ruff check .
+
+format-fix:
+	poetry run ruff format .
 
 lint: format
-	@echo "Running flake8"
-	poetry run flake8 service/* cdk/* tests/*
 	@echo "Running mypy"
 	$(MAKE) mypy-lint
 

.style

@@ -8,12 +8,12 @@ dev:
 	npm ci
 
 format:
-	poetry run isort .
-	poetry run yapf -d -vv --style=.\.style -r .
+	poetry run ruff check .
+
+format-fix:
+	poetry run ruff format .
 
 lint: format
-	@echo "Running flake8"
-	poetry run flake8 service.\* cdk\* tests\* docs\examples\*
 	@echo "Running mypy"
 	$(MAKE) mypy-lint
 

Makefile

@@ -12,7 +12,6 @@
 
 
 class ApiConstruct(Construct):
-
     def __init__(self, scope: Construct, id_: str, appconfig_app_name: str) -> None:
         super().__init__(scope, id_)
         self.id_ = id_
@@ -21,8 +20,9 @@ def __init__(self, scope: Construct, id_: str, appconfig_app_name: str) -> None:
         self.common_layer = self._build_common_layer()
         self.rest_api = self._build_api_gw()
         api_resource: aws_apigateway.Resource = self.rest_api.root.add_resource('api').add_resource(constants.GW_RESOURCE)
-        self.create_order_func = self._add_post_lambda_integration(api_resource, self.lambda_role, self.api_db.db, appconfig_app_name,
-                                                                   self.api_db.idempotency_db)
+        self.create_order_func = self._add_post_lambda_integration(
+            api_resource, self.lambda_role, self.api_db.db, appconfig_app_name, self.api_db.idempotency_db
+        )
         self.monitoring = CrudMonitoring(self, id_, self.rest_api, self.api_db.db, self.api_db.idempotency_db, [self.create_order_func])
 
     def _build_api_gw(self) -> aws_apigateway.RestApi:
@@ -44,30 +44,33 @@ def _build_lambda_role(self, db: dynamodb.Table, idempotency_table: dynamodb.Tab
             constants.SERVICE_ROLE_ARN,
             assumed_by=iam.ServicePrincipal('lambda.amazonaws.com'),
             inline_policies={
-                'dynamic_configuration':
-                    iam.PolicyDocument(statements=[
+                'dynamic_configuration': iam.PolicyDocument(
+                    statements=[
                         iam.PolicyStatement(
                             actions=['appconfig:GetLatestConfiguration', 'appconfig:StartConfigurationSession'],
                             resources=['*'],
                             effect=iam.Effect.ALLOW,
                         )
-                    ]),
-                'dynamodb_db':
-                    iam.PolicyDocument(statements=[
+                    ]
+                ),
+                'dynamodb_db': iam.PolicyDocument(
+                    statements=[
                         iam.PolicyStatement(
                             actions=['dynamodb:PutItem', 'dynamodb:GetItem'],
                             resources=[db.table_arn],
                             effect=iam.Effect.ALLOW,
                         )
-                    ]),
-                'idempotency_table':
-                    iam.PolicyDocument(statements=[
+                    ]
+                ),
+                'idempotency_table': iam.PolicyDocument(
+                    statements=[
                         iam.PolicyStatement(
                             actions=['dynamodb:PutItem', 'dynamodb:GetItem', 'dynamodb:UpdateItem', 'dynamodb:DeleteItem'],
                             resources=[idempotency_table.table_arn],
                             effect=iam.Effect.ALLOW,
                         )
-                    ]),
+                    ]
+                ),
             },
             managed_policies=[
                 iam.ManagedPolicy.from_aws_managed_policy_name(managed_policy_name=(f'service-role/{constants.LAMBDA_BASIC_EXECUTION_ROLE}'))
@@ -83,8 +86,9 @@ def _build_common_layer(self) -> PythonLayerVersion:
             removal_policy=RemovalPolicy.DESTROY,
         )
 
-    def _add_post_lambda_integration(self, api_name: aws_apigateway.Resource, role: iam.Role, db: dynamodb.Table, appconfig_app_name: str,
-                                     idempotency_table: dynamodb.Table) -> _lambda.Function:
+    def _add_post_lambda_integration(
+        self, api_name: aws_apigateway.Resource, role: iam.Role, db: dynamodb.Table, appconfig_app_name: str, idempotency_table: dynamodb.Table
+    ) -> _lambda.Function:
         lambda_function = _lambda.Function(
             self,
             constants.CREATE_LAMBDA,

Makefile_windows

@@ -6,7 +6,6 @@
 
 
 class ApiDbConstruct(Construct):
-
     def __init__(self, scope: Construct, id_: str) -> None:
         super().__init__(scope, id_)
 
@@ -25,8 +24,9 @@ def _build_idempotency_table(self, id_: str) -> dynamodb.Table:
             time_to_live_attribute='expiration',
             point_in_time_recovery=True,
         )
-        CfnOutput(self, id=constants.IDEMPOTENCY_TABLE_NAME_OUTPUT,
-                  value=table.table_name).override_logical_id(constants.IDEMPOTENCY_TABLE_NAME_OUTPUT)
+        CfnOutput(self, id=constants.IDEMPOTENCY_TABLE_NAME_OUTPUT, value=table.table_name).override_logical_id(
+            constants.IDEMPOTENCY_TABLE_NAME_OUTPUT
+        )
         return table
 
     def _build_db(self, id_prefix: str) -> dynamodb.Table:

cdk/service/api_construct.py

@@ -8,7 +8,6 @@
 
 
 class ConfigurationStore(Construct):
-
     def __init__(self, scope: Construct, id_: str, environment: str, service_name: str, configuration_name: str) -> None:
         """
         This construct should be deployed in a different repo and have its own pipeline so updates can be decoupled from

cdk/service/api_db_construct.py

@@ -13,5 +13,5 @@ def validate_features(cls, value):
         try:
             validator.validate()
         except Exception as exc:
-            raise ValueError(str(exc))
+            raise ValueError(str(exc)) from exc
         return value

cdk/service/configuration/configuration_construct.py

@@ -19,7 +19,6 @@
 
 
 class CrudMonitoring(Construct):
-
     def __init__(
         self,
         scope: Construct,
@@ -40,7 +39,7 @@ def _build_topic(self) -> sns.Topic:
             self,
             'MonitoringKey',
             description='KMS Key for SNS Topic Encryption',
-            enable_key_rotation=True  # Enables automatic key rotation
+            enable_key_rotation=True,  # Enables automatic key rotation
         )
         topic = sns.Topic(self, f'{self.id_}alarms', display_name=f'{self.id_}alarms', master_key=key)
         # Grant CloudWatch permissions to publish to the SNS topic
@@ -50,7 +49,8 @@ def _build_topic(self) -> sns.Topic:
                 effect=iam.Effect.ALLOW,
                 principals=[iam.ServicePrincipal('cloudwatch.amazonaws.com')],
                 resources=[topic.topic_arn],
-            ))
+            )
+        )
         CfnOutput(self, id=constants.MONITORING_TOPIC, value=topic.topic_name).override_logical_id(constants.MONITORING_TOPIC)
         return topic