(test): Support unit tests for IndexName validation

build.sbt

@@ -40,8 +40,8 @@ lazy val library =
         "dev.zio"                       %% "zio-schema"      % "0.3.1",
         "dev.zio"                       %% "zio-schema-json" % "0.3.1",
         "org.apache.commons"             % "commons-lang3"   % "3.12.0",
-        "dev.zio"                       %% "zio-test"        % "2.0.4" % IntegrationTest,
-        "dev.zio"                       %% "zio-test-sbt"    % "2.0.4" % IntegrationTest
+        "dev.zio"                       %% "zio-test"        % "2.0.4" % "it,test",
+        "dev.zio"                       %% "zio-test-sbt"    % "2.0.4" % "it,test"
       ),
       testFrameworks := Seq(new TestFramework("zio.test.sbt.ZTestFramework"))
     )

modules/library/src/main/scala/zio/elasticsearch/package.scala

@@ -26,15 +26,15 @@ package object elasticsearch {
       )
         Left(
           failure(
-            """Index names must meet the following criteria:
-              |   - Must be lower case only
-              |   - Cannot include \\, /, *, ?, ", <, >, |, ` `(space character), `,`(comma), #.
-              |   - Cannot include ":"(since 7.0).
-              |   - Cannot start with -, _, +.
-              |   - Cannot be `.` or `..`.
-              |   - Cannot be longer than 255 bytes (note it is bytes, so multi-byte characters will count towards the 255 limit faster).
-              |   - Names starting with . are deprecated, except for hidden indices and internal indices managed by plugins.
-              |""".stripMargin
+            s"""
+               |   - Must be lower case only
+               |   - Cannot include \\, /, *, ?, ", <, >, |, ` `(space character), `,`(comma), #.
+               |   - Cannot include ":"(since 7.0).
+               |   - Cannot start with -, _, +.
+               |   - Cannot be `.` or `..`.
+               |   - Cannot be longer than 255 bytes (note it is bytes, so multi-byte characters will count towards the 255 limit faster).
+               |   - Names starting with . are deprecated, except for hidden indices and internal indices managed by plugins.
+               |""".stripMargin
           )
         )
       else

modules/library/src/test/scala/zio/elasticsearch/IndexNameSpec.scala

@@ -0,0 +1,54 @@
+package zio.elasticsearch
+
+import zio.prelude.Validation
+import zio.test.Assertion.equalTo
+import zio.test._
+
+object IndexNameSpec extends ZIOSpecDefault {
+
+  override def spec: Spec[TestEnvironment, Any] =
+    suite("IndexName validation")(
+      test("succeed for valid string") {
+        assert(IndexName.make("index-name"))(equalTo(Validation.succeed(IndexName("index-name"))))
+      },
+      test("fail for string containing upper letter") {
+        val invalidIndexStr = "Index-name"
+        assert(IndexName.make(invalidIndexStr))(equalTo(Validation.fail(validationFailedStr(invalidIndexStr))))
+      },
+      test("fail for string containing charachter '*'") {
+        val invalidIndexStr = "index*name"
+        assert(IndexName.make(invalidIndexStr))(equalTo(Validation.fail(validationFailedStr(invalidIndexStr))))
+      },
+      test("fail for string containing charachter ':'") {
+        val invalidIndexStr = "index:name"
+        assert(IndexName.make(invalidIndexStr))(equalTo(Validation.fail(validationFailedStr(invalidIndexStr))))
+      },
+      test("fail for string starting with charachter '-'") {
+        val invalidIndexStr = "-index.name"
+        assert(IndexName.make(invalidIndexStr))(equalTo(Validation.fail(validationFailedStr(invalidIndexStr))))
+      },
+      test("fail for string '.'") {
+        val invalidIndexStr = "."
+        assert(IndexName.make(invalidIndexStr))(equalTo(Validation.fail(validationFailedStr(invalidIndexStr))))
+      },
+      test("fail for string longer than 255 bytes") {
+        checkN(5)(Gen.stringN(256)(Gen.alphaChar)) { invalidIndexStr =>
+          val lowerCaseStr = invalidIndexStr.toLowerCase()
+          assert(IndexName.make(lowerCaseStr.toLowerCase))(
+            equalTo(Validation.fail(validationFailedStr(lowerCaseStr.toLowerCase)))
+          )
+        }
+      }
+    )
+
+  private def validationFailedStr(indexStr: String): String =
+    s"""$indexStr did not satisfy 
+       |   - Must be lower case only
+       |   - Cannot include \\, /, *, ?, ", <, >, |, ` `(space character), `,`(comma), #.
+       |   - Cannot include ":"(since 7.0).
+       |   - Cannot start with -, _, +.
+       |   - Cannot be `.` or `..`.
+       |   - Cannot be longer than 255 bytes (note it is bytes, so multi-byte characters will count towards the 255 limit faster).
+       |   - Names starting with . are deprecated, except for hidden indices and internal indices managed by plugins.
+       |""".stripMargin
+}