Merge pull request #1336 from yadavan88/validate-test-names

Validation for unit test names

Author: lor6

build.sbt

@@ -715,7 +715,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,75 @@
+/** 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