2008-07-18 01:32:31 +02:00
< ? php
/**
2012-04-12 08:02:46 +02:00
* @ package framework
2008-07-18 01:32:31 +02:00
* @ subpackage tests
*
* @ todo Test that order of combine_files () is correct
2008-07-18 05:47:17 +02:00
* @ todo Figure out how to clear the modified state of Requirements class - might affect other tests .
2008-07-18 01:32:31 +02:00
*/
class RequirementsTest extends SapphireTest {
static $html_template = '<html><head></head><body></body></html>' ;
2010-10-13 03:15:47 +02:00
static $old_requirements = null ;
2008-08-11 09:22:50 +02:00
function testExternalUrls () {
2010-05-25 06:13:45 +02:00
$backend = new Requirements_Backend ;
$backend -> set_combined_files_enabled ( true );
$backend -> javascript ( 'http://www.mydomain.com/test.js' );
$backend -> javascript ( 'https://www.mysecuredomain.com/test.js' );
$backend -> css ( 'http://www.mydomain.com/test.css' );
$backend -> css ( 'https://www.mysecuredomain.com/test.css' );
2008-08-11 09:22:50 +02:00
2010-05-25 06:13:45 +02:00
$html = $backend -> includeInHTML ( false , self :: $html_template );
2008-08-11 09:22:50 +02:00
$this -> assertTrue (
( strpos ( $html , 'http://www.mydomain.com/test.js' ) !== false ),
'Load external javascript URL'
);
$this -> assertTrue (
( strpos ( $html , 'https://www.mysecuredomain.com/test.js' ) !== false ),
'Load external secure javascript URL'
);
$this -> assertTrue (
( strpos ( $html , 'http://www.mydomain.com/test.css' ) !== false ),
'Load external CSS URL'
);
$this -> assertTrue (
( strpos ( $html , 'https://www.mysecuredomain.com/test.css' ) !== false ),
'Load external secure CSS URL'
);
}
2010-05-25 06:13:45 +02:00
protected function setupCombinedRequirements ( $backend ) {
2011-03-30 08:49:11 +02:00
$basePath = $this -> getCurrentRelativePath ();
2010-05-25 06:13:45 +02:00
$backend -> clear ();
2010-05-25 06:15:43 +02:00
$backend -> setCombinedFilesFolder ( 'assets' );
2010-05-25 06:13:45 +02:00
// clearing all previously generated requirements (just in case)
$backend -> clear_combined_files ();
$backend -> delete_combined_files ( 'RequirementsTest_bc.js' );
// require files normally (e.g. called from a FormField instance)
2011-03-30 08:49:11 +02:00
$backend -> javascript ( $basePath . '/RequirementsTest_a.js' );
$backend -> javascript ( $basePath . '/RequirementsTest_b.js' );
$backend -> javascript ( $basePath . '/RequirementsTest_c.js' );
2010-05-25 06:13:45 +02:00
// require two of those files as combined includes
$backend -> combine_files (
'RequirementsTest_bc.js' ,
array (
2011-03-30 08:49:11 +02:00
$basePath . '/RequirementsTest_b.js' ,
$basePath . '/RequirementsTest_c.js'
2010-05-25 06:13:45 +02:00
)
);
}
2010-10-15 05:09:15 +02:00
protected function setupCombinedNonrequiredRequirements ( $backend ) {
2011-03-30 08:49:11 +02:00
$basePath = $this -> getCurrentRelativePath ();
2010-10-15 05:09:15 +02:00
$backend -> clear ();
$backend -> setCombinedFilesFolder ( 'assets' );
// clearing all previously generated requirements (just in case)
$backend -> clear_combined_files ();
$backend -> delete_combined_files ( 'RequirementsTest_bc.js' );
// require files as combined includes
$backend -> combine_files (
'RequirementsTest_bc.js' ,
array (
2011-03-30 08:49:11 +02:00
$basePath . '/RequirementsTest_b.js' ,
$basePath . '/RequirementsTest_c.js'
2010-10-15 05:09:15 +02:00
)
);
}
2010-05-25 06:13:45 +02:00
2008-07-18 01:32:31 +02:00
function testCombinedJavascript () {
2010-05-25 06:13:45 +02:00
$backend = new Requirements_Backend ;
$backend -> set_combined_files_enabled ( true );
2010-05-25 06:15:43 +02:00
$backend -> setCombinedFilesFolder ( 'assets' );
2010-05-25 06:13:45 +02:00
$this -> setupCombinedRequirements ( $backend );
2008-07-18 01:32:31 +02:00
2010-05-25 06:15:43 +02:00
$combinedFilePath = Director :: baseFolder () . '/assets/' . 'RequirementsTest_bc.js' ;
2010-05-25 06:13:45 +02:00
$html = $backend -> includeInHTML ( false , self :: $html_template );
2008-08-11 08:28:29 +02:00
2008-07-18 01:32:31 +02:00
/* COMBINED JAVASCRIPT FILE IS INCLUDED IN HTML HEADER */
2008-11-01 15:04:31 +01:00
$this -> assertTrue (( bool ) preg_match ( '/src=".*\/RequirementsTest_bc\.js/' , $html ), 'combined javascript file is included in html header' );
2008-07-18 01:32:31 +02:00
/* COMBINED JAVASCRIPT FILE EXISTS */
2008-07-18 05:47:17 +02:00
$this -> assertTrue ( file_exists ( $combinedFilePath ), 'combined javascript file exists' );
2008-07-18 01:32:31 +02:00
/* COMBINED JAVASCRIPT HAS CORRECT CONTENT */
2008-07-18 05:47:17 +02:00
$this -> assertTrue (( strpos ( file_get_contents ( $combinedFilePath ), " alert('b') " ) !== false ), 'combined javascript has correct content' );
$this -> assertTrue (( strpos ( file_get_contents ( $combinedFilePath ), " alert('c') " ) !== false ), 'combined javascript has correct content' );
2011-03-30 08:49:11 +02:00
2008-07-18 01:32:31 +02:00
/* COMBINED FILES ARE NOT INCLUDED TWICE */
2008-11-01 15:04:31 +01:00
$this -> assertFalse (( bool ) preg_match ( '/src=".*\/RequirementsTest_b\.js/' , $html ), 'combined files are not included twice' );
$this -> assertFalse (( bool ) preg_match ( '/src=".*\/RequirementsTest_c\.js/' , $html ), 'combined files are not included twice' );
2008-07-18 01:32:31 +02:00
/* NORMAL REQUIREMENTS ARE STILL INCLUDED */
2008-11-01 15:04:31 +01:00
$this -> assertTrue (( bool ) preg_match ( '/src=".*\/RequirementsTest_a\.js/' , $html ), 'normal requirements are still included' );
2008-07-18 05:47:17 +02:00
2010-05-25 06:13:45 +02:00
$backend -> delete_combined_files ( 'RequirementsTest_bc.js' );
2010-10-15 05:09:15 +02:00
// Then do it again, this time not requiring the files beforehand
$backend = new Requirements_Backend ;
$backend -> set_combined_files_enabled ( true );
$backend -> setCombinedFilesFolder ( 'assets' );
$this -> setupCombinedNonrequiredRequirements ( $backend );
$combinedFilePath = Director :: baseFolder () . '/assets/' . 'RequirementsTest_bc.js' ;
$html = $backend -> includeInHTML ( false , self :: $html_template );
/* COMBINED JAVASCRIPT FILE IS INCLUDED IN HTML HEADER */
$this -> assertTrue (( bool ) preg_match ( '/src=".*\/RequirementsTest_bc\.js/' , $html ), 'combined javascript file is included in html header' );
/* COMBINED JAVASCRIPT FILE EXISTS */
$this -> assertTrue ( file_exists ( $combinedFilePath ), 'combined javascript file exists' );
/* COMBINED JAVASCRIPT HAS CORRECT CONTENT */
$this -> assertTrue (( strpos ( file_get_contents ( $combinedFilePath ), " alert('b') " ) !== false ), 'combined javascript has correct content' );
$this -> assertTrue (( strpos ( file_get_contents ( $combinedFilePath ), " alert('c') " ) !== false ), 'combined javascript has correct content' );
/* COMBINED FILES ARE NOT INCLUDED TWICE */
$this -> assertFalse (( bool ) preg_match ( '/src=".*\/RequirementsTest_b\.js/' , $html ), 'combined files are not included twice' );
$this -> assertFalse (( bool ) preg_match ( '/src=".*\/RequirementsTest_c\.js/' , $html ), 'combined files are not included twice' );
$backend -> delete_combined_files ( 'RequirementsTest_bc.js' );
2008-07-18 05:47:17 +02:00
}
function testBlockedCombinedJavascript () {
2011-03-30 08:49:11 +02:00
$basePath = $this -> getCurrentRelativePath ();
2010-05-25 06:13:45 +02:00
$backend = new Requirements_Backend ;
$backend -> set_combined_files_enabled ( true );
2010-05-25 06:15:43 +02:00
$backend -> setCombinedFilesFolder ( 'assets' );
$combinedFilePath = Director :: baseFolder () . '/assets/' . 'RequirementsTest_bc.js' ;
2008-08-11 09:22:50 +02:00
2008-07-18 05:47:17 +02:00
/* BLOCKED COMBINED FILES ARE NOT INCLUDED */
2010-05-25 06:13:45 +02:00
$this -> setupCombinedRequirements ( $backend );
$backend -> block ( 'RequirementsTest_bc.js' );
$backend -> delete_combined_files ( 'RequirementsTest_bc.js' );
2008-08-11 09:22:50 +02:00
2008-07-18 05:47:17 +02:00
clearstatcache (); // needed to get accurate file_exists() results
2010-05-25 06:13:45 +02:00
$html = $backend -> includeInHTML ( false , self :: $html_template );
2008-08-11 09:22:50 +02:00
2008-11-01 15:04:31 +01:00
$this -> assertFalse (( bool ) preg_match ( '/src=".*\/RequirementsTest_bc\.js/' , $html ), 'blocked combined files are not included ' );
2010-05-25 06:13:45 +02:00
$backend -> unblock ( 'RequirementsTest_bc.js' );
2008-07-18 05:47:17 +02:00
/* BLOCKED UNCOMBINED FILES ARE NOT INCLUDED */
2010-05-25 06:13:45 +02:00
$this -> setupCombinedRequirements ( $backend );
2011-03-30 08:49:11 +02:00
$backend -> block ( $basePath . '/RequirementsTest_b.js' );
2010-05-25 06:13:45 +02:00
$backend -> delete_combined_files ( 'RequirementsTest_bc.js' );
2008-07-18 05:47:17 +02:00
clearstatcache (); // needed to get accurate file_exists() results
2010-05-25 06:13:45 +02:00
$html = $backend -> includeInHTML ( false , self :: $html_template );
2008-07-18 05:47:17 +02:00
$this -> assertFalse (( strpos ( file_get_contents ( $combinedFilePath ), " alert('b') " ) !== false ), 'blocked uncombined files are not included' );
2010-05-25 06:13:45 +02:00
$backend -> unblock ( 'RequirementsTest_b.js' );
2008-07-18 05:47:17 +02:00
/* A SINGLE FILE CAN'T BE INCLUDED IN TWO COMBINED FILES */
2010-05-25 06:13:45 +02:00
$this -> setupCombinedRequirements ( $backend );
2008-07-18 05:47:17 +02:00
clearstatcache (); // needed to get accurate file_exists() results
2008-08-12 01:18:56 +02:00
// This throws a notice-level error, so we prefix with @
2010-05-25 06:13:45 +02:00
@ $backend -> combine_files (
2008-11-01 15:04:31 +01:00
'RequirementsTest_ac.js' ,
2008-07-18 05:47:17 +02:00
array (
2011-03-30 08:49:11 +02:00
$basePath . '/RequirementsTest_a.js' ,
$basePath . '/RequirementsTest_c.js'
2008-07-18 05:47:17 +02:00
)
);
2008-08-12 01:18:56 +02:00
2010-05-25 06:13:45 +02:00
$combinedFiles = $backend -> get_combine_files ();
2008-07-18 05:47:17 +02:00
$this -> assertEquals (
array_keys ( $combinedFiles ),
2008-11-01 15:04:31 +01:00
array ( 'RequirementsTest_bc.js' ),
2008-08-11 09:22:50 +02:00
" A single file can't be included in two combined files "
2008-07-18 05:47:17 +02:00
);
2008-07-18 01:32:31 +02:00
2010-05-25 06:13:45 +02:00
$backend -> delete_combined_files ( 'RequirementsTest_bc.js' );
2008-07-18 05:47:17 +02:00
}
2009-04-29 02:07:39 +02:00
function testArgsInUrls () {
2011-03-30 08:49:11 +02:00
$basePath = $this -> getCurrentRelativePath ();
2010-05-25 06:13:45 +02:00
$backend = new Requirements_Backend ;
$backend -> set_combined_files_enabled ( true );
2009-04-29 02:07:39 +02:00
2011-03-30 08:49:11 +02:00
$backend -> javascript ( $basePath . '/RequirementsTest_a.js?test=1&test=2&test=3' );
$backend -> css ( $basePath . '/RequirementsTest_a.css?test=1&test=2&test=3' );
2010-05-25 06:16:33 +02:00
$backend -> delete_combined_files ( 'RequirementsTest_bc.js' );
2009-04-29 02:07:39 +02:00
2010-05-25 06:13:45 +02:00
$html = $backend -> includeInHTML ( false , self :: $html_template );
2009-04-29 02:07:39 +02:00
/* Javascript has correct path */
$this -> assertTrue (( bool ) preg_match ( '/src=".*\/RequirementsTest_a\.js\?m=\d\d+&test=1&test=2&test=3/' , $html ), 'javascript has correct path' );
/* CSS has correct path */
$this -> assertTrue (( bool ) preg_match ( '/href=".*\/RequirementsTest_a\.css\?m=\d\d+&test=1&test=2&test=3/' , $html ), 'css has correct path' );
}
2008-11-07 03:06:28 +01:00
function testRequirementsBackend () {
2011-03-30 08:49:11 +02:00
$basePath = $this -> getCurrentRelativePath ();
2010-05-25 06:13:45 +02:00
$backend = new Requirements_Backend ();
2011-03-30 08:49:11 +02:00
$backend -> javascript ( $basePath . '/a.js' );
2008-11-07 03:06:28 +01:00
2010-05-25 06:13:45 +02:00
$this -> assertTrue ( count ( $backend -> get_javascript ()) == 1 , " There should be only 1 file included in required javascript. " );
2011-03-30 08:49:11 +02:00
$this -> assertTrue ( in_array ( $basePath . '/a.js' , $backend -> get_javascript ()), " a.js should be included in required javascript. " );
2008-11-07 03:06:28 +01:00
2011-03-30 08:49:11 +02:00
$backend -> javascript ( $basePath . '/b.js' );
2010-05-25 06:13:45 +02:00
$this -> assertTrue ( count ( $backend -> get_javascript ()) == 2 , " There should be 2 files included in required javascript. " );
2008-11-07 03:06:28 +01:00
2011-03-30 08:49:11 +02:00
$backend -> block ( $basePath . '/a.js' );
2010-05-25 06:13:45 +02:00
$this -> assertTrue ( count ( $backend -> get_javascript ()) == 1 , " There should be only 1 file included in required javascript. " );
2011-03-30 08:49:11 +02:00
$this -> assertFalse ( in_array ( $basePath . '/a.js' , $backend -> get_javascript ()), " a.js should not be included in required javascript after it has been blocked. " );
$this -> assertTrue ( in_array ( $basePath . '/b.js' , $backend -> get_javascript ()), " b.js should be included in required javascript. " );
2008-11-07 03:06:28 +01:00
2011-03-30 08:49:11 +02:00
$backend -> css ( $basePath . '/a.css' );
2010-05-25 06:13:45 +02:00
$this -> assertTrue ( count ( $backend -> get_css ()) == 1 , " There should be only 1 file included in required css. " );
2011-03-30 08:49:11 +02:00
$this -> assertArrayHasKey ( $basePath . '/a.css' , $backend -> get_css (), " a.css should be in required css. " );
2008-11-07 03:06:28 +01:00
2011-03-30 08:49:11 +02:00
$backend -> block ( $basePath . '/a.css' );
2010-05-25 06:13:45 +02:00
$this -> assertTrue ( count ( $backend -> get_css ()) == 0 , " There should be nothing in required css after file has been blocked. " );
2008-11-07 03:06:28 +01:00
}
2010-10-13 03:15:47 +02:00
function testConditionalTemplateRequire () {
2011-03-30 08:49:11 +02:00
$basePath = $this -> getCurrentRelativePath ();
2012-04-14 08:48:28 +02:00
// we're asserting "framework", so set the relative path accordingly in case FRAMEWORK_DIR was changed to something else
$basePath = 'framework' . substr ( $basePath , strlen ( FRAMEWORK_DIR ));
2010-10-13 03:15:47 +02:00
$backend = new RequirementsTest_Backend ();
$holder = Requirements :: backend ();
Requirements :: set_backend ( $backend );
$data = new ArrayData ( array (
'FailTest' => true ,
));
$data -> renderWith ( 'RequirementsTest_Conditionals' );
2011-03-30 08:49:11 +02:00
$backend -> assertFileIncluded ( 'css' , $basePath . '/RequirementsTest_a.css' );
$backend -> assertFileIncluded ( 'js' , array ( $basePath . '/RequirementsTest_b.js' , $basePath . '/RequirementsTest_c.js' ));
$backend -> assertFileNotIncluded ( 'js' , $basePath . '/RequirementsTest_a.js' );
$backend -> assertFileNotIncluded ( 'css' , array ( $basePath . '/RequirementsTest_b.css' , $basePath . '/RequirementsTest_c.css' ));
2010-10-13 03:15:47 +02:00
$backend -> clear ();
$data = new ArrayData ( array (
'FailTest' => false ,
));
$data -> renderWith ( 'RequirementsTest_Conditionals' );
2011-03-30 08:49:11 +02:00
$backend -> assertFileNotIncluded ( 'css' , $basePath . '/RequirementsTest_a.css' );
$backend -> assertFileNotIncluded ( 'js' , array ( $basePath . '/RequirementsTest_b.js' , $basePath . '/RequirementsTest_c.js' ));
$backend -> assertFileIncluded ( 'js' , $basePath . '/RequirementsTest_a.js' );
$backend -> assertFileIncluded ( 'css' , array ( $basePath . '/RequirementsTest_b.css' , $basePath . '/RequirementsTest_c.css' ));
2010-10-13 03:15:47 +02:00
Requirements :: set_backend ( $holder );
}
2011-12-23 16:33:45 +01:00
function testJsWriteToBody () {
$backend = new Requirements_Backend ();
$backend -> javascript ( 'http://www.mydomain.com/test.js' );
// Test matching with HTML5 <header> tags as well
$template = '<html><head></head><body><header>My header</header><p>Body</p></body></html>' ;
$backend -> set_write_js_to_body ( false );
$html = $backend -> includeInHTML ( false , $template );
$this -> assertContains ( '<head><script' , $html );
$backend -> set_write_js_to_body ( true );
$html = $backend -> includeInHTML ( false , $template );
$this -> assertNotContains ( '<head><script' , $html );
$this -> assertContains ( '</script></body>' , $html );
}
2010-10-13 03:15:47 +02:00
}
class RequirementsTest_Backend extends Requirements_Backend implements TestOnly {
function assertFileIncluded ( $type , $files ) {
$type = strtolower ( $type );
switch ( strtolower ( $type )) {
case 'css' :
$var = 'css' ;
$type = 'CSS' ;
break ;
case 'js' :
case 'javascript' :
case 'script' :
$var = 'javascript' ;
$type = 'JavaScript' ;
break ;
}
if ( is_array ( $files )) {
$failedMatches = array ();
foreach ( $files as $file ) {
if ( ! array_key_exists ( $file , $this -> $var )) {
$failedMatches [] = $file ;
}
}
if ( count ( $failedMatches ) > 0 ) throw new PHPUnit_Framework_AssertionFailedError (
" Failed asserting the $type files ' "
. implode ( " ', ' " , $failedMatches )
. " ' have exact matches in the required elements: \n ' "
. implode ( " ' \n ' " , array_keys ( $this -> $var )) . " ' "
);
} else {
if ( ! array_key_exists ( $files , $this -> $var )) {
throw new PHPUnit_Framework_AssertionFailedError (
" Failed asserting the $type file ' $files ' has an exact match in the required elements: \n ' "
. implode ( " ' \n ' " , array_keys ( $this -> $var )) . " ' "
);
}
}
}
function assertFileNotIncluded ( $type , $files ) {
$type = strtolower ( $type );
switch ( $type ) {
case 'css' :
$var = 'css' ;
$type = 'CSS' ;
break ;
case 'js' :
case 'javascript' :
case 'script' :
$var = 'javascript' ;
$type = 'JavaScript' ;
break ;
}
if ( is_array ( $files )) {
$failedMatches = array ();
foreach ( $files as $file ) {
if ( array_key_exists ( $file , $this -> $var )) {
$failedMatches [] = $file ;
}
}
if ( count ( $failedMatches ) > 0 ) throw new PHPUnit_Framework_AssertionFailedError (
" Failed asserting the $type files ' "
. implode ( " ', ' " , $failedMatches )
. " ' do not have exact matches in the required elements: \n ' "
. implode ( " ' \n ' " , array_keys ( $this -> $var )) . " ' "
);
} else {
if ( array_key_exists ( $files , $this -> $var )) {
throw new PHPUnit_Framework_AssertionFailedError (
" Failed asserting the $type file ' $files ' does not have an exact match in the required elements: \n ' "
. implode ( " ' \n ' " , array_keys ( $this -> $var )) . " ' "
);
}
}
}
}
