Internal script to rename files as per standard (#117)

Fixed naming conventions in all unit tests, added name validation to ci task

Author: yadavan88

build.sbt

@@ -723,7 +723,7 @@ lazy val spark_scala = (project in file("spark-scala"))
 
 addCommandAlias(
   "ci",
-  ";compile;test:compile;it:compile;scalafmtCheckAll;test"
+  ";compile;test:compile;it:compile;scalafmtCheckAll;validateUnitTestNames;test"
 )
 
 addCommandAlias(

cats-effects/src/test/scala/com/baeldung/scala/catseffects/CancellationSpec.scala renamed to cats-effects/src/test/scala/com/baeldung/scala/catseffects/CancellationUnitTest.scala

@@ -10,7 +10,7 @@ import java.util.concurrent.atomic.AtomicBoolean
 
 import scala.concurrent.duration.DurationInt
 
-class CancellationSpec extends AnyWordSpec with Matchers {
+class CancellationUnitTest extends AnyWordSpec with Matchers {
 
   "Cancellation" should {
     "cancel the fiber directly and execute the action on cancellation" in {

cats-effects/src/test/scala/com/baeldung/scala/catseffects/ErrorHandlingSpec.scala renamed to cats-effects/src/test/scala/com/baeldung/scala/catseffects/ErrorHandlingUnitTest.scala

@@ -10,7 +10,7 @@ import org.scalatest.wordspec.AnyWordSpec
 import scala.util.Try
 import scala.util.control.NoStackTrace;
 
-class ErrorHandlingSpec extends AnyWordSpec with Matchers {
+class ErrorHandlingUnitTest extends AnyWordSpec with Matchers {
 
   "Calculator" should {
     "return left value using attempt in case of division by zero" in {

internal-scripts/ClassRenamer.scala

@@ -0,0 +1,72 @@
+/** This is an internal scala-cli script written just to reduce manual work of
+  * renaming files and class names to follow naming standards. This doesn't fully correct all the class names,
+  * however reduces the manual effort by 90%. 
+  */
+//> using toolkit default
+import os._
+
+object RenameClassNames {
+  def main(args: Array[String]): Unit = {
+    val directory = os.pwd / os.up
+
+    os.walk(directory)
+      .filter(_.ext == "scala")
+      .filter(_.toString.contains("src/test/scala"))
+      .filterNot(_.toString.endsWith("UnitTest.scala"))
+      .filter(f =>
+        f.toString.endsWith("Test.scala") || f.toString.endsWith("Spec.scala") || f.toString.endsWith("Tests.scala") || f.toString.endsWith("Suite.scala")
+      )
+      .foreach { _filePath =>
+        val _fileName = _filePath.last
+
+        val newFileName = _filePath.toString
+          .replace("Test.scala", "UnitTest.scala")
+          .replace("Spec.scala", "UnitTest.scala")
+          .replace("Suite.scala", "UnitTest.scala")
+          .replace("Tests.scala", "UnitTest.scala")
+
+        // rename file
+        val newFilePath = os.Path(newFileName)
+        os.move(_filePath, newFilePath)
+
+        val content = os.read(newFilePath)
+        val existingClassName = getClassFromContent(content)
+
+        val fileNameWithoutExtension = newFilePath.last.dropRight(6)
+
+        def isTestClass(existingClassName: String): Boolean = {
+          existingClassName
+            .endsWith("Spec") || existingClassName.endsWith("Test")
+        }
+
+        // Rename the class if it doesn't match the filename
+        if (
+          isTestClass(
+            existingClassName
+          ) && existingClassName.toLowerCase != fileNameWithoutExtension.toLowerCase
+        ) {
+          // Update the content with the new class name
+          val updatedContent = content.replaceAll(
+            s"class\\s+$existingClassName",
+            s"class $fileNameWithoutExtension"
+          )
+
+          // Now, rename the class
+          os.write.over(newFilePath, updatedContent)
+          println(
+            s"Renamed class in ${newFilePath.last} to $fileNameWithoutExtension"
+          )
+        }
+      }
+  }
+
+  // Extract class name from file content
+  def getClassFromContent(content: String): String = {
+    val classNameRegex = """class\s+(\w+)""".r
+    val matchResult = classNameRegex.findFirstMatchIn(content)
+    matchResult match {
+      case Some(m) => m.group(1)
+      case None    => ""
+    }
+  }
+}

play-scala/application-tests/test/com/baeldung/arrival/actions/SourceActionsTest.scala renamed to play-scala/application-tests/test/com/baeldung/arrival/actions/SourceActionsUnitTest.scala

@@ -8,7 +8,7 @@ import play.api.mvc.Headers
 import play.api.mvc.Results.NoContent
 import play.api.test.{FakeRequest, Helpers}
 
-class SourceActionsTest
+class SourceActionsUnitTest
   extends AnyWordSpec
   with SourceActions
   with ScalaFutures {

play-scala/application-tests/test/com/baeldung/arrival/controller/ArrivalControllerH2Test.scala renamed to play-scala/application-tests/test/com/baeldung/arrival/controller/ArrivalControllerH2UnitTest.scala

@@ -11,7 +11,7 @@ import play.api.libs.ws.{WSClient, WSResponse}
 
 import scala.concurrent.Future
 
-class ArrivalControllerH2Test
+class ArrivalControllerH2UnitTest
   extends AnyWordSpec
   with WsScalaTestClient
   with GuiceOneServerPerTest

play-scala/application-tests/test/com/baeldung/arrival/service/ArrivalDecoratorServiceTest.scala renamed to play-scala/application-tests/test/com/baeldung/arrival/service/ArrivalDecoratorServiceUnitTest.scala

@@ -5,7 +5,7 @@ import org.scalatestplus.play.MixedPlaySpec
 import play.api.Configuration
 import play.api.inject.guice.GuiceApplicationBuilder
 
-class ArrivalDecoratorServiceTest extends MixedPlaySpec {
+class ArrivalDecoratorServiceUnitTest extends MixedPlaySpec {
 
   "ArrivalDecoratorService#decorate" should {
     "mark as short an arrival with plane name length = 5" in new App(

play-scala/application-tests/test/com/baeldung/arrival/service/ArrivalServiceH2Test.scala renamed to play-scala/application-tests/test/com/baeldung/arrival/service/ArrivalServiceH2UnitTest.scala

@@ -8,7 +8,7 @@ import org.scalatestplus.play.guice.GuiceOneAppPerTest
 
 import scala.language.postfixOps
 
-class ArrivalServiceH2Test
+class ArrivalServiceH2UnitTest
   extends AnyWordSpec
   with GuiceOneAppPerTest
   with ScalaFutures

play-scala/application-tests/test/com/baeldung/arrival/service/ArrivalServiceIsolatedTest.scala renamed to play-scala/application-tests/test/com/baeldung/arrival/service/ArrivalServiceIsolatedUnitTest.scala

@@ -13,7 +13,7 @@ import org.scalatestplus.play.guice.GuiceOneAppPerTest
 import play.api.inject.guice.GuiceApplicationBuilder
 import play.api.{Application, Configuration, inject}
 
-class ArrivalServiceIsolatedTest
+class ArrivalServiceIsolatedUnitTest
   extends AnyWordSpec
   with GuiceOneAppPerTest
   with ScalaFutures {

play-scala/application-tests/test/com/baeldung/arrival/service/ArrivalServiceMocksTest.scala renamed to play-scala/application-tests/test/com/baeldung/arrival/service/ArrivalServiceMocksUnitTest.scala

@@ -15,7 +15,7 @@ import slick.dbio.{DBIO, SuccessAction}
 
 import scala.concurrent.Future
 
-class ArrivalServiceMocksTest
+class ArrivalServiceMocksUnitTest
   extends AnyWordSpec
   with GuiceOneAppPerTest
   with ScalaFutures

play-scala/dependency-injection/test/guice/service/ServiceWithRemoteCallTest.scala renamed to play-scala/dependency-injection/test/guice/service/ServiceWithRemoteCallUnitTest.scala

@@ -10,7 +10,7 @@ import org.scalatest.wordspec.FixtureAnyWordSpecLike
 import org.scalatestplus.play.MixedFixtures
 import play.api.inject.guice.GuiceApplicationBuilder
 
-class ServiceWithRemoteCallTest
+class ServiceWithRemoteCallUnitTest
   extends MixedFixtures
   with FixtureAnyWordSpecLike {
 

play-scala/dependency-injection/test/macwire/service/ServiceWithRemoteCallTest.scala renamed to play-scala/dependency-injection/test/macwire/service/ServiceWithRemoteCallUnitTest.scala

@@ -3,7 +3,7 @@ package macwire.service
 import macwire.components.{ApiComponents, MockApiComponents, ServiceComponents}
 import org.scalatest.wordspec.AnyWordSpec
 
-class ServiceWithRemoteCallTest extends AnyWordSpec {
+class ServiceWithRemoteCallUnitTest extends AnyWordSpec {
 
   "ServiceWithRemoteCall call" should {
 

reflection/src/test/scala-2/com/baeldung/reflection/JavaReflectionTest.scala renamed to reflection/src/test/scala-2/com/baeldung/reflection/JavaReflectionUnitTest.scala

@@ -2,7 +2,7 @@ package com.baeldung.reflection
 
 import org.junit.Test
 
-class JavaReflectionTest {
+class JavaReflectionUnitTest {
   @Test
   def invoke_method_dynamically(): Unit = {
     val person = Person("John", 20)

reflection/src/test/scala-2/com/baeldung/reflection/ScalaReflectionTest.scala renamed to reflection/src/test/scala-2/com/baeldung/reflection/ScalaReflectionUnitTest.scala

@@ -4,7 +4,7 @@ import org.junit.Test
 
 import scala.reflect.runtime.{universe => ru}
 
-class ScalaReflectionTest {
+class ScalaReflectionUnitTest {
   @Test
   def instantiate_a_class_at_runtime_v1: Unit = {
     val mirror: ru.Mirror = ru.runtimeMirror(getClass.getClassLoader)

scala-2-modules/scala2-core/src/test/scala-2/com/baeldung/scala/macros/GenericMacrosTest.scala renamed to scala-2-modules/scala2-core/src/test/scala-2/com/baeldung/scala/macros/GenericMacrosUnitTest.scala

@@ -3,7 +3,7 @@ package com.baeldung.scala.macros
 import org.scalatest.matchers.must.Matchers
 import org.scalatest.wordspec.AnyWordSpec
 
-class GenericMacrosTest extends AnyWordSpec with Matchers {
+class GenericMacrosUnitTest extends AnyWordSpec with Matchers {
   "generic macro" should {
     "return String for string argument" in {
       GenericMacros.getType("this is a string") mustBe "String"

scala-2-modules/scala2-core/src/test/scala-2/com/baeldung/scala/macros/OddEvenMacrosTest.scala renamed to scala-2-modules/scala2-core/src/test/scala-2/com/baeldung/scala/macros/OddEvenMacrosUnitTest.scala

@@ -3,7 +3,7 @@ package com.baeldung.scala.macros
 import org.scalatest.matchers.must.Matchers
 import org.scalatest.wordspec.AnyWordSpec
 
-class OddEvenMacrosTest extends AnyWordSpec with Matchers {
+class OddEvenMacrosUnitTest extends AnyWordSpec with Matchers {
 
   "def macros" should {
     "return literal odd for odd number" in {

scala-2-modules/scala2-libraries/src/test/scala-2/com/baeldung/scala/async/ScalaAsyncTest.scala renamed to scala-2-modules/scala2-libraries/src/test/scala-2/com/baeldung/scala/async/ScalaAsyncUnitTest.scala

@@ -59,7 +59,7 @@ object ScalaAsyncTest {
   } yield r1 + r2
 }
 
-class ScalaAsyncTest extends AsyncWordSpec with Matchers with ScalaFutures {
+class ScalaAsyncUnitTest extends AsyncWordSpec with Matchers with ScalaFutures {
 
   import ScalaAsyncTest._
 

scala-2-modules/scala2-libraries/src/test/scala-2/com/baeldung/scala/pureconfig/SampleConfigLoader.scala renamed to scala-2-modules/scala2-libraries/src/test/scala-2/com/baeldung/scala/pureconfig/SampleConfigLoaderUnitTest.scala

@@ -12,7 +12,7 @@ import pureconfig.generic.ProductHint
 import pureconfig.error.ConfigReaderException
 import scala.concurrent.duration._
 
-class SampleConfigLoader extends AnyWordSpec with Matchers {
+class SampleConfigLoaderUnitTest extends AnyWordSpec with Matchers {
 
   "pureconfig" should {
     "load config successfully" in {

scala-akka-2/src/test/scala-2/com/baeldung/scala/akka_2/grpc/MessageExchangeServiceTest.scala renamed to scala-akka-2/src/test/scala-2/com/baeldung/scala/akka_2/grpc/MessageExchangeServiceUnitTest.scala

@@ -6,7 +6,7 @@ import akka.testkit.TestKit
 import org.scalatest.BeforeAndAfterAll
 import org.scalatest.wordspec.AsyncWordSpecLike
 
-class MessageExchangeServiceTest
+class MessageExchangeServiceUnitTest
   extends TestKit(ActorSystem("Akka-gRPC"))
   with AsyncWordSpecLike
   with BeforeAndAfterAll {

scala-akka-2/src/test/scala-2/com/baeldung/scala/akka_2/persistence/BankAccountTest.scala renamed to scala-akka-2/src/test/scala-2/com/baeldung/scala/akka_2/persistence/BankAccountUnitTest.scala

@@ -4,7 +4,7 @@ import akka.actor.testkit.typed.scaladsl.ScalaTestWithActorTestKit
 import akka.pattern.StatusReply
 import org.scalatest.wordspec.AnyWordSpecLike
 
-class BankAccountTest extends ScalaTestWithActorTestKit with AnyWordSpecLike {
+class BankAccountUnitTest extends ScalaTestWithActorTestKit with AnyWordSpecLike {
 
   "A Bank Account" should {
     "deposit money to a bank account" in {

scala-akka-2/src/test/scala-2/com/baeldung/scala/akka_2/query_parameters/QueryParametersTest.scala renamed to scala-akka-2/src/test/scala-2/com/baeldung/scala/akka_2/query_parameters/QueryParametersUnitTest.scala

@@ -7,7 +7,7 @@ import akka.http.scaladsl.testkit.ScalatestRouteTest
 import org.scalatest.matchers.should.Matchers
 import org.scalatest.wordspec.AnyWordSpec
 
-class QueryParametersTest
+class QueryParametersUnitTest
   extends AnyWordSpec
   with ScalatestRouteTest
   with Matchers {

scala-akka-2/src/test/scala/com/baeldung/scala/akka/http/routetesting/AkkaRoutesTest.scala renamed to scala-akka-2/src/test/scala/com/baeldung/scala/akka/http/routetesting/AkkaRoutesUnitTest.scala

@@ -7,7 +7,7 @@ import com.baeldung.scala.akka.http.routetesting.AkkaRoutes.routes
 import org.scalatest.flatspec.AnyFlatSpec
 import org.scalatest.matchers.should.Matchers
 
-class AkkaRoutesTest extends AnyFlatSpec with Matchers with ScalatestRouteTest {
+class AkkaRoutesUnitTest extends AnyFlatSpec with Matchers with ScalatestRouteTest {
   "/hello" should "return Hello World!" in {
     Get("/hello") ~> routes ~> check {
       status shouldEqual StatusCodes.OK

scala-akka-2/src/test/scala/com/baeldung/scala/akka/stream/StreamTest.scala renamed to scala-akka-2/src/test/scala/com/baeldung/scala/akka/stream/StreamUnitTest.scala

@@ -7,7 +7,7 @@ import org.scalatest.concurrent.ScalaFutures.convertScalaFuture
 import org.scalatest.flatspec.AnyFlatSpec
 import org.scalatest.matchers.should.Matchers
 
-class StreamTest extends AnyFlatSpec with Matchers {
+class StreamUnitTest extends AnyFlatSpec with Matchers {
   implicit val system: ActorSystem = ActorSystem("baeldung")
 
   "The parse flow" should "parse pairs of integers" in {

scala-akka-3/src/test/scala/com/baeldung/scala/akka/TestService.scala renamed to scala-akka-3/src/test/scala/com/baeldung/scala/akka/TestServiceUnitTest.scala

@@ -5,7 +5,7 @@ import org.scalatest.matchers.should.Matchers
 import org.scalatest.wordspec.AnyWordSpec
 import akka.actor.testkit.typed.scaladsl.ActorTestKit
 
-class TestService extends AnyWordSpec with BeforeAndAfterAll with Matchers {
+class TestServiceUnitTest extends AnyWordSpec with BeforeAndAfterAll with Matchers {
   val testKit = ActorTestKit()
   implicit val system = testKit.system
 

scala-akka-3/src/test/scala/com/baeldung/scala/akka/Tests.scala renamed to scala-akka-3/src/test/scala/com/baeldung/scala/akka/UnitTest.scala

@@ -68,7 +68,7 @@ object ActorTest {
   }
 }
 
-class GreeterTest extends TestService {
+class GreeterUnitTest extends TestServiceUnitTest {
   import scala.concurrent.duration._
   val greeting = "Hello there"
   val sender = testKit.spawn(Greeter(), "greeter")
@@ -80,7 +80,7 @@ class GreeterTest extends TestService {
   probe.expectNoMessage(50.millis)
 }
 
-class TrafficLightTest extends TestService {
+class TrafficLightUnitTest extends TestServiceUnitTest {
   import scala.concurrent.duration._
   val sender = testKit.spawn(TrafficLight(), "traffic")
   val probe = testKit.createTestProbe[TrafficLight.CurrentSignal]()
@@ -106,7 +106,7 @@ class TrafficLightTest extends TestService {
   probe.expectNoMessage(50.millis)
 }
 
-class TrafficLightTestFut extends TestService {
+class TrafficLightTestFutUnitTest extends TestServiceUnitTest {
   import scala.concurrent.duration._
   val sender = testKit.spawn(TrafficLight(), "traffic")
   val duration = 300.millis

scala-akka-3/src/test/scala/com/baeldung/scala/akka/stream/StreamTest.scala renamed to scala-akka-3/src/test/scala/com/baeldung/scala/akka/stream/StreamUnitTest.scala

@@ -7,7 +7,7 @@ import org.scalatest.concurrent.ScalaFutures.convertScalaFuture
 import org.scalatest.flatspec.AnyFlatSpec
 import org.scalatest.matchers.should.Matchers
 
-class StreamTest extends AnyFlatSpec with Matchers {
+class StreamUnitTest extends AnyFlatSpec with Matchers {
   implicit val system: ActorSystem = ActorSystem("baeldung")
 
   "The \"parse\" flow" should "parse pairs of integers" in {

scala-akka/src/test/scala-2/com/baeldung/scala/akka/stopping/GracefulStopActorTest.scala renamed to scala-akka/src/test/scala-2/com/baeldung/scala/akka/stopping/GracefulStopActorUnitTest.scala

@@ -11,7 +11,7 @@ import org.scalatest.wordspec.AnyWordSpecLike
 import scala.concurrent.Await
 import scala.concurrent.duration._
 
-class GracefulStopActorTest
+class GracefulStopActorUnitTest
   extends TestKit(ActorSystem("test_system"))
   with AnyWordSpecLike
   with Matchers

scala-akka/src/test/scala-2/com/baeldung/scala/akka/stopping/PoisonPillActorTest.scala renamed to scala-akka/src/test/scala-2/com/baeldung/scala/akka/stopping/PoisonPillActorUnitTest.scala

@@ -7,7 +7,7 @@ import com.baeldung.scala.akka.stopping.MessageProcessorActor._
 import org.scalatest.matchers.should.Matchers
 import org.scalatest.wordspec.AnyWordSpecLike
 
-class PoisonPillActorTest
+class PoisonPillActorUnitTest
   extends TestKit(ActorSystem("test_system"))
   with AnyWordSpecLike
   with Matchers

scala-akka/src/test/scala-2/com/baeldung/scala/akka/stopping/StopActorTest.scala renamed to scala-akka/src/test/scala-2/com/baeldung/scala/akka/stopping/StopActorUnitTest.scala

@@ -8,7 +8,7 @@ import org.scalatest.matchers.should.Matchers
 import org.scalatest.wordspec.AnyWordSpecLike
 import scala.concurrent.duration._
 
-class StoppingActorTest
+class StopActorUnitTest
   extends TestKit(ActorSystem("test_system"))
   with AnyWordSpecLike
   with Matchers

scala-core-collections-modules/scala-core-collections-2/src/test/scala/com/baeldung/scala/firstmatching/FinderSpec.scala renamed to scala-core-collections-modules/scala-core-collections-2/src/test/scala/com/baeldung/scala/firstmatching/FinderUnitTest.scala

@@ -2,7 +2,7 @@ package com.baeldung.scala.firstmatching
 
 import org.scalatest.wordspec.AnyWordSpec
 
-class FinderSpec extends AnyWordSpec {
+class FinderUnitTest extends AnyWordSpec {
   import Finder._
 
   "A finder" should {

scala-core-collections-modules/scala-core-collections-2/src/test/scala/com/baeldung/scala/flattening/FlattenerSpec.scala renamed to scala-core-collections-modules/scala-core-collections-2/src/test/scala/com/baeldung/scala/flattening/FlattenerUnitTest.scala

@@ -5,7 +5,7 @@ import Flattener._
 
 import scala.collection.immutable.Queue
 
-class FlattenerSpec extends AnyWordSpec {
+class FlattenerUnitTest extends AnyWordSpec {
 
   "A full flattener" should {
     "respect the contents of an already flat sequence" in {

scala-core-collections-modules/scala-core-collections-2/src/test/scala/com/baeldung/scala/lastelement/FinderSpec.scala renamed to scala-core-collections-modules/scala-core-collections-2/src/test/scala/com/baeldung/scala/lastelement/FinderUnitTest.scala

@@ -2,7 +2,7 @@ package com.baeldung.scala.lastelement
 
 import org.scalatest.wordspec.AnyWordSpec
 
-class FinderSpec extends AnyWordSpec {
+class FinderUnitTest extends AnyWordSpec {
   import Finder._
 
   "A last element finder" should {

scala-core-collections-modules/scala-core-collections-2/src/test/scala/com/baeldung/scala/lazylists/SimpleLazyListSpec.scala renamed to scala-core-collections-modules/scala-core-collections-2/src/test/scala/com/baeldung/scala/lazylists/SimpleLazyListUnitTest.scala

@@ -2,7 +2,7 @@ package com.baeldung.scala.lazylists
 
 import org.scalatest.wordspec.AnyWordSpec
 
-class SimpleLazyListSpec extends AnyWordSpec {
+class SimpleLazyListUnitTest extends AnyWordSpec {
   "A list" should {
     "Allow the creation of a one Element list" in {
       assertResult(5)((5 :: SLNil).head)

scala-core-collections-modules/scala-core-collections-2/src/test/scala/com/baeldung/scala/lazylists/SimpleListSpec.scala renamed to scala-core-collections-modules/scala-core-collections-2/src/test/scala/com/baeldung/scala/lazylists/SimpleListUnitTest.scala

@@ -2,7 +2,7 @@ package com.baeldung.scala.lazylists
 
 import org.scalatest.wordspec.AnyWordSpec
 
-class SimpleListSpec extends AnyWordSpec {
+class SimpleListUnitTest extends AnyWordSpec {
   "A list" should {
     "Allow the creation of a one Element list" in {
       assertResult(5)((5 :: SLNil).head)

scala-core-collections-modules/scala-core-collections-2/src/test/scala/com/baeldung/scala/randomfixedsizesample/RandomFixedSizeSampleSpec.scala renamed to scala-core-collections-modules/scala-core-collections-2/src/test/scala/com/baeldung/scala/randomfixedsizesample/RandomFixedSizeSampleUnitTest.scala

@@ -5,7 +5,7 @@ import org.scalatest.matchers.should.Matchers
 
 import scala.annotation.tailrec;
 
-class RandomFixedSizeSampleSpec extends AnyWordSpec with Matchers {
+class RandomFixedSizeSampleUnitTest extends AnyWordSpec with Matchers {
 
   "RandomFixedSizeSample" should {
     "create a random sample out of the initial List" in {