Remove environment variable for unit tests. (#164)

qiuosier · web-flow · commit a34675edfee7 · 2023-05-02T15:35:06.000-04:00
Tests will setup environment variables if needed.
diff --git a/.github/workflows/run-unittests-default_setup.yml b/.github/workflows/run-unittests-default_setup.yml
@@ -4,12 +4,14 @@ on:
   pull_request:
     branches:
       - main
-      - 'release/**'
+      - "release/**"
       - develop
     paths:
-      - 'ads/**'
+      - "ads/**"
       - setup.py
-      - '**requirements.txt'
+      - "**requirements.txt"
+      - .github/workflows/run-unittests.yml
+      - .github/workflows/run-unittests-default_setup.yml
 
 # Cancel in progress workflows on pull_requests.
 # https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value
@@ -74,7 +76,6 @@ jobs:
         timeout-minutes: 15
         shell: bash
         env:
-          NB_SESSION_COMPARTMENT_OCID: ocid1.compartment.oc1.<unique_ocid>
           NoDependency: True
         run: |
           set -x # print commands that are executed
diff --git a/.github/workflows/run-unittests.yml b/.github/workflows/run-unittests.yml
@@ -4,12 +4,14 @@ on:
   pull_request:
     branches:
       - main
-      - 'release/**'
+      - "release/**"
       - develop
     paths:
-      - 'ads/**'
+      - "ads/**"
       - setup.py
-      - '**requirements.txt'
+      - "**requirements.txt"
+      - .github/workflows/run-unittests.yml
+      - .github/workflows/run-unittests-default_setup.yml
 
 # Cancel in progress workflows on pull_requests.
 # https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value
@@ -85,22 +87,21 @@ jobs:
         shell: bash
         run: |
           set -x # print commands that are executed
-          
+
           sudo apt-get install libkrb5-dev graphviz
           $CONDA/bin/conda init
           source /home/runner/.bashrc
-          
+
           pip install -r dev-requirements.txt
 
       - name: "Run unitary tests folder with maximum ADS dependencies"
         timeout-minutes: 60
         shell: bash
         env:
-          NB_SESSION_COMPARTMENT_OCID: ocid1.compartment.oc1.<unique_ocid>
           CONDA_PREFIX: /usr/share/miniconda
         run: |
           set -x # print commands that are executed
-          
+
           # Setup project and tests folder for cov reports to not be overwritten by another parallel step
           if [[ ! -z "${{ matrix.cov-reports }}" ]]; then
             mkdir -p cov-${{ matrix.name }}
@@ -109,7 +110,7 @@ jobs:
             ln -s ../ads ads
             ln -s ../.coveragerc .coveragerc
           fi
-          
+
           # Run tests
           python -m pytest -v -p no:warnings --durations=5 \
           -n auto --dist loadfile ${{ matrix.cov-reports }} \
@@ -145,18 +146,18 @@ jobs:
       - name: "Calculate overall coverage"
         run: |
           set -x # print commands that are executed
-          
+
           # Prepare default cov body text 
           COV_BODY_INTRO="📌 Overall coverage:\n\n"
           echo COV_BODY="$COV_BODY_INTRO No success to gather report. 😿" >> $GITHUB_ENV
-          
+
           # Combine coverage files
           pip install coverage
           coverage combine cov-reports-unitary/.coverage cov-reports-model/.coverage
-          
+
           # Make html report
           coverage html
-          
+
           # Calculate overall coverage and update body message
           COV=$(grep -E 'pc_cov' htmlcov/index.html | cut -d'>' -f 2 | cut -d'%' -f 1)
           if [[ ! -z $COV ]]; then 
@@ -168,18 +169,18 @@ jobs:
         if: always()
         run: |
           set -x # print commands that are executed
-          
+
           # Prepare default diff body text 
           DIFF_BODY_INTRO="📌 Cov diff with **${{ env.COMPARE_BRANCH }}**:\n\n"
           echo DIFF_BODY="$DIFF_BODY_INTRO No success to gather report. 😿" >> $GITHUB_ENV
-          
+
           # Prepare file paths to coverage xml files
           # Filenames taken from job.test last step with name - "Save coverage files"
           FILE1="cov-reports-unitary/coverage.xml"; [[ ! -f $FILE1 ]] && FILE1="" 
           FILE2="cov-reports-model/coverage.xml"; [[ ! -f $FILE2 ]] && FILE2=""
           echo "FILE1=$FILE1" >> $GITHUB_ENV
           echo "FILE2=$FILE2" >> $GITHUB_ENV
-          
+
           # Calculate coverage diff and update body message
           pip install diff_cover
           diff-cover $FILE1 $FILE2 --compare-branch=origin/${{ env.COMPARE_BRANCH }} 
diff --git a/tests/unitary/default_setup/auth/test_auth.py b/tests/unitary/default_setup/auth/test_auth.py
@@ -80,8 +80,8 @@ def test_get_signer_with_api_keys(
         mock_rp_signer.assert_called_once()
 
     @mock.patch("oci.auth.signers.get_resource_principals_signer")
+    @mock.patch.dict(os.environ, {"OCI_RESOURCE_PRINCIPAL_VERSION": "2.2"})
     def test_resource_principal(self, mock_rp_signer):
-        os.environ["OCI_RESOURCE_PRINCIPAL_VERSION"] = "2.2"
         resource_principal()
         mock_rp_signer.assert_called_once()
 
@@ -264,11 +264,11 @@ def test_api_key_create_signer(
         assert "test" in signer["client_kwargs"]
 
     @mock.patch("oci.auth.signers.get_resource_principals_signer")
+    @mock.patch.dict(os.environ, {"OCI_RESOURCE_PRINCIPAL_VERSION": "2.2"})
     def test_resource_principal_create_signer(self, mock_rp_signer):
         """
         Testing resource principal setup with set_auth() and getting it with default_signer()
         """
-        os.environ["OCI_RESOURCE_PRINCIPAL_VERSION"] = "2.2"
         set_auth(AuthType.RESOURCE_PRINCIPAL)
         signer = default_signer(client_kwargs={"test": "test"})
         assert "additional_user_agent" in signer["config"]
diff --git a/tests/unitary/default_setup/catalog/test_catalog_notebook.py b/tests/unitary/default_setup/catalog/test_catalog_notebook.py
@@ -3,20 +3,25 @@
 # Copyright (c) 2021, 2023 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
-from ads.catalog.notebook import NotebookCatalog, NotebookSummaryList
-from ads.common import auth, oci_client
-from ads.common.utils import random_valid_ocid
-from ads.config import NB_SESSION_COMPARTMENT_OCID, PROJECT_OCID
+import os
+import unittest
 from collections import namedtuple
 from datetime import datetime, timezone, timedelta
-from oci.exceptions import ServiceError
+from importlib import reload
 from unittest import mock
 from unittest.mock import MagicMock, Mock, patch
+
 import oci
-import os
 import pandas as pd
 import pytest
-import unittest
+from oci.exceptions import ServiceError
+
+import ads.config
+import ads.catalog.notebook
+from ads.catalog.notebook import NotebookCatalog, NotebookSummaryList
+from ads.common import auth, oci_client
+from ads.common.utils import random_valid_ocid
+from ads.config import PROJECT_OCID
 
 
 def generate_notebook_list(
@@ -64,33 +69,57 @@ def generate_notebook_list(
 class NotebookCatalogTest(unittest.TestCase):
     """Contains test cases for catalog.notebook"""
 
-    with patch.object(auth, "default_signer"):
-        with patch.object(oci_client, "OCIClientFactory"):
-            notebook_catalog = NotebookCatalog()
-            notebook_catalog.ds_client = MagicMock()
-            notebook_catalog.identity_client = MagicMock()
+    @classmethod
+    def setUpClass(cls) -> None:
+        os.environ[
+            "NB_SESSION_COMPARTMENT_OCID"
+        ] = "ocid1.compartment.oc1.<unique_ocid>"
+        reload(ads.config)
+        ads.catalog.notebook.NB_SESSION_COMPARTMENT_OCID = (
+            ads.config.NB_SESSION_COMPARTMENT_OCID
+        )
+        # Initialize class properties after reloading
+        with patch.object(auth, "default_signer"):
+            with patch.object(oci_client, "OCIClientFactory"):
+                cls.notebook_id = "ocid1.notebookcatalog.oc1.iad.<unique_ocid>"
+                cls.comp_id = os.environ.get(
+                    "NB_SESSION_COMPARTMENT_OCID",
+                    "ocid1.compartment.oc1.iad.<unique_ocid>",
+                )
+                cls.date_time = datetime(
+                    2020, 7, 1, 18, 24, 42, 110000, tzinfo=timezone.utc
+                )
+
+                cls.notebook_catalog = NotebookCatalog(compartment_id=cls.comp_id)
+                cls.notebook_catalog.ds_client = MagicMock()
+                cls.notebook_catalog.identity_client = MagicMock()
 
-            notebook_id = "ocid1.notebookcatalog.oc1.iad.<unique_ocid>"
-            comp_id = os.environ.get("NB_SESSION_COMPARTMENT_OCID")
-            date_time = datetime(2020, 7, 1, 18, 24, 42, 110000, tzinfo=timezone.utc)
+                cls.nsl = NotebookSummaryList(generate_notebook_list())
+        return super().setUpClass()
 
-            nsl = NotebookSummaryList(generate_notebook_list())
+    @classmethod
+    def tearDownClass(cls) -> None:
+        os.environ.pop("NB_SESSION_COMPARTMENT_OCID", None)
+        reload(ads.config)
+        ads.catalog.notebook.NB_SESSION_COMPARTMENT_OCID = (
+            ads.config.NB_SESSION_COMPARTMENT_OCID
+        )
+        return super().tearDownClass()
 
     @staticmethod
-    def generate_notebook_response_data(self, compartment_id=None, notebook_id=None):
+    def generate_notebook_response_data(compartment_id=None, notebook_id=None):
         entity_item = {
             "compartment_id": compartment_id,
             "created_by": "mock_user",
             "defined_tags": {},
             "display_name": "my new notebook catalog",
             "freeform_tags": {},
             "id": notebook_id,
-            "lifecycle_state": "",
             "lifecycle_state": "ACTIVE",
             "notebook_session_configuration_details": "",
             "notebook_session_url": "oci://notebook_session_url@test_namespace",
             "project_id": PROJECT_OCID,
-            "time_created": self.date_time.isoformat(),
+            "time_created": NotebookCatalogTest.date_time.isoformat(),
         }
         notebook_response = oci.data_science.models.NotebookSession(**entity_item)
         return notebook_response
@@ -107,12 +136,15 @@ def test_notebook_init_with_compartment_id(self, mock_client, mock_signer):
     def test_notebook_init_without_compartment_id(self, mock_client, mock_signer):
         """Test notebook catalog initiation without compartment_id."""
         test_notebook_catalog = NotebookCatalog()
-        assert test_notebook_catalog.compartment_id == NB_SESSION_COMPARTMENT_OCID
+        assert (
+            test_notebook_catalog.compartment_id
+            == ads.config.NB_SESSION_COMPARTMENT_OCID
+        )
 
     def test_decorate_notebook_session_attributes(self):
         """Test NotebookCatalog._decorate_notebook_session method."""
         notebook = self.generate_notebook_response_data(
-            self, compartment_id=self.comp_id, notebook_id=self.notebook_id
+            compartment_id=self.comp_id, notebook_id=self.notebook_id
         )
 
         def generate_get_user_data(self, compartment_id=None):
@@ -173,7 +205,6 @@ def test_get_notebook_session_with_short_id(self):
         def mock_get_notebook_session(notebook_id=id):
             return Mock(
                 data=self.generate_notebook_response_data(
-                    self,
                     compartment_id=self.comp_id,
                     notebook_id=short_id_index[short_id],
                 )
@@ -298,7 +329,7 @@ def test_update_notebook_session_with_short_id(self):
         wrapper = namedtuple("wrapper", ["data"])
         client_update_notebook_session_response = wrapper(
             data=self.generate_notebook_response_data(
-                self, compartment_id=self.comp_id, notebook_id=short_id_index[short_id]
+                compartment_id=self.comp_id, notebook_id=short_id_index[short_id]
             )
         )
         self.notebook_catalog.ds_client.update_notebook_session = MagicMock(
@@ -345,5 +376,5 @@ def test_notebook_summary_list_filter_invalid_param(self):
         # selection is a notebook session instance
         with pytest.raises(ValueError):
             self.nsl.filter(
-                selection=self.generate_notebook_response_data(self), instance=None
+                selection=self.generate_notebook_response_data(), instance=None
             )
diff --git a/tests/unitary/default_setup/catalog/test_catalog_project.py b/tests/unitary/default_setup/catalog/test_catalog_project.py
diff --git a/tests/unitary/with_extras/vault/test_vault_vault.py b/tests/unitary/with_extras/vault/test_vault_vault.py
