pantry 0.0.0 → 0.1.0

data/test/unit/logger_test.rb

@@ -0,0 +1,79 @@
+require 'unit/test_helper'
+
+describe Pantry::Logger do
+
+  let(:mock_logger) {
+    logger = stub
+    logger.stubs(:level=)
+    logger
+  }
+
+  after do
+    # Unset global state caused by these tests
+    Celluloid.logger = nil
+  end
+
+  it "is accessible through top level Pantry.logger" do
+    logger = Pantry.logger = Pantry::Logger.new
+    assert_equal logger, Pantry.logger
+  end
+
+  it "sets the celluloid logger" do
+    logger = Pantry::Logger.new
+
+    assert Celluloid.logger.is_a?(::Logger), "Celluloid logger not set properly"
+  end
+
+  it "sets celluloid logger to a path if one given" do
+    config = Pantry::Config.new
+    config.log_to = File.expand_path("../../test.log", __FILE__)
+
+    logger = Pantry::Logger.new(config)
+
+    assert Celluloid.logger.is_a?(::Logger), "Celluloid logger not set properly"
+  end
+
+  it "sets the logger to go to Syslog if so configured" do
+    config = Pantry::Config.new
+    config.log_to = "syslog"
+
+    Syslog::Logger.expects(:new).with("pantry").returns(mock_logger)
+
+    logger = Pantry::Logger.new(config)
+  end
+
+  it "configures the Syslog program name if one given in the config" do
+    config = Pantry::Config.new
+    config.log_to = "syslog"
+    config.syslog_program_name = "pantry-client"
+
+    Syslog::Logger.expects(:new).with("pantry-client").returns(mock_logger)
+
+    logger = Pantry::Logger.new(config)
+  end
+
+  it "sets the log's level according to config.log_level" do
+    Pantry.config.log_level = :info
+    logger = Pantry::Logger.new
+
+    assert_equal ::Logger::INFO, Celluloid.logger.level
+  end
+
+  it "allows symbols when setting log level" do
+    config = Pantry::Config.new
+    config.log_level = :warn
+
+    logger = Pantry::Logger.new(config)
+
+    assert_equal ::Logger::WARN, Celluloid.logger.level
+  end
+
+  it "forwards unknown messages to the celluloid logger" do
+    logger = Pantry::Logger.new
+
+    Celluloid.logger.expects(:info).with("Message!")
+
+    logger.info("Message!")
+  end
+
+end

data/test/unit/message_test.rb

@@ -0,0 +1,179 @@
+require 'unit/test_helper'
+
+describe Pantry::Message do
+
+  it "takes a message type in constructor" do
+    message = Pantry::Message.new("message_type")
+    assert_equal "message_type", message.type
+  end
+
+  it "generates a UUID on construction" do
+    message = Pantry::Message.new("message_type")
+    assert_not_nil message.uuid
+    assert message.uuid.length > 10
+  end
+
+  it "knows who the message is meant for" do
+    message = Pantry::Message.new("")
+    message.to = "stream"
+    assert_equal "stream", message.to
+  end
+
+  it "defaults the #to value to all (the empty string)" do
+    message = Pantry::Message.new("")
+    assert_equal "", message.to
+  end
+
+  it "can be given strings for the body parts" do
+    message = Pantry::Message.new("type")
+    message << "Part 1"
+    message << "Part 2"
+
+    assert_equal ["Part 1", "Part 2"], message.body
+  end
+
+  it "can be given the identity of the sending party" do
+    message = Pantry::Message.new("type")
+    message.from = "server1"
+
+    assert_equal "server1", message.from
+  end
+
+  it "can pull the identity string from an object that responds to identity" do
+    message = Pantry::Message.new("type")
+    client = Pantry::Client.new identity: "johnsonville"
+    message.from = client
+
+    assert_equal "johnsonville", message.from
+  end
+
+  it "can be flagged to require a response" do
+    message = Pantry::Message.new("type")
+    message.requires_response!
+
+    assert message.requires_response?
+  end
+
+  it "can build a response version of itself" do
+    message = Pantry::Message.new("type")
+    message << "Body part 1"
+    message << "Body part 2"
+    message.to = "server"
+    message.from = "client"
+    message.forwarded!
+    message.requires_response!
+
+    response = message.build_response
+
+    assert_equal "type", response.type
+    assert_equal [], response.body
+    assert_false response.requires_response?, "Message shouldn't require a response"
+    assert_equal "client", response.to
+    assert_equal "server", response.from
+    assert response.forwarded?
+
+    assert_equal message.uuid, response.uuid
+  end
+
+  it "clones custom metadata in a response message" do
+    message = Pantry::Message.new("type")
+    message[:custom_data] = "one"
+
+    response = message.build_response
+
+    assert_equal "one", response[:custom_data]
+
+    response[:custom_data] = "two"
+    assert_equal "one", message[:custom_data]
+    assert_equal "two", response[:custom_data]
+  end
+
+  it "can be flagged as being forwarded" do
+    message = Pantry::Message.new("type")
+    assert_false message.forwarded?
+
+    message.forwarded!
+    assert message.forwarded?
+  end
+
+  it "has a hash of metadata" do
+    message = Pantry::Message.new
+    message.type = "read_stuff"
+    message.requires_response!
+    message.forwarded!
+    message.from = "99 Luftballoons"
+    message.to = "streamer"
+
+    assert_not_nil message.metadata[:uuid]
+    assert_equal "read_stuff", message.metadata[:type]
+    assert_equal "99 Luftballoons", message.metadata[:from]
+    assert_equal "streamer", message.metadata[:to]
+    assert message.metadata[:requires_response]
+    assert message.metadata[:forwarded]
+  end
+
+  it "ensures the #to field is always a string when writing metadata" do
+    message = Pantry::Message.new
+    assert_equal "", message.metadata[:to]
+  end
+
+  it "knows if it came from the server or a client" do
+    message = Pantry::Message.new
+    message.from = Pantry::SERVER_IDENTITY
+
+    assert message.from_server?
+  end
+
+  it "takes a hash of metadata and parses out approriate values" do
+    message = Pantry::Message.new
+    message.metadata = {
+      type: "read_stuff",
+      requires_response: true,
+      forwarded: true,
+      from: "99 Luftballoons",
+      to: "streamer",
+      uuid: "123-4567-890-1234"
+    }
+
+    assert_equal "123-4567-890-1234", message.uuid
+    assert_equal "read_stuff", message.type
+    assert_equal "99 Luftballoons", message.from
+    assert_equal "streamer", message.to
+    assert       message.requires_response?
+    assert       message.forwarded?
+  end
+
+  it "ensures the #to field is always a string when reading metadata" do
+    message = Pantry::Message.new
+    message.metadata = {
+      to: nil,
+    }
+    assert_equal "", message.to
+  end
+
+  it "allows custom metadata entries" do
+    message = Pantry::Message.new
+    message[:metadata_1] = "my metadata"
+    message[:some_name] = "johnson"
+
+    assert_equal "my metadata", message[:metadata_1]
+    assert_equal "johnson", message[:some_name]
+
+    assert_equal "my metadata", message.metadata[:custom][:metadata_1]
+    assert_equal "johnson", message.metadata[:custom][:some_name]
+  end
+
+  it "loads unknown metadata keys into the custom metadata" do
+    message = Pantry::Message.new
+    message.metadata = {
+      custom: {
+        metadata_1: "my metadata",
+        some_name:  "johnson"
+      }
+    }
+
+    assert_equal "my metadata", message[:metadata_1]
+    assert_equal "johnson", message[:some_name]
+  end
+
+end

data/test/unit/multi_command_test.rb

@@ -0,0 +1,45 @@
+require 'unit/test_helper'
+
+describe Pantry::MultiCommand do
+
+  class TestPart1 < Pantry::Command
+    def perform(message)
+      [1, client.identity, message.type]
+    end
+  end
+
+  class TestPart2 < Pantry::Command
+    def perform(message)
+      [2, client.identity, message.type]
+    end
+  end
+
+  class TestPart3 < Pantry::Command
+    def perform(message)
+      [3, client.identity, message.type]
+    end
+  end
+
+  class TestMultiCommand < Pantry::MultiCommand
+    performs [
+      TestPart1,
+      TestPart2,
+      TestPart3
+    ]
+  end
+
+  it "runs multiple commands in order, combining return values" do
+    client = Pantry::Client.new identity: "Client"
+    command = TestMultiCommand.new
+    command.client = client
+
+    results = command.perform(Pantry::Message.new("Message"))
+
+    assert_equal [
+      [1, "Client", "Message"],
+      [2, "Client", "Message"],
+      [3, "Client", "Message"],
+    ], results
+  end
+
+end

data/test/unit/opt_parse_plus_test.rb

@@ -0,0 +1,218 @@
+require 'unit/test_helper'
+
+describe OptParsePlus do
+
+  it "adds block and option support to optparse" do
+    parser = OptParsePlus.new
+    parser.add_options do
+      option "-a", "--application APPLICATION", String, "An option"
+    end
+
+    command_line = %w(-a application_name)
+    options      = parser.parse!(command_line)
+
+    assert_equal "application_name", options['application']
+    assert_equal "application_name", options[:application]
+    assert_equal [], command_line
+  end
+
+  it "adds command support to optparse" do
+    parser = OptParsePlus.new
+    parser.add_command("one") do
+      option "-a", "--application APPLICATION", String, "An option"
+    end
+
+    command_line = %w(one -a application_name)
+    options      = parser.parse!(command_line)
+
+    assert_equal "application_name", options['one']['application']
+    assert_equal "application_name", options[:one][:application]
+    assert_equal [], command_line
+  end
+
+  it "allows setting an explicit banner" do
+    parser = OptParsePlus.new
+    parser.banner "pantry [command]"
+
+    help_text = parser.help
+    assert_match /pantry \[command\]/, help_text
+  end
+
+  it "allows specifying a description" do
+    parser = OptParsePlus.new
+    parser.add_options do
+      description "This is interesting yes!"
+    end
+
+    help_text = parser.help
+    assert_match /This is interesting/, help_text
+  end
+
+  it "works with commands with no block" do
+    parser = OptParsePlus.new
+    parser.add_command("run")
+
+    options = parser.parse!(%w(run))
+    assert_equal "run", options.command_found
+  end
+
+  it "allows specifying argument usage in the command name" do
+    parser = OptParsePlus.new
+    parser.add_command("run COMMAND")
+
+    command_line = %w(run Something)
+    options = parser.parse!(command_line)
+
+    assert_equal "run", options.command_found
+    assert_equal %w(Something), command_line
+  end
+
+  it "gives the command options the arguments as per the description string (???)"
+
+  it "processes arguments in order to support global and command options" do
+    parser = OptParsePlus.new
+    parser.add_options do
+      option "-L", "--log-level LEVEL"
+    end
+
+    parser.add_command("run") do
+      option "-c", "--command COMMAND"
+    end
+
+    command_line = %w(-L debug run --command DoThisNow)
+    options      = parser.parse!(command_line)
+
+    assert_equal "run", options.command_found
+    assert_equal "debug", options['log-level']
+    assert_equal "DoThisNow", options['run']['command']
+  end
+
+  it "groups commands together, sorting subcommands alphabetically" do
+    parser = OptParsePlus.new
+    parser.add_command("run") do
+      group "Exercise"
+    end
+
+    parser.add_command("bike") do
+      group "Exercise"
+    end
+
+    parser.add_command("sleep") do
+      group "Lazy"
+    end
+
+    output, err = capture_io do
+      parser.parse!(%w(--help))
+    end
+
+    # Group subheadings
+    assert_match /Exercise commands/, output
+    assert_match /Lazy commands/, output
+
+    # Check alphabetical sort
+    assert_match /bike.*run/m, output
+  end
+
+  it "adds a global help option" do
+    parser = OptParsePlus.new
+
+    options = nil
+    output, err = capture_io do
+      options = parser.parse!(%w(-h))
+    end
+
+    assert_match /Show this help message/, output
+    assert options['help'], "Help flag was not set"
+  end
+
+  it "adds help option to each command configured" do
+    parser = OptParsePlus.new
+    parser.add_command("run")
+
+    options = nil
+    output, err = capture_io do
+      options = parser.parse!(%w(run --help))
+    end
+
+    assert_match /Show this help message/, output
+    assert options['help']
+  end
+
+  it "allows explicitly getting the help text" do
+    parser = OptParsePlus.new
+    help_text = parser.help
+
+    assert_match /Show this help message/, help_text
+  end
+
+  it "includes all known commands in the top-level help text" do
+    parser = OptParsePlus.new
+    parser.add_command("run") do
+      description "Run something"
+    end
+
+    parser.add_command("stop") do
+      description "Stop something from running"
+    end
+
+    parser.add_command("stock ITEM") do
+      description "Stock the item"
+    end
+
+    help_text = parser.help
+
+    assert_match /run\s+Run something/, help_text
+    assert_match /stop\s+Stop something/, help_text
+    assert_match /stock\s+Stock the item/, help_text
+  end
+
+  it "only shows the first line of a command's description in top-level help" do
+    parser = OptParsePlus.new
+    parser.add_command("run") do
+      description "Run something.
+        Run fast.
+        Don't run slow"
+    end
+
+    help_text = parser.help
+
+    assert_match /Run something/, help_text
+    assert_no_match /Run fast/, help_text
+    assert_no_match /Don't run slow/, help_text
+  end
+
+  it "includes sub-command descriptions and banner strings in help text" do
+    parser = OptParsePlus.new
+    parser.add_command("display MESSAGE") do
+      description "Show the given message"
+      option "-c", "--cap", "Capitalize the message"
+    end
+
+    help_text, error = capture_io do
+      parser.parse!(["display", "--help"])
+    end
+
+    assert_match /display \[options\] MESSAGE/, help_text
+    assert_match /-c, --cap/, help_text
+    assert_match /Capitalize the message/, help_text
+    assert_match /Show the given message/, help_text
+  end
+
+  it "cleans up extra white space in full command descriptions" do
+    parser = OptParsePlus.new
+    parser.add_command("display MESSAGE") do
+      description "Show the given message.
+        Requires a MESSAGE to be passed in.
+        and will Error out otherwise"
+    end
+
+    help_text, error = capture_io do
+      parser.parse!(["display", "--help"])
+    end
+
+    assert_match /^Show the given message/, help_text
+    assert_match /^Requires a MESSAGE/, help_text
+    assert_match /^and will Error/, help_text
+  end
+
+end