stuartpreston-azure-sdk-for-ruby 0.6.5

data/test/integration/service_bus/queues_scenario_test.rb

@@ -0,0 +1,200 @@
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#--------------------------------------------------------------------------
+require "integration/test_helper"
+
+describe "ServiceBus Queues Scenario" do
+  let(:queue_name) { ServiceBusQueueNameHelper.name }
+
+  subject { Azure::ServiceBus::ServiceBusService.new }
+  after { ServiceBusQueueNameHelper.clean }
+
+  def setup_queue()
+    queues = subject.list_queues({ :skip => 20, :top => 2 })
+    queues.each { |q|
+      ScenarioHelper.out "Queue name is " + q.name
+    }
+
+    ScenarioHelper.out "checking if queue already exists " + queue_name
+    begin
+      subject.get_queue queue_name
+      ScenarioHelper.out "Queue already exists deleting it"
+      subject.delete_queue queue_name
+    rescue Azure::Core::Http::HTTPError => error
+      ScenarioHelper.out "could not get an existing queue (" + error.type + "), proceeding..."
+      error.status_code.must_equal 404
+      error.type.must_equal "ResourceNotFound"
+    end
+
+    q = Azure::ServiceBus::Queue.new(queue_name, {
+      :max_size_in_megabytes => 2048,
+      :requires_duplicate_detection => true,
+      :enable_batched_operations => true,
+      :max_delivery_count => 13
+    })
+
+    ScenarioHelper.out 'Creating queue ' + queue_name
+    q2 = subject.create_queue q
+    q2.max_size_in_megabytes.must_equal q.max_size_in_megabytes
+    q2.requires_duplicate_detection.must_equal q.requires_duplicate_detection
+    q2.enable_batched_operations.must_equal true
+    q2.max_delivery_count.must_equal 13
+
+    subject.get_queue queue_name
+  end
+
+  def send_messages()
+    expected_messages = []
+    expected_messages[0] = ScenarioHelper.create_issue_message '1', 'First  message information', 'label1'
+    expected_messages[1] = ScenarioHelper.create_issue_message '2', 'Second message information', 'label2'
+    expected_messages[2] = ScenarioHelper.create_issue_message '3', 'Third  message information', 'label3'
+    expected_messages[3] = ScenarioHelper.create_issue_message '4', 'Fourth message information', 'label4'
+    expected_messages.each { |message|
+      success = false
+      retry_counter = 0
+      while !success
+        begin
+          subject.send_queue_message queue_name, message
+          success = true
+        rescue Azure::Core::Http::HTTPError => error
+          ScenarioHelper.out "got error: " + error
+          retry_counter = retry_counter + 1
+          if retry_counter > 5
+            throw error
+          end
+        end
+      end
+      ScenarioHelper.out 'Message sent with id: ' + message.message_id + ' Body of $message ' + message.body
+    }
+    expected_messages
+  end
+
+  def get_message_from_queue(expected_messages, exp_custom_props = nil)
+    expected_count = expected_messages.length
+    if exp_custom_props == nil
+      exp_custom_props = []
+      for i in 1..expected_count
+        exp_custom_props[i-1] = nil
+      end
+    end
+
+    ScenarioHelper.out '=============================================='
+    ScenarioHelper.out 'Getting messages from ' +
+            'queue ' + queue_name +
+            ', expecting ' + expected_count.to_s + ' messages'
+
+    message_count = (subject.get_queue queue_name).message_count
+    ScenarioHelper.out 'Before getting any messages, Message count: ' + message_count.to_s
+    message_count.must_equal expected_count
+
+    # Peek the first message
+    message1 = subject.peek_lock_queue_message queue_name, { :timeout => 20 }
+    ScenarioHelper.compare_messages expected_messages[0], message1, exp_custom_props[0]
+
+    message_count = (subject.get_queue queue_name).message_count
+    ScenarioHelper.out 'Peek locked first message, Message count: ' + message_count.to_s
+    message_count.must_equal expected_count # Peek locked first message, count should not change
+
+    # Get the second message
+    message2 = subject.read_delete_queue_message queue_name,  { :timeout => 5 }
+    expected_count = expected_count - 1
+    ScenarioHelper.compare_messages expected_messages[1], message2, exp_custom_props[1]
+
+    message_count = (subject.get_queue queue_name).message_count
+    ScenarioHelper.out 'RECEIVE_AND_DELETE second message, Message count: ' + message_count.to_s
+    message_count.must_equal expected_count # RECEIVE_AND_DELETE second message, count decrements
+
+    # Unlock and get the first message
+    subject.unlock_queue_message message1
+
+    message_count = (subject.get_queue queue_name).message_count
+    ScenarioHelper.out 'Unlocked first message, Message count: ' + message_count.to_s
+    message_count.must_equal expected_count # Unlocked first message, count stays the same
+
+    # Get the first unlocked message
+    message1again = subject.read_delete_queue_message queue_name
+    expected_count = expected_count - 1
+    # Should be the original, now that it is unlocked
+    ScenarioHelper.compare_messages expected_messages[0], message1again, exp_custom_props[0]
+
+    message_count = (subject.get_queue queue_name).message_count
+    ScenarioHelper.out 'got first message again, Message count: ' + message_count.to_s
+    message_count.must_equal expected_count # Got message one again (destructive), count should decrease
+
+    # Negative test, make sure unlocked messages cannot be deleted.
+    begin
+      subject.delete_queue_message message1again
+      flunk 'Deleting a RECEIVEANDDELETE messasge should fail'
+    rescue Azure::Core::Http::HTTPError => error
+      ScenarioHelper.out "As expected, could not delete a deleted message"
+      error.status_code.must_equal 400
+      error.type.must_equal "Unknown"
+    end
+
+    if expected_count > 0
+      # Get the third
+      message3 = subject.peek_lock_queue_message queue_name
+      ScenarioHelper.compare_messages expected_messages[2], message3, exp_custom_props[2]
+
+      message_count = (subject.get_queue queue_name).message_count
+      ScenarioHelper.out 'Got third message, Message count: ' + message_count.to_s
+      message_count.must_equal expected_count # Peeked third message, count should not change
+
+      # Delete it
+      subject.delete_queue_message message3.location
+      expected_count = expected_count - 1
+
+      message_count = (subject.get_queue queue_name).message_count
+      ScenarioHelper.out 'Deleted third message, Message count: ' + message_count.to_s
+      message_count.must_equal expected_count # Deleted third message, count decrements
+    end
+
+    if expected_count > 0
+      # Get the fourth
+      message4 = subject.read_delete_queue_message queue_name
+      expected_count = expected_count - 1
+      ScenarioHelper.compare_messages expected_messages[3], message4, exp_custom_props[3]
+
+      message_count = (subject.get_queue queue_name).message_count
+      ScenarioHelper.out 'Got fourth message, Message count: ' + message_count.to_s
+      message_count.must_equal expected_count # Got fourth message, count decrements
+    end
+
+    # Get the rest of the messages
+    message_id = 4
+    while expected_count > 0 && message_count > 0
+      message = subject.read_delete_queue_message queue_name
+      expected_count = expected_count - 1
+      ScenarioHelper.compare_messages expected_messages[message_id], message, exp_custom_props[message_id]
+
+      message_count = (subject.get_queue queue_name).message_count
+      ScenarioHelper.out 'Got message #' + message_id.to_s + ' message, Message count: ' + message_count.to_s
+      message_count.must_equal expected_count
+      message_id = message_id + 1
+    end
+
+    message_count = (subject.get_queue queue_name).message_count
+    ScenarioHelper.out 'Got all messages, Message count: ' + message_count.to_s
+    message_count.must_equal 0
+  end
+
+  it "should be able to upload many messages and read them back" do
+
+    setup_queue
+
+    messages = send_messages
+
+    get_message_from_queue messages
+  end
+end

data/test/integration/service_bus/queues_test.rb

@@ -0,0 +1,266 @@
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#--------------------------------------------------------------------------
+require "integration/test_helper"
+
+describe "ServiceBus Queues" do
+
+  subject { Azure::ServiceBus::ServiceBusService.new }
+  let(:name) { ServiceBusQueueNameHelper.name }
+  let(:name_alternative) { ServiceBusQueueNameHelper.name }
+  let(:description) {{
+    :default_message_time_to_live => 'P10675199DT2H48M5.4775807S',
+    :duplicate_detection_history_time_window => 'PT10M',
+    :dead_lettering_on_message_expiration => "false",
+    :lock_duration => 'PT30S',
+    :max_delivery_count => "10",
+    :max_size_in_megabytes => "1",
+    :requires_duplicate_detection => "true",
+    :requires_session => "false"
+  }}
+  let(:description_alternative) {{
+    :lock_duration => 'PT30S',
+    :max_size_in_megabytes => 2048,
+    :requires_duplicate_detection => true,
+    :requires_session => true,
+    :default_message_time_to_live => 'PT30M',
+    :dead_lettering_on_message_expiration => true,
+    :duplicate_detection_history_time_window => 'PT20M',
+    :max_delivery_count => 20,
+    :enable_batched_operations => true
+  }}
+
+  after { ServiceBusQueueNameHelper.clean }
+
+  it "should be able to create a new queue from a string" do
+    queue = subject.create_queue name
+    queue.must_be_kind_of Azure::ServiceBus::Queue
+    queue.name.must_equal name
+  end
+
+  it "should be able to create a new queue from a Queue" do
+    queue = subject.create_queue Azure::ServiceBus::Queue.new(name)
+    queue.must_be_kind_of Azure::ServiceBus::Queue
+    queue.name.must_equal name
+  end
+
+  it "should be able to create a new queue from a string and description Hash" do
+    queue = subject.create_queue name_alternative, description_alternative
+    queue.must_be_kind_of Azure::ServiceBus::Queue
+    queue.name.must_equal name_alternative
+
+    queue.lock_duration.must_equal 30.0
+    queue.max_size_in_megabytes.must_equal description_alternative[:max_size_in_megabytes]
+    queue.requires_duplicate_detection.must_equal description_alternative[:requires_duplicate_detection]
+    queue.requires_session.must_equal description_alternative[:requires_session]
+    queue.default_message_time_to_live.must_equal 1800.0
+    queue.dead_lettering_on_message_expiration.must_equal description_alternative[:dead_lettering_on_message_expiration]
+    queue.duplicate_detection_history_time_window.must_equal 1200.0
+    queue.max_delivery_count.must_equal description_alternative[:max_delivery_count]
+    queue.enable_batched_operations.must_equal description_alternative[:enable_batched_operations]
+  end
+
+  it "should be able to create a new queue from a Queue with a description Hash" do
+    queue = subject.create_queue Azure::ServiceBus::Queue.new(name_alternative, description_alternative)
+    queue.must_be_kind_of Azure::ServiceBus::Queue
+    queue.name.must_equal name_alternative
+
+    queue.lock_duration.must_equal 30.0
+    queue.max_size_in_megabytes.must_equal description_alternative[:max_size_in_megabytes]
+    queue.requires_duplicate_detection.must_equal description_alternative[:requires_duplicate_detection]
+    queue.requires_session.must_equal description_alternative[:requires_session]
+    queue.default_message_time_to_live.must_equal 1800.0
+    queue.dead_lettering_on_message_expiration.must_equal description_alternative[:dead_lettering_on_message_expiration]
+    queue.duplicate_detection_history_time_window.must_equal 1200.0
+    queue.max_delivery_count.must_equal description_alternative[:max_delivery_count]
+    queue.enable_batched_operations.must_equal description_alternative[:enable_batched_operations]
+  end
+
+  describe 'when a queue exists' do
+    before { subject.create_queue name }
+
+    describe '#delete_queue' do
+      it "should raise exception if the queue cannot be deleted" do
+        assert_raises(Azure::Core::Http::HTTPError) do
+          subject.delete_queue ServiceBusQueueNameHelper.name
+        end
+      end
+
+      it "should be able to delete the queue" do
+        response = subject.delete_queue name
+        response.must_equal nil
+      end
+    end
+
+    describe "#get_queue" do
+      it "should be able to get a queue by name" do
+        result = subject.get_queue name
+
+        result.must_be_kind_of Azure::ServiceBus::Queue
+        result.name.must_equal name
+      end
+
+      it "if the queue doesn't exists it should throw" do
+        assert_raises(Azure::Core::Http::HTTPError) do
+          subject.get_queue ServiceBusQueueNameHelper.name
+        end
+      end
+    end
+
+    describe 'when there are multiple queues' do
+      let(:name1) { ServiceBusQueueNameHelper.name }
+      let(:name2) { ServiceBusQueueNameHelper.name }
+      before { 
+        subject.create_queue name1
+        subject.create_queue name2
+      }
+      
+      it "should be able to get a list of queues" do
+        result = subject.list_queues
+
+        result.must_be :kind_of?, Array
+        q_found = false
+        q1_found = false
+        q2_found = false
+        result.each { |q|
+          q_found = true if q.name == name
+          q1_found = true if q.name == name1
+          q2_found = true if q.name == name2
+        }
+        assert (q_found and q1_found and q2_found), "list_queues did not return expected queues"
+      end
+
+      it "should be able to use $skip token with list_queues" do
+        result = subject.list_queues
+        result2 = subject.list_queues({ :skip => 1 })
+        result2.length.must_equal result.length - 1
+        result2[0].id.must_equal result[1].id
+      end
+      
+      it "should be able to use $top token with list_queues" do
+        result = subject.list_queues
+        result.length.wont_equal 1
+
+        result2 = subject.list_queues({ :top => 1 })
+        result2.length.must_equal 1
+      end
+
+      it "should be able to use $skip and $top token together with list_queues" do
+        result = subject.list_queues
+        result2 = subject.list_queues({ :skip => 1, :top => 1 })
+        result2.length.must_equal 1
+        result2[0].id.must_equal result[1].id
+      end
+    end
+
+    it "should be able to send a message to a queue" do
+      msg = Azure::ServiceBus::BrokeredMessage.new("some text") do |m|
+        m.to = "yo"
+      end
+      res = subject.send_queue_message name, msg
+      res.must_be_nil
+    end
+
+    describe "when the queue has messages" do
+      let(:messageContent) { 'messagecontent' }
+      let(:to) { 'yo' }
+      let(:label) { 'my_label' }
+      let(:properties) {{
+        "CustomDoubleProperty" => 3.141592,
+        "CustomInt32Property" => 37,
+        "CustomInt64Property" => 2**32,
+        "CustomInt64NegProperty" => -(2**32),
+        "CustomStringProperty" => "CustomPropertyValue",
+        "CustomDateProperty" => Time.now,
+        "CustomTrueProperty" => true,
+        "CustomFalseProperty" => false,
+        "CustomNilProperty" => nil,
+        "CustomJSONProperty" => "testingpa\n\"{}\\rtition"
+      }}
+      let(:msg) { m = Azure::ServiceBus::BrokeredMessage.new(messageContent, properties); m.to = 'me'; m }
+      
+      before { subject.send_queue_message name, msg }
+      
+      it "should be able to peek a message from a queue" do
+        retrieved = subject.peek_lock_queue_message name
+        retrieved.must_be :kind_of?, Azure::ServiceBus::BrokeredMessage
+
+        retrieved.body.must_equal msg.body
+        retrieved.to.must_equal msg.to
+        retrieved.label.must_equal msg.label
+
+        properties.each { |k,v|
+          unless properties[k].class == Time
+            retrieved.properties[k.downcase].must_equal properties[k]
+          else
+            # Time comes back as string as there is no good way to distinguish
+            retrieved.properties[k.downcase].to_s.must_equal properties[k].httpdate
+          end
+        }
+
+        refute retrieved.lock_token.nil?
+        refute retrieved.sequence_number.nil?
+      end
+
+      it "should be able to read-delete a message from a queue" do
+        retrieved = subject.read_delete_queue_message name
+
+        retrieved.must_be :kind_of?, Azure::ServiceBus::BrokeredMessage
+        retrieved.body.must_equal msg.body
+        retrieved.to.must_equal msg.to
+
+        # it should be deleted
+        retrieved = subject.read_delete_queue_message name, { :timeout => 2 }
+        retrieved.must_be_nil
+      end
+
+      it "should be able to unlock a message from a queue" do
+        retrieved = subject.peek_lock_queue_message name, { :timeout => 2 }
+
+        # There shouldn't be an available message in the queue
+        retrieved2 = subject.peek_lock_queue_message name, { :timeout => 2 }
+        retrieved2.must_be_nil
+
+        # Unlock the message
+        res = subject.unlock_queue_message retrieved
+        res.must_be_nil
+
+        # The message should be available once again
+        retrieved = subject.peek_lock_queue_message name, { :timeout => 2 }
+        retrieved.body.must_equal msg.body
+      end
+    
+      it "should be able to delete a message from a queue" do
+
+        retrieved = subject.peek_lock_queue_message name
+        retrieved.body.must_equal msg.body
+
+        subject.delete_queue_message retrieved
+
+        # it should be deleted
+        retrieved = subject.peek_lock_queue_message name, { :timeout => 2 }
+        assert_nil retrieved
+      end
+
+      it "should be able to read a message from a queue" do
+        subject.send_queue_message name, msg
+        retrieved = subject.receive_queue_message name
+
+        retrieved.must_be :kind_of?, Azure::ServiceBus::BrokeredMessage
+        retrieved.body.must_equal msg.body
+        retrieved.to.must_equal msg.to
+      end
+    end
+  end
+end