mutant 0.7.9 → 0.8.0

data/lib/mutant/reporter/cli/printer/config.rb

@@ -0,0 +1,32 @@
+module Mutant
+  class Reporter
+    class CLI
+      class Printer
+        # Printer for mutation config
+        class Config < self
+
+          # Report configuration
+          #
+          # @param [Mutant::Config] config
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          # rubocop:disable AbcSize
+          #
+          def run
+            info 'Mutant configuration:'
+            info 'Matcher:         %s',      object.matcher.inspect
+            info 'Integration:     %s',      object.integration.name
+            info 'Expect Coverage: %0.2f%%', (object.expected_coverage * 100)
+            info 'Jobs:            %d',      object.jobs
+            info 'Includes:        %s',      object.includes
+            info 'Requires:        %s',      object.requires
+          end
+
+        end # Config
+      end # Printer
+    end # CLI
+  end # Reporter
+end # Mutant

data/lib/mutant/reporter/cli/printer/env_progress.rb

@@ -0,0 +1,66 @@
+module Mutant
+  class Reporter
+    class CLI
+      class Printer
+        # Env progress printer
+        class EnvProgress < self
+          delegate(
+            :coverage,
+            :amount_subjects,
+            :amount_mutations,
+            :amount_mutations_alive,
+            :amount_mutations_killed,
+            :runtime,
+            :killtime,
+            :overhead,
+            :env
+          )
+
+          # Run printer
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          # rubocop:disable MethodLength
+          # rubocop:disable AbcSize
+          #
+          def run
+            visit(Config, env.config)
+            info 'Subjects:        %s',        amount_subjects
+            info 'Mutations:       %s',        amount_mutations
+            info 'Kills:           %s',        amount_mutations_killed
+            info 'Alive:           %s',        amount_mutations_alive
+            info 'Runtime:         %0.2fs',    runtime
+            info 'Killtime:        %0.2fs',    killtime
+            info 'Overhead:        %0.2f%%',   overhead_percent
+            status 'Coverage:        %0.2f%%', coverage_percent
+            status 'Expected:        %0.2f%%', (env.config.expected_coverage * 100)
+          end
+
+        private
+
+          # Return coverage percent
+          #
+          # @return [Float]
+          #
+          # @api private
+          #
+          def coverage_percent
+            coverage * 100
+          end
+
+          # Return overhead percent
+          #
+          # @return [Float]
+          #
+          # @api private
+          #
+          def overhead_percent
+            (overhead / killtime) * 100
+          end
+        end # EnvProgress
+      end # Printer
+    end # CLI
+  end # Reporter
+end # Mutant

data/lib/mutant/reporter/cli/printer/env_result.rb

@@ -0,0 +1,23 @@
+module Mutant
+  class Reporter
+    class CLI
+      class Printer
+        # Full env result reporter
+        class EnvResult < self
+          delegate(:failed_subject_results)
+
+          # Run printer
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          def run
+            visit_collection(SubjectResult, failed_subject_results)
+            visit(EnvProgress, object)
+          end
+        end # EnvResult
+      end # Printer
+    end # CLI
+  end # Reporter
+end # Mutant

data/lib/mutant/reporter/cli/printer/mutation_progress_result.rb

@@ -0,0 +1,37 @@
+module Mutant
+  class Reporter
+    class CLI
+      class  Printer
+        # Printer for mutation progress results
+        class MutationProgressResult < self
+          SUCCESS = '.'.freeze
+          FAILURE = 'F'.freeze
+
+          # Run printer
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          def run
+            char(success? ? SUCCESS : FAILURE)
+          end
+
+        private
+
+          # Write colorized char
+          #
+          # @param [String] char
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          def char(char)
+            output.write(colorize(status_color, char))
+          end
+        end # MutationProgressResult
+      end # Printer
+    end # CLI
+  end # Reporter
+end # Mutant

data/lib/mutant/reporter/cli/printer/mutation_result.rb

@@ -0,0 +1,151 @@
+module Mutant
+  class Reporter
+    class CLI
+      class Printer
+        # Reporter for mutation results
+        class MutationResult < self
+
+          delegate :mutation, :test_result
+
+          DIFF_ERROR_MESSAGE =
+            'BUG: Mutation NOT resulted in exactly one diff hunk. Please report a reproduction!'.freeze
+
+          MAP = {
+            Mutant::Mutation::Evil    => :evil_details,
+            Mutant::Mutation::Neutral => :neutral_details,
+            Mutant::Mutation::Noop    => :noop_details
+          }.freeze
+
+          NEUTRAL_MESSAGE =
+            "--- Neutral failure ---\n" \
+            "Original code was inserted unmutated. And the test did NOT PASS.\n" \
+            "Your tests do not pass initially or you found a bug in mutant / unparser.\n" \
+            "Subject AST:\n" \
+            "%s\n" \
+            "Unparsed Source:\n" \
+            "%s\n" \
+            "Test Result:\n".freeze
+
+          NO_DIFF_MESSAGE =
+            "--- Internal failure ---\n" \
+            "BUG: Mutation NOT resulted in exactly one diff hunk. Please report a reproduction!\n" \
+            "Original unparsed source:\n" \
+            "%s\n" \
+            "Original AST:\n" \
+            "%s\n" \
+            "Mutated unparsed source:\n" \
+            "%s\n" \
+            "Mutated AST:\n" \
+            "%s\n".freeze
+
+          NOOP_MESSAGE    =
+            "---- Noop failure -----\n" \
+            "No code was inserted. And the test did NOT PASS.\n" \
+            "This is typically a problem of your specs not passing unmutated.\n" \
+            "Test Result:\n".freeze
+
+          FOOTER = '-----------------------'.freeze
+
+          # Run report printer
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          def run
+            puts(mutation.identification)
+            print_details
+            puts(FOOTER)
+          end
+
+        private
+
+          # Return details
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          def print_details
+            __send__(MAP.fetch(mutation.class))
+          end
+
+          # Return evil details
+          #
+          # @return [String]
+          #
+          # @api private
+          #
+          def evil_details
+            diff = Diff.build(mutation.original_source, mutation.source)
+            diff = color? ? diff.colorized_diff : diff.diff
+            if diff
+              output.write(diff)
+            else
+              print_no_diff_message
+            end
+          end
+
+          # Print no diff message
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          def print_no_diff_message
+            info(
+              NO_DIFF_MESSAGE,
+              mutation.original_source,
+              original_node.inspect,
+              mutation.source,
+              mutation.node.inspect
+            )
+          end
+
+          # Noop details
+          #
+          # @return [String]
+          #
+          # @api private
+          #
+          def noop_details
+            info(NOOP_MESSAGE)
+            visit_test_result
+          end
+
+          # Neutral details
+          #
+          # @return [String]
+          #
+          # @api private
+          #
+          def neutral_details
+            info(NEUTRAL_MESSAGE, original_node.inspect, mutation.source)
+            visit_test_result
+          end
+
+          # Visit failed test results
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          def visit_test_result
+            visit(TestResult, test_result)
+          end
+
+          # Return original node
+          #
+          # @return [Parser::AST::Node]
+          #
+          # @api private
+          #
+          def original_node
+            mutation.subject.node
+          end
+
+        end # MutationResult
+      end # Printer
+    end # CLI
+  end # Reporter
+end # Mutant

data/lib/mutant/reporter/cli/printer/status.rb

@@ -0,0 +1,60 @@
+module Mutant
+  class Reporter
+    class CLI
+      class Printer
+        # Printer for runner status
+        class Status < self
+
+          delegate(:active_jobs, :payload)
+
+          ACTIVE_JOB_HEADER = 'Active Jobs:'.freeze
+          ACTIVE_JOB_FORMAT = '%d: %s'.freeze
+
+          # Print progress for collector
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          def run
+            visit(EnvProgress, payload)
+            job_status
+            info('Active subjects: %d', active_subject_results.length)
+            visit_collection(SubjectProgress, active_subject_results)
+          end
+
+        private
+
+          # Print worker status
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          def job_status
+            return if active_jobs.empty?
+            info(ACTIVE_JOB_HEADER)
+            active_jobs.sort_by(&:index).each do |job|
+              info(ACTIVE_JOB_FORMAT, job.index, job.payload.identification)
+            end
+          end
+
+          # Return active subject results
+          #
+          # @return [Array<Result::Subject>]
+          #
+          # @api private
+          #
+          def active_subject_results
+            active_subjects = active_jobs.map(&:payload).flat_map(&:subject)
+
+            payload.subject_results.select do |subject_result|
+              active_subjects.include?(subject_result.subject)
+            end
+          end
+
+        end # Status
+      end # Printer
+    end # CLI
+  end # Reporter
+end # Mutant

data/lib/mutant/reporter/cli/printer/status_progressive.rb

@@ -0,0 +1,52 @@
+module Mutant
+  class Reporter
+    class CLI
+      class Printer
+        # Reporter for progressive output format on scheduler Status objects
+        class StatusProgressive < self
+          FORMAT = '(%02d/%02d) %3d%% - killtime: %0.02fs runtime: %0.02fs overhead: %0.02fs'.freeze
+
+          delegate(
+            :coverage,
+            :runtime,
+            :amount_mutations_killed,
+            :amount_mutations,
+            :amount_mutation_results,
+            :killtime,
+            :overhead
+          )
+
+          # Run printer
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          def run
+            status(
+              FORMAT,
+              amount_mutations_killed,
+              amount_mutations,
+              coverage * 100,
+              killtime,
+              runtime,
+              overhead
+            )
+          end
+
+        private
+
+          # Return object being printed
+          #
+          # @return [Result::Env]
+          #
+          # @api private
+          #
+          def object
+            super.payload
+          end
+        end # StatusProgressive
+      end # Printer
+    end # CLI
+  end # Reporter
+end # Mutant

data/lib/mutant/reporter/cli/printer/subject_progress.rb

@@ -0,0 +1,90 @@
+module Mutant
+  class Reporter
+    class CLI
+      class Printer
+        # Reporter for subject progress
+        class SubjectProgress < self
+          FORMAT = '(%02d/%02d) %3d%% - killtime: %0.02fs runtime: %0.02fs overhead: %0.02fs'.freeze
+
+          delegate(
+            :tests,
+            :subject,
+            :coverage,
+            :runtime,
+            :amount_mutations_killed,
+            :amount_mutations,
+            :amount_mutation_results,
+            :killtime,
+            :overhead
+          )
+
+          # Run printer
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          def run
+            puts("#{subject.identification} mutations: #{amount_mutations}")
+            print_mutation_results
+            print_progress_bar_finish
+            print_stats
+            print_tests
+          end
+
+        private
+
+          # Print stats
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          def print_stats
+            status(
+              FORMAT,
+              amount_mutations_killed,
+              amount_mutations,
+              coverage * 100,
+              killtime,
+              runtime,
+              overhead
+            )
+          end
+
+          # Print tests
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          def print_tests
+            tests.each do |test|
+              puts "- #{test.identification}"
+            end
+          end
+
+          # Print progress bar finish
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          def print_progress_bar_finish
+            puts(nil) unless amount_mutation_results.zero?
+          end
+
+          # Print mutation results
+          #
+          # @return [undefined]
+          #
+          # @api private
+          #
+          def print_mutation_results
+            visit_collection(MutationProgressResult, object.mutation_results)
+          end
+        end # SubjectProgress
+      end # Printer
+    end # CLI
+  end # Reporter
+end # Mutant