improve: Add @sample annotation for expectation pattern releated integration tests

Signed-off-by: Attila Mészáros <[email protected]>

Author: csviri

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/expectation/onallevent/ExpectationIT.java

@@ -21,12 +21,20 @@
 import org.junit.jupiter.api.extension.RegisterExtension;
 
 import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
+import io.javaoperatorsdk.annotation.Sample;
 import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
 
 import static io.javaoperatorsdk.operator.baseapi.expectation.onallevent.ExpectationReconciler.DEPLOYMENT_READY;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.awaitility.Awaitility.await;
 
+@Sample(
+    tldr = "Basic Expectation Pattern with AllEvents Trigger",
+    description = """
+        Demonstrates the basic expectation pattern using ExpectationManager with triggerReconcilerOnAllEvents = true.
+        This pattern allows reconcilers to wait for specific conditions to be met (like a Deployment having 3 ready replicas)
+        before proceeding with status updates. The test shows both successful expectation fulfillment and timeout handling.
+        Requires @ControllerConfiguration(triggerReconcilerOnAllEvents = true) for proper operation.""")
 class ExpectationIT {
 
   public static final String TEST_1 = "test1";

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/expectation/periodicclean/PeriodicCleanerExpectationIT.java

@@ -21,20 +21,20 @@
 import org.junit.jupiter.api.extension.RegisterExtension;
 
 import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
+import io.javaoperatorsdk.annotation.Sample;
 import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
 
 import static io.javaoperatorsdk.operator.baseapi.expectation.periodicclean.PeriodicCleanerExpectationReconciler.DEPLOYMENT_READY;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.awaitility.Awaitility.await;
 
-/**
- * Integration test showcasing PeriodicCleanerExpectationManager usage.
- *
- * <p>This test demonstrates the key benefits of PeriodicCleanerExpectationManager: 1. Works without
- * requiring @ControllerConfiguration(triggerReconcilerOnAllEvents = true) 2. Automatically cleans
- * up stale expectations periodically 3. Maintains the same expectation API and functionality as the
- * regular ExpectationManager
- */
+@Sample(
+    tldr = "Expectation Pattern with Periodic Cleanup",
+    description = """
+        Demonstrates the PeriodicCleanerExpectationManager pattern which provides automatic cleanup of stale expectations.
+        This pattern works without requiring @ControllerConfiguration(triggerReconcilerOnAllEvents = true) and automatically
+        cleans up stale expectations periodically (default: 1 minute). This is ideal for 'set and forget' scenarios where
+        you want the same expectation API and functionality as the regular ExpectationManager but with automatic lifecycle management.""")
 class PeriodicCleanerExpectationIT {
 
   public static final String TEST_1 = "test1";