Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add deprecation warning for remove garbage collector dead code #2253

Merged
merged 11 commits into from
Jan 23, 2025
5 changes: 4 additions & 1 deletion ocp_resources/datavolume.py
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down Expand Up @@ -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
rnetser marked this conversation as resolved.
Show resolved Hide resolved
stop_status_func (function): function that is called inside the TimeoutSampler
if it returns True - stop the Sampler and raise TimeoutExpiredError
Example:
Expand All @@ -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
Expand Down