imrpve

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Author: csviri

docs/content/en/docs/testindex/_index.md

@@ -12,6 +12,7 @@
 import io.fabric8.kubernetes.model.annotation.Group;
 import io.fabric8.kubernetes.model.annotation.Kind;
 import io.fabric8.kubernetes.model.annotation.Version;
+import io.javaoperatorsdk.annotation.Sample;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
@@ -21,6 +22,15 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.awaitility.Awaitility.await;
 
+@Sample(
+    tldr = "Custom CRD Mapping in Test Extension",
+    description =
+        """
+        Demonstrates how to manually specify and apply Custom Resource Definitions (CRDs) in \
+        integration tests using the LocallyRunOperatorExtension. This test verifies that CRDs \
+        can be loaded from specified file paths and properly registered with the Kubernetes API \
+        server during test execution.
+        """)
 public class CRDMappingInTestExtensionIT {
   private final KubernetesClient client = new KubernetesClientBuilder().build();
 

operator-framework/src/test/java/io/javaoperatorsdk/operator/CRDMappingInTestExtensionIT.java

@@ -22,10 +22,12 @@
 @Sample(
     tldr = "Concurrent Reconciliation of Multiple Resources",
     description =
-        "Demonstrates the operator's ability to handle concurrent reconciliation of multiple"
-            + " resources. The test creates, updates, and deletes many resources simultaneously to"
-            + " verify proper handling of concurrent operations, ensuring thread safety and correct"
-            + " resource state management under load.")
+        """
+        Demonstrates the operator's ability to handle concurrent reconciliation of multiple \
+        resources. The test creates, updates, and deletes many resources simultaneously to \
+        verify proper handling of concurrent operations, ensuring thread safety and correct \
+        resource state management under load.
+        """)
 class ConcurrencyIT {
   public static final int NUMBER_OF_RESOURCES_CREATED = 50;
   public static final int NUMBER_OF_RESOURCES_DELETED = 30;

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/ConcurrencyIT.java

@@ -9,12 +9,22 @@
 import io.fabric8.kubernetes.client.ConfigBuilder;
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.KubernetesClientBuilder;
+import io.javaoperatorsdk.annotation.Sample;
 import io.javaoperatorsdk.operator.Operator;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
 
+@Sample(
+    tldr = "Operator Startup with Informer Errors",
+    description =
+        """
+        Demonstrates that the operator can start successfully even when informers encounter \
+        errors during startup, such as insufficient access rights. By setting \
+        stopOnInformerErrorDuringStartup to false, the operator gracefully handles permission \
+        errors and continues initialization, allowing it to operate with partial access.
+        """)
 class InformerErrorHandlerStartIT {
   /** Test showcases that the operator starts even if there is no access right for some resource. */
   @Test

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/InformerErrorHandlerStartIT.java

@@ -8,6 +8,7 @@
 import io.fabric8.kubernetes.client.ConfigBuilder;
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.KubernetesClientBuilder;
+import io.javaoperatorsdk.annotation.Sample;
 import io.javaoperatorsdk.operator.Operator;
 import io.javaoperatorsdk.operator.OperatorException;
 import io.javaoperatorsdk.operator.ReconcilerUtils;
@@ -21,6 +22,15 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
+@Sample(
+    tldr = "Leader Election with Insufficient Permissions",
+    description =
+        """
+        Verifies that the operator fails gracefully when leader election is configured but \
+        the service account lacks permissions to access lease resources. This test ensures \
+        proper error handling and messaging when RBAC permissions are insufficient for \
+        leader election functionality.
+        """)
 class LeaderElectionPermissionIT {
 
   KubernetesClient adminClient = new KubernetesClientBuilder().build();

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/LeaderElectionPermissionIT.java

@@ -19,10 +19,12 @@
 @Sample(
     tldr = "Cleanup handler for built-in Kubernetes resources",
     description =
-        "Demonstrates how to implement cleanup handlers (finalizers) for built-in Kubernetes"
-            + " resources like Service and Pod. These resources don't use generation the same way"
-            + " as custom resources, so this sample shows the proper approach to handle their"
-            + " lifecycle and cleanup logic.")
+        """
+        Demonstrates how to implement cleanup handlers (finalizers) for built-in Kubernetes \
+        resources like Service and Pod. These resources don't use generation the same way \
+        as custom resources, so this sample shows the proper approach to handle their \
+        lifecycle and cleanup logic.
+        """)
 class BuiltInResourceCleanerIT {
 
   private static final Logger log = LoggerFactory.getLogger(BuiltInResourceCleanerIT.class);

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/builtinresourcecleaner/BuiltInResourceCleanerIT.java

@@ -25,11 +25,13 @@
 @Sample(
     tldr = "Dynamically Changing Watched Namespaces",
     description =
-        "Demonstrates how to dynamically change the set of namespaces that an operator watches at"
-            + " runtime. This feature allows operators to add or remove namespaces from their watch"
-            + " list, including switching between specific namespaces and watching all namespaces."
-            + " The test verifies that resources in newly added namespaces are reconciled and"
-            + " resources in removed namespaces are no longer watched.")
+        """
+        Demonstrates how to dynamically change the set of namespaces that an operator watches at \
+        runtime. This feature allows operators to add or remove namespaces from their watch \
+        list, including switching between specific namespaces and watching all namespaces. \
+        The test verifies that resources in newly added namespaces are reconciled and \
+        resources in removed namespaces are no longer watched.
+        """)
 class ChangeNamespaceIT {
 
   public static final String TEST_RESOURCE_NAME_1 = "test1";

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/changenamespace/ChangeNamespaceIT.java

@@ -13,12 +13,14 @@
 @Sample(
     tldr = "Implementing Cleanup Logic with Cleaner Interface",
     description =
-        "Demonstrates how to implement cleanup logic for custom resources using the Cleaner"
-            + " interface. When a reconciler implements Cleaner, the framework automatically adds a"
-            + " finalizer to resources and calls the cleanup method when the resource is deleted."
-            + " This pattern is useful for cleaning up external resources or performing custom"
-            + " deletion logic. The test verifies finalizer handling, cleanup execution, and the"
-            + " ability to reschedule cleanup operations.")
+        """
+        Demonstrates how to implement cleanup logic for custom resources using the Cleaner \
+        interface. When a reconciler implements Cleaner, the framework automatically adds a \
+        finalizer to resources and calls the cleanup method when the resource is deleted. \
+        This pattern is useful for cleaning up external resources or performing custom \
+        deletion logic. The test verifies finalizer handling, cleanup execution, and the \
+        ability to reschedule cleanup operations.
+        """)
 class CleanerForReconcilerIT {
 
   public static final String TEST_RESOURCE_NAME = "cleaner-for-reconciler-test1";

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/cleanerforreconciler/CleanerForReconcilerIT.java

@@ -6,12 +6,21 @@
 import org.junit.jupiter.api.extension.RegisterExtension;
 
 import io.fabric8.kubernetes.api.model.ObjectMeta;
+import io.javaoperatorsdk.annotation.Sample;
 import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
 
 import static io.javaoperatorsdk.operator.baseapi.cleanupconflict.CleanupConflictReconciler.WAIT_TIME;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.awaitility.Awaitility.await;
 
+@Sample(
+    tldr = "Cleanup Finalizer Removal Without Conflicts",
+    description =
+        """
+        Tests that finalizers are removed correctly during cleanup without causing conflicts, \
+        even when multiple finalizers are present and removed concurrently. This verifies the \
+        operator's ability to handle finalizer updates safely during resource deletion.
+        """)
 class CleanupConflictIT {
 
   private static final String ADDITIONAL_FINALIZER = "javaoperatorsdk.io/additionalfinalizer";

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/cleanupconflict/CleanupConflictIT.java

@@ -17,10 +17,12 @@
 @Sample(
     tldr = "Cluster-scoped resource reconciliation",
     description =
-        "Demonstrates how to reconcile cluster-scoped custom resources (non-namespaced). This"
-            + " test shows CRUD operations on cluster-scoped resources and verifies that"
-            + " dependent resources are created, updated, and properly cleaned up when the"
-            + " primary resource is deleted.")
+        """
+        Demonstrates how to reconcile cluster-scoped custom resources (non-namespaced). This \
+        test shows CRUD operations on cluster-scoped resources and verifies that \
+        dependent resources are created, updated, and properly cleaned up when the \
+        primary resource is deleted.
+        """)
 class ClusterScopedResourceIT {
 
   public static final String TEST_NAME = "test1";