test-prof 0.1.0.beta1

data/lib/test_prof/stack_prof/rspec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Shared example for RSpec to profile specific examples with StackProf
+RSpec.shared_context "stackprof", sprof: true do
+  prepend_before do
+    @stack_prof_report = TestProf::StackProf.profile
+  end
+
+  append_after do |ex|
+    next unless @stack_prof_report
+    TestProf::StackProf.dump ex.full_description.parameterize
+  end
+end

data/lib/test_prof/stack_prof.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module TestProf
+  # StackProf wrapper.
+  #
+  # Has 2 modes: global and per-example.
+  #
+  # Example:
+  #
+  #   # To activate global profiling you can use env variable
+  #   TEST_STACK_PROF=1 rspec ...
+  #
+  #   # or in your code
+  #   TestProf::StackProf.run
+  #
+  # To profile a specific examples add :sprof tag to it:
+  #
+  #   it "is doing heavy stuff", :sprof do
+  #     ...
+  #   end
+  #
+  module StackProf
+    # StackProf configuration
+    class Configuration
+      attr_accessor :mode, :interval, :raw
+
+      def initialize
+        @mode = :wall
+        @raw = false
+      end
+    end
+
+    class << self
+      include Logging
+
+      def config
+        @config ||= Configuration.new
+      end
+
+      def configure
+        yield config
+      end
+
+      # Run StackProf and automatically dump
+      # a report when the process exits.
+      #
+      # Use this method to profile the whole run.
+      def run
+        return unless profile
+
+        @locked = true
+
+        log :info, "StackProf enabled"
+
+        at_exit { dump("total") }
+      end
+
+      def profile(name = nil)
+        return if locked?
+        return unless init_stack_prof
+
+        options = {
+          mode: config.mode,
+          raw: config.raw
+        }
+
+        options[:interval] = config.interval if config.interval
+
+        if block_given?
+          options[:out] = build_path(name)
+          ::StackProf.run(options) { yield }
+        else
+          ::StackProf.start(options)
+        end
+        true
+      end
+
+      def dump(name)
+        ::StackProf.stop
+
+        path = build_path(name)
+
+        ::StackProf.results(path)
+
+        log :info, "StackProf report generated: #{path}"
+      end
+
+      private
+
+      def build_path(name)
+        TestProf.artefact_path(
+          "stack-prof-report-#{config.mode}-#{name}.dump"
+        )
+      end
+
+      def locked?
+        @locked == true
+      end
+
+      def init_stack_prof
+        return @initialized if instance_variable_defined?(:@initialized)
+        @initialized = TestProf.require(
+          'stackprof',
+          <<~MSG
+            Please, install 'stackprof' first:
+               # Gemfile
+              gem 'stackprof', require: false
+          MSG
+        )
+      end
+    end
+  end
+end
+
+require "test_prof/stack_prof/rspec" if defined?(RSpec)
+
+# Hook to run StackProf globally
+TestProf.activate('TEST_STACK_PROF') do
+  TestProf::StackProf.run
+end

data/lib/test_prof/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TestProf
+  VERSION = "0.1.0.beta1"
+end

data/lib/test_prof.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "test_prof/version"
+require "test_prof/logging"
+
+# Ruby applications tests profiling tools.
+#
+# Contains tools to anylyze factories usage, integrate with Ruby profilers,
+# profile your examples using ActiveSupport notifications (if any) and
+# statically analyze your code with custom Rubocop cops.
+#
+# Example usage:
+#
+#   require 'test_prof'
+#
+#   # Activate a tool by providing environment variable, e.g.
+#   TEST_RUBY_PROF=1 rspec ...
+#
+#   # or manually in your code
+#   TestProf::RubyProf.run
+#
+# See other modules for more examples.
+module TestProf
+  class << self
+    include Logging
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+
+    # Require gem and shows a custom
+    # message if it fails to load
+    def require(gem_name, msg)
+      Kernel.require gem_name
+      true
+    rescue LoadError
+      log :error, msg
+      false
+    end
+
+    # Run block only if provided env var is present.
+    # Contains workaround for applications using Spring.
+    def activate(env_var)
+      if defined?(::Spring) && !ENV['DISABLE_SPRING']
+        Spring.after_fork { yield if ENV[env_var] }
+      elsif ENV[env_var]
+        yield
+      end
+    end
+
+    # Return absolute path to asset
+    def asset_path(filename)
+      ::File.expand_path(filename, ::File.join(::File.dirname(__FILE__), "..", "assets"))
+    end
+
+    # Return a path to store artefact
+    def artefact_path(filename)
+      with_timestamps(
+        ::File.join(
+          config.output_dir,
+          filename
+        )
+      )
+    end
+
+    private
+
+    def with_timestamps(path)
+      return path unless config.timestamps?
+      timestamps = "-#{Time.now.to_i}"
+      "#{path.sub(/\.\w+$/, '')}#{timestamps}#{::File.extname(path)}"
+    end
+  end
+
+  # TestProf configuration
+  class Configuration
+    attr_accessor :output,      # IO to write output messages.
+                  :color,       # Whether to colorize output or not
+                  :output_dir,  # Directory to store artifacts
+                  :timestamps   # Whethere to use timestamped names for artifacts
+
+    def initialize
+      @output = $stdout
+      @color = true
+      @output_dir = "tmp"
+      @timestamps = false
+    end
+
+    def color?
+      color == true
+    end
+
+    def timestamps?
+      timestamps == true
+    end
+  end
+end
+
+require "test_prof/ruby_prof"
+require "test_prof/stack_prof"
+require "test_prof/event_prof"
+require "test_prof/factory_doctor"
+require "test_prof/factory_prof"
+require "test_prof/rspec_stamp"

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: test-prof
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta1
+platform: ruby
+authors:
+- Vladimir Dementyev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: "\n    Ruby applications tests profiling tools.\n\n    Contains tools
+  to anylyze factories usage, integrate with Ruby profilers,\n    profile your examples
+  using ActiveSupport notifications (if any) and\n    statically analyze your code
+  with custom Rubocop cops.\n  "
+email:
+- dementiev.vm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- assets/flamegraph.demo.html
+- assets/flamegraph.template.html
+- assets/src/d3-tip.js
+- assets/src/d3-tip.min.js
+- assets/src/d3.flameGraph.css
+- assets/src/d3.flameGraph.js
+- assets/src/d3.flameGraph.min.css
+- assets/src/d3.flameGraph.min.js
+- assets/src/d3.v4.min.js
+- guides/any_fixture.md
+- guides/before_all.md
+- guides/event_prof.md
+- guides/factory_doctor.md
+- guides/factory_prof.md
+- guides/rspec_stamp.md
+- guides/rubocop.md
+- guides/ruby_prof.md
+- guides/stack_prof.md
+- lib/test-prof.rb
+- lib/test_prof.rb
+- lib/test_prof/any_fixture.rb
+- lib/test_prof/cops/rspec/aggregate_failures.rb
+- lib/test_prof/event_prof.rb
+- lib/test_prof/event_prof/custom_events.rb
+- lib/test_prof/event_prof/custom_events/factory_create.rb
+- lib/test_prof/event_prof/custom_events/sidekiq_inline.rb
+- lib/test_prof/event_prof/custom_events/sidekiq_jobs.rb
+- lib/test_prof/event_prof/instrumentations/active_support.rb
+- lib/test_prof/event_prof/minitest.rb
+- lib/test_prof/event_prof/rspec.rb
+- lib/test_prof/ext/float_duration.rb
+- lib/test_prof/factory_doctor.rb
+- lib/test_prof/factory_doctor/factory_girl_patch.rb
+- lib/test_prof/factory_doctor/minitest.rb
+- lib/test_prof/factory_doctor/rspec.rb
+- lib/test_prof/factory_prof.rb
+- lib/test_prof/factory_prof/factory_girl_patch.rb
+- lib/test_prof/factory_prof/printers/flamegraph.rb
+- lib/test_prof/factory_prof/printers/simple.rb
+- lib/test_prof/logging.rb
+- lib/test_prof/recipes/rspec/any_fixture.rb
+- lib/test_prof/recipes/rspec/before_all.rb
+- lib/test_prof/rspec_stamp.rb
+- lib/test_prof/rspec_stamp/parser.rb
+- lib/test_prof/rspec_stamp/rspec.rb
+- lib/test_prof/rubocop.rb
+- lib/test_prof/ruby_prof.rb
+- lib/test_prof/ruby_prof/rspec.rb
+- lib/test_prof/stack_prof.rb
+- lib/test_prof/stack_prof/rspec.rb
+- lib/test_prof/version.rb
+homepage: http://github.com/palkan/test-prof
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby applications tests profiling tools
+test_files: []