Skip to content

Commit 501b0b4

Browse files
justin808claude
andcommitted
Add documentation and tests for new configuration options
- Add inline documentation for server_readiness_path and server_readiness_timeout - Document default values and environment variable names - Add test coverage for default values - Add test coverage for custom configuration This improves discoverability and ensures configuration options are properly tested. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent bda3755 commit 501b0b4

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

lib/cypress_on_rails/configuration.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,11 @@ class Configuration
2222
attr_accessor :server_host
2323
attr_accessor :server_port
2424
attr_accessor :transactional_server
25+
# HTTP path to check for server readiness (default: '/')
26+
# Can be set via CYPRESS_RAILS_READINESS_PATH environment variable
2527
attr_accessor :server_readiness_path
28+
# Timeout in seconds for individual HTTP readiness checks (default: 5)
29+
# Can be set via CYPRESS_RAILS_READINESS_TIMEOUT environment variable
2630
attr_accessor :server_readiness_timeout
2731

2832
# Attributes for backwards compatibility

spec/cypress_on_rails/configuration_spec.rb

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
expect(CypressOnRails.configuration.logger).to_not be_nil
1111
expect(CypressOnRails.configuration.before_request).to_not be_nil
1212
expect(CypressOnRails.configuration.vcr_options).to eq({})
13+
expect(CypressOnRails.configuration.server_readiness_path).to eq('/')
14+
expect(CypressOnRails.configuration.server_readiness_timeout).to eq(5)
1315
end
1416

1517
it 'can be configured' do
@@ -22,12 +24,16 @@
2224
config.logger = my_logger
2325
config.before_request = before_request_lambda
2426
config.vcr_options = { hook_into: :webmock }
27+
config.server_readiness_path = '/health'
28+
config.server_readiness_timeout = 10
2529
end
2630
expect(CypressOnRails.configuration.api_prefix).to eq('/api')
2731
expect(CypressOnRails.configuration.install_folder).to eq('my/path')
2832
expect(CypressOnRails.configuration.use_middleware?).to eq(false)
2933
expect(CypressOnRails.configuration.logger).to eq(my_logger)
3034
expect(CypressOnRails.configuration.before_request).to eq(before_request_lambda)
3135
expect(CypressOnRails.configuration.vcr_options).to eq(hook_into: :webmock)
36+
expect(CypressOnRails.configuration.server_readiness_path).to eq('/health')
37+
expect(CypressOnRails.configuration.server_readiness_timeout).to eq(10)
3238
end
3339
end

0 commit comments

Comments
 (0)