fake_sqs 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c424f4af6489d03024c8cc27bc894df0ffd8e065
-  data.tar.gz: 81d0da9ebe28dd1d47808d14f91f6a0d490d0bef
+  metadata.gz: 07cc7d69931207649b20dc94e4d3522023a4e110
+  data.tar.gz: 6c895b6844061cd9e054777cd19b369bccdca806
 SHA512:
-  metadata.gz: 6f8286741675fb8beb9e8206ce5102bc82183386c5ea2297917fb44e9d03ff876265c1dd3c0838717fd7b34496e4de31becb0e1a7f276c155ccbf8b3619cc2cb
-  data.tar.gz: f0f65a2c48b86beb6a935843cff6c37fe38148a4723add4176a5c24f264ca9afd1ff5b60054ee6ad97f5b48fb89d4e8e380470a40ff537d4a57ef816de75cd50
+  metadata.gz: e638d676fc1ba7cab88664b90bdbd5be94db189800e5507799e42fa546f99f7ee4f5a6d823673e54f86d69b1b6faa2788164304589e18e64063dcc12ef678b66
+  data.tar.gz: c6aebf4bffbe5d0f7a7fdc0025b4c121ff0f0fd01a4413d76e28f4575c3d156424d7a78a486a1cbfe87f142321e8dd100ac79390b20ad7abc01fe50ab2ed3434

data/.rspec

@@ -1,3 +1,3 @@
---format progress
+--format documentation
 --color
 --order random

data/README.md

@@ -55,6 +55,15 @@ To configure, see the options in the help:
 $ fake_sqs --help
 ```
 
+By default, FakeSQS uses an in-memory database (just a hash actually). To make
+it persistant, run with:
+
+```
+$ fake_sqs --database /path/to/database.yml
+```
+
+Messages are not persisted, just the queues.
+
 This is an example of how to configure the official [aws-sdk gem] [aws-sdk], to
 let it talk to Fake SQS.
 
@@ -146,6 +155,24 @@ describe "something with sqs", :sqs do
 end
 ```
 
+## Development
+
+Run all the specs:
+
+```
+$ rake
+```
+
+This will run the unit tests, then the acceptance tests for both types of
+storage (in-memory and on disk).
+
+When debugging an acceptance test, you can run it like this, which will redirect
+output to the console:
+
+```
+$ DEBUG=true SQS_DATABASE=tmp/sqs.yml rspec spec/acceptance
+```
+
 
   [fake_dynamo]: https://github.com/ananthakumaran/fake_dynamo
   [aws-sdk]: https://github.com/amazonwebservices/aws-sdk-for-ruby

data/Rakefile

@@ -1,6 +1,31 @@
 require "bundler/gem_tasks"
 
+require "tempfile"
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
+
+namespace :spec do
+
+  desc "Run only unit specs"
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern = "spec/unit"
+  end
+
+  desc "Run specs with in-memory database"
+  RSpec::Core::RakeTask.new(:memory) do |t|
+    ENV["SQS_DATABASE"] = ":memory:"
+    t.pattern = "spec/acceptance"
+  end
+
+  desc "Run specs with file database"
+  RSpec::Core::RakeTask.new(:file) do |t|
+    file = Tempfile.new(["rspec-sqs", ".yml"], encoding: "utf-8")
+    ENV["SQS_DATABASE"] = file.path
+    t.pattern = "spec/acceptance"
+  end
+
+end
+
+desc "Run spec suite with both in-memory and file"
+task :spec => ["spec:unit", "spec:memory", "spec:file"]
 
 task :default => :spec

data/bin/fake_sqs

@@ -6,15 +6,25 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fake_sqs'
 require 'optparse'
 
-options = { :port => 4568, :host => "0.0.0.0", :verbose => false, :daemonize => false }
+options = {
+  :port => 4568,
+  :host => "0.0.0.0",
+  :verbose => false,
+  :daemonize => false,
+  :database => ":memory:"
+}
 
 parser = OptionParser.new do |o|
 
+  o.on "--database DATABASE", "Where to store the database (default: #{options[:database]})" do |database|
+    options[:database] = database
+  end
+
   o.on "-p", "--port PORT", Integer, "Port to use (default: #{options[:port]})" do |port|
     options[:port] = port
   end
 
-  o.on "-o", "--bind HOST", "Host to bind to (default: 0.0.0.0)" do |host|
+  o.on "-o", "--bind HOST", "Host to bind to (default: #{options[:host]})" do |host|
     options[:host] = host
   end
 
@@ -30,10 +40,14 @@ parser = OptionParser.new do |o|
     options[:daemonize] = daemonize
   end
 
-  o.on "-v", "--[no]-verbose", "Shows input parameters and output XML" do |verbose|
+  o.on "-v", "--[no-]verbose", "Shows input parameters and output XML" do |verbose|
     options[:verbose] = verbose
   end
 
+  o.on "--log FILE", "Redirect output to this logfile (default: console)" do |logfile|
+    options[:log] = logfile
+  end
+
   o.on_tail "--version", "Shows the version" do
     puts "fake_sqs version #{FakeSQS::VERSION}"
     exit
@@ -48,34 +62,4 @@ end
 
 parser.parse!
 
-app = FakeSQS::WebInterface
-
-if options[:verbose]
-  require 'fake_sqs/show_output'
-  app.use FakeSQS::ShowOutput
-end
-
-if options[:daemonize]
-  Process.daemon(true, true)
-end
-
-if (pid = options[:pid])
-  if File.exist?(pid)
-    existing_pid = File.open(pid, 'r').read.chomp.to_i
-    running = Process.getpgid(existing_pid) rescue false
-    if running
-      warn "Error, Process #{existing_pid} already running"
-      exit 1
-    else
-      warn "Cleaning up stale pid at #{pid}"
-    end
-  end
-  File.open(pid, 'w') { |f| f.write(Process.pid) }
-end
-
-app.set :port, options[:port]
-app.set :bind, options[:host]
-app.set :server, options[:server] if options[:server]
-server = FakeSQS.server(port: options[:port], host: options[:host])
-app.set :api, FakeSQS.api(server: server)
-app.run!
+FakeSQS.to_rack(options).run!

data/lib/fake_sqs.rb

@@ -8,24 +8,56 @@ require 'fake_sqs/queues'
 require 'fake_sqs/responder'
 require 'fake_sqs/server'
 require 'fake_sqs/version'
-require 'fake_sqs/web_interface'
+require 'fake_sqs/memory_database'
+require 'fake_sqs/file_database'
 
 module FakeSQS
 
+  def self.to_rack(options)
+
+    require 'fake_sqs/web_interface'
+    app = FakeSQS::WebInterface
+
+    if (log = options[:log])
+      $stdout.reopen(log, "w:utf-8")
+      $stderr.reopen(log, "w:utf-8")
+      app.enable :logging
+    end
+
+    if options[:verbose]
+      require 'fake_sqs/show_output'
+      app.use FakeSQS::ShowOutput
+      app.enable :logging
+    end
+
+    if options[:daemonize]
+      require 'fake_sqs/daemonize'
+      Daemonize.new(options).call
+    end
+
+    app.set :port, options[:port] if options[:port]
+    app.set :bind, options[:host] if options[:host]
+    app.set :server, options[:server] if options[:server]
+    server = FakeSQS.server(port: options[:port], host: options[:host])
+    app.set :api, FakeSQS.api(server: server, database: options[:database])
+    app
+  end
+
   def self.server(options = {})
     Server.new(options)
   end
 
   def self.api(options = {})
+    db = database_for(options.fetch(:database) { ":memory:" })
     API.new(
       server: options.fetch(:server),
-      queues: queues,
+      queues: queues(db),
       responder: responder
     )
   end
 
-  def self.queues
-    Queues.new(queue_factory: queue_factory)
+  def self.queues(database)
+    Queues.new(queue_factory: queue_factory, database: database)
   end
 
   def self.responder
@@ -44,4 +76,12 @@ module FakeSQS
     Queue
   end
 
+  def self.database_for(name)
+    if name == ":memory:"
+      MemoryDatabase.new
+    else
+      FileDatabase.new(name)
+    end
+  end
+
 end

data/lib/fake_sqs/actions/set_queue_attributes.rb

@@ -17,6 +17,7 @@ module FakeSQS
           end
         end
         queue.add_queue_attributes(results)
+        @queues.save(queue)
         @responder.call :SetQueueAttributes
       end
 

data/lib/fake_sqs/api.rb

@@ -16,7 +16,7 @@ module FakeSQS
 
   class API
 
-    attr_reader :queues
+    attr_reader :queues, :options
 
     def initialize(options = {})
       @queues    = options.fetch(:queues)
@@ -25,7 +25,10 @@ module FakeSQS
 
     def call(action, *args)
       if FakeSQS::Actions.const_defined?(action)
-        FakeSQS::Actions.const_get(action).new(@options).call(*args)
+        action = FakeSQS::Actions.const_get(action).new(options)
+        queues.transaction do
+          action.call(*args)
+        end
       else
         fail InvalidAction, "Unknown (or not yet implemented) action: #{action}"
       end

data/lib/fake_sqs/daemonize.rb

@@ -0,0 +1,30 @@
+module FakeSQS
+  class Daemonize
+
+    attr_reader :pid
+
+    def initialize(options)
+      @pid = options.fetch(:pid) {
+        warn "No PID file specified while daemonizing!"
+        exit 1
+      }
+    end
+
+    def call
+      Process.daemon(true, true)
+
+      if File.exist?(pid)
+        existing_pid = File.open(pid, 'r').read.chomp.to_i
+        running = Process.getpgid(existing_pid) rescue false
+        if running
+          warn "Error, Process #{existing_pid} already running"
+          exit 1
+        else
+          warn "Cleaning up stale pid at #{pid}"
+        end
+      end
+      File.open(pid, 'w') { |f| f.write(Process.pid) }
+    end
+
+  end
+end

data/lib/fake_sqs/file_database.rb

@@ -0,0 +1,83 @@
+require "yaml/store"
+
+module FakeSQS
+  class FileDatabase
+
+    attr_reader :filename
+
+    def initialize(filename)
+      @filename = filename
+      @queue_objects = {}
+    end
+
+    def load
+      transaction do
+        store["queues"] ||= {}
+      end
+    end
+
+    def transaction
+      store.transaction do
+        yield
+      end
+    end
+
+    def reset
+      transaction do
+        store["queues"] = {}
+      end
+      @queue_objects = {}
+    end
+
+    def []=(key, value)
+      storage[key] = value.to_yaml
+    end
+
+    def [](key)
+      value = storage[key]
+      if value
+        deserialize(key)
+      else
+        value
+      end
+    end
+
+    def each(&block)
+      storage.each do |key, value|
+        yield key, deserialize(key)
+      end
+    end
+
+    def select(&block)
+      new_list = storage.select do |key, value|
+        yield key, deserialize(key)
+      end
+      Hash[new_list.map { |key, value| [key, deserialize(key)] }]
+    end
+
+    def delete(key)
+      storage.delete(key)
+    end
+
+    def values
+      storage.map { |key, value|
+        deserialize(key)
+      }
+    end
+
+    private
+
+    def deserialize(key)
+      @queue_objects[key] ||= Queue.new(storage[key].merge(message_factory: Message))
+    end
+
+    def storage
+      store["queues"]
+    end
+
+    def store
+      @store ||= YAML::Store.new(filename)
+    end
+
+  end
+end

data/lib/fake_sqs/memory_database.rb

@@ -0,0 +1,36 @@
+require "forwardable"
+
+module FakeSQS
+  class MemoryDatabase
+    extend Forwardable
+
+    def_delegators :@queues,
+      :[], :[]=, :delete, :each, :select, :values
+
+    def initialize
+      @in_transaction = false
+    end
+
+    def load
+      @queues = {}
+    end
+
+    def transaction
+      if @in_transaction
+        raise "Already in transaction"
+      else
+        @in_transaction = true
+        begin
+          yield
+        ensure
+          @in_transaction = false
+        end
+      end
+    end
+
+    def reset
+      @queues = {}
+    end
+
+  end
+end

data/lib/fake_sqs/message.rb

@@ -3,18 +3,20 @@ require 'securerandom'
 module FakeSQS
   class Message
 
-    attr_reader :body
+    attr_reader :body, :id, :md5
 
     def initialize(options = {})
       @body = options.fetch("MessageBody")
+      @id = options.fetch("Id") { SecureRandom.uuid }
+      @md5 = options.fetch("MD5") { Digest::MD5.hexdigest(@body) }
     end
 
-    def id
-      @id ||= SecureRandom.uuid
-    end
-
-    def md5
-      @md5 ||= Digest::MD5.hexdigest(body)
+    def attributes
+      {
+        "MessageBody" => body,
+        "Id" => id,
+        "MD5" => md5,
+      }
     end
 
   end

data/lib/fake_sqs/queue.rb

@@ -6,22 +6,31 @@ module FakeSQS
 
   class Queue
 
-    attr_reader :name, :messages, :message_factory, :messages_in_flight, :arn
+    attr_reader :name, :messages, :message_factory, :messages_in_flight, :arn, :queue_attributes
 
     def initialize(options = {})
-      @name = options.fetch("QueueName")
       @message_factory = options.fetch(:message_factory)
-      @arn = "arn:aws:sqs:us-east-1:#{SecureRandom.hex}:#{@name}"
-      @queue_attributes = {}
+
+      @name = options.fetch("QueueName")
+      @arn = options.fetch("Arn") { "arn:aws:sqs:us-east-1:#{SecureRandom.hex}:#{@name}" }
+      @queue_attributes = options.fetch("Attributes") { {} }
       reset
     end
 
+    def to_yaml
+      {
+        "QueueName"        => name,
+        "Arn"              => arn,
+        "Attributes"       => queue_attributes,
+      }
+    end
+
     def add_queue_attributes(attrs)
-      @queue_attributes.merge!(attrs)
+      queue_attributes.merge!(attrs)
     end
 
     def attributes
-      @queue_attributes.merge(
+      queue_attributes.merge(
         "QueueArn" => arn,
         "ApproximateNumberOfMessages" => messages.size,
         "ApproximateNumberOfMessagesNotVisible" => messages_in_flight.size,

data/lib/fake_sqs/queues.rb

@@ -5,25 +5,26 @@ module FakeSQS
 
   class Queues
 
-    attr_reader :queues, :queue_factory
+    attr_reader :queue_factory, :database
 
     def initialize(options = {})
       @queue_factory = options.fetch(:queue_factory)
-      reset
+      @database = options.fetch(:database)
+      @database.load
     end
 
     def create(name, options = {})
-      if queues[name]
+      if database[name]
         fail QueueNameExists, name
       else
         queue = queue_factory.new(options)
-        queues[name] = queue
+        database[name] = queue
       end
     end
 
     def delete(name, options = {})
-      if queues[name]
-        queues.delete(name)
+      if database[name]
+        database.delete(name)
       else
         fail NonExistentQueue, name
       end
@@ -31,26 +32,38 @@ module FakeSQS
 
     def list(options = {})
       if (prefix = options["QueueNamePrefix"])
-        queues.select { |name, queue| name =~ /^#{prefix}/ }.values
+        database.select { |name, queue| name.start_with?(prefix) }.values
       else
-        queues.values
+        database.values
       end
     end
 
     def get(name, options = {})
-      if queues[name]
-        queues[name]
+      if (db = database[name])
+        db
       else
         fail NonExistentQueue, name
       end
     end
 
+    def transaction
+      database.transaction do
+        yield
+      end
+    end
+
+    def save(queue)
+      database[queue.name] = queue
+    end
+
     def reset
-      @queues = {}
+      database.reset
     end
 
     def expire
-      queues.each { |name, queue| queue.expire }
+      transaction do
+        database.each { |name, queue| queue.expire }
+      end
     end
 
   end

data/lib/fake_sqs/test_integration.rb

@@ -23,7 +23,8 @@ module FakeSQS
     end
 
     def start!
-      @pid = Process.spawn(binfile, "-p", port.to_s, :out => out, :err => out)
+      args = [ binfile, "-p", port.to_s, verbose, logging, "--database", database, { :out => out, :err => out } ].flatten.compact
+      @pid = Process.spawn(*args)
       wait_until_up
     end
 
@@ -61,6 +62,25 @@ module FakeSQS
       options.fetch(key) { AWS.config.public_send(key) }
     end
 
+    def database
+      options.fetch(:database)
+    end
+
+    def verbose
+      if debug?
+        "--verbose"
+      else
+        "--no-verbose"
+      end
+    end
+
+    def logging
+      if (file = ENV["SQS_LOG"] || options[:log])
+        [ "--log", file ]
+      else
+        []
+      end
+    end
 
     def wait_until_up(deadline = Time.now + 2)
       fail "FakeSQS didn't start in time" if Time.now > deadline
@@ -87,7 +107,7 @@ module FakeSQS
     end
 
     def debug?
-      ENV["DEBUG"].to_s == "true"
+      ENV["DEBUG"].to_s == "true" || options[:debug]
     end
 
   end

data/lib/fake_sqs/version.rb

@@ -1,3 +1,3 @@
 module FakeSQS
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/spec/spec_helper.rb

@@ -9,13 +9,15 @@ AWS.config(
   :secret_access_key => "fake secret key",
 )
 
-$fake_sqs = FakeSQS::TestIntegration.new
+db = ENV["SQS_DATABASE"] || ":memory:"
+puts "\n\e[34mRunning specs with database \e[33m#{db}\e[0m"
+$fake_sqs = FakeSQS::TestIntegration.new(database: db)
 
 RSpec.configure do |config|
 
   config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.before(:suite) { $fake_sqs = FakeSQS::TestIntegration.new }
   config.before(:each, :sqs) { $fake_sqs.start }
+  config.before(:each, :sqs) { $fake_sqs.reset }
   config.after(:suite) { $fake_sqs.stop }
 
 end

data/spec/unit/api_spec.rb

@@ -15,11 +15,13 @@ end
 describe FakeSQS::API do
 
   it "delegates actions to classes" do
-    api = FakeSQS::API.new(:queues => [])
+    queues = double :queues
+    allow(queues).to receive(:transaction).and_yield
+    api = FakeSQS::API.new(:queues => queues)
 
     response = api.call("TheAction", {:foo => "bar"})
 
-    response[:options].should eq :queues => []
+    response[:options].should eq :queues => queues
     response[:params].should eq :foo => "bar"
   end
 

data/spec/unit/queues_spec.rb

@@ -1,16 +1,18 @@
 require 'fake_sqs/queues'
+require 'fake_sqs/memory_database'
 
 describe FakeSQS::Queues do
 
+  let(:fake_database) { FakeSQS::MemoryDatabase.new }
   let(:queue_factory) { double :queue_factory, :new => double }
-  subject(:queues) { FakeSQS::Queues.new(queue_factory: queue_factory) }
+  subject(:queues) { FakeSQS::Queues.new(queue_factory: queue_factory, database: fake_database) }
 
   describe "#create" do
 
     it "creates new queues" do
-      queues.should have(0).queues
+      queues.list.size.should eq 0
       create_queue("test")
-      queues.should have(1).queues
+      queues.list.size.should eq 1
     end
 
     it "uses the queue factory" do
@@ -38,9 +40,9 @@ describe FakeSQS::Queues do
 
     it "deletes an existing queue" do
       create_queue("test")
-      queues.should have(1).queues
+      queues.list.size.should eq 1
       queues.delete("test")
-      queues.should have(0).queues
+      queues.list.size.should eq 0
     end
 
     it "cannot delete an non-existing queue" do
@@ -62,7 +64,7 @@ describe FakeSQS::Queues do
     it "can be filtered by prefix" do
       queue1 = create_queue("test-1")
       queue2 = create_queue("test-2")
-      queue3 = create_queue("other-3")
+      _ = create_queue("other-3")
       queues.list("QueueNamePrefix" => "test").should eq [ queue1, queue2 ]
     end
 
@@ -88,9 +90,9 @@ describe FakeSQS::Queues do
     it "clears all queues" do
       create_queue("foo")
       create_queue("bar")
-      queues.should have(2).queues
+      queues.list.size.should eq 2
       queues.reset
-      queues.should have(0).queues
+      queues.list.size.should eq 0
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fake_sqs
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - iain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-15 00:00:00.000000000 Z
+date: 2013-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -167,8 +167,11 @@ files:
 - lib/fake_sqs/actions/set_queue_attributes.rb
 - lib/fake_sqs/api.rb
 - lib/fake_sqs/catch_errors.rb
+- lib/fake_sqs/daemonize.rb
 - lib/fake_sqs/error_response.rb
 - lib/fake_sqs/error_responses.yml
+- lib/fake_sqs/file_database.rb
+- lib/fake_sqs/memory_database.rb
 - lib/fake_sqs/message.rb
 - lib/fake_sqs/queue.rb
 - lib/fake_sqs/queue_factory.rb