gloo-test 1.1 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a73cec30908a847f9a57eff2a51260510ce2c6dae9c7ce3a5c899cb2b687385
-  data.tar.gz: 3e39c1eeac6b251ed68f81047759a7a505d5eccff6c62b3c156994a8c42b5a8c
+  metadata.gz: 4487381d226f57da2c903ba429b55ad0df105b2f33f765ff0d82eaa89d63adf1
+  data.tar.gz: d2fa596dd35c471998d3186b1234053c8ee3464cbf596ac07206dcbb3b5a0646
 SHA512:
-  metadata.gz: a78397cbeb4554166ec1d210149969121f1ebe133f3d6b7c45811fba1da0c1f3f2c2627a0a12dfa2257b3a6e9b4a85294fd61f42c53b8731cf201e33a29b6e5a
-  data.tar.gz: b11b5be346c5de429676e3095c675b4ef651fc4ea4688890473fba113bcd1345777175ee95011ef4f930fe5d6054bbe8c751f3987df1e3ce5d347f28d9a83c29
+  metadata.gz: e1addf250dd2716c409a1fa723463a325786d98ba3c1ccb03ae1f9d9ee8ad001f7a3752186ab105ac31e499b8e2ea0c4a831db1b72372899cfc15218c572be76
+  data.tar.gz: 9dc962225a118a28757d033c60ed1cbc7d7406ff66763b56933019ff64208ac250a245fe796becdefb79cfd5d659583004f2bfdb1a4e0611c49d423f0a48a6fe

data/lib/assert.rb

@@ -28,8 +28,7 @@ class Assert < Gloo::Core::Verb
     begin
       @engine.context_object.assert_count += 1
       if @engine.heap.it.is_true?
-        # Assertion passes
-        @engine.context_object.passed = true
+        # Assertion passes; leave passed alone so an earlier failure stands
         return true
       else
         # Assertion fails

data/lib/refute.rb

@@ -29,8 +29,7 @@ class Refute < Gloo::Core::Verb
     begin
       @engine.context_object.refute_count += 1
       if @engine.heap.it.is_false?
-        # Refutation passes
-        @engine.context_object.passed = true
+        # Refutation passes; leave passed alone so an earlier failure stands
         return true
       else
         # Refutation fails

data/lib/result.rb

@@ -4,8 +4,15 @@
 #
 class Result
 
-  attr_accessor :passed, :assert_count, :refute_count
+  EXPECTED_FAIL_MSG = 'expected this test to fail, but no assertion failed'.freeze
 
+  attr_accessor :passed, :assert_count, :refute_count,
+    :error_count, :warning_count, :expect_errors
+  attr_reader :pn
+
+  #
+  # Set up the result for the given test.
+  #
   def initialize( engine, test )
     @engine = engine
     @test = test
@@ -15,10 +22,38 @@ class Result
     @assert_count = 0
     @refute_count = 0
 
+    # Errors and warnings logged while the test ran, and whether
+    # the test declared that it triggers them on purpose.
+    @error_count = 0
+    @warning_count = 0
+    @expect_errors = false
+
     @passed = true
     @failure_msg = ''
   end
 
+  #
+  # Did the test log errors or warnings it didn't declare?
+  #
+  def unexpected_logs?
+    return false if @expect_errors
+
+    return ( @error_count + @warning_count ).positive?
+  end
+
+  #
+  # The test was meant to fail: it passes if an assertion failed,
+  # and fails if no assertion failed.
+  #
+  def expect_failure
+    if @passed
+      @passed = false
+      add_message EXPECTED_FAIL_MSG
+    else
+      @passed = true
+    end
+  end
+
   #
   # Show the test result symbol.
   #

data/lib/results.rb

@@ -76,10 +76,13 @@ class Results
   # Show the results.
   #
   def show_results
+    theme = @engine.theme
     delta = duration.round( 2 )
     puts
     puts get_result_summary
-    puts "Tests finished in #{delta} seconds".white
+    logged = get_logged_summary
+    puts theme.warn( logged ) if logged
+    puts theme.emphasis( "Tests finished in #{delta} seconds" )
     puts
   end
 
@@ -88,27 +91,94 @@ class Results
   #
   def show_failures
     if @fail_count > 0
+      theme = @engine.theme
       puts
-      puts "*** Failures (#{@fail_count}) ***".red
+      puts theme.error( "*** Failures (#{@fail_count}) ***" )
       puts
       @failures.each do |failure|
         failure.show_failure
       end
     end
   end
-  
-  # 
+
+  #
   # Get a textual summary of the results.
   #
   def get_result_summary
-    str = "Tests: #{@all_results.length} • Passed: #{@pass_count} • ".white
+    theme = @engine.theme
+    str = theme.emphasis( "Tests: #{@all_results.length} • Passed: #{@pass_count} • " )
     if @fail_count > 0
-      str += " Failed: #{@fail_count} ".red
+      str += theme.error( " Failed: #{@fail_count} " )
     else
-      str += " Failed: #{@fail_count} ".white
+      str += theme.emphasis( " Failed: #{@fail_count} " )
     end
-    str += "\n  Assertions: #{@assert_count} • Files: #{@file_count}".yellow
+    str += theme.accent( "\n  Assertions: #{@assert_count} • Files: #{@file_count}" )
     return str
   end
 
+  # ---------------------------------------------------------------------
+  #    Logged Errors and Warnings
+  # ---------------------------------------------------------------------
+
+  #
+  # Get a summary of the errors and warnings logged during the run
+  # that no test declared (with expect_errors), naming the tests that
+  # logged them. Returns nil when there's nothing unexpected.
+  # Counts are since the log's counts were last reset (the runner
+  # resets them just before running the tests).
+  #
+  def get_logged_summary
+    unexpected = @all_results.select( &:unexpected_logs? )
+    outside_errors, outside_warnings = logged_outside_tests
+
+    errors = unexpected.sum( &:error_count ) + outside_errors
+    warnings = unexpected.sum( &:warning_count ) + outside_warnings
+    return nil if ( errors + warnings ).zero?
+
+    lines = [ "  #{count_phrase( errors, warnings )} logged during the run; see #{log_path}" ]
+    unexpected.each do |r|
+      lines << "    #{r.pn} (#{count_phrase( r.error_count, r.warning_count )})"
+    end
+    if ( outside_errors + outside_warnings ).positive?
+      lines << "    (outside tests: #{count_phrase( outside_errors, outside_warnings )})"
+    end
+    return lines.join( "\n" )
+  end
+
+  #
+  # Get the errors and warnings logged outside any test (eg. while
+  # loading a test file): everything logged less what the tests logged.
+  #
+  def logged_outside_tests
+    log = @engine.log
+    errors = log.error_count - @all_results.sum( &:error_count )
+    warnings = log.warning_count - @all_results.sum( &:warning_count )
+    return [ errors, warnings ]
+  end
+
+  #
+  # Describe a count of errors and warnings, eg. "1 error",
+  # "2 warnings", or "2 errors and 1 warning". Zero counts are left out.
+  #
+  def count_phrase( errors, warnings )
+    parts = []
+    parts << pluralize( errors, 'error' ) if errors.positive?
+    parts << pluralize( warnings, 'warning' ) if warnings.positive?
+    return parts.join( ' and ' )
+  end
+
+  #
+  # A count with its noun, plural unless the count is one.
+  #
+  def pluralize( count, noun )
+    return count == 1 ? "1 #{noun}" : "#{count} #{noun}s"
+  end
+
+  #
+  # The error log's path, with the home folder shown as ~.
+  #
+  def log_path
+    return @engine.log.err_file.sub( /\A#{Regexp.escape( Dir.home )}/, '~' )
+  end
+
 end

data/lib/test.rb

@@ -6,6 +6,8 @@ class Test < Gloo::Core::Obj
   KEYWORD = 'test'.freeze
   TEST_DESC = 'description'.freeze
   ON_TEST_EVENT = 'on_test'.freeze
+  EXPECT_ERRORS = 'expect_errors'.freeze
+  EXPECT_FAIL = 'expect_fail'.freeze
 
 
   #
@@ -31,6 +33,30 @@ class Test < Gloo::Core::Obj
     return o ? o.value : 'Unknown'
   end
 
+  #
+  # Does the test trigger errors or warnings on purpose?
+  # Set with an optional expect_errors [bool] child.
+  #
+  def expect_errors?
+    return flag_set?( EXPECT_ERRORS )
+  end
+
+  #
+  # Is the test meant to fail?
+  # Set with an optional expect_fail [bool] child.
+  #
+  def expect_fail?
+    return flag_set?( EXPECT_FAIL )
+  end
+
+  #
+  # Is the named bool child present and true?
+  #
+  def flag_set?( name )
+    o = find_child name
+    return o ? o.value == true : false
+  end
+
 
   # ---------------------------------------------------------------------
   #    Children
@@ -69,10 +95,19 @@ class Test < Gloo::Core::Obj
   #
   def run_test
     result = Result.new( @engine, self )
+    errors_before = @engine.log.error_count
+    warnings_before = @engine.log.warning_count
+
     @engine.context_object = result
     run_on_test
     @engine.context_object = nil
 
+    # Record what this test logged, for the run's summary.
+    result.error_count = @engine.log.error_count - errors_before
+    result.warning_count = @engine.log.warning_count - warnings_before
+    result.expect_errors = expect_errors?
+    result.expect_failure if expect_fail?
+
     result.show_result_symbol
 
     return result
@@ -102,7 +137,9 @@ class Test < Gloo::Core::Obj
       :description => 'A single gloo test.',
       :children => [
         'description (string) — A textual description of the test and desired outcome, used in output if there is an error.',
-        'on_test (script) — The script to run when the test is executed. Note that the normal way to run tests is with gloo --test.'
+        'on_test (script) — The script to run when the test is executed. Note that the normal way to run tests is with gloo --test.',
+        'expect_errors (bool) — Optional. Set to true for a test that triggers errors or warnings on purpose (eg. to check on_error); they are left out of the summary of what was logged during the run.',
+        'expect_fail (bool) — Optional. Set to true for a test that is meant to fail: it passes if at least one assertion fails, and fails if none does. It can\'t tell which assertion failed, or why, so keep such a test to the one thing it checks.'
       ],
       :examples => <<~EXAMPLES.strip
         #

data/lib/test_files.rb

@@ -45,8 +45,7 @@ class TestFiles
       elsif File.exist?( f )
         add( f )
       else
-        # TODO: Show error
-        puts "Test file does not exist: #{f}"
+        @engine.err Gloo::Core::NotFound.file( f )
       end
     end
   end

data/lib/test_runner.rb

@@ -20,6 +20,9 @@ class TestRunner
   # Execute all tests and display results.
   #
   def run
+    # Count only what's logged from here on, not loading gloo-test.
+    # Before setup, so a missing test file is counted.
+    @engine.log.reset_counts
     setup
 
     @results.start_timer    
@@ -37,7 +40,7 @@ class TestRunner
   def setup
     @engine.log.debug "TestRunner is running…"
     puts
-    puts "Gloo Test Runner".white
+    puts @engine.theme.emphasis( "Gloo Test Runner" )
     puts
 
     # Get a list of test files and randomize

metadata

@@ -1,14 +1,82 @@
 --- !ruby/object:Gem::Specification
 name: gloo-test
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.3'
 platform: ruby
 authors:
 - Eric Crane
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gloo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
 description: Adds Gloo Unit Test support to Gloo.
 email:
 - eric.crane@mac.com