Merge pull request #55 from nebulab/add-snapshot-specs

Add snapshot specs for countries query

Author: AlessioRocco

solidus_graphql_api.gemspec

@@ -33,5 +33,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rubocop-rspec', '~> 1.33.0'
   s.add_development_dependency 'simplecov', '~> 0.16.1'
   s.add_development_dependency 'sqlite3', '~> 1.4.1'
+  s.add_development_dependency 'timecop', '~> 0.9.1'
   s.add_development_dependency 'with_model', '~> 2.1.2'
 end

spec/integration/countries_spec.rb

@@ -2,18 +2,33 @@
 
 require 'spec_helper'
 
-RSpec.describe "Countries" do
-  include_examples 'query is successful', :countries do
-    let(:country_nodes) { subject.data.countries.nodes }
-    let(:state_nodes) { country_nodes.map { |c| c.states.nodes }.flatten }
-
-    before do
-      create_list(:state, 2)
-      create_list(:state, 2, country_iso: 'IT')
+RSpec.describe_query :countries do
+  connection_field :countries, query: :countries, freeze_date: true do
+    context 'when countries does not exists' do
+      it { expect(subject.data.countries.nodes).to be_empty }
     end
 
-    it { expect(country_nodes).to be_present }
+    context 'when countries exists' do
+      let!(:country) { create(:country, id: 1) }
 
-    it { expect(state_nodes).to be_present }
+      before { create(:country, id: 2, iso: 'IT') }
+
+      it { is_expected.to match_response(:countries) }
+
+      connection_field :states, query: 'countries/states' do
+        context 'when states does not exists' do
+          it { is_expected.to match_response('countries/empty_states') }
+        end
+
+        context 'when states exists' do
+          before do
+            create(:state, id: 1, country: country)
+            create(:state, id: 2, country: country, state_code: 'CA')
+          end
+
+          it { is_expected.to match_response('countries/states') }
+        end
+      end
+    end
   end
 end

spec/lib/solidus_graphql_api/types/country_spec.rb

@@ -5,7 +5,6 @@
 RSpec.describe SolidusGraphqlApi::Types::Query do
   subject { described_class.send(:new, {}, {}) }
 
-  it { expect(described_class.method_defined?(:countries)).to be_truthy }
   it { expect(described_class.method_defined?(:taxonomies)).to be_truthy }
 
   describe '#products' do

spec/lib/solidus_graphql_api/types/query_spec.rb

@@ -15,19 +15,40 @@
 
 require "graphql/schema_comparator"
 require 'with_model'
+require 'timecop'
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
 Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
 
 RSpec.configure do |config|
+  DEFAULT_FREEZE_DATE = "21/12/2012 12:00:00"
+
   config.infer_spec_type_from_file_location!
   config.use_transactional_fixtures = false
   config.include Helpers::Graphql
+  config.include Matchers::Graphql
+
+  # They can be used in the specs to explain better the result of a Graphql query.
+  config.alias_example_group_to :describe_query, type: :graphql_query
+  config.alias_example_group_to :connection_field, type: :graphql_query
+  config.alias_example_group_to :field, type: :graphql_query
 
   config.before(:each) do
     BatchLoader::Executor.clear_current
   end
 
+  config.around(:each, type: :graphql_query) do |example|
+    freeze_date = example.metadata[:freeze_date]
+
+    if freeze_date
+      Timecop.freeze(DateTime.parse(freeze_date.is_a?(String) ? freeze_date : DEFAULT_FREEZE_DATE))
+      example.run
+      Timecop.return
+    else
+      example.run
+    end
+  end
+
   config.extend WithModel
 end

spec/spec_helper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Matchers
+  module Graphql
+    extend RSpec::Matchers::DSL
+
+    matcher :match_response do |query_result_file|
+      match do |actual|
+        template = File.read("spec/support/query_results/#{query_result_file}.json.erb")
+        json_result = ERB.new(template).result_with_hash(@variables || {})
+
+        @expected = JSON.parse(json_result, object_class: @object_class || OpenStruct)
+
+        actual == @expected
+      end
+
+      chain :with_args do |variables|
+        @variables = variables
+      end
+
+      chain :as do |object_class|
+        @object_class = object_class
+      end
+
+      failure_message_when_negated do |actual|
+        "expected that #{actual} would not be equal of #{expected}"
+      end
+
+      diffable
+      attr_reader :expected
+    end
+  end
+end

spec/support/matchers/graphql.rb

@@ -1,23 +1,15 @@
 query {
   countries {
     nodes {
+      createdAt
       id
-      isoName
       iso
       iso3
+      isoName
       name
       numcode
       statesRequired
-      createdAt
       updatedAt
-      states {
-        nodes {
-          name
-          abbr
-          createdAt
-          updatedAt
-        }
-      }
     }
   }
 }

spec/support/queries/countries.gql

@@ -0,0 +1,16 @@
+query {
+  countries {
+    nodes {
+      id
+      states {
+        nodes {
+          abbr
+          createdAt
+          id
+          name
+          updatedAt
+        }
+      }
+    }
+  }
+}

spec/support/queries/countries/states.gql

@@ -0,0 +1,30 @@
+{
+  "data": {
+    "countries": {
+      "nodes": [
+        {
+          "createdAt": "2012-12-21T12:00:00Z",
+          "id": 1,
+          "iso": "US",
+          "iso3": "USA",
+          "isoName": "UNITED STATES",
+          "name": "United States",
+          "numcode": 840,
+          "statesRequired": false,
+          "updatedAt": "2012-12-21T12:00:00Z"
+        },
+        {
+          "createdAt": "2012-12-21T12:00:00Z",
+          "id": 2,
+          "iso": "IT",
+          "iso3": "ITA",
+          "isoName": "ITALY",
+          "name": "Italy",
+          "numcode": 380,
+          "statesRequired": false,
+          "updatedAt": "2012-12-21T12:00:00Z"
+        }
+      ]
+    }
+  }
+}

spec/support/query_results/countries.json.erb

@@ -0,0 +1,20 @@
+{
+  "data": {
+    "countries": {
+      "nodes": [
+        {
+          "id": 1,
+          "states": {
+            "nodes": []
+          }
+        },
+        {
+          "id": 2,
+          "states": {
+            "nodes": []
+          }
+        }
+      ]
+    }
+  }
+}

spec/support/query_results/countries/empty_states.json.erb

@@ -0,0 +1,35 @@
+{
+  "data": {
+    "countries": {
+      "nodes": [
+        {
+          "id": 1,
+          "states": {
+            "nodes": [
+              {
+                "abbr": "AL",
+                "createdAt": "2012-12-21T12:00:00Z",
+                "id": 1,
+                "name": "Alabama",
+                "updatedAt": "2012-12-21T12:00:00Z"
+              },
+              {
+                "abbr": "CA",
+                "createdAt": "2012-12-21T12:00:00Z",
+                "id": 2,
+                "name": "California",
+                "updatedAt": "2012-12-21T12:00:00Z"
+              }
+            ]
+          }
+        },
+        {
+          "id": 2,
+          "states": {
+            "nodes": []
+          }
+        }
+      ]
+    }
+  }
+}

spec/support/query_results/countries/states.json.erb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+RSpec.shared_context "graphql query subject", type: :graphql_query do
+  subject do |example|
+    execute_query(
+      try(:query) || example.metadata[:query],
+      variables: try(:query_variables) || example.metadata[:query_variables],
+      context: try(:query_context) || example.metadata[:query_context]
+    )
+  end
+end