Deprecated new_name in Undelete (#18690)

* Deprecated new_name in Undelete

* added additional TODO comments on soft delete enabled tests

* removed it from DSC

* removed line

Author: tasherif-msft

sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py

@@ -5,6 +5,7 @@
 # --------------------------------------------------------------------------
 
 import functools
+import warnings
 from typing import (  # pylint: disable=unused-import
     Union, Optional, Any, Iterable, Dict, List,
     TYPE_CHECKING
@@ -624,14 +625,13 @@ def undelete_container(self, deleted_container_name, deleted_container_version,
             Specifies the name of the deleted container to restore.
         :param str deleted_container_version:
             Specifies the version of the deleted container to restore.
-        :keyword str new_name:
-            The new name for the deleted container to be restored to.
-            If not specified deleted_container_name will be used as the restored container name.
         :keyword int timeout:
             The timeout parameter is expressed in seconds.
         :rtype: ~azure.storage.blob.ContainerClient
         """
         new_name = kwargs.pop('new_name', None)
+        if new_name:
+            warnings.warn("`new_name` is no longer supported.", DeprecationWarning)
         container = self.get_container_client(new_name or deleted_container_name)
         try:
             container._client.container.restore(deleted_container_name=deleted_container_name,  # pylint: disable = protected-access

sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_service_client_async.py

@@ -5,6 +5,7 @@
 # --------------------------------------------------------------------------
 # pylint: disable=invalid-overridden-method
 import functools
+import warnings
 from typing import (  # pylint: disable=unused-import
     Union, Optional, Any, Iterable, Dict, List,
     TYPE_CHECKING
@@ -567,14 +568,13 @@ async def undelete_container(self, deleted_container_name, deleted_container_ver
             Specifies the name of the deleted container to restore.
         :param str deleted_container_version:
             Specifies the version of the deleted container to restore.
-        :keyword str new_name:
-            The new name for the deleted container to be restored to.
-            If not specified deleted_container_name will be used as the restored container name.
         :keyword int timeout:
             The timeout parameter is expressed in seconds.
         :rtype: ~azure.storage.blob.aio.ContainerClient
         """
         new_name = kwargs.pop('new_name', None)
+        if new_name:
+            warnings.warn("`new_name` is no longer supported.", DeprecationWarning)
         container = self.get_container_client(new_name or deleted_container_name)
         try:
             await container._client.container.restore(deleted_container_name=deleted_container_name, # pylint: disable = protected-access

sdk/storage/azure-storage-blob/tests/recordings/test_container.test_restore_to_existing_container.yaml

@@ -7,6 +7,7 @@
 # --------------------------------------------------------------------------
 
 import sys
+import time
 from datetime import datetime, timedelta
 from time import sleep
 
@@ -797,8 +798,7 @@ def test_delete_container_with_lease_id(self, resource_group, location, storage_
     @pytest.mark.playback_test_only
     @GlobalStorageAccountPreparer()
     def test_undelete_container(self, resource_group, location, storage_account, storage_account_key):
-        # container soft delete should enabled by SRP call or use armclient, so make this test as playback only.
-
+        # TODO: container soft delete should enabled by SRP call or use ARM, so make this test as playback only.
         bsc = BlobServiceClient(self.account_url(storage_account, "blob"), storage_account_key)
         container_client = self._create_container(bsc)
 
@@ -811,49 +811,20 @@ def test_undelete_container(self, resource_group, location, storage_account, sto
         container_list = list(bsc.list_containers(include_deleted=True))
         self.assertTrue(len(container_list) >= 1)
 
-        restored_version = 0
         for container in container_list:
             # find the deleted container and restore it
             if container.deleted and container.name == container_client.container_name:
-                restored_ctn_client = bsc.undelete_container(container.name, container.version,
-                                                              new_name="restored" + str(restored_version))
-                restored_version += 1
+                restored_ctn_client = bsc.undelete_container(container.name, container.version)
 
                 # to make sure the deleted container is restored
                 props = restored_ctn_client.get_container_properties()
                 self.assertIsNotNone(props)
 
-    @pytest.mark.playback_test_only
-    @GlobalStorageAccountPreparer()
-    def test_restore_to_existing_container(self, resource_group, location, storage_account, storage_account_key):
-        # container soft delete should enabled by SRP call or use armclient, so make this test as playback only.
-
-        bsc = BlobServiceClient(self.account_url(storage_account, "blob"), storage_account_key)
-        # get an existing container
-        existing_container_client = self._create_container(bsc, prefix="existing")
-        container_client = self._create_container(bsc)
-
-        # Act
-        container_client.delete_container()
-        # to make sure the container deleted
-        with self.assertRaises(ResourceNotFoundError):
-            container_client.get_container_properties()
-
-        container_list = list(bsc.list_containers(include_deleted=True))
-        self.assertTrue(len(container_list) >= 1)
-
-        for container in container_list:
-            # find the deleted container and restore it
-            if container.deleted and container.name == container_client.container_name:
-                with self.assertRaises(HttpResponseError):
-                    bsc.undelete_container(container.name, container.version,
-                                            new_name=existing_container_client.container_name)
-
     @pytest.mark.live_test_only  # sas token is dynamically generated
     @pytest.mark.playback_test_only  # we need container soft delete enabled account
     @GlobalStorageAccountPreparer()
     def test_restore_with_sas(self, resource_group, location, storage_account, storage_account_key):
-        # container soft delete should enabled by SRP call or use armclient, so make this test as playback only.
+        # TODO: container soft delete should enabled by SRP call or use ARM, so make this test as playback only.
         token = generate_account_sas(
             storage_account.name,
             storage_account_key,
@@ -875,9 +846,7 @@ def test_restore_with_sas(self, resource_group, location, storage_account, stora
         for container in container_list:
             # find the deleted container and restore it
             if container.deleted and container.name == container_client.container_name:
-                restored_ctn_client = bsc.undelete_container(container.name, container.version,
-                                                              new_name="restored" + str(restored_version))
-                restored_version += 1
+                restored_ctn_client = bsc.undelete_container(container.name, container.version)
 
                 # to make sure the deleted container is restored
                 props = restored_ctn_client.get_container_properties()

sdk/storage/azure-storage-blob/tests/recordings/test_container.test_undelete_container.yaml

@@ -5,6 +5,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
+import time
 from time import sleep
 
 import pytest
@@ -890,8 +891,7 @@ async def test_delete_container_with_lease_id(self, resource_group, location, st
     @GlobalStorageAccountPreparer()
     @AsyncStorageTestCase.await_prepared_test
     async def test_undelete_container(self, resource_group, location, storage_account, storage_account_key):
-        # container soft delete should enabled by SRP call or use armclient, so make this test as playback only.
-        pytest.skip('This will be added back along with STG74 features')
+        # TODO: container soft delete should enabled by SRP call or use ARM, so make this test as playback only.
         bsc = BlobServiceClient(self.account_url(storage_account, "blob"), storage_account_key)
         container_client = await self._create_container(bsc)
 
@@ -906,48 +906,15 @@ async def test_undelete_container(self, resource_group, location, storage_accoun
             container_list.append(c)
         self.assertTrue(len(container_list) >= 1)
 
-        restored_version = 0
         for container in container_list:
             # find the deleted container and restore it
             if container.deleted and container.name == container_client.container_name:
-                restored_ctn_client = await bsc.undelete_container(container.name, container.version,
-                                                                    new_name="restoredctn" + str(restored_version))
-                restored_version += 1
+                restored_ctn_client = await bsc.undelete_container(container.name, container.version)
 
                 # to make sure the deleted container is restored
                 props = await restored_ctn_client.get_container_properties()
                 self.assertIsNotNone(props)
 
-    @pytest.mark.playback_test_only
-    @GlobalStorageAccountPreparer()
-    @AsyncStorageTestCase.await_prepared_test
-    async def test_restore_to_existing_container(self, resource_group, location, storage_account, storage_account_key):
-        pytest.skip('This will be added back along with STG74 features')
-        # container soft delete should enabled by SRP call or use armclient, so make this test as playback only.
-
-        bsc = BlobServiceClient(self.account_url(storage_account, "blob"), storage_account_key)
-        # get an existing container
-        existing_container_client = await self._create_container(bsc, prefix="existing")
-        container_client = await self._create_container(bsc)
-
-        # Act
-        await container_client.delete_container()
-        # to make sure the container deleted
-        with self.assertRaises(ResourceNotFoundError):
-            await container_client.get_container_properties()
-
-        container_list = list()
-        async for c in bsc.list_containers(include_deleted=True):
-            container_list.append(c)
-        self.assertTrue(len(container_list) >= 1)
-
-        for container in container_list:
-            # find the deleted container and restore it
-            if container.deleted and container.name == container_client.container_name:
-                with self.assertRaises(HttpResponseError):
-                    await bsc.undelete_container(container.name, container.version,
-                                                  new_name=existing_container_client.container_name)
-
     @GlobalStorageAccountPreparer()
     @AsyncStorageTestCase.await_prepared_test
     async def test_list_names(self, resource_group, location, storage_account, storage_account_key):

sdk/storage/azure-storage-blob/tests/recordings/test_container_async.test_restore_to_existing_container.yaml

@@ -294,9 +294,6 @@ def undelete_file_system(self, name, deleted_version, **kwargs):
             Specifies the name of the deleted filesystem to restore.
         :param str deleted_version:
             Specifies the version of the deleted filesystem to restore.
-        :keyword str new_name:
-            The new name for the deleted filesystem to be restored to.
-            If not specified "name" will be used as the restored filesystem name.
         :keyword int timeout:
             The timeout parameter is expressed in seconds.
         :rtype: ~azure.storage.filedatalake.FileSystemClient

sdk/storage/azure-storage-blob/tests/recordings/test_container_async.test_undelete_container.yaml

@@ -244,9 +244,6 @@ async def undelete_file_system(self, name, deleted_version, **kwargs):
             Specifies the name of the deleted filesystem to restore.
         :param str deleted_version:
             Specifies the version of the deleted filesystem to restore.
-        :keyword str new_name:
-            The new name for the deleted filesystem to be restored to.
-            If not specified "name" will be used as the restored filesystem name.
         :keyword int timeout:
             The timeout parameter is expressed in seconds.
         :rtype: ~azure.storage.filedatalake.FileSystemClient