Refactor S3 Module (#5)

jibbs1703 · web-flow · commit dfaa4bbdc158 · 2025-08-25T19:41:10.000-04:00
* Code Changes: Refactored Cedential Retrieval

* refactored credentials and log modules

* refactored s3 tests

* added credentials tests, refactored test-lint.yaml

* refactored failing tests

* refactored failing tests
diff --git a/.github/workflows/test-lint.yaml b/.github/workflows/test-lint.yaml
@@ -24,10 +24,6 @@ jobs:
           python -m pip install --upgrade pip
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
 
-      - name: Set PYTHONPATH
-        run: |
-          echo "PYTHONPATH=$(pwd)/src/aws_resource_manager" >> $GITHUB_ENV
-
       - name: Lint Python scripts with Ruff
         run: |
           python -m ruff check src/ tests/
diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # AWS Resource Manager
 ![Python Version](https://img.shields.io/badge/python-3.10%20|%203.11%20|%203.12%20|%203.13-blue)
-![text_image_extractor](https://img.shields.io/badge/My%20Package-unreleased-yell)
+![aws_resource_manager](https://img.shields.io/badge/aws_resource_manager-unreleased-yellow)
 ![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)
 
 **AWS Resource Manager** is a Python package designed to simplify and automate the management of AWS
diff --git a/env.example b/env.example
@@ -1,3 +1,3 @@
-ACCESS_KEY='Insert Here'
-ACCESS_SECRET='Insert Here'
-REGION='Insert Here'
+AWS_ACCESS_KEY_ID="Add Access Key"
+AWS_SECRET_ACCESS_KEY="Add Secret Key"
+REGION="Add Region"
diff --git a/pyproject.toml b/pyproject.toml
@@ -16,8 +16,12 @@ classifiers = [
   "Development Status :: 2 - Pre-Alpha",
   "Intended Audience :: Developers",
   "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
 ]
+
 dependencies = [
     "boto3==1.36.11",
     "botocore==1.36.11",
diff --git a/pytest.ini b/pytest.ini
@@ -0,0 +1,4 @@
+[pytest]
+markers =
+    unit: marks test as unit tests
+    integration: marks tests as integration tests
diff --git a/ruff.toml b/ruff.toml
@@ -33,7 +33,7 @@ ignore = [
     "N806", # Variable name should be lowercase
     "N803", # Argument name should be lowercase
     "S101", # Use of assert detected 
-
+    "S106", # Possible hardcoded password
 ]
 
 exclude = [
diff --git a/src/aws_resource_manager/credentials.py b/src/aws_resource_manager/credentials.py
@@ -0,0 +1,37 @@
+"""Credentials Module for AWS Resource Manager"""
+
+import os
+
+from dotenv import load_dotenv
+
+
+def get_credentials():
+        """
+        Retrieves AWS credentials from a hidden environment file.
+
+        This class method accesses the user's AWS secret and access
+        keys stored in an environment file. If a region is specified,
+        the methods within the S3Handler class will execute in that region.
+        Otherwise, AWS will assign a default region.
+
+        :return: An instance of the S3Handler class initialized with
+        the user's credentials and specified region
+        """
+        aws_access_key_id = os.getenv("AWS_ACCESS_KEY_ID")
+        aws_secret_access_key = os.getenv("AWS_SECRET_ACCESS_KEY")
+        region = os.getenv("REGION")
+
+        if not all([aws_access_key_id, aws_secret_access_key, region]):
+            load_dotenv()
+            aws_access_key_id = os.getenv("AWS_ACCESS_KEY_ID")
+            aws_secret_access_key = os.getenv("AWS_SECRET_ACCESS_KEY")
+            region = os.getenv("REGION")
+
+        if not all([aws_access_key_id, aws_secret_access_key, region]):
+            raise ValueError("All credentials not found in environment variables.")
+
+        return aws_access_key_id, aws_secret_access_key, region
+
+
+if __name__ == "__main__":
+    get_credentials()
diff --git a/src/aws_resource_manager/ec2.py b/src/aws_resource_manager/ec2.py
@@ -4,9 +4,10 @@
 import boto3
 from botocore.exceptions import ClientError
 from dotenv import load_dotenv
-from logger import configure_logger
 
-logger = configure_logger()
+from aws_resource_manager.logs import get_logger
+
+logger = get_logger()
 
 
 class EC2Handler:
diff --git a/src/aws_resource_manager/logs.py b/src/aws_resource_manager/logs.py
@@ -3,28 +3,22 @@
 import logging
 
 
-def configure_logger():
-    # Create a logger
-    configured_logger = logging.getLogger(__name__)  # Or a specific name
-    configured_logger.setLevel(logging.DEBUG)  # Set the minimum level to log
+def get_logger():
+    configured_logger = logging.getLogger(__name__)
+    configured_logger.setLevel(logging.DEBUG) 
 
-    # Create a handler for console output (stderr by default)
     handler = logging.StreamHandler()
 
-    # Create a formatter
     formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
     handler.setFormatter(formatter)
 
-    # Add the handler to the logger
     configured_logger.addHandler(handler)
 
     return configured_logger
 
 
 if __name__ == "__main__":
-    # Create Console Logger from Function
-    logger = configure_logger()
-    # Print Dummy Messages
+    logger = get_logger()
     logger.debug("This is a debug message.")
     logger.info("This is an info message.")
     logger.warning("This is a warning message.")
diff --git a/src/aws_resource_manager/redshift.py b/src/aws_resource_manager/redshift.py
@@ -3,9 +3,10 @@
 import boto3
 from botocore.exceptions import ClientError
 from dotenv import load_dotenv
-from logger import configure_logger
 
-logger = configure_logger()
+from aws_resource_manager.logs import get_logger
+
+logger = get_logger()
 
 
 class RedshiftHandler:
diff --git a/src/aws_resource_manager/s3.py b/src/aws_resource_manager/s3.py
@@ -1,38 +1,18 @@
 """Module for managing AWS S3 resources."""
 import io
-import os
-from io import StringIO
 
 import boto3
 from botocore.exceptions import ClientError
-from dotenv import load_dotenv
-from logger import configure_logger
 
-logger = configure_logger()
+from src.aws_resource_manager.credentials import get_credentials
+from src.aws_resource_manager.logs import get_logger
 
+logger = get_logger()
 
-class S3Handler:
-    @classmethod
-    def credentials(cls) -> "S3Handler":
-        """
-        Retrieves AWS credentials from a hidden environment file.
 
-        This class method accesses the user's AWS secret and access
-        keys stored in an environment file. If a region is specified,
-        the methods within the S3Handler class will execute in that region.
-        Otherwise, AWS will assign a default region.
-
-        :return: An instance of the S3Handler class initialized with
-        the user's credentials and specified region
-        """
-        load_dotenv()
-        secret = os.getenv("ACCESS_SECRET")
-        access = os.getenv("ACCESS_KEY")
-        region = os.getenv("REGION")
-
-        return cls(secret, access, region)
-
-    def __init__(self, secret, access, region) -> None:
+class S3Handler:
+    """Class to Handle S3 operations."""
+    def __init__(self) -> None:
         """
         Initializes the S3Handler class with user credentials and creates
         the AWS S3 client.
@@ -49,18 +29,21 @@ def __init__(self, secret, access, region) -> None:
 
         Returns: None
         """
+        aws_access_key_id, aws_secret_access_key, region = get_credentials()
         if region is None:
-            self.client = boto3.client("s3", aws_access_key_id=access, aws_secret_access_key=secret)
+            self.client = boto3.client("s3",
+                                       aws_access_key_id=aws_access_key_id,
+                                       aws_secret_access_key=aws_secret_access_key)
         else:
             self.location = {"LocationConstraint": region}
             self.client = boto3.client(
                 "s3",
-                aws_access_key_id=access,
-                aws_secret_access_key=secret,
+                aws_access_key_id=aws_access_key_id,
+                aws_secret_access_key=aws_secret_access_key,
                 region_name=region,
             )
 
-    def list_buckets(self) -> list:
+    def list_buckets(self) -> list | None:
         """
         Retrieves and returns a list of bucket names available in the user's
         AWS account.
@@ -288,7 +271,7 @@ def read_file(self, bucket_name: str, object_name: str):
                 return "File not in bucket"
 
             response = self.client.get_object(Bucket=bucket_name, Key=object_name)
-            file_content = StringIO(response["Body"].read().decode("utf-8"))
+            file_content = io.StringIO(response["Body"].read().decode("utf-8"))
             logger.info(f"File '{object_name}' read successfully from bucket '{bucket_name}'.")
             return file_content
 
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,12 +1,33 @@
-"""This module contains default fixtures for the aws_resource_manager package tests."""
+"""This module contains default fixtures for tests."""
 
 import warnings
+from unittest.mock import MagicMock, patch
 
 import pytest
 
+from src.aws_resource_manager.s3 import S3Handler
+
 
 @pytest.fixture(autouse=True)
 def silence_specific_deprecation_warnings():
     with warnings.catch_warnings():
         warnings.filterwarnings("ignore", "datetime.datetime.utcnow.*", DeprecationWarning)
         yield
+
+
+@pytest.fixture
+def env_vars(monkeypatch):
+    monkeypatch.setenv("AWS_ACCESS_KEY_ID", "test_access_key")
+    monkeypatch.setenv("AWS_SECRET_ACCESS_KEY", "test_secret_key")
+    monkeypatch.setenv("REGION", "test_region")
+    yield
+
+
+@pytest.fixture
+def s3handler_mock(env_vars):
+    with patch("src.aws_resource_manager.s3.boto3.client") as mock_client:
+        mock_instance = MagicMock()
+        mock_client.return_value = mock_instance
+        handler = S3Handler()
+        handler.client = mock_instance
+        yield handler
diff --git a/tests/test_credentials.py b/tests/test_credentials.py
@@ -0,0 +1,40 @@
+"""Tests for the Credentials Module of the AWS Resource Manager Package."""
+
+from unittest import mock
+
+import pytest
+
+from src.aws_resource_manager.credentials import get_credentials
+
+
+@pytest.mark.unit
+def test_get_credentials_from_env(monkeypatch):
+    monkeypatch.setenv("AWS_ACCESS_KEY_ID", "test_access_key")
+    monkeypatch.setenv("AWS_SECRET_ACCESS_KEY", "test_secret_key")
+    monkeypatch.setenv("REGION", "us-east-2")
+    creds = get_credentials()
+    assert creds == ("test_access_key", "test_secret_key", "us-east-2")
+
+
+@pytest.mark.unit
+def test_get_credentials_load_dotenv(monkeypatch):
+    # Unset env vars to force load_dotenv
+    monkeypatch.delenv("AWS_ACCESS_KEY_ID", raising=False)
+    monkeypatch.delenv("AWS_SECRET_ACCESS_KEY", raising=False)
+    monkeypatch.delenv("REGION", raising=False)
+
+    with mock.patch("os.getenv", side_effect=["dotenv_access", "dotenv_secret", "dotenv_region"]):
+        creds = get_credentials()
+        assert creds == ("dotenv_access", "dotenv_secret", "dotenv_region")
+
+
+@pytest.mark.unit
+def test_get_credentials_missing(monkeypatch):
+    monkeypatch.delenv("AWS_ACCESS_KEY_ID", raising=False)
+    monkeypatch.delenv("AWS_SECRET_ACCESS_KEY", raising=False)
+    monkeypatch.delenv("REGION", raising=False)
+
+    with mock.patch("src.aws_resource_manager.credentials.load_dotenv"), \
+         mock.patch("os.getenv", side_effect=[None, None, None, None, None, None]):
+        with pytest.raises(ValueError, match="All credentials not found in environment variables."):
+            get_credentials()
diff --git a/tests/test_s3.py b/tests/test_s3.py

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ ignore = [`
`33`	`33`	`"N806", # Variable name should be lowercase`
`34`	`34`	`"N803", # Argument name should be lowercase`
`35`	`35`	`"S101", # Use of assert detected`
`36`		`-`
	`36`	`+ "S106", # Possible hardcoded password`
`37`	`37`	`]`
`38`	`38`
`39`	`39`	`exclude = [`