api-validator 0.0.1

data/spec/json_validator_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+require 'faraday'
+
+require 'support/validator_shared_examples'
+
+describe ApiValidator::Json do
+  let(:env) { HashWrapper.new(:status => 200, :response_headers => {}, :body => '') }
+  let(:response) { Faraday::Response.new(env) }
+  let(:validator) { stub(:everything) }
+  let(:instance) { described_class.new(expected_properties) }
+  let(:expectation_key) { :response_body }
+
+  let(:res) { instance.validate(response) }
+
+  describe "#validate" do
+    let(:expected_properties) do
+      {
+        :water => {
+          :fire => "air",
+          :coords => {
+            :lat => "-19.65",
+            :lng => "86.86"
+          }
+        },
+        :air => "water fire",
+        :fire => /\Aair/,
+        :altitude => 500_000,
+        :snacks => [
+          {
+            :name => "Chunky Bar",
+            :quantity => 12
+          },
+          {
+            :name => "Celery Sticks",
+            :quantity => 30
+          },
+          {
+            :name => "Peanut Butter Cups",
+            :quantity => 1024
+          },
+          {
+            :name => "Date Squares",
+            :quantity => 256,
+            :ingredients => [["Dates", { :quantity => 4, :units => "cups" }], ["Almonds", { :quantity => 10, :units => "cups" }]]
+          }
+        ]
+      }
+    end
+
+    let(:expected_assertions) do
+      [
+        { :op => "test", :path => "/water/fire", :value => "air" },
+        { :op => "test", :path => "/water/coords/lat", :value => "-19.65" },
+        { :op => "test", :path => "/water/coords/lng", :value => "86.86" },
+        { :op => "test", :path => "/air", :value => "water fire" },
+        { :op => "test", :path => "/fire", :value => "/^air/", :type => "regexp" },
+        { :op => "test", :path => "/altitude", :value => 500_000 },
+        { :op => "test", :path => "/snacks/0/name", :value => "Chunky Bar" },
+        { :op => "test", :path => "/snacks/0/quantity", :value => 12 },
+        { :op => "test", :path => "/snacks/1/name", :value => "Celery Sticks" },
+        { :op => "test", :path => "/snacks/1/quantity", :value => 30 },
+        { :op => "test", :path => "/snacks/2/name", :value => "Peanut Butter Cups" },
+        { :op => "test", :path => "/snacks/2/quantity", :value => 1024 },
+        { :op => "test", :path => "/snacks/3/name", :value => "Date Squares" },
+        { :op => "test", :path => "/snacks/3/quantity", :value => 256 },
+        { :op => "test", :path => "/snacks/3/ingredients/0/0", :value => "Dates" },
+        { :op => "test", :path => "/snacks/3/ingredients/0/1/quantity", :value => 4 },
+        { :op => "test", :path => "/snacks/3/ingredients/0/1/units", :value => "cups" },
+        { :op => "test", :path => "/snacks/3/ingredients/1/0", :value => "Almonds" },
+        { :op => "test", :path => "/snacks/3/ingredients/1/1/quantity", :value => 10 },
+        { :op => "test", :path => "/snacks/3/ingredients/1/1/units", :value => "cups" },
+      ]
+    end
+
+    context "when expectation fails" do
+      it_behaves_like "a validator #validate method"
+
+      before do
+        env.body = {
+          "water" => {
+            "fire" => "very hot",
+            "depth" => 2_000_000_000,
+            "coords" => {
+              "lat" => "-19.65",
+              "type" => "latlng"
+            }
+          },
+          "fire" => "air water fire",
+          "altitude" => 500_000,
+          "type" => "random_data",
+          "snacks" => [
+            {
+              "name" => "Chunky Bar",
+              "quantity" => 12
+            },
+            {
+              "name" => "Celery Sticks",
+              "quantity" => 30
+            },
+            {
+              "name" => "Peanut Butter Cups",
+              "quantity" => 1024
+            },
+            {
+              "name" => "Date Squares",
+              "quantity" => 256,
+              "ingredients" => [["Dates", { "quantity" => 4, "units" => "cups" }], ["Almonds", { "quantity" => 10, "units" => "cups" }]]
+            }
+          ]
+        }
+      end
+
+      let(:expected_failed_assertions) do
+        [
+          { :op => "test", :path => "/water/fire", :value => "air" },
+          { :op => "test", :path => "/water/coords/lng", :value => "86.86" },
+          { :op => "test", :path => "/air", :value => "water fire" }
+        ]
+      end
+
+      let(:expected_diff) do
+        [
+          { :op => "replace", :path => "/water/fire", :value => "air", :current_value => "very hot" },
+          { :op => "add", :path => "/water/coords/lng", :value => "86.86" },
+          { :op => "add", :path => "/air", :value => "water fire" }
+        ]
+      end
+    end
+
+    context "when expectation passes" do
+      it_behaves_like "a validator #validate method"
+
+      before do
+        env.body = {
+          "water" => {
+            "fire" => "air",
+            "depth" => 2_000_000_000,
+            "coords" => {
+              "lat" => "-19.65",
+              "lng" => "86.86",
+              "type" => "latlng"
+            }
+          },
+          "air" => "water fire",
+          "fire" => "air water fire",
+          "altitude" => 500_000,
+          "type" => "random_data",
+          "snacks" => [
+            {
+              "name" => "Chunky Bar",
+              "quantity" => 12
+            },
+            {
+              "name" => "Celery Sticks",
+              "quantity" => 30
+            },
+            {
+              "name" => "Peanut Butter Cups",
+              "quantity" => 1024
+            },
+            {
+              "name" => "Date Squares",
+              "quantity" => 256,
+              "ingredients" => [["Dates", { "quantity" => 4, "units" => "cups" }], ["Almonds", { "quantity" => 10, "units" => "cups" }]]
+            }
+          ]
+        }
+      end
+
+      let(:expected_diff) { [] }
+      let(:expected_failed_assertions) { [] }
+    end
+  end
+end

data/spec/response_expectation_results_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe ApiValidator::ResponseExpectation::Results do
+  let(:request_url) { "http://lindeichmann.example.com/ollie?foo=bar" }
+  let(:request_headers) { { "Accept" => "text/plain" } }
+  let(:request_body) { "Ping" }
+  let(:response_headers) { { "Count" => "285", "Sugar" => "Crack from Mary Poppins" } }
+  let(:response_body) { "Pong" }
+  let(:env) {
+    HashWrapper.new(
+      :status => 200,
+      :request_headers => request_headers,
+      :request_body => request_body,
+      :method => 'get',
+      :url => URI(request_url),
+      :body => response_body,
+      :response_headers => response_headers
+    )
+  }
+  let(:results) {
+    [
+      {
+        :key => :response_headers,
+        :assertions => [
+          { :op => "test", :path => "/Count", :value => "/^\\d+$/", :type => "regexp" }
+        ],
+        :failed_assertions => [],
+        :diff => [],
+        :valid => true
+      },
+      {
+        :key => :response_headers,
+        :assertions => [
+          { :op => "test", :path => "/Sugar", :value => "Sweet" }
+        ],
+        :failed_assertions => [
+          { :op => "test", :path => "/Sugar", :value => "Sweet" }
+        ],
+        :diff => [
+          { :op => "replace", :path => "/Sugar", :value => "Sweet" },
+          { :op => "add", :path => "/Content-Type", :value => "text/plain" }
+        ],
+        :valid => false
+      },
+      {
+        :key => :response_status,
+        :assertions => [
+          { :op => "test", :path => "", :value => 200 }
+        ],
+        :failed_assertions => [],
+        :diff => [],
+        :valid => true
+      }
+    ]
+  }
+  let(:response) { Faraday::Response.new(env) }
+  let(:instance) { described_class.new(response, results) }
+
+  describe "#as_json" do
+    let(:expected_output) {
+      {
+        :expected => {
+          :response_headers => {
+            :assertions => [
+              { :op => "test", :path => "/Count", :value => "/^\\d+$/", :type => "regexp" },
+              { :op => "test", :path => "/Sugar", :value => "Sweet" }
+            ],
+            :failed_assertions => [
+              { :op => "test", :path => "/Sugar", :value => "Sweet" }
+            ],
+            :diff => [
+              { :op => "replace", :path => "/Sugar", :value => "Sweet" },
+              { :op => "add", :path => "/Content-Type", :value => "text/plain" }
+            ],
+            :valid => false
+          },
+          :response_status => {
+            :assertions => [
+              { :op => "test", :path => "", :value => 200 }
+            ],
+            :failed_assertions => [],
+            :diff => [],
+            :valid => true
+          }
+        },
+        :actual => {
+          :request_headers => request_headers,
+          :request_body => request_body,
+          :request_path => "/ollie",
+          :request_params => { "foo" => "bar" },
+          :request_url => request_url,
+          :request_method => 'GET',
+
+          :response_headers => response_headers,
+          :response_body => response_body,
+          :response_status => 200
+        }
+      }
+    }
+
+    it "merges expectation results with actual data" do
+      expect(instance.as_json).to eql(expected_output)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'bundler/setup'
+require 'api-validator'
+require 'support/hash_wrapper'
+require 'mocha/api'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/spec_results_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe ApiValidator::Spec::Results do
+  let(:validator) { stub(:name => "GET /foo") }
+  let(:other_validator) { stub(:name => "with bar") }
+  let(:results) {
+    [
+      {
+        :response_headers => {
+          :assertions => [],
+          :failed_assertions => [],
+          :diff => [],
+          :valid => true
+        }
+      }
+    ]
+  }
+  let(:instance) { described_class.new(validator, results) }
+  let(:other_instance) { described_class.new(other_validator, results) }
+
+  describe "#as_json" do
+    let(:expected_output) {
+      {
+        "GET /foo" => {
+          :results => results
+        }
+      }
+    }
+    it "returns results nested under validator name" do
+      expect(instance.as_json).to eql(expected_output)
+    end
+  end
+
+  describe "#merge!" do
+    let(:expected_output) {
+      {
+        "GET /foo" => {
+          :results => results,
+          "with bar" => {
+            :results => results
+          }
+        }
+      }
+    }
+
+    it "merges given results as children and returns self" do
+      expect(instance.merge!(other_instance)).to eql(instance)
+      expect(instance.results).to eql(expected_output)
+    end
+  end
+end
+

data/spec/spec_spec.rb

@@ -0,0 +1,196 @@
+require 'spec_helper'
+require 'support/shared_examples/validation_declaration'
+require 'support/shared_examples/shared_example_declaration'
+require 'support/shared_examples/shared_example_lookup'
+
+describe ApiValidator::Spec do
+  describe "class methods" do
+    let(:instance) { described_class }
+
+    describe ".describe" do
+      it_behaves_like "a validation declaration" do
+        let(:method_name) { :describe }
+        let(:parent) { nil }
+      end
+    end
+
+    describe ".context" do
+      it_behaves_like "a validation declaration" do
+        let(:method_name) { :describe }
+        let(:parent) { nil }
+      end
+    end
+
+    describe ".shared_example" do
+      it_behaves_like "a shared example declaration"
+    end
+  end
+
+  describe "instance methods" do
+    let(:instance) { described_class.new("foo bar") }
+
+    describe "#describe" do
+      it_behaves_like "a validation declaration" do
+        let(:method_name) { :describe }
+        let(:parent) { instance }
+      end
+    end
+
+    describe "#context" do
+      it_behaves_like "a validation declaration" do
+        let(:method_name) { :context }
+        let(:parent) { instance }
+      end
+    end
+
+    describe "#shared_example" do
+      it_behaves_like "a shared example declaration"
+    end
+
+    describe "#find_shared_example" do
+      let(:block) { lambda {} }
+      let(:name) { :foo }
+
+      context "when example in current instance" do
+        before do
+          instance.shared_examples[name] = block
+        end
+
+        it_behaves_like "shared example lookup"
+      end
+
+      context "when example in parent instance" do
+        before do
+          i = described_class.new("bar baz")
+          instance.instance_eval { @parent = i }
+          i.shared_examples[name] = block
+        end
+
+        it_behaves_like "shared example lookup"
+      end
+
+      context "when example in parent of parent instance" do
+        before do
+          i = described_class.new("bar bar")
+          instance.instance_eval { @parent = i }
+
+          i2 = described_class.new("baz biz")
+          i.instance_eval { @parent = i2 }
+
+          i2.shared_examples[name] = block
+        end
+
+        it_behaves_like "shared example lookup"
+      end
+
+      context "when example in class" do
+        before do
+          described_class.shared_examples[name] = block
+        end
+
+        it_behaves_like "shared example lookup"
+      end
+    end
+
+    describe "#behaves_as" do
+      let(:name) { :bar }
+
+      context "when shared example exists" do
+        it "calls block in scope of validator" do
+          ref = nil
+          example_block = proc { ref = self }
+
+          instance.stubs(:find_shared_example).with(name).returns(example_block)
+          instance.behaves_as(name)
+
+          expect(ref).to eql(instance)
+        end
+      end
+
+      context "when shared example does not exist" do
+        it "raises BehaviourNotFoundError" do
+          expect { instance.behaves_as(name) }.to raise_error(ApiValidator::Spec::BehaviourNotFoundError)
+        end
+      end
+    end
+
+    describe "#expect_response" do
+      it "creates a new response expectation" do
+        expect(instance.expect_response).to be_a(ApiValidator::ResponseExpectation)
+      end
+
+      it "appends expectation to list of expectations" do
+        expect { instance.expect_response }.to change(instance.expectations, :size).by(1)
+      end
+    end
+
+    describe "#run" do
+      it "calls before hooks in context of validator" do
+        ref = nil
+        before_hook = proc { ref = self }
+        instance.before_hooks << before_hook
+
+        instance.run
+        expect(ref).to eql(instance)
+      end
+
+      context "when before hook is an instance method" do
+        it "calls before hooks in context of validator" do
+          ref = nil
+          instance.class.class_eval do
+            define_method :something do
+              ref = self
+            end
+          end
+          instance.before_hooks << instance.method(:something)
+
+          instance.run
+          expect(ref).to eql(instance)
+        end
+      end
+
+      it "executes response expectations" do
+        response_expectation = stub
+        instance.expectations << response_expectation
+
+        response_expectation.expects(:run).returns([])
+        instance.run
+      end
+
+      it "runs child validations" do
+        child = stub
+        instance.validations << child
+
+        child.expects(:run).returns(stub(:results => {}))
+        instance.run
+      end
+
+      it "returns validator results object" do
+        child = described_class.new("biz baz")
+        instance.validations << child
+
+        child.stubs(:run).returns(stub(
+          :results => {
+            "biz baz" => {
+              :results => [
+                { :response_headers => { :valid => true } }
+              ]
+            }
+          }
+        ))
+
+        res = instance.run
+        expect(res.as_json).to eql(
+          instance.name => {
+            :results => [],
+            child.name => {
+              :results => [
+                { :response_headers => { :valid => true } }
+              ]
+            }
+          }
+        )
+      end
+    end
+  end
+end