JarCastingScalaCheck Schema
ScalaCheck generators for various Iglu-compatible schema formats.
Installation
The latest version of ScalaCheck Schema is 0.1.0, which is cross-built against Scala 2.11.x and 2.12.x.
If you're using SBT, add the following lines to your build file:
libraryDependencies += "com.snowplowanalytics" %% "scalacheck-schema" % "0.1.0"
Usage
import org.json4s.jackson.parseJson
import com.snowplowanalytics.iglu.schemaddl.jsonschema.Schema
import com.snowplowanalytics.iglu.schemaddl.jsonschema.json4s.Json4sToSchema._
import com.snowplowanalytics.iglu.schemaddl.scalacheck.JsonSchemaGen
val schemaJson = parseJson("""{"type": ["integer", "string"], "maxLength": 10}""")
val schemaObject: Schema = Schema.parse(schemaJson).getOrElse(throw new RuntimeException("Invalid JSON Schema"))
val jsonGen: Gen[JValue] = JsonSchemaGen.json(schemaObject)
Or you can fetch existing Schema from Iglu Registry:
import com.snowplowanalytics.iglu.client.Resolver
import com.snowplowanalytics.iglu.schemaddl.scalacheck.{ IgluSchemas, JsonSchemaGen }
val resolver: Option[Resolver] = ??? // Can be some custom resolver or none for Iglu Central
for {
// Get schema from Iglu Central
schemaJson <- IgluSchemas.lookup(None)("iglu:com.snowplowanalytics.snowplow/geolocation_context/jsonschema/1-1-0")
// Parse as JSON Schema AST
schemaObject <- IgluSchemas.parseSchema(schemaJson)
// Create JSON generateor
gen = schemaObject.map(JsonSchemaGen.json)
// Generate JSON instance compatible with specified schema
json = gen.sample
} yield json
Copyright and License
Snowplow scalacheck-schema is copyright 2018 Snowplow Analytics Ltd.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
