test.php

<?php

// oh baby a testing thing

require_once 'lib/steamid.php';

header( 'Content-Type: text/plain' );

SteamID::SetParseRawDefault(true);

// ****************************************************************************
function PrintLine( $text ) {
	echo $text . "\r\n"; 
	flush();
}
// ****************************************************************************
function PrintSubTest( $text ) {
	echo "  $text" . "\r\n"; 
	flush();
}


// ****************************************************************************
class Test {
	public $name;
	public $method;
	
	function Run() {
		// lol.
		$method = $this->method;
		return $method(); 
	}
	
	function __construct( $name, $method ) {
		$this->name = $name;
		$this->method = $method;
	}
}

// ****************************************************************************
final class Tests {

	public static $tests = array();
	/*
	public function __construct( $name ) {
		self::$tests[] = $this;
		$this->name = $name; 
	}*/
	
	/**
	 * Run this test return TRUE on pass FALSE on failure.
	 */
	//protected abstract function RunTest();
	/*
	public function Run() {
		PrintLine( "---" );
		PrintLine( "Running test: \"$this->name\"" );
		if( $this->RunTest() ) {
			PrintLine( "Passed." );
		} else {
			PrintLine( "*** Failed! ***" );
		}
		
	}*/
	
	public static function Run() {
		PrintLine( "---" );
		PrintLine( "Running all tests." );
		foreach( self::$tests as $test ) {
			PrintLine( "" );
			PrintLine( "\"$test->name\"" );
			if( $test->Run() ) {
				PrintLine( "--- Passed. ---" );
			} else {
				PrintLine( "*** Failed! ***" );
			}
		}
	}
	
	public static function Add( $name, $method ) {
		self::$tests[] = new Test( $name, $method );
	}
}

// ****************************************************************************
Tests::Add( "Conversion Test", function() {
	
	PrintSubTest( "32-bit detect" );
	$steamid = SteamID::Parse( " STEAM_1:1:54499221 " );
	if( $steamid === FALSE ) return FALSE;
	PrintSubTest( "32-bit direct" );
	$steamid = SteamID::Parse( "STEAM_0:1:54499221", SteamID::FORMAT_STEAMID32 );
	if( $steamid === FALSE ) return FALSE;
	PrintSubTest( "32-bit as 64 error" );
	$steamid = SteamID::Parse( "STEAM_1:1:54499221", SteamID::FORMAT_STEAMID64 );
	if( $steamid !== FALSE ) return FALSE;
	
	PrintSubTest( "64-bit detect" );
	$steamid = SteamID::Parse( "76561198069264171" );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	
	PrintSubTest( "64-bit direct" );
	$steamid = SteamID::Parse( "76561198069264171", SteamID::FORMAT_STEAMID64 );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	
	PrintSubTest( "64-bit errornous" );
	$steamid = SteamID::Parse( "76533611981069263334171", SteamID::FORMAT_STEAMID64 );
	if( $steamid !== FALSE ) return FALSE;
	
	PrintSubTest( "64-bit as raw" );
	$steamid = SteamID::Parse( "76561198069264171", SteamID::FORMAT_RAW );
	if( $steamid !== FALSE ) return FALSE;
	
	PrintSubTest( "v3 detect" );
	$steamid = SteamID::Parse( "[U:1:108998443]" );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	
	PrintSubTest( "v3 direct" );
	$steamid = SteamID::Parse( "[U:1:108998443]", SteamID::FORMAT_STEAMID3 );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	
	PrintSubTest( "s32 detect" );
	$steamid = SteamID::Parse( "108998443" );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	
	PrintSubTest( "s32 direct" );
	$steamid = SteamID::Parse( "108998443", SteamID::FORMAT_S32 );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	
	PrintSubTest( "raw direct" );
	$steamid = SteamID::Parse( "108998443", SteamID::FORMAT_RAW );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	
	PrintSubTest( "community URL 1" );
	$steamid = SteamID::Parse( "http://www.steamcommunity.com/profiles/76561198069264171" );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	
	PrintSubTest( "community URL 1 Trailing Slashes" );
	$steamid = SteamID::Parse( "http://www.steamcommunity.com/profiles/76561198069264171/" );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	$steamid = SteamID::Parse( "http://www.steamcommunity.com/profiles/76561198069264171//////" );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	
	PrintSubTest( "community URL 2" );
	$steamid = SteamID::Parse( "http://steamcommunity.com/profiles/76561198069264171" );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	
	PrintSubTest( "community URL 3" );
	$steamid = SteamID::Parse( "www.steamcommunity.com/profiles/76561198069264171" );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	
	PrintSubTest( "community URL 4" );
	$steamid = SteamID::Parse( "steamcommunity.com/profiles/76561198069264171" );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	
	PrintSubTest( "random conversions..." );
	for( $i = 0; $i < 5000; $i++ ) {
		// get a 32bit unsigned value
		$raw = bcadd( (string)mt_rand( 0, 2147483647 ), (string)mt_rand( 0, 2147483647 ), 0 );
		
		$steamid = SteamID::Parse( $raw, SteamID::FORMAT_RAW );
		
		for( $j = 0; $j < 8; $j++ ) {
			$format = mt_rand( 1, 5 );
			$formatted = $steamid->Format( $format );
			$steamid2 = SteamID::Parse( $formatted );
			if( $steamid2 === FALSE || $steamid2->Format( $format ) != $formatted ) {
				PrintSubTest( "failure:" );
				var_dump( $steamid );
				return FALSE;
			}
			$steamid = $steamid2;
		}
	}
	
	return TRUE;
} );

// ****************************************************************************
Tests::Add( "Large SteamID conversions", function () {

	for( $i = 0; $i < 255; $i++ ) {
		// get a 64bit-ish value
		$a = bcdiv( (string)mt_rand(), (string)mt_getrandmax() );
		$a = bcmul( $a, SteamID::MAX_VALUE, 0 );
	
		$steamid = SteamID::Parse( $a, SteamID::FORMAT_RAW );
		
		for( $j = 0; $j < 8; $j++ ) {
			$format = mt_rand( 1, 5 );
			$formatted = $steamid->Format( $format );
			if( $format == SteamID::FORMAT_S32 ) {
			
				// for S32 check for proper failure.
				if( $formatted === FALSE ) {
					if( bccomp( $steamid->value, '4294967296' ) >= 0 ) {
						
						continue;
					}
				}
			}
			$steamid2 = SteamID::Parse( $formatted );
			if( $steamid2 === FALSE || $steamid2->Format( $format ) != $formatted ) {
				PrintSubTest( "failure: (format=$format)" );
				var_dump( $steamid );
				return FALSE;
			}
			$steamid = $steamid2;
		}
	}
	
	return TRUE;
} );

// ****************************************************************************
function VanityTest() {

	$buildname = function( $len ) {
		$name = "";
		for( $i = 0; $i < $len; $i++ ) {
			$name .= chr( mt_rand( 97, 122 ) );
		}
		return $name;
	};
	
	PrintSubTest( "simple/direct" );
	$steamid = SteamID::Parse( "prayspray", SteamID::FORMAT_AUTO, true );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	
	PrintSubTest( "fullurl" );
	$steamid = SteamID::Parse( "http://steamcommunity.com/id/prayspray", SteamID::FORMAT_AUTO, true );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	
	PrintSubTest( "fullurl with trailing slash" );
	$steamid = SteamID::Parse( "http://steamcommunity.com/id/prayspray/", SteamID::FORMAT_AUTO, true );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	
	PrintSubTest( "fullurl with trailing slashes" );
	$steamid = SteamID::Parse( "http://steamcommunity.com/id/prayspray/////", SteamID::FORMAT_AUTO, true );
	if( $steamid === FALSE ) return FALSE;
	if( $steamid->Format( SteamID::FORMAT_STEAMID32 ) != "STEAM_1:1:54499221" ) return FALSE;
	
	PrintSubTest( "random strings" );
	for( $i = 0; $i < 20; $i++ ) {
		$name = $buildname( $i );
		
		try {
			$steamid = SteamID::Parse( $name, SteamID::FORMAT_AUTO, true );
		} catch( SteamIDResolutionException $e ) {
			switch( $e->reason ) {
			case SteamIDResolutionException::UNKNOWN:
				PrintSubTest( "failure: UNKNOWN. $name" );
				PrintSubTest( $e->getMessage() );
				return FALSE;
			case SteamIDResolutionException::CURL_FAILURE:
				PrintSubTest( "CURL_FAILURE $name" );
				PrintSubTest( $e->getMessage() );
				return FALSE;
			case SteamIDResolutionException::VANITYURL_NOTFOUND:
				// normal operation
				continue;
			case SteamIDResolutionException::VANITYURL_FAILED:
				PrintSubTest( "STEAM FAILURE $name" );
				PrintSubTest( $e->getMessage() );
				return FALSE;
			}
		}
	}
	return TRUE;
}

// ****************************************************************************
Tests::Add( "VanityURL Resolution via XML", function () {
	
	return VanityTest();
	
} );

// ****************************************************************************
Tests::Add( "VanityURL Resolution via Steam API", function () {
	$steamapikey = file_get_contents( "steamapikey" );
	if($steamapikey=="") {
		PrintSubTest( 
"Steam API Key missing, please create a file called 
\"steamapikey\" and set the contents to your Steam API key!" );
		PrintSubTest( "http://steamcommunity.com/dev/apikey" );
		return FALSE;
	}

	SteamID::SetSteamAPIKey( $steamapikey );
	
	return VanityTest();
} );

// ****************************************************************************
bcscale( 32 );
Tests::Run();

?>