Awesome Open Source
Awesome Open Source
Sponsorship

Gem Version RSpec Linters Codacy Badge Maintainability Test Coverage Dependabot Status

PigCI

Sample Output of PigCI in TravisCI

Monitor your Ruby Applications metrics (Memory, SQL Requests & Request Time) as part of your test suite.

Please consider supporting this project by adding PigCI to your GitHub project & using this as part of CI. The CI tool will fail PRs that exceed metric threshold (e.g. a big increase in memory).

Installation

Add this line to your application's Gemfile:

group :test do
  gem 'pig-ci-rails'
end

And then execute:

bundle

Or install it yourself as:

gem install pig-ci-rails

Usage

On it's own

# In spec/rails_helper.rb
require 'pig_ci'
PigCI.start

Configuring thresholds

Configuring the thresholds will allow your test suite to fail in CI. You will need to configure the thresholds depending on your application.

# In spec/rails_helper.rb
require 'pig_ci'
PigCI.start do |config|
  # Maximum memory in megabytes
  config.thresholds.memory = 350

  # Maximum time per a HTTP request
  config.thresholds.request_time = 250

  # Maximum database calls per a request
  config.thresholds.database_request = 35
end if RSpec.configuration.files_to_run.count > 1

Configuring other options

This gems was setup to be configured by passing a block to the PigCI.start method, e.g:

# In spec/rails_helper.rb
require 'pig_ci'
PigCI.start do |config|
  config.option = 'new_value'

  # E.g. disable terminal summary output
  config.generate_terminal_summary = false

  # Rails caches repeated SQL queries, you might want to omit these from your report.
  config.ignore_cached_queries = true
end # if RSpec.configuration.files_to_run.count > 1

You can see the full configuration options lib/pig_ci.rb.

Skipping individual tests

If you have a scenario where you'd like PigCI to not log a specific test, you can add the RSpec metadata pig_ci: true. For example:

RSpec.describe "Comments", type: :request do
  # This test block will be not be tracked.
  describe "GET #index", pig_ci: false do
    it do
      get comments_path
      expect(response).to be_successful
    end
  end
end

Framework support

Currently this gem only supports Ruby on Rails tested via RSpec.

Metric notes

Minor fluctuations in memory usage and request time are to be expected and are nothing to worry about. Though any large spike is a signal of something worth investigating.

Memory

By default, this gem will tell Rails to eager load your application on startup. This aims to help identify leaks, over just pure bulk.

You can disable this functionality by setting your configuration to be:

require 'pig_ci'
PigCI.start do |config|
  config.during_setup_eager_load_application = false
end

Request Time

Often the first request test will be slow, as rails is loading a full environment & rendering assets. To mitigate this issue, this gem will make a blank request to your application before your test suite starts & compiling assets.

You can disable this functionality by setting your configuration to be:

require 'pig_ci'
PigCI.start do |config|
  config.during_setup_make_blank_application_request = false
  config.during_setup_precompile_assets = false
end

Authors

  • This gem was made by @MikeRogers0.
  • It was originally inspired by oink, after it was used to monitor acceptance tests and it spotted a memory leak. It seemed like something that would be useful to have as part of CI.
  • The HTML output was inspired by simplecov.

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.

TODO

Features I'd like to add at some point:

  • Add a conditional to only save metrics when all tests pass. So if a test suite is failing, it won't affect future stats.
  • HTML output to include branch - Right now they're just timestamps which makes filtering hard.
  • https://rubydoc.info/gems/yard/file/docs/GettingStarted.md - Document the gem so it's easier for people to jump on.
  • Support ActionCable (when requests have no key).

Contributing

Bug reports and pull requests are welcome on GitHub at PigCI/pig-ci-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Code of Conduct

Everyone interacting in the PigCI project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
ruby (12,202
ruby-on-rails (122
gem (88
rspec (59

Find Open Source By Browsing 7,000 Topics Across 59 Categories