pantry 0.0.0 → 0.1.0

data/test/acceptance/communication/server_requests_info_from_client_test.rb

@@ -0,0 +1,41 @@
+require 'acceptance/test_helper'
+
+describe "Server requests info from the Client" do
+
+  it "asks a client for info and waits for the response" do
+    set_up_environment(ports_start_at: 10600)
+
+    message = Pantry::Commands::Echo.new("Hello Client").to_message
+    response_future = @server.send_request(@client1, message)
+
+    assert_equal ["Hello Client"], response_future.value(1).body
+  end
+
+  it "asks multiple clients for info and matches responses with requests" do
+    set_up_environment(ports_start_at: 10610)
+
+    message1 = Pantry::Commands::Echo.new("Hello Client1").to_message
+    message2 = Pantry::Commands::Echo.new("Hello Client2").to_message
+
+    future1 = @server.send_request(@client1, message1)
+    future2 = @server.send_request(@client2, message2)
+
+    assert_equal ["Hello Client1"], future1.value(1).body
+    assert_equal ["Hello Client2"], future2.value(1).body
+  end
+
+  it "handles multiple subsequent requests of the same type to the same client" do
+    set_up_environment(ports_start_at: 10620)
+
+    futures = []
+    10.times do |i|
+      message = Pantry::Commands::Echo.new("Hello Client #{i}").to_message
+      futures << @server.send_request(@client1, message)
+    end
+
+    10.times do |i|
+      assert_equal ["Hello Client #{i}"], futures[i].value(5).body
+    end
+  end
+
+end

data/test/acceptance/test_helper.rb

@@ -0,0 +1,25 @@
+require 'pantry/test/acceptance'
+
+# Swap these lines to turn on the logger in tests
+Pantry.logger.disable!
+#Pantry.config.log_level = :debug
+
+class Minitest::Test
+
+  def setup
+    Pantry.config.root_dir = File.expand_path("../../root_dir", __FILE__)
+    clean_up_pantry_root
+  end
+
+  # Ensure Pantry.root is always clean for each test.
+  def clean_up_pantry_root
+    Dir["#{Pantry.root}/**/*"].each do |file|
+      FileUtils.rm_rf file
+    end
+  end
+
+  def fixture_path(file_path)
+    File.join(File.dirname(__FILE__), "..", "fixtures", file_path)
+  end
+
+end

data/test/fixtures/config.yml

@@ -0,0 +1,22 @@
+---
+log_to: /var/log/pantry.log
+log_level: warn
+syslog_program_name: testing
+root_dir: /tmp/data
+
+networking:
+  server_host: 10.0.0.1
+  pub_sub_port: 12345
+  receive_port: 54321
+  file_service_port: 35412
+  security: curve
+
+client:
+  heartbeat_interval: 600
+  identity: "pantry-test-1"
+  application: "pantry"
+  environment: "test"
+  roles:
+    - database
+    - application
+

data/test/fixtures/empty.yml

@@ -0,0 +1,2 @@
+---
+nothing: here

data/test/fixtures/file_to_upload

@@ -0,0 +1,3 @@
+Hello
+Pantry
+!

data/test/unit/cli_test.rb

@@ -0,0 +1,173 @@
+require 'unit/test_helper'
+
+describe Pantry::CLI do
+
+  let(:filter) { Pantry::Communication::ClientFilter.new }
+
+  mock_ui!
+
+  def build_cli(command)
+    Pantry::CLI.new([command].flatten)
+  end
+
+  it "defaults identity to the current ENV['USER']" do
+    assert_equal ENV["USER"], build_cli("echo").identity
+  end
+
+  it "builds a message from a command request and sends it to the server" do
+    cli = build_cli("status")
+    Pantry::Command.any_instance.stubs(:wait_for_finish)
+
+    cli.expects(:send_message).with do |message|
+      assert_equal "Status", message.type
+    end
+
+    cli.run
+  end
+
+  it "passes along arguments to the command handler" do
+    cli = build_cli(["echo", "Hello World"])
+    Pantry::Command.any_instance.stubs(:wait_for_finish)
+
+    cli.expects(:send_message).with do |message|
+      assert message.requires_response?, "Message not flagged to require response"
+      assert_equal "Echo", message.type
+      assert_equal "Hello World", message.body[0]
+    end
+
+    cli.run
+  end
+
+  it "includes global options when passing options to a command handler" do
+    cli = build_cli(["-a", "pantry", "-e", "test", "echo", "Hello World"])
+    Pantry::Command.any_instance.stubs(:wait_for_finish)
+
+    Pantry::Commands::Echo.any_instance.expects(:prepare_message).with do |options|
+      assert_equal "pantry", options["application"]
+      assert_equal "test", options["environment"]
+    end.returns(stub_everything)
+
+    cli.stubs(:send_message)
+
+    cli.run
+  end
+
+  it "sets the logging level to info on -v" do
+    Pantry.config.expects(:refresh)
+
+    capture_io do
+      cli = build_cli(["-v"])
+      cli.run
+    end
+
+    assert_equal :info, Pantry.config.log_level
+  end
+
+  it "sets logging level to debug on -d" do
+    Pantry.config.expects(:refresh)
+
+    capture_io do
+      cli = build_cli(["-d"])
+      cli.run
+    end
+
+    assert_equal :debug, Pantry.config.log_level
+  end
+
+  it "sets the hostname of the server to communicate with" do
+    capture_io do
+      cli = build_cli(["-h", "localhost"])
+      cli.run
+    end
+
+    assert_equal "localhost", Pantry.config.server_host
+  end
+
+  it "prints out the version of pantry when requested" do
+    cli = build_cli(["-V"])
+    cli.run
+
+    assert_equal Pantry::VERSION, stdout.strip
+  end
+
+  it "prints the help if nothing given on the command line" do
+    out, err = capture_io do
+      cli = build_cli([])
+      cli.run
+    end
+
+    assert_match /Usage:/, out
+  end
+
+  it "can be given a set of filters to limit the request to a certain subset of clients" do
+    cli = build_cli(["-a", "pantry", "-e", "test", "echo", "Hello World"])
+    Pantry::Command.any_instance.stubs(:wait_for_finish)
+
+    cli.expects(:send_message).with do |message|
+      assert_equal "Echo", message.type
+      assert_equal "pantry.test", message.to
+    end
+
+    cli.run
+  end
+
+  it "reads a local config file and sets default options" do
+    File.open(Pantry.root.join("config"), "w+") do |f|
+      f.puts("-a pantry")
+      f.puts("--environment test")
+      f.puts("-r app")
+    end
+
+    cli = build_cli(["echo", "Hello World"])
+    Pantry::Command.any_instance.stubs(:wait_for_finish)
+
+    cli.expects(:send_message).with do |message|
+      assert_equal "Echo", message.type
+      assert_equal "pantry.test.app", message.to
+    end
+
+    cli.run
+  end
+
+  it "turns on Curve and sets keys if --curve-key-file is set" do
+    break unless Pantry::Communication::Security.curve_supported?
+    Pantry::Command.any_instance.stubs(:wait_for_finish)
+
+    File.open(Pantry.root.join("keys.yml"), "w+") do |f|
+      f.write(YAML.dump(
+        "server_public_key" => "x" * 40,
+        "public_key" => "y" * 40,
+        "private_key" => "z" * 40
+      ))
+    end
+
+    capture_io do
+      cli = build_cli(["--curve-key-file", "keys.yml"])
+      cli.run
+    end
+
+    assert_equal "curve", Pantry.config.security
+
+    assert FileUtils.compare_file(
+      Pantry.root.join("keys.yml"),
+      Pantry.root.join("security", "curve", "client_keys.yml")
+    ), "Did not copy the keys file into a client-ready position"
+  end
+
+  it "errors if the curve-key-file is not found"
+
+  it "forwards messages received to the current command" do
+    cli = build_cli("status")
+    cli.stubs(:send_message)
+
+    command = Pantry::Command.new
+    cli.async.request(filter, command, {})
+
+    message = Pantry::Message.new
+    message.from = Pantry::SERVER_IDENTITY
+
+    cli.receive_message(message)
+    assert command.finished?, "Command was not marked as finished"
+  end
+
+end

data/test/unit/client_registry_test.rb

@@ -0,0 +1,61 @@
+require 'unit/test_helper'
+
+describe Pantry::ClientRegistry do
+
+  before do
+    @c1 = Pantry::ClientInfo.new identity: "client1", application: "pantry", environment: "test"
+    @c2 = Pantry::ClientInfo.new identity: "client2", environment: "test"
+
+    @registry = Pantry::ClientRegistry.new
+    @registry.check_in(@c1)
+    @registry.check_in(@c2)
+  end
+
+  it "marks a client as checked in" do
+    assert @registry.include?(@c1)
+    assert @registry.include?(@c2)
+  end
+
+  it "does not duplicate clients in the list from multiple check-ins" do
+    @registry.check_in(@c1)
+    @registry.check_in(@c1)
+    @registry.check_in(@c1)
+
+    assert_equal [@c1, @c2], @registry.all
+  end
+
+  it "returns all known clients that match the given stream" do
+    assert_equal [@c1, @c2], @registry.all_matching("")
+    assert_equal [@c1], @registry.all_matching("pantry.test")
+    assert_equal [@c1], @registry.all_matching("client1")
+    assert_equal [@c2], @registry.all_matching("client2")
+  end
+
+  it "returns all known clients that match a given ClientFilter" do
+    assert_equal [@c1, @c2], @registry.all_matching(Pantry::Communication::ClientFilter.new)
+
+    filter = Pantry::Communication::ClientFilter.new(application: "pantry", environment: "test")
+    assert_equal [@c1], @registry.all_matching(filter)
+
+    filter = Pantry::Communication::ClientFilter.new(environment: "test")
+    assert_equal [@c2], @registry.all_matching(filter)
+  end
+
+  it "processes each found client via the block if given" do
+    found = @registry.all_matching(Pantry::Communication::ClientFilter.new) do |client, record|
+      client.identity
+    end
+
+    assert_equal [@c1.identity, @c2.identity], found
+  end
+
+  it "can return all known clients" do
+    assert_equal [@c1, @c2], @registry.all
+  end
+
+  it "returns the client who matches the given identity" do
+    assert_equal @c1, @registry.find("client1")
+    assert_nil @registry.find("unknown")
+  end
+
+end

data/test/unit/client_test.rb

@@ -0,0 +1,128 @@
+require 'unit/test_helper'
+
+describe Pantry::Client do
+
+  class FakeNetworkStack
+    def initialize(listener)
+    end
+
+    def self.new_link(listener)
+      new(listener)
+    end
+  end
+
+  before do
+    FakeNetworkStack.any_instance.stubs(:send_message)
+  end
+
+  it "can take a list of roles this Client manages" do
+    client = Pantry::Client.new roles: %w(app db)
+    assert_equal %w(app db), client.roles
+  end
+
+  it "can take an application to manage" do
+    client = Pantry::Client.new application: "pantry"
+    assert_equal "pantry", client.application
+  end
+
+  it "can take an environment to manage" do
+    client = Pantry::Client.new environment: "production"
+    assert_equal "production", client.environment
+  end
+
+  it "packages up all filter information into a Filter object" do
+    client = Pantry::Client.new environment: "production", application: "pantry"
+
+    filter = Pantry::Communication::ClientFilter.new(
+      environment: "production", application: "pantry", identity: client.identity)
+
+    assert_equal filter, client.filter
+    assert_equal "production", client.environment
+  end
+
+  it "starts up and shuts down the networking stack" do
+    FakeNetworkStack.any_instance.expects(:run)
+
+    client = Pantry::Client.new(network_stack_class: FakeNetworkStack)
+    client.run
+  end
+
+  it "sends a registration packet once networking is up" do
+    client = Pantry::Client.new(identity: "johnson", network_stack_class: FakeNetworkStack)
+
+    FakeNetworkStack.any_instance.stubs(:run)
+    FakeNetworkStack.any_instance.expects(:send_message).with do |message|
+      assert_equal "RegisterClient", message.type
+    end
+
+    client.run
+  end
+
+  it "executes callbacks when a message matches" do
+    client = Pantry::Client.new
+
+    Pantry::CommandHandler.any_instance.stubs(:can_handle?).returns(true)
+    Pantry::CommandHandler.any_instance.expects(:process).with do |message|
+      message.type == "test_message"
+    end
+
+    client.receive_message(Pantry::Message.new("test_message"))
+  end
+
+  it "builds and sends a response message if message flagged as needing one" do
+    client = Pantry::Client.new(network_stack_class: FakeNetworkStack)
+
+    Pantry::CommandHandler.any_instance.stubs(:can_handle?).returns(true)
+    Pantry::CommandHandler.any_instance.expects(:process).returns("A response message")
+
+    message = Pantry::Message.new("test_message")
+    message.requires_response!
+
+    FakeNetworkStack.any_instance.expects(:send_message).with do |response_message|
+      assert_equal "test_message", response_message.type
+      assert_equal ["A response message"], response_message.body
+    end
+
+    client.receive_message(message)
+  end
+
+  it "keeps all object formatting of the response message" do
+    client = Pantry::Client.new(network_stack_class: FakeNetworkStack)
+
+    Pantry::CommandHandler.any_instance.stubs(:can_handle?).returns(true)
+    Pantry::CommandHandler.any_instance.expects(:process).returns([%w(A response message)])
+
+    message = Pantry::Message.new("test_message")
+    message.requires_response!
+
+    FakeNetworkStack.any_instance.expects(:send_message).with do |response_message|
+      assert_equal [["A", "response", "message"]], response_message.body
+    end
+
+    client.receive_message(message)
+  end
+
+  it "can request info of a the server" do
+    client = Pantry::Client.new(network_stack_class: FakeNetworkStack)
+    message = Pantry::Message.new("test message")
+
+    FakeNetworkStack.any_instance.expects(:send_request).with(message)
+
+    client.send_request( message)
+
+    assert message.requires_response?, "Message should require a response from the server"
+  end
+
+  describe "Identity" do
+    it "can be given a specific identity" do
+      c = Pantry::Client.new identity: "My Test Client"
+      assert_equal "My Test Client", c.identity
+    end
+
+    it "defaults to the hostname of the machine" do
+      c = Pantry::Client.new
+      assert_equal `hostname`.strip, c.identity
+    end
+  end
+
+end