refactor: 💡 retire dotenv on esaclient

Author: scnsh

esa_client.py

@@ -1,23 +1,23 @@
 import logging
-import os
 
 import requests
-from dotenv import load_dotenv
 
-load_dotenv()
+# from dotenv import load_dotenv
+
+# load_dotenv()
 logger = logging.getLogger(__name__)
 
 
 class EsaClient:
-    def __init__(self):
-        self.token = os.getenv("ESA_TOKEN")
-        self.team_name = os.getenv("ESA_TEAM_NAME")
+    def __init__(self, token: str, team_name: str):
+        self.token = token
+        self.team_name = team_name
 
         if not self.token:
-            logger.error("Environment variable ESA_TOKEN is not set.")
+            logger.error("Token is required but was not provided.")
             raise ValueError("ESA_TOKEN is required")
         if not self.team_name:
-            logger.error("Environment variable ESA_TEAM_NAME is not set.")
+            logger.error("Team name is required but was not provided.")
             raise ValueError("ESA_TEAM_NAME is required")
 
         self.base_url = f"https://api.esa.io/v1/teams/{self.team_name}"
@@ -118,6 +118,9 @@ def delete_post(self, post_number: int):
 
 # Example usage (optional, for testing during development)
 if __name__ == "__main__":
+    from dotenv import load_dotenv
+
+    load_dotenv()
     logging.basicConfig(level=logging.INFO)
     try:
         client = EsaClient()

main.py

@@ -32,7 +32,7 @@
     esa_client = None
 else:
     try:
-        esa_client = EsaClient()
+        esa_client = EsaClient(token=esa_token, team_name=esa_team_name)
         logger.info("EsaClient initialized successfully.")
     except ValueError as e:  # Catch potential ValueError from EsaClient init
         logger.error(f"Failed to initialize EsaClient: {e}")

tests/integration/test_esa_client_integration.py

@@ -1,3 +1,4 @@
+import os
 import random
 import time
 
@@ -11,18 +12,32 @@
 load_dotenv()
 
 
+@pytest.fixture(scope="module")
+def integration_client():
+    token = os.getenv("ESA_TOKEN")
+    team_name = os.getenv("ESA_TEAM_NAME")
+    if not token or not team_name:
+        pytest.skip("ESA_TOKEN or ESA_TEAM_NAME not set for integration tests. Skipping integration tests.")
+    try:
+        client = EsaClient(token=token, team_name=team_name)
+        return client
+    except ValueError as e:
+        pytest.fail(f"Failed to initialize EsaClient for integration tests: {e}. Is .env configured correctly?")
+    except Exception as e:
+        pytest.fail(f"An unexpected error occurred during EsaClient initialization for integration tests: {e}")
+
+
 # Note: These tests require a valid .env file with ESA_TOKEN and ESA_TEAM_NAME
 # and will make actual API calls to esa.io.
 # They might be skipped by default unless explicitly run.
 
 
 @pytest.mark.integration
-def test_get_user_integration():
+def test_get_user_integration(integration_client):
     "Test get_user against the actual esa.io API."
+    client = integration_client
     try:
-        # Create a real client instance (loads .env)
-        client = EsaClient()
-        print(f"\nRunning integration test for team: {client.team_name}")
+        print(f"\nRunning get_user_integration test for team: {client.team_name}")
         user_data = client.get_user()
         print(f"Received user data: {user_data}")
 
@@ -32,19 +47,17 @@ def test_get_user_integration():
         assert "email" in user_data
         print("Integration test passed.")
 
-    except ValueError as e:
-        pytest.fail(f"Integration test setup failed: {e}. Is .env configured correctly?")
     except requests.exceptions.RequestException as e:
         pytest.fail(f"Integration test API call failed: {e}")
     except Exception as e:
         pytest.fail(f"Integration test unexpected error: {e}")
 
 
 @pytest.mark.integration
-def test_get_posts_integration():
+def test_get_posts_integration(integration_client):
     "Test get_posts against the actual esa.io API (no params)."
+    client = integration_client
     try:
-        client = EsaClient()
         print(f"\nRunning get_posts integration test for team: {client.team_name}")
         posts_data = client.get_posts()
         posts_list = posts_data.get("posts", [])
@@ -79,12 +92,12 @@ def test_get_posts_integration():
 
 
 @pytest.mark.integration
-def test_get_posts_pagination_integration():
+def test_get_posts_pagination_integration(integration_client):
     "Test get_posts pagination against the actual esa.io API."
+    client = integration_client
     test_page = 2
     test_per_page = 5
     try:
-        client = EsaClient()
         print(f"\nRunning get_posts pagination integration test (page={test_page}, per_page={test_per_page})")
         posts_data = client.get_posts(page=test_page, per_page=test_per_page)
         posts_list = posts_data.get("posts", [])
@@ -122,13 +135,13 @@ def test_get_posts_pagination_integration():
 
 
 @pytest.mark.integration
-def test_get_post_integration():
+def test_get_post_integration(integration_client):
     "Test get_post against the actual esa.io API (existing post)."
+    client = integration_client
     # Note: Assumes post number 1 exists in the test team.
     # Adjust post_number if necessary for your test environment.
     test_post_number = 1
     try:
-        client = EsaClient()
         print(f"\nRunning get_post integration test for post #{test_post_number}")
         post_data = client.get_post(post_number=test_post_number)
         print(f"Received post title: {post_data.get('name')}")
@@ -153,12 +166,12 @@ def test_get_post_integration():
 
 
 @pytest.mark.integration
-def test_get_post_not_found_integration():
+def test_get_post_not_found_integration(integration_client):
     "Test get_post against the actual esa.io API (non-existent post)."
+    client = integration_client
     # Use a post number that is guaranteed not to exist (e.g., 0 or a very large number)
     test_post_number = 0
     try:
-        client = EsaClient()
         print(f"\nRunning get_post integration test for non-existent post #{test_post_number}")
         with pytest.raises(requests.exceptions.HTTPError) as exc_info:
             client.get_post(post_number=test_post_number)
@@ -180,9 +193,9 @@ def test_get_post_not_found_integration():
 
 
 @pytest.mark.integration
-def test_create_post_integration():
+def test_create_post_integration(integration_client):
     """Test create_post and verify the created post."""
-    client = EsaClient()
+    client = integration_client
     unique_name = f"Test Post - {int(time.time())}"
     post_payload = {
         "name": unique_name,
@@ -240,9 +253,9 @@ def test_create_post_integration():
 
 
 @pytest.mark.integration
-def test_delete_post_integration():
+def test_delete_post_integration(integration_client):
     """Test create_post, then delete_post, and verify deletion."""
-    client = EsaClient()
+    client = integration_client
     unique_name = f"Test Post for Deletion - {int(time.time())}"
     post_payload = {
         "name": unique_name,
@@ -284,9 +297,9 @@ def test_delete_post_integration():
 
 
 @pytest.mark.integration
-def test_delete_post_non_existent_integration():
+def test_delete_post_non_existent_integration(integration_client):
     """Test delete_post with a non-existent post_number."""
-    client = EsaClient()
+    client = integration_client
     non_existent_post_number = 0
     with pytest.raises(requests.exceptions.HTTPError) as excinfo:
         client.delete_post(non_existent_post_number)
@@ -295,9 +308,9 @@ def test_delete_post_non_existent_integration():
 
 
 @pytest.mark.integration
-def test_update_post_integration():
+def test_update_post_integration(integration_client):
     """Test creating, updating, and verifying a post."""
-    client = EsaClient()
+    client = integration_client
     original_name = f"Original Post Title - {int(time.time())}"
     updated_name = f"Updated Post Title - {int(time.time())}"
     post_payload = {
@@ -354,9 +367,9 @@ def test_update_post_integration():
 
 
 @pytest.mark.integration
-def test_update_post_not_found_integration():
+def test_update_post_not_found_integration(integration_client):
     """Test updating a non-existent post."""
-    client = EsaClient()
+    client = integration_client
     non_existent_post_number = 0  # A post number that is guaranteed not to exist
     update_payload = {"name": "Attempt to update non-existent post", "body_md": "This should not succeed."}
 
@@ -368,9 +381,9 @@ def test_update_post_not_found_integration():
 
 
 @pytest.mark.integration
-def test_create_post_with_all_fields_integration():
+def test_create_post_with_all_fields_integration(integration_client):
     """Test create_post with all optional fields and verify them."""
-    client = EsaClient()
+    client = integration_client
     unique_suffix = int(time.time())
     post_name = f"Test All Fields - {unique_suffix}"
     post_body = f"Body for all fields test created at {unique_suffix}."

tests/test_esa_client.py

@@ -7,16 +7,9 @@
 
 
 @pytest.fixture
-def mock_env(monkeypatch):
-    "Set up environment variables for testing."
-    monkeypatch.setenv("ESA_TOKEN", "test_token")
-    monkeypatch.setenv("ESA_TEAM_NAME", "test_team")
-
-
-@pytest.fixture
-def client(mock_env):
-    "Return an instance of EsaClient with mocked env vars."
-    return EsaClient()
+def client():
+    "Return an instance of EsaClient with specified token and team_name."
+    return EsaClient(token="test_token", team_name="test_team")
 
 
 def test_esa_client_initialization(client):
@@ -27,20 +20,20 @@ def test_esa_client_initialization(client):
     assert client.session.headers["Authorization"] == f"Bearer {client.token}"
 
 
-def test_esa_client_initialization_missing_token(monkeypatch):
-    "Test ValueError is raised if ESA_TOKEN is missing."
-    monkeypatch.delenv("ESA_TOKEN", raising=False)  # Ensure it's removed if exists
-    monkeypatch.setenv("ESA_TEAM_NAME", "test_team")
+def test_esa_client_initialization_missing_token():
+    "Test ValueError is raised if token is missing or invalid."
     with pytest.raises(ValueError, match="ESA_TOKEN is required"):
-        EsaClient()
+        EsaClient(token=None, team_name="test_team")
+    with pytest.raises(ValueError, match="ESA_TOKEN is required"):
+        EsaClient(token="", team_name="test_team")
 
 
-def test_esa_client_initialization_missing_team_name(monkeypatch):
-    "Test ValueError is raised if ESA_TEAM_NAME is missing."
-    monkeypatch.setenv("ESA_TOKEN", "test_token")
-    monkeypatch.delenv("ESA_TEAM_NAME", raising=False)  # Ensure it's removed if exists
+def test_esa_client_initialization_missing_team_name():
+    "Test ValueError is raised if team_name is missing or invalid."
+    with pytest.raises(ValueError, match="ESA_TEAM_NAME is required"):
+        EsaClient(token="test_token", team_name=None)
     with pytest.raises(ValueError, match="ESA_TEAM_NAME is required"):
-        EsaClient()
+        EsaClient(token="test_token", team_name="")
 
 
 @patch("esa_client.requests.Session.request")