json_schema 0.0.7 → 0.0.9

data/test/commands/validate_schema_test.rb

@@ -0,0 +1,103 @@
+require "test_helper"
+
+require "commands/validate_schema"
+require "tempfile"
+
+describe Commands::ValidateSchema do
+  before do
+    @command = Commands::ValidateSchema.new
+  end
+
+  it "shows usage with no arguments" do
+    success = @command.run([])
+    assert_equal [], @command.errors
+    assert_equal [], @command.messages
+    refute success
+  end
+
+  it "runs successfully in detect mode" do
+    temp_file(basic_schema) do |path|
+      @command.extra_schemas << schema_path
+      @command.detect = true
+      success = @command.run([path])
+      assert_equal [], @command.errors
+      assert_equal ["#{path} is valid."], @command.messages
+      assert success
+    end
+  end
+
+  it "runs successfully out of detect mode" do
+    temp_file(basic_schema) do |path|
+      @command.detect = false
+      success = @command.run([schema_path, path])
+      assert_equal [], @command.errors
+      assert_equal ["#{path} is valid."], @command.messages
+      assert success
+    end
+  end
+
+  it "takes extra schemas" do
+    temp_file(basic_hyper_schema) do |path|
+      @command.detect = false
+      @command.extra_schemas << schema_path
+      success = @command.run([hyper_schema_path, path])
+      assert_equal [], @command.errors
+      assert_equal ["#{path} is valid."], @command.messages
+      assert success
+    end
+  end
+
+  it "requires at least one argument in detect mode" do
+    @command.detect = true
+    success = @command.run([])
+    assert_equal [], @command.errors
+    assert_equal [], @command.messages
+    refute success
+  end
+
+  it "requires at least two arguments out of detect mode" do
+    @command.detect = false
+    success = @command.run([hyper_schema_path])
+    assert_equal [], @command.errors
+    assert_equal [], @command.messages
+    refute success
+  end
+
+  it "errors on invalid files" do
+    @command.detect = false
+    success = @command.run(["dne-1", "dne-2"])
+    assert_equal ["dne-1: No such file or directory."], @command.errors
+    assert_equal [], @command.messages
+    refute success
+  end
+
+  def basic_hyper_schema
+    <<-eos
+      { "$schema": "http://json-schema.org/draft-04/hyper-schema" }
+    eos
+  end
+
+  def basic_schema
+    <<-eos
+      { "$schema": "http://json-schema.org/draft-04/schema" }
+    eos
+  end
+
+  def hyper_schema_path
+    File.expand_path("schema.json", "#{__FILE__}/../../../schemas")
+  end
+
+  def schema_path
+    File.expand_path("schema.json", "#{__FILE__}/../../../schemas")
+  end
+
+  def temp_file(contents)
+    file = Tempfile.new("schema")
+    file.write(contents)
+    file.size() # flush
+    yield(file.path)
+  ensure
+    file.close
+    file.unlink
+  end
+end

data/test/json_reference/reference_test.rb

@@ -0,0 +1,45 @@
+require "test_helper"
+
+require "json_reference"
+
+describe JsonReference::Reference do
+  it "expands a reference without a URI" do
+    ref = reference("#/definitions")
+    assert_equal nil, ref.uri
+    assert_equal "#/definitions", ref.pointer
+  end
+
+  it "expands a reference with a URI" do
+    ref = reference("http://example.com#/definitions")
+    assert_equal URI.parse("http://example.com"), ref.uri
+    assert_equal "#/definitions", ref.pointer
+  end
+
+  it "expands just a root sign" do
+    ref = reference("#")
+    assert_equal nil, ref.uri
+    assert_equal "#", ref.pointer
+  end
+
+  it "expands a URI with just a root sign" do
+    ref = reference("http://example.com#")
+    assert_equal URI.parse("http://example.com"), ref.uri
+    assert_equal "#", ref.pointer
+  end
+
+  it "normalizes pointers by adding a root sign prefix" do
+    ref = reference("/definitions")
+    assert_equal nil, ref.uri
+    assert_equal "#/definitions", ref.pointer
+  end
+
+  it "normalizes pointers by stripping a trailing slash" do
+    ref = reference("#/definitions/")
+    assert_equal nil, ref.uri
+    assert_equal "#/definitions", ref.pointer
+  end
+
+  def reference(str)
+    JsonReference::Reference.new(str)
+  end
+end

data/test/json_schema/parser_test.rb

@@ -86,12 +86,29 @@ describe JsonSchema::Parser do
 
   it "parses the basic set of object validations" do
     schema = parse.definitions["app"]
-    assert_equal false, schema.additional_properties
     assert_equal 10, schema.max_properties
     assert_equal 1, schema.min_properties
     assert_equal ["name"], schema.required
   end
 
+  it "parses the additionalProperties object validation as boolean" do
+    pointer("#/definitions/app").merge!(
+      "additionalProperties" => false
+    )
+    schema = parse.definitions["app"]
+    assert_equal false, schema.additional_properties
+  end
+
+  it "parses the additionalProperties object validation as schema" do
+    pointer("#/definitions/app").merge!(
+      "additionalProperties" => {
+        "type" => "boolean"
+      }
+    )
+    schema = parse.definitions["app"].additional_properties
+    assert_equal ["boolean"], schema.type
+  end
+
   it "parses the dependencies object validation" do
     schema = parse.definitions["app"]
     assert_equal ["ssl"], schema.dependencies["production"]

data/test/json_schema/reference_expander_test.rb

@@ -4,36 +4,46 @@ require "json_schema"
 
 describe JsonSchema::ReferenceExpander do
   it "expands references" do
-    assert expand
+    expand
+    assert_equal [], errors
 
     # this was always a fully-defined property
     referenced = @schema.definitions["app"]
     # this used to be a $ref
     reference = @schema.properties["app"]
 
-    assert_nil reference.reference
+    assert_equal "#/definitions/app", reference.reference.pointer
     assert_equal referenced.description, reference.description
     assert_equal referenced.id, reference.id
     assert_equal referenced.type, reference.type
     assert_equal referenced.uri, reference.uri
   end
 
+  it "takes a document store" do
+    store = JsonSchema::DocumentStore.new
+    expand(store: store)
+    assert store.lookup_uri("/")
+  end
+
   it "will expand anyOf" do
-    assert expand
+    expand
+    assert_equal [], errors
     schema = @schema.properties["app"].definitions["contrived_plus"]
     assert_equal 3, schema.any_of[0].min_length
     assert_equal 5, schema.any_of[1].min_length
   end
 
   it "will expand allOf" do
-    assert expand
+    expand
+    assert_equal [], errors
     schema = @schema.properties["app"].definitions["contrived_plus"]
     assert_equal 30, schema.all_of[0].max_length
     assert_equal 3, schema.all_of[1].min_length
   end
 
   it "will expand dependencies" do
-    assert expand
+    expand
+    assert_equal [], errors
     schema = @schema.properties["app"].dependencies["ssl"].properties["name"]
     assert_equal ["string"], schema.type
   end
@@ -44,7 +54,8 @@ describe JsonSchema::ReferenceExpander do
         "$ref" => "#/definitions/app/definitions/name"
       }
     )
-    assert expand
+    expand
+    assert_equal [], errors
     schema = @schema.properties["app"].properties["flags"].items
     assert_equal ["string"], schema.type
   end
@@ -56,7 +67,8 @@ describe JsonSchema::ReferenceExpander do
         { "$ref" => "#/definitions/app/definitions/owner" }
       ]
     )
-    assert expand
+    expand
+    assert_equal [], errors
     schema0 = @schema.properties["app"].properties["flags"].items[0]
     schema1 = @schema.properties["app"].properties["flags"].items[0]
     assert_equal ["string"], schema0.type
@@ -64,20 +76,33 @@ describe JsonSchema::ReferenceExpander do
   end
 
   it "will expand oneOf" do
-    assert expand
+    expand
+    assert_equal [], errors
     schema = @schema.properties["app"].definitions["contrived_plus"]
     assert_equal /^(foo|aaa)$/, schema.one_of[0].pattern
     assert_equal /^(foo|zzz)$/, schema.one_of[1].pattern
   end
 
   it "will expand not" do
-    assert expand
+    expand
+    assert_equal [], errors
     schema = @schema.properties["app"].definitions["contrived_plus"]
     assert_equal /^$/, schema.not.pattern
   end
 
+  it "will expand additionalProperties" do
+    pointer("#").merge!(
+      "additionalProperties" => { "$ref" => "#" }
+    )
+    expand
+    assert_equal [], errors
+    schema = @schema.additional_properties
+    assert_equal ["object"], schema.type
+  end
+
   it "will expand patternProperties" do
-    assert expand
+    expand
+    assert_equal [], errors
     # value ([1]) of the #first tuple in hash
     schema = @schema.properties["app"].definitions["roles"].
       pattern_properties.first[1]
@@ -85,51 +110,68 @@ describe JsonSchema::ReferenceExpander do
   end
 
   it "will expand hyperschema link schemas" do
-    assert expand
+    expand
+    assert_equal [], errors
     schema = @schema.properties["app"].links[0].schema.properties["name"]
     assert_equal ["string"], schema.type
   end
 
   it "will perform multiple passes to resolve all references" do
-    schema_sample["properties"] = {
-      "app" => {
-        "$ref" => "#/properties/my-app"
-      },
-      "my-app" => {
-        "$ref" => "#/definitions/app"
-      }
-    }
-    assert expand
+    pointer("#/properties").merge!(
+      "app0" => { "$ref" => "#/properties/app1" },
+      "app1" => { "$ref" => "#/properties/app2" },
+      "app2" => { "$ref" => "#/definitions/app" },
+    )
+    expand
+    assert_equal [], errors
+    schema = @schema.properties["app0"]
+    assert_equal ["object"], schema.type
+  end
+
+  it "will resolve circular dependencies" do
+    pointer("#/properties").merge!(
+      "app" => { "$ref" => "#" }
+    )
+    expand
+    assert_equal [], errors
+    schema = @schema.properties["app"]
+    assert_equal ["object"], schema.type
   end
 
   it "errors on a JSON Pointer that can't be resolved" do
-    schema_sample["properties"]["app"] = {
-      "$ref" => "#/definitions/nope"
-    }
+    pointer("#/properties").merge!(
+      "app" => { "$ref" => "#/definitions/nope" }
+    )
     refute expand
-    assert_includes error_messages,
+    assert_includes errors,
       %{Couldn't resolve pointer "#/definitions/nope".}
+    assert_includes errors,
+      %{Couldn't resolve references: #/definitions/nope.}
   end
 
-  it "errors on a schema that can't be resolved" do
-    schema_sample["properties"]["app"] = {
-      "$ref" => "/schemata/user#/definitions/name"
-    }
+  it "errors on a URI that can't be resolved" do
+    pointer("#/properties").merge!(
+      "app" => { "$ref" => "/schemata/user#/definitions/name" }
+    )
     refute expand
-    assert_includes error_messages,
-      %{Couldn't resolve references (possible circular dependency): /schemata/user#/definitions/name.}
+    assert_includes errors,
+      %{Couldn't resolve references: /schemata/user#/definitions/name.}
+    assert_includes errors, %{Couldn't resolve URI: /schemata/user.}
   end
 
-  it "errors on a circular reference" do
-    schema_sample["definitions"]["app"] = {
-      "$ref" => "#/properties/app"
-    }
+  it "errors on a reference cycle" do
+    pointer("#/properties").merge!(
+      "app0" => { "$ref" => "#/properties/app2" },
+      "app1" => { "$ref" => "#/properties/app0" },
+      "app2" => { "$ref" => "#/properties/app1" },
+    )
     refute expand
-    assert_includes error_messages,
-      %{Couldn't resolve references (possible circular dependency): #/definitions/app.}
+    properties = "#/properties/app0, #/properties/app1, #/properties/app2"
+    assert_includes errors, %{Reference cycle detected: #{properties}.}
+    assert_includes errors, %{Couldn't resolve references: #{properties}.}
   end
 
-  def error_messages
+  def errors
     @expander.errors.map { |e| e.message }
   end
 
@@ -141,9 +183,9 @@ describe JsonSchema::ReferenceExpander do
     @schema_sample ||= DataScaffold.schema_sample
   end
 
-  def expand
+  def expand(options = {})
     @schema = JsonSchema::Parser.new.parse!(schema_sample)
     @expander = JsonSchema::ReferenceExpander.new
-    @expander.expand(@schema)
+    @expander.expand(@schema, options)
   end
 end

data/test/json_schema/validator_test.rb

@@ -291,7 +291,15 @@ describe JsonSchema::Validator do
       %{Expected data to be a multiple of 0.01, value was: 0.005.}
   end
 
-  it "validates additionalProperties" do
+  it "validates additionalProperties boolean successfully" do
+    pointer("#/definitions/app").merge!(
+      "additionalProperties" => true
+    )
+    data_sample["foo"] = "bar"
+    assert validate
+  end
+
+  it "validates additionalProperties boolean unsuccessfully" do
     pointer("#/definitions/app").merge!(
       "additionalProperties" => false
     )
@@ -300,6 +308,28 @@ describe JsonSchema::Validator do
     assert_includes error_messages, %{Extra keys in object: foo.}
   end
 
+  it "validates additionalProperties schema successfully" do
+    pointer("#/definitions/app").merge!(
+      "additionalProperties" => {
+        "type" => ["boolean"]
+      }
+    )
+    data_sample["foo"] = true
+    assert validate
+  end
+
+  it "validates additionalProperties schema unsuccessfully" do
+    pointer("#/definitions/app").merge!(
+      "additionalProperties" => {
+        "type" => ["boolean"]
+      }
+    )
+    data_sample["foo"] = 4
+    refute validate
+    assert_includes error_messages,
+      %{Expected data to be of type "boolean"; value was: 4.}
+  end
+
   it "validates simple dependencies" do
     pointer("#/definitions/app/dependencies").merge!(
       "production" => "ssl"
@@ -516,7 +546,25 @@ describe JsonSchema::Validator do
       %{Expected data to match "ipv6" format, value was: 1::3:4:5:6:7:8:9.}
   end
 
-  it "validates uri format successfully" do
+  it "validates regex format successfully" do
+    pointer("#/definitions/app/definitions/owner").merge!(
+      "format" => "regex"
+    )
+    data_sample["owner"] = "^owner@heroku\.com$"
+    assert validate
+  end
+
+  it "validates regex format successfully" do
+    pointer("#/definitions/app/definitions/owner").merge!(
+      "format" => "regex"
+    )
+    data_sample["owner"] = "^owner($"
+    refute validate
+    assert_includes error_messages,
+      %{Expected data to match "regex" format, value was: ^owner($.}
+  end
+
+  it "validates absolute uri format successfully" do
     pointer("#/definitions/app/definitions/owner").merge!(
       "format" => "uri"
     )
@@ -524,14 +572,22 @@ describe JsonSchema::Validator do
     assert validate
   end
 
+  it "validates relative uri format successfully" do
+    pointer("#/definitions/app/definitions/owner").merge!(
+      "format" => "uri"
+    )
+    data_sample["owner"] = "schemata/app"
+    assert validate
+  end
+
   it "validates uri format unsuccessfully" do
     pointer("#/definitions/app/definitions/owner").merge!(
       "format" => "uri"
     )
-    data_sample["owner"] = "example.com"
+    data_sample["owner"] = "http://"
     refute validate
     assert_includes error_messages,
-      %{Expected data to match "uri" format, value was: example.com.}
+      %{Expected data to match "uri" format, value was: http://.}
   end
 
   it "validates uuid format successfully" do