Fix typos, remove unnecessary braces, add editorconfig

Author: kevinwallimann

.editorconfig

@@ -0,0 +1,21 @@
+# top-most EditorConfig file
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+
+[*.xml]
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+
+[*.{java,scala,js,json,css}]
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+
+[*.md]
+trim_trailing_whitespace = false

component-scanner/src/test/scala/za/co/absa/hyperdrive/scanner/JarTestUtils.scala

@@ -22,6 +22,8 @@ import java.util.jar.{Attributes, JarEntry, JarOutputStream, Manifest}
 
 object JarTestUtils {
 
+  val BUFFER_SIZE = 1024
+
   def createJar(baseDir: File, jarName: String, filenames: List[String]): File = {
     val content = filenames.map(filename => new File(getClass.getClassLoader.getResource(filename).toURI) -> filename).toMap
     JarTestUtils.createJar(baseDir, jarName, content)
@@ -44,7 +46,7 @@ object JarTestUtils {
   private def addEntries(destJarFile: File, manifest: Manifest, content: Map[File, String]): Unit = {
     val outputJar = new JarOutputStream(new FileOutputStream(destJarFile.getAbsolutePath), manifest)
     content.foreach(entry => add(entry._1, entry._2, outputJar))
-    outputJar.close();
+    outputJar.close()
   }
 
   @throws[IOException]
@@ -59,7 +61,7 @@ object JarTestUtils {
 
       val in = new BufferedInputStream(new FileInputStream(source))
 
-      val buffer = new Array[Byte](1024)
+      val buffer = new Array[Byte](BUFFER_SIZE)
 
       var count = in.read(buffer)
       while (count != -1) {

component-scanner/src/test/scala/za/co/absa/hyperdrive/scanner/TestObjectScanner.scala

@@ -18,7 +18,7 @@
 package za.co.absa.hyperdrive.scanner
 
 import java.io.File
-import java.nio.file.{Files, Path}
+import java.nio.file.Files
 
 import org.scalatest.{FlatSpec, Matchers}
 import za.co.absa.hyperdrive.ingestor.api.decoder.StreamDecoderFactory

component-scanner/src/test/scala/za/co/absa/hyperdrive/scanner/dummyjar/AbstractDummyStreamReaderFactory.scala

@@ -19,4 +19,4 @@ package za.co.absa.hyperdrive.scanner.dummyjar
 
 import za.co.absa.hyperdrive.ingestor.api.reader.StreamReaderFactory
 
-abstract class AbstractDummyStreamReaderFactory extends StreamReaderFactory {}
+abstract class AbstractDummyStreamReaderFactory extends StreamReaderFactory

component-scanner/src/test/scala/za/co/absa/hyperdrive/scanner/dummyjar/DummyStreamReaderOne.scala

@@ -20,7 +20,7 @@ package za.co.absa.hyperdrive.scanner.dummyjar
 import org.apache.commons.configuration2.Configuration
 import org.apache.spark.sql.SparkSession
 import org.apache.spark.sql.streaming.DataStreamReader
-import za.co.absa.hyperdrive.ingestor.api.reader.{StreamReader, StreamReaderFactory}
+import za.co.absa.hyperdrive.ingestor.api.reader.StreamReader
 
 class DummyStreamReaderOne extends DummyTrait {
   override def read(spark: SparkSession): DataStreamReader = ???

component-scanner/src/test/scala/za/co/absa/hyperdrive/scanner/dummyjar/DummyStreamReaderTwo.scala

@@ -20,7 +20,7 @@ package za.co.absa.hyperdrive.scanner.dummyjar
 import org.apache.commons.configuration2.Configuration
 import org.apache.spark.sql.SparkSession
 import org.apache.spark.sql.streaming.DataStreamReader
-import za.co.absa.hyperdrive.ingestor.api.reader.{StreamReader, StreamReaderFactory}
+import za.co.absa.hyperdrive.ingestor.api.reader.StreamReader
 
 class DummyStreamReaderTwo extends DummyTrait {
   override def read(spark: SparkSession): DataStreamReader = ???

component-scanner/src/test/scala/za/co/absa/hyperdrive/scanner/dummyjar/DummyTrait.scala

@@ -19,6 +19,4 @@ package za.co.absa.hyperdrive.scanner.dummyjar
 
 import za.co.absa.hyperdrive.ingestor.api.reader.StreamReader
 
-trait DummyTrait extends StreamReader {
-
-}
+trait DummyTrait extends StreamReader

driver/src/main/scala/za/co/absa/hyperdrive/driver/SparkIngestor.scala

@@ -85,7 +85,7 @@ object SparkIngestor {
       ingestionQuery.stop()
     } catch {
       case NonFatal(e) =>
-        throw new IngestionException(message = s"PROBABLY FAILED INGESTION $ingestionId. The was no error in the query plan, but something when wrong. " +
+        throw new IngestionException(message = s"PROBABLY FAILED INGESTION $ingestionId. There was no error in the query plan, but something when wrong. " +
           s"Pay attention to this exception since the query has been started, which might lead to duplicate data or similar issues. " +
           s"The logs should have enough detail, but a possible course of action is to replay this ingestion and overwrite the destination.", e)
     }

driver/src/main/scala/za/co/absa/hyperdrive/driver/drivers/PropertiesIngestionDriver.scala

@@ -35,7 +35,7 @@ object PropertiesIngestionDriver extends IngestionDriver {
   def main(args: Array[String]): Unit = {
     val propertiesFile = getPropertiesFilePath(args)
     if (propertiesFile.isEmpty) {
-      throw new IllegalArgumentException("No properties file informed.")
+      throw new IllegalArgumentException("No properties file supplied.")
     }
 
     if (isInvalid(propertiesFile.get)) {

ingestor-default/src/main/scala/za/co/absa/hyperdrive/ingestor/implementation/reader/kafka/KafkaStreamReader.scala

@@ -140,7 +140,7 @@ object KafkaStreamReader extends StreamReaderFactory {
     }
   }
 
-  private def findMissingKeys(keys: Seq[String], map: Map[String,String]): Seq[String] = keys.filterNot(map.contains(_))
+  private def findMissingKeys(keys: Seq[String], map: Map[String,String]): Seq[String] = keys.filterNot(map.contains)
 
   private def tweakKeyName(key: String): String = {
     key.replace(s"$rootComponentConfKey.", "") // remove the component root configuration key

shared/src/test/scala/za/co/absa/hyperdrive/shared/utils/classloaderutils/TestClassLoaderUtilsNoSingleton.scala

@@ -17,6 +17,4 @@
 
 package za.co.absa.hyperdrive.shared.utils.classloaderutils
 
-class TestClassLoaderUtilsNoSingleton {
-
-}
+class TestClassLoaderUtilsNoSingleton

shared/src/test/scala/za/co/absa/hyperdrive/shared/utils/classloaderutils/TestClassLoaderUtilsNotInstanceOf.scala

@@ -17,6 +17,4 @@
 
 package za.co.absa.hyperdrive.shared.utils.classloaderutils
 
-object TestClassLoaderUtilsNotInstanceOf {
-
-}
+object TestClassLoaderUtilsNotInstanceOf

shared/src/test/scala/za/co/absa/hyperdrive/shared/utils/classloaderutils/TestClassLoaderUtilsSingletonInstanceOf.scala

@@ -17,6 +17,4 @@
 
 package za.co.absa.hyperdrive.shared.utils.classloaderutils
 
-object TestClassLoaderUtilsSingletonInstanceOf extends TestClassLoaderUtilsTestTrait {
-
-}
+object TestClassLoaderUtilsSingletonInstanceOf extends TestClassLoaderUtilsTestTrait

shared/src/test/scala/za/co/absa/hyperdrive/shared/utils/classloaderutils/TestClassLoaderUtilsTestTrait.scala

@@ -17,6 +17,4 @@
 
 package za.co.absa.hyperdrive.shared.utils.classloaderutils
 
-trait TestClassLoaderUtilsTestTrait {
-
-}
+trait TestClassLoaderUtilsTestTrait

testutils/src/main/scala/za/co/absa/hyperdrive/testutils/SparkTestUtils.scala

@@ -18,6 +18,8 @@ package za.co.absa.hyperdrive.testutils
 
 import org.apache.spark.sql.types.{ArrayType, StructField, StructType}
 
+import scala.annotation.tailrec
+
 object SparkTestUtils {
 
   def areAllFieldsNullable(schema: StructType): Boolean = {
@@ -40,6 +42,7 @@ object SparkTestUtils {
     }
   }
 
+  @tailrec
   private def isExpectedNullabilityForAll(arrayType: ArrayType, expectedNullability: Boolean): Boolean = {
     arrayType.elementType match {
       case dt: ArrayType => isExpectedNullabilityForAll(dt, expectedNullability)