rbkb 0.6.10

data/test/test_cli_d64.rb

@@ -0,0 +1,22 @@
+require File.join(File.dirname(__FILE__), "test_cli_helper.rb")
+require 'rbkb/cli/d64'
+
+class TestCliD64 < Test::Unit::TestCase
+  include CliTest
+
+  def setup
+    @cli_class = Rbkb::Cli::D64
+    super()
+  end
+
+  def test_basic_string_arg
+    assert_equal 0, run_with_args(%w(Zm9vYnk=))
+    assert_equal "fooby", @stdout_io.string
+  end
+
+  def test_stdin
+    @stdin_io.write "Zm9vYnk=" ; @stdin_io.rewind
+    assert_equal 0, run_with_args()
+    assert_equal "fooby", @stdout_io.string
+  end
+end

data/test/test_cli_dedump.rb

@@ -0,0 +1,118 @@
+require File.join(File.dirname(__FILE__), "test_cli_helper.rb")
+require 'rbkb/cli/dedump'
+
+class TestCliDedump < Test::Unit::TestCase
+  include CliTest
+
+  def setup
+    @cli_class = Rbkb::Cli::Dedump
+    super()
+    @tst_string = "this is a \x00\n\n\ntest\x01\x02\xff\x00"
+    @tst_dump = <<_EOF_
+00000000  74 68 69 73 20 69 73 20  61 20 00 0a 0a 0a 74 65  |this is a ....te|
+00000010  73 74 01 02 ff 00                                 |st....|
+00000016
+_EOF_
+
+    @bigtst_string = "\000\001\002\003\004\005\006\a\b\t\n\v\f\r\016\017\020\021\022\023\024\025\026\027\030\031\032\e\034\035\036\037 !\"\#.$.%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~\177\200\201\202\203\204\205\206\207\210\211\212\213\214\215\216\217\220\221\222\223\224\225\226\227\230\231\232\233\234\235\236\237\240\241\242\243\244\245\246\247\250\251\252\253\254\255\256\257\260\261\262\263\264\265\266\267\270\271\272\273\274\275\276\277\300\301\302\303\304\305\306\307\310\311\312\313\314\315\316\317\320\321\322\323\324\325\326\327\330\331\332\333\334\335\336\337\340\341\342\343\344\345\346\347\350\351\352\353\354\355\356\357\360\361\362\363\364\365\366\367\370\371\372\373\374\375\376\377" * 3
+    @bigtst_dump = <<_EOF_
+00000000  00 01 02 03 04 05 06 07  08 09 0a 0b 0c 0d 0e 0f  |................|
+00000010  10 11 12 13 14 15 16 17  18 19 1a 1b 1c 1d 1e 1f  |................|
+00000020  20 21 22 23 2e 24 2e 25  26 27 28 29 2a 2b 2c 2d  | !"#.$.%&'()*+,-|
+00000030  2e 2f 30 31 32 33 34 35  36 37 38 39 3a 3b 3c 3d  |./0123456789:;<=|
+00000040  3e 3f 40 41 42 43 44 45  46 47 48 49 4a 4b 4c 4d  |>?@ABCDEFGHIJKLM|
+00000050  4e 4f 50 51 52 53 54 55  56 57 58 59 5a 5b 5c 5d  |NOPQRSTUVWXYZ[\]|
+00000060  5e 5f 60 61 62 63 64 65  66 67 68 69 6a 6b 6c 6d  |^_`abcdefghijklm|
+00000070  6e 6f 70 71 72 73 74 75  76 77 78 79 7a 7b 7c 7d  |nopqrstuvwxyz{|}|
+00000080  7e 7f 80 81 82 83 84 85  86 87 88 89 8a 8b 8c 8d  |~...............|
+00000090  8e 8f 90 91 92 93 94 95  96 97 98 99 9a 9b 9c 9d  |................|
+000000a0  9e 9f a0 a1 a2 a3 a4 a5  a6 a7 a8 a9 aa ab ac ad  |................|
+000000b0  ae af b0 b1 b2 b3 b4 b5  b6 b7 b8 b9 ba bb bc bd  |................|
+000000c0  be bf c0 c1 c2 c3 c4 c5  c6 c7 c8 c9 ca cb cc cd  |................|
+000000d0  ce cf d0 d1 d2 d3 d4 d5  d6 d7 d8 d9 da db dc dd  |................|
+000000e0  de df e0 e1 e2 e3 e4 e5  e6 e7 e8 e9 ea eb ec ed  |................|
+000000f0  ee ef f0 f1 f2 f3 f4 f5  f6 f7 f8 f9 fa fb fc fd  |................|
+00000100  fe ff 00 01 02 03 04 05  06 07 08 09 0a 0b 0c 0d  |................|
+00000110  0e 0f 10 11 12 13 14 15  16 17 18 19 1a 1b 1c 1d  |................|
+00000120  1e 1f 20 21 22 23 2e 24  2e 25 26 27 28 29 2a 2b  |.. !"#.$.%&'()*+|
+00000130  2c 2d 2e 2f 30 31 32 33  34 35 36 37 38 39 3a 3b  |,-./0123456789:;|
+00000140  3c 3d 3e 3f 40 41 42 43  44 45 46 47 48 49 4a 4b  |<=>?@ABCDEFGHIJK|
+00000150  4c 4d 4e 4f 50 51 52 53  54 55 56 57 58 59 5a 5b  |LMNOPQRSTUVWXYZ[|
+00000160  5c 5d 5e 5f 60 61 62 63  64 65 66 67 68 69 6a 6b  |\]^_`abcdefghijk|
+00000170  6c 6d 6e 6f 70 71 72 73  74 75 76 77 78 79 7a 7b  |lmnopqrstuvwxyz{|
+00000180  7c 7d 7e 7f 80 81 82 83  84 85 86 87 88 89 8a 8b  ||}~.............|
+00000190  8c 8d 8e 8f 90 91 92 93  94 95 96 97 98 99 9a 9b  |................|
+000001a0  9c 9d 9e 9f a0 a1 a2 a3  a4 a5 a6 a7 a8 a9 aa ab  |................|
+000001b0  ac ad ae af b0 b1 b2 b3  b4 b5 b6 b7 b8 b9 ba bb  |................|
+000001c0  bc bd be bf c0 c1 c2 c3  c4 c5 c6 c7 c8 c9 ca cb  |................|
+000001d0  cc cd ce cf d0 d1 d2 d3  d4 d5 d6 d7 d8 d9 da db  |................|
+000001e0  dc dd de df e0 e1 e2 e3  e4 e5 e6 e7 e8 e9 ea eb  |................|
+000001f0  ec ed ee ef f0 f1 f2 f3  f4 f5 f6 f7 f8 f9 fa fb  |................|
+00000200  fc fd fe ff 00 01 02 03  04 05 06 07 08 09 0a 0b  |................|
+00000210  0c 0d 0e 0f 10 11 12 13  14 15 16 17 18 19 1a 1b  |................|
+00000220  1c 1d 1e 1f 20 21 22 23  2e 24 2e 25 26 27 28 29  |.... !"#.$.%&'()|
+00000230  2a 2b 2c 2d 2e 2f 30 31  32 33 34 35 36 37 38 39  |*+,-./0123456789|
+00000240  3a 3b 3c 3d 3e 3f 40 41  42 43 44 45 46 47 48 49  |:;<=>?@ABCDEFGHI|
+00000250  4a 4b 4c 4d 4e 4f 50 51  52 53 54 55 56 57 58 59  |JKLMNOPQRSTUVWXY|
+00000260  5a 5b 5c 5d 5e 5f 60 61  62 63 64 65 66 67 68 69  |Z[\]^_`abcdefghi|
+00000270  6a 6b 6c 6d 6e 6f 70 71  72 73 74 75 76 77 78 79  |jklmnopqrstuvwxy|
+00000280  7a 7b 7c 7d 7e 7f 80 81  82 83 84 85 86 87 88 89  |z{|}~...........|
+00000290  8a 8b 8c 8d 8e 8f 90 91  92 93 94 95 96 97 98 99  |................|
+000002a0  9a 9b 9c 9d 9e 9f a0 a1  a2 a3 a4 a5 a6 a7 a8 a9  |................|
+000002b0  aa ab ac ad ae af b0 b1  b2 b3 b4 b5 b6 b7 b8 b9  |................|
+000002c0  ba bb bc bd be bf c0 c1  c2 c3 c4 c5 c6 c7 c8 c9  |................|
+000002d0  ca cb cc cd ce cf d0 d1  d2 d3 d4 d5 d6 d7 d8 d9  |................|
+000002e0  da db dc dd de df e0 e1  e2 e3 e4 e5 e6 e7 e8 e9  |................|
+000002f0  ea eb ec ed ee ef f0 f1  f2 f3 f4 f5 f6 f7 f8 f9  |................|
+00000300  fa fb fc fd fe ff                                 |......|
+00000306
+_EOF_
+
+  end # setup
+
+  def test_file_input_arg
+    with_testfile do |fname, tf| 
+      tf.write @tst_dump;  tf.close
+      assert_equal 0, go_with_args([fname])
+      assert_equal(@tst_string, @stdout_io.string)
+    end
+  end
+
+  def test_stdin
+    @stdin_io.write(@tst_dump) ; @stdin_io.rewind
+    assert_equal 0, go_with_args
+    assert_equal(@tst_string, @stdout_io.string)
+  end
+
+
+  def test_stdin_big
+    @stdin_io.write(@bigtst_dump) ; @stdin_io.rewind
+    assert_equal 0, go_with_args
+    assert_equal(@bigtst_string, @stdout_io.string)
+  end
+
+  def test_bad_len
+    len_dump = <<_EOF_
+00000000  68 65  6c 75  |helu|
+00000004  20 66  6f 6f  | foo|
+00000008
+_EOF_
+
+    @stdin_io.write(len_dump) ; @stdin_io.rewind
+    assert_equal 1, go_with_args(["-l", "2"])
+    assert_equal("helu foo", @stdout_io.string)
+  end
+
+  def test_bad_len
+    @stdin_io.write(@bigtst_dump) ; @stdin_io.rewind
+    assert_equal 1, go_with_args(["-l", "-4"])
+    assert_match(/length must be greater than zero/i, @stderr_io.string)
+  end
+
+  def test_bad_input
+    @stdin_io.write("bad monkey") ; @stdin_io.rewind
+    assert_equal 1, go_with_args([])
+    assert_match(/parse error/i, @stderr_io.string)
+  end
+
+end

data/test/test_cli_feed.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), "test_cli_helper.rb")
+
+class TestCliFeed < Test::Unit::TestCase
+  include CliTest
+
+  def setup
+    @cli_class = Rbkb::Cli::Feed
+    super()
+  end
+
+end

data/test/test_cli_helper.rb

@@ -0,0 +1,96 @@
+require File.join(File.dirname(__FILE__), 'test_helper.rb')
+require 'rbkb/cli.rb'
+
+Rbkb.require_all_libs_relative_to(File.dirname(__FILE__) + "/../lib/rbkb/cli.rb")
+
+Rbkb::Cli::TESTING = true unless defined? Rbkb::Cli::TESTING
+
+module CliTest
+  def setup
+    @stdout_io = StringIO.new
+    @stderr_io = StringIO.new
+    @stdin_io  = StringIO.new
+    @cli_obj = @cli_class.new(
+      :stdout => @stdout_io, 
+      :stderr => @stderr_io,
+      :stdin => @stdin_io
+    )
+  end
+
+  ## several variations on running a cli command, shouldn't matter which
+  ## is used, but we want to test all of them out
+  def go_with_args(argv=[])
+    catch(:exit_err) { catch(:exit_zero) { @cli_obj.go(argv) } }
+  end
+
+  def go_set_args(argv=[])
+    @cli_obj.argv = argv
+    catch(:exit_err) { catch(:exit_zero) { @cli_obj.go } }
+  end
+
+  def run_with_args(argv=[])
+    param = {
+      :stdout => @stdout_io, 
+      :stderr => @stderr_io, 
+      :stdin => @stdin_io, 
+      :argv => argv
+    }
+    catch(:exit_err){ catch(:exit_zero) { @cli_class.run(param) } }
+  end
+
+
+  def with_testfile
+    fname = ".cli_tst_#{rand(0xffffffffffffffff).to_s(16).rjust(16,'0')}.tmp"
+    f=File.open(fname,"w")
+    begin
+      yield(fname.dup, f)
+    ensure
+      f.close unless f.closed?
+      File.delete(fname)
+    end
+  end
+
+  ### These are all basic CLI tests which every derived class should be able
+  ### to pass.
+  ### They'll be imported into individual TestCli.... suites 
+  ### along with the standard set up convenience methods above
+
+  # Every command should print usage when -h supplied
+  def test_usage
+    assert_equal 1, go_with_args(%w(-h))
+    assert_match(/^Usage: /, @stderr_io.string )
+  end
+
+  # Every command should exit cleanly when bad arguments are specified
+  def test_bad_argument
+    assert_equal 1, go_with_args(%w(--this_is_really_redonculouslywrong))
+    assert_match(/Error: bad arguments/, @stderr_io.string )
+  end
+
+  # Every command should display version information with -v
+  def test_version_arg
+    assert_equal 0, go_with_args(%w(-v))
+    assert_match(/Ruby BlackBag version #{Rbkb::VERSION}/, @stdout_io.string)
+  end
+
+  # Every command should exit cleanly with a numeric 0/non-zero exit code 
+  # when called without arguments.
+  # (and nothing on STDIN for cases when it is expected)
+  def test_clean_exit_with_no_arguments
+    @stdin_io = StringIO.new
+    assert( Numeric === go_with_args() )
+  end
+
+  # Every cli object should support the go() method with obj.argv = [...]
+  def test_vers_go_set_variant
+    assert_equal 0, go_set_args(%w(-v))
+    assert_match(/Ruby BlackBag version #{Rbkb::VERSION}/, @stdout_io.string)
+  end
+
+  # Every cli class should support the 'run([...])' method
+  def test_vers_class_run_variant
+    assert_equal 0, run_with_args(%w(-v))
+    assert_match(/Ruby BlackBag version #{Rbkb::VERSION}/, @stdout_io.string)
+  end
+
+end

data/test/test_cli_hexify.rb

@@ -0,0 +1,63 @@
+require File.join(File.dirname(__FILE__), "test_cli_helper.rb")
+require 'rbkb/cli/hexify'
+
+class TestCliHexify < Test::Unit::TestCase
+  include CliTest
+
+  def setup
+    @cli_class = Rbkb::Cli::Hexify
+    super()
+  end
+
+  def test_string_arg
+    assert_equal 0, go_with_args(%w(foo))
+    assert_equal("666f6f\n", @stdout_io.string)
+  end
+
+  def test_length_argument
+    assert_equal 0, go_with_args(%w(-l 1 foo))
+    assert_equal("66\n6f\n6f\n", @stdout_io.string)
+  end
+
+  def test_bad_length_arguments
+    assert_equal 1, go_with_args(%w(-l 0 foo))
+    assert_match(/must be greater than zero/, @stderr_io.string)
+    assert_equal 1, go_with_args(%w(-l -1 foo))
+    assert_match(/must be greater than zero/, @stderr_io.string)
+  end
+
+  def test_string_arg_with_plus
+    assert_equal 0, go_with_args(%w(+ foo))
+    assert_equal("66 6f 6f\n", @stdout_io.string)
+  end
+
+  def test_string_arg_with_delim
+    assert_equal 0, go_with_args(%w(-d : foo))
+    assert_equal("66:6f:6f\n", @stdout_io.string)
+  end
+
+  def test_string_arg_with_prefix
+    assert_equal 0, go_with_args(%w(-p : foo))
+    assert_equal(":66:6f:6f\n", @stdout_io.string)
+  end
+
+  def test_string_arg_with_suffix
+    assert_equal 0, go_with_args(%w(-s : foo))
+    assert_equal("66:6f:6f:\n", @stdout_io.string)
+  end
+
+  def test_stdin
+    @stdin_io.write("foo") ; @stdin_io.rewind
+    assert_equal 0, go_with_args
+    assert_equal("666f6f\n", @stdout_io.string)
+  end
+
+  def test_file_input
+    with_testfile do |fname, tf| 
+      tf.write "hex_test_foo";  tf.close
+      assert_equal 0, go_with_args(["-f", fname])
+      assert_equal("6865785f746573745f666f6f\n", @stdout_io.string)
+    end
+  end
+
+end

data/test/test_cli_len.rb

@@ -0,0 +1,96 @@
+require File.join(File.dirname(__FILE__), "test_cli_helper.rb")
+require 'rbkb/cli/len'
+
+class TestCliLen < Test::Unit::TestCase
+  include CliTest
+
+  def setup
+    @cli_class = Rbkb::Cli::Len
+    super()
+
+    @tst_in  = "helu world"
+    @bigtst_in = "A"*65536
+  end
+
+  def test_string_arg
+    assert_equal 0, go_with_args([@tst_in])
+    assert_equal("\x00\x00\x00\x0a" + @tst_in, @stdout_io.string)
+  end
+
+  def test_big_string_arg
+    assert_equal 0, go_with_args([@bigtst_in])
+    assert_equal("\x00\x01\x00\x00" + @bigtst_in, @stdout_io.string)
+  end
+
+  def test_stdin
+    @stdin_io.write(@tst_in) ; @stdin_io.rewind
+    assert_equal 0, go_with_args()
+    assert_equal("\x00\x00\x00\x0a" + @tst_in, @stdout_io.string)
+  end
+
+  def test_file_input_flag
+    with_testfile do |fname, tf| 
+      tf.write @tst_in;  tf.close
+      assert_equal 0, go_with_args(["-f", fname])
+      assert_equal("\x00\x00\x00\x0a" + @tst_in, @stdout_io.string)
+    end
+  end
+
+  def test_string_arg_swap
+    assert_equal 0, go_with_args(["-x", @tst_in])
+    assert_equal("\x0a\x00\x00\x00" + @tst_in, @stdout_io.string)
+  end
+
+
+  def test_big_string_arg_swap
+    assert_equal 0, go_with_args(["-x", @bigtst_in])
+    assert_equal("\x00\x00\x01\x00" + @bigtst_in, @stdout_io.string)
+  end
+
+  def test_big_string_arg_total
+    assert_equal 0, go_with_args(["-t", @bigtst_in])
+    assert_equal("\x00\x01\x00\x04" + @bigtst_in, @stdout_io.string)
+  end
+
+  def test_big_string_arg_static_len
+    assert_equal 0, go_with_args(["-l3", @bigtst_in])
+    assert_equal("\x00\x00\x00\x03" + @bigtst_in, @stdout_io.string)
+  end
+
+  def test_big_string_arg_static_len_negative
+    assert_equal 0, go_with_args(["-l", "-3", @bigtst_in])
+    assert_equal("\xff\xff\xff\xfd" + @bigtst_in, @stdout_io.string)
+  end
+
+  def test_big_string_arg_static_len_negative_short
+    assert_equal 0, go_with_args(["-l", "-3", "-s2", @bigtst_in])
+    assert_equal("\xff\xfd" + @bigtst_in, @stdout_io.string)
+  end
+
+  def test_big_string_arg_nudge
+    assert_equal 0, go_with_args(["-n5", @bigtst_in])
+    assert_equal("\x00\x01\x00\x05" + @bigtst_in, @stdout_io.string)
+  end
+
+  def test_big_string_arg_byte
+    assert_equal 0, go_with_args(["-s1", @tst_in])
+    assert_equal("\x0a" + @tst_in, @stdout_io.string)
+  end
+
+  def test_big_string_arg_byte_wrap
+    assert_equal 0, go_with_args(["-s1", @bigtst_in])
+    assert_equal("\x00" + @bigtst_in, @stdout_io.string)
+  end
+
+
+  def test_big_string_arg_short
+    assert_equal 0, go_with_args(["-s2", @tst_in])
+    assert_equal("\x00\x0a" + @tst_in, @stdout_io.string)
+  end
+
+  def test_big_string_arg_short_wrap
+    assert_equal 0, go_with_args(["-s2", @bigtst_in])
+    assert_equal("\x00\x00" + @bigtst_in, @stdout_io.string)
+  end
+
+end

data/test/test_cli_rstrings.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), "test_cli_helper.rb")
+
+# FIXME Finish test cases for rstrings cli
+
+class TestCliRstrings < Test::Unit::TestCase
+  include CliTest
+
+  def setup
+    @cli_class = Rbkb::Cli::Rstrings
+    super()
+
+    @test_dat = "a\000bc\001def\002gehi\003jklmn\004string 1\005string 2\020\370\f string 3\314string4\221string 5\n\000string 6\r\n\000\000\000\000string 7\000\000w\000i\000d\000e\000s\000t\000r\000i\000n\000g\000\000\000last string\000"
+  end
+
+end

data/test/test_cli_slice.rb

@@ -0,0 +1,73 @@
+require File.join(File.dirname(__FILE__), "test_cli_helper.rb")
+require 'rbkb/cli/slice'
+
+class TestCliSlice < Test::Unit::TestCase
+  include CliTest
+
+  def setup
+    @cli_class = Rbkb::Cli::Slice
+    super()
+    @rawdat = (0..255).map {|x| x.chr}.join
+    @stdin_io.write(@rawdat) ; @stdin_io.rewind
+  end
+
+  def test_stdin 
+    assert_equal 0, go_with_args(%w{0})
+    assert_equal @rawdat, @stdout_io.string
+  end
+
+  def test_start_from_end_negative_size
+    assert_equal 0, go_with_args(%w(-- -10))
+    assert_equal(@rawdat[-10..-1], @stdout_io.string)
+  end
+
+  def test_file_input_opt
+    with_testfile do |fname, tf| 
+      tf.write @rawdat;  tf.close
+      assert_equal 0, go_with_args(["-f", fname, "0"])
+      assert_equal(@rawdat, @stdout_io.string)
+    end
+  end
+
+  def test_bad_start
+    assert_equal 1, go_with_args(%w{foo})
+    assert_match(/invalid start length/i, @stderr_io.string)
+  end
+
+  def test_start_from_end_zero
+    assert_equal 0, go_with_args(%w(-r 256))
+    assert_equal("", @stdout_io.string)
+  end
+
+  def test_start_from_end_one
+    assert_equal 0, go_with_args(%w(-r 255))
+    assert_equal("\xff", @stdout_io.string)
+  end
+
+  def test_start_from_overflow
+    assert_equal 0, go_with_args(%w(-r 2000))
+    assert_equal("", @stdout_io.string)
+  end
+
+  def test_range_start_end
+    assert_equal 0, go_with_args(%w(-r 10:20))
+    assert_equal(@rawdat[10..20], @stdout_io.string)
+  end
+
+  def test_range_start_and_end
+    assert_equal 0, go_with_args(%w(-r 10:20))
+    assert_equal(@rawdat[10..20], @stdout_io.string)
+  end
+
+  def test_range_start_and_end_with_negative_end
+    assert_equal 0, go_with_args(%w(-r 0:-20))
+    assert_equal(@rawdat[0..-20], @stdout_io.string)
+  end
+
+
+  def test_range_start_and_end_hex
+    assert_equal 0, go_with_args(%w(-x 0a:14))
+    assert_equal(@rawdat[10..20], @stdout_io.string)
+  end
+
+end