Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Disable Events in specs by default (#13471)
Damian Legawiec4ec4804e07c0
diff --git a/admin/spec/spec_helper.rb b/admin/spec/spec_helper.rbindex 0c46fc2611..a78c8e8983 100644--- a/admin/spec/spec_helper.rb+++ b/admin/spec/spec_helper.rb@@ -68,6 +68,7 @@ RSpec.configure do |config|config.use_transactional_fixtures = trueconfig.before(:suite) do+ Spree::Events.disable!Capybara.match = :smartCapybara.javascript_driver = :selenium_chrome_headlessCapybara.default_max_wait_time = 10@@ -77,6 +78,11 @@ RSpec.configure do |config|DatabaseCleaner.clean_with(:truncation)end+ # Re-enable events for specs that need them+ config.around(:each, events: true) do |example|+ Spree::Events.enable { example.run }+ end+config.around(:each) do |example|DatabaseCleaner.cleaning doexample.rundiff --git a/api/spec/spec_helper.rb b/api/spec/spec_helper.rbindex 5e88744591..1ae76c3a5c 100644--- a/api/spec/spec_helper.rb+++ b/api/spec/spec_helper.rb@@ -82,6 +82,11 @@ RSpec.configure do |config|DatabaseCleaner.clean_with(:truncation)end+ # Re-enable events for specs that need them+ config.around(:each, events: true) do |example|+ Spree::Events.enable { example.run }+ end+config.before doreset_spree_preferencesdiff --git a/core/lib/spree/events.rb b/core/lib/spree/events.rbindex 2c837ce347..d4a2ae95e1 100644--- a/core/lib/spree/events.rb+++ b/core/lib/spree/events.rb@@ -202,11 +202,37 @@ module SpreeRequestStore.store[:spree_events_disabled] = previousend- # Set the disabled state of the event system- # Useful for testing- # @param value [Boolean] The disabled state+ # Globally disable events+ # Useful for testing to disable events for the entire test suite# @return [void]def disable!+ RequestStore.store[:spree_events_disabled] = true+ end++ # Temporarily enable events within a block+ # Useful for testing when events are globally disabled+ #+ # @yield Block during which events are enabled+ # @return [Object] Return value of the block+ #+ # @example+ # Spree::Events.enable do+ # # Events published here will trigger subscribers+ # order.complete!+ # end+ #+ def enable+ previous = RequestStore.store[:spree_events_disabled]+ RequestStore.store[:spree_events_disabled] = false+ yield+ ensure+ RequestStore.store[:spree_events_disabled] = previous+ end++ # Globally enable events+ # Useful for testing+ # @return [void]+ def enable!RequestStore.store[:spree_events_disabled] = falseendenddiff --git a/core/lib/spree/testing_support/lifecycle_events.rb b/core/lib/spree/testing_support/lifecycle_events.rbindex 8f5b740c22..6a3f1cb4d9 100644--- a/core/lib/spree/testing_support/lifecycle_events.rb+++ b/core/lib/spree/testing_support/lifecycle_events.rb@@ -4,7 +4,7 @@ shared_examples_for 'lifecycle events' do |factory: nil, event_prefix: nil|let(:lifecycle_factory) { factory || described_class.name.demodulize.underscore.to_sym }let(:lifecycle_event_prefix) { event_prefix || described_class.event_prefix }- describe 'lifecycle events' do+ describe 'lifecycle events', events: true dodescribe "#{described_class.event_prefix}.created" doit 'publishes created event when record is created' dorecord = build(lifecycle_factory)diff --git a/core/spec/lib/spree/events_spec.rb b/core/spec/lib/spree/events_spec.rbindex 99e784bd47..fc4fa5b634 100644--- a/core/spec/lib/spree/events_spec.rb+++ b/core/spec/lib/spree/events_spec.rb@@ -2,7 +2,7 @@require 'spec_helper'-RSpec.describe Spree::Events do+RSpec.describe Spree::Events, events: true dobefore dodescribed_class.reset!enddiff --git a/core/spec/models/concerns/spree/publishable_spec.rb b/core/spec/models/concerns/spree/publishable_spec.rbindex 85b22496f5..1bda60bc50 100644--- a/core/spec/models/concerns/spree/publishable_spec.rb+++ b/core/spec/models/concerns/spree/publishable_spec.rb@@ -2,7 +2,7 @@require 'spec_helper'-RSpec.describe Spree::Publishable do+RSpec.describe Spree::Publishable, events: true dobefore doSpree::Events.reset!enddiff --git a/core/spec/models/spree/customer_return_spec.rb b/core/spec/models/spree/customer_return_spec.rbindex cac9a981d6..c1d083038c 100644--- a/core/spec/models/spree/customer_return_spec.rb+++ b/core/spec/models/spree/customer_return_spec.rb@@ -7,7 +7,7 @@ describe Spree::CustomerReturn, type: :model doit_behaves_like 'metadata'- describe 'lifecycle events' do+ describe 'lifecycle events', events: true dodescribe 'customer_return.created' doit 'publishes created event when record is created' docustomer_return = build(:customer_return_without_return_items, store: create(:store))diff --git a/core/spec/models/spree/gift_card_batch_spec.rb b/core/spec/models/spree/gift_card_batch_spec.rbindex ca72ca8eb7..f4b689f431 100644--- a/core/spec/models/spree/gift_card_batch_spec.rb+++ b/core/spec/models/spree/gift_card_batch_spec.rb@@ -1,7 +1,7 @@require 'spec_helper'RSpec.describe Spree::GiftCardBatch, type: :model do- describe 'lifecycle events' do+ describe 'lifecycle events', events: true dolet(:gift_card_batch_attrs) { { codes_count: 2, prefix: 'batch_', amount: 10 } }describe 'gift_card_batch.created' dodiff --git a/core/spec/models/spree/gift_card_spec.rb b/core/spec/models/spree/gift_card_spec.rbindex 8a7a651917..1ad8253636 100644--- a/core/spec/models/spree/gift_card_spec.rb+++ b/core/spec/models/spree/gift_card_spec.rb@@ -195,7 +195,7 @@ RSpec.describe Spree::GiftCard, type: :model doendend- describe 'custom events' do+ describe 'custom events', events: true dolet(:store) { Spree::Store.default }describe 'gift_card.redeemed' dodiff --git a/core/spec/models/spree/import_spec.rb b/core/spec/models/spree/import_spec.rbindex 934c442a82..26582acb8b 100644--- a/core/spec/models/spree/import_spec.rb+++ b/core/spec/models/spree/import_spec.rb@@ -383,7 +383,7 @@ RSpec.describe Spree::Import, :job, type: :model doendend- describe 'custom events' do+ describe 'custom events', events: true dodescribe 'import.completed' dobefore doimport.save!diff --git a/core/spec/models/spree/invitation_spec.rb b/core/spec/models/spree/invitation_spec.rbindex 15339ada16..4f16870249 100644--- a/core/spec/models/spree/invitation_spec.rb+++ b/core/spec/models/spree/invitation_spec.rb@@ -78,7 +78,7 @@ RSpec.describe Spree::Invitation, type: :model doexpect(invitation.accepted_at).to be_presentend- it 'publishes invitation.accept event' do+ it 'publishes invitation.accept event', events: true doinvitation.invitee = create(:admin_user, :without_admin_role)expect(invitation).to receive(:publish_event).with('invitation.accepted')@@ -109,18 +109,18 @@ RSpec.describe Spree::Invitation, type: :model doenddescribe '#resend!' do- it 'publishes invitation.resent event if invitation is pending and not expired' do+ it 'publishes invitation.resent event if invitation is pending and not expired', events: true doexpect(invitation).to receive(:publish_event).with('invitation.resent')invitation.resend!end- it 'does not publish event if invitation is expired' do+ it 'does not publish event if invitation is expired', events: true doallow(invitation).to receive(:expired?).and_return(true)expect(invitation).not_to receive(:publish_event)invitation.resend!end- it 'does not publish event if invitation is accepted' do+ it 'does not publish event if invitation is accepted', events: true doinvitation.invitee = create(:admin_user, :without_admin_role)expect(invitation).to receive(:publish_event).with('invitation.accepted')invitation.acceptdiff --git a/core/spec/models/spree/order_spec.rb b/core/spec/models/spree/order_spec.rbindex e3af0b6961..4c39d57f69 100644--- a/core/spec/models/spree/order_spec.rb+++ b/core/spec/models/spree/order_spec.rb@@ -224,7 +224,7 @@ describe Spree::Order, type: :model doendend- context 'events' do+ context 'events', events: true dolet(:order) { create(:completed_order_with_totals, store: store) }it 'publishes order.canceled event' do@@ -240,7 +240,7 @@ describe Spree::Order, type: :model dobefore { order.cancel! }- it 'publishes order.resumed event' do+ it 'publishes order.resumed event', events: true doexpect(order).to receive(:publish_event).with('order.resumed').at_least(:once)allow(order).to receive(:publish_event).with(anything)order.resume!@@ -290,7 +290,7 @@ describe Spree::Order, type: :model doendend- context 'events' do+ context 'events', events: true dolet(:order) { create(:completed_order_with_totals) }it 'publishes order.canceled event' do@@ -401,7 +401,7 @@ describe Spree::Order, type: :model doendend- context 'events' do+ context 'events', events: true dolet(:order) { create(:order_with_line_items, store: store) }before { order.update_column(:state, 'complete') }@@ -698,7 +698,7 @@ describe Spree::Order, type: :model doendend- context 'events' do+ context 'events', events: true doit 'publishes order.updated event' doorder = create(:order_with_totals, state: 'delivery')expect(order).to receive(:publish_event).with('order.updated').at_least(:once)@@ -975,7 +975,7 @@ describe Spree::Order, type: :model doit_behaves_like '#associate_user!', trueend- context 'events' do+ context 'events', events: true dolet(:order) { create(:order, order_attributes) }it 'publishes order.updated event' do@@ -1028,7 +1028,7 @@ describe Spree::Order, type: :model doorder.approved_by(admin_user)end- context 'events' do+ context 'events', events: true doit 'publishes order.approved event' doexpect(order).to receive(:publish_event).with('order.approved').at_least(:once)order.approved_by(admin_user)@@ -1044,7 +1044,7 @@ describe Spree::Order, type: :model doexpect(order.reload.considered_risky).to be trueend- context 'events' do+ context 'events', events: true doit 'publishes order.updated event' doexpect(order).to receive(:publish_event).with('order.updated')order.considered_risky!@@ -1064,7 +1064,7 @@ describe Spree::Order, type: :model doexpect(order.reload.considered_risky).to be falseend- context 'events' do+ context 'events', events: true doit 'publishes order.approved event' doexpect(order).to receive(:publish_event).with('order.approved')order.approve!@@ -1099,7 +1099,7 @@ describe Spree::Order, type: :model doexpect(order.reload.state).to eq('address')end- context 'events' do+ context 'events', events: true doit 'publishes order.updated event' doexpect(order).to receive(:publish_event).with('order.updated').at_least(:once)order.ensure_updated_shipmentsdiff --git a/core/spec/models/spree/payment_spec.rb b/core/spec/models/spree/payment_spec.rbindex 3bed924b9f..26429f7a4d 100644--- a/core/spec/models/spree/payment_spec.rb+++ b/core/spec/models/spree/payment_spec.rb@@ -1307,7 +1307,7 @@ describe Spree::Payment, type: :model doendend- describe 'events' do+ describe 'events', events: true dodescribe 'completed state transition' doit 'publishes payment.completed event' dopayment.started_processing!diff --git a/core/spec/models/spree/product_spec.rb b/core/spec/models/spree/product_spec.rbindex a7c591f6db..1805324ac2 100644--- a/core/spec/models/spree/product_spec.rb+++ b/core/spec/models/spree/product_spec.rb@@ -1524,7 +1524,7 @@ describe Spree::Product, type: :model doendend- describe 'custom events' do+ describe 'custom events', events: true dodescribe 'product.activated' dolet(:product) { create(:product, status: 'draft', stores: [store]) }diff --git a/core/spec/models/spree/reimbursement_spec.rb b/core/spec/models/spree/reimbursement_spec.rbindex 9f31939961..ce6123e729 100644--- a/core/spec/models/spree/reimbursement_spec.rb+++ b/core/spec/models/spree/reimbursement_spec.rb@@ -213,7 +213,7 @@ describe Spree::Reimbursement, type: :model doendend- describe 'custom events' do+ describe 'custom events', events: true dodescribe 'reimbursement.reimbursed' dolet(:order) { create(:shipped_order, line_items_count: 1, line_items_price: BigDecimal(10), shipment_cost: 0, store: store) }let(:line_item) { order.line_items.first }diff --git a/core/spec/models/spree/return_authorization_spec.rb b/core/spec/models/spree/return_authorization_spec.rbindex f278ad2aef..c76f19443e 100644--- a/core/spec/models/spree/return_authorization_spec.rb+++ b/core/spec/models/spree/return_authorization_spec.rb@@ -13,7 +13,7 @@ describe Spree::ReturnAuthorization, type: :model doreturn_authorization_reason_id: rma_reason.id)end- describe 'lifecycle events' do+ describe 'lifecycle events', events: true dodescribe 'return_authorization.created' doit 'publishes created event when record is created' doshipped_order = create(:shipped_order)@@ -269,7 +269,7 @@ describe Spree::ReturnAuthorization, type: :model doendend- describe 'custom events' do+ describe 'custom events', events: true dodescribe 'return_authorization.canceled' dolet(:return_authorization) { create(:return_authorization) }diff --git a/core/spec/models/spree/return_item_spec.rb b/core/spec/models/spree/return_item_spec.rbindex efff072d5a..3fe4be4e38 100644--- a/core/spec/models/spree/return_item_spec.rb+++ b/core/spec/models/spree/return_item_spec.rb@@ -769,7 +769,7 @@ describe Spree::ReturnItem, type: :model doendend- describe 'custom events' do+ describe 'custom events', events: true dodescribe 'return_item.received' dolet(:inventory_unit) { create(:inventory_unit, state: 'shipped') }let(:return_item) { create(:return_item, inventory_unit: inventory_unit, reception_status: 'awaiting') }diff --git a/core/spec/models/spree/shipment_spec.rb b/core/spec/models/spree/shipment_spec.rbindex 06dd6d7670..76178de5b9 100644--- a/core/spec/models/spree/shipment_spec.rb+++ b/core/spec/models/spree/shipment_spec.rb@@ -1041,7 +1041,7 @@ describe Spree::Shipment, type: :model doendend- describe 'events' do+ describe 'events', events: true dolet(:order) { create(:order_ready_to_ship) }let(:shipment) { order.shipments.first }diff --git a/core/spec/models/spree/stock_movement_spec.rb b/core/spec/models/spree/stock_movement_spec.rbindex 4244d632f9..37e953aabc 100644--- a/core/spec/models/spree/stock_movement_spec.rb+++ b/core/spec/models/spree/stock_movement_spec.rb@@ -2,7 +2,7 @@ require 'spec_helper'describe Spree::StockMovement, type: :model do# Note: StockMovement is marked as readonly after creation, so we only test the created event- describe 'lifecycle events' do+ describe 'lifecycle events', events: true dodescribe 'stock_movement.created' doit 'publishes created event when record is created' dorecord = build(:stock_movement)diff --git a/core/spec/models/spree/subscriber_spec.rb b/core/spec/models/spree/subscriber_spec.rbindex 8bf9001b13..99a2139453 100644--- a/core/spec/models/spree/subscriber_spec.rb+++ b/core/spec/models/spree/subscriber_spec.rb@@ -2,7 +2,7 @@require 'spec_helper'-RSpec.describe Spree::Subscriber do+RSpec.describe Spree::Subscriber, events: true dobefore doSpree::Events.reset!enddiff --git a/core/spec/models/spree/wishlist_spec.rb b/core/spec/models/spree/wishlist_spec.rbindex 98b5e8c246..b0e99a645f 100644--- a/core/spec/models/spree/wishlist_spec.rb+++ b/core/spec/models/spree/wishlist_spec.rb@@ -10,7 +10,7 @@ describe Spree::Wishlist, type: :model dolet!(:wishlist_belonging_to_other_store) { create(:wishlist, user: user, name: 'My Wishlist', store: other_store, is_default: true) }let!(:wishlist_belonging_to_other_user) { create(:wishlist, user: other_user, name: 'My Wishlist', store: store, is_default: true) }- describe 'lifecycle events' do+ describe 'lifecycle events', events: true dodescribe 'wishlist.created' doit 'publishes created event when record is created' dorecord = build(:wishlist, user: user, store: store)diff --git a/core/spec/services/spree/newsletter/verify_spec.rb b/core/spec/services/spree/newsletter/verify_spec.rbindex e49fb2c098..08ed914f28 100644--- a/core/spec/services/spree/newsletter/verify_spec.rb+++ b/core/spec/services/spree/newsletter/verify_spec.rb@@ -38,7 +38,7 @@ module Spreeendend- describe 'custom events' do+ describe 'custom events', events: true dolet(:user) { nil }it 'publishes newsletter_subscriber.verified event when verified' dodiff --git a/core/spec/spec_helper.rb b/core/spec/spec_helper.rbindex cfc65bf8ef..927908b7b1 100644--- a/core/spec/spec_helper.rb+++ b/core/spec/spec_helper.rb@@ -66,11 +66,17 @@ RSpec.configure do |config|config.use_transactional_fixtures = trueconfig.before(:suite) do+ Spree::Events.disable!# Clean out the database state before the tests runDatabaseCleaner.strategy = :transactionDatabaseCleaner.clean_with(:truncation)end+ # Re-enable events for specs that need them+ config.around(:each, events: true) do |example|+ Spree::Events.enable { example.run }+ end+config.around(:each) do |example|DatabaseCleaner.cleaning doexample.rundiff --git a/emails/spec/models/spree/order_spec.rb b/emails/spec/models/spree/order_spec.rbindex ae90f66a8e..82b2a0d6ee 100644--- a/emails/spec/models/spree/order_spec.rb+++ b/emails/spec/models/spree/order_spec.rb@@ -12,7 +12,7 @@ describe Spree::Order, type: :model doorder.update_column :state, 'complete'end- it 'publishes order.completed event when finalizing' do+ it 'publishes order.completed event when finalizing', events: true doexpect(order).to receive(:publish_event).with('order.completed')allow(order).to receive(:publish_event).with(anything)@@ -47,7 +47,7 @@ describe Spree::Order, type: :model doallow_any_instance_of(Spree::OrderUpdater).to receive(:update_adjustment_total).and_return(10)end- it 'publishes order.canceled event when canceling' do+ it 'publishes order.canceled event when canceling', events: true doallow(shipment).to receive(:cancel!)allow(order).to receive :restock_items!diff --git a/emails/spec/models/spree/reimbursement_spec.rb b/emails/spec/models/spree/reimbursement_spec.rbindex 1804e02687..d4c84d5786 100644--- a/emails/spec/models/spree/reimbursement_spec.rb+++ b/emails/spec/models/spree/reimbursement_spec.rb@@ -28,7 +28,7 @@ describe Spree::Reimbursement, type: :model doreturn_item.accept!end- it 'publishes reimbursement.reimbursed event when performing' do+ it 'publishes reimbursement.reimbursed event when performing', events: true doexpect(reimbursement).to receive(:publish_event).with('reimbursement.reimbursed')allow(reimbursement).to receive(:publish_event).with(anything)diff --git a/emails/spec/models/spree/shipment_spec.rb b/emails/spec/models/spree/shipment_spec.rbindex cd3306984f..a6a2fa7f7d 100644--- a/emails/spec/models/spree/shipment_spec.rb+++ b/emails/spec/models/spree/shipment_spec.rb@@ -22,7 +22,7 @@ describe Spree::Shipment, type: :model doallow(shipment).to receive_messages(require_inventory: false, update_order: true, state: state)end- it 'publishes shipment.shipped event when shipping' do+ it 'publishes shipment.shipped event when shipping', events: true doallow_any_instance_of(Spree::ShipmentHandler).to receive(:update_order_shipment_state)expect(shipment).to receive(:publish_event).with('shipment.shipped')diff --git a/emails/spec/spec_helper.rb b/emails/spec/spec_helper.rbindex e9a388a02e..56b3143185 100644--- a/emails/spec/spec_helper.rb+++ b/emails/spec/spec_helper.rb@@ -58,11 +58,17 @@ RSpec.configure do |config|config.use_transactional_fixtures = trueconfig.before(:suite) do+ Spree::Events.disable!# Clean out the database state before the tests runDatabaseCleaner.strategy = :transactionDatabaseCleaner.clean_with(:truncation)end+ # Re-enable events for specs that need them+ config.around(:each, events: true) do |example|+ Spree::Events.enable { example.run }+ end+config.around(:each) do |example|DatabaseCleaner.cleaning doexample.rundiff --git a/packages/page_builder/spec/spec_helper.rb b/packages/page_builder/spec/spec_helper.rbindex 37b0b27ce3..5bbf9c221e 100644--- a/packages/page_builder/spec/spec_helper.rb+++ b/packages/page_builder/spec/spec_helper.rb@@ -57,6 +57,11 @@ RSpec.configure do |config|DatabaseCleaner.clean_with(:truncation)end+ # Re-enable events for specs that need them+ config.around(:each, events: true) do |example|+ Spree::Events.enable { example.run }+ end+config.around(:each) do |example|DatabaseCleaner.cleaning doexample.rundiff --git a/sample/spec/spec_helper.rb b/sample/spec/spec_helper.rbindex c35a10aa6d..7a2b8243d4 100644--- a/sample/spec/spec_helper.rb+++ b/sample/spec/spec_helper.rb@@ -34,10 +34,16 @@ RSpec.configure do |config|endconfig.before(:suite) do+ Spree::Events.disable!DatabaseCleaner.strategy = :transactionDatabaseCleaner.clean_with(:truncation)end+ # Re-enable events for specs that need them+ config.around(:each, events: true) do |example|+ Spree::Events.enable { example.run }+ end+config.append_after doDatabaseCleaner.cleanenddiff --git a/storefront/spec/spec_helper.rb b/storefront/spec/spec_helper.rbindex 422e24f6d9..1694dbebe2 100644--- a/storefront/spec/spec_helper.rb+++ b/storefront/spec/spec_helper.rb@@ -77,6 +77,11 @@ RSpec.configure do |config|DatabaseCleaner.clean_with(:truncation)end+ # Re-enable events for specs that need them+ config.around(:each, events: true) do |example|+ Spree::Events.enable { example.run }+ end+config.around(:each) do |example|DatabaseCleaner.cleaning doexample.run