Move JSpecify annotations closest to the target and enable NullAway annotation check (#39)

* update to Quarkus 3.32.1 and update dependencies to latest versions

* validate K8s resource references against the RFC 1123 hostname format Kubernetes uses

* refactor SecretRef and ClusterReference to one common ResourceRef type

* fix the test by having a own SchemaCustomizer for Kubernetes names

* do not short-circuit the PostgreSQLInstanceReadinessCheck check once one instance is down

* let the PostgreSQLContextFactory exception bubble up

* reformat code

* fix compile issue

* move the JSpecify annotations closest to their target

* enable NullAway option RequireExplicitNullMarking to detect classes that are not annotated with JSpecify annotations

* the namespace should come always first

* add explicit string max length check of 63

* add explicit string max length check of 63

Author: ThoSap

build.gradle.kts

@@ -83,6 +83,7 @@ subprojects {
 
         options.errorprone {
             check("NullAway", CheckSeverity.ERROR)
+            check("RequireExplicitNullMarking", CheckSeverity.ERROR)
             option("NullAway:AnnotatedPackages", "it.aboutbits.postgresql")
             option("NullAway:JSpecifyMode", "true")
         }

operator/src/main/java/it/aboutbits/postgresql/PostgreSQLInstanceReadinessCheck.java

@@ -15,9 +15,9 @@
  * configured PostgreSQL instances. Each instance is probed with a lightweight
  * operation, and the aggregated status is exposed.
  */
-@NullMarked
 @Readiness
 @RequiredArgsConstructor
+@NullMarked
 public class PostgreSQLInstanceReadinessCheck implements HealthCheck {
     private final PostgreSQLContextFactory postgreSQLContextFactory;
 

operator/src/main/java/it/aboutbits/postgresql/core/BaseReconciler.java

@@ -14,8 +14,8 @@
 import java.util.Optional;
 import java.util.concurrent.TimeUnit;
 
-@NullMarked
 @Slf4j
+@NullMarked
 public abstract class BaseReconciler<CR extends CustomResource<?, S> & Named, S extends CRStatus> {
     protected abstract S newStatus();
 

operator/src/main/java/it/aboutbits/postgresql/core/CRStatus.java

@@ -15,16 +15,15 @@
  * <p>
  * This object captures the current state of a Custom Resource as observed by the reconciler.
  */
-@NullMarked
 @Getter
 @Setter
 @Accessors(chain = true)
+@NullMarked
 public class CRStatus {
     /**
      * The Custom Resource name (may differ from metadata.name).
      */
-    @Nullable
-    private String name = null;
+    private @Nullable String name = null;
 
     /**
      * Current lifecycle phase of the Bucket.
@@ -35,21 +34,18 @@ public class CRStatus {
     /**
      * Human-readable message providing details about the current state.
      */
-    @Nullable
-    private String message = null;
+    private @Nullable String message = null;
 
     /**
      * Last time the condition was probed/updated.
      */
-    @Nullable
-    private OffsetDateTime lastProbeTime = null;
+    private @Nullable OffsetDateTime lastProbeTime = null;
 
     /**
      * Last time the condition transitioned from one status to another.
      */
-    @Nullable
     @Setter(AccessLevel.NONE)
-    private OffsetDateTime lastPhaseTransitionTime = null;
+    private @Nullable OffsetDateTime lastPhaseTransitionTime = null;
 
     /**
      * Observed resource generation that the controller acted upon.

operator/src/main/java/it/aboutbits/postgresql/core/KubernetesService.java

@@ -8,8 +8,8 @@
 import java.nio.charset.Charset;
 import java.util.Base64;
 
-@NullMarked
 @Singleton
+@NullMarked
 public final class KubernetesService {
     public static final String SECRET_TYPE_BASIC_AUTH = "kubernetes.io/basic-auth";
     public static final String SECRET_DATA_BASIC_AUTH_USERNAME_KEY = "username";

operator/src/main/java/it/aboutbits/postgresql/core/PostgreSQLAuthenticationService.java

@@ -21,9 +21,9 @@
 
 import static it.aboutbits.postgresql.core.infrastructure.persistence.Tables.PG_AUTHID;
 
-@NullMarked
 @Slf4j
 @Singleton
+@NullMarked
 public final class PostgreSQLAuthenticationService {
     private static final String MD5 = "MD5";
     private static final String SHA_256 = "SHA-256";

operator/src/main/java/it/aboutbits/postgresql/core/PostgreSQLContextFactory.java

@@ -11,9 +11,9 @@
 
 import java.util.Properties;
 
-@NullMarked
 @ApplicationScoped
 @RequiredArgsConstructor
+@NullMarked
 public class PostgreSQLContextFactory {
     private static final String POSTGRESQL_AUTHENTICATION_USER_KEY = "user";
     private static final String POSTGRESQL_AUTHENTICATION_PASSWORD_KEY = "password";

operator/src/main/java/it/aboutbits/postgresql/core/Privilege.java

@@ -15,10 +15,10 @@
  * https://www.postgresql.org/docs/current/sql-grant.html
  * </a>
  */
-@NullMarked
 @Getter
 @Accessors(fluent = true)
 @RequiredArgsConstructor
+@NullMarked
 public enum Privilege {
     SELECT(null),
     INSERT(null),
@@ -33,8 +33,7 @@ public enum Privilege {
     USAGE(null),
     MAINTAIN(17);
 
-    @Nullable
-    private final Integer minimumPostgresVersion;
+    private final @Nullable Integer minimumPostgresVersion;
 
     @JsonValue
     public String toValue() {

operator/src/main/java/it/aboutbits/postgresql/core/ReclaimPolicy.java

@@ -4,8 +4,8 @@
 import lombok.RequiredArgsConstructor;
 import org.jspecify.annotations.NullMarked;
 
-@NullMarked
 @RequiredArgsConstructor
+@NullMarked
 public enum ReclaimPolicy {
     RETAIN("Retain"),
     DELETE("Delete");

operator/src/main/java/it/aboutbits/postgresql/core/ResourceRef.java

@@ -26,17 +26,16 @@
 /// |-------------------|-----------------------------------------------------|
 /// | non-null          | the explicit namespace                              |
 /// | `null` (omitted)  | the namespace of the CR that owns this reference    |
-@NullMarked
 @Getter
 @Setter
 @SchemaCustomizer(KubernetesNameCustomizer.class)
+@NullMarked
 public class ResourceRef {
     /// The namespace of the referenced Kubernetes resource.
     /// If `null`, defaults to the namespace of the CR that defines this reference.
-    @Nullable
-    @Max(63)
     @io.fabric8.generator.annotation.Nullable
-    private String namespace;
+    @Max(63)
+    private @Nullable String namespace;
 
     @Required
     @Max(63)