Merge pull request #2 from Jmateusribeiro/github-action-pylint

Update pylint.yml

.github/workflows/pylint.yml

@@ -18,6 +18,6 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install pylint
-    - name: Analysing the code with pylint
+    - name: Analyzing the code with pylint
       run: |
-        pylint $(git ls-files '*.py')
+        pylint **/*.py

tests/step_defs/conftest.py

@@ -1,7 +1,7 @@
 import pytest
 from utilities.classes.sqs_client import SQSClient
 from utilities.classes.log import CustomLogger
-from utilities.settings import queue_name, sqs_bucket, report_dir
+from utilities.settings import QUEUE_NAME, SQS_BUCKET, REPORT_DIR
 from utilities import os_funcs as cmd
 from moto import mock_aws
 
@@ -41,7 +41,7 @@ def log() -> CustomLogger:
     Returns:
         CustomLogger: A CustomLogger instance.
     """
-    return CustomLogger(report_dir)
+    return CustomLogger(REPORT_DIR)
 
 @pytest.fixture(autouse=True, scope='module')
 def setup(request: 'pytest.FixtureRequest', mock_aws_flag: bool, log: CustomLogger) -> None:
@@ -89,8 +89,8 @@ def sqs_cli(mock_aws_flag: bool, log: CustomLogger) -> SQSClient:
     Returns:
         SQSClient: An SQSClient instance.
     """
-    sqs_cli = SQSClient(log=log, bucket=sqs_bucket, mock_aws_flag=mock_aws_flag)
-    sqs_cli.create_queue(queue_name)
-    sqs_cli.get_queue_url(queue_name)
+    sqs_cli = SQSClient(log=log, bucket=SQS_BUCKET, mock_aws_flag=mock_aws_flag)
+    sqs_cli.create_queue(QUEUE_NAME)
+    sqs_cli.get_queue_url(QUEUE_NAME)
 
     return sqs_cli

tests/step_defs/test_messages_steps.py

@@ -1,6 +1,6 @@
 from pytest_bdd import scenarios, given, when, then
 import json
-from utilities.settings import project_dir
+from utilities.settings import PROJECT_DIR
 
 # Load feature files for pytest-bdd
 scenarios('../features/cars_stream_processing.feature')
@@ -19,7 +19,7 @@ def added_cars(sqs_cli: 'SQSClient', log: 'CustomLogger') -> list:
         list: List of cars added to the queue.
     """
     log.info("########   Start Step: 'Given a list of cars are added to car queue'   ########")
-    f = open(project_dir + "\\test-data\\cars.json", "r")
+    f = open(PROJECT_DIR + "\\test-data\\cars.json", "r")
     cars = json.loads(f.read())
 
     for car in cars:

utilities/classes/sqs_client.py

@@ -1,19 +1,19 @@
 import boto3
 from botocore.exceptions import ClientError
 import json
-from utilities.settings import localhost, region_name
+from utilities.settings import LOCALHOST, REGION_NAME
 
 class SQSClient:
-    def __init__(self, log: 'CustomLogger', bucket: str, mock_aws_flag: bool, host: str = localhost, region_name: str = region_name):
+    def __init__(self, log: 'CustomLogger', bucket: str, mock_aws_flag: bool, host: str = LOCALHOST, region_name: str = REGION_NAME):
         """
         Initialize SQSClient.
 
         Args:
             log (CustomLogger): Logger object.
             bucket (str): Name of the AWS bucket.
             mock_aws_flag (bool): Flag indicating whether to mock AWS or not.
-            host (str, optional): Host URL. Defaults to localhost.
-            region_name (str, optional): AWS region name. Defaults to region_name.
+            host (str, optional): Host URL. Defaults to LOCALHOST.
+            region_name (str, optional): AWS region name. Defaults to REGION_NAME.
         """
         self.log = log
         self.bucket_name = bucket

utilities/os_funcs.py

@@ -1,3 +1,6 @@
+"""
+    LocalStack Commandline Functions Module
+"""
 import os
 
 def start_localstack() -> None:
@@ -11,4 +14,4 @@ def stop_localstack() -> None:
     """
     Stop local stack on command line.
     """
-    os.system('localstack stop')
+    os.system('localstack stop')

utilities/settings.py

@@ -1,8 +1,11 @@
+"""
+    Project Settings
+"""
 import os
 
-project_dir = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
-report_dir  = project_dir + "//reports"
-queue_name  = "cars"
-localhost   = "http://localhost:4566"
-sqs_bucket  = "sqs"
-region_name = "eu-west-2"
+PROJECT_DIR = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
+REPORT_DIR  = PROJECT_DIR + "//reports"
+QUEUE_NAME  = "cars"
+LOCALHOST   = "http://localhost:4566"
+SQS_BUCKET  = "sqs"
+REGION_NAME = "eu-west-2"