Skip to content

armgit / spree

Public Imported from GitHub
0

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.

Add parallel_tests for local parallel spec execution (#13532)

Damian Legawiececfdead65dd0
diff --git a/admin/spec/spec_helper.rb b/admin/spec/spec_helper.rb
index b6dad4387e..9ae5c66a5f 100644
--- a/admin/spec/spec_helper.rb
+++ b/admin/spec/spec_helper.rb
@@ -56,7 +56,7 @@ require 'action_text/system_test_helper'
RSpec.configure do |config|
config.color = true
- config.default_formatter = ENV['CI'] ? 'progress' : 'doc'
+ config.default_formatter = 'progress'
config.fail_fast = ENV['FAIL_FAST'] || false
config.infer_spec_type_from_file_location!
config.mock_with :rspec
diff --git a/api/spec/spec_helper.rb b/api/spec/spec_helper.rb
index 54cf3a6e24..2af506d8ac 100644
--- a/api/spec/spec_helper.rb
+++ b/api/spec/spec_helper.rb
@@ -64,7 +64,7 @@ end
RSpec.configure do |config|
config.backtrace_exclusion_patterns = [/gems\/activesupport/, /gems\/actionpack/, /gems\/rspec/]
config.color = true
- config.default_formatter = ENV['CI'] ? 'progress' : 'doc'
+ config.default_formatter = 'progress'
config.fail_fast = ENV['FAIL_FAST'] || false
config.infer_spec_type_from_file_location!
config.raise_errors_for_deprecations!
diff --git a/common_spree_dependencies.rb b/common_spree_dependencies.rb
index 9892d7f7c9..8ddfc5d5b1 100644
--- a/common_spree_dependencies.rb
+++ b/common_spree_dependencies.rb
@@ -18,6 +18,7 @@ platforms :ruby do
end
group :test do
+ gem 'parallel_tests'
gem 'capybara'
gem 'capybara-screenshot'
gem 'capybara-select-2'
diff --git a/core/lib/generators/spree/dummy/templates/rails/database.yml b/core/lib/generators/spree/dummy/templates/rails/database.yml
index 6b492c55fb..dc36bb1c7e 100644
--- a/core/lib/generators/spree/dummy/templates/rails/database.yml
+++ b/core/lib/generators/spree/dummy/templates/rails/database.yml
@@ -14,7 +14,7 @@ development:
database: db/spree_development.sqlite3
test:
adapter: sqlite3
- database: db/spree_test.sqlite3
+ database: db/spree_test<%%= ENV['TEST_ENV_NUMBER'] %>.sqlite3
timeout: 10000
production:
adapter: sqlite3
@@ -40,7 +40,7 @@ development:
database: <%= database_prefix %><%= lib_name %>_spree_development
test:
<<: *mysql
- database: <%= database_prefix %><%= lib_name %>_spree_test
+ database: <%= database_prefix %><%= lib_name %>_spree_test<%%= ENV['TEST_ENV_NUMBER'] %>
production:
<<: *mysql
database: <%= database_prefix %><%= lib_name %>_spree_production
@@ -57,14 +57,14 @@ postgres: &postgres
host: <%= db_host %>
<% end %>
min_messages: warning
- pool: <%= ENV["DB_POOL"] || 50 %>
+ pool: <%%= ENV.fetch("DB_POOL", 50) %>
development:
<<: *postgres
database: <%= database_prefix %><%= lib_name %>_spree_development
test:
<<: *postgres
- database: <%= database_prefix %><%= lib_name %>_spree_test
+ database: <%= database_prefix %><%= lib_name %>_spree_test<%%= ENV['TEST_ENV_NUMBER'] %>
production:
<<: *postgres
database: <%= database_prefix %><%= lib_name %>_spree_production
@@ -74,8 +74,8 @@ development:
database: db/spree_development.sqlite3
test:
adapter: sqlite3
- database: db/spree_test.sqlite3
+ database: db/spree_test<%%= ENV['TEST_ENV_NUMBER'] %>.sqlite3
production:
adapter: sqlite3
database: db/spree_production.sqlite3
-<% end %>
\ No newline at end of file
+<% end %>
diff --git a/core/lib/spree/testing_support/common_rake.rb b/core/lib/spree/testing_support/common_rake.rb
index d275cfb83a..b941ed3ab4 100644
--- a/core/lib/spree/testing_support/common_rake.rb
+++ b/core/lib/spree/testing_support/common_rake.rb
@@ -134,3 +134,56 @@ namespace :common do
system('bundle exec rake db:seed RAILS_ENV=test > /dev/null 2>&1')
end
end
+
+# Custom parallel setup task instead of parallel_tests' native parallel:create/parallel:prepare
+# because Spree gems are not Rails apps — the Rails app lives in spec/dummy/ and db: rake tasks
+# are not available from the gem directory. For SQLite, we copy the primary .sqlite3 file which
+# is faster than creating + migrating N databases through Rails.
+desc 'Create and prepare databases for parallel test workers'
+task :parallel_setup, [:count] do |_t, args|
+ require 'parallel'
+
+ count = (args[:count] || ENV.fetch('PARALLEL_TEST_PROCESSORS', Parallel.processor_count)).to_i
+ dummy_path = ENV['DUMMY_PATH'] || 'spec/dummy'
+ db_config_path = File.join(dummy_path, 'config', 'database.yml')
+
+ raise "Database config not found at #{db_config_path}. Run 'rake test_app' first." unless File.exist?(db_config_path)
+
+ require 'erb'
+ require 'yaml'
+
+ db_config = YAML.safe_load(ERB.new(File.read(db_config_path)).result, permitted_classes: [Symbol])
+ adapter = db_config.dig('test', 'adapter')
+
+ if adapter == 'sqlite3'
+ # For SQLite, copy the primary test database for each worker
+ primary_db = File.join(dummy_path, db_config.dig('test', 'database'))
+
+ raise "Primary test database not found at #{primary_db}. Run 'rake test_app' first." unless File.exist?(primary_db)
+
+ 2.upto(count) do |i|
+ worker_db = primary_db.sub(/\.sqlite3$/, "#{i}.sqlite3")
+ FileUtils.cp(primary_db, worker_db)
+ puts "Created parallel database: #{worker_db}"
+ end
+ else
+ # For PostgreSQL/MySQL, create and migrate each worker's database
+ 2.upto(count) do |i|
+ env_vars = "TEST_ENV_NUMBER=#{i} RAILS_ENV=test"
+ puts "Setting up database for worker #{i}..."
+ Dir.chdir(dummy_path) do
+ system("#{env_vars} bundle exec rake db:create db:migrate") || raise("Failed to setup database for worker #{i}")
+ end
+ end
+ end
+
+ puts "Parallel databases setup complete (#{count} workers)"
+end
+
+desc 'Run specs in parallel'
+task :parallel_spec, [:count] do |_t, args|
+ count = args[:count] || ENV.fetch('PARALLEL_TEST_PROCESSORS', nil)
+ count_arg = count ? "-n #{count}" : ''
+ success = system("bundle exec parallel_rspec #{count_arg} spec")
+ exit(success ? 0 : 1)
+end
diff --git a/core/spec/spec_helper.rb b/core/spec/spec_helper.rb
index 0ad67b872f..b441312ba8 100644
--- a/core/spec/spec_helper.rb
+++ b/core/spec/spec_helper.rb
@@ -54,7 +54,7 @@ require 'spree/testing_support/next_instance_of'
RSpec.configure do |config|
config.color = true
- config.default_formatter = ENV['CI'] ? 'progress' : 'doc'
+ config.default_formatter = 'progress'
config.fail_fast = ENV['FAIL_FAST'] || false
config.infer_spec_type_from_file_location!
config.mock_with :rspec
diff --git a/docs/developer/contributing/developing-spree.mdx b/docs/developer/contributing/developing-spree.mdx
index 4ad90aca99..0ddd5bfb85 100644
--- a/docs/developer/contributing/developing-spree.mdx
+++ b/docs/developer/contributing/developing-spree.mdx
@@ -129,6 +129,34 @@ If you want to run a particular line of spec
bundle exec rspec spec/models/spree/state_spec.rb:7
```
+### Running tests in parallel
+
+You can run specs in parallel locally using the `parallel_tests` gem. This distributes spec files across multiple CPU cores for faster execution.
+
+After setting up the test app, create databases for parallel workers:
+
+ ```bash
+ cd core
+ bundle exec rake parallel_setup
+ ```
+
+Then run specs in parallel:
+
+ ```bash
+ bundle exec parallel_rspec spec
+ ```
+
+You can also specify the number of workers:
+
+ ```bash
+ bundle exec rake "parallel_setup[4]"
+ bundle exec parallel_rspec -n 4 spec
+ ```
+
+After schema changes, re-run `bundle exec rake parallel_setup` to update the worker databases.
+
+This works with both SQLite (default) and PostgreSQL. For PostgreSQL, set the `DB` environment variable when generating the test app as described above.
+
### Running integration tests on MacOS (only applicable for Admin Panel/Storefront)
We use chromedriver to run integration tests. To install it please use this command:
diff --git a/emails/spec/spec_helper.rb b/emails/spec/spec_helper.rb
index 9dbe0a6780..234d325e44 100644
--- a/emails/spec/spec_helper.rb
+++ b/emails/spec/spec_helper.rb
@@ -46,7 +46,7 @@ require 'spree/testing_support/rspec_retry_config'
RSpec.configure do |config|
config.color = true
- config.default_formatter = ENV['CI'] ? 'progress' : 'doc'
+ config.default_formatter = 'progress'
config.fail_fast = ENV['FAIL_FAST'] || false
config.infer_spec_type_from_file_location!
config.mock_with :rspec
diff --git a/page_builder/spec/spec_helper.rb b/page_builder/spec/spec_helper.rb
index afe20daf87..2a123bcf51 100644
--- a/page_builder/spec/spec_helper.rb
+++ b/page_builder/spec/spec_helper.rb
@@ -41,7 +41,7 @@ require 'spree/page_builder/testing_support/factories'
RSpec.configure do |config|
config.color = true
- config.default_formatter = ENV['CI'] ? 'progress' : 'doc'
+ config.default_formatter = 'progress'
config.fail_fast = ENV['FAIL_FAST'] || false
config.infer_spec_type_from_file_location!
config.mock_with :rspec
diff --git a/sample/spec/spec_helper.rb b/sample/spec/spec_helper.rb
index de00e08cf8..6d3b47bc22 100644
--- a/sample/spec/spec_helper.rb
+++ b/sample/spec/spec_helper.rb
@@ -11,7 +11,7 @@ require 'spree/testing_support/preferences'
RSpec.configure do |config|
config.color = true
- config.default_formatter = ENV['CI'] ? 'progress' : 'doc'
+ config.default_formatter = 'progress'
config.fail_fast = ENV['FAIL_FAST'] || false
config.infer_spec_type_from_file_location!
config.mock_with :rspec
diff --git a/storefront/spec/spec_helper.rb b/storefront/spec/spec_helper.rb
index b8687d0201..8c129abf91 100644
--- a/storefront/spec/spec_helper.rb
+++ b/storefront/spec/spec_helper.rb
@@ -55,7 +55,7 @@ require 'spree/core/controller_helpers/strong_parameters'
RSpec.configure do |config|
config.color = true
- config.default_formatter = ENV['CI'] ? 'progress' : 'doc'
+ config.default_formatter = 'progress'
config.fail_fast = ENV['FAIL_FAST'] || false
config.infer_spec_type_from_file_location!
config.mock_with :rspec
@@ -110,7 +110,7 @@ RSpec.configure do |config|
config.order = :random
Kernel.srand config.seed
- Capybara.server_port = 3000
+ Capybara.server_port = 3000 + ENV.fetch('TEST_ENV_NUMBER', 0).to_i
Capybara.test_id = 'data-test-id'
config.filter_run_including focus: true unless ENV['CI']