Merge branch 'support_ee_schemas' into 'master'

Support JSON schemas under the `ee` directory for JsonSchemaValidator

See merge request gitlab-org/gitlab!56368

app/validators/json_schema_validator.rb

@@ -13,11 +13,14 @@ class JsonSchemaValidator < ActiveModel::EachValidator
   FILENAME_ALLOWED = /\A[a-z0-9_-]*\Z/.freeze
   FilenameError = Class.new(StandardError)
   JSON_VALIDATOR_MAX_DRAFT_VERSION = 4
+  BASE_DIRECTORY = %w(app validators json_schemas).freeze
 
   def initialize(options)
     raise ArgumentError, "Expected 'filename' as an argument" unless options[:filename]
     raise FilenameError, "Must be a valid 'filename'" unless options[:filename].match?(FILENAME_ALLOWED)
 
+    @base_directory = options.delete(:base_directory) || BASE_DIRECTORY
+
     super(options)
   end
 
@@ -29,6 +32,8 @@ class JsonSchemaValidator < ActiveModel::EachValidator
 
   private
 
+  attr_reader :base_directory
+
   def valid_schema?(value)
     if draft_version > JSON_VALIDATOR_MAX_DRAFT_VERSION
       JSONSchemer.schema(Pathname.new(schema_path)).valid?(value)
@@ -38,10 +43,16 @@ class JsonSchemaValidator < ActiveModel::EachValidator
   end
 
   def schema_path
-    Rails.root.join('app', 'validators', 'json_schemas', "#{options[:filename]}.json").to_s
+    @schema_path ||= Rails.root.join(*base_directory, filename_with_extension).to_s
+  end
+
+  def filename_with_extension
+    "#{options[:filename]}.json"
   end
 
   def draft_version
     options[:draft] || JSON_VALIDATOR_MAX_DRAFT_VERSION
   end
 end
+
+JsonSchemaValidator.prepend_ee_mod

ee/app/validators/ee/json_schema_validator.rb

+# frozen_string_literal: true
+
+module EE
+  module JsonSchemaValidator
+    private
+
+    def schema_path
+      @schema_path ||= begin
+        if File.exist?(super)
+          super
+        else
+          Rails.root.join('ee', *base_directory, filename_with_extension).to_s
+        end
+      end
+    end
+  end
+end

ee/spec/validators/json_schema_validator_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe JsonSchemaValidator do
+  describe '#validates_each' do
+    let(:test_value) { 'bar' }
+    let(:mock_subject) { double(:subject) }
+    let(:validator) { described_class.new(attributes: [:foo], filename: schema_name, base_directory: %w(spec fixtures)) }
+
+    subject(:validate_subject) { validator.validate_each(mock_subject, :foo, test_value) }
+
+    before do
+      allow(JSON::Validator).to receive(:validate).and_return(true)
+    end
+
+    context 'when the schema file exists on CE' do
+      let(:schema_name) { 'ce_sample_schema' }
+      let(:schema_path) { Rails.root.join('spec', 'fixtures', 'ce_sample_schema.json').to_s }
+
+      it 'calls the validator with CE schema' do
+        validate_subject
+
+        expect(JSON::Validator).to have_received(:validate).with(schema_path, test_value)
+      end
+    end
+
+    context 'when the schema file exists on EE' do
+      let(:schema_name) { 'ee_sample_schema' }
+      let(:schema_path) { Rails.root.join('ee', 'spec', 'fixtures', 'ee_sample_schema.json').to_s }
+
+      it 'calls the validator with EE schema' do
+        validate_subject
+
+        expect(JSON::Validator).to have_received(:validate).with(schema_path, test_value)
+      end
+    end
+  end
+end