http_server_manager 0.0.1

data/lib/http_server_manager/rake/server_tasks.rb

@@ -0,0 +1,30 @@
+require 'rake/tasklib' unless defined? (::Rake::TaskLib)
+
+module HttpServerManager
+
+  module Rake
+
+    class ServerTasks < ::Rake::TaskLib
+
+      def initialize(server)
+        desc "Starts a #{server.name} as a background process"
+        task :start do
+          server.start!
+        end
+
+        desc "Stops a running #{server.name}"
+        task :stop do
+          server.stop!
+        end
+
+        desc "Displays the status of a #{server.name} process"
+        task :status do
+          puts "#{server.name} is #{server.status}"
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/http_server_manager/rake/task_generators.rb

@@ -0,0 +1,3 @@
+require 'rake'
+
+require_relative 'server_tasks'

data/lib/http_server_manager/server.rb

@@ -0,0 +1,83 @@
+module HttpServerManager
+
+  class Server
+
+    attr_reader :name, :port
+
+    def initialize(options)
+      @name = options[:name]
+      @port = options[:port]
+      @deletable_artifacts = [pid_file_path]
+    end
+
+    def start!
+      if running?
+        logger.info "#{@name} already running on port #{@port}"
+      else
+        ensure_directories_exist
+        pid = Process.spawn(start_command, { [:out, :err] => [log_file_path, "w"] })
+        create_pid_file(pid)
+        Wait.until_true!("#{@name} is running") { running? }
+        logger.info "#{@name} started on port #{@port}"
+      end
+    end
+
+    def stop!
+      if running?
+        Process.kill_tree(9, current_pid)
+        FileUtils.rm_f(@deletable_artifacts)
+        logger.info "#{@name} stopped"
+      else
+        logger.info "#{@name} not running"
+      end
+    end
+
+    def status
+      running? ? :started : :stopped
+    end
+
+    def to_s
+      "#{@name} on port #{@port}"
+    end
+
+    private
+
+    def running?
+      !!Net::HTTP.get_response("localhost", "/", @port) rescue false
+    end
+
+    def current_pid
+      File.exists?(pid_file_path) ? File.read(pid_file_path).to_i : nil
+    end
+
+    def pid_file_path
+      File.join(pid_dir, "#{@name}.pid")
+    end
+
+    def create_pid_file(pid)
+      File.open(pid_file_path, "w") { |file| file.write(pid) }
+    end
+
+    def log_file_path
+      File.join(log_dir, "#{@name}_console.log")
+    end
+
+    def ensure_directories_exist
+      FileUtils.mkdir_p([pid_dir, log_dir])
+    end
+
+    def pid_dir
+      HttpServerManager.pid_dir
+    end
+
+    def log_dir
+      HttpServerManager.log_dir
+    end
+
+    def logger
+      HttpServerManager.logger
+    end
+
+  end
+
+end

data/lib/http_server_manager/stdout_logger.rb

@@ -0,0 +1,11 @@
+module HttpServerManager
+
+  class StdOutLogger
+
+    def info(message)
+      puts message
+    end
+
+  end
+
+end

data/lib/http_server_manager/version.rb

@@ -0,0 +1,3 @@
+module HttpServerManager
+  VERSION = "0.0.1"
+end

data/lib/http_server_manager.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require(:default)
+
+require 'net/http'
+require 'sys/proctree'
+require 'wait_until'
+
+require_relative 'http_server_manager/stdout_logger'
+
+module HttpServerManager
+
+  class << self
+
+    attr_accessor :logger, :pid_dir, :log_dir
+
+    def logger
+      @logger || HttpServerManager::StdOutLogger.new
+    end
+
+  end
+
+end
+
+require_relative 'http_server_manager/server'

data/spec/lib/http_server_manager/rake/server_tasks_integration_spec.rb

@@ -0,0 +1,61 @@
+describe HttpServerManager::Rake::ServerTasks do
+  include_context "server integration utilities"
+  include ::Rake::DSL
+
+  before(:all) do
+    namespace :rack_server do
+      server_tasks
+    end
+  end
+
+  describe "start task" do
+
+    let(:task) { ::Rake::Task["rack_server:start"] }
+
+    after(:each) { force_stop! }
+
+    it "should start a stopped server" do
+      task.execute
+
+      wait_until_started!
+    end
+
+  end
+
+  describe "stop task" do
+
+    let(:task) { ::Rake::Task["rack_server:stop"] }
+
+    before(:each) { force_start! }
+
+    after(:each) { force_stop! } # Ensure server has completely stopped
+
+    it "should stop a started server" do
+      task.execute
+
+      wait_until_stopped!
+    end
+
+  end
+
+  describe "status task" do
+
+    let(:task) { ::Rake::Task["rack_server:status"] }
+
+    it "should write the server name and it's status to stdout" do
+      server_tasks.should_receive(:puts).with("rack_server is stopped")
+
+      task.execute
+    end
+
+  end
+
+  def server_tasks
+    @server_tasks ||= HttpServerManager::Rake::ServerTasks.new(server)
+  end
+
+  def server
+    @server ||= RackServer.new(port: 4001)
+  end
+
+end

data/spec/lib/http_server_manager/server_integration_spec.rb

@@ -0,0 +1,169 @@
+describe HttpServerManager::Server do
+  include_context "server integration utilities"
+
+  let(:server) { RackServer.new(port: 4001) }
+
+  describe "#start!" do
+
+    after(:each) { force_stop! }
+
+    describe "when the server is not running" do
+
+      after(:each) { wait_until_started! } # Ensure server has completely started
+
+      it "should start the server via the provided command" do
+        server.start!
+
+        wait_until_started!
+      end
+
+      it "should create a pid file for the server in the configured pid directory" do
+        server.start!
+
+        ::Wait.until_true!("rack server pid created") { pid_file_exists? }
+      end
+
+      it "should create a log file capturing the stdout and stderr of the server in the configured log directory" do
+        server.start!
+
+        ::Wait.until_true!("log file is created") do
+          File.exists?("#{log_dir}/rack_server_console.log")
+        end
+      end
+
+      it "should log that the server started on the configured port" do
+        logger.should_receive(:info).with(/started on port 4001/)
+
+        server.start!
+      end
+
+    end
+
+    describe "when the server is already running" do
+
+      before(:each) do
+        server.start!
+        wait_until_started!
+      end
+
+      it "should log that the server is already running on the configured port" do
+        logger.should_receive(:info).with(/already running on port 4001/)
+
+        server.start!
+      end
+
+    end
+
+  end
+
+  describe "#stop!" do
+
+    describe "when the server is running" do
+
+      before(:each) { force_start! }
+
+      after(:each) { force_stop! } # Ensure server has completely stopped
+
+      it "should stop the server" do
+        server.stop!
+
+        wait_until_stopped!
+      end
+
+      it "should delete the servers pid file" do
+        server.stop!
+
+        ::Wait.until_false!("rack server pid is deleted") do
+          File.exists?("#{pid_dir}/rack_server.pid")
+        end
+      end
+
+      it "should log that the server has stopped" do
+        logger.should_receive(:info).with(/stopped/)
+
+        server.stop!
+      end
+
+    end
+
+    describe "when the server is not running" do
+
+      it "should log that the server is not running" do
+        logger.should_receive(:info).with(/not running/)
+
+        server.stop!
+      end
+
+    end
+
+  end
+
+  describe "#status" do
+
+    describe "when the server is running" do
+
+      before(:each) { force_start! }
+
+      after(:each) { force_stop! }
+
+      describe "and the pid file exists" do
+
+        it "should return :started" do
+          server.status.should eql(:started)
+        end
+
+      end
+
+      describe "and the pid file does not exist" do
+
+        before(:each) { force_pid_file_deletion! }
+
+        after(:each) { restore_pid_file! }
+
+        it "should return :started" do
+          server.status.should eql(:started)
+        end
+
+      end
+
+    end
+
+    describe "when the server is not running" do
+
+      describe "and the pid file does not exist" do
+
+        it "should return :stopped" do
+          server.status.should eql(:stopped)
+        end
+
+      end
+
+      describe "and the pid file exists" do
+
+        before(:each) { force_pid_file_creation! }
+
+        after(:each) { force_pid_file_deletion! }
+
+        it "should return :stopped" do
+          server.status.should eql(:stopped)
+        end
+
+      end
+
+    end
+
+  end
+
+  describe "#to_s" do
+
+    it "should return a string containing the servers name" do
+      server.to_s.should match(/rack_server/)
+    end
+
+    it "should return a string containing the servers port" do
+      server.to_s.should match(/4001/)
+    end
+
+  end
+
+end

data/spec/lib/http_server_manager/stdout_logger_spec.rb

@@ -0,0 +1,16 @@
+describe HttpServerManager::StdOutLogger do
+
+  let(:logger) { HttpServerManager::StdOutLogger.new }
+
+  describe "#info" do
+
+    it "should write the message to stdout" do
+      message = "Some message"
+      logger.should_receive(:puts).with(message)
+
+      logger.info message
+    end
+
+  end
+
+end

data/spec/lib/http_server_manager_spec.rb

@@ -0,0 +1,31 @@
+describe HttpServerManager do
+
+  describe ".logger" do
+
+    describe "when no logger has been explicitly configured" do
+
+      before(:each) { HttpServerManager.logger = nil }
+
+      it "should default to the stdout logger" do
+        HttpServerManager.logger.should be_a(HttpServerManager::StdOutLogger)
+      end
+
+    end
+
+    describe "when a logger has been explicitly configured" do
+
+      let(:logger) { double("Logger").as_null_object }
+
+      before(:each) { HttpServerManager.logger = logger }
+
+      after(:each) { HttpServerManager.logger = nil }
+
+      it "should return the configured logger" do
+        HttpServerManager.logger.should eql(logger)
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+  minimum_coverage 100
+  refuse_coverage_drop
+end if ENV["coverage"]
+
+require_relative '../lib/http_server_manager'
+require_relative '../lib/http_server_manager/rake/task_generators'
+
+module HttpServerManager
+
+  def self.root
+    @root ||= File.expand_path("../../../", __FILE__)
+  end
+
+end
+
+require_relative 'support/http_server_manager/test/silent_logger'
+HttpServerManager.logger = HttpServerManager::Test::SilentLogger
+HttpServerManager.pid_dir = "#{HttpServerManager.root}/tmp/pids"
+HttpServerManager.log_dir = "#{HttpServerManager.root}/tmp/logs"
+
+Bundler.require(:test)
+
+require_relative '../examples/rack_server'
+
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |file| require file }

data/spec/support/http_server_manager/test/server_integration_utilities.rb

@@ -0,0 +1,99 @@
+module HttpServerManager
+
+  module Test
+
+    module ServerIntegrationUtilities
+
+      def force_start!
+        server.start!
+        wait_until_started!
+      end
+
+      alias_method :force_server_start!, :force_start!
+
+      def force_stop!
+        server.stop!
+        wait_until_stopped!
+      end
+
+      alias_method :force_server_stop!, :force_stop!
+
+      def force_pid_file_creation!
+        File.open(pid_file_path, "w") { |file| file.write "0" }
+        wait_until_file_exists!(pid_file_path)
+      end
+
+      def force_pid_file_deletion!
+        FileUtils.rm_f(pid_file_path)
+        ::Wait.until_false!("#{pid_file_path} is deleted") { pid_file_exists? }
+      end
+
+      def restore_pid_file!
+        FileUtils.cp(pid_file_backup_path, pid_file_path)
+        wait_until_file_exists!(pid_file_path)
+      end
+
+      def wait_until_started!
+        ::Wait.until_true!("#{server.name} starts") do
+          !!Net::HTTP.get_response("localhost", "/", server.port) && pid_file_exists?
+        end
+        FileUtils.cp(pid_file_path, pid_file_backup_path)
+      end
+
+      def wait_until_stopped!
+        ::Wait.until_true!("#{server.name} stops") do
+          begin
+            Net::HTTP.get_response("localhost", "/", server.port)
+            false
+          rescue
+            !pid_file_exists?
+          end
+        end
+      end
+
+      def wait_until_file_exists!(file)
+        ::Wait.until_true!("#{file} exists") { File.exists?(file) }
+      end
+
+      def ensure_pid_file_backup_directory_exists!
+        FileUtils.mkdir_p(pid_file_backup_directory)
+        wait_until_file_exists!(pid_file_backup_directory)
+      end
+
+      def pid_file_exists?
+        File.exists?(pid_file_path)
+      end
+
+      def pid_file_path
+        "#{pid_dir}/#{pid_file_name}"
+      end
+
+      def pid_file_name
+        "#{server.name}.pid"
+      end
+
+      def pid_file_backup_directory
+        "#{pid_dir}/backup"
+      end
+
+      def pid_file_backup_path
+        "#{pid_file_backup_directory}/#{pid_file_name}"
+      end
+
+      def pid_dir
+        HttpServerManager.pid_dir
+      end
+
+      def logger
+        HttpServerManager.logger
+      end
+
+      def log_dir
+        HttpServerManager.log_dir
+      end
+
+    end
+
+  end
+
+end

data/spec/support/http_server_manager/test/server_integration_utilities_spec_context.rb

@@ -0,0 +1,10 @@
+shared_context "server integration utilities" do
+  include HttpServerManager::Test::ServerIntegrationUtilities
+
+  before(:each) do
+    HttpServerManager.logger.stub!(:info)
+
+    ensure_pid_file_backup_directory_exists!
+  end
+
+end

data/spec/support/http_server_manager/test/silent_logger.rb

@@ -0,0 +1,15 @@
+module HttpServerManager
+
+  module Test
+
+    class SilentLogger
+
+      def method_missing(*args)
+        # Intentionally blank
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: http_server_manager
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthew Ueckerman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-21 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: 10.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+- !ruby/object:Gem::Dependency
+  name: sys-proctree
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: wait_until
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+- !ruby/object:Gem::Dependency
+  name: travis-lint
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+description: Manages the lifecycle of HTTP server processes
+email: matthew.ueckerman@myob.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./lib/http_server_manager/rake/server_tasks.rb
+- ./lib/http_server_manager/rake/task_generators.rb
+- ./lib/http_server_manager/server.rb
+- ./lib/http_server_manager/stdout_logger.rb
+- ./lib/http_server_manager/version.rb
+- ./lib/http_server_manager.rb
+- ./spec/lib/http_server_manager/rake/server_tasks_integration_spec.rb
+- ./spec/lib/http_server_manager/server_integration_spec.rb
+- ./spec/lib/http_server_manager/stdout_logger_spec.rb
+- ./spec/lib/http_server_manager_spec.rb
+- ./spec/spec_helper.rb
+- ./spec/support/http_server_manager/test/server_integration_utilities.rb
+- ./spec/support/http_server_manager/test/server_integration_utilities_spec_context.rb
+- ./spec/support/http_server_manager/test/silent_logger.rb
+homepage: http://github.com/MYOB-Technology/http_server_manager
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- spec/support
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3855735617667382002
+requirements: []
+rubyforge_project: http_server_manager
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Manages the lifecycle of HTTP server processes
+test_files:
+- ./spec/lib/http_server_manager/rake/server_tasks_integration_spec.rb
+- ./spec/lib/http_server_manager/server_integration_spec.rb
+- ./spec/lib/http_server_manager/stdout_logger_spec.rb
+- ./spec/lib/http_server_manager_spec.rb
+- ./spec/spec_helper.rb
+- ./spec/support/http_server_manager/test/server_integration_utilities.rb
+- ./spec/support/http_server_manager/test/server_integration_utilities_spec_context.rb
+- ./spec/support/http_server_manager/test/silent_logger.rb