oktest 1.0.0

data/test/tc.rb

@@ -0,0 +1,115 @@
+# -*- coding: utf-8 -*-
+
+## micro test case class
+class TC
+
+  COUNTS = {:ok => 0, :fail => 0, :error => 0}
+
+  def self.report_result()
+    ok, fail, error = COUNTS[:ok], COUNTS[:fail], COUNTS[:error]
+    COUNTS.keys.each {|k| COUNTS[k] = 0 }
+    red = proc {|s| "\033[0;31m#{s}\033[0m" }
+    fail_s  = "fail: #{fail}"   ; fail_s  = red.call(fail_s)  if fail > 0
+    error_s = "error: #{error}" ; error_s = red.call(error_s) if error > 0
+    STDOUT.puts "## total: #{ok+fail+error} (ok: #{ok}, #{fail_s}, #{error_s})"
+  end
+
+  def self.describe(target, &b)
+    prev, @curr_target = @curr_target, target
+    yield
+  ensure
+    @curr_target = prev
+  end
+
+  def self.curr_target()
+    @curr_target
+  end
+
+  def self.it(spec, &b)
+    t = @curr_target
+    print "[#{self.name}#{t ? ' > ' : ''}#{t}] #{spec} ... " unless ENV['TC_QUIET']
+    obj = self.new
+    obj.setup()
+    begin
+      obj.instance_eval(&b)
+    rescue => exc
+      if exc.is_a?(AssertionFailed)
+        COUNTS[:fail]  += 1; puts "FAILED!" unless ENV['TC_QUIET']
+      else
+        COUNTS[:error] += 1; puts "ERROR!"  unless ENV['TC_QUIET']
+      end
+      puts "  #{exc.class.name}: #{exc.message}"
+      exc.backtrace.each do |bt|
+        puts "    #{bt}" if bt.index(__FILE__) == nil
+      end
+    else
+      COUNTS[:ok] += 1; puts "ok." unless ENV['TC_QUIET']
+    ensure
+      obj.teardown()
+    end
+  end
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  class AssertionFailed < StandardError
+  end
+
+  def assert(cond, msg="assertion failed")
+    raise msg unless cond
+  end
+
+  def assert_eq(actual, expected)
+    return if actual == expected
+    multiline_p = actual.is_a?(String) && actual =~ /\n/ \
+                && expected.is_a?(String) && expected =~ /\n/
+    errmsg = (multiline_p \
+              ? "$<actual> == $<expected> : failed.\n" +
+                "    $<actual>:   <<END\n#{actual}END\n" +
+                "    $<expected>: <<END\n#{expected}END"
+              : "$<actual> == $<expected> : failed.\n" +
+                "    $<actual>:   #{actual.inspect}\n" +
+                "    $<expected>: #{expected.inspect}")
+    raise AssertionFailed, errmsg
+  end
+
+  def assert_exc(errcls, errmsg=nil, &b)
+    begin
+      yield
+    rescue NoMemoryError, SystemExit, SyntaxError, SignalException
+      raise
+    rescue Exception => exc
+      exc.class == errcls  or
+        raise AssertionFailed, "#{errcls} should be raised but got #{exc.inspect}"
+      errmsg.nil? || errmsg === exc.message  or
+        raise AssertionFailed, ("invalid error message.\n"\
+                                "  $<actual>:   #{exc.message.inspect}\n"\
+                                "  $<expected>: #{errmsg.inspect}")
+      return exc
+    else
+      raise AssertionFailed, "#{errcls.name} should be raised but not."
+    end
+  end
+
+  def capture(input="", tty: true, &b)
+    require 'stringio' unless defined?(StringIO)
+    stdin, stdout, stderr = $stdin, $stdout, $stderr
+    $stdin  = sin  = StringIO.new(input)
+    $stdout = sout = StringIO.new
+    $stderr = serr = StringIO.new
+    def sin.tty? ; true; end if tty
+    def sout.tty?; true; end if tty
+    def sout.tty?; true; end if tty
+    yield
+    return sout.string, serr.string
+  ensure
+    $stdin, $stdout, $stderr = stdin, stdout, stderr
+  end
+
+end
+
+
+at_exit { TC.report_result() }

data/test/util_test.rb

@@ -0,0 +1,258 @@
+# -*- coding: utf-8 -*-
+
+###
+### $Release: 1.0.0 $
+### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
+### $License: MIT License $
+###
+
+require_relative './initialize'
+
+
+class Util_TC < TC
+  include Oktest::Util
+
+  describe Oktest::Util do
+
+    describe '.file_line()' do
+      it "[!4z65g] returns nil if file not exist or not a file." do
+        assert_eq Oktest::Util.file_line("not-exist-file", 1), nil
+        assert_eq Oktest::Util.file_line(".", 1), nil
+      end
+      it "[!162e1] returns line string." do
+        lineno = __LINE__ + 2
+        _ = <<END
+U6XYR-SH08J
+END
+        assert_eq Oktest::Util.file_line(__FILE__, lineno), "U6XYR-SH08J\n"
+      end
+      it "[!4a2ji] caches recent file content for performance reason." do
+        _ = Oktest::Util.file_line(__FILE__, 1)
+        c = Oktest::Util.instance_variable_get('@__cache')
+        assert c.is_a?(Array), "array object expected."
+        assert_eq c[0], __FILE__
+        assert_eq c[1][0], "# -*- coding: utf-8 -*-\n"
+        assert_eq c[1][11], "class Util_TC < TC\n"
+        #
+        data1 = c[1]
+        _ = Oktest::Util.file_line(__FILE__, 1)
+        c2 = Oktest::Util.instance_variable_get('@__cache')
+        assert c2[1].equal?(data1), "cache object changed unexpectedly."
+      end
+      it "[!wtrl5] recreates cache data if other file requested." do
+        _ = Oktest::Util.file_line(__FILE__, 1)
+        c = Oktest::Util.instance_variable_get('@__cache')
+        data1 = c[1]
+        #
+        otherfile = File.join(File.dirname(__FILE__), "initialize.rb")
+        _ = Oktest::Util.file_line(otherfile, 1)
+        c3 = Oktest::Util.instance_variable_get('@__cache')
+        assert_eq c3[0], otherfile
+        assert ! c3[1].equal?(data1), "cache object should be recreated, but not."
+      end
+    end
+
+    describe '.required_param_names_of_block()' do
+      it "[!a9n46] returns nil if argument is nil." do
+        assert_eq required_param_names_of_block(nil), nil
+      end
+      it "[!7m81p] returns empty array if block has no parameters." do
+        pr = proc { nil }
+        assert_eq required_param_names_of_block(pr), []
+      end
+      it "[!n3g63] returns parameter names of block." do
+        pr = proc {|x, y, z| nil }
+        assert_eq required_param_names_of_block(pr), [:x, :y, :z]
+      end
+      it "[!d5kym] collects only normal parameter names." do
+        pr = proc {|x, y, z=1, *rest, a: 1, b: 2, &blk| nil }
+        assert_eq required_param_names_of_block(pr), [:x, :y]
+        pr = proc {|a: 1, b: 2, &blk| nil }
+        assert_eq required_param_names_of_block(pr), []
+        pr = proc {|*rest, &blk| nil }
+        assert_eq required_param_names_of_block(pr), []
+      end
+    end
+
+    describe '.strfold()' do
+      it "[!wb7m8] returns string as it is if string is not long." do
+        s = "*" * 79
+        assert_eq strfold(s, 80), s
+        s = "*" * 80
+        assert_eq strfold(s, 80), s
+      end
+      it "[!a2igb] shorten string if it is enough long." do
+        expected = "*" * 77 + "..."
+        s = "*" * 81
+        assert_eq strfold(s, 80), expected
+      end
+      it "[!0gjye] supports non-ascii characters." do
+        expected = "あ" * 38 + "..."
+        s = "あ" * 41
+        assert_eq strfold(s, 80), expected
+        #
+        expected = "x" + "あ" * 37 + "..."
+        s = "x" + "あ" * 40
+        assert_eq strfold(s, 80), expected
+      end
+    end
+
+    describe '.hhmmss()' do
+      it "[!shyl1] converts 400953.444 into '111:22:33.4'." do
+        x = 111*60*60 + 22*60 + 33.444
+        assert_eq x, 400953.444
+        assert_eq hhmmss(x), "111:22:33.4"
+      end
+      it "[!vyi2v] converts 5025.678 into '1:23:45.7'." do
+        x = 1*60*60 + 23*60 + 45.678
+        assert_eq x, 5025.678
+        assert_eq hhmmss(x), "1:23:45.7"
+      end
+      it "[!pm4xf] converts 754.888 into '12:34.9'." do
+        x = 12*60 + 34.888
+        assert_eq x, 754.888
+        assert_eq hhmmss(x), "12:34.9"
+      end
+      it "[!lwewr] converts 83.444 into '1:23.4'." do
+        x = 1*60 + 23.444
+        assert_eq x, 83.444
+        assert_eq hhmmss(x), "1:23.4"
+      end
+      it "[!ijx52] converts 56.8888 into '56.9'." do
+        x = 56.8888
+        assert_eq hhmmss(x), "56.9"
+      end
+      it "[!2kra2] converts 9.777 into '9.78'." do
+        x = 9.777
+        assert_eq hhmmss(x), "9.78"
+      end
+      it "[!4aomb] converts 0.7777 into '0.778'." do
+        x = 0.7777
+        assert_eq hhmmss(x), "0.778"
+      end
+    end
+
+    describe '.hhmmss()' do
+      it "[!wf4ns] calculates unified diff from two text strings." do
+        s1 = <<'END'
+Haruhi
+Mikuru
+Yuki
+END
+        s2 = <<'END'
+Haruhi
+Michiru
+Yuki
+END
+        expected = <<'END'
+--- old
++++ new
+@@ -1,4 +1,4 @@
+ Haruhi
+-Mikuru
++Michiru
+ Yuki
+END
+        diff = Oktest::Util.unified_diff(s1, s2)
+        assert_eq diff, expected
+      end
+    end
+
+    describe '.unified_diff()' do
+      it "[!rnx4f] checks whether text string ends with newline char." do
+        s1 = <<'END'
+Haruhi
+Mikuru
+Yuki
+END
+        s2 = s1
+        #
+        expected1 = <<'END'
+--- old
++++ new
+@@ -1,4 +1,4 @@
+ Haruhi
+ Mikuru
+-Yuki\ No newline at end of string
++Yuki
+END
+        diff = Oktest::Util.unified_diff(s1.chomp, s2)
+        assert_eq diff, expected1
+        #
+        expected2 = <<'END'
+--- old
++++ new
+@@ -1,4 +1,4 @@
+ Haruhi
+ Mikuru
+-Yuki
++Yuki\ No newline at end of string
+END
+        diff = Oktest::Util.unified_diff(s1, s2.chomp)
+        assert_eq diff, expected2
+      end
+    end
+
+    describe '.diff_unified()' do
+      it "[!ulyq5] returns unified diff string of two text strings." do
+        s1 = <<'END'
+Haruhi
+Mikuru
+Yuki
+END
+        s2 = <<'END'
+Haruhi
+Michiru
+Yuki
+END
+        expected = <<'END'
+--- old
++++ new
+@@ -1,3 +1,3 @@
+ Haruhi
+-Mikuru
++Michiru
+ Yuki
+END
+        diff = Oktest::Util.diff_unified(s1, s2)
+        assert_eq diff, expected
+      end
+      it "[!6tgum] detects whether char at end of file is newline or not." do
+        s1 = <<'END'
+Haruhi
+Mikuru
+Yuki
+END
+        s2 = s1
+        #
+        expected1 = <<'END'
+--- old
++++ new
+@@ -1,3 +1,3 @@
+ Haruhi
+ Mikuru
+-Yuki
+
++Yuki
+END
+        diff = Oktest::Util.diff_unified(s1.chomp, s2)
+        assert_eq diff, expected1
+        #
+        expected2 = <<'END'
+--- old
++++ new
+@@ -1,3 +1,3 @@
+ Haruhi
+ Mikuru
+-Yuki
++Yuki
+
+END
+        diff = Oktest::Util.diff_unified(s1, s2.chomp)
+        assert_eq diff, expected2
+      end
+    end
+
+  end
+
+end

data/test/visitor_test.rb

@@ -0,0 +1,292 @@
+# -*- coding: utf-8 -*-
+
+###
+### $Release: 1.0.0 $
+### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
+### $License: MIT License $
+###
+
+require_relative './initialize'
+
+
+class Visitor_TC < TC
+
+  class DummyVisitor0 < Oktest::Visitor
+    def initialize
+      @log = []
+    end
+    attr_reader :log
+    def visit_scope(spec, depth, parent)
+      indent = depth >= 0 ? "  " * depth : ""
+      @log << "#{indent}scope: #{spec.filename} {\n"
+      super
+      @log << "#{indent}}\n"
+    end
+    def visit_topic(topic, depth, parent)
+      indent = depth >= 0 ? "  " * depth : ""
+      @log << "#{indent}topic: #{topic.target} {\n"
+      super
+      @log << "#{indent}}\n"
+    end
+    def visit_spec(spec, depth, parent)
+      indent = depth >= 0 ? "  " * depth : ""
+      @log << "#{indent}spec: #{spec.desc} {\n"
+      super
+      @log << "#{indent}}\n"
+    end
+  end
+
+  def prepare()
+    Oktest.scope do
+      topic 'Example1' do
+        topic 'sample1-1' do
+          spec("1+1 should be 2") { ok {1+1} == 2 }
+          spec("1-1 should be 0") { ok {1-1} == 0 }
+        end
+      end
+    end
+  end
+
+  def setup
+  end
+
+  def teardown
+    Oktest::THE_GLOBAL_SCOPE.clear_children()
+  end
+
+  describe '#visit_spec()' do
+    it "[!9f7i9] do something on spec." do
+      expected = <<'END'
+spec: sample {
+}
+END
+      sp = Oktest::SpecLeaf.new(nil, "sample")
+      visitor = DummyVisitor0.new
+      visitor.visit_spec(sp, 0, nil)
+      assert_eq visitor.log.join(), expected
+    end
+  end
+
+  describe '#visit_topic()' do
+    it "[!mu3fn] visits each child of topic." do
+      expected = <<'END'
+topic: example {
+  spec: sample {
+  }
+}
+END
+      to = Oktest::TopicNode.new(nil, "example")
+      sp = Oktest::SpecLeaf.new(to, "sample")
+      visitor = DummyVisitor0.new
+      visitor.visit_topic(to, 0, nil)
+      assert_eq visitor.log.join(), expected
+    end
+  end
+
+  describe '#visit_scope()' do
+    it "[!hebhz] visits each child scope." do
+      expected = <<'END'
+scope: file.rb {
+  topic: example {
+  }
+  spec: sample {
+  }
+}
+END
+      sc = Oktest::ScopeNode.new(nil, "file.rb")
+      to = Oktest::TopicNode.new(sc, "example")
+      sp = Oktest::SpecLeaf.new(sc, "sample")
+      visitor = DummyVisitor0.new
+      visitor.visit_scope(sc, 0, nil)
+      assert_eq visitor.log.join(), expected
+    end
+  end
+
+  describe '#start()' do
+    it "[!8h8qf] start visiting tree." do
+      expected = <<'END'
+scope: test/visitor_test.rb {
+  topic: Example1 {
+    topic: sample1-1 {
+      spec: 1+1 should be 2 {
+      }
+      spec: 1-1 should be 0 {
+      }
+    }
+  }
+}
+END
+      prepare()
+      visitor = DummyVisitor0.new
+      visitor.start()
+      assert_eq visitor.log.join(), expected
+    end
+  end
+
+end
+
+
+class Traverser_TC < TC
+
+  class MyTraverser < Oktest::Traverser
+    def on_scope(filename, tag, depth)
+      print "  " * depth if depth >= 0
+      print "* scope: #{filename}"
+      print " (tag: #{tag})" if tag
+      print "\n"
+      yield
+    end
+    def on_topic(target, tag, depth)
+      print "  " * depth
+      print "+ topic: #{target}"
+      print " (tag: #{tag})" if tag
+      print "\n"
+      yield
+    end
+    def on_case(desc, tag, depth)
+      print "  " * depth
+      print "- case: #{desc}"
+      print " (tag: #{tag})" if tag
+      print "\n"
+      yield
+    end
+    def on_spec(desc, tag, depth)
+      print "  " * depth
+      print "- spec: #{desc}"
+      print " (tag: #{tag})" if tag
+      print "\n"
+    end
+  end
+
+  def prepare()
+    Oktest.scope do
+      topic 'Example' do
+        topic Integer, tag: 'cls' do
+          spec "1+1 should be 2." do ok {1+1} == 2 end
+          spec "1-1 should be 0." do ok {1-1} == 0 end
+          case_when 'negative...' do
+            spec "abs() returns sign-reversed value." do ok {-3.abs()} == 3 end
+          end
+          case_else do
+            spec "abs() returns positive value." do ok {4.abs()} == 4 end
+          end
+        end
+        topic Float, tag: 'cls' do
+          spec "1*1 should be 1.", tag: 'err' do ok {1*1} == 2 end   # fail
+          spec "1/1 should be 1.", tag: 'err' do ok {1/0} == 1 end   # error
+        end
+      end
+    end
+  end
+
+  def teardown()
+    Oktest::THE_GLOBAL_SCOPE.clear_children()
+  end
+
+
+  describe '#start()' do
+    it "[!5zonp] visits topics and specs and calls callbacks." do
+      expected = <<'END'
+* scope: test/visitor_test.rb
+  + topic: Example
+    + topic: Integer (tag: cls)
+      - spec: 1+1 should be 2.
+      - spec: 1-1 should be 0.
+      - case: When negative...
+        - spec: abs() returns sign-reversed value.
+      - case: Else
+        - spec: abs() returns positive value.
+    + topic: Float (tag: cls)
+      - spec: 1*1 should be 1. (tag: err)
+      - spec: 1/1 should be 1. (tag: err)
+END
+      prepare()
+      sout, serr = capture { MyTraverser.new.start() }
+      assert_eq sout, expected
+      assert_eq serr, ""
+    end
+    it "[!gkopz] doesn't change Oktest::THE_GLOBAL_SCOPE." do
+      prepare()
+      n = Oktest::THE_GLOBAL_SCOPE.each_child.to_a.length
+      sout, serr = capture do
+        MyTraverser.new.start()
+      end
+      assert_eq Oktest::THE_GLOBAL_SCOPE.each_child.to_a.length, n
+    end
+  end
+
+  describe '#visit_scope()' do
+    it "[!ledj3] calls on_scope() callback on scope." do
+      expected = <<'END'
+* scope: test/visitor_test.rb
+* scope: test/visitor_test.rb
+END
+      Oktest.scope do
+      end
+      Oktest.scope do
+      end
+      sout, serr = capture { MyTraverser.new.start() }
+      assert_eq sout, expected
+      assert_eq serr, ""
+    end
+  end
+
+  describe '#visit_topic()' do
+    it "[!x8r9w] calls on_topic() callback on topic." do
+      expected = <<'END'
+* scope: test/visitor_test.rb
+  + topic: Parent
+    + topic: Child
+END
+      Oktest.scope do
+        topic 'Parent' do
+          topic 'Child' do
+          end
+        end
+      end
+      sout, serr = capture { MyTraverser.new.start() }
+      assert_eq sout, expected
+      assert_eq serr, ""
+    end
+    it "[!qh0q3] calls on_case() callback on case_when or case_else." do
+      expected = <<'END'
+* scope: test/visitor_test.rb
+  + topic: Parent
+    - case: When some condition
+    - case: Else
+END
+      Oktest.scope do
+        topic 'Parent' do
+          case_when 'some condition' do
+          end
+          case_else do
+          end
+        end
+      end
+      sout, serr = capture { MyTraverser.new.start() }
+      assert_eq sout, expected
+      assert_eq serr, ""
+    end
+  end
+
+  describe '#visit_spec()' do
+    it "[!41uyj] calls on_spec() callback." do
+      expected = <<'END'
+* scope: test/visitor_test.rb
+  + topic: Example
+    - spec: sample #1
+    - spec: sample #2
+END
+      Oktest.scope do
+        topic 'Example' do
+          spec "sample #1" do ok {1+1} == 2 end
+          spec "sample #2" do ok {1-1} == 0 end
+        end
+      end
+      sout, serr = capture { MyTraverser.new.start() }
+      assert_eq sout, expected
+      assert_eq serr, ""
+    end
+  end
+
+end