test-prof 1.2.2 → 1.3.0

data/lib/test_prof/vernier.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module TestProf
+  # Vernier wrapper.
+  #
+  # Has 2 modes: global and per-example.
+  #
+  # Example:
+  #
+  #   # To activate global profiling you can use env variable
+  #   TEST_VERNIER=1 rspec ...
+  #
+  # To profile a specific examples add :vernier tag to it:
+  #
+  #   it "is doing heavy stuff", :vernier do
+  #     ...
+  #   end
+  #
+  module Vernier
+    # Vernier configuration
+    class Configuration
+      attr_accessor :mode, :target, :interval
+
+      def initialize
+        @mode = ENV.fetch("TEST_VERNIER_MODE", :wall).to_sym
+        @target = (ENV["TEST_VERNIER"] == "boot") ? :boot : :suite
+
+        sample_interval = ENV["TEST_VERNIER_INTERVAL"].to_i
+        @interval = (sample_interval > 0) ? sample_interval : nil
+      end
+
+      def boot?
+        target == :boot
+      end
+
+      def suite?
+        target == :suite
+      end
+    end
+
+    class << self
+      include Logging
+
+      def config
+        @config ||= Configuration.new
+      end
+
+      def configure
+        yield config
+      end
+
+      attr_reader :default_collector
+
+      # Run Vernier and automatically dump
+      # a report when the process exits or when the application is booted.
+      def run
+        collector = profile
+        return unless collector
+
+        @locked = true
+        @default_collector = collector
+
+        log :info, "Vernier enabled globally: " \
+                   "mode – #{config.mode}, target – #{config.target}"
+
+        at_exit { dump(collector, "total") } if config.suite?
+      end
+
+      def profile(name = nil)
+        if locked?
+          log :warn, <<~MSG
+            Vernier has been already activated.
+
+            Make sure you do not have the TEST_VERNIER environmental variable set somewhere.
+          MSG
+
+          return false
+        end
+
+        return false unless init_vernier
+
+        options = {}
+
+        options[:interval] = config.interval if config.interval
+
+        if block_given?
+          options[:mode] = config.mode
+          options[:out] = build_path(name)
+          ::Vernier.trace(**options) { yield }
+        else
+          collector = ::Vernier::Collector.new(config.mode, **options)
+          collector.start
+
+          collector
+        end
+      end
+
+      def dump(collector, name)
+        result = collector.stop
+
+        path = build_path(name)
+
+        File.write(path, ::Vernier::Output::Firefox.new(result).output)
+
+        log :info, "Vernier report generated: #{path}"
+      end
+
+      private
+
+      def build_path(name)
+        TestProf.artifact_path(
+          "vernier-report-#{config.mode}-#{name}.json"
+        )
+      end
+
+      def locked?
+        @locked == true
+      end
+
+      def init_vernier
+        return @initialized if instance_variable_defined?(:@initialized)
+        @locked = false
+        @initialized = TestProf.require(
+          "vernier",
+          <<~MSG
+            Please, install 'vernier' first:
+               # Gemfile
+              gem 'vernier', '>= 0.3.0', require: false
+          MSG
+        ) { check_vernier_version }
+      end
+
+      def check_vernier_version
+        if Utils.verify_gem_version("vernier", at_least: "0.3.0")
+          true
+        else
+          log :error, <<~MSG
+            Please, upgrade 'vernier' to version >= 0.3.0.
+          MSG
+          false
+        end
+      end
+    end
+  end
+end
+
+require "test_prof/vernier/rspec" if TestProf.rspec?
+
+# Hook to run Vernier globally
+TestProf.activate("TEST_VERNIER") do
+  TestProf::Vernier.run
+end

data/lib/test_prof/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestProf
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/lib/test_prof.rb

@@ -1,177 +1,15 @@
 # frozen_string_literal: true
 
-require "fileutils"
-require "logger"
-
 require "test_prof/version"
-require "test_prof/logging"
-require "test_prof/utils"
-
-# Ruby applications tests profiling tools.
-#
-# Contains tools to analyze 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
-
-    # Returns true if we're inside RSpec
-    def rspec?
-      defined?(RSpec::Core)
-    end
-
-    # Returns true if we're inside Minitest
-    def minitest?
-      defined?(Minitest)
-    end
-
-    # Returns true if Spring is used and not disabled
-    def spring?
-      # See https://github.com/rails/spring/blob/577cf01f232bb6dbd0ade7df2df2ac209697e741/lib/spring/binstub.rb
-      disabled = ENV["DISABLE_SPRING"]
-      defined?(::Spring::Application) && (disabled.nil? || disabled.empty? || disabled == "0")
-    end
-
-    # Returns the current process time
-    def now
-      Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    end
-
-    # Require gem and shows a custom
-    # message if it fails to load
-    def require(gem_name, msg = nil)
-      Kernel.require gem_name
-      block_given? ? yield : true
-    rescue LoadError
-      log(:error, msg) if msg
-      false
-    end
-
-    # Run block only if provided env var is present and
-    # equal to the provided value (if any).
-    # Contains workaround for applications using Spring.
-    def activate(env_var, val = nil)
-      if spring?
-        notify_spring_detected
-        ::Spring.after_fork do
-          activate!(env_var, val) do
-            notify_spring_activate env_var
-            yield
-          end
-        end
-      else
-        activate!(env_var, val) { 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 artifact
-    def artifact_path(filename)
-      create_artifact_dir
-
-      with_timestamps(
-        ::File.join(
-          config.output_dir,
-          with_report_suffix(
-            filename
-          )
-        )
-      )
-    end
-
-    def create_artifact_dir
-      FileUtils.mkdir_p(config.output_dir)[0]
-    end
-
-    private
-
-    def activate!(env_var, val)
-      yield if ENV[env_var] && (val.nil? || val === ENV[env_var])
-    end
-
-    def with_timestamps(path)
-      return path unless config.timestamps?
-      timestamps = "-#{now.to_i}"
-      "#{path.sub(/\.\w+$/, "")}#{timestamps}#{::File.extname(path)}"
-    end
-
-    def with_report_suffix(path)
-      return path if config.report_suffix.nil?
-
-      "#{path.sub(/\.\w+$/, "")}-#{config.report_suffix}#{::File.extname(path)}"
-    end
-
-    def notify_spring_detected
-      return if instance_variable_defined?(:@spring_notified)
-      log :info, "Spring detected"
-      @spring_notified = true
-    end
-
-    def notify_spring_activate(env_var)
-      log :info, "Activating #{env_var} with `Spring.after_fork`"
-    end
-  end
-
-  # TestProf configuration
-  class Configuration
-    attr_accessor :output, # IO to write logs
-      :color, # Whether to colorize output or not
-      :output_dir, # Directory to store artifacts
-      :timestamps, # Whether to use timestamped names for artifacts,
-      :report_suffix # Custom suffix for reports/artifacts
-
-    def initialize
-      @output = $stdout
-      @color = true
-      @output_dir = "tmp/test_prof"
-      @timestamps = false
-      @report_suffix = ENV["TEST_PROF_REPORT"]
-    end
-
-    def color?
-      color == true && output.is_a?(IO) && output.tty?
-    end
-
-    def timestamps?
-      timestamps == true
-    end
-
-    def logger
-      @logger ||= Logger.new(output, formatter: Logging::Formatter.new)
-    end
-  end
-end
+require "test_prof/core"
 
 require "test_prof/ruby_prof"
 require "test_prof/stack_prof"
+require "test_prof/vernier"
 require "test_prof/event_prof"
 require "test_prof/factory_doctor"
 require "test_prof/factory_prof"
+require "test_prof/memory_prof"
 require "test_prof/rspec_stamp"
 require "test_prof/tag_prof"
 require "test_prof/rspec_dissect" if TestProf.rspec?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2023-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,6 +143,7 @@ files:
 - lib/test_prof/cops/rspec/aggregate_examples/metadata_helpers.rb
 - lib/test_prof/cops/rspec/aggregate_examples/node_matchers.rb
 - lib/test_prof/cops/rspec/language.rb
+- lib/test_prof/core.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
@@ -179,6 +180,14 @@ files:
 - lib/test_prof/factory_prof/printers/nate_heckler.rb
 - lib/test_prof/factory_prof/printers/simple.rb
 - lib/test_prof/logging.rb
+- lib/test_prof/memory_prof.rb
+- lib/test_prof/memory_prof/minitest.rb
+- lib/test_prof/memory_prof/printer.rb
+- lib/test_prof/memory_prof/printer/number_to_human.rb
+- lib/test_prof/memory_prof/rspec.rb
+- lib/test_prof/memory_prof/tracker.rb
+- lib/test_prof/memory_prof/tracker/linked_list.rb
+- lib/test_prof/memory_prof/tracker/rss_tool.rb
 - lib/test_prof/recipes/logging.rb
 - lib/test_prof/recipes/minitest/before_all.rb
 - lib/test_prof/recipes/minitest/sample.rb
@@ -211,6 +220,8 @@ files:
 - lib/test_prof/utils/html_builder.rb
 - lib/test_prof/utils/rspec.rb
 - lib/test_prof/utils/sized_ordered_set.rb
+- lib/test_prof/vernier.rb
+- lib/test_prof/vernier/rspec.rb
 - lib/test_prof/version.rb
 homepage: http://github.com/test-prof/test-prof
 licenses:
@@ -237,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Ruby applications tests profiling tools