glint 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81f0eee87a5a44a32801d9146415bc2389bb15a2
+  data.tar.gz: 5d3b67a57c0b799140b04d10b60e2dd76f9062b9
+SHA512:
+  metadata.gz: e13fc5620882e3aada1251aba79fdc8f091d9115c38b1d82f2efbfd514ca32da23b90fba72a54fffa2bcd17b4be1742b66db9e6c3d74d063636dad123e815baf
+  data.tar.gz: b5d7c8e28415b7eb30d9d8850bbdc7923d74ea327d4ffe797d7ad363937c596600afccb76b97d5a913ab9b5c5a7cb4eba7f1248553ad6426e3e796ef65d4bb48

data/.travis.yml

@@ -4,4 +4,3 @@ rvm:
   - 1.9.3
   - 1.9.2
   - ruby-head
-  - rbx-19mode

data/README.md

@@ -4,7 +4,7 @@ Glint is a library which allows you to fire arbitrary TCP server processes progr
 
 It's useful when you want to test your code against real TCP server processes.
 
-## Usage
+## Synopsis
 
 ```ruby
 server = Glint::Server.new do |port|
@@ -21,6 +21,42 @@ exit
 # The process executed above will be shutdown here.
 ```
 
+## Methods
+
+### Glint::Server
+
+#### Glint::Server.info
+
+server.rb:
+
+```
+server = Glint::Server.new do |port|
+  exec 'memcached', '-p', port.to_s;
+  exit 0
+end
+server.start
+
+Glint::Server.info[:memcached] = "127.0.0.1:#{server.port}"
+```
+
+client.rb:
+
+```
+client = Dalli::Client.new(Glint::Server.info[:memcached])
+```
+
+`Glint::Server.info` is used to store server info globally which is retrieved and utilized by client later. It's useful when server and client codes are not in the same code.
+
+#### Glint::Server#start
+
+```
+server = Glint::Server.new do |port|
+  exec 'memcached', '-p', port.to_s;
+  exit 0
+end
+server.start
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/examples/memcached/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'dalli'
+gem 'rake'
+gem 'rspec'

data/examples/memcached/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.ruby_opts = %w[-w]
+end
+
+task :default => :spec

data/examples/memcached/spec/lib/bar_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'bar' do
+  include_context 'memcached'
+  before { client.set('test_bar', 'value') }
+  it { expect(client.get('test_bar')).to be == 'value' }
+end

data/examples/memcached/spec/lib/baz_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'baz' do
+  include_context 'memcached'
+  before { client.set('test_baz', 'value') }
+  it { expect(client.get('test_baz')).to be == 'value' }
+end

data/examples/memcached/spec/lib/foo_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'foo' do
+  include_context 'memcached'
+
+  before {
+    client.set('test_foo', 'value')
+  }
+
+  it {
+    expect(client.get('test_foo')).to be == 'value'
+  }
+end

data/examples/memcached/spec/servers/memcached.rb

@@ -0,0 +1,8 @@
+server = Glint::Server.new do |port|
+  exec 'memcached', '-p', port.to_s;
+  exit 0
+end
+server.on_stopped = ->(s) { puts 'memcached stopped!' }
+server.start
+
+Glint::Server.info[:memcached] = "127.0.0.1:#{server.port}"

data/examples/memcached/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift '../../lib'
+
+require 'glint'
+Dir[File.expand_path("../servers/*.rb", __FILE__)].each do |f|
+  require f
+end
+
+require 'rspec'
+shared_context 'memcached' do
+  require 'dalli'
+  let(:client) {
+    Dalli::Client.new(Glint::Server.info[:memcached])
+  }
+end

data/examples/redis/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'redis'
+gem 'rake'
+gem 'rspec'

data/examples/redis/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.ruby_opts = %w[-w]
+end
+
+task :default => :spec

data/examples/redis/spec/lib/bar_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'bar' do
+  include_context 'redis'
+  before { client.set('test_bar', 'value') }
+  it { expect(client.get('test_bar')).to be == 'value' }
+end

data/examples/redis/spec/lib/baz_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'baz' do
+  include_context 'redis'
+  before { client.set('test_baz', 'value') }
+  it { expect(client.get('test_baz')).to be == 'value' }
+end

data/examples/redis/spec/lib/foo_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'foo' do
+  include_context 'redis'
+  before { client.set('test_foo', 'value') }
+  it { expect(client.get('test_foo')).to be == 'value' }
+end

data/examples/redis/spec/servers/redis.rb

@@ -0,0 +1,12 @@
+server = Glint::Server.new do |port|
+  # `--port` option is available since version 2.6
+  exec 'redis-server', '--port', port.to_s
+  exit 0
+end
+server.on_stopped = ->(s) { puts 'redis stopped!' }
+server.start
+
+Glint::Server.info[:redis] = {
+  host: "127.0.0.1",
+  port: server.port,
+}

data/examples/redis/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift '../../lib'
+
+require 'glint'
+Dir[File.expand_path("../servers/*.rb", __FILE__)].each {|f| require f}
+
+require 'rspec'
+shared_context 'redis' do
+  require 'redis'
+  let(:client) {
+    Redis.new(
+      host: Glint::Server.info[:redis][:host],
+      port: Glint::Server.info[:redis][:port]
+    )
+  }
+end
+
+RSpec.configure do |config|
+end

data/lib/glint/server.rb

@@ -1,8 +1,13 @@
 require_relative 'util.rb'
+require "timeout"
 
 module Glint
   class Server
-    attr_accessor :port, :block, :pid, :child_pid
+    attr_accessor :port, :block, :pid, :child_pid, :on_stopped
+
+    def self.info
+      @@info ||= {}
+    end
 
     def initialize(port = nil, opts = {}, &block)
       unless block_given?
@@ -10,6 +15,7 @@ module Glint
       end
 
       @port  = port || Util.empty_port
+      @opts  = { timeout: 1, signals: [:TERM, :INT, :KILL] }.merge(opts)
       @block = block
       @pid   = Process.pid
 
@@ -23,13 +29,22 @@ module Glint
       end
 
       Util.wait_port(port)
+      self
     end
 
     def stop
       if pid == Process.pid && child_pid
-        Process.kill(:TERM, child_pid)
-        Process.waitpid(child_pid)
+        signals = @opts[:signals].clone
+        begin
+          Process.kill(signals.shift, child_pid)
+          timeout(@opts[:timeout]) do
+            Process.waitpid(child_pid)
+          end
+        rescue Timeout::Error => e
+          retry
+        end
         self.child_pid = nil
+        on_stopped && on_stopped.call(self)
       end
     end
   end

data/lib/glint/version.rb

@@ -1,3 +1,3 @@
 module Glint
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/glint/server_spec.rb

@@ -2,6 +2,26 @@ require_relative '../../spec_helper'
 
 module Glint
   describe Server do
+    describe '.info' do
+      context 'when no info set' do
+        it { expect(Glint::Server.info).to be == {} }
+      end
+
+      context 'when a value via the method' do
+        before {
+          Glint::Server.info['foo'] = 'bar'
+          Glint::Server.info['baz'] = 'qux'
+        }
+
+        it {
+          expect(Glint::Server.info).to be == {
+            'foo' => 'bar',
+            'baz' => 'qux',
+          }
+        }
+      end
+    end
+
     describe '.new' do
       context 'when block is given' do
         context 'and a port is passed in' do
@@ -50,14 +70,75 @@ module Glint
           exec File.expand_path("../../../bin/server.rb", __FILE__), port.to_s
         end
       }
-      before { server.start }
 
       it {
+        expect(server.start).to equal(server)
         expect(server.child_pid).to be_true
       }
     end
 
     describe '#stop' do
+      context "when normal process" do
+        let(:server) {
+          server = Glint::Server.new do |port|
+            exec File.expand_path("../../../bin/server.rb", __FILE__), port.to_s
+          end
+          server.start
+          server
+        }
+        let(:child_pid) { server.child_pid }
+
+        before { server.stop }
+
+        it {
+          expect(server.child_pid).to be_nil
+        }
+      end
+
+      context "when process which traps SIGTERM" do
+        let(:server) {
+          server = Glint::Server.new(nil, { timeout: 0.1 }) do |port|
+            require "socket"
+            Signal.trap(:SIGTERM) { }
+            server = TCPServer.new(port)
+            1 while server.accept
+          end
+          server.start
+          server
+        }
+        let(:child_pid) { server.child_pid }
+
+        before { server.stop }
+
+        it {
+          expect(server.child_pid).to be_nil
+        }
+      end
+
+      context "when process which traps SIGTERM and SIGINT" do
+        let(:server) {
+          server = Glint::Server.new(nil, { timeout: 0.1 }) do |port|
+            require "socket"
+            Signal.trap(:SIGTERM) { }
+            Signal.trap(:SIGINT) { }
+            server = TCPServer.new(port)
+            1 while server.accept
+          end
+          server.start
+          server
+        }
+        let(:child_pid) { server.child_pid }
+
+        before { server.stop }
+
+        it {
+          expect(server.child_pid).to be_nil
+        }
+      end
+    end
+
+    describe '#on_stopped' do
+      let!(:result) { false }
       let(:server) {
         server = Glint::Server.new do |port|
           exec File.expand_path("../../../bin/server.rb", __FILE__), port.to_s
@@ -65,13 +146,29 @@ module Glint
         server.start
         server
       }
-      let(:child_pid) { server.child_pid }
 
-      before { server.stop }
+      context 'when `on_stopped` is set' do
+        before {
+          server.on_stopped = ->(s) {
+            s.instance_variable_set(:@_stopped, true)
+          }
+          server.stop
+        }
 
-      it {
-        expect(server.child_pid).to be_nil
-      }
+        it {
+          expect(server.instance_variable_get(:@_stopped)).to be true
+        }
+      end
+
+      context 'when `on_stopped` is not set' do
+        before {
+          server.stop
+        }
+
+        it {
+          expect(server.instance_variable_get(:@_stopped)).to be nil
+        }
+      end
     end
   end
 end

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: glint
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Kentaro Kuribayashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-17 00:00:00.000000000 Z
+date: 2014-01-10 00:00:00.000000000 Z
 dependencies:
 - !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
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -57,6 +52,20 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/memcached/Gemfile
+- examples/memcached/Rakefile
+- examples/memcached/spec/lib/bar_spec.rb
+- examples/memcached/spec/lib/baz_spec.rb
+- examples/memcached/spec/lib/foo_spec.rb
+- examples/memcached/spec/servers/memcached.rb
+- examples/memcached/spec/spec_helper.rb
+- examples/redis/Gemfile
+- examples/redis/Rakefile
+- examples/redis/spec/lib/bar_spec.rb
+- examples/redis/spec/lib/baz_spec.rb
+- examples/redis/spec/lib/foo_spec.rb
+- examples/redis/spec/servers/redis.rb
+- examples/redis/spec/spec_helper.rb
 - glint.gemspec
 - lib/glint.rb
 - lib/glint/server.rb
@@ -69,30 +78,26 @@ files:
 homepage: http://github.com/kentaro/glint
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1775963593609715634
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Firebombs arbitrary server processs for tests.
 test_files:
 - spec/bin/server.rb