govuk-content-schema-test-helpers 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 011b735b77af91d6916c2bc5a2a44738c7b35fa3
-  data.tar.gz: a2604a0fc50abdc8a4354b77e5700d4ef7097cfd
+  metadata.gz: 9f9fcae915c287cae77f19e2f189b9bd6858f23f
+  data.tar.gz: e50af50fca493575e933c982ce0a36749ab83b13
 SHA512:
-  metadata.gz: 18187cd7620e0191b5f4b77a885c923352463bdfc80c859d51827a6e3befe722296a7063bb50a62ef57aafda482f6a52cc6432962e50968411bd084a40f692f6
-  data.tar.gz: aa600d91f64117aed5a63f2f31e082bdd8a8adcfec1d5ca8114b38bd859aee3cbeb221799b53b64692998ad6ab0bcc69063d2a6df1313dcb43bdfc95bc8ec85f
+  metadata.gz: 2428aebd180cbd3a47844240422e4286397010ce29b9ff2f019162db02882af93488ba873239bd1ed3feaa5b0f7413ed6d77aaa9864022e8f47e91b31ab75e0e
+  data.tar.gz: 087633067fe7a5f726935981b4e4aca067ac438e72901316ca30d6a389a07290bf7f4f13cdc918ff0a03001c00a843963daa09be1042de98ae90add2773ae92e

data/README.md

@@ -12,13 +12,13 @@ This app provides test helpers for working with [alphagov/govuk-content-schemas]
 
 - [alphagov/govuk-content-schemas](https://github.com/alphagov/govuk-content-schemas) - contains the examples and schemas returned by this gem
 
-### Usage
+### Usage (Publishers and frontend applications)
 
 #### Configuration and setup
 
 Firstly, you will need a copy of [govuk-content-schemas](http://github.com/alphagov/govuk-content-schemas) on your file system. By default these should be in a sibling directory to your project. Alternatively, you can specify their location with the `GOVUK_CONTENT_SCHEMAS_PATH` environment variable. You should probably duplicate this paragraph (excluding this sentence) in your own `README`.
 
-You will need to configure which type of schemas your app uses. A good place to do this is in `test_helper.rb` or `spec_helper.rb`:
+You will need to configure which type of schemas your app uses. A good place to do this is in `test_helper.rb` or `spec/support/govuk_content_schemas.rb`:
 
 ```ruby
   require 'govuk-content-schema-test-helpers'
@@ -34,22 +34,58 @@ If you are not using Rails, you'll need to set `project_root` differently. Assum
   config.project_root = File.absolute_path(File.join(File.basename(__FILE__), '..'))
 ```
 
-#### Loading an example document
+#### Loading example documents
 
 ```ruby
   GovukContentSchemaTestHelpers::Examples.new.get('finder', 'contacts')
   # => '{ "some": "json" }'
 ```
 
-#### Loading all examples for a given format
-
-
 ```ruby
   GovukContentSchemaTestHelpers::Examples.new.get_all_for_format('case_study')
   # => ['{ "first": "example"}', '{ "second": "example" }']
 ```
 
-This would be useful for checking your app can handle all examples and any that come into existence later:
+#### Frontend contract tests
+
+Check that your app can handle requests for all relevant examples,
+including any added later.
+
+##### RSpec
+
+```ruby
+  require "spec_helper"
+  require "gds_api/test_helpers/content_store"
+
+  RSpec.describe "Schema compatibility", type: :request do
+    include GdsApi::TestHelpers::ContentStore
+
+    before do
+      GovukContentSchemaTestHelpers::Examples.new.get_all_for_format("finder").each do |finder_format|
+        content_item = JSON.parse(finder_format)
+        content_store_has_item(content_item['base_path'], content_item)
+      end
+    end
+
+    all_examples_for_supported_formats = GovukContentSchemaTestHelpers::Examples.new.get_all_for_formats(%w{
+      specialist_document
+    })
+
+    all_examples_for_supported_formats.each do |example|
+      content_item = JSON.parse(example)
+
+      it "can handle a request for #{content_item["base_path"]}" do
+        content_store_has_item(content_item['base_path'], content_item)
+
+        get content_item['base_path']
+        expect(response.status).to eq(200)
+        assert_select 'title', Regexp.new(Regexp.escape(content_item['title']))
+      end
+    end
+  end
+```
+
+##### Test::Unit/Minitest
 
 ```ruby
   def supported_formats
@@ -76,14 +112,17 @@ This would be useful for checking your app can handle all examples and any that
   end
 ```
 
+#### Publisher contract tests
+
+Check that your presenter produces JSON which adheres to the appropriate schema.
 
-#### RSpec matcher
+##### RSpec
 
-To use the built-in RSpec matcher, add this to spec_helper.rb:
+To use the built-in RSpec matcher, add this to `spec/support/govuk_content_schemas.rb`:
 
 ```ruby
   require 'govuk-content-schema-test-helpers/rspec_matchers'
-  include GovukContentSchemaTestHelpers::RSpecMatchers
+  RSpec.configuration.include GovukContentSchemaTestHelpers::RSpecMatchers
 ```
 
 Then:
@@ -98,7 +137,7 @@ or as an argument matcher:
         .with("/first-finder", be_valid_against_schema('finder'))
 ```
 
-#### Test::Unit/Minitest
+##### Test::Unit/Minitest
 
 Setup:
 
@@ -112,10 +151,10 @@ Then in a test:
   assert_valid_against_schema(presented_hash, 'case_study')
 ```
 
-#### Validating against the schema manually
+##### Validating against the schema manually
 
 ```ruby
-  validator = GovukContentSchemaTestHelpers::Validator.new('finder', '{ "some": "json" }')
+  validator = GovukContentSchemaTestHelpers::Validator.new('finder', 'schema', '{ "some": "json" }')
   validator.valid?
   # => false
   validator.errors

data/lib/govuk-content-schema-test-helpers/rspec_matchers.rb

@@ -2,24 +2,76 @@ module GovukContentSchemaTestHelpers
   module RSpecMatchers
     RSpec::Matchers.define :be_valid_against_schema do |schema_name|
       match do |actual|
-        validator = Validator.new(schema_name, actual)
+        validator = Validator.new(schema_name, "schema", actual)
         validator.valid?
       end
 
-      # Required for a helpful message with RSpec 3
-      description do |actual|
-        validator = Validator.new(schema_name, actual)
-        "to be valid against '#{schema_name}' schema. Errors: #{validator.errors}"
+      # `failure_message` is RSpec 3.0, `failure_message_for_should` also works
+      # in 2.X, but deprecated in rspec 3.0.
+      if respond_to?(:failure_message)
+        failure_message do |actual|
+          ValidationErrorMessage.new(schema_name, "schema", actual).message
+        end
+      else
+        failure_message_for_should do |actual|
+          ValidationErrorMessage.new(schema_name, "schema", actual).message
+        end
+      end
+    end
+
+    RSpec::Matchers.define :be_valid_against_links_schema do |schema_name|
+      match do |actual|
+        validator = Validator.new(schema_name, "links", actual)
+        validator.valid?
       end
 
-      if Gem.loaded_specs['rspec-expectations'].version < Gem::Version.new('3.0.0')
-        # Required for a helpful message with RSpec 2
-        # Generates a deprecation warning on 3.2.0
+      # `failure_message` is RSpec 3.0, `failure_message_for_should` also works
+      # in 2.X, but deprecated in rspec 3.0.
+      if respond_to?(:failure_message)
+        failure_message do |actual|
+          ValidationErrorMessage.new(schema_name, "links", actual).message
+        end
+      else
         failure_message_for_should do |actual|
-          validator = Validator.new(schema_name, actual)
-          "to be valid against '#{schema_name}' schema. Errors: #{validator.errors}"
+          ValidationErrorMessage.new(schema_name, "links", actual).message
         end
       end
     end
   end
+
+  class ValidationErrorMessage
+    attr_reader :schema_name, :type, :payload
+
+    def initialize(schema_name, type, payload)
+      @schema_name = schema_name
+      @type = type
+      @payload = payload
+    end
+
+    def message
+<<-doc
+expected the payload to be valid against the '#{schema_name}' schema:
+
+#{formatted_payload}
+
+Validation errors:
+#{errors}
+doc
+    end
+
+  private
+    def errors
+      validator = Validator.new(schema_name, type, payload)
+      validator.errors.map { |message| "- " + humanized_error(message) }.join("\n")
+    end
+
+    def formatted_payload
+      return payload if payload.is_a?(String)
+      JSON.pretty_generate(payload)
+    end
+
+    def humanized_error(message)
+      message.gsub("The property '#/'", "The item")
+    end
+  end
 end

data/lib/govuk-content-schema-test-helpers/test_unit.rb

@@ -1,7 +1,12 @@
 module GovukContentSchemaTestHelpers
   module TestUnit
     def assert_valid_against_schema(content_item_hash, format)
-      validator = GovukContentSchemaTestHelpers::Validator.new(format, content_item_hash.to_json)
+      validator = GovukContentSchemaTestHelpers::Validator.new(format, "schema", content_item_hash.to_json)
+      assert validator.valid?, "JSON not valid against #{format} schema: #{validator.errors.to_s}"
+    end
+
+    def assert_valid_against_links_schema(content_item_hash, format)
+      validator = GovukContentSchemaTestHelpers::Validator.new(format, "links", content_item_hash.to_json)
       assert validator.valid?, "JSON not valid against #{format} schema: #{validator.errors.to_s}"
     end
   end

data/lib/govuk-content-schema-test-helpers/validator.rb

@@ -2,18 +2,12 @@ require 'json-schema'
 
 module GovukContentSchemaTestHelpers
   class Validator
-    # Return the first schema path that exists on the filesystem
-    def self.schema_path(schema_name)
-      paths = candidate_schema_paths(schema_name)
-      paths.detect { |path| File.exists?(path) } ||
-        raise(ImproperlyConfiguredError, "Schema file not found at any of: #{paths.join(', ')}.")
-    end
-
-    # schema_name should be a string, such as 'finder'
-    # document should be a JSON string of the document to validate
-    def initialize(schema_name, document)
+    # @param schema - the format (like `topic`). Use `format.links` for the
+    def initialize(schema_name, variant, document)
       Util.check_govuk_content_schemas_path!
-      @schema_path = GovukContentSchemaTestHelpers::Validator.schema_path(schema_name)
+
+      @schema_name = schema_name
+      @variant = variant
       @document = document
     end
 
@@ -22,22 +16,23 @@ module GovukContentSchemaTestHelpers
     end
 
     def errors
-      @errors ||= JSON::Validator.fully_validate(@schema_path, @document)
+      unless File.exists?(schema_path)
+        raise ImproperlyConfiguredError, "Schema file not found at: #{schema_path}"
+      end
+
+      @errors ||= JSON::Validator.fully_validate(schema_path, @document)
     end
 
   private
-    def self.construct_schema_path(prefix, schema_name)
+    def schema_path
       File.join(
         Util.govuk_content_schemas_path,
-        prefix,
-        schema_name,
+        "dist",
+        "formats",
+        @schema_name,
         GovukContentSchemaTestHelpers.configuration.schema_type,
-        "schema.json"
+        "#{@variant}.json"
       )
     end
-
-    def self.candidate_schema_paths(schema_name)
-      ["dist/formats", "formats"].map { |prefix| construct_schema_path(prefix, schema_name) }
-    end
   end
 end

data/lib/govuk-content-schema-test-helpers/version.rb

@@ -1,3 +1,3 @@
 module GovukContentSchemaTestHelpers
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk-content-schema-test-helpers
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Jamie Cobbett
@@ -67,6 +67,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: This app provides test helpers for working with [alphagov/govuk-content-schemas](https://github.com/alphagov/govuk-content-schemas)
 email:
 - jamie.cobbett@digital.cabinet-office.gov.uk
@@ -106,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Test helpers for working with GOV.UK content schemas