Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dpoetzsch/sidekiq-fake-scheduler
Helpers for manual processing of scheduled sidekiq jobs for integration testing
https://github.com/dpoetzsch/sidekiq-fake-scheduler
integration-testing ruby ruby-on-rails rubygem sidekiq testing
Last synced: about 2 months ago
JSON representation
Helpers for manual processing of scheduled sidekiq jobs for integration testing
- Host: GitHub
- URL: https://github.com/dpoetzsch/sidekiq-fake-scheduler
- Owner: dpoetzsch
- License: mit
- Created: 2017-09-05T15:19:34.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-09-05T15:34:11.000Z (over 7 years ago)
- Last Synced: 2024-11-13T16:50:40.566Z (2 months ago)
- Topics: integration-testing, ruby, ruby-on-rails, rubygem, sidekiq, testing
- Language: Ruby
- Size: 13.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SidekiqFakeScheduler
This gem provides behavior similar to [sidekiq](https://github.com/mperham/sidekiq)'s inline mode but respects starting dates for scheduled jobs.
This is especially useful for integration testing when asserting that certain things happen within a certain time frame.
## Example
Imagine you implemented a reminder loop like this:
```ruby
class ReminderWorker
def perform(phase)
return if phase > 2
# send reminder email
ReminderWorker.perform_in(5.days, phase + 1)
end
end
```
Then, using this gem, you could test it as follows (I used timecop to manipulate the clock, however, this is not a requirement):
```ruby
RSpec.describe ReminderWorker do
after { Timecop.return }
# schedule first reminder for in 5 days
before { ReminderWorker.perform_in(5.days, 1) }
# perform all workers that are due
before { SidekiqFakeScheduler.work }
it 'should not have sent an email' { ... }
context '5 days later' do
# perform all workers that are due
before do
Timecop.freeze 5.days.from_now
SidekiqFakeScheduler.work
end
it 'should have sent 1 email' { ... }
end
context '10 days later' do
# perform all workers that are due
before do
Timecop.freeze 10.days.from_now
SidekiqFakeScheduler.work
end
it 'should have sent 2 emails' { ... }
end
context '15 days later' do
# perform all workers that are due
before do
Timecop.freeze 15.days.from_now
SidekiqFakeScheduler.work
end
it 'should have stopped sending emails after 2 reminders' { ... }
end
end
```
## Installation
Add this line to your application's Gemfile:
```ruby
group :test do
gem 'sidekiq-fake-scheduler'
end
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install sidekiq-fake-scheduler
## Usage
Whenever you want to perform sidekiq jobs just call `SidekiqFakeScheduler.work`.
Use timecop or a similar library to travel in time.
### Clockwork
Many people use sidekiq jobs in combination with [clockwork](https://github.com/Rykian/clockwork) for periodic jobs.
There exist several libraries for manually scheduling clockwork tasks similar to this one.
I personally use (and maintain) [clockwork-mocks](https://github.com/dpoetzsch/clockwork-mocks) that was built in the same spirit using similar techniques.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/dpoetzsch/sidekiq-fake-scheduler. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Sidekiq::Mocks project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dpoetzsch/sidekiq-fake-scheduler/blob/master/CODE_OF_CONDUCT.md).