fix: minor fixes (#802)

* fix: e2e test name

* fix: missing javadoc

* fix: typo + javadoc

* fix: simplify assertion

* fix: avoid type masking

Author: metacosm

.github/workflows/e2e-test-mysql.yml

@@ -7,18 +7,18 @@ on:
   push:
     branches:
       - main
-jobs: 
-    tomcat_e2e_test:
-       runs-on: ubuntu-latest
-       env:
-        KIND_CL_NAME: e2e-test
-       steps:
-        - name: Checkout
-          uses: actions/checkout@v2
+jobs:
+  mysql_e2e_test:
+    runs-on: ubuntu-latest
+    env:
+      KIND_CL_NAME: e2e-test
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
 
-        - name: clean resident local docker
-          if: ${{ env.ACT }}
-          continue-on-error: true
+      - name: clean resident local docker
+        if: ${{ env.ACT }}
+        continue-on-error: true
           run: |
             for DIMG in "$KIND_CL_NAME-control-plane "; do
               docker stop $DIMG ; docker rm $DIMG ;

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

@@ -106,7 +106,7 @@ default boolean useFinalizer() {
   /**
    * Allow controllers to filter events before they are provided to the
    * {@link io.javaoperatorsdk.operator.processing.event.EventHandler}. Note that the provided
-   * filter is combined with {@link #isGenerationAware()} to compute the final set of fiolters that
+   * filter is combined with {@link #isGenerationAware()} to compute the final set of filters that
    * should be applied;
    *
    * @return filter

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

@@ -21,7 +21,7 @@ public interface ErrorStatusHandler<T extends HasMetadata> {
    * should not be updates on custom resource after it is marked for deletion.
    *
    * @param resource to update the status on
-   * @param retryInfo
+   * @param retryInfo the current retry status
    * @param e exception thrown from the reconciler
    * @return the updated resource
    */

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/EventSourceManagerTest.java

@@ -133,10 +133,10 @@ void retrievingAnEventSourceWhenMultipleAreRegisteredForATypeShouldRequireAQuali
     assertTrue(exception.getMessage().contains("name1"));
     assertTrue(exception.getMessage().contains("name2"));
 
-    assertTrue(manager.getResourceEventSourceFor(TestCustomResource.class, "name2").get()
-        .equals(eventSource2));
-    assertTrue(manager.getResourceEventSourceFor(TestCustomResource.class, "name1").get()
-        .equals(eventSource));
+    assertEquals(manager.getResourceEventSourceFor(TestCustomResource.class, "name2").get(),
+        eventSource2);
+    assertEquals(manager.getResourceEventSourceFor(TestCustomResource.class, "name1").get(),
+        eventSource);
   }
 
   @Test

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcherTest.java

@@ -83,7 +83,7 @@ private <R extends HasMetadata> ReconciliationDispatcher<R> init(R customResourc
     when(configService.getResourceCloner()).thenReturn(new Cloner() {
       @Override
 
-      public <R extends HasMetadata> R clone(R object) {
+      public <T extends HasMetadata> T clone(T object) {
         return object;
       }
     });

operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/AccumulativeMappingWriter.java

@@ -55,8 +55,8 @@ public AccumulativeMappingWriter add(String key, String value) {
   }
 
   /**
-   * Generates or overrise the resource file with the given path
-   * ({@linkAccumulativeMappingWriter#resourcePath})
+   * Generates or override the resource file with the given path
+   * ({@link AccumulativeMappingWriter#resourcePath})
    */
   public void flush() {
     PrintWriter printWriter = null;