test-prof-autopilot 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6b29ef753d35ba43c38480f03c1add33a6b13cbd44af7993a2c832fdc112fab
-  data.tar.gz: cf9350ecb966825cebcd9c011cfbaddb089b34b8299e038f94b4679eae1a5b8d
+  metadata.gz: da180b01be948feec684ca0b80005809678834cec159dc8af26b8dcc8549d31f
+  data.tar.gz: e42323a7e60dbd7198cf4772153f6c42e3544a4b60fc55f66c1fb335055e0aad
 SHA512:
-  metadata.gz: cf235d7c96b20d9db4f33c31fcddf11112bc6ecf5ad6e305aa7417c034100e27c0b3c14734b7e04a3324ebcbac102deefc2f303fa7ecda6c9bbda5d4c85c86e0
-  data.tar.gz: ab28bcc384705b84f195fa210cad6d7edf995e8273b8ccbc3acc7a7588cb2dcb8402fdf37bfe2e333bbb0d2fe0c91c7be4552d85095b898138fece8cd1264492
+  metadata.gz: 18ec8fffa21d68373ff74f32da3ff1f08c9146a0e74c22e9fd420dc469f61fec1ef7808f06f614caea0ca8c11967cf159163724248a9411fb2ace7f081671e2f
+  data.tar.gz: 5db488c8dd13b78fc623eddf05ca69465f212e1bb8f6492dd62370f9415e061cc455448d7067f9e05bfce8ef8aac048e471487a61c32c983927dd6ba0fcaaf63

data/lib/test_prof/autopilot/cli.rb

@@ -2,22 +2,31 @@
 
 require "optparse"
 require "test_prof/autopilot/runner"
+require "test_prof/autopilot/merger"
 
 module TestProf
   module Autopilot
     class CLI
-      attr_reader :command, :plan_path
+      attr_reader :command, :plan_path, :mode, :merge_type, :report_paths
 
       def run(args = ARGV)
+        @mode = "runner"
+
         optparser.parse!(args)
 
-        raise "Test command must be specified. See -h for options" unless command
+        if mode == "runner"
+          raise "Test command must be specified. See -h for options" unless command
+
+          raise "Plan path must be specified. See -h for options" unless plan_path
 
-        raise "Plan path must be specified. See -h for options" unless plan_path
+          raise "Plan #{plan_path} doesn't exist" unless File.file?(plan_path)
 
-        raise "Plan #{plan_path} doesn't exist" unless File.file?(plan_path)
+          Runner.invoke(plan_path, command)
+        elsif mode == "merger"
+          raise "Report paths must be specified. See -h for options" unless report_paths
 
-        Runner.invoke(plan_path, command)
+          Merger.invoke(merge_type, report_paths)
+        end
       end
 
       private
@@ -38,6 +47,24 @@ module TestProf
           opts.on("-i FILE", "--plan", "Path to test plan") do |val|
             @plan_path = val
           end
+
+          # Merger-specific options
+          opts.on("--merge=TYPE", "Merge existing reports of the specified type") do |val|
+            @mode = "merger"
+            @merge_type = val
+          end
+
+          opts.on("--reports=PATH", "Reports path glob or comma-separated paths") do |val|
+            @report_paths = val.split(",")
+          end
+
+          opts.on("--merge-format=FORMAT", "Combined report format") do |val|
+            Autopilot.config.merge_format = val
+          end
+
+          opts.on("--merge-file=PATH", "Where to store combined report") do |val|
+            Autopilot.config.merge_file = File.absolute_path?(val) ? val : File.expand_path(val)
+          end
         end
       end
     end

data/lib/test_prof/autopilot/configuration.rb

@@ -18,12 +18,15 @@ module TestProf
         :tmp_dir,
         :artifacts_dir,
         :plan_path,
+        :merge_format,
+        :merge_file,
         :command
 
       def initialize
         @output = $stdout
         @tmp_dir = "tmp/test_prof_autopilot"
         @artifacts_dir = "test_prof_autopilot"
+        @merge_format = "info"
       end
     end
   end

data/lib/test_prof/autopilot/dsl.rb

@@ -2,8 +2,14 @@
 
 require "test_prof/autopilot/event_prof/printer"
 require "test_prof/autopilot/event_prof/profiling_executor"
+require "test_prof/autopilot/event_prof/writer"
+
+require "test_prof/autopilot/tag_prof/printer"
+require "test_prof/autopilot/tag_prof/profiling_executor"
+require "test_prof/autopilot/tag_prof/writer"
 
 require "test_prof/autopilot/factory_prof/printer"
+require "test_prof/autopilot/factory_prof/writer"
 require "test_prof/autopilot/factory_prof/profiling_executor"
 
 require "test_prof/autopilot/stack_prof/printer"

data/lib/test_prof/autopilot/event_prof/printer.rb

@@ -20,10 +20,10 @@ module TestProf
           msgs <<
             <<~MSG
               EventProf results for #{result["event"]}
-  
+
               Total time: #{result["total_time"].duration} of #{result["absolute_run_time"].duration} (#{result["time_percentage"]}%)
               Total events: #{result["total_count"]}
-  
+
               Top #{result["top_count"]} slowest suites (by #{result["rank_by"]}):
             MSG
 

data/lib/test_prof/autopilot/event_prof/profiling_executor.rb

@@ -18,6 +18,7 @@ module TestProf
 
         def validate_profiler!
           super
+          @options[:event] = @options[:events].join(",") if @options[:events]
           raise ArgumentError, "'event' option is required for 'event_prof' profiler" if @options[:event].nil?
         end
 

data/lib/test_prof/autopilot/event_prof/report.rb

@@ -25,6 +25,22 @@ module TestProf
         def paths
           @raw_report["groups"].reduce("") { |paths, group| "#{paths} #{group["location"]}" }.strip
         end
+
+        def merge(other)
+          raise ArgumentError, "Incompatible events: #{raw_report["event"]} and #{other.raw_report["event"]}" if raw_report["event"] != other.raw_report["event"]
+
+          report = raw_report.dup
+
+          %w[total_time absolute_run_time total_count].each do |field|
+            report[field] += other.raw_report[field]
+          end
+
+          report["time_percentage"] = (report["total_time"] / report["absolute_run_time"]) * 100
+
+          report["groups"] = (report["groups"] + other.raw_report["groups"]).sort { |a, b| b["time"] <=> a["time"] }.take(report["top_count"])
+
+          Report.new(report)
+        end
       end
     end
   end

data/lib/test_prof/autopilot/event_prof/writer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "test_prof/autopilot/report_writer"
+
+module TestProf
+  module Autopilot
+    module EventProf
+      # Class is used for writing :event_prof report in different formats
+      class Writer < ReportWriter
+        Registry.register(:event_prof_writer, self)
+
+        ARTIFACT_FILE = "event_prof_report"
+
+        def generate_json
+          JSON.generate(report.raw_report)
+        end
+      end
+    end
+  end
+end

data/lib/test_prof/autopilot/factory_prof/profiling_executor.rb

@@ -18,7 +18,7 @@ module TestProf
 
         def build_env
           super.tap do |env|
-            env["FPROF"] = "1"
+            env["FPROF"] = @options[:flamegraph] ? "flamegraph" : "1"
           end
         end
       end

data/lib/test_prof/autopilot/factory_prof/writer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module TestProf
+  module Autopilot
+    module FactoryProf
+      # Module is used for writing :factory_prof report in different formats
+      module Writer
+        Registry.register(:factory_prof_writer, self)
+
+        ARTIFACT_FILE = "factory_prof_report"
+
+        def write_report(report, file_name: ARTIFACT_FILE)
+          dir_path = FileUtils.mkdir_p(Autopilot.config.artifacts_dir)[0]
+          file_path = File.join(dir_path, file_name + ".json")
+
+          File.write(file_path, JSON.generate(report.raw_report))
+
+          Logging.log "FactoryProf report saved: #{file_path}"
+        end
+
+        module_function :write_report
+      end
+    end
+  end
+end

data/lib/test_prof/autopilot/merger.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "test_prof/autopilot/configuration"
+require "test_prof/autopilot/registry"
+require "test_prof/autopilot/logging"
+require "test_prof/autopilot/dsl"
+require "fileutils"
+
+module TestProf
+  module Autopilot
+    class Merger
+      prepend Dsl
+
+      class << self
+        def invoke(type, paths)
+          Logging.log "Merging #{type} reports at #{paths.join(", ")}..."
+
+          paths = paths.flat_map(&Dir.method(:glob))
+
+          new(type, paths).print_report
+        end
+      end
+
+      attr_reader :type, :report_class, :paths
+
+      def initialize(type, paths)
+        @type = type
+        @paths = paths
+        @report_class = Registry.fetch(:"#{type}_report")
+      end
+
+      def print_report
+        format = Autopilot.config.merge_format
+        if format == "info"
+          info agg_report
+        else
+          save agg_report, format: format, file_name: Autopilot.config.merge_file
+        end
+      end
+
+      private
+
+      def agg_report
+        return @agg_report if instance_variable_defined?(:@agg_report)
+
+        initial = report_class.new(JSON.parse(File.read(paths.pop)))
+
+        paths.reduce(initial) do |acc, path|
+          report = report_class.new(JSON.parse(File.read(path)))
+
+          acc.merge(report)
+        end
+      end
+    end
+  end
+end

data/lib/test_prof/autopilot/patches/factory_prof_patch.rb

@@ -33,6 +33,28 @@ module TestProf
               File.write(file_path, JSON.generate(profiler_hash))
             end
           end
+
+          TestProf::FactoryProf::Printers::Flamegraph.module_eval do
+            def self.dump(result, **)
+              profiler_hash =
+                if result.raw_stats == {}
+                  {
+                    error: "No factories detected"
+                  }
+                else
+                  {
+                    total_stacks: result.stacks.size,
+                    total: result.total_count,
+                    roots: convert_stacks(result)
+                  }
+                end
+
+              dir_path = FileUtils.mkdir_p(Autopilot.config.tmp_dir)[0]
+              file_path = File.join(dir_path, ARTIFACT_FILE)
+
+              File.write(file_path, JSON.generate(profiler_hash))
+            end
+          end
         end
 
         module_function :patch

data/lib/test_prof/autopilot/patches/tag_prof_patch.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module TestProf
+  module Autopilot
+    module Patches
+      # Monkey-patch for 'TestProf::TagProf::RSpecListener'.
+      # Redefined 'report' method provides writing artifact to the directory
+      # instead of printing report
+      module TagProfPatch
+        ARTIFACT_FILE = "tag_prof_report.json"
+
+        def patch
+          TestProf::TagProf::RSpecListener.class_eval do
+            def report
+              dir_path = FileUtils.mkdir_p(Autopilot.config.tmp_dir)[0]
+              file_path = File.join(dir_path, ARTIFACT_FILE)
+
+              File.write(file_path, result.to_json)
+            end
+          end
+        end
+
+        module_function :patch
+      end
+    end
+  end
+end
+
+TestProf::Autopilot::Patches::TagProfPatch.patch

data/lib/test_prof/autopilot/profiling_executor/base.rb

@@ -2,6 +2,7 @@
 
 require "test_prof/autopilot/command_executor"
 require "test_prof/autopilot/event_prof/report"
+require "test_prof/autopilot/tag_prof/report"
 require "test_prof/autopilot/factory_prof/report"
 require "test_prof/autopilot/stack_prof/report"
 

data/lib/test_prof/autopilot/report_writer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module TestProf
+  module Autopilot
+    # Base class for report writers classes
+    class ReportWriter
+      include Logging
+
+      class << self
+        def write_report(report, **options)
+          new(report).write(**options)
+        end
+      end
+
+      attr_reader :report
+
+      def initialize(report)
+        @report = report
+      end
+
+      def write(file_name: nil, format: "json")
+        file_path = file_name || self.class::ARTIFACT_FILE
+
+        if File.absolute_path?(file_path)
+          FileUtils.mkdir_p(File.dirname(file_path))
+        else
+          dir_path = FileUtils.mkdir_p(Autopilot.config.artifacts_dir)[0]
+          file_path = File.join(dir_path, file_path + ".#{format}")
+        end
+
+        File.write(file_path, public_send("generate_#{format}"))
+
+        log "Report saved: #{file_path}"
+      end
+
+      def generate_json
+      end
+    end
+  end
+end

data/lib/test_prof/autopilot/stack_prof/writer.rb

@@ -1,22 +1,19 @@
 # frozen_string_literal: true
 
+require "test_prof/autopilot/report_writer"
+
 module TestProf
   module Autopilot
     module StackProf
-      # Module is used for writing :stack_prof report in different formats
-      module Writer
+      # Class is used for writing :stack_prof report in different formats
+      class Writer < ReportWriter
         Registry.register(:stack_prof_writer, self)
 
         ARTIFACT_FILE = "stack_prof_report"
 
-        def write_report(report, file_name: ARTIFACT_FILE)
-          dir_path = FileUtils.mkdir_p(Autopilot.config.artifacts_dir)[0]
-          file_path = File.join(dir_path, file_name + ".json")
-
-          File.write(file_path, JSON.generate(report.data))
+        def generate_json
+          JSON.generate(report.data)
         end
-
-        module_function :write_report
       end
     end
   end

data/lib/test_prof/autopilot/tag_prof/printer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "test_prof"
+require "test_prof/tag_prof/printers/simple"
+
+module TestProf
+  module Autopilot
+    module TagProf
+      # Module is used for printing :tag_prof report
+      module Printer
+        Registry.register(:tag_prof_printer, self)
+
+        def print_report(report)
+          TestProf::TagProf::Printers::Simple.dump(report.result)
+        end
+
+        module_function :print_report
+      end
+    end
+  end
+end

data/lib/test_prof/autopilot/tag_prof/profiling_executor.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "test_prof/autopilot/profiling_executor/base"
+
+module TestProf
+  module Autopilot
+    module TagProf
+      # Provides :tag_prof specific validations, env and command building.
+      class ProfilingExecutor < ProfilingExecutor::Base
+        Registry.register(:tag_prof_executor, self)
+
+        def initialize(options)
+          super
+          @profiler = :tag_prof
+        end
+
+        private
+
+        def validate_profiler!
+          super
+          @options[:event] = @options[:events].join(",") if @options[:events]
+          @options[:tag] ||= "type"
+        end
+
+        def build_env
+          super.tap do |env|
+            env["TAG_PROF"] = @options[:tag]
+            env["TAG_PROF_EVENT"] = @options[:event] if @options[:event]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_prof/autopilot/tag_prof/report.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "json"
+require "test_prof/autopilot/report_builder"
+require "test_prof/tag_prof/result"
+
+module TestProf
+  module Autopilot
+    module TagProf
+      # :tag_prof report allows to add additional functionality
+      # for it's instances
+      class Report
+        Registry.register(:tag_prof_report, self)
+
+        extend ReportBuilder
+
+        ARTIFACT_FILE = "tag_prof_report.json"
+
+        SYMBOLIC_DATA_KEYS = %w[value count time].freeze
+
+        attr_reader :type, :raw_report
+
+        def initialize(raw_report)
+          @type = :tag_prof
+          @raw_report = raw_report
+        end
+
+        def result
+          @result ||= TestProf::TagProf::Result.new(raw_report["tag"], raw_report["events"]).tap do |result|
+            raw_report["data"].each do |tag_data|
+              result.data[tag_data["value"]] = tag_data.transform_keys do |key|
+                SYMBOLIC_DATA_KEYS.include?(key) ? key.to_sym : key
+              end
+            end
+          end
+        end
+
+        def merge(other)
+          raise ArgumentError, "Tags must be identical: #{raw_report["tag"]} and #{other.raw_report["tag"]}" unless raw_report["tag"] == other.raw_report["tag"]
+
+          new_report = raw_report.dup
+
+          (raw_report["data"] + other.raw_report["data"]).each_with_object({}) do |tag_data, acc|
+            if acc.key?(tag_data["value"])
+              el = acc[tag_data["value"]]
+              tag_data.each do |field, val|
+                next if field == "value"
+                next unless el.key?(field)
+
+                el[field] += val
+              end
+            else
+              acc[tag_data["value"]] = tag_data.dup
+            end
+          end.then do |new_data|
+            new_report["data"] = new_data.values
+          end
+
+          Report.new(new_report)
+        end
+      end
+    end
+  end
+end

data/lib/test_prof/autopilot/tag_prof/writer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "test_prof/autopilot/report_writer"
+require "test_prof/tag_prof/printers/html"
+
+module TestProf
+  module Autopilot
+    module TagProf
+      # Class is used for writing :tag_prof report in different formats
+      class Writer < ReportWriter
+        Registry.register(:tag_prof_writer, self)
+
+        ARTIFACT_FILE = "tag_prof_report"
+
+        def generate_json
+          report.result.to_json
+        end
+
+        def generate_html
+          path = TestProf::Utils::HTMLBuilder.generate(
+            data: report.result,
+            template: TestProf::TagProf::Printers::HTML::TEMPLATE,
+            output: TestProf::TagProf::Printers::HTML::OUTPUT_NAME
+          )
+
+          File.read(path).tap do
+            FileUtils.rm(path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_prof/autopilot/version.rb

@@ -2,6 +2,6 @@
 
 module TestProf
   module Autopilot # :nodoc:
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/lib/test_prof/autopilot.rb

@@ -3,5 +3,6 @@
 require "test-prof"
 require "test_prof/autopilot/configuration"
 require "test_prof/autopilot/patches/event_prof_patch"
+require "test_prof/autopilot/patches/tag_prof_patch"
 require "test_prof/autopilot/patches/factory_prof_patch"
 require "test_prof/autopilot/patches/stack_prof_patch"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test-prof-autopilot
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ruslan Shakirov
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-13 00:00:00.000000000 Z
+date: 2022-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-prof
@@ -26,61 +26,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: stackprof
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.9
-  type: :runtime
+        version: '1.15'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.9
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: stackprof
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: 0.2.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: 0.2.9
 description: Automatic TestProf runner
 email:
 - ruslan@shakirov.dev
@@ -103,21 +103,30 @@ files:
 - lib/test_prof/autopilot/event_prof/printer.rb
 - lib/test_prof/autopilot/event_prof/profiling_executor.rb
 - lib/test_prof/autopilot/event_prof/report.rb
+- lib/test_prof/autopilot/event_prof/writer.rb
 - lib/test_prof/autopilot/factory_prof/printer.rb
 - lib/test_prof/autopilot/factory_prof/profiling_executor.rb
 - lib/test_prof/autopilot/factory_prof/report.rb
+- lib/test_prof/autopilot/factory_prof/writer.rb
 - lib/test_prof/autopilot/logging.rb
+- lib/test_prof/autopilot/merger.rb
 - lib/test_prof/autopilot/patches/event_prof_patch.rb
 - lib/test_prof/autopilot/patches/factory_prof_patch.rb
 - lib/test_prof/autopilot/patches/stack_prof_patch.rb
+- lib/test_prof/autopilot/patches/tag_prof_patch.rb
 - lib/test_prof/autopilot/profiling_executor/base.rb
 - lib/test_prof/autopilot/registry.rb
 - lib/test_prof/autopilot/report_builder.rb
+- lib/test_prof/autopilot/report_writer.rb
 - lib/test_prof/autopilot/runner.rb
 - lib/test_prof/autopilot/stack_prof/printer.rb
 - lib/test_prof/autopilot/stack_prof/profiling_executor.rb
 - lib/test_prof/autopilot/stack_prof/report.rb
 - lib/test_prof/autopilot/stack_prof/writer.rb
+- lib/test_prof/autopilot/tag_prof/printer.rb
+- lib/test_prof/autopilot/tag_prof/profiling_executor.rb
+- lib/test_prof/autopilot/tag_prof/report.rb
+- lib/test_prof/autopilot/tag_prof/writer.rb
 - lib/test_prof/autopilot/version.rb
 homepage: http://github.com/test-prof/test-prof-autopilot
 licenses:
@@ -131,14 +140,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Automatic TestProf runner