pig-ci-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf3c447e7716e880cb65a571d903404691cf724e564ee3f7ea6f45bcb2e4579a
+  data.tar.gz: a0fa3bd34791ca87aac66664911e35ff195bbc5425bfbda0f5b729a68fc0145a
+SHA512:
+  metadata.gz: 9c84c537d59fd9c716c5308c6b268d2fdc3bb60d4edcba2777063de5bd782110e06491906ba33403f31d66ded07ca17a930e3d6185782f43e4e21823f69bb01a
+  data.tar.gz: 7dbbb125ab5fd4a4866bc4d3c1b3e3c58ffa9e118ee2f6ae962beb4a0f640d54f8916af9f2f99be91892c7fd4890b47be1dcc56b84f26b3af213c28615ff4267

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  Exclude:
+    - '.git/**/*'
+    - 'bin/*'
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  CountComments: true
+  Max: 25
+  ExcludedMethods: []
+  Exclude:
+    - "spec/**/*"
+    - '*.gemspec'
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact

data/.travis.yml

@@ -0,0 +1,21 @@
+---
+sudo: false
+
+language: ruby
+
+cache: bundler
+
+rvm:
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.3
+  - ruby-head
+
+before_install: 
+  - gem install bundler -v 2.0.1
+
+script: "bundle exec rake spec"
+
+notifications:
+  email: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0 (In Development)
+
+  * Initial Release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at me@mikerogers.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pig_ci.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Mike Rogers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,124 @@
+# PigCI
+
+Monitor your Ruby Applications metrics (Memory, SQL Requests & Request Time) as part of your test suite.
+
+Please consider supporting this project by adding [PigCI](https://pigci.com/) 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:
+
+```ruby
+group :test do
+  gem 'pig-ci-rails'
+end
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install pig-ci-rails
+```
+
+## Usage
+
+### On it's own
+
+```ruby
+# In spec/rails_helper.rb
+require 'pig_ci'
+PigCI.start
+```
+
+### With [PigCI.com](https://pigci.com) - For sharing runs as a team via CI.
+
+You can hookup your project to PigCI.com, this will fail PRs when metric thresholds are exceeded (e.g. your app see a big increase in memory).
+
+```ruby
+# In spec/rails_helper.rb
+require 'pig_ci'
+PigCI.start do |config|
+  # When you connect your project, you'll be given an API key.
+  config.api_key = 'you-api-key-here'
+end
+```
+
+### Configuring PigCI
+
+This gems was setup to be configured by passing a block to the `PigCI.start` method, e.g:
+
+```ruby
+# 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
+end # if RSpec.configuration.files_to_run.count > 1
+```
+
+You can see the full configuration options [lib/pig_ci.rb](https://github.com/PigCI/pig-ci-rails/blob/master/lib/pig_ci.rb#L21).
+
+### Framework support
+
+Currently this gem only supports Ruby on Rails.
+
+### Metric notes
+
+#### Memory
+
+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.
+
+You can improve its accuracy by updating your `config/environments/test.rb` to have the line:
+
+```ruby
+config.eager_load = true
+```
+
+#### Request Time
+
+Often the first request test will be slow, as rails is loading a full environment. While this metric is useful, I'd suggest focusing on other metrics (like memory, or database requests).
+
+Alternatively add:
+
+```ruby
+Rails.application.call(::Rack::MockRequest.env_for('/'))
+```
+
+Before you call `PigCI.start`.
+
+## Authors
+
+  * This gem was made by [@MikeRogers0](https://github.com/MikeRogers0).
+  * It was originally inspired by [oink](https://github.com/noahd1/oink), after it was used to [monitor acceptance tests](https://mikerogers.io/2015/03/28/monitor-rails-memory-usage-in-integration-tests.html) 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](https://github.com/colszowka/simplecov).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## TODO
+
+Features I'd like to add at some point:
+ 
+  * HTML output to include branch - Right now they're just timestamps which makes filtering hard.
+  * Should I disable terminal output by default? It feels like noise.
+  * Should I reject database requests that have a value of 0? I think so.
+  * Document setting branch/commit encase of weird CI.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [PigCI/pig-ci-rails](https://github.com/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](http://contributor-covenant.org) 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](https://github.com/PigCI/pig-ci-rails/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pig_ci"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/locales/pig_ci/en.yml

@@ -0,0 +1,43 @@
+en:
+  pig_ci:
+    api:
+      reports:
+        error: 'Unable to connect to PigCI API: %{error}'
+    summary:
+      saved_successfully: PigCI report generated to %{output_directory}
+      title: PigCI Results
+      view_historic_reports: 'Historic Reports'
+      footer_html: |
+        <p>Generated <time datetime="%{generated_at}">%{generated_at}</time> by PigCI.</p>
+        <p>Support <a href="https://pigci.com/" target="_blank" rel="noopener">PigCI</a> by <a href="https://github.com/apps/pigci/installations/new" target="_blank" rel="noopener">adding us on GitHub</a>.</p>
+
+    report:
+      memory:
+        name: Peak memory per a request
+        attributes:
+          key: Key
+          max: Max (MB)
+          min: Min (MB)
+          mean: Mean (MB)
+          number_of_requests: Requests
+          max_change_percentage: "% Change"
+
+      request_time:
+        name: Request Time
+        attributes:
+          key: Key
+          max: Max (ms)
+          min: Min (ms)
+          mean: Mean (ms)
+          number_of_requests: Requests
+          max_change_percentage: "% Change"
+
+      database_request:
+        name: Queries to the database
+        attributes:
+          key: Key
+          max: Max
+          min: Min
+          mean: Mean
+          number_of_requests: Requests
+          max_change_percentage: "% Change"

data/lib/pig_ci.rb

@@ -0,0 +1,146 @@
+require 'active_support'
+require 'active_support/core_ext/string/inflections'
+
+require 'pig_ci/version'
+require 'pig_ci/api'
+require 'pig_ci/decorator'
+require 'pig_ci/summary'
+require 'pig_ci/profiler_engine'
+require 'pig_ci/profiler'
+require 'pig_ci/metric'
+require 'pig_ci/report'
+
+module PigCI
+  extend self
+
+  attr_accessor :pid
+
+  attr_writer :tmp_directory
+  def tmp_directory
+    @tmp_directory || Pathname.new(Dir.getwd).join('tmp', 'pig-ci')
+  end
+
+  attr_writer :output_directory
+  def output_directory
+    @output_directory || Pathname.new(Dir.getwd).join('pig-ci')
+  end
+
+  attr_accessor :generate_terminal_summary
+  def generate_terminal_summary?
+    @generate_terminal_summary.nil? || @generate_terminal_summary
+  end
+
+  attr_accessor :generate_html_summary
+  def generate_html_summary?
+    @generate_html_summary.nil? || @generate_html_summary
+  end
+
+  attr_writer :max_change_percentage_precision
+  def max_change_percentage_precision
+    @max_change_percentage_precision || 1
+  end
+
+  attr_writer :report_memory_precision
+  def report_memory_precision
+    @report_memory_precision || 2
+  end
+
+  attr_writer :terminal_report_row_limit
+  def terminal_report_row_limit
+    @terminal_report_row_limit || -1
+  end
+
+  # PigCI.report_row_sort_by = Proc.new { |d| d[:max_change_percentage] * -1 }
+  attr_writer :report_row_sort_by
+  def report_row_sort_by(data)
+    (@report_row_sort_by || proc { |d| d[:max].to_i * -1 }).call(data)
+  end
+
+  attr_writer :historical_data_run_limit
+  def historical_data_run_limit
+    @historical_data_run_limit ||= 10
+  end
+
+  attr_writer :run_timestamp
+  def run_timestamp
+    @run_timestamp ||= Time.now.to_i.to_s
+  end
+
+  attr_writer :profiler_engine
+  def profiler_engine
+    @profiler_engine ||= PigCI::ProfilerEngine::Rails.new
+  end
+
+  attr_writer :api_base_uri
+  def api_base_uri
+    @api_base_uri || 'https://api.pigci.com'
+  end
+
+  attr_accessor :api_verify_ssl
+  def api_verify_ssl?
+    !@api_verify_ssl.nil? ? @api_verify_ssl : true
+  end
+
+  attr_accessor :api_key
+  def api_key?
+    !@api_key.nil? && @api_key != ''
+  end
+
+  attr_writer :commit_sha1
+  def commit_sha1
+    @commit_sha1 || ENV['CIRCLE_SHA1'] || ENV['TRAVIS_COMMIT'] || `git rev-parse HEAD`.strip
+  end
+
+  attr_writer :head_branch
+  def head_branch
+    @head_branch || ENV['CIRCLE_BRANCH'] || ENV['TRAVIS_BRANCH'] || `git rev-parse --abbrev-ref HEAD`.strip
+  end
+
+  attr_writer :locale
+  def locale
+    @locale || :en
+  end
+
+  module_function
+
+  def start(&block)
+    self.pid = Process.pid
+
+    block.call(self) if block_given?
+
+    # Add our translations
+    load_i18ns!
+
+    # Make sure our directories exist
+    Dir.mkdir(tmp_directory) unless File.exist?(tmp_directory)
+    Dir.mkdir(output_directory) unless File.exist?(output_directory)
+
+    # Purge any previous logs and attach some listeners
+    profiler_engine.setup!
+  end
+
+  def load_i18ns!
+    I18n.available_locales << PigCI.locale
+    I18n.load_path += Dir["#{File.expand_path('../config/locales/pig_ci', __dir__)}/*.{rb,yml}"]
+  end
+
+  def run_exit_tasks!
+    return if PigCI.pid != Process.pid || !PigCI.profiler_engine.request_captured?
+
+    # Save all the reports as JSON
+    profiler_engine.profilers.each(&:save!)
+
+    # Print the report summary to Terminal
+    PigCI::Summary::Terminal.new(reports: profiler_engine.reports).print! if PigCI.generate_terminal_summary?
+
+    # Save the report summary to the project root.
+    PigCI::Summary::HTML.new(reports: profiler_engine.reports).save! if PigCI.generate_html_summary?
+
+    # If they have an API key, share it with PigCI.com
+    PigCI::Api::Reports.new(reports: profiler_engine.reports).share! if PigCI.api_key?
+  end
+end
+
+at_exit do
+  PigCI.run_exit_tasks!
+end