[Cosmos] migrate from using unittest

sdk/cosmos/azure-cosmos/CHANGELOG.md

@@ -7,6 +7,8 @@
 #### Breaking Changes
 
 #### Bugs Fixed
+* Small fix to the `offer_throughput` option in the async client's `create_database_if_not_exists` method, which was previously misspelled as `offerThroughput`.
+See [PR 32076](https://github.com/Azure/azure-sdk-for-python/pull/32076).
 
 #### Other Changes
 * Marked the outdated `diagnostics.py` file for deprecation since we now recommend the use of our `CosmosHttpLoggingPolicy` for diagnostics.

sdk/cosmos/azure-cosmos/azure/cosmos/aio/_cosmos_client.py

@@ -292,7 +292,7 @@ async def create_database_if_not_exists(  # pylint: disable=redefined-builtin
         :returns: A DatabaseProxy instance representing the database.
         :rtype: ~azure.cosmos.DatabaseProxy
         """
-        offer_throughput = kwargs.pop("offerThroughput", None)
+        offer_throughput = kwargs.pop("offer_throughput", None)
         try:
             database_proxy = self.get_database_client(id)
             await database_proxy.read(**kwargs)

sdk/cosmos/azure-cosmos/dev_requirements.txt

@@ -1,3 +1,4 @@
+aiohttp>=3.0
 -e ../../core/azure-core
 -e ../../identity/azure-identity
 -e ../../../tools/azure-sdk-tools

sdk/cosmos/azure-cosmos/test/test_auto_scale.py

@@ -18,36 +18,36 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-import unittest
-import azure.cosmos.cosmos_client as cosmos_client
+
+from azure.cosmos import CosmosClient
 import azure.cosmos.exceptions as exceptions
-from azure.cosmos import ThroughputProperties, PartitionKey, http_constants
+from azure.cosmos import ThroughputProperties, PartitionKey
 import pytest
 import test_config
 
 pytestmark = pytest.mark.cosmosEmulator
 
 
 @pytest.mark.usefixtures("teardown")
-class AutoScaleTest(unittest.TestCase):
+class TestAutoScale:
     host = test_config._test_config.host
     masterKey = test_config._test_config.masterKey
     connectionPolicy = test_config._test_config.connectionPolicy
 
     @classmethod
-    def setUpClass(cls):
+    def _set_up(cls):
         if (cls.masterKey == '[YOUR_KEY_HERE]' or
                 cls.host == '[YOUR_ENDPOINT_HERE]'):
             raise Exception(
                 "You must specify your Azure Cosmos account values for "
                 "'masterKey' and 'host' at the top of this class to run the "
                 "tests.")
 
-        cls.client = cosmos_client.CosmosClient(cls.host, cls.masterKey, consistency_level="Session",
-                                                connection_policy=cls.connectionPolicy)
+        cls.client = CosmosClient(cls.host, cls.masterKey, consistency_level="Session")
         cls.created_database = cls.client.create_database_if_not_exists(test_config._test_config.TEST_DATABASE_ID)
 
-    def test_auto_scale(self):
+    def test_autoscale_create_container(self):
+        self._set_up()
         created_container = self.created_database.create_container(
             id='auto_scale',
             partition_key=PartitionKey(path="/id"),
@@ -56,83 +56,85 @@ def test_auto_scale(self):
         )
         created_container_properties = created_container.get_throughput()
         # Testing the input value of the max_throughput
-        self.assertEqual(
-            created_container_properties.auto_scale_max_throughput, 7000)
-        self.assertEqual(created_container_properties.auto_scale_increment_percent, 0)
-        self.assertEqual(created_container_properties.offer_throughput, None)
+        assert created_container_properties.auto_scale_max_throughput == 7000
+        assert created_container_properties.auto_scale_increment_percent == 0
+        assert created_container_properties.offer_throughput is None
 
         self.created_database.delete_container(created_container)
 
         # Testing the incorrect passing of an input value of the max_throughput to verify negative behavior
         with pytest.raises(exceptions.CosmosHttpResponseError) as e:
-            created_container = self.created_database.create_container(
+            self.created_database.create_container(
                 id='container_with_wrong_auto_scale_settings',
                 partition_key=PartitionKey(path="/id"),
                 offer_throughput=ThroughputProperties(auto_scale_max_throughput=-200, auto_scale_increment_percent=0))
         assert "Requested throughput -200 is less than required minimum throughput 1000" in str(e.value)
 
-    def test_create_container_if_not_exist(self):
         # Testing auto_scale_settings for the create_container_if_not_exists method
         created_container = self.created_database.create_container_if_not_exists(
             id='auto_scale_2',
             partition_key=PartitionKey(path="/id"),
             offer_throughput=ThroughputProperties(auto_scale_max_throughput=1000, auto_scale_increment_percent=3)
         )
         created_container_properties = created_container.get_throughput()
-        # Testing the incorrect input value of the max_throughput
-        self.assertNotEqual(
-            created_container_properties.auto_scale_max_throughput, 2000)
+        # Testing the input value of the max_throughput
+        assert created_container_properties.auto_scale_max_throughput == 1000
         # Testing the input value of the increment_percentage
-        self.assertEqual(
-            created_container_properties.auto_scale_increment_percent, 3)
+        assert created_container_properties.auto_scale_increment_percent == 3
 
         self.created_database.delete_container(created_container.id)
 
-    def test_create_database(self):
+    def test_autoscale_create_database(self):
+        self._set_up()
         # Testing auto_scale_settings for the create_database method
         created_database = self.client.create_database("db_auto_scale", offer_throughput=ThroughputProperties(
             auto_scale_max_throughput=5000,
-            auto_scale_increment_percent=0))
+            auto_scale_increment_percent=2))
         created_db_properties = created_database.get_throughput()
         # Testing the input value of the max_throughput
-        self.assertEqual(
-            created_db_properties.auto_scale_max_throughput, 5000)
+        assert created_db_properties.auto_scale_max_throughput == 5000
         # Testing the input value of the increment_percentage
-        self.assertEqual(
-            created_db_properties.auto_scale_increment_percent, 0)
+        assert created_db_properties.auto_scale_increment_percent == 2
 
         self.client.delete_database("db_auto_scale")
 
-    def test_create_database_if_not_exists(self):
         # Testing auto_scale_settings for the create_database_if_not_exists method
         created_database = self.client.create_database_if_not_exists("db_auto_scale_2",
                                                                      offer_throughput=ThroughputProperties(
                                                                          auto_scale_max_throughput=9000,
                                                                          auto_scale_increment_percent=11))
         created_db_properties = created_database.get_throughput()
         # Testing the input value of the max_throughput
-        self.assertNotEqual(
-            created_db_properties.auto_scale_max_throughput, 8000)
+        assert created_db_properties.auto_scale_max_throughput == 9000
         # Testing the input value of the increment_percentage
-        self.assertEqual(
-            created_db_properties.auto_scale_increment_percent, 11)
+        assert created_db_properties.auto_scale_increment_percent == 11
 
         self.client.delete_database("db_auto_scale_2")
 
-    def test_replace_throughput(self):
+    def test_autoscale_replace_throughput(self):
+        self._set_up()
+
+        created_database = self.client.create_database("replace_db", offer_throughput=ThroughputProperties(
+            auto_scale_max_throughput=5000,
+            auto_scale_increment_percent=2))
+        created_database.replace_throughput(
+            throughput=ThroughputProperties(auto_scale_max_throughput=7000, auto_scale_increment_percent=20))
+        created_db_properties = created_database.get_throughput()
+        # Testing the input value of the max_throughput
+        assert created_db_properties.auto_scale_max_throughput == 7000
+        # Testing the input value of the increment_percentage
+        assert created_db_properties.auto_scale_increment_percent == 20
+        self.client.delete_database("replace_db")
+
         created_container = self.created_database.create_container(
             id='container_with_replace_functionality',
             partition_key=PartitionKey(path="/id"),
-            offer_throughput=ThroughputProperties(auto_scale_max_throughput=5000, auto_scale_increment_percent=0)
-
-        )
-        new_throughput = created_container.replace_throughput(
+            offer_throughput=ThroughputProperties(auto_scale_max_throughput=5000, auto_scale_increment_percent=0))
+        created_container.replace_throughput(
             throughput=ThroughputProperties(auto_scale_max_throughput=7000, auto_scale_increment_percent=20))
         created_container_properties = created_container.get_throughput()
         # Testing the input value of the replaced auto_scale settings
-        self.assertEqual(
-            created_container_properties.auto_scale_max_throughput, 7000)
-        self.assertEqual(
-            created_container_properties.auto_scale_increment_percent, 20)
+        assert created_container_properties.auto_scale_max_throughput == 7000
+        assert created_container_properties.auto_scale_increment_percent == 20
 
         self.created_database.delete_container(created_container.id)

sdk/cosmos/azure-cosmos/test/test_auto_scale_async.py

@@ -18,36 +18,37 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-import unittest
+
 from azure.cosmos.aio import CosmosClient
 import azure.cosmos.exceptions as exceptions
-from azure.cosmos import ThroughputProperties, PartitionKey, http_constants
+from azure.cosmos import ThroughputProperties, PartitionKey
 import pytest
 import test_config
 
 pytestmark = pytest.mark.cosmosEmulator
 
 
 @pytest.mark.usefixtures("teardown")
-class AutoScaleTest(unittest.TestCase):
+class TestAutoScaleAsync:
     host = test_config._test_config.host
     masterKey = test_config._test_config.masterKey
     connectionPolicy = test_config._test_config.connectionPolicy
 
     @classmethod
-    async def setUpClass(cls):
+    async def _set_up(cls):
         if (cls.masterKey == '[YOUR_KEY_HERE]' or
                 cls.host == '[YOUR_ENDPOINT_HERE]'):
             raise Exception(
                 "You must specify your Azure Cosmos account values for "
                 "'masterKey' and 'host' at the top of this class to run the "
                 "tests.")
 
-        cls.client = CosmosClient(cls.host, cls.masterKey, consistency_level="Session",
-                                  connection_policy=cls.connectionPolicy)
+        cls.client = CosmosClient(cls.host, cls.masterKey)
         cls.created_database = await cls.client.create_database_if_not_exists(test_config._test_config.TEST_DATABASE_ID)
 
-    async def test_auto_scale(self):
+    @pytest.mark.asyncio
+    async def test_autoscale_create_container_async(self):
+        await self._set_up()
         created_container = await self.created_database.create_container(
             id='container_with_auto_scale_settings',
             partition_key=PartitionKey(path="/id"),
@@ -56,92 +57,86 @@ async def test_auto_scale(self):
         )
         created_container_properties = await created_container.get_throughput()
         # Testing the input value of the max_throughput
-        self.assertEqual(
-            created_container_properties.auto_scale_max_throughput, 5000)
-        self.assertEqual(created_container_properties.auto_scale_increment_percent, 0)
-        self.assertEqual(created_container_properties.offer_throughput, None)
+        assert created_container_properties.auto_scale_max_throughput == 5000
+        assert created_container_properties.auto_scale_increment_percent == 0
+        assert created_container_properties.offer_throughput is None
 
         await self.created_database.delete_container(created_container)
 
         # Testing the incorrect passing of an input value of the max_throughput to verify negative behavior
         with pytest.raises(exceptions.CosmosHttpResponseError) as e:
-            created_container = await self.created_database.create_container(
+            await self.created_database.create_container(
                 id='container_with_wrong_auto_scale_settings',
                 partition_key=PartitionKey(path="/id"),
                 offer_throughput=ThroughputProperties(auto_scale_max_throughput=-200, auto_scale_increment_percent=0))
         assert "Requested throughput -200 is less than required minimum throughput 1000" in str(e.value)
 
-    async def test_create_container_if_not_exist(self):
         # Testing auto_scale_settings for the create_container_if_not_exists method
         created_container = await self.created_database.create_container_if_not_exists(
             id='container_with_auto_scale_settings',
             partition_key=PartitionKey(path="/id"),
-            offer_throughput=ThroughputProperties(auto_scale_max_throughput=1000, auto_scale_increment_percent=0)
+            offer_throughput=ThroughputProperties(auto_scale_max_throughput=1000, auto_scale_increment_percent=3)
         )
         created_container_properties = await created_container.get_throughput()
-        # Testing the incorrect input value of the max_throughput
-        self.assertNotEqual(
-            created_container_properties.auto_scale_max_throughput, 2000)
-
-        await self.created_database.delete_container(created_container)
-
-        created_container = await self.created_database.create_container_if_not_exists(
-            id='container_with_auto_scale_settings',
-            partition_key=PartitionKey(path="/id"),
-            offer_throughput=ThroughputProperties(auto_scale_max_throughput=5000, auto_scale_increment_percent=2)
-
-        )
-        created_container_properties = await created_container.get_throughput()
-        # Testing the incorrect input value of the max_increment_percentage
-        self.assertNotEqual(
-            created_container_properties.auto_scale_increment_percent, 3)
+        # Testing the input value of the max_throughput
+        assert created_container_properties.auto_scale_max_throughput == 1000
+        # Testing the input value of the increment_percentage
+        assert created_container_properties.auto_scale_increment_percent == 3
 
-        await self.created_database.delete_container(created_container)
+        await self.created_database.delete_container(created_container.id)
 
-    async def test_create_database(self):
+    @pytest.mark.asyncio
+    async def test_autoscale_create_database_async(self):
+        await self._set_up()
         # Testing auto_scale_settings for the create_database method
         created_database = await self.client.create_database("db1", offer_throughput=ThroughputProperties(
             auto_scale_max_throughput=5000,
             auto_scale_increment_percent=0))
         created_db_properties = await created_database.get_throughput()
         # Testing the input value of the max_throughput
-        self.assertEqual(
-            created_db_properties.auto_scale_max_throughput, 5000)
+        assert created_db_properties.auto_scale_max_throughput == 5000
         # Testing the input value of the increment_percentage
-        self.assertEqual(
-            created_db_properties.auto_scale_increment_percent, 0)
+        assert created_db_properties.auto_scale_increment_percent == 0
 
         await self.client.delete_database("db1")
 
-    async def test_create_database_if_not_exists(self):
         # Testing auto_scale_settings for the create_database_if_not_exists method
         created_database = await self.client.create_database_if_not_exists("db2", offer_throughput=ThroughputProperties(
             auto_scale_max_throughput=9000,
             auto_scale_increment_percent=11))
         created_db_properties = await created_database.get_throughput()
         # Testing the input value of the max_throughput
-        self.assertNotEqual(
-            created_db_properties.auto_scale_max_throughput, 8000)
+        assert created_db_properties.auto_scale_max_throughput == 9000
         # Testing the input value of the increment_percentage
-        self.assertEqual(
-            created_db_properties.auto_scale_increment_percent, 11)
+        assert created_db_properties.auto_scale_increment_percent == 11
 
         await self.client.delete_database("db2")
 
-    async def test_replace_throughput(self):
+    @pytest.mark.asyncio
+    async def test_replace_throughput_async(self):
+        await self._set_up()
+
+        created_database = await self.client.create_database("replace_db", offer_throughput=ThroughputProperties(
+            auto_scale_max_throughput=5000,
+            auto_scale_increment_percent=0))
+        await created_database.replace_throughput(
+            throughput=ThroughputProperties(auto_scale_max_throughput=7000, auto_scale_increment_percent=20))
+        created_db_properties = await created_database.get_throughput()
+        # Testing the replaced value of the max_throughput
+        assert created_db_properties.auto_scale_max_throughput == 7000
+        # Testing the replaced value of the increment_percentage
+        assert created_db_properties.auto_scale_increment_percent == 20
+        await self.client.delete_database("replace_db")
+
         created_container = await self.created_database.create_container(
             id='container_with_auto_scale_settings',
             partition_key=PartitionKey(path="/id"),
-            offer_throughput=ThroughputProperties(auto_scale_max_throughput=5000, auto_scale_increment_percent=0)
-
-        )
-        new_throughput = await created_container.replace_throughput(
+            offer_throughput=ThroughputProperties(auto_scale_max_throughput=5000, auto_scale_increment_percent=0)        )
+        await created_container.replace_throughput(
             throughput=ThroughputProperties(auto_scale_max_throughput=7000, auto_scale_increment_percent=20))
         created_container_properties = await created_container.get_throughput()
         # Testing the input value of the replaced auto_scale settings
-        self.assertEqual(
-            created_container_properties.auto_scale_max_throughput, 7000)
-        self.assertEqual(
-            created_container_properties.auto_scale_increment_percent, 20)
+        assert created_container_properties.auto_scale_max_throughput == 7000
+        assert created_container_properties.auto_scale_increment_percent == 20
 
         await self.client.delete_database(test_config._test_config.TEST_DATABASE_ID)