rspec-graphql-integration 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 39c4ff53e15be806adbd54539c31cd15f92b7733f6161fbbd3d90b4d827d6d23
+  data.tar.gz: '0780649082510a767cc3bf76225539837a1f0bb4caef92b5f610406b7567d5de'
+SHA512:
+  metadata.gz: 26c78cddba206449f656a17f8ec4e0fe4edf6527b1104be5fd490a8e785be56bec083b2f8d21c155c696b201989a0036898c05f59b3576de3f2e0ba1189c2e66
+  data.tar.gz: a6ae1678e9c113928c98c3c45cd3e7ef33aa432cd9a03eb2ceedc80aa350fd8d1e44d2f77417eae5d5925b36ebdc69b386dedae9b89b595b311274ca5ca7e78f

data/lib/rspec/graphql_integration/configuration.rb

@@ -0,0 +1,30 @@
+module RSpec
+  ##
+  # This module sets up GraphQL integration testing for RSpec.
+  module GraphqlIntegration
+    def self.initialize_configuration(config) # rubocop:disable Metrics/MethodLength
+      config.add_setting(:graphql_schema_class, default: nil)
+
+      config.include(RSpec::GraphqlIntegration::Matchers::DeepEq, type: :graphql)
+      config.include(RSpec::GraphqlIntegration::Matchers::MatchGraphqlResponse, type: :graphql)
+
+      config.instance_exec do
+        # This method is inspired by the one from the RSpec::Rails gem.
+        # See https://github.com/rspec/rspec-rails/blob/main/lib/rspec/rails/configuration.rb
+        # => #infer_spec_type_from_file_location!
+        #
+        # It has to be called explicitly in the spec_helper.rb file to be enabled.
+        # See the README for more information.
+        def infer_graphql_spec_type_from_file_location!
+          escaped_path = Regexp.compile("#{%w[spec graphql].join("[\\\\/]")}[\\/]")
+
+          define_derived_metadata(file_path: escaped_path) do |metadata|
+            metadata[:type] ||= :graphql
+          end
+        end
+      end
+    end
+
+    initialize_configuration RSpec.configuration
+  end
+end

data/lib/rspec/graphql_integration/matchers/deep_eq.rb

@@ -0,0 +1,44 @@
+module RSpec
+  module GraphqlIntegration
+    module Matchers
+      ##
+      # This matcher recursively compares nested Ruby Hashes and Arrays while ignoring
+      # the order of elements in Arrays.
+      module DeepEq
+        extend RSpec::Matchers::DSL
+
+        matcher(:deep_eq) { |expected| match { |actual| deep_eq?(actual, expected) } }
+
+        def deep_eq?(actual, expected)
+          return arrays_deep_eq?(actual, expected) if expected.is_a?(Array) && actual.is_a?(Array)
+
+          return hashes_deep_eq?(actual, expected) if expected.is_a?(Hash) && actual.is_a?(Hash)
+
+          expected == actual
+        end
+
+        def arrays_deep_eq?(actual, expected)
+          expected = expected.clone
+
+          actual.each do |array|
+            index = expected.find_index { |element| deep_eq?(array, element) }
+            return false if index.nil?
+
+            expected.delete_at(index)
+          end
+
+          expected.empty?
+        end
+
+        def hashes_deep_eq?(actual, expected)
+          return false if actual.keys.sort != expected.keys.sort
+
+          # TODO: use any or all
+          actual.each { |key, value| return false unless deep_eq?(value, expected[key]) }
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/rspec/graphql_integration/matchers/match_graphql_response.rb

@@ -0,0 +1,115 @@
+module RSpec
+  module GraphqlIntegration
+    module Matchers
+      ##
+      # This module contains the matchers that are used to test GraphQL queries and mutations.
+      module MatchGraphqlResponse
+        extend RSpec::Matchers::DSL
+
+        ##
+        # This error is thrown when a variable is missing that is required for
+        # the GraphQL response matcher.
+        class TestVariableMissing < ArgumentError
+          def initialize(variable_name, example_value)
+            super <<~TEXT
+              Test variable #{variable_name} is missing.
+
+              Please define it, e.g. with:
+              let(:#{variable_name}) { #{example_value} }
+            TEXT
+          end
+        end
+
+        ##
+        # Defines the required variables as a hash for a test that uses
+        # the GraphQL response matcher.
+        #
+        # Key is the variable name, value is an example value.
+        REQUIRED_TEST_VARIABLES = { test_dir: "__FILE__" }.freeze
+
+        matcher(:match_graphql_response) do |_expected| # rubocop:disable Metrics/BlockLength
+          match do |_actual|
+            check_variables!
+
+            # We need to test the responses with be_deep_equal so that we ignore
+            # the order in nested hashes.
+            expect(actual_response).to deep_eq(expected_response)
+          rescue RSpec::Expectations::ExpectationNotMetError => e
+            @error = e
+            raise
+          end
+
+          # For the failure message, we want to show the diff between the actual and
+          # the expected response and the standard eq matcher from RSpec does that best.
+          failure_message { expect(actual_response).to eq(expected_response) }
+
+          def check_variables!
+            REQUIRED_TEST_VARIABLES.each do |variable_name, example_value|
+              unless defined?(send(variable_name))
+                raise TestVariableMissing.new(variable_name, example_value)
+              end
+            end
+          end
+
+          def expected_response
+            expected_response = load_response(test_dir, response_template, response_variables)
+
+            expected_response = [expected_response] unless expected_response.is_a?(Array)
+
+            expected_response
+          end
+
+          def actual_response
+            response =
+              schema_class.execute(
+                load_query(test_dir, query_file),
+                context: context,
+                variables: defined?(request_variables) ? request_variables : {},
+              )
+
+            response.values
+          end
+
+          def schema_class
+            # It's possible to overwrite the schema class if an app has multiple schemas.
+            return schema_class_overwrite if defined?(schema_class_overwrite)
+
+            if RSpec.configuration.graphql_schema_class.nil? && !Object.const_defined?(:Schema)
+              raise "Please define config.graphql_schema_class in your rails_helper.rb"
+            end
+
+            RSpec.configuration.graphql_schema_class
+          end
+        end
+
+        ##
+        # Loads a query in a GraphQL file.
+        #
+        # Example:
+        # load_query(__FILE__, 'current_user/query.graphql'),
+        def load_query(dir, filename)
+          File.read(File.join(File.dirname(dir), filename))
+        end
+
+        ##
+        # Loads a response in a JSON file and substitute the passed variables that
+        # are surrounded by {{...}} in the file.
+        #
+        # Example:
+        # load_response(
+        #   __FILE__,
+        #   'current_user/response.json',
+        #   {
+        #     user_id: user.id,
+        #   },
+        # )
+        def load_response(dir, filename, variables = {})
+          json_file = File.read(File.join(File.dirname(dir), filename))
+          variables.each { |key, value| json_file.gsub!("\"{{#{key}}}\"", JSON.dump(value)) }
+
+          JSON.parse(json_file)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/graphql_integration/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module GraphqlIntegration
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/rspec/graphql_integration.rb

@@ -0,0 +1,6 @@
+require "rspec/core"
+
+require "rspec/graphql_integration/matchers/deep_eq"
+require "rspec/graphql_integration/matchers/match_graphql_response"
+
+require "rspec/graphql_integration/configuration"

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: rspec-graphql-integration
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Gundel
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: prettier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- gundel.peter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rspec/graphql_integration.rb
+- lib/rspec/graphql_integration/configuration.rb
+- lib/rspec/graphql_integration/matchers/deep_eq.rb
+- lib/rspec/graphql_integration/matchers/match_graphql_response.rb
+- lib/rspec/graphql_integration/version.rb
+homepage: https://github.com/peterfication/rspec-graphql-integration
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: An RSpec plugin to simplify integration tests for GraphQL
+test_files: []