minecraftctl 1.0.0 → 1.1.0

data/lib/message_collector.rb

@@ -0,0 +1,21 @@
+class MessageCollector
+	def initialize(&operation)
+		@operation = operation
+	end
+
+	def self.for(minecraft, &operations)
+		self.new do |collector|
+			minecraft.with_message_collector(collector, &operations)
+		end
+	end
+
+	def collect(msg)
+		@collector.call(msg)
+	end
+
+	def each(&collector)
+		@collector = collector
+		@operation.call(method(:collect))
+	end
+end
+

data/lib/minecraft.rb

@@ -0,0 +1,281 @@
+require 'timeout'
+require 'spawn'
+Thread.abort_on_exception = true
+
+class Minecraft
+	class HistoryQueue < Queue
+		def initialize
+			@history = []
+			super
+		end
+
+		def flush
+			until empty? 
+				msg = pop(true)
+			yield msg if block_given?
+			end
+		end
+
+		def history
+			flush
+			@history
+		end
+
+		def pop(blocking = false)
+			msg = super(blocking)
+			@history << msg
+			msg
+		end
+	end
+
+	class MessageQueue < HistoryQueue
+		class Message
+			def initialize(msg)
+				@msg = msg
+			end
+
+			attr_reader :msg
+
+			def to_s
+				@msg
+			end
+
+			class Internal < Message
+				def initialize(msg)
+					super(msg)
+				end
+			end
+
+			class InternalError < Message
+				def initialize(msg)
+					super(msg)
+				end
+			end
+
+			class Out < Message
+				def initialize(msg)
+					super(msg)
+				end
+			end
+
+			class Err < Message
+				def initialize(line)
+					x, @time, @level, msg = *line.match(/^([^ ]* [^ ]*) \[([^\]]*)\] (.*)/)
+					msg = line unless @time and @level and msg
+					super(msg)
+				end
+
+				attr_reader :time, :level
+			end
+		end
+
+		def initialize
+			super
+		end
+
+		def out(msg)
+			push Message::Out.new(msg)
+		end
+
+		def err(msg)
+			push Message::Err.new(msg)
+		end
+
+		def log(msg)
+			push Message::Internal.new(msg)
+		end
+
+		def error(msg)
+			push Message::InternalError.new(msg)
+		end
+	end
+
+	class StartupFailedError < RuntimeError
+		def initialize(command)
+			super "failed to start process: #{command}"
+		end
+	end
+
+	def initialize(cmd)
+		@cmd = cmd
+		@in_queue = Queue.new
+		@message_queue = MessageQueue.new
+
+		@server_pid = nil
+
+		@collector = nil
+	end
+
+	attr_reader :server_pid
+
+	def with_message_collector(collector, &operations)
+		@message_queue.flush
+		@collector = collector
+		begin
+			instance_eval &operations
+		rescue Timeout::Error
+			error "Command timed out"
+		ensure
+			@message_queue.flush do |msg|
+				collect(msg)
+			end
+			@collector = nil
+		end
+	end
+
+	def running?
+		@out_reader and @in_writter.alive?
+	end
+
+	def log(msg)
+		@message_queue.log(msg)
+	end
+
+	def error(msg)
+		@message_queue.error(msg)
+	end
+
+	def start
+		if running?
+			log "Server already running"
+		else
+			time_operation("Server start") do
+				begin
+					log "Starting minecraft: #{@cmd}"
+
+					pid, @stdin, @stdout, @stderr = Spawn::spawn(@cmd)
+					@server_pid = pid
+
+					log "Started server process with pid: #{@server_pid}"
+
+					@in_writter = Thread.new do
+						begin
+							loop do
+								msg = @in_queue.pop
+								@stdin.write(msg)
+							end
+						rescue IOError, Errno::EPIPE
+						end
+					end
+
+					@err_reader = Thread.new do
+						begin
+							@stderr.each do |line|
+								@message_queue.err(line.strip)
+							end
+						rescue IOError
+						end
+					end
+
+					@out_reader = Thread.new do
+						begin
+							@stdout.each do |line|
+								@message_queue.out(line.strip)
+							end
+						rescue IOError
+						ensure
+							@in_writter.kill
+							@err_reader.kill
+
+							@stdin.close unless @stdin.closed?
+							@stderr.close unless @stderr.closed?
+							@stdout.close unless @stdout.closed?
+
+							log "Minecraft exits"
+						end
+					end
+
+					wait_msg do |m|
+						m.msg =~ /Done \(([^n]*)ns\)!/ or m.msg =~ /Minecraft exits/
+					end
+
+					unless running?
+						Process.wait(@server_pid)
+						raise StartupFailedError, @cmd 
+					end
+				rescue Errno::ENOENT
+					raise StartupFailedError, @cmd 
+				end
+			end
+		end
+	end
+
+	def stop
+		unless running?
+			log "Server already stopped"
+		else
+			command('stop') do
+				time_operation("Server stop") do
+					Process.wait(@server_pid)
+					log "Server stopped"
+				end
+
+				wait_msg{|m| m.msg == "Server stopped"}
+			end
+		end
+	end
+
+	def save_all
+		command('save-all') do
+			time_operation("Save") do
+				wait_msg{|m| m.msg =~ /Save complete/}
+			end
+		end
+	end
+
+	def list
+		command('list') do
+			wait_msg{|m| m.msg =~ /Connected players:/}
+		end
+	end
+
+	def method_missing(m, *args)
+		command(([m.to_s.tr('_', '-')] + args).join(' '))
+	end
+
+	def command(cmd)
+		raise RuntimeError, "server not running" unless running?
+		@in_queue << "#{cmd}\n"
+		if block_given?
+			yield 
+		else
+			active_wait
+		end
+	end
+
+	def history
+		@message_queue.history
+	end
+
+	private
+
+	def collect(msg)
+		@collector.call(msg) if @collector
+	end
+
+	def time_operation(name)
+		start = Time.now
+		yield
+		log "#{name} finished in #{(Time.now - start).to_f}"
+	end
+
+	def wait_msg(discard = false, timeout = 20)
+		Timeout::timeout(timeout) do
+			loop do
+				msg = @message_queue.pop
+				if yield msg
+					collect(msg) unless discard
+					break
+				end
+
+				collect(msg)
+			end
+		end
+	end
+
+	def active_wait
+		@in_queue << "list\n"
+		wait_msg(true){|m| m.msg =~ /Connected players:/}
+	end
+end
+

data/lib/spawn.rb

@@ -0,0 +1,78 @@
+require 'fcntl'
+
+class Spawn
+  def self.spawn(*cmd, &b)
+    pw, pr, pe, ps = IO.pipe, IO.pipe, IO.pipe, IO.pipe
+
+		ps.first.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+		ps.last.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+
+		cid = fork {
+			pw.last.close
+			STDIN.reopen pw.first
+			pw.first.close
+
+			pr.first.close
+			STDOUT.reopen pr.last
+			pr.last.close
+
+			pe.first.close
+			STDERR.reopen pe.last
+			pe.last.close
+
+			STDOUT.sync = STDERR.sync = true
+
+			begin
+				# WARNING: detect max open fd no - is thre a better way?
+				r, w = IO.pipe
+				max_fd = r.to_i - 1
+				r.close
+				w.close
+
+				#puts "setting close on exec for fd's from 3 to #{max_fd}"
+				(3..max_fd).each do |fd|
+					begin
+						IO.for_fd(fd).fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+						#puts "fd #{fd} set for closure on exec"
+					rescue Errno::EBADF
+					end
+				end
+
+				exec(*cmd)
+				raise 'forty-two' 
+			rescue Exception => e
+				Marshal.dump(e, ps.last)
+				ps.last.flush
+			end
+			ps.last.close unless (ps.last.closed?)
+			exit!
+		}
+
+    [pw.first, pr.last, pe.last, ps.last].each{|fd| fd.close}
+
+    begin
+      e = Marshal.load ps.first
+      raise(Exception === e ? e : "unknown failure!")
+    rescue EOFError # If we get an EOF error, then the exec was successful
+      42
+    ensure
+      ps.first.close
+    end
+
+    pw.last.sync = true
+
+    pi = [pw.last, pr.first, pe.first]
+
+    if b 
+      begin
+        b[cid, *pi]
+        Process.waitpid2(cid).last
+      ensure
+        pi.each{|fd| fd.close unless fd.closed?}
+      end
+    else
+      [cid, pw.last, pr.first, pe.first]
+    end
+  end
+end
+

data/minecraftctl.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "minecraftctl"
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jakub Pastuszek"]
-  s.date = "2011-09-10"
+  s.date = "2011-09-22"
   s.description = "Allows to send messages, start and stop Minecraft server"
   s.email = "jpastuszek@gmail.com"
   s.executables = ["minecraftctl", "minecraftctlserver", "minecraftctl", "minecraftctlserver"]
@@ -28,10 +28,15 @@ Gem::Specification.new do |s|
     "VERSION",
     "bin/minecraftctl",
     "bin/minecraftctlserver",
-    "lib/minecraftctl.rb",
+    "lib/message_collector.rb",
+    "lib/minecraft.rb",
+    "lib/spawn.rb",
     "minecraftctl.gemspec",
-    "spec/minecraftctl_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/message_collector_spec.rb",
+    "spec/minecraft_spec.rb",
+    "spec/minecraftctlserver_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/stub_server/minecraft"
   ]
   s.homepage = "http://github.com/jpastuszek/minecraftctl"
   s.licenses = ["MIT"]
@@ -53,6 +58,8 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<main>, [">= 4.7.3"])
       s.add_development_dependency(%q<haml>, [">= 3.1.3"])
       s.add_development_dependency(%q<httpclient>, [">= 2.2.1"])
+      s.add_development_dependency(%q<open4>, [">= 1.1.0"])
+      s.add_development_dependency(%q<mongrel>, [">= 1.1.5"])
     else
       s.add_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -64,6 +71,8 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<main>, [">= 4.7.3"])
       s.add_dependency(%q<haml>, [">= 3.1.3"])
       s.add_dependency(%q<httpclient>, [">= 2.2.1"])
+      s.add_dependency(%q<open4>, [">= 1.1.0"])
+      s.add_dependency(%q<mongrel>, [">= 1.1.5"])
     end
   else
     s.add_dependency(%q<rspec>, ["~> 2.3.0"])
@@ -76,6 +85,8 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<main>, [">= 4.7.3"])
     s.add_dependency(%q<haml>, [">= 3.1.3"])
     s.add_dependency(%q<httpclient>, [">= 2.2.1"])
+    s.add_dependency(%q<open4>, [">= 1.1.0"])
+    s.add_dependency(%q<mongrel>, [">= 1.1.5"])
   end
 end
 

data/spec/message_collector_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'message_collector'
+require 'minecraft'
+
+describe MessageCollector do
+	it 'should collect messages via passed proc call' do
+		mc = MessageCollector.new do |collector|
+			collector.call(:test1)
+			collector.call(:test2)
+		end
+
+		msgs = []
+		mc.each do |msg|
+			msgs << msg
+		end
+
+		msgs.should == [:test1, :test2]
+	end
+
+	describe 'with minecraft running' do
+		before :all do
+			@m = Minecraft.new(File.dirname(__FILE__) + '/stub_server/minecraft')
+			@m.start
+		end
+
+		it 'should collect messages generated by minecraft commands' do
+			msgs = []
+
+			MessageCollector.new do |collector|
+			@m.with_message_collector(collector) do
+				list
+				command(:help)
+			end
+			end.each do |msg|
+				msgs << msg.msg
+			end
+
+			msgs.first.should == 'Connected players: kazuya'
+			msgs.should include 'Console commands:'
+		end
+
+		it 'should provide #for method that shortens the code' do
+			msgs = []
+
+			MessageCollector.for(@m) do
+				list
+				command(:help)
+			end.each do |msg|
+				msgs << msg.msg
+			end
+
+			msgs.first.should == 'Connected players: kazuya'
+			msgs.should include 'Console commands:'
+		end
+
+		after :all do
+			@m.stop
+		end
+	end
+end
+