warden-protocol 0.1.3

data/spec/resource_limits_spec.rb

@@ -0,0 +1,84 @@
+# coding: UTF-8
+
+require "spec_helper"
+
+describe Warden::Protocol::ResourceLimits do
+  subject do
+    described_class.new
+  end
+
+  field :as do
+    it_should_be_optional
+    it_should_be_typed_as_uint64
+  end
+
+  field :core do
+    it_should_be_optional
+    it_should_be_typed_as_uint64
+  end
+
+  field :cpu do
+    it_should_be_optional
+    it_should_be_typed_as_uint64
+  end
+
+  field :data do
+    it_should_be_optional
+    it_should_be_typed_as_uint64
+  end
+
+  field :fsize do
+    it_should_be_optional
+    it_should_be_typed_as_uint64
+  end
+
+  field :locks do
+    it_should_be_optional
+    it_should_be_typed_as_uint64
+  end
+
+  field :memlock do
+    it_should_be_optional
+    it_should_be_typed_as_uint64
+  end
+
+  field :msgqueue do
+    it_should_be_optional
+    it_should_be_typed_as_uint64
+  end
+
+  field :nice do
+    it_should_be_optional
+    it_should_be_typed_as_uint64
+  end
+
+  field :nofile do
+    it_should_be_optional
+    it_should_be_typed_as_uint64
+  end
+
+  field :nproc do
+    it_should_be_optional
+    it_should_be_typed_as_uint64
+  end
+
+  field :rss do
+    it_should_be_optional
+    it_should_be_typed_as_uint64
+  end
+
+  field :rtprio do
+    it_should_be_optional
+    it_should_be_typed_as_uint64
+  end
+
+  field :sigpending do
+    it_should_be_optional
+    it_should_be_typed_as_uint64
+  end
+
+  field :stack do
+    it_should_be_optional
+    it_should_be_typed_as_uint64
+  end
+end

data/spec/run_spec.rb

@@ -0,0 +1,79 @@
+# coding: UTF-8
+
+require "spec_helper"
+
+module Warden::Protocol
+  describe RunRequest do
+    subject(:request) do
+      described_class.new(:handle => "handle", :script => "echo foo")
+    end
+
+    it_should_behave_like "wrappable request"
+
+    its("class.type_camelized") { should == "Run" }
+    its("class.type_underscored") { should == "run" }
+
+    field :handle do
+      it_should_be_required
+    end
+
+    field :script do
+      it_should_be_required
+    end
+
+    field :privileged do
+      it_should_be_optional
+      it_should_default_to false
+    end
+
+    field :rlimits do
+      it_should_be_optional
+
+      it "should be populated with ResourceLimits object" do
+        request.rlimits = ResourceLimits.new
+        request.should be_valid
+      end
+    end
+
+    it "should respond to #create_response" do
+      request.create_response.should be_a(RunResponse)
+    end
+  end
+
+  describe RunResponse do
+    subject(:response) do
+      described_class.new
+    end
+
+    it_should_behave_like "wrappable response"
+
+    its("class.type_camelized") { should == "Run" }
+    its("class.type_underscored") { should == "run" }
+
+    it { should be_ok }
+    it { should_not be_error }
+
+    field :exit_status do
+      it_should_be_optional
+      it_should_be_typed_as_uint
+    end
+
+    field :stdout do
+      it_should_be_optional
+      it_should_be_typed_as_string
+    end
+
+    field :stderr do
+      it_should_be_optional
+      it_should_be_typed_as_string
+    end
+
+    field :info do
+      it_should_be_optional
+
+      it "should be a InfoResponse" do
+        field.type.should == InfoResponse
+      end
+    end
+  end
+end

data/spec/spawn_spec.rb

@@ -0,0 +1,55 @@
+# coding: UTF-8
+
+require "spec_helper"
+
+describe Warden::Protocol::SpawnRequest do
+  subject(:request) do
+    described_class.new(:handle => "handle", :script => "echo foo")
+  end
+
+  it_should_behave_like "wrappable request"
+
+  its("class.type_camelized") { should == "Spawn" }
+  its("class.type_underscored") { should == "spawn" }
+
+  field :handle do
+    it_should_be_required
+  end
+
+  field :script do
+    it_should_be_required
+  end
+
+  field :privileged do
+    it_should_be_optional
+    it_should_default_to false
+  end
+
+  it "should be populated with ResourceLimits object" do
+    request.rlimits = Warden::Protocol::ResourceLimits.new
+    request.should be_valid
+  end
+
+  it "should respond to #create_response" do
+    request.create_response.should be_a(Warden::Protocol::SpawnResponse)
+  end
+end
+
+describe Warden::Protocol::SpawnResponse do
+  subject(:response) do
+    described_class.new(:job_id => 1)
+  end
+
+  it_should_behave_like "wrappable response"
+
+  its("class.type_camelized") { should == "Spawn" }
+  its("class.type_underscored") { should == "spawn" }
+
+  it { should be_ok }
+  it { should_not be_error }
+
+  field :job_id do
+    it_should_be_required
+    it_should_be_typed_as_uint
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# coding: UTF-8
+
+require "rspec"
+require "rspec/autorun"
+require "warden/protocol"
+
+Dir["./spec/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.include(Helper)
+end

data/spec/stop_spec.rb

@@ -0,0 +1,46 @@
+# coding: UTF-8
+
+require "spec_helper"
+
+describe Warden::Protocol::StopRequest do
+  subject(:request) do
+    described_class.new(:handle => "handle")
+  end
+
+  it_should_behave_like "wrappable request"
+
+  its("class.type_camelized") { should == "Stop" }
+  its("class.type_underscored") { should == "stop" }
+
+  field :handle do
+    it_should_be_required
+  end
+
+  field :background do
+    it_should_be_optional
+    it_should_be_typed_as_boolean
+  end
+
+  field :kill do
+    it_should_be_optional
+    it_should_be_typed_as_boolean
+  end
+
+  it "should respond to #create_response" do
+    request.create_response.should be_a(Warden::Protocol::StopResponse)
+  end
+end
+
+describe Warden::Protocol::StopResponse do
+  subject(:response) do
+    described_class.new
+  end
+
+  it_should_behave_like "wrappable response"
+
+  its("class.type_camelized") { should == "Stop" }
+  its("class.type_underscored") { should == "stop" }
+
+  it { should be_ok }
+  it { should_not be_error }
+end

data/spec/stream_spec.rb

@@ -0,0 +1,65 @@
+# coding: UTF-8
+
+require "spec_helper"
+
+describe Warden::Protocol::StreamRequest do
+  subject(:request) do
+    described_class.new(:handle => "handle", :job_id => 1)
+  end
+
+  it_should_behave_like "wrappable request"
+
+  its("class.type_camelized") { should == "Stream" }
+  its("class.type_underscored") { should == "stream" }
+
+  field :handle do
+    it_should_be_required
+    it_should_be_typed_as_string
+  end
+
+  field :job_id do
+    it_should_be_required
+    it_should_be_typed_as_uint
+  end
+
+  it "should respond to #create_response" do
+    request.create_response.should be_a(Warden::Protocol::StreamResponse)
+  end
+end
+
+describe Warden::Protocol::StreamResponse do
+  subject(:response) do
+    described_class.new
+  end
+
+  it_should_behave_like "wrappable response"
+
+  its("class.type_camelized") { should == "Stream" }
+  its("class.type_underscored") { should == "stream" }
+
+  it { should be_ok }
+  it { should_not be_error }
+
+  field :name do
+    it_should_be_optional
+    it_should_be_typed_as_string
+  end
+
+  field :data do
+    it_should_be_optional
+    it_should_be_typed_as_string
+  end
+
+  field :exit_status do
+    it_should_be_optional
+    it_should_be_typed_as_uint
+  end
+
+  field :info do
+    it_should_be_optional
+
+    it "should be a InfoResponse" do
+      field.type.should == Warden::Protocol::InfoResponse
+    end
+  end
+end

data/spec/support/examples/wrappable_reply.rb

@@ -0,0 +1,26 @@
+# coding: UTF-8
+
+shared_examples "wrappable response" do
+  let(:wrapped) { subject.wrap }
+
+  it "should respond to #wrap" do
+    wrapped.should be_a(Warden::Protocol::Message)
+
+    type_const = described_class.name.split("::").last.gsub(/Response$/, "")
+    wrapped.type.should == Warden::Protocol::Message::Type.const_get(type_const)
+    wrapped.payload.to_s.should == subject.encode.to_s
+  end
+
+  it "should retain class when unwrapped" do
+    wrapped.response.should be_a(described_class)
+  end
+
+  it "should retain properties when unwrapped" do
+    compare_without_encoding(wrapped.response.to_hash, subject.to_hash)
+  end
+
+  it "should retain properties when encoded and decoded" do
+    freshly_wrapped = Warden::Protocol::Message.decode(wrapped.encode.to_s)
+    compare_without_encoding(freshly_wrapped.response.to_hash, subject.to_hash)
+  end
+end

data/spec/support/examples/wrappable_request.rb

@@ -0,0 +1,26 @@
+# coding: UTF-8
+
+shared_examples "wrappable request" do
+  let(:wrapped) { subject.wrap }
+
+  it "should respond to #wrap" do
+    wrapped.should be_a(Warden::Protocol::Message)
+
+    type_const = described_class.name.split("::").last.gsub(/Request$/, "")
+    wrapped.type.should == Warden::Protocol::Message::Type.const_get(type_const)
+    wrapped.payload.to_s.should == subject.encode.to_s
+  end
+
+  it "should retain class when unwrapped" do
+    wrapped.request.should be_a(described_class)
+  end
+
+  it "should retain properties when unwrapped" do
+    compare_without_encoding(wrapped.request.to_hash, subject.to_hash)
+  end
+
+  it "should retain properties when encoded and decoded" do
+    freshly_wrapped = Warden::Protocol::Message.decode(wrapped.encode.to_s)
+    compare_without_encoding(freshly_wrapped.request.to_hash, subject.to_hash)
+  end
+end

data/spec/support/helper.rb

@@ -0,0 +1,122 @@
+# coding: UTF-8
+
+module Helper
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  # Compare strings in hashes regardless of their encoding
+  def compare_without_encoding(a, b)
+    (a.keys + b.keys).uniq.each do |key|
+      if a[key].respond_to?(:encoding)
+        a[key].should == b[key].force_encoding(a[key].encoding)
+      else
+        a[key].should == b[key]
+      end
+    end
+  end
+
+  module ClassMethods
+    def field(field, &blk)
+      describe field do
+        let(:field) do
+          subject.fields.values.detect { |f| f.name == field }
+        end
+
+        instance_eval(&blk)
+      end
+    end
+
+    def it_should_be_required
+      it "should be required" do
+        subject.should be_valid
+        subject.send("#{field.name}=", nil)
+        subject.should_not be_valid
+      end
+    end
+
+    def it_should_be_optional
+      it "should be optional" do
+        subject.should be_valid
+        subject.send("#{field.name}=", nil)
+        subject.should be_valid
+      end
+    end
+
+    def it_should_default_to(default)
+      it "should default to #{default}" do
+        instance = subject.reload
+        instance.send(field.name).should == default
+      end
+    end
+
+    def it_should_be_typed_as_uint
+      it "should not allow a signed integer" do
+        subject.send("#{field.name}=", -1)
+        subject.should_not be_valid
+      end
+
+      it "should allow zero" do
+        subject.send("#{field.name}=", 0)
+        subject.should be_valid
+      end
+
+      it "should allow integers larger than zero" do
+        subject.send("#{field.name}=", 37)
+        subject.should be_valid
+      end
+    end
+
+    def it_should_be_typed_as_uint32
+      it_should_be_typed_as_uint
+
+      it "should allow integer 2^32-1" do
+        subject.send("#{field.name}=", 2**32-1)
+        subject.should be_valid
+      end
+
+      it "should not allow integer 2^32" do
+        subject.send("#{field.name}=", 2**32)
+        subject.should_not be_valid
+      end
+    end
+
+    def it_should_be_typed_as_uint64
+      it_should_be_typed_as_uint
+
+      it "should allow integer 2^64-1" do
+        subject.send("#{field.name}=", 2**64-1)
+        subject.should be_valid
+      end
+
+      it "should not allow integer 2^64" do
+        subject.send("#{field.name}=", 2**64)
+        subject.should_not be_valid
+      end
+    end
+
+    def it_should_be_typed_as_string
+      it "should allow an empty string" do
+        subject.send("#{field.name}=", "")
+        subject.should be_valid
+      end
+
+      it "should allow a non-empty string" do
+        subject.send("#{field.name}=", "non-empty")
+        subject.should be_valid
+      end
+    end
+
+    def it_should_be_typed_as_boolean
+      it "should allow false" do
+        subject.send("#{field.name}=", false)
+        subject.should be_valid
+      end
+
+      it "should allow true" do
+        subject.send("#{field.name}=", true)
+        subject.should be_valid
+      end
+    end
+  end
+end