schemata-dea 0.0.1.beta1

data/spec/support/message_type_helpers.rb

@@ -0,0 +1,171 @@
+shared_examples "a message type" do
+
+  versions = described_class.constants.select {|x| x =~ /V[0-9]+/ }
+    .map {|x| x.to_s[1..-1].to_i}
+
+  let(:message_type_name) { described_class.name.split("::")[2] }
+  let(:message_type)      { described_class }
+  let(:component_name)    { described_class.name.split("::")[1] }
+  let(:component)         { Schemata::const_get(component_name) }
+
+  let(:mock_method)       { "mock_#{decamelize(message_type_name)}" }
+
+  describe ".decode" do
+    context "when the current version is 1" do
+      before :each do
+        set_current_version(message_type, 1)
+      end
+
+      after :each do
+        reset_version(message_type)
+      end
+
+      it "should return a V1 object given a flat hash" do
+        data = component.send(mock_method, 1).contents
+        json = Yajl::Encoder.encode(data)
+        msg_obj = message_type.decode(json)
+        msg_obj.class.should == message_type::V1
+
+        message_type::V1.schema.schemas.keys do |key|
+          msg_obj.send(key).should == data[key]
+        end
+      end
+
+      it "should return a V1 object given a V1-encoded json" do
+        data = component.send(mock_method, 1).contents
+
+        msg_hash = {"V1" => data, "min_version" => 1}
+        json = Yajl::Encoder.encode(msg_hash)
+
+        msg_obj = message_type.decode(json)
+        msg_obj.class.should == message_type::V1
+
+        message_type::V1.schema.schemas.keys do |key|
+          msg_obj.send(key).should == data[key]
+        end
+      end
+
+      it "should return a V1 object given a mixed (V1-encoded + flat hash) json" do
+        data = component.send(mock_method, 1).contents
+        msg_hash = {
+          "V1" => data,
+          "min_version" => 1
+        }.merge(Schemata::HashCopyHelpers.deep_copy(data))
+        json = Yajl::Encoder.encode(msg_hash)
+
+        msg_obj = message_type.decode(json)
+        msg_obj.class.should == message_type::V1
+
+        message_type::V1.schema.schemas.keys do |key|
+          msg_obj.send(key).should == data[key]
+        end
+      end
+
+      it "should return a V1 object when given a V2-encoded json" do
+        v2_hash = component.send(mock_method, 1).contents
+        msg_hash = {
+          "V2" => v2_hash,
+          "V1" => {},
+          "min_version" => 1
+        }
+        json = Yajl::Encoder.encode(msg_hash)
+
+        msg_obj = message_type.decode(json)
+        msg_obj.class.should == message_type::V1
+
+        message_type::V1.schema.schemas.keys do |key|
+          msg_obj.send(key).should == data[key]
+        end
+      end
+
+      it "should raise an error if the input does not have the valid Schemata \
+structure or a complete flash hash" do
+        mock_obj = component.send(mock_method, 1)
+        mock_hash = mock_obj.contents
+
+        if num_mandatory_fields(mock_obj) > 1
+          first_key = mock_hash.keys[0]
+          first_value = mock_hash[first_key]
+
+          json = Yajl::Encoder.encode({ first_key => first_value})
+        else
+          json = Yajl::Encoder.encode({})
+        end
+        expect {
+          msg_obj = message_type.decode(json)
+        }.to raise_error(Schemata::DecodeError)
+      end
+    end
+  end
+
+  if versions.include?(2)
+    context "when current version is 2" do
+      before :each do
+        set_current_version(message_type, 2)
+      end
+
+      after :each do
+        reset_version(message_type)
+      end
+
+      it "should raise an error given a flat hash" do
+        data = component.send(mock_method, 2).contents
+        json = Yajl::Encoder.encode(data)
+        expect {
+          msg_obj = message_type.decode(json)
+        }.to raise_error(Schemata::DecodeError)
+      end
+
+      it "should return a V2 object a given a mixed (flat hash + V1-encoded) json" do
+        msg_hash = component.send(mock_method, 2).contents
+        v1_hash = Schemata::HashCopyHelpers.deep_copy(msg_hash)
+        msg_hash["V1"] = v1_hash
+        msg_hash["min_version"] = 1
+
+        json = Yajl::Encoder.encode(msg_hash)
+
+        msg_obj = message_type.decode(json)
+        msg_obj.class.should == message_type::V2
+
+        message_type::V2.schema.schemas.keys.each do |key|
+          msg_obj.send(key).should == v1_hash[key]
+        end
+      end
+
+      it "should return a V2 object given a V1-encoded json" do
+        v1_hash = component.send(mock_method, 1).contents
+        msg_hash = {"V1" => v1_hash, 'min_version' => 1}
+
+        json = Yajl::Encoder.encode(msg_hash)
+
+        msg_obj = message_type.decode(json)
+        msg_obj.class.should == message_type::V2
+
+        message_type::V2.schema.schemas.keys.each do |key|
+          msg_obj.send(key).should == v1_hash[key]
+        end
+      end
+
+      it "should return a V2 object given a V2-encoded object" do
+        data = component.send(mock_method, 2).contents
+        v2_hash = Schemata::HashCopyHelpers.deep_copy(data)
+        msg_hash = {"V2" => v2_hash, "V1" => {}, "min_version" => 1}
+
+        json = Yajl::Encoder.encode(msg_hash)
+
+        msg_obj = message_type.decode(json)
+        msg_obj.class.should == message_type::V2
+
+        message_type::V2.schema.schemas.keys.each do |key|
+          msg_obj.send(key).should == data[key]
+        end
+      end
+    end
+  end
+
+  # The first two versions have exceptional behavior, starting from
+  # version 3, all versions should have the same unit tests
+  versions.select { |x| x > 2 }.each do |version|
+
+  end
+end

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification
+name: schemata-dea
+version: !ruby/object:Gem::Version
+  version: 0.0.1.beta1
+  prerelease: 6
+platform: ruby
+authors:
+- dsabeti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: membrane
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcap_common
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "    Specify schema for DEA messages and validate messages\n      against
+  defined schema\n"
+email:
+- support@cloudfoundry.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/schemata/dea/find_droplet_response.rb
+- lib/schemata/dea/exit_message/exit_message_v1.rb
+- lib/schemata/dea/droplet_status_response.rb
+- lib/schemata/dea/find_droplet_request/find_droplet_request_v1.rb
+- lib/schemata/dea/heartbeat_response.rb
+- lib/schemata/dea/find_droplet_request.rb
+- lib/schemata/dea/start_request/start_request_v1.rb
+- lib/schemata/dea/hello_message.rb
+- lib/schemata/dea/update_request/update_request_v1.rb
+- lib/schemata/dea/dea_status_response.rb
+- lib/schemata/dea/droplet_status_response/droplet_status_response_v1.rb
+- lib/schemata/dea/discover_request/discover_request_v1.rb
+- lib/schemata/dea/stop_request/stop_request_v1.rb
+- lib/schemata/dea/advertise_message/advertise_message_v1.rb
+- lib/schemata/dea/dea_status_response/dea_status_response_v1.rb
+- lib/schemata/dea/hello_message/hello_message_v1.rb
+- lib/schemata/dea/version.rb
+- lib/schemata/dea/heartbeat_response/heartbeat_response_v1.rb
+- lib/schemata/dea/stop_request.rb
+- lib/schemata/dea/start_request.rb
+- lib/schemata/dea/update_request.rb
+- lib/schemata/dea/advertise_message.rb
+- lib/schemata/dea/find_droplet_response/find_droplet_response_v1.rb
+- lib/schemata/dea/discover_request.rb
+- lib/schemata/dea/exit_message.rb
+- lib/schemata/dea.rb
+- lib/schemata/common/msgtypebase.rb
+- lib/schemata/common/parsed_msg.rb
+- lib/schemata/common/msgbase.rb
+- lib/schemata/common/error.rb
+- lib/schemata/helpers/stringify.rb
+- lib/schemata/helpers/hash_copy.rb
+- spec/cloud_controller/cc_bar_spec.rb
+- spec/common/helpers_spec.rb
+- spec/common/parsed_msg_spec.rb
+- spec/component/aux_data_spec.rb
+- spec/component/component_bar_spec.rb
+- spec/component/component_foo_spec.rb
+- spec/component/foo_spec.rb
+- spec/dea/advertise_message_spec.rb
+- spec/dea/dea_spec.rb
+- spec/dea/dea_status_response_spec.rb
+- spec/dea/discover_request_spec.rb
+- spec/dea/droplet_status_response_spec.rb
+- spec/dea/exit_message_spec.rb
+- spec/dea/find_droplet_request_spec.rb
+- spec/dea/find_droplet_response_spec.rb
+- spec/dea/heartbeat_response_spec.rb
+- spec/dea/hello_message_spec.rb
+- spec/dea/start_request_spec.rb
+- spec/dea/stop_request_spec.rb
+- spec/dea/update_request_spec.rb
+- spec/router/register_request_spec.rb
+- spec/router/router_spec.rb
+- spec/router/start_message_spec.rb
+- spec/spec_helper.rb
+- spec/staging/staging_message_spec.rb
+- spec/staging/staging_spec.rb
+- spec/support/component_helpers.rb
+- spec/support/helpers.rb
+- spec/support/message_helpers.rb
+- spec/support/message_type_helpers.rb
+homepage: http://www.cloudfoundry.org
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: validation for cloundfoundry DEA messages
+test_files:
+- spec/cloud_controller/cc_bar_spec.rb
+- spec/common/helpers_spec.rb
+- spec/common/parsed_msg_spec.rb
+- spec/component/aux_data_spec.rb
+- spec/component/component_bar_spec.rb
+- spec/component/component_foo_spec.rb
+- spec/component/foo_spec.rb
+- spec/dea/advertise_message_spec.rb
+- spec/dea/dea_spec.rb
+- spec/dea/dea_status_response_spec.rb
+- spec/dea/discover_request_spec.rb
+- spec/dea/droplet_status_response_spec.rb
+- spec/dea/exit_message_spec.rb
+- spec/dea/find_droplet_request_spec.rb
+- spec/dea/find_droplet_response_spec.rb
+- spec/dea/heartbeat_response_spec.rb
+- spec/dea/hello_message_spec.rb
+- spec/dea/start_request_spec.rb
+- spec/dea/stop_request_spec.rb
+- spec/dea/update_request_spec.rb
+- spec/router/register_request_spec.rb
+- spec/router/router_spec.rb
+- spec/router/start_message_spec.rb
+- spec/spec_helper.rb
+- spec/staging/staging_message_spec.rb
+- spec/staging/staging_spec.rb
+- spec/support/component_helpers.rb
+- spec/support/helpers.rb
+- spec/support/message_helpers.rb
+- spec/support/message_type_helpers.rb