dotpretty 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f49efdc481cac0f784e3c65cb68cdf854376a0df3b6082baef9a893469a27a6b
-  data.tar.gz: 87d1b72bab6148ff502796e1c29d6bf786b08c3deeae45aa08f453dbaffaec63
+  metadata.gz: fdf29d364ee36b5ec7a9d54e2e80441d70a21a6b41bb89fb299f108081ba35bf
+  data.tar.gz: 16d74cfdcefa4ef0c16207998e1ece6e61ff5e4f46f24849a9915f3f2e34c1f0
 SHA512:
-  metadata.gz: d262321031ccdc28a5e137697ecaed5bc168509de3e9ca4303ad672f072b35d8c857b3ddd1876fce04a51571e2568254e5928b300b1ec8a2524d5dc364b8f7d9
-  data.tar.gz: f13f21aacfd75aca9f9f4970958f63868d3a4b5b13ac56b4ea9f9dd84ca7c5364343dc50310bbd01c65206c75ea7b7314d0363a1c042225ff4f65344e075371c
+  metadata.gz: d855c3c5a208361dc345238e8b50d8bf1cb85e27632d6ad504a6728ff9af22b29e6f4a29ddcd6a7062f2af399768b6b739bfb53097ab4eaa85bbc4d665f1c55f
+  data.tar.gz: 8a64fd76daede11596684381c4fc1a1df6d2992a361c86c6ec9219e1d10ee20c1e1e201649672c7294587d38ba2731885fc013a45b76fad1d76f3b4c91a76a1e

data/bin/dotpretty

@@ -1,8 +1,36 @@
 #!/usr/bin/env ruby
 
 require "dotpretty/parser"
+require "dotpretty/reporters/factory"
+require "dotpretty/reporters/names"
+require "optparse"
 
-parser = Dotpretty::Parser.new({ output: STDOUT })
+options = {}
+OptionParser.new do |opts|
+
+  opts.banner = "Usage: dotnet test -v=normal Test.Project/ | dotnet [options]"
+
+  opts.on("-h", "--help", "Display this help") do
+    puts opts
+    exit
+  end
+
+  all_reporter_names = Dotpretty::Reporters::Names::ALL
+  reporter_message = ["Set reporter. Defaults to basic", "Available reporters: #{all_reporter_names.join(", ")}"]
+  opts.on("-rREPORTER", "--reporter=REPORTER", *reporter_message) do |reporter_name|
+    options[:reporter_name] = reporter_name
+  end
+
+  if STDIN.tty?
+    $stderr.puts opts.help
+    exit 1
+  end
+
+end.parse!
+
+
+reporter = Dotpretty::Reporters::Factory.build_reporter(options[:reporter_name], STDOUT)
+parser = Dotpretty::Parser.new({ reporter: reporter })
 
 STDIN.each_line do |line|
   parser.parse_line(line)

data/lib/dotpretty/aggregator.rb

@@ -0,0 +1,105 @@
+module Dotpretty
+  class Aggregator
+
+    BUILD_COMPLETED = /^Build completed/
+    TEST_FAILED = /^Failed/
+    TEST_PASSED = /^Passed/
+    TEST_SUMMARY = /^Total tests/
+    TESTS_STARTED = /^Starting test execution, please wait...$/
+
+    attr_accessor :state_machine
+
+    def initialize(reporter:)
+      self.reporter = reporter
+    end
+
+    def parse_line(input_line)
+      case state_machine.current_state_name
+      when :waiting
+        state_machine.trigger(:build_started)
+      when :build_in_progress
+        state_machine.trigger(:build_completed) if input_line.match(BUILD_COMPLETED)
+      when :ready_to_run_tests
+        state_machine.trigger(:tests_started) if input_line.match(TESTS_STARTED)
+      when :waiting_for_test_input
+        state_machine.trigger(:test_input_received, input_line)
+      when :waiting_for_failure_details
+        state_machine.trigger(:received_failure_details, input_line)
+      when :reading_failure_details
+        state_machine.trigger(:received_input_line, input_line)
+      end
+    end
+
+    def parse_test_input(input_line)
+      if input_line.match(TEST_PASSED)
+        match = input_line.match(/^Passed\s+(.+)$/)
+        state_machine.trigger(:test_passed, match[1])
+      elsif input_line.match(TEST_FAILED)
+        match = input_line.match(/^Failed\s+(.+)$/)
+        state_machine.trigger(:test_failed, match[1])
+      elsif input_line.match(TEST_SUMMARY)
+        state_machine.trigger(:tests_completed, input_line)
+      else
+        state_machine.trigger(:received_other_input)
+      end
+    end
+
+    def build_completed
+      reporter.build_completed
+    end
+
+    def build_started
+      reporter.build_started
+    end
+
+    def track_failure_details(details)
+      current_failing_test[:details] << details.rstrip if details.rstrip != ""
+    end
+
+    def show_test_summary(summary)
+      match = summary.match(/^Total tests: (\d+). Passed: (\d+). Failed: (\d+). Skipped: (\d+)./)
+      reporter.show_test_summary({
+        failedTests: match[3].to_i,
+        passedTests: match[2].to_i,
+        skippedTests: match[4].to_i,
+        totalTests: match[1].to_i
+      })
+    end
+
+    def report_failing_test(*args)
+      reporter.test_failed(current_failing_test)
+    end
+
+    def parse_failure_line(input_line)
+      if input_line.match(TEST_PASSED)
+        state_machine.trigger(:done_reading_failure, input_line)
+      elsif input_line.match(TEST_SUMMARY)
+        state_machine.trigger(:done_reading_failure, input_line)
+      elsif input_line.match(TEST_FAILED)
+        state_machine.trigger(:done_reading_failure, input_line)
+      else
+        state_machine.trigger(:received_failure_output, input_line)
+      end
+    end
+
+    def starting_tests
+      reporter.starting_tests
+    end
+
+    def reset_current_failing_test(test_name)
+      self.current_failing_test = {
+        details: [],
+        name: test_name
+      }
+    end
+
+    def test_passed(test_name)
+      reporter.test_passed(test_name)
+    end
+
+    private
+
+    attr_accessor :current_failing_test, :reporter
+
+  end
+end

data/lib/dotpretty/parser.rb

@@ -1,12 +1,13 @@
-require "dotpretty/reporter"
+require "dotpretty/aggregator"
+require "dotpretty/reporters/basic"
 require "dotpretty/state_machine_builder"
 
 module Dotpretty
   class Parser
 
-    def initialize(output:)
-      self.output = output
-      self.state_machine = Dotpretty::StateMachineBuilder.build(Dotpretty::Reporter.new(output: output)) do
+    def initialize(reporter:)
+      self.aggregator = Dotpretty::Aggregator.new({ reporter: reporter })
+      self.state_machine = Dotpretty::StateMachineBuilder.build(aggregator) do
         state :waiting do
           transition :build_started, :build_in_progress, :build_started
         end
@@ -14,56 +15,42 @@ module Dotpretty
           transition :build_completed, :ready_to_run_tests, :build_completed
         end
         state :ready_to_run_tests do
-          transition :starting_tests, :running_tests, :starting_tests
+          transition :tests_started, :waiting_for_test_input, :starting_tests
         end
-        state :running_tests do
-          transition :test_failed, :reading_test_failure, :test_failed
-          transition :test_passed, :running_tests, :test_passed
+        state :waiting_for_test_input do
+          transition :test_input_received, :parsing_test_input
+        end
+        state :parsing_test_input do
+          on_entry :parse_test_input
+          transition :received_other_input, :waiting_for_test_input
+          transition :test_failed, :waiting_for_failure_details, :reset_current_failing_test
+          transition :test_passed, :waiting_for_test_input, :test_passed
           transition :tests_completed, :done, :show_test_summary
         end
-        state :reading_test_failure do
-          transition :test_passed, :running_tests, :test_passed
-          transition :received_failure_output, :reading_test_failure, :show_failure_details
+        state :waiting_for_failure_details do
+          transition :received_failure_details, :reading_failure_details
+        end
+        state :reading_failure_details do
+          on_entry :parse_failure_line
+          transition :done_reading_failure, :parsing_test_input, :report_failing_test
+          transition :received_failure_output, :waiting_for_failure_details, :track_failure_details
+        end
+        state :parsing_failure_line do
+          on_entry :parse_failure_line
+          transition :received_failure_output, :reading_failure_details, :track_failure_details
           transition :tests_completed, :done, :show_test_summary
         end
       end
+      aggregator.state_machine = state_machine
     end
 
     def parse_line(input_line)
-      case state_machine.current_state_name
-      when :waiting
-        state_machine.trigger(:build_started)
-      when :build_in_progress
-        state_machine.trigger(:build_completed) if input_line.match(/^Build completed/)
-      when :ready_to_run_tests
-        if input_line.match(/^Starting test execution, please wait...$/)
-          state_machine.trigger(:starting_tests)
-        end
-      when :running_tests
-        if input_line.start_with?("Passed")
-          match = input_line.match(/^Passed\s+(.+)$/)
-          state_machine.trigger(:test_passed, match[1])
-        elsif input_line.start_with?("Failed")
-          match = input_line.match(/^Failed\s+(.+)$/)
-          state_machine.trigger(:test_failed, match[1])
-        elsif input_line.start_with?("Total tests")
-          state_machine.trigger(:tests_completed, input_line)
-        end
-      when :reading_test_failure
-        if input_line.start_with?("Passed")
-          match = input_line.match(/^Passed\s+(.+)$/)
-          state_machine.trigger(:test_passed, match[1])
-        elsif input_line.start_with?("Total tests")
-          state_machine.trigger(:tests_completed, input_line)
-        else
-          state_machine.trigger(:received_failure_output, input_line)
-        end
-      end
+      aggregator.parse_line(input_line)
     end
 
     private
 
-    attr_accessor :output, :state_machine
+    attr_accessor :aggregator, :output, :state_machine
 
   end
 end

data/lib/dotpretty/reporters/basic.rb

@@ -0,0 +1,43 @@
+module Dotpretty
+  module Reporters
+    class Basic
+
+      def initialize(output)
+        self.output = output
+      end
+
+      def build_started
+        output.puts("Build started")
+      end
+
+      def build_completed
+        output.puts("Build completed")
+        output.puts("")
+      end
+
+      def starting_tests
+        output.puts("Starting test execution...")
+      end
+
+      def test_passed(test_name)
+        output.puts("Passed   #{test_name}")
+      end
+
+      def test_failed(failing_test)
+        output.puts("Failed   #{failing_test[:name]}")
+        failing_test[:details].each do |line|
+          output.puts(line)
+        end
+      end
+
+      def show_test_summary(summary)
+        output.puts("\nTotal tests: #{summary[:totalTests]}. Passed: #{summary[:passedTests]}. Failed: #{summary[:failedTests]}. Skipped: #{summary[:skippedTests]}.\n")
+      end
+
+      private
+
+      attr_accessor :output
+
+    end
+  end
+end

data/lib/dotpretty/reporters/factory.rb

@@ -0,0 +1,20 @@
+require "dotpretty/reporters/basic"
+require "dotpretty/reporters/json"
+require "dotpretty/reporters/names"
+
+module Dotpretty
+  module Reporters
+    class Factory
+
+      def self.build_reporter(name, output)
+        case name
+        when Dotpretty::Reporters::Names::JSON
+          return Dotpretty::Reporters::Json.new(output)
+        else
+          return Dotpretty::Reporters::Basic.new({ output: output })
+        end
+      end
+
+    end
+  end
+end

data/lib/dotpretty/reporters/json.rb

@@ -0,0 +1,46 @@
+require "json"
+
+module Dotpretty
+  module Reporters
+    class Json
+
+      def initialize(output)
+        self.output = output
+        self.tests = []
+      end
+
+      def build_started
+      end
+
+      def build_completed
+      end
+
+      def starting_tests
+      end
+
+      def test_passed(test_name)
+        tests << {
+          name: test_name,
+          result: "passed"
+        }
+      end
+
+      def test_failed(failing_test)
+        tests << failing_test.merge({
+          result: "failed"
+        })
+      end
+
+      def show_test_summary(summary)
+        output.puts({
+          tests: tests
+        }.to_json)
+      end
+
+      private
+
+      attr_accessor :output, :tests
+
+    end
+  end
+end

data/lib/dotpretty/reporters/names.rb

@@ -0,0 +1,11 @@
+module Dotpretty
+  module Reporters
+    class Names
+
+      BASIC = "basic"
+      JSON = "json"
+
+      ALL = [BASIC, JSON]
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dotpretty
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Eric Meyer
@@ -19,8 +19,12 @@ extra_rdoc_files: []
 files:
 - bin/dotpretty
 - lib/dotpretty.rb
+- lib/dotpretty/aggregator.rb
 - lib/dotpretty/parser.rb
-- lib/dotpretty/reporter.rb
+- lib/dotpretty/reporters/basic.rb
+- lib/dotpretty/reporters/factory.rb
+- lib/dotpretty/reporters/json.rb
+- lib/dotpretty/reporters/names.rb
 - lib/dotpretty/state_details.rb
 - lib/dotpretty/state_machine.rb
 - lib/dotpretty/state_machine_builder.rb

data/lib/dotpretty/reporter.rb

@@ -1,42 +0,0 @@
-module Dotpretty
-  class Reporter
-
-    def initialize(output:)
-      self.output = output
-    end
-
-    def build_completed
-      output.puts("Build completed")
-      output.puts("")
-    end
-
-    def build_started
-      output.puts("Build started")
-    end
-
-    def show_failure_details(details)
-      output.puts("#{details}")
-    end
-
-    def show_test_summary(summary)
-      output.puts("\n#{summary}")
-    end
-
-    def starting_tests
-      output.puts("Starting test execution...")
-    end
-
-    def test_failed(test_name)
-      output.puts("Failed   #{test_name}")
-    end
-
-    def test_passed(test_name)
-      output.puts("Passed   #{test_name}")
-    end
-
-    private
-
-    attr_accessor :output
-
-  end
-end