This is an automated email from the ASF dual-hosted git repository.

dongjoon pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/spark-kubernetes-operator.git


The following commit(s) were added to refs/heads/main by this push:
     new 026bc0f  [SPARK-49159] Enforce 
`FieldDeclarationsShouldBeAtStartOfClass`, `LinguisticNaming` and 
`ClassWithOnlyPrivateConstructorsShouldBeFinal` rules
026bc0f is described below

commit 026bc0faa332eb8843901ecaee729e1bf3104bdc
Author: William Hyun <[email protected]>
AuthorDate: Thu Aug 8 09:04:29 2024 -0700

    [SPARK-49159] Enforce `FieldDeclarationsShouldBeAtStartOfClass`, 
`LinguisticNaming` and `ClassWithOnlyPrivateConstructorsShouldBeFinal` rules
    
    ### What changes were proposed in this pull request?
    This PR aims to enforce `FieldDeclarationsShouldBeAtStartOfClass`, 
`LinguisticNaming` and `ClassWithOnlyPrivateConstructorsShouldBeFinal` rules
    
    ### Why are the changes needed?
    To ensure future code quality.
    
    ### Does this PR introduce _any_ user-facing change?
    No.
    
    ### How was this patch tested?
    Pass the CIs.
    
    ### Was this patch authored or co-authored using generative AI tooling?
    No.
    
    Closes #40 from williamhyun/class.
    
    Authored-by: William Hyun <[email protected]>
    Signed-off-by: Dongjoon Hyun <[email protected]>
---
 config/pmd/ruleset.xml                             |  3 ---
 .../operator/status/ApplicationStateSummary.java   | 24 +++++++++++-----------
 .../k8s/operator/reconciler/ReconcileProgress.java |  2 +-
 .../apache/spark/k8s/operator/utils/TestUtils.java |  4 +---
 .../spark/k8s/operator/SparkAppDriverConf.java     |  2 +-
 5 files changed, 15 insertions(+), 20 deletions(-)

diff --git a/config/pmd/ruleset.xml b/config/pmd/ruleset.xml
index 6a67e97..8e1c33c 100644
--- a/config/pmd/ruleset.xml
+++ b/config/pmd/ruleset.xml
@@ -28,10 +28,8 @@
   <rule ref="category/java/codestyle.xml">
     <exclude name="AtLeastOneConstructor" />
     <exclude name="CommentDefaultAccessModifier" />
-    <exclude name="FieldDeclarationsShouldBeAtStartOfClass" />
     <exclude name="FieldNamingConventions" />
     <exclude name="GenericsNaming" />
-    <exclude name="LinguisticNaming" />
     <exclude name="LocalVariableCouldBeFinal" />
     <exclude name="LongVariable" />
     <exclude name="MethodArgumentCouldBeFinal" />
@@ -43,7 +41,6 @@
   <rule ref="category/java/design.xml">
     <exclude name="AbstractClassWithoutAnyMethod" />
     <exclude name="AvoidCatchingGenericException" />
-    <exclude name="ClassWithOnlyPrivateConstructorsShouldBeFinal" />
     <exclude name="CognitiveComplexity" />
     <exclude name="CyclomaticComplexity" />
     <exclude name="ExcessiveImports" />
diff --git 
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationStateSummary.java
 
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationStateSummary.java
index 5c962bc..fc5fed1 100644
--- 
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationStateSummary.java
+++ 
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationStateSummary.java
@@ -99,6 +99,18 @@ public enum ApplicationStateSummary implements 
BaseStateSummary {
    */
   TerminatedWithoutReleaseResources;
 
+  public static final Set<ApplicationStateSummary> infrastructureFailures =
+      Set.of(DriverStartTimedOut, ExecutorsStartTimedOut, SchedulingFailure);
+
+  public static final Set<ApplicationStateSummary> failures =
+      Set.of(
+          DriverStartTimedOut,
+          ExecutorsStartTimedOut,
+          SchedulingFailure,
+          DriverEvicted,
+          Failed,
+          DriverReadyTimedOut);
+
   public boolean isInitializing() {
     return Submitted.equals(this) || ScheduledToRestart.equals(this);
   }
@@ -127,18 +139,6 @@ public enum ApplicationStateSummary implements 
BaseStateSummary {
     return RunningWithBelowThresholdExecutors.ordinal() < this.ordinal() && 
!isTerminated();
   }
 
-  public static final Set<ApplicationStateSummary> infrastructureFailures =
-      Set.of(DriverStartTimedOut, ExecutorsStartTimedOut, SchedulingFailure);
-
-  public static final Set<ApplicationStateSummary> failures =
-      Set.of(
-          DriverStartTimedOut,
-          ExecutorsStartTimedOut,
-          SchedulingFailure,
-          DriverEvicted,
-          Failed,
-          DriverReadyTimedOut);
-
   @Override
   public boolean isFailure() {
     return failures.contains(this);
diff --git 
a/spark-operator/src/main/java/org/apache/spark/k8s/operator/reconciler/ReconcileProgress.java
 
b/spark-operator/src/main/java/org/apache/spark/k8s/operator/reconciler/ReconcileProgress.java
index d59bf4b..fa0879a 100644
--- 
a/spark-operator/src/main/java/org/apache/spark/k8s/operator/reconciler/ReconcileProgress.java
+++ 
b/spark-operator/src/main/java/org/apache/spark/k8s/operator/reconciler/ReconcileProgress.java
@@ -34,7 +34,7 @@ import lombok.Data;
  * the frequency
  */
 @Data
-public class ReconcileProgress {
+public final class ReconcileProgress {
   private boolean completed;
   boolean requeue;
   private Duration requeueAfterDuration;
diff --git 
a/spark-operator/src/test/java/org/apache/spark/k8s/operator/utils/TestUtils.java
 
b/spark-operator/src/test/java/org/apache/spark/k8s/operator/utils/TestUtils.java
index 6320263..14bac50 100644
--- 
a/spark-operator/src/test/java/org/apache/spark/k8s/operator/utils/TestUtils.java
+++ 
b/spark-operator/src/test/java/org/apache/spark/k8s/operator/utils/TestUtils.java
@@ -63,9 +63,7 @@ public class TestUtils {
     return System.currentTimeMillis() - startTime;
   }
 
-  public static <T> T setConfigKey(ConfigOption<T> configKey, T newValue) {
-    T originalPropertyValue = configKey.getValue();
+  public static <T> void setConfigKey(ConfigOption<T> configKey, T newValue) {
     Whitebox.setInternalState(configKey, "defaultValue", newValue);
-    return originalPropertyValue;
   }
 }
diff --git 
a/spark-submission-worker/src/main/java/org/apache/spark/k8s/operator/SparkAppDriverConf.java
 
b/spark-submission-worker/src/main/java/org/apache/spark/k8s/operator/SparkAppDriverConf.java
index f2870a2..30ed041 100644
--- 
a/spark-submission-worker/src/main/java/org/apache/spark/k8s/operator/SparkAppDriverConf.java
+++ 
b/spark-submission-worker/src/main/java/org/apache/spark/k8s/operator/SparkAppDriverConf.java
@@ -28,7 +28,7 @@ import org.apache.spark.deploy.k8s.KubernetesVolumeUtils;
 import org.apache.spark.deploy.k8s.submit.KubernetesClientUtils;
 import org.apache.spark.deploy.k8s.submit.MainAppResource;
 
-public class SparkAppDriverConf extends KubernetesDriverConf {
+public final class SparkAppDriverConf extends KubernetesDriverConf {
   private SparkAppDriverConf(
       SparkConf sparkConf,
       String appId,


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to