mumukit 2.34.1 → 2.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecf5dad926913985cd2067a888f7e14233c66a70a887ee287d60093fd3d33faf
-  data.tar.gz: 8e36f9461737a850f6c8a691b0e6524bbe58dbd7276e92b5c5e40f6ad4c407d4
+  metadata.gz: c93b40ab8d9ea10cfe1e73457763ef6146c396fbfe6feeab318e0e4938553fff
+  data.tar.gz: e7b34dad3b8a67f5be0468e720bfae08a985eae4f7b299886919a03a765367e3
 SHA512:
-  metadata.gz: 6fbd065df141368fee19ddfbc7c9eb03df473ff1a0cf92cc2b4ab407dc35688ce7ac119cd778e63ad6a87a880f41fbe7c027645e652b959e13eb2355070618f6
-  data.tar.gz: 7ea9f24a7635aec967c1c3ceb3df3458a533aacdd644596beb58bbb91fffa15ef62bbe785d9d5a984bafc80faa48bc75adb279da4765e2559381226227f829df
+  metadata.gz: 40a8ad3cbe13a399ae7d012819eff925497920cd1233e6b4f16db14aa5f60fe0b6b521c491532c77d36f7b1c5e998b3aa132275006fd55bab3b944c258f429ef
+  data.tar.gz: 5135710e6ebbb026321d6f36fdcb0139203612d75ec5255805158438ef7008cf469813ae778395c42aa1f16b3ccd8e47366a94f5ec8adcc75b624cff8ef75aa1

data/lib/mumukit/metatest.rb

@@ -3,6 +3,7 @@ end
 
 require_relative './metatest/errors'
 require_relative './metatest/checker'
+require_relative './metatest/test_result_builder'
 require_relative './metatest/interactive_checker'
 require_relative './metatest/framework'
-require_relative './metatest/identity_runner'
+require_relative './metatest/identity_runner'

data/lib/mumukit/metatest/checker.rb

@@ -24,10 +24,12 @@ module Mumukit::Metatest
     ## }
     ##
     def check(input, example)
+      builder = Mumukit::Metatest::TestResultBuilder.new
+
       check_assertions input, postconditions_for(example), example
-      [example[:name], :passed, render_success_output(input)]
+      build_passed_test_result builder, example, input
     rescue => e
-      [example[:name], :failed, render_error_output(input, e.message)]
+      build_failed_test_result builder, example, input, e
     end
 
     ## If no postconditions are included in the example,
@@ -36,12 +38,34 @@ module Mumukit::Metatest
       example[:postconditions] || example.except(:name)
     end
 
-    def render_success_output(value)
+    # Implementors may override this method instead of `build_success_output`
+    # if they don't want to handle error details.
+    #
+    # This method is only for backward compatibility. New code
+    # should use `build_success_output`.
+    def render_success_output(_input)
       nil
     end
 
-    def render_error_output(value, error)
-      error
+    # Implementors may override this method instead of `build_error_output`
+    # if they don't want to handle error details.
+    #
+    # This method is only for backward compatibility. New code
+    # should use `build_error_output`.
+    def render_error_output(_input, error_message)
+      error_message
+    end
+
+    # Implementors should override this method if they want access to
+    # the error details and produce more complex test results
+    def build_success_output(builder, _example, input)
+      builder.result = render_success_output input
+    end
+
+    # Implementors should override this method if they want access to
+    # the error details and produce more complex test results
+    def build_error_output(builder, input, _example, error)
+      builder.result = render_error_output input, error.message
     end
 
     def check_assertions(input, assertions_hash, example)
@@ -54,16 +78,30 @@ module Mumukit::Metatest
       send "check_#{assertion_name}", input, assertion_config
     end
 
-    def fail(message)
-      raise Mumukit::Metatest::Failed, message
+    def fail(message, details: nil)
+      raise Mumukit::Metatest::Failed.new(message, details)
+    end
+
+    def abort(message, details: nil)
+      raise Mumukit::Metatest::Aborted.new(message, details)
+    end
+
+    def error(message, details: nil)
+      raise Mumukit::Metatest::Errored.new(message, details)
     end
 
-    def abort(message)
-      raise Mumukit::Metatest::Aborted, message
+    def build_passed_test_result(builder, example, input)
+      builder.title = example[:name]
+      builder.status = :passed
+      build_success_output builder, example, input
+      builder.build
     end
 
-    def error(message)
-      raise Mumukit::Metatest::Errored, message
+    def build_failed_test_result(builder, example, input, e)
+      builder.title = example[:name]
+      builder.status = :failed
+      build_error_output builder, example, input, e
+      builder.build
     end
   end
 end

data/lib/mumukit/metatest/errors.rb

@@ -1,10 +1,17 @@
 module Mumukit::Metatest
-  class Aborted < StandardError
+  class BaseError < StandardError
+    attr_reader :details
+    def initialize(message = "", details = nil)
+      super(message)
+      @details = details
+    end
+  end
+  class Aborted < BaseError
   end
 
-  class Errored < StandardError
+  class Errored < BaseError
   end
 
-  class Failed < StandardError
+  class Failed < BaseError
   end
-end
+end

data/lib/mumukit/metatest/test_result_builder.rb

@@ -0,0 +1,20 @@
+module Mumukit::Metatest
+  class TestResultBuilder
+    attr_accessor :title, :status, :result, :summary_type, :summary_message
+
+    def summary
+      {type: summary_type.presence, message: summary_message.presence}.compact
+    end
+
+    def build
+      raise 'missing status' unless status
+      raise "invalid #{status}" unless status.passed? || status.failed?
+
+      if summary_message.present? || summary_type.present?
+        [title, status, result, summary]
+      else
+        [title, status, result]
+      end
+    end
+  end
+end

data/lib/mumukit/server/response_builder.rb

@@ -58,10 +58,16 @@ class Mumukit::Server::ResponseBuilder
   end
 
   def structured_base_response(test_results)
-    {testResults: test_results[0].map { |title, status, result|
-      {title: title,
-       status: status,
-       result: result} }}
+    {
+      testResults: test_results[0].map do |title, status, result, summary|
+        { summary: summary&.compact.presence }
+          .compact
+          .merge(
+            title: title,
+            status: status,
+            result: result)
+      end
+    }
   end
 
   def unstructured_base_response(test_results)

data/lib/mumukit/version.rb

@@ -1,3 +1,3 @@
 module Mumukit
-  VERSION = '2.34.1'
+  VERSION = '2.35.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumukit
 version: !ruby/object:Gem::Version
-  version: 2.34.1
+  version: 2.35.0
 platform: ruby
 authors:
 - Franco Leonardo Bulgarelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-08 00:00:00.000000000 Z
+date: 2020-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -323,6 +323,7 @@ files:
 - lib/mumukit/metatest/framework.rb
 - lib/mumukit/metatest/identity_runner.rb
 - lib/mumukit/metatest/interactive_checker.rb
+- lib/mumukit/metatest/test_result_builder.rb
 - lib/mumukit/request_validation_error.rb
 - lib/mumukit/runner.rb
 - lib/mumukit/runtime.rb