Share validation tests

docs/SCALA-NATIVE.md

@@ -73,9 +73,12 @@ val config = ConfigFactory.parseReader(
 val specialChars = config.getString("fromProps.specialChars")
 ```
 
-### How to read a HOCON configuation file into a String for Scala Native
+In Scala Native `java.io.FileReader` is available so you can create a
+`FileReader` from a `File`.
 
-In order to read the configuration file into a `String` you need to know the relative
+### How to read a HOCON configuation file using Scala Native
+
+In order to read a configuration file you need to know the relative
 path from where the executable was started or use an absolute path. If the 
 Scala Native executable is `run` from `sbt` it will have the current working directory 
 equal to the directory at the base of your project where `sbt` was started. If curious
@@ -88,16 +91,21 @@ println(s"Working Dir: $dir")
 ```
 
 Continuing the same thought process you can use the following code to read the file
-into a `String` from a simple `sbt` project where the `src` directory is at the top
+from a simple `sbt` project where the `src` directory is at the top
 level of your project and you are using the `run` command. If you package your
 application or run the application executable directly, then making the path relative
 to the binary with the code above could be your best option. Another option is to use
-the `"user.home"` or the `"user.dir"` property to configure the file path.
+the `"user.home"` or the `"user.dir"` property to configure the file path. Note: When the
+executable is added to the path, the current working directory is where you start the
+executable from so keep that in mind
 
 ```scala
-import java.nio.file.{Files, Paths}
-val bytes = Files.readAllBytes(Paths.get("src/main/resources/myapp.conf"))
-val configStr = new String(bytes)
+import java.io.File
+val file = new File("src/main/resources/myapp.conf")
+// ConfigDocument
+val configDocument = ConfigDocumentFactory.parseFile(file)
+// or Config
+val config = ConfigFactory.parseFile(file)
 ```
 
 Using this code with the code above gives you a working solution to use `sconfig`

project/plugins.sbt

@@ -5,7 +5,7 @@ resolvers ++= Resolver.sonatypeOssRepos("snapshots")
 val crossVer = "1.3.2"
 val scalaJSVersion = "1.17.0"
 val scalaNativeVersion = "0.5.5"
-val scalafix = "0.12.1"
+val scalafix = "0.13.0"
 
 // includes sbt-dynver sbt-pgp sbt-sonatype sbt-git
 addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.6.1")

sconfig/js/src/main/scala/org/ekrich/config/parser/PlatformConfigDocumentFactory.scala

@@ -1,7 +1,7 @@
 package org.ekrich.config.parser
 
 /**
- * [[ConfigFactoryDocument]] methods for Scala.js platform
+ * [[ConfigDocumentFactory]] methods for Scala.js platform
  */
 abstract class PlatformConfigDocumentFactory
     extends ConfigDocumentFactoryShared {}

sconfig/jvm-native/src/main/scala/org/ekrich/config/parser/ConfigDocumentFactoryJvmNative.scala

@@ -6,7 +6,7 @@ import org.ekrich.config.ConfigParseOptions
 import org.ekrich.config.impl.Parseable
 
 /**
- * [[ConfigFactoryDocument]] methods common to JVM and Native
+ * [[ConfigDocumentFactory]] methods common to JVM and Native
  */
 abstract class ConfigDocumentFactoryJvmNative
     extends ConfigDocumentFactoryShared {

sconfig/jvm-native/src/test/scala/org/ekrich/config/impl/ConfigFactoryDocumentTest.scala

@@ -3,6 +3,6 @@ package org.ekrich.config.impl
 // import org.junit.Assert._
 // import org.junit.Test
 
-class ConfigFactoryDocumentTest {
+class ConfigDocumentFactoryTest {
   // Empty for now - Scala.js has parody with Scala Native for now
 }

sconfig/jvm/src/test/scala/org/ekrich/config/impl/FileUtils.scala → sconfig/jvm-native/src/test/scala/org/ekrich/config/impl/FileUtils.scala

@@ -27,7 +27,7 @@ object FileUtils {
     else ""
 
   val resourceDir = {
-    val f = new File("src/test/resources")
+    val f = TestPath.file()
     if (!f.exists()) {
       val here = new File(".").getAbsolutePath
       throw new Exception(
@@ -39,6 +39,9 @@ object FileUtils {
     f
   }
 
+  // TODO: can't test if file exists because some tests require the absense
+  // of the file. The problem is that later on in the framework, not test
+  // is done so silent failures can occur
   def resourceFile(filename: String): File =
     new File(resourceDir, filename)
 

sconfig/jvm-native/src/test/scala/org/ekrich/config/impl/ValidationFileTest.scala

@@ -0,0 +1,78 @@
+/**
+ * Copyright (C) 2011 Typesafe Inc. <http://typesafe.com>
+ */
+package org.ekrich.config.impl
+
+import org.junit._
+
+import org.ekrich.config.ConfigFactory
+import org.ekrich.config.ConfigParseOptions
+import org.ekrich.config.ConfigException
+import FileUtils._
+
+class ValidationFileTest extends TestUtils {
+  // TODO: There is a problem upstream where an exception is not thrown
+  // when the file does not exist. Added a check in FileUtils for native only
+  // jvm would need it.
+  @Test
+  def validation(): Unit = {
+    val reference = ConfigFactory.parseFile(
+      resourceFile("validate-reference.conf"),
+      ConfigParseOptions.defaults
+    )
+    val conf = ConfigFactory.parseFile(
+      resourceFile("validate-invalid.conf"),
+      ConfigParseOptions.defaults
+    )
+    val e = intercept[ConfigException.ValidationFailed] {
+      conf.checkValid(reference)
+    }
+
+    val expecteds = Seq(
+      Missing("willBeMissing", 1, "number"),
+      WrongType("int3", 7, "number", "object"),
+      WrongType("float2", 9, "number", "boolean"),
+      WrongType("float3", 10, "number", "list"),
+      WrongType("bool1", 11, "boolean", "number"),
+      WrongType("bool3", 13, "boolean", "object"),
+      Missing("object1.a", 17, "string"),
+      WrongType("object2", 18, "object", "list"),
+      WrongType("object3", 19, "object", "number"),
+      WrongElementType("array3", 22, "boolean", "object"),
+      WrongElementType("array4", 23, "object", "number"),
+      WrongType("array5", 24, "list", "number"),
+      WrongType("a.b.c.d.e.f.g", 28, "boolean", "number"),
+      Missing("a.b.c.d.e.f.j", 28, "boolean"),
+      WrongType("a.b.c.d.e.f.i", 30, "boolean", "list")
+    )
+
+    checkValidationException(e, expecteds)
+  }
+
+  @Test
+  def validationWithRoot(): Unit = {
+    val objectWithB = parseObject("""{ b : c }""")
+    val reference = ConfigFactory
+      .parseFile(
+        resourceFile("validate-reference.conf"),
+        ConfigParseOptions.defaults
+      )
+      .withFallback(objectWithB)
+    val conf = ConfigFactory.parseFile(
+      resourceFile("validate-invalid.conf"),
+      ConfigParseOptions.defaults
+    )
+    val e = intercept[ConfigException.ValidationFailed] {
+      conf.checkValid(reference, "a", "b")
+    }
+
+    val expecteds = Seq(
+      Missing("b", 1, "string"),
+      WrongType("a.b.c.d.e.f.g", 28, "boolean", "number"),
+      Missing("a.b.c.d.e.f.j", 28, "boolean"),
+      WrongType("a.b.c.d.e.f.i", 30, "boolean", "list")
+    )
+
+    checkValidationException(e, expecteds)
+  }
+}

sconfig/jvm/src/main/scala/org/ekrich/config/parser/PlatformConfigDocumentFactory.scala

@@ -1,7 +1,7 @@
 package org.ekrich.config.parser
 
 /**
- * [[ConfigFactoryDocument]] methods for Scala JVM platform
+ * [[ConfigDocumentFactory]] methods for Scala JVM platform
  */
 abstract class PlatformConfigDocumentFactory
     extends ConfigDocumentFactoryJvmNative {}

sconfig/jvm/src/test/scala/org/ekrich/config/impl/TestPath.scala

@@ -0,0 +1,8 @@
+package org.ekrich.config.impl
+
+import java.io.File
+
+// See: https://github.com/scala-native/scala-native/issues/4077
+object TestPath {
+  def file(): File = new File("src/test/resources")
+}

sconfig/jvm/src/test/scala/org/ekrich/config/impl/ValidationSerializableTest.scala

@@ -0,0 +1,24 @@
+/**
+ * Copyright (C) 2011 Typesafe Inc. <http://typesafe.com>
+ */
+package org.ekrich.config.impl
+
+import org.junit._
+
+import org.ekrich.config.ConfigException
+
+class ValidationSerializableTest extends TestUtils {
+  @Test
+  def validationFailedSerializable(): Unit = {
+    // Reusing a previous test case to generate an error
+    val reference = parseConfig("""{ a : [{},{},{}] }""")
+    val conf = parseConfig("""{ a : 42 }""")
+    val e = intercept[ConfigException.ValidationFailed] {
+      conf.checkValid(reference)
+    }
+    val expecteds = Seq(WrongType("a", 1, "list", "number"))
+
+    val actual = checkSerializableNoMeaningfulEquals(e)
+    checkValidationException(actual, expecteds)
+  }
+}

sconfig/native/src/main/scala/org/ekrich/config/parser/PlatformConfigDocumentFactory.scala

@@ -1,7 +1,7 @@
 package org.ekrich.config.parser
 
 /**
- * [[ConfigFactoryDocument]] methods for Scala Native platform
+ * [[ConfigDocumentFactory]] methods for Scala Native platform
  */
 abstract class PlatformConfigDocumentFactory
     extends ConfigDocumentFactoryJvmNative {}