oktest 1.3.0 → 1.4.0

data/test/helper_test.rb

@@ -1,5 +1,8 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 ###
-### $Release: 1.3.0 $
+### $Release: 1.4.0 $
 ### $Copyright: copyright(c) 2011-2024 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###
@@ -181,9 +184,9 @@ END
     end
   end
 
-  describe '#capture_sio()' do
+  describe '#capture_stdio()' do
     it "[!1kbnj] captures $stdio and $stderr." do
-      sout, serr = capture_sio() do
+      sout, serr = capture_stdio() do
         puts "fooo"
         $stderr.puts "baaa"
       end
@@ -192,7 +195,7 @@ END
     end
     it "[!53mai] takes $stdin data." do
       data = nil
-      sout, serr = capture_sio("blabla") do
+      sout, serr = capture_stdio("blabla") do
         data = $stdin.read()
       end
       data = "blabla"
@@ -201,7 +204,7 @@ END
       stdin_, stdout_, stderr_ = $stdin, $stdout, $stderr
       exception = nil
       begin
-        sout, serr = capture_sio() do
+        sout, serr = capture_stdio() do
           puts "fooo"
           $stderr.puts "baaa"
           assert stdin_  != $stdin , "stdin should be replaced"
@@ -219,7 +222,7 @@ END
       assert stderr_ == $stderr, "stderr should be recovered"
     end
     it "[!4j494] returns outpouts of stdout and stderr." do
-      sout, serr = capture_sio() do
+      sout, serr = capture_stdio() do
         puts "foo"
         $stderr.puts "bar"
       end
@@ -227,17 +230,186 @@ END
       assert_eq serr, "bar\n"
     end
     it "[!6ik8b] can simulate tty." do
-      sout, serr = capture_sio() do
+      sout, serr = capture_stdio() do
         assert_eq $stdin.tty?, false
         assert_eq $stdout.tty?, false
         assert_eq $stderr.tty?, false
       end
       #
-      sout, serr = capture_sio(tty: true) do
+      sout, serr = capture_stdio(tty: true) do
+        assert_eq $stdin.tty?, true
+        assert_eq $stdout.tty?, true
+        assert_eq $stderr.tty?, true
+      end
+    end
+  end
+
+  describe '#capture_sio()' do
+    it "[!qjmaa] 'capture_sio()' is an alias of 'capture_stdio()'." do
+      sin = nil
+      sout, serr = capture_sio("INPUT", tty: true) do
+        sin = $stdin.read()
+        puts "OUTPUT"
+        $stderr.puts "ERROR"
+        assert_eq $stdin.tty?, true
+        assert_eq $stdout.tty?, true
+        assert_eq $stdout.tty?, true
+      end
+      assert_eq sin, "INPUT"
+      assert_eq sout, "OUTPUT\n"
+      assert_eq serr, "ERROR\n"
+    end
+  end
+
+  describe '#capture_stdout()' do
+    it "[!4agii] same as `sout, serr = capture_stdio(); ok {serr} == ''`." do
+      sin = nil
+      sout = capture_stdout("INPUT", tty: true) do
+        sin = $stdin.read()
+        puts "OUTPUT"
         assert_eq $stdin.tty?, true
         assert_eq $stdout.tty?, true
         assert_eq $stderr.tty?, true
       end
+      assert_eq sin, "INPUT"
+      assert_eq sout, "OUTPUT\n"
+    end
+    it "[!may84] fails when stderr is not empty." do
+      assert_exc(Oktest::AssertionFailed, "Output of $stderr expected to be empty, but got: \"ERROR\"") do
+        capture_stdout() do
+          $stderr.print "ERROR"
+        end
+      end
+    end
+    it "[!5n04e] returns output of stdout." do
+      sout = capture_stdout() do
+        print "OUTPUT"
+      end
+      assert_eq sout, "OUTPUT"
+    end
+  end
+
+  describe '#capture_stderr()' do
+    it "[!46tj4] same as `sout, serr = capture_stdio(); ok {sout} == ''`." do
+      sin = nil
+      serr = capture_stderr("INPUT", tty: true) do
+        sin = $stdin.read()
+        $stderr.puts "ERROR"
+        assert_eq $stdin.tty?, true
+        assert_eq $stdout.tty?, true
+        assert_eq $stderr.tty?, true
+      end
+      assert_eq sin, "INPUT"
+      assert_eq serr, "ERROR\n"
+    end
+    it "[!3zh32] fails when stdout is not empty." do
+      assert_exc(Oktest::AssertionFailed, "Output of $stdout expected to be empty, but got: \"OUTPUT\"") do
+        capture_stderr() do
+          print "OUTPUT"
+        end
+      end
+    end
+    it "[!5vs64] returns output of stderr." do
+      serr = capture_stderr() do
+        $stderr.print "ERROR"
+      end
+      assert_eq serr, "ERROR"
+    end
+  end
+
+  describe '#capture_command()' do
+    it "[!wyp17] executes command with stdin data." do
+      sout, serr = capture_command("cat -n", "AAA\nBBB\n")
+      assert_eq sout, "     1\tAAA\n     2\tBBB\n"
+      assert_eq serr, ""
+    end
+    it "[!jd63p] raises error if command failed." do
+      begin
+        capture_command("ls *not*exist*")
+      rescue => exc
+        assert_eq exc.class, RuntimeError
+        assert_eq exc.message, "Command failed with status (1): `ls *not*exist*`"
+      else
+        assert false, "Exception should be raised but not."
+      end
+    end
+    it "[!lsmgq] calls error handler block if command failed." do
+      called = nil
+      sout, serr = capture_command("ls *not*exist*") do |pstat|
+        called = pstat
+      end
+      assert called.is_a?(Process::Status)
+      assert called.exitstatus == 1
+      assert_eq sout, ""
+      assert_eq serr, "ls: *not*exist*: No such file or directory\n"
+    end
+    it "[!vivq3] doesn't call error handler block if command finished successfully." do
+      called = false
+      sout, serr = capture_command("cat -n", "AAA\nBBB\n") do
+        called = true
+      end
+      assert_eq called, false
+      assert_eq sout, "     1\tAAA\n     2\tBBB\n"
+      assert_eq serr, ""
+    end
+    it "[!nxw59] not raise error if command failed and error handler specified." do
+      begin
+        sout, serr = capture_command("ls *not*exist*") do end
+      rescue => exc
+        assert false, "Exception should not raised, but raised #{exc.inspect}"
+      end
+      assert_eq sout, ""
+      assert_eq serr, "ls: *not*exist*: No such file or directory\n"
+    end
+    it "[!h5994] returns output of stdin and stderr." do
+      sout, serr = capture_command("cat -n", "AAA\nBBB\n")
+      assert_eq sout, "     1\tAAA\n     2\tBBB\n"
+      assert_eq serr, ""
+      #
+      sout, serr = capture_command("echo ERR >&2")
+      assert_eq sout, ""
+      assert_eq serr, "ERR\n"
+    end
+  end
+
+  describe '#capture_command!()' do
+    it "[!vlbpo] executes command with stdin data." do
+      sout, serr = capture_command!("cat -n", "AAA\nBBB\n")
+      assert_eq sout, "     1\tAAA\n     2\tBBB\n"
+      assert_eq serr, ""
+    end
+    it "[!yfohb] not raise error even if command failed." do
+      sout, serr = capture_command!("ls *not*exist*")
+      assert_eq sout, ""
+      assert_eq serr, "ls: *not*exist*: No such file or directory\n"
+    end
+    it "[!andyj] calls error handler block if command failed." do
+      called = nil
+      sout, serr = capture_command!("ls *not*exist*") do |pstat|
+        called = pstat
+      end
+      assert called.is_a?(Process::Status)
+      assert called.exitstatus == 1
+      assert_eq sout, ""
+      assert_eq serr, "ls: *not*exist*: No such file or directory\n"
+    end
+    it "[!xnkqc] doesn't call error handler block if command finished successfully." do
+      called = false
+      sout, serr = capture_command!("cat -n", "AAA\nBBB\n") do
+        called = true
+      end
+      assert_eq called, false
+      assert_eq sout, "     1\tAAA\n     2\tBBB\n"
+      assert_eq serr, ""
+    end
+    it "[!3xdgo] returns output of stdin and stderr." do
+      sout, serr = capture_command!("cat -n", "AAA\nBBB\n")
+      assert_eq sout, "     1\tAAA\n     2\tBBB\n"
+      assert_eq serr, ""
+      #
+      sout, serr = capture_command!("echo ERR >&2")
+      assert_eq sout, ""
+      assert_eq serr, "ERR\n"
     end
   end
 

data/test/initialize.rb

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###
-### $Release: 1.3.0 $
+### $Release: 1.4.0 $
 ### $Copyright: copyright(c) 2011-2024 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/mainapp_test.rb

@@ -1,5 +1,8 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 ###
-### $Release: 1.3.0 $
+### $Release: 1.4.0 $
 ### $Copyright: copyright(c) 2011-2024 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###
@@ -108,37 +111,37 @@ END
     it "[!d5mql] returns 1 when a certain error raised." do
       ret, sout, serr = main(["-U"])
       assert_eq ret, 1
-      assert_eq serr, "#{File.basename($0)}: -U: unknown option.\n"
+      assert_eq serr, "[ERROR] -U: Unknown option.\n"
     end
 
     it "[!jr49p] reports error when unknown option specified." do
       ret, sout, serr = main(["-X"])
       assert_eq ret, 1
-      assert_eq serr, "#{File.basename($0)}: -X: unknown option.\n"
+      assert_eq serr, "[ERROR] -X: Unknown option.\n"
       #
       ret, sout, serr = main(["--foobar"])
       assert_eq ret, 1
-      assert_eq serr, "#{File.basename($0)}: --foobar: unknown option.\n"
+      assert_eq serr, "[ERROR] --foobar: Unknown long option.\n"
     end
 
     it "[!uqomj] reports error when required argument is missing." do
       ret, sout, serr = main(["-s"])
       assert_eq ret, 1
-      assert_eq serr, "#{File.basename($0)}: -s: argument required.\n"
+      assert_eq serr, "[ERROR] -s: Argument required.\n"
     end
 
     it "[!8i755] reports error when argument is invalid." do
       ret, sout, serr = main(["-s", "foobar"])
       assert_eq ret, 1
-      assert_eq serr, "#{File.basename($0)}: -s foobar: invalid argument.\n"
+      assert_eq serr, "[ERROR] -s foobar: Expected one of verbose/simple/compact/plain/quiet/v/s/c/p/q.\n"
       #
       ret, sout, serr = main(["-F", "aaa=*pat*"])
       assert_eq ret, 1
-      assert_eq serr, "#{File.basename($0)}: -F aaa=*pat*: invalid argument.\n"
+      assert_eq serr, "[ERROR] -F aaa=*pat*: Pattern unmatched.\n"
       #
-      ret, sout, serr = main(["--color=true"])
+      ret, sout, serr = main(["--color=abc"])
       assert_eq ret, 1
-      assert_eq serr, "#{File.basename($0)}: --color=true: invalid argument.\n"
+      assert_eq serr, "[ERROR] --color=abc: Boolean expected.\n"
     end
 
   end
@@ -163,6 +166,13 @@ END
       assert edit_actual(sout).end_with?(edit_expected(expected)), "invalid status line"
     end
 
+    it "[!k402d] raises error if file not found." do
+      filename = "not-exist-file"
+      assert_exc(Benry::CmdOpt::OptionError, "#{filename}: not found.") do
+        run(filename)
+      end
+    end
+
     it "[!bim36] changes auto-running to off." do
       Oktest::Config.auto_run = true
       _ = run(@testfile)
@@ -213,25 +223,38 @@ END
       end
     end
 
+    it "[!tt2gj] parses command options even after filenames." do
+      ret, sout, serr = run(@testfile, "--version")
+      assert_eq ret, 0
+      assert_eq sout, Oktest::VERSION+"\n"
+      assert_eq serr, ""
+    end
+
     #HELP_MESSAGE = Oktest::MainApp::HELP_MESSAGE % {command: File.basename($0)}
-    HELP_MESSAGE = <<"END"
-Usage: #{File.basename($0)} [<options>] [<file-or-directory>...]
-  -h, --help             : show help
-      --version          : print version
-  -s <REPORT-STYLE>      : verbose/simple/compact/plain/quiet, or v/s/c/p/q
-  -F <PATTERN>           : filter topic or spec with pattern (see below)
-      --color[={on|off}] : enable/disable output coloring forcedly
-  -S, --skeleton         : print test code skeleton
-  -G, --generate         : generate test code skeleton from ruby file
-
-Filter examples:
-  $ oktest -F topic=Hello            # filter by topic
-  $ oktest -F spec='*hello*'         # filter by spec
-  $ oktest -F tag=name               # filter by tag name
-  $ oktest -F tag!=name              # negative filter by tag name
-  $ oktest -F tag='{name1,name2}'    # filter by multiple tag names
-
-See https://github.com/kwatch/oktest/blob/ruby/ruby/README.md for details.
+    HELP_MESSAGE = (<<"END") % {command: File.basename($0)}
+\e[1mOktest\e[0m (#{Oktest::VERSION}) -- New style testing library
+
+\e[36mUsage:\e[0m
+  $ \e[1m%{command}\e[0m [<options>] [<file|directory>...]
+
+\e[36mOptions:\e[0m
+  -h, --help               : show help
+      --version            : print version
+  -s <reporting-style>     : verbose/simple/compact/plain/quiet, or v/s/c/p/q
+  -F <key>=<pattern>       : filter topic or spec with pattern (see below)
+      --color[=<on|off>]   : enable/disable output coloring forcedly
+  -S, --skeleton           : print test code skeleton
+  -G, --generate[=<style>] : generate test code skeleton from ruby file
+
+\e[36mFilter Examples:\e[0m
+  $ %{command} -F topic=Hello            # filter by topic
+  $ %{command} -F spec='*hello*'         # filter by spec
+  $ %{command} -F tag=name               # filter by tag name
+  $ %{command} -F tag!=name              # negative filter by tag name
+  $ %{command} -F tag='{name1,name2}'    # filter by multiple tag names
+
+\e[36mDocument:\e[0m
+  https://github.com/kwatch/oktest/blob/ruby/ruby/README.md
 END
 
     it "[!65vdx] prints help message if no arguments specified." do
@@ -256,8 +279,18 @@ END
       assert_eq serr, ""
     end
 
+    it "[!v938d] help message will be colored only when stdout is a tty." do
+      ret, sout, serr = run("-h", tty: true)
+      assert sout =~ /\e\[1mOktest\e\[0m/
+      assert sout =~ /\e\[36mOptions:\e\[0m/
+      #
+      ret, sout, serr = run("-h", tty: false)
+      assert sout !~ /\e\[1mOktest\e\[0m/
+      assert sout !~ /\e\[36mOptions:\e\[0m/
+    end
+
     it "[!qqizl] '--version' option prints version number." do
-      expected = '$Release: 1.3.0 $'.split()[1] + "\n"
+      expected = '$Release: 1.4.0 $'.split()[1] + "\n"
       #
       ret, sout, serr = run("--version")
       assert_eq ret, 0
@@ -445,7 +478,7 @@ END
     end
 
     it "[!71h2x] '-F ...' option will be error." do
-      assert_exc(OptionParser::InvalidArgument, "invalid argument: -F *pat*") do
+      assert_exc(Benry::CmdOpt::OptionError, "-F *pat*: Pattern unmatched.") do
         run("-F", "*pat*", @testfile)
       end
     end
@@ -500,16 +533,10 @@ END
       end
     end
 
-    it "[!9nr94] '--color=true' option raises error." do
-      assert_exc(OptionParser::InvalidArgument, "invalid argument: --color=true") do
-        run("--color=true", @testfile)
-      end
-    end
-
     it "[!dk8eg] '-S' or '--skeleton' option prints test code skeleton." do
       ret, sout, serr = run("-S")
       assert_eq ret, 0
-      assert_eq sout, Oktest::MainApp::SKELETON
+      assert_eq sout, Oktest::MainApp.new.__send__(:skeleton)
       assert_eq serr, ""
     end
 
@@ -547,7 +574,7 @@ Oktest.scope do
 
       spec "returns greeting message."
 
-    end  # #hello()
+    end
 
 
   end  # Hello
@@ -592,7 +619,7 @@ Oktest.scope do
 
     - spec("returns greeting message.")
 
-    end  # #hello()
+    end
 
 
   end  # Hello
@@ -602,7 +629,7 @@ end
 END
       #
       begin
-        ret, sout, serr = run("-gunaryop", filename)
+        ret, sout, serr = run("-Gunaryop", filename)
         assert_eq ret, 0
         assert_eq sout, expected
         assert_eq serr, ""
@@ -675,4 +702,23 @@ END
 
   end
 
+  describe '#skeleton()' do
+    it "[!s2i1p] returns skeleton string of test script." do
+      str = Oktest::MainApp.new.__send__(:skeleton)
+      assert str =~ /^require 'oktest'$/
+      assert str =~ /^Oktest\.scope do$/
+    end
+    it "[!opvik] skeleton string is valid ruby code." do
+      str = Oktest::MainApp.new.__send__(:skeleton)
+      filename = "tmp.skeleten.rb"
+      File.write(filename, str, encoding: 'utf-8')
+      begin
+        result = `ruby -wc #{filename}`
+        assert_eq result, "Syntax OK\n"
+      ensure
+        File.unlink filename
+      end
+    end
+  end
+
 end

data/test/matcher_test.rb

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###
-### $Release: 1.3.0 $
+### $Release: 1.4.0 $
 ### $Copyright: copyright(c) 2011-2024 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/misc_test.rb

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###
-### $Release: 1.3.0 $
+### $Release: 1.4.0 $
 ### $Copyright: copyright(c) 2011-2024 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/node_test.rb

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###
-### $Release: 1.3.0 $
+### $Release: 1.4.0 $
 ### $Copyright: copyright(c) 2011-2024 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###
@@ -496,6 +497,21 @@ class Context_TC < TC
       to = node.each_child.first
       assert_eq to.target, "When condition..."
     end
+    it "[!53qxv] not add 'When ' if description starts with it." do
+      node = new_node_with() do
+        case_when "when condition..." do
+        end
+      end
+      to = node.each_child.first
+      assert_eq to.target, "when condition..."
+      #
+      node = new_node_with() do
+        case_when "[""!abc] when..." do
+        end
+      end
+      to = node.each_child.first
+      assert_eq to.target, "[""!abc] when..."
+    end
   end
 
   describe '#case_else()' do
@@ -521,6 +537,25 @@ class Context_TC < TC
       assert_eq to.class, Oktest::TopicNode
       assert_eq to.target, "Else"
     end
+    it "[!3nn8d] not add 'Else ' if description starts with it." do
+      node = new_node_with() do
+        case_else "else (x < 0)" do
+        end
+      end
+      assert_eq node.each_child.to_a.length, 1
+      to = node.each_child.first
+      assert_eq to.class, Oktest::TopicNode
+      assert_eq to.target, "else (x < 0)"
+      #
+      node = new_node_with() do
+        case_else "[""!abc] else..." do
+        end
+      end
+      assert_eq node.each_child.to_a.length, 1
+      to = node.each_child.first
+      assert_eq to.class, Oktest::TopicNode
+      assert_eq to.target, "[""!abc] else..."
+    end
     it "[!hs1to] 1st parameter is optional." do
       node = new_node_with() do
         case_else "(x < 0)" do

data/test/reporter_test.rb

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###
-### $Release: 1.3.0 $
+### $Release: 1.4.0 $
 ### $Copyright: copyright(c) 2011-2024 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/run_all.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 #Dir.chdir File.dirname(__FILE__) do
 #  Dir.glob("**/*_test.rb") do |x|

data/test/runner_test.rb

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###
-### $Release: 1.3.0 $
+### $Release: 1.4.0 $
 ### $Copyright: copyright(c) 2011-2024 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/tc.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ## micro test case class
 class TC

data/test/util_test.rb

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###
-### $Release: 1.3.0 $
+### $Release: 1.4.0 $
 ### $Copyright: copyright(c) 2011-2024 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###
@@ -32,7 +33,7 @@ END
         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"
+        assert_eq c[1][12], "class Util_TC < TC\n"
         #
         data1 = c[1]
         _ = Oktest::Util.file_line(__FILE__, 1)

data/test/utilhelper_test.rb

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###
-### $Release: 1.3.0 $
+### $Release: 1.4.0 $
 ### $Copyright: copyright(c) 2011-2024 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/visitor_test.rb

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ###
-### $Release: 1.3.0 $
+### $Release: 1.4.0 $
 ### $Copyright: copyright(c) 2011-2024 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###