Merge pull request #224 from FullStackWithLawrence/next

refactor unit tests. add a teardown function

Author: lpm0073

.github/actions/tests/python/action.yml

@@ -11,22 +11,22 @@ inputs:
     description: "The version of Python to use, such as 3.11.0"
     required: true
     type: string
-openai-api-organization:
-  description: "The OpenAI API organization"
-  required: true
-  type: string
-openai-api-key:
-  description: "The OpenAI API key"
-  required: true
-  type: string
-pinecone-api-key:
-  description: "The Pinecone API key"
-  required: true
-  type: string
-pinecone-environment:
-  description: "The Pinecone environment"
-  required: true
-  type: string
+  openai-api-organization:
+    description: "The OpenAI API organization"
+    required: true
+    type: string
+  openai-api-key:
+    description: "The OpenAI API key"
+    required: true
+    type: string
+  pinecone-api-key:
+    description: "The Pinecone API key"
+    required: true
+    type: string
+  pinecone-environment:
+    description: "The Pinecone environment"
+    required: true
+    type: string
 
 runs:
   using: "composite"

.github/workflows/runTests.yml

@@ -24,6 +24,10 @@ jobs:
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           aws-region: ${{ secrets.AWS_REGION }}
 
+      - name: Get IAM user info
+        run: |
+          aws sts get-caller-identity
+
       - name: Run Python tests
         uses: ./.github/actions/tests/python
         with:

.github/workflows/testsPython.yml

@@ -6,6 +6,9 @@ on:
     paths:
       - "**.py"
   push:
+    branches:
+      - main
+      - next
     paths:
       - "**.py"
 
@@ -27,6 +30,10 @@ jobs:
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           aws-region: ${{ secrets.AWS_REGION }}
 
+      - name: Get IAM user info
+        run: |
+          aws sts get-caller-identity
+
       - name: Run Python tests
         uses: ./.github/actions/tests/python
         with:

api/terraform/python/openai_api/common/conf.py

@@ -216,7 +216,7 @@ class Settings(BaseSettings):
     _dump: dict = None
     _initialized: bool = False
 
-    # pylint: disable=too-many-branches
+    # pylint: disable=too-many-branches,too-many-statements
     def __init__(self, **data: Any):
         super().__init__(**data)
         if not Services.enabled(Services.AWS_CLI):
@@ -225,27 +225,45 @@ def __init__(self, **data: Any):
 
         if bool(os.environ.get("AWS_DEPLOYED", False)):
             # If we're running inside AWS Lambda, then we don't need to set the AWS credentials.
+            logger.info("running inside AWS Lambda")
             self._aws_access_key_id_source: str = "overridden by IAM role-based security"
             self._aws_secret_access_key_source: str = "overridden by IAM role-based security"
             self._aws_session = boto3.Session()
             self._initialized = True
 
         if not self.initialized and bool(os.environ.get("GITHUB_ACTIONS", False)):
+            console_handler = logging.StreamHandler()
+            console_handler.setLevel(logging.DEBUG)
+            logger.addHandler(console_handler)
+            logger.setLevel(logging.DEBUG)
+
+            logger.info("running inside GitHub Actions")
+            aws_access_key_id = os.environ.get("AWS_ACCESS_KEY_ID", None)
+            aws_secret_access_key = os.environ.get("AWS_SECRET_ACCESS_KEY", None)
+            if not aws_access_key_id or not aws_secret_access_key:
+                raise OpenAIAPIConfigurationError(
+                    "required environment variable(s) AWS_ACCESS_KEY_ID and/or AWS_SECRET_ACCESS_KEY not set"
+                )
+            self._aws_access_key_id_source = "environ"
+            self._aws_secret_access_key_source = "environ"
+            region_name = os.environ.get("AWS_REGION", None)
+            if not region_name:
+                raise OpenAIAPIConfigurationError("required environment variable AWS_REGION not set")
             try:
                 self._aws_session = boto3.Session(
-                    region_name=os.environ.get("AWS_REGION", "us-east-1"),
-                    aws_access_key_id=os.environ.get("AWS_ACCESS_KEY_ID", None),
-                    aws_secret_access_key=os.environ.get("AWS_SECRET_ACCESS_KEY", None),
+                    region_name=region_name,
+                    aws_access_key_id=aws_access_key_id,
+                    aws_secret_access_key=aws_secret_access_key,
                 )
+                self._initialized = True
+                self._aws_access_key_id_source = "environ"
+                self._aws_secret_access_key_source = "environ"
             except ProfileNotFound:
                 logger.warning("aws_profile %s not found", self.aws_profile)
 
-            if self.aws_profile:
+            if self.aws_profile and self._aws_access_key_id_source == "unset":
                 self._aws_access_key_id_source = "aws_profile"
                 self._aws_secret_access_key_source = "aws_profile"
-            else:
-                self._aws_access_key_id_source = "environ"
-                self._aws_secret_access_key_source = "environ"
             self._initialized = True
 
         if not self.initialized:
@@ -317,6 +335,10 @@ def __init__(self, **data: Any):
         SettingsDefaults.AWS_APIGATEWAY_ROOT_DOMAIN,
         env="AWS_APIGATEWAY_ROOT_DOMAIN",
     )
+    init_info: Optional[str] = Field(
+        None,
+        env="INIT_INFO",
+    )
     langchain_memory_key: Optional[str] = Field(SettingsDefaults.LANGCHAIN_MEMORY_KEY, env="LANGCHAIN_MEMORY_KEY")
     openai_api_organization: Optional[str] = Field(
         SettingsDefaults.OPENAI_API_ORGANIZATION, env="OPENAI_API_ORGANIZATION"
@@ -367,6 +389,7 @@ def aws_auth(self) -> dict:
             "aws_access_key_id_source": self.aws_access_key_id_source,
             "aws_secret_access_key_source": self.aws_secret_access_key_source,
             "aws_region": self.aws_region,
+            "init_info": self.init_info,
         }
 
     @property

api/terraform/python/openai_api/common/tests/test_configuration.py

@@ -27,7 +27,13 @@ class TestConfiguration(unittest.TestCase):
     here = os.path.dirname(os.path.abspath(__file__))
 
     def setUp(self):
-        """Set up test fixtures."""
+        # Save current environment variables
+        self.saved_env = dict(os.environ)
+
+    def tearDown(self):
+        # Restore environment variables
+        os.environ.clear()
+        os.environ.update(self.saved_env)
 
     def env_path(self, filename):
         """Return the path to the .env file."""
@@ -36,7 +42,7 @@ def env_path(self, filename):
     def test_conf_defaults(self):
         """Test that settings == SettingsDefaults when no .env is in use."""
         os.environ.clear()
-        mock_settings = Settings()
+        mock_settings = Settings(init_info="test_conf_defaults()")
 
         self.assertEqual(mock_settings.aws_region, SettingsDefaults.AWS_REGION)
         self.assertEqual(mock_settings.openai_endpoint_image_n, SettingsDefaults.OPENAI_ENDPOINT_IMAGE_N)
@@ -59,7 +65,7 @@ def test_conf_defaults(self):
     def test_conf_defaults_secrets(self):
         """Test that settings == SettingsDefaults when no .env is in use."""
         os.environ.clear()
-        mock_settings = Settings()
+        mock_settings = Settings(init_info="test_conf_defaults_secrets()")
 
         # pylint: disable=no-member
         self.assertEqual(mock_settings.openai_api_key.get_secret_value(), None)
@@ -74,7 +80,7 @@ def test_env_legal_nulls(self):
         loaded = load_dotenv(env_path)
         self.assertTrue(loaded)
 
-        mock_settings = Settings()
+        mock_settings = Settings(init_info="test_env_legal_nulls()")
 
         self.assertEqual(mock_settings.aws_region, SettingsDefaults.AWS_REGION)
         self.assertEqual(mock_settings.langchain_memory_key, SettingsDefaults.LANGCHAIN_MEMORY_KEY)
@@ -89,7 +95,7 @@ def test_env_illegal_nulls(self):
         self.assertTrue(loaded)
 
         with self.assertRaises(PydanticValidationError):
-            Settings()
+            Settings(init_info="test_env_illegal_nulls()")
 
     def test_env_overrides(self):
         """Test that settings takes custom .env values."""
@@ -98,7 +104,7 @@ def test_env_overrides(self):
         loaded = load_dotenv(env_path)
         self.assertTrue(loaded)
 
-        mock_settings = Settings()
+        mock_settings = Settings(init_info="test_env_overrides()")
 
         self.assertEqual(mock_settings.aws_region, "us-west-1")
         self.assertEqual(mock_settings.debug_mode, True)
@@ -111,14 +117,13 @@ def test_invalid_aws_region_code(self):
         """Test that Pydantic raises a validation error for environment variable with non-existent aws region code."""
 
         with self.assertRaises(Exception):
-            Settings()
+            Settings(init_info="test_invalid_aws_region_code()")
 
     def test_configure_with_class_constructor(self):
         """test that we can set values with the class constructor"""
 
         mock_settings = Settings(
-            aws_region="eu-west-1",
-            debug_mode=True,
+            aws_region="eu-west-1", debug_mode=True, init_info="test_configure_with_class_constructor()"
         )
 
         self.assertEqual(mock_settings.aws_region, "eu-west-1")
@@ -164,13 +169,13 @@ def test_readonly_settings(self):
     def test_dump(self):
         """Test that dump is a dict."""
 
-        mock_settings = Settings()
+        mock_settings = Settings(init_info="test_dump()")
         self.assertIsInstance(mock_settings.dump, dict)
 
     def test_dump_keys(self):
         """Test that dump contains the expected keys."""
 
-        mock_settings = Settings()
+        mock_settings = Settings(init_info="test_dump_keys()")
         environment = mock_settings.dump["environment"]
         self.assertIn("DEBUG_MODE".lower(), environment)
         self.assertIn("os", environment)
@@ -191,7 +196,7 @@ def test_dump_keys(self):
     def test_cloudwatch_values(self):
         """Test that dump contains the expected default values."""
 
-        mock_settings = Settings()
+        mock_settings = Settings(init_info="test_cloudwatch_values()")
         environment = mock_settings.dump["environment"]
         # aws_apigateway = mock_settings.dump["aws_apigateway"]
         openai_api = mock_settings.dump["openai_api"]
@@ -217,6 +222,7 @@ def test_initialize_with_values(self):
             openai_endpoint_image_size="TEST_image_size",
             pinecone_api_key="TEST_pinecone_api_key",
             shared_resource_identifier="TEST_shared_resource_identifier",
+            init_info="test_initialize_with_values()",
         )
         self.assertEqual(mock_settings.debug_mode, False)
         self.assertEqual(mock_settings.dump_defaults, False)