pantry 0.0.0 → 0.1.0

data/test/unit/commands/register_client_test.rb

@@ -0,0 +1,41 @@
+require 'unit/test_helper'
+
+describe Pantry::Commands::RegisterClient do
+
+  it "builds a client and notifies server of the new client" do
+    message = Pantry::Message.new("RegisterClient")
+    message.from = "client 427"
+    message << {
+      :environment => "test", :application => "pantry", :roles => %w(app db)
+    }
+
+    server = Pantry::Server.new
+
+    command = Pantry::Commands::RegisterClient.new
+    command.server_or_client = server
+    command.perform(message)
+
+    clients = server.client_registry.all
+
+    assert_equal 1, clients.length
+    assert_equal "client 427", clients[0].identity
+    assert_equal "pantry", clients[0].application
+    assert_equal "test", clients[0].environment
+    assert_equal %w(app db), clients[0].roles
+  end
+
+  it "builds message including the Client's information for registration" do
+    command = Pantry::Commands::RegisterClient.new(Pantry::ClientInfo.new(
+      identity: "Test123", application: "pantry", environment: "test",
+      roles: %w(app db)
+    ))
+
+    message = command.to_message
+
+    assert_equal(
+      {:application => "pantry", :environment => "test", :roles => %w(app db)},
+      message.body[0]
+    )
+  end
+
+end

data/test/unit/commands/status_test.rb

@@ -0,0 +1,81 @@
+require 'unit/test_helper'
+
+describe Pantry::Commands::Status do
+
+  mock_ui!
+
+  describe "#prepare_message" do
+    it "generates a message with the given client filter" do
+      command = Pantry::Commands::Status.new
+      message = command.prepare_message({
+        application: "pantry"
+      })
+
+      assert_equal "Status", message.type
+      assert_equal({application: "pantry", environment: nil, roles: [], identity: nil},
+                  message.body[0])
+    end
+  end
+
+  describe "#perform" do
+    it "asks server for known clients and returns the info as a list" do
+      server = Pantry::Server.new
+      server.register_client(Pantry::ClientInfo.new(identity: "client1"))
+      server.register_client(Pantry::ClientInfo.new(identity: "client2"))
+      server.register_client(Pantry::ClientInfo.new(identity: "client3"))
+
+      message = Pantry::Message.new("Status")
+
+      command = Pantry::Commands::Status.new
+      command.server_or_client = server
+
+      response = command.perform(message)
+
+      assert_equal ["client1", "client2", "client3"], response.map {|entry| entry[:identity] }
+    end
+
+    it "only counts clients that match the given filters" do
+      server = Pantry::Server.new
+      server.register_client(Pantry::ClientInfo.new(identity: "client1", application: "pantry"))
+      server.register_client(Pantry::ClientInfo.new(identity: "client2", application: "pantry", environment: "testing"))
+      server.register_client(Pantry::ClientInfo.new(identity: "client3"))
+
+      message = Pantry::Message.new("Status")
+      message << Pantry::Communication::ClientFilter.new(application: "pantry").to_hash
+
+      command = Pantry::Commands::Status.new
+      command.server_or_client = server
+
+      response = command.perform(message)
+
+      assert_equal ["client1", "client2"], response.map {|entry| entry[:identity] }
+    end
+  end
+
+  describe "#receive_message" do
+    let(:response) do
+      Pantry::Message.new.tap do |m|
+        m.from = Pantry::SERVER_IDENTITY
+        m << {:identity => "client1", :last_checked_in => (Time.now - 60*60).to_s }
+        m << {:identity => "client2", :last_checked_in => (Time.now - 60*5).to_s }
+      end
+    end
+
+    it "reports the name and last time checked in to the user" do
+      command = Pantry::Commands::Status.new
+      command.receive_response(response)
+
+      assert_match /client1/, stdout, "Did not include client1 in output"
+      assert_match /client2/, stdout, "Did not include client2 in output"
+    end
+
+    it "builds a nice message for when the clients last checked in" do
+      command = Pantry::Commands::Status.new
+      command.receive_response(response)
+
+      assert_match /5 minutes ago/, stdout
+      assert_match /1 hour ago/, stdout
+    end
+  end
+
+end

data/test/unit/commands/sync_directory_test.rb

@@ -0,0 +1,75 @@
+require 'unit/test_helper'
+
+describe Pantry::Commands::SyncDirectory do
+
+  fake_fs!
+
+  class MySyncTest < Pantry::Commands::SyncDirectory
+    def server_directory(local_root)
+      local_root.join("copy", "from", "dir")
+    end
+
+    def client_directory(local_root)
+      local_root.join("copy", "to")
+    end
+  end
+
+  it "asks Server for all files in a directory, returning name and contents" do
+    client = stub_everything
+
+    response = Pantry::Message.new
+    response << ["file1.txt", %|some content here|]
+    response << ["file2.rb",  %|def main; end;|]
+
+    client.expects(:send_request).with do |message|
+      assert_equal "DownloadDirectory", message.type
+      assert_equal "copy/from/dir", message.body[0]
+    end.returns(mock(:value => response))
+
+    command = MySyncTest.new
+    command.client = client
+    command.perform(Pantry::Message.new)
+
+    file1 = Pantry.root.join("copy", "to", "file1.txt")
+    assert File.exists?(file1), "Did not write the first file"
+    assert_equal "some content here", File.read(file1)
+
+    file2 = Pantry.root.join("copy", "to", "file2.rb")
+    assert File.exists?(file2), "Did not write the second file"
+    assert_equal "def main; end;", File.read(file2)
+  end
+
+  it "ensures nested directories are created" do
+    client = stub_everything
+
+    response = Pantry::Message.new
+    response << ["nested/file1.txt", ""]
+
+    client.expects(:send_request).returns(mock(:value => response))
+
+    command = MySyncTest.new
+    command.client = client
+    command.perform(Pantry::Message.new)
+
+    file1 = Pantry.root.join("copy", "to", "nested", "file1.txt")
+    assert File.exists?(file1), "Did not write the nested file"
+  end
+
+  it "doesn't allow path injection attacks" do
+    client = stub_everything
+
+    response = Pantry::Message.new
+    response << ["../../../../file1.txt", %|some content here|]
+
+    client.stubs(:send_request).returns(mock(:value => response))
+
+    command = MySyncTest.new
+    command.client = client
+    command.perform(Pantry::Message.new)
+
+    file1 = Pantry.root.join("copy", "to", "file1.txt")
+    assert_false File.exists?(file1), "Still wrote out the bad file?"
+    assert_false File.exists?(Pantry.root.join("../../../../file1.txt")), "Still wrote out the bad file?"
+  end
+
+end

data/test/unit/commands/update_application_test.rb

@@ -0,0 +1,35 @@
+require 'unit/test_helper'
+
+describe Pantry::Commands::UpdateApplication do
+  let(:command) { Pantry::Commands::UpdateApplication.new }
+
+  fake_fs!
+
+  describe "#perform" do
+    it "takes contents of the message and writes out a new config file for the application" do
+      message = Pantry::Message.new
+      message << "pantry"
+      message << {name: "pantry", enviornment: "test"}.to_yaml
+
+      assert command.perform(message)
+
+      assert File.exists?(Pantry.root.join("applications", "pantry", "config.yml")),
+        "Did not write out the new config file"
+    end
+
+    it "ignores file content that's not valid YAML" do
+      message = Pantry::Message.new
+      message << "pantry"
+      message << "---\nthis: that\n<> { not valid yaml zomg }"
+
+      response = command.perform(message)
+
+      assert_false response[0]
+      assert_false File.exists?(Pantry.root.join("applications", "pantry", "config.yml")),
+        "Wrote out an invalid config file"
+    end
+
+    it "creates a backup of the file being overwritten"
+  end
+
+end

data/test/unit/commands/upload_file_test.rb

@@ -0,0 +1,51 @@
+require 'unit/test_helper'
+
+describe Pantry::Commands::UploadFile do
+
+  class MyUploader < Pantry::Commands::UploadFile
+    def required_options
+      %i(application)
+    end
+
+    def upload_directory(options)
+      Pantry.root.join("upload", options[:application])
+    end
+  end
+
+  describe "#prepare_message" do
+    it "requires an application we're uploading for" do
+      command = MyUploader.new(fixture_path("file_to_upload"))
+      assert_raises Pantry::MissingOption do
+        command.prepare_message({})
+      end
+    end
+
+    it "sets the file name and contents in the message to the Server" do
+      command = MyUploader.new(fixture_path("file_to_upload"))
+      message = command.prepare_message({application: "pantry"})
+
+      assert_equal({application: "pantry"}, message.body[0])
+      assert_equal "file_to_upload", message.body[1]
+      assert_equal %|Hello\nPantry\n!\n|, message.body[2]
+    end
+  end
+
+  describe "#perform" do
+    fake_fs!
+
+    it "writes out the file data to the appropriate location" do
+      message = Pantry::Message.new
+      message << {application: "pantry"}
+      message << "filename.rb"
+      message << "This is the content"
+
+      command = MyUploader.new
+      command.perform(message)
+
+      uploaded_file = Pantry.root.join("upload", "pantry", "filename.rb")
+      assert File.exists?(uploaded_file), "Did not write out the file"
+      assert_equal "This is the content", File.read(uploaded_file)
+    end
+  end
+
+end

data/test/unit/communication/client_filter_test.rb

@@ -0,0 +1,262 @@
+require 'unit/test_helper'
+
+describe Pantry::Communication::ClientFilter do
+
+  it "ensures roles is always an array" do
+    filter = Pantry::Communication::ClientFilter.new(roles: nil)
+    assert_equal [], filter.roles
+  end
+
+  describe "#streams" do
+    it "returns empty string if no filters given" do
+      filter = Pantry::Communication::ClientFilter.new({})
+      assert_equal [""], filter.streams
+    end
+
+    it "takes a hash of filters and builds streams from them" do
+      filter = Pantry::Communication::ClientFilter.new(
+        identity:    "my_test_ident",
+        application: "pantry",
+        environment: "test",
+        roles:       %w(db app)
+      )
+
+      expected_streams = [
+        "my_test_ident",
+        "pantry",
+        "pantry.test",
+        "pantry.test.db",
+        "pantry.test.app",
+      ]
+
+      assert_equal expected_streams, filter.streams
+    end
+
+    it "handles environment and roles, no application" do
+      filter = Pantry::Communication::ClientFilter.new(
+        environment: "test",
+        roles:       %w(db app)
+      )
+
+      expected_streams = [
+        "test",
+        "test.db",
+        "test.app",
+      ]
+
+      assert_equal expected_streams, filter.streams
+    end
+
+    it "handles application and roles, no environment, properly" do
+      filter = Pantry::Communication::ClientFilter.new(
+        application: "pantry",
+        roles:       %w(db app)
+      )
+
+      expected_streams = [
+        "pantry",
+        "pantry.db",
+        "pantry.app",
+      ]
+
+      assert_equal expected_streams, filter.streams
+    end
+
+    it "handles just roles" do
+      filter = Pantry::Communication::ClientFilter.new(
+        roles:       %w(db app)
+      )
+
+      assert_equal ["db", "app"], filter.streams
+    end
+
+    it "uses the identity of no other values set" do
+      filter = Pantry::Communication::ClientFilter.new(
+        identity: "tester.client"
+      )
+
+      assert_equal ["tester.client"], filter.streams
+    end
+  end
+
+  describe "#stream" do
+    it "returns the most explicit stream matching filters given" do
+      filter = Pantry::Communication::ClientFilter.new(
+        application: "pantry",
+        environment: "test",
+        roles:       %w(db)
+      )
+
+      assert_equal "pantry.test.db", filter.stream
+    end
+
+    it "ignores environment if left out" do
+      filter = Pantry::Communication::ClientFilter.new(
+        application: "pantry",
+        roles:       %w(db)
+      )
+
+      assert_equal "pantry.db", filter.stream
+    end
+
+    it "ignores application if left out" do
+      filter = Pantry::Communication::ClientFilter.new(
+        roles:       %w(db)
+      )
+
+      assert_equal "db", filter.stream
+    end
+
+    it "uses the client identity if given" do
+      filter = Pantry::Communication::ClientFilter.new(
+        identity: "12345.client",
+        roles:    %w(app db)
+      )
+
+      assert_equal "12345.client", filter.stream
+    end
+  end
+
+  describe "#equality" do
+    it "return true on empty filters" do
+      assert_equal(
+        Pantry::Communication::ClientFilter.new,
+        Pantry::Communication::ClientFilter.new
+      )
+    end
+
+    it "returns true on matching all options" do
+      assert_equal(
+        Pantry::Communication::ClientFilter.new(
+          application: "app", environment: "test", roles: %w(db)),
+        Pantry::Communication::ClientFilter.new(
+          application: "app", environment: "test", roles: %w(db))
+      )
+    end
+
+    it "returns false if other is nil" do
+      refute_equal(
+        Pantry::Communication::ClientFilter.new,
+        nil
+      )
+    end
+  end
+
+  describe "#matches" do
+    it "returns true if the stream is matched by any part of the filter" do
+      filter = Pantry::Communication::ClientFilter.new(
+        application: "app", environment: "test", roles: %w(db))
+
+      assert filter.matches?("")
+      assert filter.matches?("app")
+      assert filter.matches?("app.test")
+      assert filter.matches?("app.test.db")
+
+      assert_false filter.matches?("app2")
+      assert_false filter.matches?("db")
+      assert_false filter.matches?("test")
+    end
+
+    it "tries to match against an identity filter" do
+      filter = Pantry::Communication::ClientFilter.new(identity: "test-client")
+
+      assert filter.matches?("")
+      assert filter.matches?("test-client")
+
+      assert_false filter.matches?("app")
+      assert_false filter.matches?("pantry.test")
+    end
+  end
+
+  describe "#includes?" do
+    it "returns true if the two filters are equal" do
+      f1 = Pantry::Communication::ClientFilter.new(
+        application: "app", environment: "test", roles: %w(db))
+      f2 = Pantry::Communication::ClientFilter.new(
+        application: "app", environment: "test", roles: %w(db))
+
+      assert f2.includes?(f1), "f1's match set was not included in f2's match set"
+    end
+
+    it "returns true if the most specific stream" do
+      f1 = Pantry::Communication::ClientFilter.new(
+        application: "app", environment: "test", roles: %w(db))
+      f2 = Pantry::Communication::ClientFilter.new(application: "app")
+
+      assert f2.includes?(f1), "app should have included app.test.db"
+    end
+
+    it "handles multiple roles" do
+      f1 = Pantry::Communication::ClientFilter.new(
+        application: "app", roles: %w(db web))
+      f2 = Pantry::Communication::ClientFilter.new(application: "app", roles: %w(web))
+
+      assert f2.includes?(f1), "app.web should have included app.test.web / app.test.db"
+    end
+
+    it "returns false if application doesn't match" do
+      f1 = Pantry::Communication::ClientFilter.new(
+        application: "app", environment: "test", roles: %w(db))
+      f2 = Pantry::Communication::ClientFilter.new(
+        application: "app2", environment: "test", roles: %w(db))
+
+      assert_false f2.includes?(f1), "f1's match set was included in f2's match set"
+    end
+
+    it "returns false if environment doesn't match" do
+      f1 = Pantry::Communication::ClientFilter.new(
+        application: "app", environment: "test", roles: %w(db))
+      f2 = Pantry::Communication::ClientFilter.new(
+        application: "app", environment: "dev", roles: %w(db))
+
+      assert_false f2.includes?(f1), "f1's match set was included in f2's match set"
+    end
+
+    it "returns false if roles doesn't match" do
+      f1 = Pantry::Communication::ClientFilter.new(
+        application: "app", environment: "test", roles: %w(app))
+      f2 = Pantry::Communication::ClientFilter.new(
+        application: "app", environment: "test", roles: %w(db))
+
+      assert_false f2.includes?(f1), "f1's match set was included in f2's match set"
+    end
+
+    it "returns false if environments are given in one but not the other" do
+      f1 = Pantry::Communication::ClientFilter.new(
+        application: "app", environment: "test", roles: %w(db))
+      f2 = Pantry::Communication::ClientFilter.new(
+        application: "app", roles: %w(db))
+
+      assert_false f2.includes?(f1), "f1's match set was included in f2's match set"
+    end
+
+    it "returns true if we are the empty set (match all)" do
+      f1 = Pantry::Communication::ClientFilter.new(
+        application: "app", environment: "test", roles: %w(db))
+      f2 = Pantry::Communication::ClientFilter.new()
+
+      assert f2.includes?(f1), "f1 was not included in f2's all client match"
+    end
+
+    it "returns false if identity is the only value set and doesn't match" do
+      f1 = Pantry::Communication::ClientFilter.new(identity: "test-client")
+      f2 = Pantry::Communication::ClientFilter.new(application: "pantry")
+
+      assert_false f2.includes?(f1), "f1 was not included in f2's all client match"
+    end
+  end
+
+  describe "#to_hash" do
+    it "returns a hash representation of the filter" do
+      filter = Pantry::Communication::ClientFilter.new(
+        application: "app", environment: "test", roles: %w(db), identity: "test"
+      )
+
+      assert_equal(
+        {application: "app", environment: "test", roles: %w(db), identity: "test"},
+        filter.to_hash
+      )
+    end
+  end
+
+end