reality-core 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0001afc36f924a295d6b3461b1cdcd78ac7546a
-  data.tar.gz: 739121f92b960be4f5f27f18c0378a23a4727fa5
+  metadata.gz: 43244fb34b6e74b1281a583f71cdd1ba308391ce
+  data.tar.gz: 1cdbdaf9304e69c358f6f7448164cfcb84932e91
 SHA512:
-  metadata.gz: 4a968ddcf90298e09ba2ca6d2d6037e33819ffe73f214f30fbcf3cb9f44debdc1113e71d01aba8e3843da9f0981781200f060009082f924b6f6f384092ce8517
-  data.tar.gz: 5e69567c10388ea9e4a0b52819582fbf6dad1c38d8913853b913273075378167ba04d95e37591cb5858b21f8be2ef80e208c9d646b1799a1588e976ec3fbd0e1
+  metadata.gz: eb5958c12e4396ac98014749fc3063482d3822f5a1a0769ae70964a293ff7d2b6c82f0be585c2f958250781f3f78882d5d5bb02938727516cf2b68e99d56f18e
+  data.tar.gz: 8b7750bacc77d561bc64578d0d6775a29edb00262e3cede212da6d1a713f4e43090f897cae29550ca471dc7fdf14b8bdf3fe08de0baa85bef6c31070179c680e

data/lib/reality/logging.rb

@@ -75,5 +75,53 @@ module Reality
         end
       end
     end
+
+    # Module that should be mixed into base test class to test dependent libraries.
+    # It is expected that the class this is mixed into supplies a assert_raise method.
+    module Assertions
+      # for the specified log container capture the log output during blocks
+      # execution and return as a string
+      def capture_logging(log_container, &block)
+        raise 'capture_logging called but no block supplied.' unless block_given?
+        logger = log_container.const_get(:Logger)
+
+        logdev = logger.instance_variable_get('@logdev')
+        original_dev = logdev.instance_variable_get('@dev')
+
+        capture_io = StringIO.new
+        begin
+          logdev.instance_variable_set('@dev', capture_io)
+          yield block
+          return capture_io.string
+        ensure
+          logdev.instance_variable_set('@dev', original_dev)
+        end
+      end
+
+      # For the specified log container, capture the log output during blocks
+      # execution and match specified message. A new line is appended to
+      # expected_message as the logging system appends one.
+      def assert_logging_message(log_container, expected_message, &block)
+        raise 'assert_logging_message called but no block supplied.' unless block_given?
+
+        result = capture_logging(log_container) do
+          yield block
+        end
+
+        assert_equal "#{expected_message}\n", result
+      end
+
+      # For the specified log container, capture the log output during blocks
+      # execution and match specified message. Also ensure an exception is raised
+      # with the same message
+      def assert_logging_error(log_container, expected_message, &block)
+        raise 'assert_logging_error called but no block supplied.' unless block_given?
+        assert_logging_message(log_container, expected_message) do
+          assert_raise(RuntimeError.new(expected_message)) do
+            yield block
+          end
+        end
+      end
+    end
   end
 end

data/reality-core.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name               = %q{reality-core}
-  s.version            = '1.5.0'
+  s.version            = '1.6.0'
   s.platform           = Gem::Platform::RUBY
 
   s.authors            = ['Peter Donald']

data/test/test_logging.rb

@@ -65,4 +65,59 @@ class Reality::TestLogging < Reality::TestCase
     assert_equal ::Logger::DEBUG, logger1.level
     assert_equal ::Logger::INFO, logger2.level
   end
+
+  class MyModule2
+  end
+
+  class MyFakeTest
+    include Test::Unit::Assertions
+    include Reality::Logging::Assertions
+  end
+
+  def test_assertions
+    mytest = MyFakeTest.new
+
+    io = StringIO.new('', 'w')
+    Reality::Logging.configure(MyModule2, ::Logger::INFO, io)
+
+    assert_raise(RuntimeError.new('capture_logging called but no block supplied.')) do
+      mytest.capture_logging(MyModule2)
+    end
+    assert_raise(RuntimeError.new('assert_logging_message called but no block supplied.')) do
+      mytest.assert_logging_message(MyModule2, 'X')
+    end
+    assert_raise(RuntimeError.new('assert_logging_error called but no block supplied.')) do
+      mytest.assert_logging_error(MyModule2, 'X')
+    end
+
+    messages = mytest.capture_logging(MyModule2) do
+      MyModule2.info('Hello from log system')
+    end
+    assert_equal "Hello from log system\n", messages
+
+    assert_raise(RuntimeError.new('assert_logging_message called but no block supplied.')) do
+      mytest.assert_logging_message(MyModule2, 'Hello from log system')
+    end
+
+    mytest.assert_logging_message(MyModule2, 'Hello from log system') do
+      MyModule2.info('Hello from log system')
+    end
+
+    assert_raise(Test::Unit::AssertionFailedError.new("<\"Hello from log system\\n\"> expected but was\n<\"\">.")) do
+      mytest.assert_logging_message(MyModule2, 'Hello from log system') do
+        # There is no message
+      end
+    end
+
+    assert_raise(Test::Unit::AssertionFailedError.new('<RuntimeError(<Hello from log system>)> exception expected but none was thrown.')) do
+      mytest.assert_logging_error(MyModule2, 'Hello from log system') do
+        # Should fail as there is only a message and not an error
+        MyModule2.info('Hello from log system')
+      end
+    end
+
+    mytest.assert_logging_error(MyModule2, 'Error!') do
+      MyModule2.error('Error!')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reality-core
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Peter Donald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-07 00:00:00.000000000 Z
+date: 2016-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest