minecraftctl 1.0.0 → 1.1.0

data/spec/minecraft_spec.rb

@@ -0,0 +1,80 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'minecraft'
+
+describe Minecraft do
+	it "should raise Minecraft::StartupFailedError when server command is not executable" do
+		@m = Minecraft.new(File.dirname(__FILE__) + '/stub_minecraftxx')
+		lambda {
+			@m.start
+		}.should raise_error Minecraft::StartupFailedError
+	end
+
+	it "should raise Minecraft::StartupFailedError when server command is not returning expected output" do
+		@m = Minecraft.new('echo hello world')
+		lambda {
+			@m.start
+		}.should raise_error Minecraft::StartupFailedError
+	end
+
+	it "should start up" do
+		@m = Minecraft.new(File.dirname(__FILE__) + '/stub_server/minecraft')
+		@m.start
+
+		msgs = @m.history.map{|m| m.msg}
+
+		msgs.should include "Starting minecraft server version Beta 1.7.3"
+		msgs.should include "Done (5887241893ns)! For help, type \"help\" or \"?\""
+		msgs.last.should =~ /Server start finished/
+	end
+
+	describe 'while running' do
+		before :all do
+			@m = Minecraft.new(File.dirname(__FILE__) + '/stub_server/minecraft')
+			@m.start
+		end
+
+		it 'should provide message history' do
+			h = @m.history
+			h.first.should be_kind_of Minecraft::MessageQueue::Message::Internal
+			h.should have(23).items
+		end
+
+		it 'responds to list command' do
+			@m.list
+			msgs = @m.history.map{|m| m.msg}
+			msgs.last.should == 'Connected players: kazuya'
+		end
+
+		it 'responds to say command' do
+			@m.say('hello', 'world')
+			msgs = @m.history.map{|m| m.msg}
+			msgs.should include '[CONSOLE] hello world'
+		end
+
+		it 'responds to save_all command' do
+			@m.save_all
+			msgs = @m.history.map{|m| m.msg}
+			msgs.should include 'CONSOLE: Save complete.'
+		end
+
+		it 'should stop and start' do
+			@m.stop
+			msgs = @m.history.map{|m| m.msg}
+			msgs.should include 'Stopping server'
+			@m.running?.should == false
+
+			@m.start
+			msgs = @m.history.map{|m| m.msg}
+			msgs[-5, 5].should include 'Done (5887241893ns)! For help, type "help" or "?"'
+			@m.running?.should == true
+
+			@m.list
+			msgs = @m.history.map{|m| m.msg}
+			msgs.last.should == 'Connected players: kazuya'
+		end
+
+		after :all do
+			@m.stop
+		end
+	end
+end

data/spec/minecraftctlserver_spec.rb

@@ -0,0 +1,92 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'httpclient'
+require 'open4'
+require 'timeout'
+
+
+$url = 'http://localhost:25560/'
+
+def start_stub(wait = true)
+	pid, stdin, stdout, stderr = Open4::popen4(File.dirname(__FILE__) + '/../bin/minecraftctlserver -c ./minecraft ' + File.dirname(__FILE__) + '/stub_server')
+
+	if wait
+		c = HTTPClient.new
+		Timeout.timeout(10) do
+			begin
+				c.get_content($url + "status")
+			rescue Errno::ECONNREFUSED
+				sleep 0.4
+				retry
+			end
+		end
+	end
+end
+
+def stop_stub
+	HTTPClient.new.post_content($url + "shutdown", '')
+
+	Timeout.timeout(10) do
+		begin
+			loop do
+				HTTPClient.new.get_content($url + "status")
+				sleep 0.4
+			end
+		rescue Errno::ECONNREFUSED
+		rescue => e
+			puts "got different error: #{e}"
+		end
+	end
+	sleep 0.2
+end
+
+describe 'minecraftctlserver' do
+	describe 'text mode HTTP' do
+		describe  'server startup' do
+			before :all do
+				start_stub(false)
+			end
+
+			it 'should start the minecraft server and respond to status command when ready' do
+				Timeout.timeout(10) do
+					out = nil
+					begin
+						out = HTTPClient.new.get_content($url + "status")
+					rescue Errno::ECONNREFUSED
+						sleep 0.4
+						retry
+					end
+
+					out.should =~ /Minecraft server is running with pid:/
+				end
+			end
+
+			after :all do
+				stop_stub
+			end
+		end
+
+		describe 'while server ready' do
+			before :all do
+				start_stub
+			end
+
+			it 'should respond to GET /list' do
+				HTTPClient.new.get_content($url + "list").should == "Connected players: kazuya\n"
+			end
+
+			it 'should stop and start with POST /stop and POST /start' do
+				HTTPClient.new.post_content($url + "stop", '').should include "Server stopped\n"
+				HTTPClient.new.post_content($url + "start", '').should include 'Done (5887241893ns)! For help, type "help" or "?"'
+			end
+
+			it 'should respond to GET /help' do
+				HTTPClient.new.get_content($url + "help").should include "show server status\n"
+			end
+
+			after :all do
+				stop_stub
+			end
+		end
+	end
+end
+

data/spec/spec_helper.rb

@@ -1,7 +1,6 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
-require 'minecraftctl'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.

data/spec/stub_server/minecraft

@@ -0,0 +1,100 @@
+#!/usr/bin/ruby
+
+def out(line)
+	STDOUT << line + "\n"
+	STDOUT.flush
+end
+
+def err(line)
+	STDERR << line + "\n"
+	STDERR.flush
+end
+
+$expects = {}
+
+def expect(command, &response)
+	$expects[command] = response
+end
+
+out '151 recipes'
+out '16 achievements'
+err '2011-09-10 12:58:55 [INFO] Starting minecraft server version Beta 1.7.3'
+err '2011-09-10 12:58:55 [WARNING] **** NOT ENOUGH RAM!'
+err '2011-09-10 12:58:55 [WARNING] To start the server with more ram, launch it as "java -Xmx1024M -Xms1024M -jar minecraft_server.jar"'
+err '2011-09-10 12:58:55 [INFO] Loading properties'
+err '2011-09-10 12:58:55 [INFO] Starting Minecraft server on *:25565'
+err '2011-09-10 12:58:55 [WARNING] **** SERVER IS RUNNING IN OFFLINE/INSECURE MODE!'
+err '2011-09-10 12:58:55 [WARNING] The server will make no attempt to authenticate usernames. Beware.'
+err '2011-09-10 12:58:55 [WARNING] While this makes the game possible to play without internet access, it also opens up the ability for hackers to connect with any username they choose.'
+err '2011-09-10 12:58:55 [WARNING] To change this, set "online-mode" to "true" in the server.settings file.'
+err '2011-09-10 12:58:55 [INFO] Preparing level "world"'
+err '2011-09-10 12:58:55 [INFO] Preparing start region for level 0'
+err '2011-09-10 12:58:56 [INFO] Preparing spawn area: 32%'
+err '2011-09-10 12:58:57 [INFO] Preparing spawn area: 77%'
+err '2011-09-10 12:58:58 [INFO] Preparing start region for level 1'
+err '2011-09-10 12:58:59 [INFO] Preparing spawn area: 4%'
+err '2011-09-10 12:59:00 [INFO] Preparing spawn area: 52%'
+err '2011-09-10 12:59:01 [INFO] Preparing spawn area: 97%'
+err '2011-09-10 12:59:01 [INFO] Done (5887241893ns)! For help, type "help" or "?"'
+
+expect 'list' do
+	err '2011-09-20 14:42:04 [INFO] Connected players: kazuya'
+end
+
+expect 'stop' do
+	err '2011-09-19 22:12:00 [INFO] Stopping server'
+	err '2011-09-19 22:12:00 [INFO] Saving chunks'
+	err '2011-09-19 22:12:00 [INFO] Saving chunks'
+	exit
+end
+
+expect 'help' do
+	err '2011-09-21 13:33:46 [INFO] To run the server without a gui, start it like this:'
+	err '2011-09-21 13:33:46 [INFO]    java -Xmx1024M -Xms1024M -jar minecraft_server.jar nogui'
+	err '2011-09-21 13:33:46 [INFO] Console commands:'
+	err '2011-09-21 13:33:46 [INFO]    help  or  ?               shows this message'
+	err '2011-09-21 13:33:46 [INFO]    kick <player>             removes a player from the server'
+	err '2011-09-21 13:33:46 [INFO]    ban <player>              bans a player from the server'
+	err '2011-09-21 13:33:46 [INFO]    pardon <player>           pardons a banned player so that they can connect again'
+	err '2011-09-21 13:33:46 [INFO]    ban-ip <ip>               bans an IP address from the server'
+	err '2011-09-21 13:33:46 [INFO]    pardon-ip <ip>            pardons a banned IP address so that they can connect again'
+	err '2011-09-21 13:33:46 [INFO]    op <player>               turns a player into an op'
+	err '2011-09-21 13:33:46 [INFO]    deop <player>             removes op status from a player'
+	err '2011-09-21 13:33:46 [INFO]    tp <player1> <player2>    moves one player to the same location as another player'
+	err '2011-09-21 13:33:46 [INFO]    give <player> <id> [num]  gives a player a resource'
+	err '2011-09-21 13:33:46 [INFO]    tell <player> <message>   sends a private message to a player'
+	err '2011-09-21 13:33:46 [INFO]    stop                      gracefully stops the server'
+	err '2011-09-21 13:33:46 [INFO]    save-all                  forces a server-wide level save'
+	err '2011-09-21 13:33:46 [INFO]    save-off                  disables terrain saving (useful for backup scripts)'
+	err '2011-09-21 13:33:46 [INFO]    save-on                   re-enables terrain saving'
+	err '2011-09-21 13:33:46 [INFO]    list                      lists all currently connected players'
+	err '2011-09-21 13:33:46 [INFO]    say <message>             broadcasts a message to all players'
+	err '2011-09-21 13:33:46 [INFO]    time <add|set> <amount>   adds to or sets the world time (0-24000)'
+	err '2011-09-21 13:33:46 [INFO]    gamemode <player> <mode>  sets player\'s game mode (0 or 1)'
+end
+
+expect 'say' do |*args|
+	err "2011-09-21 14:01:18 [INFO] [CONSOLE] #{args.join(' ')}"
+end
+
+expect 'save-all' do
+	err '2011-09-21 14:02:22 [INFO] CONSOLE: Forcing save..'
+	err '2011-09-21 14:02:22 [INFO] CONSOLE: Save complete.'
+end
+
+expect 'stream' do
+	10.times do |n|
+		err "2011-09-21 14:02:#{n} [INFO] #{n}"
+		sleep 1
+	end
+end
+
+loop do
+	cmd, *args = gets.split(' ')
+	if $expects.member? cmd
+		$expects[cmd].call(*args)    
+	else
+		err '2011-09-20 14:42:52 [INFO] Unknown console command. Type "help" for help.'
+	end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: minecraftctl
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Jakub Pastuszek
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-10 00:00:00 Z
+date: 2011-09-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -175,6 +175,38 @@ dependencies:
   name: httpclient
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  version_requirements: *id011
+  name: open4
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 1
+        - 5
+        version: 1.1.5
+  version_requirements: *id012
+  name: mongrel
+  prerelease: false
+  type: :development
 description: Allows to send messages, start and stop Minecraft server
 email: jpastuszek@gmail.com
 executables: 
@@ -196,10 +228,15 @@ files:
 - 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/message_collector_spec.rb
+- spec/minecraft_spec.rb
+- spec/minecraftctlserver_spec.rb
 - spec/spec_helper.rb
+- spec/stub_server/minecraft
 homepage: http://github.com/jpastuszek/minecraftctl
 licenses: 
 - MIT

data/spec/minecraftctl_spec.rb

@@ -1,7 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "Minecraftctl" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
-  end
-end