steam-condenser 1.0.2 → 1.1.0

data/test/steam/servers/test_master_server.rb

@@ -0,0 +1,131 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'helper'
+require 'steam/servers/master_server'
+
+class TestMasterServer < Test::Unit::TestCase
+
+  context 'The user' do
+
+    should 'be able to set the number of retries' do
+      MasterServer.retries = 5
+
+      assert_equal 5, MasterServer.send(:class_variable_get, :@@retries)
+    end
+
+  end
+
+  context 'A master server' do
+
+    setup do
+      Socket.stubs(:getaddrinfo).
+        with('master', 27015, Socket::AF_INET, Socket::SOCK_DGRAM).
+        returns [[nil, nil, 'master', '127.0.0.1']]
+
+      @server = MasterServer.new 'master', 27015
+    end
+
+    should 'create a client socket upon initialization' do
+      socket = mock
+      MasterServerSocket.expects(:new).with('127.0.0.1', 27015).returns socket
+
+      @server.init_socket
+
+      assert_same socket, @server.instance_variable_get(:@socket)
+    end
+
+    should 'be able to get a challenge' do
+      reply = mock :challenge => 1234
+
+      socket = @server.instance_variable_get :@socket
+      socket.expects(:send).with { |packet| packet.is_a? C2M_CHECKMD5_Packet }
+      socket.expects(:reply).returns reply
+
+      assert_equal 1234, @server.challenge
+    end
+
+    should 'be able to get a list of servers' do
+      reply1 = mock :servers => %w{127.0.0.1:27015 127.0.0.2:27015 127.0.0.3:27015}
+      reply2 = mock :servers => %w{127.0.0.4:27015 0.0.0.0:0}
+
+      socket = @server.instance_variable_get :@socket
+      socket.expects(:send).with do |packet|
+        packet.is_a?(A2M_GET_SERVERS_BATCH2_Packet) &&
+        packet.instance_variable_get(:@filter) == 'filter' &&
+        packet.instance_variable_get(:@region_code) == MasterServer::REGION_EUROPE &&
+        packet.instance_variable_get(:@start_ip) == '0.0.0.0:0'
+      end
+      socket.expects(:send).with do |packet|
+        packet.is_a?(A2M_GET_SERVERS_BATCH2_Packet) &&
+        packet.instance_variable_get(:@filter) == 'filter' &&
+        packet.instance_variable_get(:@region_code) == MasterServer::REGION_EUROPE &&
+        packet.instance_variable_get(:@start_ip) == '127.0.0.3:27015'
+      end
+      socket.expects(:reply).times(2).returns(reply1).returns reply2
+
+      servers = [['127.0.0.1', '27015'], ['127.0.0.2', '27015'], ['127.0.0.3', '27015'], ['127.0.0.4', '27015']]
+      assert_equal servers, @server.servers(MasterServer::REGION_EUROPE, 'filter')
+    end
+
+    should 'be able to send a heartbeat' do
+      reply1 = mock
+      reply2 = mock
+
+      socket = @server.instance_variable_get :@socket
+      socket.expects(:send).with { |packet| packet.is_a? S2M_HEARTBEAT2_Packet }
+      socket.expects(:reply).times(3).returns(reply1).returns(reply2).then.
+        raises SteamCondenser::TimeoutError
+
+      data = { :challenge => 1234 }
+      assert_equal [reply1, reply2], @server.send_heartbeat(data)
+    end
+
+    should 'not timeout if returning servers is forced' do
+      MasterServer.retries = 1
+
+      reply = mock :servers => %w{127.0.0.1:27015 127.0.0.2:27015 127.0.0.3:27015}
+
+      socket = @server.instance_variable_get :@socket
+      socket.expects(:send).with do |packet|
+        packet.is_a?(A2M_GET_SERVERS_BATCH2_Packet) &&
+        packet.instance_variable_get(:@filter) == 'filter' &&
+        packet.instance_variable_get(:@region_code) == MasterServer::REGION_EUROPE &&
+        packet.instance_variable_get(:@start_ip) == '0.0.0.0:0'
+      end
+      socket.expects(:send).with do |packet|
+        packet.is_a?(A2M_GET_SERVERS_BATCH2_Packet) &&
+        packet.instance_variable_get(:@filter) == 'filter' &&
+        packet.instance_variable_get(:@region_code) == MasterServer::REGION_EUROPE &&
+        packet.instance_variable_get(:@start_ip) == '127.0.0.3:27015'
+      end
+      socket.expects(:reply).times(2).returns(reply).then.
+        raises(SteamCondenser::TimeoutError)
+
+      servers = [['127.0.0.1', '27015'], ['127.0.0.2', '27015'], ['127.0.0.3', '27015']]
+      assert_equal servers, @server.servers(MasterServer::REGION_EUROPE, 'filter', true)
+    end
+
+    should 'timeout after a predefined number of retries' do
+      retries = rand(4) + 1
+      MasterServer.retries = retries
+
+      socket = @server.instance_variable_get :@socket
+      socket.expects(:send).times(retries).with do |packet|
+        packet.is_a? A2M_GET_SERVERS_BATCH2_Packet
+        packet.instance_variable_get(:@filter) == ''
+        packet.instance_variable_get(:@region_code) == MasterServer::REGION_ALL
+        packet.instance_variable_get(:@start_ip) == '0.0.0.0:0'
+      end
+      socket.expects(:reply).times(retries).raises SteamCondenser::TimeoutError
+
+      assert_raises SteamCondenser::TimeoutError do
+        @server.servers
+      end
+    end
+
+  end
+
+end

data/test/steam/servers/test_server.rb

@@ -0,0 +1,72 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'helper'
+require 'steam/servers/server'
+
+class TestServer < Test::Unit::TestCase
+
+  context 'A generic server' do
+
+    class GenericServer
+      include Server
+    end
+
+    should 'split IP and port combinations' do
+      Socket.expects(:getaddrinfo).
+        with('127.0.0.1', '27015', Socket::AF_INET, Socket::SOCK_DGRAM).
+        returns []
+      Socket.expects(:getaddrinfo).
+        with('someserver', '27015', Socket::AF_INET, Socket::SOCK_DGRAM).
+        returns []
+
+      GenericServer.new '127.0.0.1:27015'
+      GenericServer.new 'someserver:27015'
+    end
+
+    should 'resolve multiple DNS names' do
+      Socket.expects(:getaddrinfo).
+        with('someserver', 27015, Socket::AF_INET, Socket::SOCK_DGRAM).
+        returns [
+          [nil, nil, 'someserver', '127.0.0.1'],
+          [nil, nil, 'someserver2', '127.0.0.2']
+        ]
+
+      server = GenericServer.new 'someserver', 27015
+
+      assert_equal %w{someserver someserver2}, server.host_names
+      assert_equal %w{127.0.0.1 127.0.0.2}, server.ip_addresses
+    end
+
+    should 'rotate through multiple IP addresses' do
+      Socket.stubs(:getaddrinfo).returns []
+
+      server = GenericServer.new 'someserver'
+      server.instance_variable_set :@ip_addresses, %w{127.0.0.1 127.0.0.2}
+      server.instance_variable_set :@ip_address, '127.0.0.1'
+      server.expects(:init_socket).twice
+
+      assert_not server.rotate_ip
+      assert_equal '127.0.0.2', server.instance_variable_get(:@ip_address)
+      assert server.rotate_ip
+      assert_equal '127.0.0.1', server.instance_variable_get(:@ip_address)
+    end
+
+    should 'allow a failsafe block to execute with IP fallback' do
+      Socket.stubs(:getaddrinfo).returns []
+      block = Proc.new { raise 'error' }
+
+      server = GenericServer.new 'someserver'
+      server.expects(:rotate_ip).twice.returns(false).then.returns(true)
+
+      error = assert_raises RuntimeError do
+        server.send :failsafe, &block
+      end
+      assert_equal 'error', error.message
+    end
+
+  end
+
+end

data/test/steam/servers/test_source_server.rb

@@ -0,0 +1,140 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'helper'
+require 'steam/servers/source_server'
+
+class TestSourceServer < Test::Unit::TestCase
+
+  context 'The user' do
+
+    should 'be able to get a master server for Source servers' do
+      master = mock
+      MasterServer.expects(:new).with(*MasterServer::SOURCE_MASTER_SERVER).
+        returns master
+
+      assert_equal master, SourceServer.master
+    end
+
+  end
+
+  context 'A Source server' do
+
+    setup do
+      Socket.stubs(:getaddrinfo).
+        with('source', 27015, Socket::AF_INET, Socket::SOCK_DGRAM).
+        returns [[nil, nil, 'source', '127.0.0.1']]
+
+      @server = SourceServer.new 'source', 27015
+    end
+
+    should 'create client sockets upon initialization' do
+      socket = mock
+      SourceSocket.expects(:new).with('127.0.0.1', 27015).returns socket
+      rcon_socket = mock
+      RCONSocket.expects(:new).with('127.0.0.1', 27015).returns rcon_socket
+
+      @server.init_socket
+
+      assert_same socket, @server.instance_variable_get(:@socket)
+      assert_same rcon_socket, @server.instance_variable_get(:@rcon_socket)
+    end
+
+    should 'be able to authenticate successfully' do
+      reply = mock
+
+      rcon_socket = mock
+      rcon_socket.expects(:send).with do |packet|
+        reply.expects(:request_id).twice.returns packet.request_id
+
+        packet.is_a? RCONAuthRequest
+      end
+      rcon_socket.expects(:reply).twice.returns(nil).returns(reply)
+      @server.instance_variable_set :@rcon_socket, rcon_socket
+
+      assert @server.rcon_auth 'password'
+      assert @server.instance_variable_get(:@rcon_authenticated)
+    end
+
+    should 'fail to authenticate if the wrong request ID is returned' do
+      reply = mock
+      reply.expects(:request_id).twice.returns -2
+
+      rcon_socket = mock
+      rcon_socket.expects(:send).with { |packet| packet.is_a? RCONAuthRequest }
+      rcon_socket.expects(:reply).twice.returns(nil).returns(reply)
+      @server.instance_variable_set :@rcon_socket, rcon_socket
+
+      assert_not @server.rcon_auth 'password'
+      assert_not @server.instance_variable_get(:@rcon_authenticated)
+    end
+
+    should 'raise an error if authentication fails' do
+      reply = mock
+      reply.expects(:request_id).returns -1
+
+      rcon_socket = mock
+      rcon_socket.expects(:send).with { |packet| packet.is_a? RCONAuthRequest }
+      rcon_socket.expects(:reply).twice.returns(nil).returns(reply)
+      @server.instance_variable_set :@rcon_socket, rcon_socket
+
+      assert_raises RCONNoAuthError do
+        @server.rcon_auth 'password'
+      end
+    end
+
+    should 'raise an error if the RCON connection is not authenticated' do
+      assert_raises RCONNoAuthError do
+        @server.rcon_exec 'command'
+      end
+    end
+
+    context 'with an authenticated RCON connection' do
+
+      setup do
+        @rcon_socket = mock
+        @rcon_socket.expects(:send).with do |packet|
+          packet.is_a?(RCONExecRequest) &&
+          packet.instance_variable_get(:@content_data).string == "command\0\0" &&
+          packet.instance_variable_get(:@request_id) == 1234
+        end
+        @rcon_socket.expects(:send).with do |packet|
+          packet.is_a?(RCONTerminator) &&
+          packet.instance_variable_get(:@request_id) == 1234
+        end
+
+        @server.instance_variable_set :@rcon_authenticated, true
+        @server.instance_variable_set :@rcon_request_id, 1234
+        @server.instance_variable_set :@rcon_socket, @rcon_socket
+      end
+
+      should 'reset the connection if the server indicates so' do
+        reply = mock
+        reply.expects(:is_a?).with(RCONAuthResponse).returns true
+        @rcon_socket.expects(:reply).returns(reply)
+
+        assert_raises RCONNoAuthError do
+          @server.rcon_exec 'command'
+        end
+        assert_not @server.instance_variable_get(:@rcon_authenticated)
+      end
+
+      should 'receive the response of a command' do
+        reply1 = mock :response => 'test'
+        reply2 = mock :response => 'test'
+        reply3 = mock
+        reply3.expects(:response).twice.returns ''
+
+        @rcon_socket.expects(:reply).times(3).returns(reply1).returns(reply2).
+          returns reply3
+
+        assert_equal 'testtest', @server.rcon_exec('command')
+      end
+
+    end
+
+  end
+
+end

data/test/steam/sockets/test_goldsrc_socket.rb

@@ -0,0 +1,127 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'helper'
+require 'steam/sockets/goldsrc_socket'
+
+class TestGoldSrcSocket < Test::Unit::TestCase
+
+  context 'A new GoldSrc socket' do
+
+    should 'know if its endpoint is a HLTV server' do
+      socket1 = GoldSrcSocket.new '127.0.0.1', 27015
+      socket2 = GoldSrcSocket.new '127.0.0.1', 27015, true
+
+      assert_not socket1.instance_variable_get(:@is_hltv)
+      assert socket2.instance_variable_get(:@is_hltv)
+    end
+
+  end
+
+  context 'A GoldSrc socket' do
+
+    setup do
+      @socket = GoldSrcSocket.new '127.0.0.1'
+    end
+
+    should 'send wrapped up RCON requests' do
+      packet = mock
+      RCONGoldSrcRequest.expects(:new).with('test').returns packet
+      @socket.expects(:send).with packet
+
+      @socket.rcon_send 'test'
+    end
+
+    should 'be able to get a RCON challenge' do
+      @socket.expects(:rcon_send).with 'challenge rcon'
+
+      reply = mock :response => 'hallenge rcon 12345678'
+      @socket.expects(:reply).returns reply
+
+      @socket.rcon_challenge
+
+      assert_equal '12345678', @socket.instance_variable_get(:@rcon_challenge)
+    end
+
+    should 'raise an error if the client is banned on challenge' do
+      @socket.expects(:rcon_send).with 'challenge rcon'
+
+      reply = mock :response => 'You have been banned from this server.'
+      @socket.expects(:reply).returns reply
+
+      assert_raises RCONBanError do
+        @socket.rcon_challenge
+      end
+    end
+
+    should 'be able to receive single packet replies' do
+      buffer = mock
+      @socket.instance_variable_set :@buffer, buffer
+
+      @socket.expects(:receive_packet).with 1400
+      data = mock
+      buffer.expects(:long).returns 0xFFFFFFFF
+      buffer.expects(:get).returns data
+      packet = mock
+      SteamPacketFactory.expects(:packet_from_data).with(data).returns packet
+
+      assert_equal packet, @socket.reply
+    end
+
+    should 'be able to receive split packet replies' do
+      buffer = mock
+      @socket.instance_variable_set :@buffer, buffer
+
+      @socket.expects(:receive_packet).with(1400)
+      @socket.expects(:receive_packet).with().returns 1400
+
+      data1, data2 = mock, mock
+      buffer.expects(:long).times(4).returns(0xFFFFFFFE).returns(1234).
+        returns(0xFFFFFFFE).returns 1234
+      buffer.expects(:byte).twice.returns(0x02).returns 0x12
+      buffer.expects(:get).twice.returns(data1).returns(data2)
+
+      packet = mock
+      SteamPacketFactory.expects(:reassemble_packet).with([data1, data2]).
+        returns packet
+
+      assert_equal packet, @socket.reply
+    end
+
+    should 'be able to send RCON commands to game servers' do
+      @socket.expects(:rcon_challenge).with do
+        @socket.instance_variable_set :@rcon_challenge, '1234'
+      end
+      @socket.expects(:rcon_send).with("rcon 1234 password command")
+      @socket.expects(:rcon_send).with("rcon 1234 password")
+      packet1 = mock :response => 'test '
+      packet2 = mock :response => 'test'
+      packet3 = mock :response => ''
+      @socket.expects(:reply).times(3).returns(packet1).returns(packet2).
+        returns packet3
+
+      assert_equal 'test test', @socket.rcon_exec('password', 'command')
+    end
+
+    should 'be able to send RCON commands to HLTV servers' do
+      @socket.instance_variable_set :@is_hltv, true
+
+      @socket.expects(:rcon_challenge).with do
+        @socket.instance_variable_set :@rcon_challenge, '1234'
+      end
+      @socket.expects(:rcon_send).with("rcon 1234 password command")
+      @socket.expects(:rcon_send).with("rcon 1234 password")
+      packet1 = mock :response => 'test '
+      packet2 = mock :response => 'test'
+      packet3 = mock :response => ''
+      @socket.expects(:reply).times(4).raises(SteamCondenser::TimeoutError).
+        returns(packet1).returns(packet2).returns packet3
+
+      assert_equal 'test test', @socket.rcon_exec('password', 'command')
+    end
+
+  end
+
+end