chore: use formatter-maven-plugin to automatic code formatting (#505)

Fixes #504

Co-authored-by: Chris Laprun <[email protected]>

Author: lburgazzoli

.github/workflows/master-snapshot-release.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        java: [11, 15]
+        java: [11, 16]
         distribution: [adopt, adopt-openj9]
         kubernetes: ['v1.17.13','v1.18.20','v1.19.14','v1.20.10','v1.21.4']
     steps:

.github/workflows/pr.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        java: [11, 15]
+        java: [11, 16]
         distribution: [ adopt, adopt-openj9 ]
         kubernetes: ['v1.17.13','v1.18.20','v1.19.14','v1.20.10','v1.21.4']
     steps:
@@ -32,7 +32,7 @@ jobs:
           distribution: ${{ matrix.distribution }}
           java-version: ${{ matrix.java }}
       - name: Check code format
-        run: ./mvnw ${MAVEN_ARGS} fmt:check --file pom.xml
+        run: ./mvnw ${MAVEN_ARGS} formatter:validate -Dconfigfile=$PWD/contributing/eclipse-google-style.xml --file pom.xml
       - name: Run unit tests
         run: ./mvnw ${MAVEN_ARGS} -B test --file pom.xml
       - name: Set up Minikube

contributing/eclipse-google-style.xml

@@ -65,7 +65,7 @@
 <setting id="org.eclipse.jdt.core.formatter.comment.format_line_comments" value="true"/>
 <setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_angle_bracket_in_type_arguments" value="do not insert"/>
 <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_declarations" value="insert"/>
-<setting id="org.eclipse.jdt.core.formatter.join_wrapped_lines" value="true"/>
+<setting id="org.eclipse.jdt.core.formatter.join_wrapped_lines" value="false"/>
 <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_block" value="insert"/>
 <setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_explicit_constructor_call" value="16"/>
 <setting id="org.eclipse.jdt.core.formatter.wrap_non_simple_local_variable_annotation" value="true"/>

operator-framework-core/pom.xml

@@ -57,7 +57,6 @@
     </plugins>
   </build>
 
-
   <dependencies>
     <dependency>
       <groupId>io.fabric8</groupId>

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java

@@ -124,8 +124,8 @@ public <R extends CustomResource> void register(ResourceController<R> controller
 
   /**
    * Add a registration requests for the specified controller with this operator, overriding its
-   * default configuration by the specified one (usually created via {@link
-   * io.javaoperatorsdk.operator.api.config.ControllerConfigurationOverrider#override(ControllerConfiguration)},
+   * default configuration by the specified one (usually created via
+   * {@link io.javaoperatorsdk.operator.api.config.ControllerConfigurationOverrider#override(ControllerConfiguration)},
    * passing it the controller's original configuration. The effective registration of the
    * controller is delayed till the operator is started.
    *
@@ -150,8 +150,8 @@ public <R extends CustomResource> void register(
 
   /**
    * Registers the specified controller with this operator, overriding its default configuration by
-   * the specified one (usually created via {@link
-   * io.javaoperatorsdk.operator.api.config.ControllerConfigurationOverrider#override(ControllerConfiguration)},
+   * the specified one (usually created via
+   * {@link io.javaoperatorsdk.operator.api.config.ControllerConfigurationOverrider#override(ControllerConfiguration)},
    * passing it the controller's original configuration.
    *
    * @param controller the controller to register
@@ -241,7 +241,7 @@ private void throwMissingCRDException(String crdName, String specVersion, String
    * but is missing
    *
    * @return {@code true} if the current namespace is requested but is missing, {@code false}
-   *     otherwise
+   *         otherwise
    */
   private static <R extends CustomResource> boolean failOnMissingCurrentNS(
       ControllerConfiguration<R> configuration) {

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/Controller.java

@@ -26,8 +26,8 @@
 
   /**
    * If true, will dispatch new event to the controller if generation increased since the last
-   * processing, otherwise will process all events. See generation meta attribute <a
-   * href="https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#status-subresource">here</a>
+   * processing, otherwise will process all events. See generation meta attribute <a href=
+   * "https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#status-subresource">here</a>
    *
    * @return whether the controller takes generation into account to process events
    */

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/DeleteControl.java

@@ -1,6 +1,5 @@
 package io.javaoperatorsdk.operator.api;
 
 public enum DeleteControl {
-  DEFAULT_DELETE,
-  NO_FINALIZER_REMOVAL
+  DEFAULT_DELETE, NO_FINALIZER_REMOVAL
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/ResourceController.java

@@ -8,22 +8,23 @@ public interface ResourceController<R extends CustomResource> {
   /**
    * The implementation should delete the associated component(s). Note that this is method is
    * called when an object is marked for deletion. After it's executed the custom resource finalizer
-   * is automatically removed by the framework; unless the return value is {@link
-   * DeleteControl#NO_FINALIZER_REMOVAL}, which indicates that the controller has determined that
-   * the resource should not be deleted yet, in which case it is up to the controller to restore the
-   * resource's status so that it's not marked for deletion anymore.
+   * is automatically removed by the framework; unless the return value is
+   * {@link DeleteControl#NO_FINALIZER_REMOVAL}, which indicates that the controller has determined
+   * that the resource should not be deleted yet, in which case it is up to the controller to
+   * restore the resource's status so that it's not marked for deletion anymore.
    *
-   * <p>It's important that this method be idempotent, as it could be called several times,
-   * depending on the conditions and the controller's configuration (for example, if the controller
-   * is configured to not use a finalizer but the resource does have finalizers, it might be be
+   * <p>
+   * It's important that this method be idempotent, as it could be called several times, depending
+   * on the conditions and the controller's configuration (for example, if the controller is
+   * configured to not use a finalizer but the resource does have finalizers, it might be be
    * "offered" again for deletion several times until the finalizers are all removed.
    *
    * @param resource the resource that is marked for deletion
    * @param context the context with which the operation is executed
    * @return {@link DeleteControl#DEFAULT_DELETE} - so the finalizer is automatically removed after
-   *     the call. {@link DeleteControl#NO_FINALIZER_REMOVAL} if you don't want to remove the
-   *     finalizer to indicate that the resource should not be deleted after all, in which case the
-   *     controller should restore the resource's state appropriately.
+   *         the call. {@link DeleteControl#NO_FINALIZER_REMOVAL} if you don't want to remove the
+   *         finalizer to indicate that the resource should not be deleted after all, in which case
+   *         the controller should restore the resource's state appropriately.
    */
   default DeleteControl deleteResource(R resource, Context<R> context) {
     return DeleteControl.DEFAULT_DELETE;
@@ -36,20 +37,20 @@ default DeleteControl deleteResource(R resource, Context<R> context) {
    *
    * @param resource the resource that has been created or updated
    * @param context the context with which the operation is executed
-   * @return The resource is updated in api server if the return value is not {@link
-   *     UpdateControl#noUpdate()}. This the common use cases. However in cases, for example the
-   *     operator is restarted, and we don't want to have an update call to k8s api to be made
-   *     unnecessarily, by returning {@link UpdateControl#noUpdate()} this update can be skipped.
-   *     <b>However we will always call an update if there is no finalizer on object and it's not
-   *     marked for deletion.</b>
+   * @return The resource is updated in api server if the return value is not
+   *         {@link UpdateControl#noUpdate()}. This the common use cases. However in cases, for
+   *         example the operator is restarted, and we don't want to have an update call to k8s api
+   *         to be made unnecessarily, by returning {@link UpdateControl#noUpdate()} this update can
+   *         be skipped. <b>However we will always call an update if there is no finalizer on object
+   *         and it's not marked for deletion.</b>
    */
   UpdateControl<R> createOrUpdateResource(R resource, Context<R> context);
 
   /**
    * In init typically you might want to register event sources.
    *
    * @param eventSourceManager the {@link EventSourceManager} which handles this controller and with
-   *     which event sources can be registered
+   *        which event sources can be registered
    */
   default void init(EventSourceManager eventSourceManager) {}
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java

@@ -24,7 +24,7 @@ <R extends CustomResource> ControllerConfiguration<R> getConfigurationFor(
    * Retrieves the Kubernetes client configuration
    *
    * @return the configuration of the Kubernetes client, defaulting to the provided
-   *     auto-configuration
+   *         auto-configuration
    */
   default Config getClientConfiguration() {
     return Config.autoConfigure(null);
@@ -45,11 +45,13 @@ default Config getClientConfiguration() {
   Version getVersion();
 
   /**
-   * Whether the operator should query the CRD to make sure it's deployed and validate {@link
-   * CustomResource} implementations before attempting to register the associated controllers.
+   * Whether the operator should query the CRD to make sure it's deployed and validate
+   * {@link CustomResource} implementations before attempting to register the associated
+   * controllers.
    *
-   * <p>Note that this might require elevating the privileges associated with the operator to gain
-   * read access on the CRD resources.
+   * <p>
+   * Note that this might require elevating the privileges associated with the operator to gain read
+   * access on the CRD resources.
    *
    * @return {@code true} if CRDs should be checked (default), {@code false} otherwise
    */

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/DefaultRetryConfiguration.java

@@ -1,3 +1,4 @@
 package io.javaoperatorsdk.operator.api.config;
 
-public class DefaultRetryConfiguration implements RetryConfiguration {}
+public class DefaultRetryConfiguration implements RetryConfiguration {
+}