FactoryTrace helps you to cleanup unused factories (by @EvgeniyDemin)
If you write tests for your project and use FactoryBot to generate test data then gem FactoryTrace can help you to maintain your factories and traits in the actual state.
When you execute your tests gem traces usage of factories and in the end outputs a report.
$ FB_TRACE=1 rspec total number of unique used factories & traits: 3 total number of unique unused factories & traits: 2 unused global trait with_email unused factory admin
For RSpec, it's enough to just install the gem and it can be used. For any other testing framework, simple do these manipulations:
# add it to the beginning of your tests execution FactoryTrace.start # add it to the end of your tests execution FactoryTrace.stop
Parallel/Partial execution
Sometimes, if tests take long time to execute, we run them in parallel process by partials, and to make data of unused factories correct we need to process usage from all runners.
You can do it in the following way:
# first partial FB_TRACE=trace_only FB_TRACE_FILE=fb_trace_result1.txt bundle exec rspec spec/first_spec.rb # second partial (it can be more) FB_TRACE=trace_only FB_TRACE_FILE=fb_trace_result2.txt bundle exec rspec spec/second_spec.rb # grouping and processing bundle exec factory_trace fb_trace_result1.txt fb_trace_result2.txt
Thanks to the implementation of FactoryBot with using ActiveSupport::Notifications we can easily add a callback, when a factory was used:
ActiveSupport::Notifications.subscribe('factory_bot.run_factory') do |_name, _start, _finish, _id, payload| name = payload[:name] traits = payload[:traits] storage[name] ||= Set.new storage[name] |= traits end
And after gathering all the information, we can find all unused factories and traits.
Try it yourself and share your opinion. Any contribution is welcome!
Thank you for your time!
DatabaseConsistency - help you to maintain consistency between your database schema and models definitions.
DatabaseValidations - provides two one-line replacement helpers: db_belongs_to and validates_db_uniqueness_of with better performance and consistency.
P.S. Original post was made by me on reddit.
izzy806
kaledo-art
blakekathryn
gummygunk
andulkaphoto
turnnoffyourmind