9a9398b386
Adds Skooma-based OpenAPI validation so SDK-facing request specs can assert that documented request and response contracts match real Rails behavior. This also upgrades the spec to OpenAPI 3.1 and fixes contract drift uncovered while validating core application and platform resources. Closes None Why We want CI to catch OpenAPI drift before it reaches SDK consumers. While wiring validation in, this PR surfaced several mismatches between the documented contract and what the Rails endpoints actually accept or return. What this change does - Adds Skooma-backed OpenAPI validation to the request spec flow and a dedicated OpenAPI validation spec. - Migrates nullable schema definitions to OpenAPI 3.1-compatible unions. - Updates core SDK-facing schemas and payloads across accounts, contacts, conversations, inboxes, messages, teams, reporting events, and platform account resources. - Documents concrete runtime cases that were previously missing or inaccurate, including nested `profile` update payloads, multipart avatar uploads, required profile update bodies, nullable inbox feature flags, and message sender types that include both `Captain::Assistant` and senderless activity-style messages. - Regenerates the committed Swagger JSON and tag-group artifacts used by CI sync checks. Validation - `bundle exec rake swagger:build` - `bundle exec rspec spec/swagger/openapi_spec.rb` --------- Co-authored-by: Sojan Jose <sojan@pepalo.com>
96 lines
3.7 KiB
Ruby
96 lines
3.7 KiB
Ruby
require 'spec_helper'
|
|
ENV['RAILS_ENV'] ||= 'test'
|
|
require File.expand_path('../config/environment', __dir__)
|
|
# Prevent database truncation if the environment is production
|
|
abort('The Rails environment is running in production mode!') if Rails.env.production?
|
|
require 'rspec/rails'
|
|
require 'pundit/rspec'
|
|
require 'sidekiq/testing'
|
|
|
|
# test-prof helpers for tests optimization
|
|
require 'test_prof/recipes/rspec/before_all'
|
|
require 'test_prof/recipes/rspec/let_it_be'
|
|
|
|
# Add additional requires below this line. Rails is not loaded until this point!
|
|
|
|
# Requires supporting ruby files with custom matchers and macros, etc, in
|
|
# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
|
|
# run as spec files by default. This means that files in spec/support that end
|
|
# in _spec.rb will both be required and run as specs, causing the specs to be
|
|
# run twice. It is recommended that you do not name files matching this glob to
|
|
# end with _spec.rb. You can configure this pattern with the --pattern
|
|
# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
|
|
#
|
|
# The following line is provided for convenience purposes. It has the downside
|
|
# of increasing the boot-up time by auto-requiring all files in the support
|
|
# directory. Alternatively, in the individual `*_spec.rb` files, manually
|
|
# require only the support files necessary.
|
|
#
|
|
# rubocop:disable Rails/FilePath
|
|
Dir[Rails.root.join('spec', 'support', '**', '*.rb')].each { |f| require f }
|
|
# rubocop:enable Rails/FilePath
|
|
|
|
# Checks for pending migrations and applies them before tests are run.
|
|
# If you are not using ActiveRecord, you can remove these lines.
|
|
begin
|
|
ActiveRecord::Migration.maintain_test_schema!
|
|
rescue ActiveRecord::PendingMigrationError => e
|
|
puts e.to_s.strip
|
|
exit 1
|
|
end
|
|
RSpec.configure do |config|
|
|
config.include FactoryBot::Syntax::Methods
|
|
# Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
|
|
config.fixture_path = Rails.root.join('spec/fixtures')
|
|
|
|
# If you're not using ActiveRecord, or you'd prefer not to run each of your
|
|
# examples within a transaction, remove the following line or assign false
|
|
# instead of true.
|
|
config.use_transactional_fixtures = true
|
|
|
|
# RSpec Rails can automatically mix in different behaviours to your tests
|
|
# based on their file location, for example enabling you to call `get` and
|
|
# `post` in specs under `spec/controllers`.
|
|
#
|
|
# You can disable this behaviour by removing the line below, and instead
|
|
# explicitly tag your specs with their type, e.g.:
|
|
#
|
|
# RSpec.describe UsersController, :type => :controller do
|
|
# # ...
|
|
# end
|
|
#
|
|
# The different available types are documented in the features, such as in
|
|
# https://relishapp.com/rspec/rspec-rails/docs
|
|
config.infer_spec_type_from_file_location!
|
|
|
|
# Filter lines from Rails gems in backtraces.
|
|
config.filter_rails_from_backtrace!
|
|
# arbitrary gems may also be filtered via:
|
|
# config.filter_gems_from_backtrace("gem name")
|
|
config.include SlackStubs
|
|
config.include FileUploadHelpers
|
|
config.include CsvSpecHelpers
|
|
config.include InstagramSpecHelpers
|
|
config.include Devise::Test::IntegrationHelpers, type: :request
|
|
config.include ActiveSupport::Testing::TimeHelpers
|
|
config.include ActionCable::TestHelper
|
|
config.include ActiveJob::TestHelper
|
|
|
|
# OpenAPI response validation via Skooma
|
|
path_to_openapi = Rails.root.join('swagger/swagger.json')
|
|
config.include Skooma::RSpec[path_to_openapi], type: :request
|
|
end
|
|
|
|
Shoulda::Matchers.configure do |config|
|
|
config.integrate do |with|
|
|
with.test_framework :rspec
|
|
with.library :rails
|
|
end
|
|
end
|
|
|
|
# Required for fixture_file_upload
|
|
FactoryBot::SyntaxRunner.class_eval do
|
|
include ActionDispatch::TestProcess
|
|
include ActiveSupport::Testing::FileFixtures
|
|
end
|