bwkfanboy 1.4.1 → 2.0.0

data/test/helper_cliutils.rb

@@ -0,0 +1,34 @@
+# :erb: ruby-cli
+# Various staff for minitest. Include this file into your 'helper.rb'.
+
+require 'fileutils'
+include FileUtils
+
+require_relative '../lib/bwkfanboy/cliutils'
+include Bwkfanboy
+
+require 'minitest/autorun'
+
+# Return an absolute path of a _c_.
+def cmd(c)
+  case File.basename(Dir.pwd)
+  when Meta::NAME.downcase
+    # test probably is executed from the Rakefile
+    Dir.chdir('test')
+    $stderr.puts('*** chdir to ' + Dir.pwd)
+  when 'test'
+    # we are in the test directory, there is nothing special to do
+  else
+    # tests were invoked by 'gem check -t bwkfanboy'
+    # (for a classic rubygems 1.3.7)
+    begin
+      Dir.chdir(CliUtils::DIR_LIB_SRC.parent.parent + test)
+    rescue
+      raise "running tests from '#{Dir.pwd}' isn't supported: #{$!}"
+    end
+  end
+
+  File.absolute_path('../bin/' + c)
+end
+
+# Don't remove this: falsework/2.0.0/ruby-cli/2012-03-05T05:04:11+02:00

data/test/test_cli.rb

@@ -0,0 +1,86 @@
+require 'msgpack'
+require 'fakefs/safe'
+require 'digest/md5'
+
+require_relative '../lib/bwkfanboy/utils'
+require_relative 'helper'
+
+class TestCLI < MiniTest::Unit::TestCase
+  def setup
+    # this runs every time before test_*
+    @cmd = cmd('bwkfanboy') # get path to the exe & cd to tests directory
+    
+    @bwkfanboy_parse = File.dirname(@cmd) + '/bwkfanboy_parse'
+    @bwkfanboy_generate = File.dirname(@cmd) + '/bwkfanboy_generate'
+  end
+
+  def test_bwkfanboy_parse_fail
+    r = CliUtils.exec "echo '' | #{@bwkfanboy_parse}"
+    assert_equal EX_USAGE, r[0]
+    assert_match /bwkfanboy_parse \[options\] plugin/, r[1]
+
+    r = CliUtils.exec "echo '' | #{@bwkfanboy_parse} BUGUS-PLUGIN"
+    assert_equal EX_DATAERR, r[0]
+    assert_match /'BUGUS-PLUGIN' not found/, r[1]
+    
+    r = CliUtils.exec "echo '' | #{@bwkfanboy_parse} bwk"
+    assert_equal EX_DATAERR, r[0]
+    assert_match /it ain\'t grab anything/, r[1]
+  end
+
+  def test_bwkfanboy_parse
+    r = CliUtils.exec "#{@bwkfanboy_parse} bwk < example/02/plugins/bwk.html"
+    assert_equal EX_OK, r[0]
+
+    raw = MessagePack.unpack r[2]
+    assert raw
+    assert_equal raw['channel']['title'], "Brian Kernighan's articles from Daily Princetonian"
+    assert_operator 4, :<=, raw['x_entries'].size
+  end
+
+  def test_bwkfanboy_generate_fail
+    r = CliUtils.exec "echo '' | #{@bwkfanboy_generate}"
+    assert_equal EX_DATAERR, r[0]
+  end
+
+  def test_bwkfanboy_fail
+    r = CliUtils.exec "#{@cmd}"
+    assert_equal EX_USAGE, r[0]
+
+    r = CliUtils.exec "#{@cmd} BOGUS-PLUGIN"
+    assert_equal EX_DATAERR, r[0]
+    assert_match /not found/, r[1]
+
+    r = CliUtils.exec "#{@cmd} test"
+    assert_equal EX_DATAERR, r[0]
+    assert_match /forget about additional options/, r[1]
+  end
+
+  def test_bwkfanboy
+    r = CliUtils.exec "#{@cmd} test foo bar"
+    assert_equal EX_OK, r[0]
+  end
+
+  def test_skeleton
+    skel = File.read '../lib/bwkfanboy/plugin_skeleton.erb'
+    FakeFS do
+      File.open('skel.erb', 'w+') {|fp| fp.write skel }
+      
+      Utils.skeletonCreate 'skel.erb', '1'
+      m1 = Digest::MD5.file('1').hexdigest
+      Utils.skeletonCreate 'skel.erb', '1'
+      m2 = Digest::MD5.file('1').hexdigest
+      assert_equal m1, m2
+
+      File.open('1', 'w+') {|fp| fp.write 'fffffuuuu' }
+      m3 = Digest::MD5.file('1').hexdigest
+      out, err = capture_io { Utils.skeletonCreate 'skel.erb', '1' }
+      assert_match /1 already exists/, err
+      m4 = Digest::MD5.file('1').hexdigest
+      assert_equal m3, m4
+
+      refute_equal m1, m4      
+    end
+  end
+  
+end

data/test/test_fetch.rb

@@ -1,28 +1,59 @@
+require 'stringio'
+
 require_relative 'helper'
+require_relative '../lib/bwkfanboy/plugin'
+require_relative '../lib/bwkfanboy/fetch'
 
-# TODO add HTTP 404 check; drop connection from server during HTTP 200
-# replay...
 class TestFetch < MiniTest::Unit::TestCase
-  CMD = cmd('bwkfanboy_fetch')
+  
+  def setup
+    # this runs every time before test_*
+    @cmd = cmd('bwkfanboy') # get path to the exe & cd to tests directory
 
-  def test_empty_url
-    r = Utils.cmd_run("echo '' | #{CMD}")
-    assert_equal(1, r[0])
-    assert_match(/No such file or directory/, r[1])
+    ENV['BWKFANBOY_CONF'] = ''
+    @h = Home.new('example/02')
   end
 
-  def test_invalid_url
-    r = Utils.cmd_run("echo 'http://invalid.hostname.qwerty' | #{CMD}")
-    assert_equal(1, r[0])
-    assert_match(/504 Host .+ lookup failed: Host not found/, r[1])
+  def test_fetch
+    url1 = @h.root + Home::PLUGINS + 'bwk.html'
+    
+    streams = Fetch.openStreams [url1, url1]
+    assert_equal 2, streams.size
+    assert streams.sample.is_a?(File)
+
+    # stream in an array is readale
+    rs = streams.sample
+    assert_operator 500, :<, rs.read.size
+    rs.rewind
+
+    # open plugin with 1 stream only
+    p0 = Plugin.new @h.conf[:plugins_path], 'bwk', []
+    assert p0
+    p0.run_parser [streams.sample]
+
+    # open the same plugin with 2 streams
+    streams_other = Fetch.openStreams [url1, url1]
+    all = Plugin.new @h.conf[:plugins_path], 'bwk', []
+    assert all
+    all.run_parser streams_other
+
+    assert_operator p0.size, :<, all.size
+
+    Fetch.closeStreams streams
   end
 
-  def test_local_file
-    cmd CMD
-    r = Utils.cmd_run("echo semis/bwk.html | #{CMD}")
-    assert_equal(0, r[0])
-    # MD5 (html/bwk.html) = c8259a358dd7261a79b226985d3e8753
-    assert_equal(Digest::MD5.hexdigest(r[2]), '00cc906c59c0eb11c3eaa8166dab729f')
+  def test_fetch_fail
+    refute Fetch.openStreams(nil)
+
+    e = assert_raises(FetchException) { Fetch.openStreams [] }
+    assert_match /failed to open at least 1/, e.message
+    
+    e = assert_raises(FetchException) { Fetch.openStreams [nil] }
+    assert_match /can\'t convert nil into String/, e.message
+
+    e = assert_raises(FetchException) {
+      Fetch.openStreams ["/FILE/DOESN'T/EXIST"]
+    }
+    assert_match /No such file or directory/, e.message
   end
-  
 end

data/test/test_generate.rb

@@ -1,24 +1,51 @@
+require 'stringio'
+
 require_relative 'helper'
+require_relative '../lib/bwkfanboy/plugin'
+require_relative '../lib/bwkfanboy/generator'
 
 class TestGenerate < MiniTest::Unit::TestCase
-  CMD = cmd('bwkfanboy_generate')
-    
-  def test_empty_input
-    r = Utils.cmd_run("echo '' | #{CMD}")
-    assert_equal(1, r[0])
-    assert_match(/stdin had invalid JSON/, r[1])
+  def setup
+    # this runs every time before test_*
+    @cmd = cmd('bwkfanboy') # get path to the exe & cd to tests directory
+
+    ENV['BWKFANBOY_CONF'] = ''
+    @h = Home.new('example/02')
+  end
+
+  def test_atom
+    stream = [StringIO.new(File.read(@h.root + Home::PLUGINS + 'bwk.html'))]
+    p = Plugin.new @h.conf[:plugins_path], 'bwk', {}
+    p.run_parser stream
+
+    raw = StringIO.new ''
+    p.pack raw
+    raw.rewind
+
+    data = Generator.unpack raw
+#    pp data
+    r = Generator.atom data
+#    pp r
+    doc = Nokogiri::HTML r.to_s
+    assert_equal("Brian Kernighan's articles from Daily Princetonian",
+                 doc.xpath('//feed/title').text)
   end
-  
-  def test_invalid_json
-    r = Utils.cmd_run("echo '{\"foo\" : \"bar\"}' | #{CMD} --check")
-    assert_equal(1, r[0])
-    assert_match(/channel:? is missing and it is not optional/, r[1])
+
+  def test_atom_fail
+    e = assert_raises(GeneratorException) { Generator.atom nil }
+    assert_match /input is nil/, e.message
+
+    e = assert_raises(GeneratorException) { Generator.atom [1,2] }
+    assert_match /can\'t convert String into Integer/, e.message
   end
 
-  def test_right_json
-    r = Utils.cmd_run("#{CMD} --check < semis/bwk.json")
-    assert_equal(0, r[0])
-    # bin/bwkfanboy_generate < test/semis/bwk.json|md5
-    assert_equal('adc5a0d9487bdc11b6896fe29745ffa3', Digest::MD5.hexdigest(r[2]))
+  def test_unpack
+    refute Generator.unpack(nil)
+
+    raw = StringIO.new ''
+    refute Generator.unpack(raw)
+
+    raw = StringIO.new MessagePack.pack([1,2,3])
+    assert_equal [1,2,3], Generator.unpack(raw)
   end
 end

data/test/test_home.rb

@@ -0,0 +1,33 @@
+require_relative 'helper'
+
+require_relative '../lib/bwkfanboy/home'
+
+class TestHome < MiniTest::Unit::TestCase
+  def setup
+    # this runs every time before test_*
+    @cmd = cmd('bwkfanboy') # get path to the exe & cd to tests directory
+
+    rm_rf 'example/01'
+    ENV['BWKFANBOY_CONF'] = ''
+  end
+
+  def test_home_dirs
+    h = Home.new 'example/01'
+    assert_equal 'example/01/log', h.logs.to_s
+    assert_equal 'example/01/plugins', h.conf[:plugins_path].first.to_s
+    assert_equal 2, h.conf[:plugins_path].size
+    assert File.readable?(h.root)
+    assert File.readable?(h.conf[:plugins_path].first.to_s)
+    assert File.readable?(h.logs)
+  end
+  
+  def test_home_opts
+    ENV['BWKFANBOY_CONF'] = '-I /tmp -I /bin -I /INVALID-DIR --zzz "later on"'
+    h = Home.new('example/01') {|loader, o|
+      o.on('--zzz ARG', 'zzz') {|i| loader.conf[:zzz] = i }
+    }
+    assert_equal(['example/01/plugins', Home::SYSTEM_PLUGINS.to_s, '/tmp', '/bin'],
+                 h.conf[:plugins_path].map(&:to_s) )
+    assert_equal 'later on', h.conf[:zzz]
+  end
+end

data/test/test_plugin.rb

@@ -0,0 +1,141 @@
+require 'stringio'
+
+require_relative 'helper'
+require_relative '../lib/bwkfanboy/home'
+require_relative '../lib/bwkfanboy/plugin'
+
+class TestPlugin < MiniTest::Unit::TestCase
+  def setup
+    # this runs every time before test_*
+    @cmd = cmd('bwkfanboy') # get path to the exe & cd to tests directory
+
+    ENV['BWKFANBOY_CONF'] = ''
+    @h = Home.new('example/02')
+  end
+
+  def test_allset
+    assert_equal false, BH.all_set?([])
+    assert_equal false, BH.all_set?(nil)
+    assert_equal false, BH.all_set?('')
+    assert_equal false, BH.all_set?('    ')
+    assert_equal false, BH.all_set?([1,2, ''])
+    assert_equal false, BH.all_set?([1,2, nil])
+    assert_equal true, BH.all_set?(1)
+    assert_equal true, BH.all_set?('1')
+  end
+
+  def test_entryMostRecent
+    stream = [StringIO.new(File.read(@h.root + Home::PLUGINS + 'bwk.html'))]
+    p = Plugin.new @h.conf[:plugins_path], 'bwk', []
+    p.run_parser stream
+
+#    p.each {|i| puts i[:updated]}
+    assert_equal '2012-03-12T00:00:00+00:00', p.entryMostRecent
+
+    p[rand(0..3)]['updated'] = '2042-03-12T00:00:00+00:00'
+    assert_equal '2042-03-12T00:00:00+00:00', p.entryMostRecent
+  end
+  
+  def test_load_ok
+    stream = [StringIO.new(File.read(@h.root + Home::PLUGINS + 'bwk.html'))]
+    p1 = Plugin.new @h.conf[:plugins_path], 'bwk', []
+    assert(p1)
+    p1.run_parser stream
+
+    assert_match /^http:\/\/\S+/, p1[2]['link']
+    assert DateTime.parse(p1[2]['updated'])
+    
+    ['title', 'author', 'content'].each {|i|
+      assert_operator 0, :<, p1[2][i].size
+    }
+    
+    assert_operator 4, :<=, p1.size
+  end
+
+  def test_load_failed
+    e = assert_raises(PluginException) { Plugin.new nil, 'foo', [] }
+    assert_match /invalid search path/, e.message
+
+    e = assert_raises(PluginInvalidName) { Plugin.new nil, 'BOGUS PLUGIN', [] }
+    assert_match /name doesn\'t match/, e.message
+    
+    e = assert_raises(PluginNotFound) {
+      Plugin.new @h.conf[:plugins_path], 'BOGUS-PLUGIN', []
+    }
+    assert_match /not found/, e.message
+
+    e = assert_raises(PluginException) {
+      p = Plugin.new @h.conf[:plugins_path], 'bwk', []
+      p.run_parser nil
+    }
+    assert_match /parser expects a valid array of IO objects/, e.message
+
+    stream = [StringIO.new("")]
+    p = Plugin.new @h.conf[:plugins_path], 'bwk', []
+    assert(p)
+    e = assert_raises(PluginException) { p.run_parser stream }
+    assert_match /it ain\'t grab anything/, e.message
+
+    stream = [StringIO.new("fffffuuuuuuu")]
+    p = Plugin.new @h.conf[:plugins_path], 'bwk', []
+    assert(p)
+    e = assert_raises(PluginException) { p.run_parser stream }
+    assert_match /it ain\'t grab anything/, e.message
+  end
+
+  def test_broken_plugins
+    streams = [StringIO.new(File.read(@h.root + Home::PLUGINS + 'bwk.html'))]
+    e = assert_raises(PluginNoOptions) {
+      Plugin.new @h.conf[:plugins_path], 'empty', []
+    }
+    assert_match /forget about additional options/, e.message
+
+    e = assert_raises(PluginException) {
+      Plugin.new @h.conf[:plugins_path], 'empty', [1,2,3]
+    }
+    assert_match /uri must be an array of strings/, e.message
+    
+    e = assert_raises(PluginException) {
+      p = Plugin.new @h.conf[:plugins_path], 'garbage', []
+    }
+    assert_match /failed to parse/, e.message
+  end
+
+  def test_plugin_with_opt
+    streams = [StringIO.new(File.read(@h.root + Home::PLUGINS + 'inc.html')),
+               StringIO.new(File.read(@h.root + Home::PLUGINS + 'inc.html'))]
+    
+    e = assert_raises(PluginNoOptions) {
+      Plugin.new @h.conf[:plugins_path], 'inc', []
+    }
+    assert_match /forget about additional options/, e.message
+
+    rs = streams.sample
+    p1 = Plugin.new @h.conf[:plugins_path], 'inc', [1]
+    p1.run_parser [rs]
+    rs.rewind
+    
+    p2 = Plugin.new @h.conf[:plugins_path], 'inc', [1,2]
+    p2.run_parser streams
+
+    assert_operator p1.size, :<, p2.size
+  end
+
+  def test_PluginInfo_about
+    e = assert_raises(PluginException) { PluginInfo.about nil, 'foo', nil }
+    assert_match /invalid search path/, e.message
+
+    e = assert_raises(PluginNotFound) {
+      PluginInfo.about @h.conf[:plugins_path], 'BOGUS-PLUGIN', nil
+    }
+    assert_match /not found/, e.message
+
+    out, err = capture_io {
+      PluginInfo.about @h.conf[:plugins_path], 'bwk', nil
+    }
+    out.split("\n")[0..3].each {|i|
+      assert_match /^[A-Z]+ *: .+/, i
+    }
+    
+  end
+end

data/test/test_server.rb

@@ -1,44 +1,33 @@
-require 'open-uri'
+require 'rack/test'
 
 require_relative 'helper'
+require_relative '../lib/bwkfanboy/server'
 
-$count = 1
-
-# this tests will mess up logs and the pid file
 class TestServer < MiniTest::Unit::TestCase
-  CMD = cmd('bwkfanboy_server')
-  PORT = 9042
-  ADDR = '127.0.0.1'
+  include Rack::Test::Methods
 
-  def setup
-    @port = PORT + $count
-    @pid = spawn("#{CMD} -D -p #{@port}")
-    $count += 1
-    sleep(2) # wait for the server's loading
+  def app
+    MyApp
   end
+  
+  def setup
+    # this runs every time before test_*
+    @cmd = cmd('bwkfanboy') # get path to the exe & cd to tests directory
 
-  def teardown
-    Process.kill("TERM", @pid)
+    ENV['BWKFANBOY_CONF'] = ''
   end
-  
-  def test_no_plugin
-    assert_raises(OpenURI::HTTPError) { open("http://#{ADDR}:#{@port}") }
-    assert_raises(OpenURI::HTTPError) { open("http://#{ADDR}:#{@port}/?p=INVALID") }
-    # 'o' is missing
-    assert_raises(OpenURI::HTTPError) { open("http://#{ADDR}:#{@port}/?p=inc") }
+
+  def test_list
+    get '/'
+    assert last_response.ok?
+    assert_match /Plugins List/, last_response.body
   end
 
-  def test_right_plugins
-    plugins = {
-      'bwk' => '64186fac2c52e5a969ad5675b9cc95ed',
-      'econlib' => '11f6114a9ab54d6ec67a26cbd76f5260',
-      'inc' => '13dae248c81dd6407ff327dd5575f8b5',
-    }
-    plugins.each {|k,v|
-      r = ''
-      open("http://#{ADDR}:#{@port}/?p=#{k}&o=foo") { |f| r = f.read }
-      # wget -q -O - '127.0.0.1:9042/?p=inc&o=foo' | md5
-      assert_equal(v, Digest::MD5.hexdigest(r))
-    }
+  def test_plugin_test
+    get '/test?o=foo&o=bar'
+    assert last_response.ok?
+    assert_operator 100, :<, last_response.header['Content-Length'].to_i
+    assert_equal 'application/atom+xml; charset=UTF-8', last_response.header['Content-Type']
   end
+
 end