add deprecation warning for remove garbage collector dead code (#2253)

* remove garbage collector dead code

* Update datavolume.py

* Update datavolume.py

* Update datavolume.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update datavolume.py

* Update datavolume.py

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

ocp_resources/datavolume.py

@@ -8,6 +8,7 @@
 from ocp_resources.persistent_volume_claim import PersistentVolumeClaim
 from ocp_resources.resource import NamespacedResource, Resource
 from timeout_sampler import TimeoutExpiredError, TimeoutSampler
+from warnings import warn
 
 
 class DataVolume(NamespacedResource):
@@ -281,7 +282,7 @@ def wait_for_dv_success(
         Args:
             timeout (int):  Time to wait for the DataVolume to succeed.
             failure_timeout (int): Time to wait for the DataVolume to have not Pending/None status
-            dv_garbage_collection_enabled (bool, default: False): if True, expect that DV will disappear after success
+            dv_garbage_collection_enabled (bool, default: False): DV garbage collection is deprecated and removed in v4.19
             stop_status_func (function): function that is called inside the TimeoutSampler
                 if it returns True - stop the Sampler and raise TimeoutExpiredError
                 Example:
@@ -307,6 +308,8 @@ def test_dv():
                 wait_timeout=timeout,
                 func=lambda: self.exists,
             ):
+                if dv_garbage_collection_enabled is not None:
+                    warn("garbage collector is deprecated and removed in version v4.19", DeprecationWarning)
                 # DV reach success if the status is Succeeded, or if DV garbage collection enabled and the DV does not exist
                 if sample and sample.get("status", {}).get("phase") == self.Status.SUCCEEDED:
                     break