drupal_web_test_case.php 131 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757
  1. <?php
  2. /**
  3. * Global variable that holds information about the tests being run.
  4. *
  5. * An array, with the following keys:
  6. * - 'test_run_id': the ID of the test being run, in the form 'simpletest_%"
  7. * - 'in_child_site': TRUE if the current request is a cURL request from
  8. * the parent site.
  9. *
  10. * @var array
  11. */
  12. global $drupal_test_info;
  13. /**
  14. * Base class for Drupal tests.
  15. *
  16. * Do not extend this class, use one of the subclasses in this file.
  17. */
  18. abstract class DrupalTestCase {
  19. /**
  20. * The test run ID.
  21. *
  22. * @var string
  23. */
  24. protected $testId;
  25. /**
  26. * The database prefix of this test run.
  27. *
  28. * @var string
  29. */
  30. protected $databasePrefix = NULL;
  31. /**
  32. * The original file directory, before it was changed for testing purposes.
  33. *
  34. * @var string
  35. */
  36. protected $originalFileDirectory = NULL;
  37. /**
  38. * Time limit for the test.
  39. */
  40. protected $timeLimit = 500;
  41. /**
  42. * Current results of this test case.
  43. *
  44. * @var Array
  45. */
  46. public $results = array(
  47. '#pass' => 0,
  48. '#fail' => 0,
  49. '#exception' => 0,
  50. '#debug' => 0,
  51. );
  52. /**
  53. * Assertions thrown in that test case.
  54. *
  55. * @var Array
  56. */
  57. protected $assertions = array();
  58. /**
  59. * This class is skipped when looking for the source of an assertion.
  60. *
  61. * When displaying which function an assert comes from, it's not too useful
  62. * to see "drupalWebTestCase->drupalLogin()', we would like to see the test
  63. * that called it. So we need to skip the classes defining these helper
  64. * methods.
  65. */
  66. protected $skipClasses = array(__CLASS__ => TRUE);
  67. /**
  68. * Flag to indicate whether the test has been set up.
  69. *
  70. * The setUp() method isolates the test from the parent Drupal site by
  71. * creating a random prefix for the database and setting up a clean file
  72. * storage directory. The tearDown() method then cleans up this test
  73. * environment. We must ensure that setUp() has been run. Otherwise,
  74. * tearDown() will act on the parent Drupal site rather than the test
  75. * environment, destroying live data.
  76. */
  77. protected $setup = FALSE;
  78. protected $setupDatabasePrefix = FALSE;
  79. protected $setupEnvironment = FALSE;
  80. /**
  81. * Constructor for DrupalTestCase.
  82. *
  83. * @param $test_id
  84. * Tests with the same id are reported together.
  85. */
  86. public function __construct($test_id = NULL) {
  87. $this->testId = $test_id;
  88. }
  89. /**
  90. * Internal helper: stores the assert.
  91. *
  92. * @param $status
  93. * Can be 'pass', 'fail', 'exception'.
  94. * TRUE is a synonym for 'pass', FALSE for 'fail'.
  95. * @param $message
  96. * The message string.
  97. * @param $group
  98. * Which group this assert belongs to.
  99. * @param $caller
  100. * By default, the assert comes from a function whose name starts with
  101. * 'test'. Instead, you can specify where this assert originates from
  102. * by passing in an associative array as $caller. Key 'file' is
  103. * the name of the source file, 'line' is the line number and 'function'
  104. * is the caller function itself.
  105. */
  106. protected function assert($status, $message = '', $group = 'Other', array $caller = NULL) {
  107. // Convert boolean status to string status.
  108. if (is_bool($status)) {
  109. $status = $status ? 'pass' : 'fail';
  110. }
  111. // Increment summary result counter.
  112. $this->results['#' . $status]++;
  113. // Get the function information about the call to the assertion method.
  114. if (!$caller) {
  115. $caller = $this->getAssertionCall();
  116. }
  117. // Creation assertion array that can be displayed while tests are running.
  118. $this->assertions[] = $assertion = array(
  119. 'test_id' => $this->testId,
  120. 'test_class' => get_class($this),
  121. 'status' => $status,
  122. 'message' => $message,
  123. 'message_group' => $group,
  124. 'function' => $caller['function'],
  125. 'line' => $caller['line'],
  126. 'file' => $caller['file'],
  127. );
  128. // Store assertion for display after the test has completed.
  129. self::getDatabaseConnection()
  130. ->insert('simpletest')
  131. ->fields($assertion)
  132. ->execute();
  133. // We do not use a ternary operator here to allow a breakpoint on
  134. // test failure.
  135. if ($status == 'pass') {
  136. return TRUE;
  137. }
  138. else {
  139. return FALSE;
  140. }
  141. }
  142. /**
  143. * Returns the database connection to the site running Simpletest.
  144. *
  145. * @return DatabaseConnection
  146. * The database connection to use for inserting assertions.
  147. */
  148. public static function getDatabaseConnection() {
  149. try {
  150. $connection = Database::getConnection('default', 'simpletest_original_default');
  151. }
  152. catch (DatabaseConnectionNotDefinedException $e) {
  153. // If the test was not set up, the simpletest_original_default
  154. // connection does not exist.
  155. $connection = Database::getConnection('default', 'default');
  156. }
  157. return $connection;
  158. }
  159. /**
  160. * Store an assertion from outside the testing context.
  161. *
  162. * This is useful for inserting assertions that can only be recorded after
  163. * the test case has been destroyed, such as PHP fatal errors. The caller
  164. * information is not automatically gathered since the caller is most likely
  165. * inserting the assertion on behalf of other code. In all other respects
  166. * the method behaves just like DrupalTestCase::assert() in terms of storing
  167. * the assertion.
  168. *
  169. * @return
  170. * Message ID of the stored assertion.
  171. *
  172. * @see DrupalTestCase::assert()
  173. * @see DrupalTestCase::deleteAssert()
  174. */
  175. public static function insertAssert($test_id, $test_class, $status, $message = '', $group = 'Other', array $caller = array()) {
  176. // Convert boolean status to string status.
  177. if (is_bool($status)) {
  178. $status = $status ? 'pass' : 'fail';
  179. }
  180. $caller += array(
  181. 'function' => t('Unknown'),
  182. 'line' => 0,
  183. 'file' => t('Unknown'),
  184. );
  185. $assertion = array(
  186. 'test_id' => $test_id,
  187. 'test_class' => $test_class,
  188. 'status' => $status,
  189. 'message' => $message,
  190. 'message_group' => $group,
  191. 'function' => $caller['function'],
  192. 'line' => $caller['line'],
  193. 'file' => $caller['file'],
  194. );
  195. return self::getDatabaseConnection()
  196. ->insert('simpletest')
  197. ->fields($assertion)
  198. ->execute();
  199. }
  200. /**
  201. * Delete an assertion record by message ID.
  202. *
  203. * @param $message_id
  204. * Message ID of the assertion to delete.
  205. * @return
  206. * TRUE if the assertion was deleted, FALSE otherwise.
  207. *
  208. * @see DrupalTestCase::insertAssert()
  209. */
  210. public static function deleteAssert($message_id) {
  211. return (bool) self::getDatabaseConnection()
  212. ->delete('simpletest')
  213. ->condition('message_id', $message_id)
  214. ->execute();
  215. }
  216. /**
  217. * Cycles through backtrace until the first non-assertion method is found.
  218. *
  219. * @return
  220. * Array representing the true caller.
  221. */
  222. protected function getAssertionCall() {
  223. $backtrace = debug_backtrace();
  224. // The first element is the call. The second element is the caller.
  225. // We skip calls that occurred in one of the methods of our base classes
  226. // or in an assertion function.
  227. while (($caller = $backtrace[1]) &&
  228. ((isset($caller['class']) && isset($this->skipClasses[$caller['class']])) ||
  229. substr($caller['function'], 0, 6) == 'assert')) {
  230. // We remove that call.
  231. array_shift($backtrace);
  232. }
  233. return _drupal_get_last_caller($backtrace);
  234. }
  235. /**
  236. * Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
  237. *
  238. * @param $value
  239. * The value on which the assertion is to be done.
  240. * @param $message
  241. * The message to display along with the assertion.
  242. * @param $group
  243. * The type of assertion - examples are "Browser", "PHP".
  244. * @return
  245. * TRUE if the assertion succeeded, FALSE otherwise.
  246. */
  247. protected function assertTrue($value, $message = '', $group = 'Other') {
  248. return $this->assert((bool) $value, $message ? $message : t('Value @value is TRUE.', array('@value' => var_export($value, TRUE))), $group);
  249. }
  250. /**
  251. * Check to see if a value is false (an empty string, 0, NULL, or FALSE).
  252. *
  253. * @param $value
  254. * The value on which the assertion is to be done.
  255. * @param $message
  256. * The message to display along with the assertion.
  257. * @param $group
  258. * The type of assertion - examples are "Browser", "PHP".
  259. * @return
  260. * TRUE if the assertion succeeded, FALSE otherwise.
  261. */
  262. protected function assertFalse($value, $message = '', $group = 'Other') {
  263. return $this->assert(!$value, $message ? $message : t('Value @value is FALSE.', array('@value' => var_export($value, TRUE))), $group);
  264. }
  265. /**
  266. * Check to see if a value is NULL.
  267. *
  268. * @param $value
  269. * The value on which the assertion is to be done.
  270. * @param $message
  271. * The message to display along with the assertion.
  272. * @param $group
  273. * The type of assertion - examples are "Browser", "PHP".
  274. * @return
  275. * TRUE if the assertion succeeded, FALSE otherwise.
  276. */
  277. protected function assertNull($value, $message = '', $group = 'Other') {
  278. return $this->assert(!isset($value), $message ? $message : t('Value @value is NULL.', array('@value' => var_export($value, TRUE))), $group);
  279. }
  280. /**
  281. * Check to see if a value is not NULL.
  282. *
  283. * @param $value
  284. * The value on which the assertion is to be done.
  285. * @param $message
  286. * The message to display along with the assertion.
  287. * @param $group
  288. * The type of assertion - examples are "Browser", "PHP".
  289. * @return
  290. * TRUE if the assertion succeeded, FALSE otherwise.
  291. */
  292. protected function assertNotNull($value, $message = '', $group = 'Other') {
  293. return $this->assert(isset($value), $message ? $message : t('Value @value is not NULL.', array('@value' => var_export($value, TRUE))), $group);
  294. }
  295. /**
  296. * Check to see if two values are equal.
  297. *
  298. * @param $first
  299. * The first value to check.
  300. * @param $second
  301. * The second value to check.
  302. * @param $message
  303. * The message to display along with the assertion.
  304. * @param $group
  305. * The type of assertion - examples are "Browser", "PHP".
  306. * @return
  307. * TRUE if the assertion succeeded, FALSE otherwise.
  308. */
  309. protected function assertEqual($first, $second, $message = '', $group = 'Other') {
  310. return $this->assert($first == $second, $message ? $message : t('Value @first is equal to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
  311. }
  312. /**
  313. * Check to see if two values are not equal.
  314. *
  315. * @param $first
  316. * The first value to check.
  317. * @param $second
  318. * The second value to check.
  319. * @param $message
  320. * The message to display along with the assertion.
  321. * @param $group
  322. * The type of assertion - examples are "Browser", "PHP".
  323. * @return
  324. * TRUE if the assertion succeeded, FALSE otherwise.
  325. */
  326. protected function assertNotEqual($first, $second, $message = '', $group = 'Other') {
  327. return $this->assert($first != $second, $message ? $message : t('Value @first is not equal to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
  328. }
  329. /**
  330. * Check to see if two values are identical.
  331. *
  332. * @param $first
  333. * The first value to check.
  334. * @param $second
  335. * The second value to check.
  336. * @param $message
  337. * The message to display along with the assertion.
  338. * @param $group
  339. * The type of assertion - examples are "Browser", "PHP".
  340. * @return
  341. * TRUE if the assertion succeeded, FALSE otherwise.
  342. */
  343. protected function assertIdentical($first, $second, $message = '', $group = 'Other') {
  344. return $this->assert($first === $second, $message ? $message : t('Value @first is identical to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
  345. }
  346. /**
  347. * Check to see if two values are not identical.
  348. *
  349. * @param $first
  350. * The first value to check.
  351. * @param $second
  352. * The second value to check.
  353. * @param $message
  354. * The message to display along with the assertion.
  355. * @param $group
  356. * The type of assertion - examples are "Browser", "PHP".
  357. * @return
  358. * TRUE if the assertion succeeded, FALSE otherwise.
  359. */
  360. protected function assertNotIdentical($first, $second, $message = '', $group = 'Other') {
  361. return $this->assert($first !== $second, $message ? $message : t('Value @first is not identical to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
  362. }
  363. /**
  364. * Fire an assertion that is always positive.
  365. *
  366. * @param $message
  367. * The message to display along with the assertion.
  368. * @param $group
  369. * The type of assertion - examples are "Browser", "PHP".
  370. * @return
  371. * TRUE.
  372. */
  373. protected function pass($message = NULL, $group = 'Other') {
  374. return $this->assert(TRUE, $message, $group);
  375. }
  376. /**
  377. * Fire an assertion that is always negative.
  378. *
  379. * @param $message
  380. * The message to display along with the assertion.
  381. * @param $group
  382. * The type of assertion - examples are "Browser", "PHP".
  383. * @return
  384. * FALSE.
  385. */
  386. protected function fail($message = NULL, $group = 'Other') {
  387. return $this->assert(FALSE, $message, $group);
  388. }
  389. /**
  390. * Fire an error assertion.
  391. *
  392. * @param $message
  393. * The message to display along with the assertion.
  394. * @param $group
  395. * The type of assertion - examples are "Browser", "PHP".
  396. * @param $caller
  397. * The caller of the error.
  398. * @return
  399. * FALSE.
  400. */
  401. protected function error($message = '', $group = 'Other', array $caller = NULL) {
  402. if ($group == 'User notice') {
  403. // Since 'User notice' is set by trigger_error() which is used for debug
  404. // set the message to a status of 'debug'.
  405. return $this->assert('debug', $message, 'Debug', $caller);
  406. }
  407. return $this->assert('exception', $message, $group, $caller);
  408. }
  409. /**
  410. * Logs a verbose message in a text file.
  411. *
  412. * The link to the verbose message will be placed in the test results as a
  413. * passing assertion with the text '[verbose message]'.
  414. *
  415. * @param $message
  416. * The verbose message to be stored.
  417. *
  418. * @see simpletest_verbose()
  419. */
  420. protected function verbose($message) {
  421. if ($id = simpletest_verbose($message)) {
  422. $class_safe = str_replace('\\', '_', get_class($this));
  423. $url = file_create_url($this->originalFileDirectory . '/simpletest/verbose/' . $class_safe . '-' . $id . '.html');
  424. $this->error(l(t('Verbose message'), $url, array('attributes' => array('target' => '_blank'))), 'User notice');
  425. }
  426. }
  427. /**
  428. * Run all tests in this class.
  429. *
  430. * Regardless of whether $methods are passed or not, only method names
  431. * starting with "test" are executed.
  432. *
  433. * @param $methods
  434. * (optional) A list of method names in the test case class to run; e.g.,
  435. * array('testFoo', 'testBar'). By default, all methods of the class are
  436. * taken into account, but it can be useful to only run a few selected test
  437. * methods during debugging.
  438. */
  439. public function run(array $methods = array()) {
  440. // Initialize verbose debugging.
  441. $class = get_class($this);
  442. simpletest_verbose(NULL, variable_get('file_public_path', conf_path() . '/files'), str_replace('\\', '_', $class));
  443. // HTTP auth settings (<username>:<password>) for the simpletest browser
  444. // when sending requests to the test site.
  445. $this->httpauth_method = variable_get('simpletest_httpauth_method', CURLAUTH_BASIC);
  446. $username = variable_get('simpletest_httpauth_username', NULL);
  447. $password = variable_get('simpletest_httpauth_password', NULL);
  448. if ($username && $password) {
  449. $this->httpauth_credentials = $username . ':' . $password;
  450. }
  451. set_error_handler(array($this, 'errorHandler'));
  452. // Iterate through all the methods in this class, unless a specific list of
  453. // methods to run was passed.
  454. $class_methods = get_class_methods($class);
  455. if ($methods) {
  456. $class_methods = array_intersect($class_methods, $methods);
  457. }
  458. foreach ($class_methods as $method) {
  459. // If the current method starts with "test", run it - it's a test.
  460. if (strtolower(substr($method, 0, 4)) == 'test') {
  461. // Insert a fail record. This will be deleted on completion to ensure
  462. // that testing completed.
  463. $method_info = new ReflectionMethod($class, $method);
  464. $caller = array(
  465. 'file' => $method_info->getFileName(),
  466. 'line' => $method_info->getStartLine(),
  467. 'function' => $class . '->' . $method . '()',
  468. );
  469. $completion_check_id = DrupalTestCase::insertAssert($this->testId, $class, FALSE, t('The test did not complete due to a fatal error.'), 'Completion check', $caller);
  470. $this->setUp();
  471. if ($this->setup) {
  472. try {
  473. $this->$method();
  474. // Finish up.
  475. }
  476. catch (Exception $e) {
  477. $this->exceptionHandler($e);
  478. }
  479. $this->tearDown();
  480. }
  481. else {
  482. $this->fail(t("The test cannot be executed because it has not been set up properly."));
  483. }
  484. // Remove the completion check record.
  485. DrupalTestCase::deleteAssert($completion_check_id);
  486. }
  487. }
  488. // Clear out the error messages and restore error handler.
  489. drupal_get_messages();
  490. restore_error_handler();
  491. }
  492. /**
  493. * Handle errors during test runs.
  494. *
  495. * Because this is registered in set_error_handler(), it has to be public.
  496. * @see set_error_handler
  497. */
  498. public function errorHandler($severity, $message, $file = NULL, $line = NULL) {
  499. if ($severity & error_reporting()) {
  500. $error_map = array(
  501. E_STRICT => 'Run-time notice',
  502. E_WARNING => 'Warning',
  503. E_NOTICE => 'Notice',
  504. E_CORE_ERROR => 'Core error',
  505. E_CORE_WARNING => 'Core warning',
  506. E_USER_ERROR => 'User error',
  507. E_USER_WARNING => 'User warning',
  508. E_USER_NOTICE => 'User notice',
  509. E_RECOVERABLE_ERROR => 'Recoverable error',
  510. );
  511. // PHP 5.3 adds new error logging constants. Add these conditionally for
  512. // backwards compatibility with PHP 5.2.
  513. if (defined('E_DEPRECATED')) {
  514. $error_map += array(
  515. E_DEPRECATED => 'Deprecated',
  516. E_USER_DEPRECATED => 'User deprecated',
  517. );
  518. }
  519. $backtrace = debug_backtrace();
  520. $this->error($message, $error_map[$severity], _drupal_get_last_caller($backtrace));
  521. }
  522. return TRUE;
  523. }
  524. /**
  525. * Handle exceptions.
  526. *
  527. * @see set_exception_handler
  528. */
  529. protected function exceptionHandler($exception) {
  530. $backtrace = $exception->getTrace();
  531. // Push on top of the backtrace the call that generated the exception.
  532. array_unshift($backtrace, array(
  533. 'line' => $exception->getLine(),
  534. 'file' => $exception->getFile(),
  535. ));
  536. require_once DRUPAL_ROOT . '/includes/errors.inc';
  537. // The exception message is run through check_plain() by _drupal_decode_exception().
  538. $this->error(t('%type: !message in %function (line %line of %file).', _drupal_decode_exception($exception)), 'Uncaught exception', _drupal_get_last_caller($backtrace));
  539. }
  540. /**
  541. * Generates a random string of ASCII characters of codes 32 to 126.
  542. *
  543. * The generated string includes alpha-numeric characters and common
  544. * miscellaneous characters. Use this method when testing general input
  545. * where the content is not restricted.
  546. *
  547. * Do not use this method when special characters are not possible (e.g., in
  548. * machine or file names that have already been validated); instead,
  549. * use DrupalWebTestCase::randomName().
  550. *
  551. * @param $length
  552. * Length of random string to generate.
  553. *
  554. * @return
  555. * Randomly generated string.
  556. *
  557. * @see DrupalWebTestCase::randomName()
  558. */
  559. public static function randomString($length = 8) {
  560. $str = '';
  561. for ($i = 0; $i < $length; $i++) {
  562. $str .= chr(mt_rand(32, 126));
  563. }
  564. return $str;
  565. }
  566. /**
  567. * Generates a random string containing letters and numbers.
  568. *
  569. * The string will always start with a letter. The letters may be upper or
  570. * lower case. This method is better for restricted inputs that do not
  571. * accept certain characters. For example, when testing input fields that
  572. * require machine readable values (i.e. without spaces and non-standard
  573. * characters) this method is best.
  574. *
  575. * Do not use this method when testing unvalidated user input. Instead, use
  576. * DrupalWebTestCase::randomString().
  577. *
  578. * @param $length
  579. * Length of random string to generate.
  580. *
  581. * @return
  582. * Randomly generated string.
  583. *
  584. * @see DrupalWebTestCase::randomString()
  585. */
  586. public static function randomName($length = 8) {
  587. $values = array_merge(range(65, 90), range(97, 122), range(48, 57));
  588. $max = count($values) - 1;
  589. $str = chr(mt_rand(97, 122));
  590. for ($i = 1; $i < $length; $i++) {
  591. $str .= chr($values[mt_rand(0, $max)]);
  592. }
  593. return $str;
  594. }
  595. /**
  596. * Converts a list of possible parameters into a stack of permutations.
  597. *
  598. * Takes a list of parameters containing possible values, and converts all of
  599. * them into a list of items containing every possible permutation.
  600. *
  601. * Example:
  602. * @code
  603. * $parameters = array(
  604. * 'one' => array(0, 1),
  605. * 'two' => array(2, 3),
  606. * );
  607. * $permutations = DrupalTestCase::generatePermutations($parameters)
  608. * // Result:
  609. * $permutations == array(
  610. * array('one' => 0, 'two' => 2),
  611. * array('one' => 1, 'two' => 2),
  612. * array('one' => 0, 'two' => 3),
  613. * array('one' => 1, 'two' => 3),
  614. * )
  615. * @endcode
  616. *
  617. * @param $parameters
  618. * An associative array of parameters, keyed by parameter name, and whose
  619. * values are arrays of parameter values.
  620. *
  621. * @return
  622. * A list of permutations, which is an array of arrays. Each inner array
  623. * contains the full list of parameters that have been passed, but with a
  624. * single value only.
  625. */
  626. public static function generatePermutations($parameters) {
  627. $all_permutations = array(array());
  628. foreach ($parameters as $parameter => $values) {
  629. $new_permutations = array();
  630. // Iterate over all values of the parameter.
  631. foreach ($values as $value) {
  632. // Iterate over all existing permutations.
  633. foreach ($all_permutations as $permutation) {
  634. // Add the new parameter value to existing permutations.
  635. $new_permutations[] = $permutation + array($parameter => $value);
  636. }
  637. }
  638. // Replace the old permutations with the new permutations.
  639. $all_permutations = $new_permutations;
  640. }
  641. return $all_permutations;
  642. }
  643. }
  644. /**
  645. * Test case for Drupal unit tests.
  646. *
  647. * These tests can not access the database nor files. Calling any Drupal
  648. * function that needs the database will throw exceptions. These include
  649. * watchdog(), module_implements(), module_invoke_all() etc.
  650. */
  651. class DrupalUnitTestCase extends DrupalTestCase {
  652. /**
  653. * Constructor for DrupalUnitTestCase.
  654. */
  655. function __construct($test_id = NULL) {
  656. parent::__construct($test_id);
  657. $this->skipClasses[__CLASS__] = TRUE;
  658. }
  659. /**
  660. * Sets up unit test environment.
  661. *
  662. * Unlike DrupalWebTestCase::setUp(), DrupalUnitTestCase::setUp() does not
  663. * install modules because tests are performed without accessing the database.
  664. * Any required files must be explicitly included by the child class setUp()
  665. * method.
  666. */
  667. protected function setUp() {
  668. global $conf;
  669. // Store necessary current values before switching to the test environment.
  670. $this->originalFileDirectory = variable_get('file_public_path', conf_path() . '/files');
  671. // Reset all statics so that test is performed with a clean environment.
  672. drupal_static_reset();
  673. // Generate temporary prefixed database to ensure that tests have a clean starting point.
  674. $this->databasePrefix = Database::getConnection()->prefixTables('{simpletest' . mt_rand(1000, 1000000) . '}');
  675. // Create test directory.
  676. $public_files_directory = $this->originalFileDirectory . '/simpletest/' . substr($this->databasePrefix, 10);
  677. file_prepare_directory($public_files_directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
  678. $conf['file_public_path'] = $public_files_directory;
  679. // Clone the current connection and replace the current prefix.
  680. $connection_info = Database::getConnectionInfo('default');
  681. Database::renameConnection('default', 'simpletest_original_default');
  682. foreach ($connection_info as $target => $value) {
  683. $connection_info[$target]['prefix'] = array(
  684. 'default' => $value['prefix']['default'] . $this->databasePrefix,
  685. );
  686. }
  687. Database::addConnectionInfo('default', 'default', $connection_info['default']);
  688. // Set user agent to be consistent with web test case.
  689. $_SERVER['HTTP_USER_AGENT'] = $this->databasePrefix;
  690. // If locale is enabled then t() will try to access the database and
  691. // subsequently will fail as the database is not accessible.
  692. $module_list = module_list();
  693. if (isset($module_list['locale'])) {
  694. // Transform the list into the format expected as input to module_list().
  695. foreach ($module_list as &$module) {
  696. $module = array('filename' => drupal_get_filename('module', $module));
  697. }
  698. $this->originalModuleList = $module_list;
  699. unset($module_list['locale']);
  700. module_list(TRUE, FALSE, FALSE, $module_list);
  701. }
  702. $this->setup = TRUE;
  703. }
  704. protected function tearDown() {
  705. global $conf;
  706. // Get back to the original connection.
  707. Database::removeConnection('default');
  708. Database::renameConnection('simpletest_original_default', 'default');
  709. $conf['file_public_path'] = $this->originalFileDirectory;
  710. // Restore modules if necessary.
  711. if (isset($this->originalModuleList)) {
  712. module_list(TRUE, FALSE, FALSE, $this->originalModuleList);
  713. }
  714. }
  715. }
  716. /**
  717. * Test case for typical Drupal tests.
  718. */
  719. class DrupalWebTestCase extends DrupalTestCase {
  720. /**
  721. * The profile to install as a basis for testing.
  722. *
  723. * @var string
  724. */
  725. protected $profile = 'standard';
  726. /**
  727. * The URL currently loaded in the internal browser.
  728. *
  729. * @var string
  730. */
  731. protected $url;
  732. /**
  733. * The handle of the current cURL connection.
  734. *
  735. * @var resource
  736. */
  737. protected $curlHandle;
  738. /**
  739. * The headers of the page currently loaded in the internal browser.
  740. *
  741. * @var Array
  742. */
  743. protected $headers;
  744. /**
  745. * The content of the page currently loaded in the internal browser.
  746. *
  747. * @var string
  748. */
  749. protected $content;
  750. /**
  751. * The content of the page currently loaded in the internal browser (plain text version).
  752. *
  753. * @var string
  754. */
  755. protected $plainTextContent;
  756. /**
  757. * The value of the Drupal.settings JavaScript variable for the page currently loaded in the internal browser.
  758. *
  759. * @var Array
  760. */
  761. protected $drupalSettings;
  762. /**
  763. * The parsed version of the page.
  764. *
  765. * @var SimpleXMLElement
  766. */
  767. protected $elements = NULL;
  768. /**
  769. * The current user logged in using the internal browser.
  770. *
  771. * @var bool
  772. */
  773. protected $loggedInUser = FALSE;
  774. /**
  775. * The current cookie file used by cURL.
  776. *
  777. * We do not reuse the cookies in further runs, so we do not need a file
  778. * but we still need cookie handling, so we set the jar to NULL.
  779. */
  780. protected $cookieFile = NULL;
  781. /**
  782. * Additional cURL options.
  783. *
  784. * DrupalWebTestCase itself never sets this but always obeys what is set.
  785. */
  786. protected $additionalCurlOptions = array();
  787. /**
  788. * The original user, before it was changed to a clean uid = 1 for testing purposes.
  789. *
  790. * @var object
  791. */
  792. protected $originalUser = NULL;
  793. /**
  794. * The original shutdown handlers array, before it was cleaned for testing purposes.
  795. *
  796. * @var array
  797. */
  798. protected $originalShutdownCallbacks = array();
  799. /**
  800. * HTTP authentication method
  801. */
  802. protected $httpauth_method = CURLAUTH_BASIC;
  803. /**
  804. * HTTP authentication credentials (<username>:<password>).
  805. */
  806. protected $httpauth_credentials = NULL;
  807. /**
  808. * The current session name, if available.
  809. */
  810. protected $session_name = NULL;
  811. /**
  812. * The current session ID, if available.
  813. */
  814. protected $session_id = NULL;
  815. /**
  816. * Whether the files were copied to the test files directory.
  817. */
  818. protected $generatedTestFiles = FALSE;
  819. /**
  820. * The number of redirects followed during the handling of a request.
  821. */
  822. protected $redirect_count;
  823. /**
  824. * Constructor for DrupalWebTestCase.
  825. */
  826. function __construct($test_id = NULL) {
  827. parent::__construct($test_id);
  828. $this->skipClasses[__CLASS__] = TRUE;
  829. }
  830. /**
  831. * Get a node from the database based on its title.
  832. *
  833. * @param $title
  834. * A node title, usually generated by $this->randomName().
  835. * @param $reset
  836. * (optional) Whether to reset the internal node_load() cache.
  837. *
  838. * @return
  839. * A node object matching $title.
  840. */
  841. function drupalGetNodeByTitle($title, $reset = FALSE) {
  842. $nodes = node_load_multiple(array(), array('title' => $title), $reset);
  843. // Load the first node returned from the database.
  844. $returned_node = reset($nodes);
  845. return $returned_node;
  846. }
  847. /**
  848. * Creates a node based on default settings.
  849. *
  850. * @param $settings
  851. * An associative array of settings to change from the defaults, keys are
  852. * node properties, for example 'title' => 'Hello, world!'.
  853. * @return
  854. * Created node object.
  855. */
  856. protected function drupalCreateNode($settings = array()) {
  857. // Populate defaults array.
  858. $settings += array(
  859. 'body' => array(LANGUAGE_NONE => array(array())),
  860. 'title' => $this->randomName(8),
  861. 'comment' => 2,
  862. 'changed' => REQUEST_TIME,
  863. 'moderate' => 0,
  864. 'promote' => 0,
  865. 'revision' => 1,
  866. 'log' => '',
  867. 'status' => 1,
  868. 'sticky' => 0,
  869. 'type' => 'page',
  870. 'revisions' => NULL,
  871. 'language' => LANGUAGE_NONE,
  872. );
  873. // Use the original node's created time for existing nodes.
  874. if (isset($settings['created']) && !isset($settings['date'])) {
  875. $settings['date'] = format_date($settings['created'], 'custom', 'Y-m-d H:i:s O');
  876. }
  877. // If the node's user uid is not specified manually, use the currently
  878. // logged in user if available, or else the user running the test.
  879. if (!isset($settings['uid'])) {
  880. if ($this->loggedInUser) {
  881. $settings['uid'] = $this->loggedInUser->uid;
  882. }
  883. else {
  884. global $user;
  885. $settings['uid'] = $user->uid;
  886. }
  887. }
  888. // Merge body field value and format separately.
  889. $body = array(
  890. 'value' => $this->randomName(32),
  891. 'format' => filter_default_format(),
  892. );
  893. $settings['body'][$settings['language']][0] += $body;
  894. $node = (object) $settings;
  895. node_save($node);
  896. // Small hack to link revisions to our test user.
  897. db_update('node_revision')
  898. ->fields(array('uid' => $node->uid))
  899. ->condition('vid', $node->vid)
  900. ->execute();
  901. return $node;
  902. }
  903. /**
  904. * Creates a custom content type based on default settings.
  905. *
  906. * @param $settings
  907. * An array of settings to change from the defaults.
  908. * Example: 'type' => 'foo'.
  909. * @return
  910. * Created content type.
  911. */
  912. protected function drupalCreateContentType($settings = array()) {
  913. // Find a non-existent random type name.
  914. do {
  915. $name = strtolower($this->randomName(8));
  916. } while (node_type_get_type($name));
  917. // Populate defaults array.
  918. $defaults = array(
  919. 'type' => $name,
  920. 'name' => $name,
  921. 'base' => 'node_content',
  922. 'description' => '',
  923. 'help' => '',
  924. 'title_label' => 'Title',
  925. 'body_label' => 'Body',
  926. 'has_title' => 1,
  927. 'has_body' => 1,
  928. );
  929. // Imposed values for a custom type.
  930. $forced = array(
  931. 'orig_type' => '',
  932. 'old_type' => '',
  933. 'module' => 'node',
  934. 'custom' => 1,
  935. 'modified' => 1,
  936. 'locked' => 0,
  937. );
  938. $type = $forced + $settings + $defaults;
  939. $type = (object) $type;
  940. $saved_type = node_type_save($type);
  941. node_types_rebuild();
  942. menu_rebuild();
  943. node_add_body_field($type);
  944. $this->assertEqual($saved_type, SAVED_NEW, t('Created content type %type.', array('%type' => $type->type)));
  945. // Reset permissions so that permissions for this content type are available.
  946. $this->checkPermissions(array(), TRUE);
  947. return $type;
  948. }
  949. /**
  950. * Get a list files that can be used in tests.
  951. *
  952. * @param $type
  953. * File type, possible values: 'binary', 'html', 'image', 'javascript', 'php', 'sql', 'text'.
  954. * @param $size
  955. * File size in bytes to match. Please check the tests/files folder.
  956. * @return
  957. * List of files that match filter.
  958. */
  959. protected function drupalGetTestFiles($type, $size = NULL) {
  960. if (empty($this->generatedTestFiles)) {
  961. // Generate binary test files.
  962. $lines = array(64, 1024);
  963. $count = 0;
  964. foreach ($lines as $line) {
  965. simpletest_generate_file('binary-' . $count++, 64, $line, 'binary');
  966. }
  967. // Generate text test files.
  968. $lines = array(16, 256, 1024, 2048, 20480);
  969. $count = 0;
  970. foreach ($lines as $line) {
  971. simpletest_generate_file('text-' . $count++, 64, $line);
  972. }
  973. // Copy other test files from simpletest.
  974. $original = drupal_get_path('module', 'simpletest') . '/files';
  975. $files = file_scan_directory($original, '/(html|image|javascript|php|sql)-.*/');
  976. foreach ($files as $file) {
  977. file_unmanaged_copy($file->uri, variable_get('file_public_path', conf_path() . '/files'));
  978. }
  979. $this->generatedTestFiles = TRUE;
  980. }
  981. $files = array();
  982. // Make sure type is valid.
  983. if (in_array($type, array('binary', 'html', 'image', 'javascript', 'php', 'sql', 'text'))) {
  984. $files = file_scan_directory('public://', '/' . $type . '\-.*/');
  985. // If size is set then remove any files that are not of that size.
  986. if ($size !== NULL) {
  987. foreach ($files as $file) {
  988. $stats = stat($file->uri);
  989. if ($stats['size'] != $size) {
  990. unset($files[$file->uri]);
  991. }
  992. }
  993. }
  994. }
  995. usort($files, array($this, 'drupalCompareFiles'));
  996. return $files;
  997. }
  998. /**
  999. * Compare two files based on size and file name.
  1000. */
  1001. protected function drupalCompareFiles($file1, $file2) {
  1002. $compare_size = filesize($file1->uri) - filesize($file2->uri);
  1003. if ($compare_size) {
  1004. // Sort by file size.
  1005. return $compare_size;
  1006. }
  1007. else {
  1008. // The files were the same size, so sort alphabetically.
  1009. return strnatcmp($file1->name, $file2->name);
  1010. }
  1011. }
  1012. /**
  1013. * Create a user with a given set of permissions.
  1014. *
  1015. * @param array $permissions
  1016. * Array of permission names to assign to user. Note that the user always
  1017. * has the default permissions derived from the "authenticated users" role.
  1018. *
  1019. * @return object|false
  1020. * A fully loaded user object with pass_raw property, or FALSE if account
  1021. * creation fails.
  1022. */
  1023. protected function drupalCreateUser(array $permissions = array()) {
  1024. // Create a role with the given permission set, if any.
  1025. $rid = FALSE;
  1026. if ($permissions) {
  1027. $rid = $this->drupalCreateRole($permissions);
  1028. if (!$rid) {
  1029. return FALSE;
  1030. }
  1031. }
  1032. // Create a user assigned to that role.
  1033. $edit = array();
  1034. $edit['name'] = $this->randomName();
  1035. $edit['mail'] = $edit['name'] . '@example.com';
  1036. $edit['pass'] = user_password();
  1037. $edit['status'] = 1;
  1038. if ($rid) {
  1039. $edit['roles'] = array($rid => $rid);
  1040. }
  1041. $account = user_save(drupal_anonymous_user(), $edit);
  1042. $this->assertTrue(!empty($account->uid), t('User created with name %name and pass %pass', array('%name' => $edit['name'], '%pass' => $edit['pass'])), t('User login'));
  1043. if (empty($account->uid)) {
  1044. return FALSE;
  1045. }
  1046. // Add the raw password so that we can log in as this user.
  1047. $account->pass_raw = $edit['pass'];
  1048. return $account;
  1049. }
  1050. /**
  1051. * Creates a role with specified permissions.
  1052. *
  1053. * @param $permissions
  1054. * Array of permission names to assign to role.
  1055. * @param $name
  1056. * (optional) String for the name of the role. Defaults to a random string.
  1057. * @return
  1058. * Role ID of newly created role, or FALSE if role creation failed.
  1059. */
  1060. protected function drupalCreateRole(array $permissions, $name = NULL) {
  1061. // Generate random name if it was not passed.
  1062. if (!$name) {
  1063. $name = $this->randomName();
  1064. }
  1065. // Check the all the permissions strings are valid.
  1066. if (!$this->checkPermissions($permissions)) {
  1067. return FALSE;
  1068. }
  1069. // Create new role.
  1070. $role = new stdClass();
  1071. $role->name = $name;
  1072. user_role_save($role);
  1073. user_role_grant_permissions($role->rid, $permissions);
  1074. $this->assertTrue(isset($role->rid), t('Created role of name: @name, id: @rid', array('@name' => $name, '@rid' => (isset($role->rid) ? $role->rid : t('-n/a-')))), t('Role'));
  1075. if ($role && !empty($role->rid)) {
  1076. $count = db_query('SELECT COUNT(*) FROM {role_permission} WHERE rid = :rid', array(':rid' => $role->rid))->fetchField();
  1077. $this->assertTrue($count == count($permissions), t('Created permissions: @perms', array('@perms' => implode(', ', $permissions))), t('Role'));
  1078. return $role->rid;
  1079. }
  1080. else {
  1081. return FALSE;
  1082. }
  1083. }
  1084. /**
  1085. * Check to make sure that the array of permissions are valid.
  1086. *
  1087. * @param $permissions
  1088. * Permissions to check.
  1089. * @param $reset
  1090. * Reset cached available permissions.
  1091. * @return
  1092. * TRUE or FALSE depending on whether the permissions are valid.
  1093. */
  1094. protected function checkPermissions(array $permissions, $reset = FALSE) {
  1095. $available = &drupal_static(__FUNCTION__);
  1096. if (!isset($available) || $reset) {
  1097. $available = array_keys(module_invoke_all('permission'));
  1098. }
  1099. $valid = TRUE;
  1100. foreach ($permissions as $permission) {
  1101. if (!in_array($permission, $available)) {
  1102. $this->fail(t('Invalid permission %permission.', array('%permission' => $permission)), t('Role'));
  1103. $valid = FALSE;
  1104. }
  1105. }
  1106. return $valid;
  1107. }
  1108. /**
  1109. * Log in a user with the internal browser.
  1110. *
  1111. * If a user is already logged in, then the current user is logged out before
  1112. * logging in the specified user.
  1113. *
  1114. * Please note that neither the global $user nor the passed-in user object is
  1115. * populated with data of the logged in user. If you need full access to the
  1116. * user object after logging in, it must be updated manually. If you also need
  1117. * access to the plain-text password of the user (set by drupalCreateUser()),
  1118. * e.g. to log in the same user again, then it must be re-assigned manually.
  1119. * For example:
  1120. * @code
  1121. * // Create a user.
  1122. * $account = $this->drupalCreateUser(array());
  1123. * $this->drupalLogin($account);
  1124. * // Load real user object.
  1125. * $pass_raw = $account->pass_raw;
  1126. * $account = user_load($account->uid);
  1127. * $account->pass_raw = $pass_raw;
  1128. * @endcode
  1129. *
  1130. * @param $account
  1131. * User object representing the user to log in.
  1132. *
  1133. * @see drupalCreateUser()
  1134. */
  1135. protected function drupalLogin(stdClass $account) {
  1136. if ($this->loggedInUser) {
  1137. $this->drupalLogout();
  1138. }
  1139. $edit = array(
  1140. 'name' => $account->name,
  1141. 'pass' => $account->pass_raw
  1142. );
  1143. $this->drupalPost('user', $edit, t('Log in'));
  1144. // If a "log out" link appears on the page, it is almost certainly because
  1145. // the login was successful.
  1146. $pass = $this->assertLink(t('Log out'), 0, t('User %name successfully logged in.', array('%name' => $account->name)), t('User login'));
  1147. if ($pass) {
  1148. $this->loggedInUser = $account;
  1149. }
  1150. }
  1151. /**
  1152. * Generate a token for the currently logged in user.
  1153. */
  1154. protected function drupalGetToken($value = '') {
  1155. $private_key = drupal_get_private_key();
  1156. return drupal_hmac_base64($value, $this->session_id . $private_key);
  1157. }
  1158. /*
  1159. * Logs a user out of the internal browser, then check the login page to confirm logout.
  1160. */
  1161. protected function drupalLogout() {
  1162. // Make a request to the logout page, and redirect to the user page, the
  1163. // idea being if you were properly logged out you should be seeing a login
  1164. // screen.
  1165. $this->drupalGet('user/logout');
  1166. $this->drupalGet('user');
  1167. $pass = $this->assertField('name', t('Username field found.'), t('Logout'));
  1168. $pass = $pass && $this->assertField('pass', t('Password field found.'), t('Logout'));
  1169. if ($pass) {
  1170. $this->loggedInUser = FALSE;
  1171. }
  1172. }
  1173. /**
  1174. * Generates a database prefix for running tests.
  1175. *
  1176. * The generated database table prefix is used for the Drupal installation
  1177. * being performed for the test. It is also used as user agent HTTP header
  1178. * value by the cURL-based browser of DrupalWebTestCase, which is sent
  1179. * to the Drupal installation of the test. During early Drupal bootstrap, the
  1180. * user agent HTTP header is parsed, and if it matches, all database queries
  1181. * use the database table prefix that has been generated here.
  1182. *
  1183. * @see DrupalWebTestCase::curlInitialize()
  1184. * @see drupal_valid_test_ua()
  1185. * @see DrupalWebTestCase::setUp()
  1186. */
  1187. protected function prepareDatabasePrefix() {
  1188. $this->databasePrefix = 'simpletest' . mt_rand(1000, 1000000);
  1189. // As soon as the database prefix is set, the test might start to execute.
  1190. // All assertions as well as the SimpleTest batch operations are associated
  1191. // with the testId, so the database prefix has to be associated with it.
  1192. db_update('simpletest_test_id')
  1193. ->fields(array('last_prefix' => $this->databasePrefix))
  1194. ->condition('test_id', $this->testId)
  1195. ->execute();
  1196. }
  1197. /**
  1198. * Changes the database connection to the prefixed one.
  1199. *
  1200. * @see DrupalWebTestCase::setUp()
  1201. */
  1202. protected function changeDatabasePrefix() {
  1203. if (empty($this->databasePrefix)) {
  1204. $this->prepareDatabasePrefix();
  1205. // If $this->prepareDatabasePrefix() failed to work, return without
  1206. // setting $this->setupDatabasePrefix to TRUE, so setUp() methods will
  1207. // know to bail out.
  1208. if (empty($this->databasePrefix)) {
  1209. return;
  1210. }
  1211. }
  1212. // Clone the current connection and replace the current prefix.
  1213. $connection_info = Database::getConnectionInfo('default');
  1214. Database::renameConnection('default', 'simpletest_original_default');
  1215. foreach ($connection_info as $target => $value) {
  1216. $connection_info[$target]['prefix'] = array(
  1217. 'default' => $value['prefix']['default'] . $this->databasePrefix,
  1218. );
  1219. }
  1220. Database::addConnectionInfo('default', 'default', $connection_info['default']);
  1221. // Indicate the database prefix was set up correctly.
  1222. $this->setupDatabasePrefix = TRUE;
  1223. }
  1224. /**
  1225. * Prepares the current environment for running the test.
  1226. *
  1227. * Backups various current environment variables and resets them, so they do
  1228. * not interfere with the Drupal site installation in which tests are executed
  1229. * and can be restored in tearDown().
  1230. *
  1231. * Also sets up new resources for the testing environment, such as the public
  1232. * filesystem and configuration directories.
  1233. *
  1234. * @see DrupalWebTestCase::setUp()
  1235. * @see DrupalWebTestCase::tearDown()
  1236. */
  1237. protected function prepareEnvironment() {
  1238. global $user, $language, $conf;
  1239. // Store necessary current values before switching to prefixed database.
  1240. $this->originalLanguage = $language;
  1241. $this->originalLanguageDefault = variable_get('language_default');
  1242. $this->originalFileDirectory = variable_get('file_public_path', conf_path() . '/files');
  1243. $this->originalProfile = drupal_get_profile();
  1244. $this->originalCleanUrl = variable_get('clean_url', 0);
  1245. $this->originalUser = $user;
  1246. // Set to English to prevent exceptions from utf8_truncate() from t()
  1247. // during install if the current language is not 'en'.
  1248. // The following array/object conversion is copied from language_default().
  1249. $language = (object) array('language' => 'en', 'name' => 'English', 'native' => 'English', 'direction' => 0, 'enabled' => 1, 'plurals' => 0, 'formula' => '', 'domain' => '', 'prefix' => '', 'weight' => 0, 'javascript' => '');
  1250. // Save and clean the shutdown callbacks array because it is static cached
  1251. // and will be changed by the test run. Otherwise it will contain callbacks
  1252. // from both environments and the testing environment will try to call the
  1253. // handlers defined by the original one.
  1254. $callbacks = &drupal_register_shutdown_function();
  1255. $this->originalShutdownCallbacks = $callbacks;
  1256. $callbacks = array();
  1257. // Create test directory ahead of installation so fatal errors and debug
  1258. // information can be logged during installation process.
  1259. // Use temporary files directory with the same prefix as the database.
  1260. $this->public_files_directory = $this->originalFileDirectory . '/simpletest/' . substr($this->databasePrefix, 10);
  1261. $this->private_files_directory = $this->public_files_directory . '/private';
  1262. $this->temp_files_directory = $this->private_files_directory . '/temp';
  1263. // Create the directories
  1264. file_prepare_directory($this->public_files_directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
  1265. file_prepare_directory($this->private_files_directory, FILE_CREATE_DIRECTORY);
  1266. file_prepare_directory($this->temp_files_directory, FILE_CREATE_DIRECTORY);
  1267. $this->generatedTestFiles = FALSE;
  1268. // Log fatal errors.
  1269. ini_set('log_errors', 1);
  1270. ini_set('error_log', $this->public_files_directory . '/error.log');
  1271. // Set the test information for use in other parts of Drupal.
  1272. $test_info = &$GLOBALS['drupal_test_info'];
  1273. $test_info['test_run_id'] = $this->databasePrefix;
  1274. $test_info['in_child_site'] = FALSE;
  1275. // Indicate the environment was set up correctly.
  1276. $this->setupEnvironment = TRUE;
  1277. }
  1278. /**
  1279. * Sets up a Drupal site for running functional and integration tests.
  1280. *
  1281. * Generates a random database prefix and installs Drupal with the specified
  1282. * installation profile in DrupalWebTestCase::$profile into the
  1283. * prefixed database. Afterwards, installs any additional modules specified by
  1284. * the test.
  1285. *
  1286. * After installation all caches are flushed and several configuration values
  1287. * are reset to the values of the parent site executing the test, since the
  1288. * default values may be incompatible with the environment in which tests are
  1289. * being executed.
  1290. *
  1291. * @param ...
  1292. * List of modules to enable for the duration of the test. This can be
  1293. * either a single array or a variable number of string arguments.
  1294. *
  1295. * @see DrupalWebTestCase::prepareDatabasePrefix()
  1296. * @see DrupalWebTestCase::changeDatabasePrefix()
  1297. * @see DrupalWebTestCase::prepareEnvironment()
  1298. */
  1299. protected function setUp() {
  1300. global $user, $language, $conf;
  1301. // Create the database prefix for this test.
  1302. $this->prepareDatabasePrefix();
  1303. // Prepare the environment for running tests.
  1304. $this->prepareEnvironment();
  1305. if (!$this->setupEnvironment) {
  1306. return FALSE;
  1307. }
  1308. // Reset all statics and variables to perform tests in a clean environment.
  1309. $conf = array();
  1310. drupal_static_reset();
  1311. // Change the database prefix.
  1312. // All static variables need to be reset before the database prefix is
  1313. // changed, since DrupalCacheArray implementations attempt to
  1314. // write back to persistent caches when they are destructed.
  1315. $this->changeDatabasePrefix();
  1316. if (!$this->setupDatabasePrefix) {
  1317. return FALSE;
  1318. }
  1319. // Preset the 'install_profile' system variable, so the first call into
  1320. // system_rebuild_module_data() (in drupal_install_system()) will register
  1321. // the test's profile as a module. Without this, the installation profile of
  1322. // the parent site (executing the test) is registered, and the test
  1323. // profile's hook_install() and other hook implementations are never invoked.
  1324. $conf['install_profile'] = $this->profile;
  1325. // Perform the actual Drupal installation.
  1326. include_once DRUPAL_ROOT . '/includes/install.inc';
  1327. drupal_install_system();
  1328. $this->preloadRegistry();
  1329. // Set path variables.
  1330. variable_set('file_public_path', $this->public_files_directory);
  1331. variable_set('file_private_path', $this->private_files_directory);
  1332. variable_set('file_temporary_path', $this->temp_files_directory);
  1333. // Set the 'simpletest_parent_profile' variable to add the parent profile's
  1334. // search path to the child site's search paths.
  1335. // @see drupal_system_listing()
  1336. // @todo This may need to be primed like 'install_profile' above.
  1337. variable_set('simpletest_parent_profile', $this->originalProfile);
  1338. // Include the testing profile.
  1339. variable_set('install_profile', $this->profile);
  1340. $profile_details = install_profile_info($this->profile, 'en');
  1341. // Install the modules specified by the testing profile.
  1342. module_enable($profile_details['dependencies'], FALSE);
  1343. // Install modules needed for this test. This could have been passed in as
  1344. // either a single array argument or a variable number of string arguments.
  1345. // @todo Remove this compatibility layer in Drupal 8, and only accept
  1346. // $modules as a single array argument.
  1347. $modules = func_get_args();
  1348. if (isset($modules[0]) && is_array($modules[0])) {
  1349. $modules = $modules[0];
  1350. }
  1351. if ($modules) {
  1352. $success = module_enable($modules, TRUE);
  1353. $this->assertTrue($success, t('Enabled modules: %modules', array('%modules' => implode(', ', $modules))));
  1354. }
  1355. // Run the profile tasks.
  1356. $install_profile_module_exists = db_query("SELECT 1 FROM {system} WHERE type = 'module' AND name = :name", array(
  1357. ':name' => $this->profile,
  1358. ))->fetchField();
  1359. if ($install_profile_module_exists) {
  1360. module_enable(array($this->profile), FALSE);
  1361. }
  1362. // Reset/rebuild all data structures after enabling the modules.
  1363. $this->resetAll();
  1364. // Run cron once in that environment, as install.php does at the end of
  1365. // the installation process.
  1366. drupal_cron_run();
  1367. // Ensure that the session is not written to the new environment and replace
  1368. // the global $user session with uid 1 from the new test site.
  1369. drupal_save_session(FALSE);
  1370. // Login as uid 1.
  1371. $user = user_load(1);
  1372. // Restore necessary variables.
  1373. variable_set('install_task', 'done');
  1374. variable_set('clean_url', $this->originalCleanUrl);
  1375. variable_set('site_mail', 'simpletest@example.com');
  1376. variable_set('date_default_timezone', date_default_timezone_get());
  1377. // Set up English language.
  1378. unset($conf['language_default']);
  1379. $language = language_default();
  1380. // Use the test mail class instead of the default mail handler class.
  1381. variable_set('mail_system', array('default-system' => 'TestingMailSystem'));
  1382. drupal_set_time_limit($this->timeLimit);
  1383. $this->setup = TRUE;
  1384. }
  1385. /**
  1386. * Preload the registry from the testing site.
  1387. *
  1388. * This method is called by DrupalWebTestCase::setUp(), and preloads the
  1389. * registry from the testing site to cut down on the time it takes to
  1390. * set up a clean environment for the current test run.
  1391. */
  1392. protected function preloadRegistry() {
  1393. // Use two separate queries, each with their own connections: copy the
  1394. // {registry} and {registry_file} tables over from the parent installation
  1395. // to the child installation.
  1396. $original_connection = Database::getConnection('default', 'simpletest_original_default');
  1397. $test_connection = Database::getConnection();
  1398. foreach (array('registry', 'registry_file') as $table) {
  1399. // Find the records from the parent database.
  1400. $source_query = $original_connection
  1401. ->select($table, array(), array('fetch' => PDO::FETCH_ASSOC))
  1402. ->fields($table);
  1403. $dest_query = $test_connection->insert($table);
  1404. $first = TRUE;
  1405. foreach ($source_query->execute() as $row) {
  1406. if ($first) {
  1407. $dest_query->fields(array_keys($row));
  1408. $first = FALSE;
  1409. }
  1410. // Insert the records into the child database.
  1411. $dest_query->values($row);
  1412. }
  1413. $dest_query->execute();
  1414. }
  1415. }
  1416. /**
  1417. * Reset all data structures after having enabled new modules.
  1418. *
  1419. * This method is called by DrupalWebTestCase::setUp() after enabling
  1420. * the requested modules. It must be called again when additional modules
  1421. * are enabled later.
  1422. */
  1423. protected function resetAll() {
  1424. // Reset all static variables.
  1425. drupal_static_reset();
  1426. // Reset the list of enabled modules.
  1427. module_list(TRUE);
  1428. // Reset cached schema for new database prefix. This must be done before
  1429. // drupal_flush_all_caches() so rebuilds can make use of the schema of
  1430. // modules enabled on the cURL side.
  1431. drupal_get_schema(NULL, TRUE);
  1432. // Perform rebuilds and flush remaining caches.
  1433. drupal_flush_all_caches();
  1434. // Reload global $conf array and permissions.
  1435. $this->refreshVariables();
  1436. $this->checkPermissions(array(), TRUE);
  1437. }
  1438. /**
  1439. * Refresh the in-memory set of variables. Useful after a page request is made
  1440. * that changes a variable in a different thread.
  1441. *
  1442. * In other words calling a settings page with $this->drupalPost() with a changed
  1443. * value would update a variable to reflect that change, but in the thread that
  1444. * made the call (thread running the test) the changed variable would not be
  1445. * picked up.
  1446. *
  1447. * This method clears the variables cache and loads a fresh copy from the database
  1448. * to ensure that the most up-to-date set of variables is loaded.
  1449. */
  1450. protected function refreshVariables() {
  1451. global $conf;
  1452. cache_clear_all('variables', 'cache_bootstrap');
  1453. $conf = variable_initialize();
  1454. }
  1455. /**
  1456. * Delete created files and temporary files directory, delete the tables created by setUp(),
  1457. * and reset the database prefix.
  1458. */
  1459. protected function tearDown() {
  1460. global $user, $language;
  1461. // In case a fatal error occurred that was not in the test process read the
  1462. // log to pick up any fatal errors.
  1463. simpletest_log_read($this->testId, $this->databasePrefix, get_class($this), TRUE);
  1464. $emailCount = count(variable_get('drupal_test_email_collector', array()));
  1465. if ($emailCount) {
  1466. $message = format_plural($emailCount, '1 e-mail was sent during this test.', '@count e-mails were sent during this test.');
  1467. $this->pass($message, t('E-mail'));
  1468. }
  1469. // Delete temporary files directory.
  1470. file_unmanaged_delete_recursive($this->originalFileDirectory . '/simpletest/' . substr($this->databasePrefix, 10));
  1471. // Remove all prefixed tables.
  1472. $tables = db_find_tables($this->databasePrefix . '%');
  1473. $connection_info = Database::getConnectionInfo('default');
  1474. $tables = db_find_tables($connection_info['default']['prefix']['default'] . '%');
  1475. if (empty($tables)) {
  1476. $this->fail('Failed to find test tables to drop.');
  1477. }
  1478. $prefix_length = strlen($connection_info['default']['prefix']['default']);
  1479. foreach ($tables as $table) {
  1480. if (db_drop_table(substr($table, $prefix_length))) {
  1481. unset($tables[$table]);
  1482. }
  1483. }
  1484. if (!empty($tables)) {
  1485. $this->fail('Failed to drop all prefixed tables.');
  1486. }
  1487. // Get back to the original connection.
  1488. Database::removeConnection('default');
  1489. Database::renameConnection('simpletest_original_default', 'default');
  1490. // Restore original shutdown callbacks array to prevent original
  1491. // environment of calling handlers from test run.
  1492. $callbacks = &drupal_register_shutdown_function();
  1493. $callbacks = $this->originalShutdownCallbacks;
  1494. // Return the user to the original one.
  1495. $user = $this->originalUser;
  1496. drupal_save_session(TRUE);
  1497. // Ensure that internal logged in variable and cURL options are reset.
  1498. $this->loggedInUser = FALSE;
  1499. $this->additionalCurlOptions = array();
  1500. // Reload module list and implementations to ensure that test module hooks
  1501. // aren't called after tests.
  1502. module_list(TRUE);
  1503. module_implements('', FALSE, TRUE);
  1504. // Reset the Field API.
  1505. field_cache_clear();
  1506. // Rebuild caches.
  1507. $this->refreshVariables();
  1508. // Reset public files directory.
  1509. $GLOBALS['conf']['file_public_path'] = $this->originalFileDirectory;
  1510. // Reset language.
  1511. $language = $this->originalLanguage;
  1512. if ($this->originalLanguageDefault) {
  1513. $GLOBALS['conf']['language_default'] = $this->originalLanguageDefault;
  1514. }
  1515. // Close the CURL handler.
  1516. $this->curlClose();
  1517. }
  1518. /**
  1519. * Initializes the cURL connection.
  1520. *
  1521. * If the simpletest_httpauth_credentials variable is set, this function will
  1522. * add HTTP authentication headers. This is necessary for testing sites that
  1523. * are protected by login credentials from public access.
  1524. * See the description of $curl_options for other options.
  1525. */
  1526. protected function curlInitialize() {
  1527. global $base_url;
  1528. if (!isset($this->curlHandle)) {
  1529. $this->curlHandle = curl_init();
  1530. // Some versions/configurations of cURL break on a NULL cookie jar, so
  1531. // supply a real file.
  1532. if (empty($this->cookieFile)) {
  1533. $this->cookieFile = $this->public_files_directory . '/cookie.jar';
  1534. }
  1535. $curl_options = array(
  1536. CURLOPT_COOKIEJAR => $this->cookieFile,
  1537. CURLOPT_URL => $base_url,
  1538. CURLOPT_FOLLOWLOCATION => FALSE,
  1539. CURLOPT_RETURNTRANSFER => TRUE,
  1540. CURLOPT_SSL_VERIFYPEER => FALSE, // Required to make the tests run on HTTPS.
  1541. CURLOPT_SSL_VERIFYHOST => FALSE, // Required to make the tests run on HTTPS.
  1542. CURLOPT_HEADERFUNCTION => array(&$this, 'curlHeaderCallback'),
  1543. CURLOPT_USERAGENT => $this->databasePrefix,
  1544. );
  1545. if (isset($this->httpauth_credentials)) {
  1546. $curl_options[CURLOPT_HTTPAUTH] = $this->httpauth_method;
  1547. $curl_options[CURLOPT_USERPWD] = $this->httpauth_credentials;
  1548. }
  1549. // curl_setopt_array() returns FALSE if any of the specified options
  1550. // cannot be set, and stops processing any further options.
  1551. $result = curl_setopt_array($this->curlHandle, $this->additionalCurlOptions + $curl_options);
  1552. if (!$result) {
  1553. throw new Exception('One or more cURL options could not be set.');
  1554. }
  1555. // By default, the child session name should be the same as the parent.
  1556. $this->session_name = session_name();
  1557. }
  1558. // We set the user agent header on each request so as to use the current
  1559. // time and a new uniqid.
  1560. if (preg_match('/simpletest\d+/', $this->databasePrefix, $matches)) {
  1561. curl_setopt($this->curlHandle, CURLOPT_USERAGENT, drupal_generate_test_ua($matches[0]));
  1562. }
  1563. }
  1564. /**
  1565. * Initializes and executes a cURL request.
  1566. *
  1567. * @param $curl_options
  1568. * An associative array of cURL options to set, where the keys are constants
  1569. * defined by the cURL library. For a list of valid options, see
  1570. * http://www.php.net/manual/function.curl-setopt.php
  1571. * @param $redirect
  1572. * FALSE if this is an initial request, TRUE if this request is the result
  1573. * of a redirect.
  1574. *
  1575. * @return
  1576. * The content returned from the call to curl_exec().
  1577. *
  1578. * @see curlInitialize()
  1579. */
  1580. protected function curlExec($curl_options, $redirect = FALSE) {
  1581. $this->curlInitialize();
  1582. if (!empty($curl_options[CURLOPT_URL])) {
  1583. // Forward XDebug activation if present.
  1584. if (isset($_COOKIE['XDEBUG_SESSION'])) {
  1585. $options = drupal_parse_url($curl_options[CURLOPT_URL]);
  1586. $options += array('query' => array());
  1587. $options['query'] += array('XDEBUG_SESSION_START' => $_COOKIE['XDEBUG_SESSION']);
  1588. $curl_options[CURLOPT_URL] = url($options['path'], $options);
  1589. }
  1590. // cURL incorrectly handles URLs with a fragment by including the
  1591. // fragment in the request to the server, causing some web servers
  1592. // to reject the request citing "400 - Bad Request". To prevent
  1593. // this, we strip the fragment from the request.
  1594. // TODO: Remove this for Drupal 8, since fixed in curl 7.20.0.
  1595. if (strpos($curl_options[CURLOPT_URL], '#')) {
  1596. $original_url = $curl_options[CURLOPT_URL];
  1597. $curl_options[CURLOPT_URL] = strtok($curl_options[CURLOPT_URL], '#');
  1598. }
  1599. }
  1600. $url = empty($curl_options[CURLOPT_URL]) ? curl_getinfo($this->curlHandle, CURLINFO_EFFECTIVE_URL) : $curl_options[CURLOPT_URL];
  1601. if (!empty($curl_options[CURLOPT_POST])) {
  1602. // This is a fix for the Curl library to prevent Expect: 100-continue
  1603. // headers in POST requests, that may cause unexpected HTTP response
  1604. // codes from some webservers (like lighttpd that returns a 417 error
  1605. // code). It is done by setting an empty "Expect" header field that is
  1606. // not overwritten by Curl.
  1607. $curl_options[CURLOPT_HTTPHEADER][] = 'Expect:';
  1608. }
  1609. curl_setopt_array($this->curlHandle, $this->additionalCurlOptions + $curl_options);
  1610. if (!$redirect) {
  1611. // Reset headers, the session ID and the redirect counter.
  1612. $this->session_id = NULL;
  1613. $this->headers = array();
  1614. $this->redirect_count = 0;
  1615. }
  1616. $content = curl_exec($this->curlHandle);
  1617. $status = curl_getinfo($this->curlHandle, CURLINFO_HTTP_CODE);
  1618. // cURL incorrectly handles URLs with fragments, so instead of
  1619. // letting cURL handle redirects we take of them ourselves to
  1620. // to prevent fragments being sent to the web server as part
  1621. // of the request.
  1622. // TODO: Remove this for Drupal 8, since fixed in curl 7.20.0.
  1623. if (in_array($status, array(300, 301, 302, 303, 305, 307)) && $this->redirect_count < variable_get('simpletest_maximum_redirects', 5)) {
  1624. if ($this->drupalGetHeader('location')) {
  1625. $this->redirect_count++;
  1626. $curl_options = array();
  1627. $curl_options[CURLOPT_URL] = $this->drupalGetHeader('location');
  1628. $curl_options[CURLOPT_HTTPGET] = TRUE;
  1629. return $this->curlExec($curl_options, TRUE);
  1630. }
  1631. }
  1632. $this->drupalSetContent($content, isset($original_url) ? $original_url : curl_getinfo($this->curlHandle, CURLINFO_EFFECTIVE_URL));
  1633. $message_vars = array(
  1634. '!method' => !empty($curl_options[CURLOPT_NOBODY]) ? 'HEAD' : (empty($curl_options[CURLOPT_POSTFIELDS]) ? 'GET' : 'POST'),
  1635. '@url' => isset($original_url) ? $original_url : $url,
  1636. '@status' => $status,
  1637. '!length' => format_size(strlen($this->drupalGetContent()))
  1638. );
  1639. $message = t('!method @url returned @status (!length).', $message_vars);
  1640. $this->assertTrue($this->drupalGetContent() !== FALSE, $message, t('Browser'));
  1641. return $this->drupalGetContent();
  1642. }
  1643. /**
  1644. * Reads headers and registers errors received from the tested site.
  1645. *
  1646. * @see _drupal_log_error().
  1647. *
  1648. * @param $curlHandler
  1649. * The cURL handler.
  1650. * @param $header
  1651. * An header.
  1652. */
  1653. protected function curlHeaderCallback($curlHandler, $header) {
  1654. // Header fields can be extended over multiple lines by preceding each
  1655. // extra line with at least one SP or HT. They should be joined on receive.
  1656. // Details are in RFC2616 section 4.
  1657. if ($header[0] == ' ' || $header[0] == "\t") {
  1658. // Normalize whitespace between chucks.
  1659. $this->headers[] = array_pop($this->headers) . ' ' . trim($header);
  1660. }
  1661. else {
  1662. $this->headers[] = $header;
  1663. }
  1664. // Errors are being sent via X-Drupal-Assertion-* headers,
  1665. // generated by _drupal_log_error() in the exact form required
  1666. // by DrupalWebTestCase::error().
  1667. if (preg_match('/^X-Drupal-Assertion-[0-9]+: (.*)$/', $header, $matches)) {
  1668. // Call DrupalWebTestCase::error() with the parameters from the header.
  1669. call_user_func_array(array(&$this, 'error'), unserialize(urldecode($matches[1])));
  1670. }
  1671. // Save cookies.
  1672. if (preg_match('/^Set-Cookie: ([^=]+)=(.+)/', $header, $matches)) {
  1673. $name = $matches[1];
  1674. $parts = array_map('trim', explode(';', $matches[2]));
  1675. $value = array_shift($parts);
  1676. $this->cookies[$name] = array('value' => $value, 'secure' => in_array('secure', $parts));
  1677. if ($name == $this->session_name) {
  1678. if ($value != 'deleted') {
  1679. $this->session_id = $value;
  1680. }
  1681. else {
  1682. $this->session_id = NULL;
  1683. }
  1684. }
  1685. }
  1686. // This is required by cURL.
  1687. return strlen($header);
  1688. }
  1689. /**
  1690. * Close the cURL handler and unset the handler.
  1691. */
  1692. protected function curlClose() {
  1693. if (isset($this->curlHandle)) {
  1694. curl_close($this->curlHandle);
  1695. unset($this->curlHandle);
  1696. }
  1697. }
  1698. /**
  1699. * Parse content returned from curlExec using DOM and SimpleXML.
  1700. *
  1701. * @return
  1702. * A SimpleXMLElement or FALSE on failure.
  1703. */
  1704. protected function parse() {
  1705. if (!$this->elements) {
  1706. // DOM can load HTML soup. But, HTML soup can throw warnings, suppress
  1707. // them.
  1708. $htmlDom = new DOMDocument();
  1709. @$htmlDom->loadHTML($this->drupalGetContent());
  1710. if ($htmlDom) {
  1711. $this->pass(t('Valid HTML found on "@path"', array('@path' => $this->getUrl())), t('Browser'));
  1712. // It's much easier to work with simplexml than DOM, luckily enough
  1713. // we can just simply import our DOM tree.
  1714. $this->elements = simplexml_import_dom($htmlDom);
  1715. }
  1716. }
  1717. if (!$this->elements) {
  1718. $this->fail(t('Parsed page successfully.'), t('Browser'));
  1719. }
  1720. return $this->elements;
  1721. }
  1722. /**
  1723. * Retrieves a Drupal path or an absolute path.
  1724. *
  1725. * @param $path
  1726. * Drupal path or URL to load into internal browser
  1727. * @param $options
  1728. * Options to be forwarded to url().
  1729. * @param $headers
  1730. * An array containing additional HTTP request headers, each formatted as
  1731. * "name: value".
  1732. * @return
  1733. * The retrieved HTML string, also available as $this->drupalGetContent()
  1734. */
  1735. protected function drupalGet($path, array $options = array(), array $headers = array()) {
  1736. $options['absolute'] = TRUE;
  1737. // We re-using a CURL connection here. If that connection still has certain
  1738. // options set, it might change the GET into a POST. Make sure we clear out
  1739. // previous options.
  1740. $out = $this->curlExec(array(CURLOPT_HTTPGET => TRUE, CURLOPT_URL => url($path, $options), CURLOPT_NOBODY => FALSE, CURLOPT_HTTPHEADER => $headers));
  1741. $this->refreshVariables(); // Ensure that any changes to variables in the other thread are picked up.
  1742. // Replace original page output with new output from redirected page(s).
  1743. if ($new = $this->checkForMetaRefresh()) {
  1744. $out = $new;
  1745. }
  1746. $this->verbose('GET request to: ' . $path .
  1747. '<hr />Ending URL: ' . $this->getUrl() .
  1748. '<hr />' . $out);
  1749. return $out;
  1750. }
  1751. /**
  1752. * Retrieve a Drupal path or an absolute path and JSON decode the result.
  1753. */
  1754. protected function drupalGetAJAX($path, array $options = array(), array $headers = array()) {
  1755. return drupal_json_decode($this->drupalGet($path, $options, $headers));
  1756. }
  1757. /**
  1758. * Execute a POST request on a Drupal page.
  1759. * It will be done as usual POST request with SimpleBrowser.
  1760. *
  1761. * @param $path
  1762. * Location of the post form. Either a Drupal path or an absolute path or
  1763. * NULL to post to the current page. For multi-stage forms you can set the
  1764. * path to NULL and have it post to the last received page. Example:
  1765. *
  1766. * @code
  1767. * // First step in form.
  1768. * $edit = array(...);
  1769. * $this->drupalPost('some_url', $edit, t('Save'));
  1770. *
  1771. * // Second step in form.
  1772. * $edit = array(...);
  1773. * $this->drupalPost(NULL, $edit, t('Save'));
  1774. * @endcode
  1775. * @param $edit
  1776. * Field data in an associative array. Changes the current input fields
  1777. * (where possible) to the values indicated. A checkbox can be set to
  1778. * TRUE to be checked and FALSE to be unchecked. Note that when a form
  1779. * contains file upload fields, other fields cannot start with the '@'
  1780. * character.
  1781. *
  1782. * Multiple select fields can be set using name[] and setting each of the
  1783. * possible values. Example:
  1784. * @code
  1785. * $edit = array();
  1786. * $edit['name[]'] = array('value1', 'value2');
  1787. * @endcode
  1788. * @param $submit
  1789. * Value of the submit button whose click is to be emulated. For example,
  1790. * t('Save'). The processing of the request depends on this value. For
  1791. * example, a form may have one button with the value t('Save') and another
  1792. * button with the value t('Delete'), and execute different code depending
  1793. * on which one is clicked.
  1794. *
  1795. * This function can also be called to emulate an Ajax submission. In this
  1796. * case, this value needs to be an array with the following keys:
  1797. * - path: A path to submit the form values to for Ajax-specific processing,
  1798. * which is likely different than the $path parameter used for retrieving
  1799. * the initial form. Defaults to 'system/ajax'.
  1800. * - triggering_element: If the value for the 'path' key is 'system/ajax' or
  1801. * another generic Ajax processing path, this needs to be set to the name
  1802. * of the element. If the name doesn't identify the element uniquely, then
  1803. * this should instead be an array with a single key/value pair,
  1804. * corresponding to the element name and value. The callback for the
  1805. * generic Ajax processing path uses this to find the #ajax information
  1806. * for the element, including which specific callback to use for
  1807. * processing the request.
  1808. *
  1809. * This can also be set to NULL in order to emulate an Internet Explorer
  1810. * submission of a form with a single text field, and pressing ENTER in that
  1811. * textfield: under these conditions, no button information is added to the
  1812. * POST data.
  1813. * @param $options
  1814. * Options to be forwarded to url().
  1815. * @param $headers
  1816. * An array containing additional HTTP request headers, each formatted as
  1817. * "name: value".
  1818. * @param $form_html_id
  1819. * (optional) HTML ID of the form to be submitted. On some pages
  1820. * there are many identical forms, so just using the value of the submit
  1821. * button is not enough. For example: 'trigger-node-presave-assign-form'.
  1822. * Note that this is not the Drupal $form_id, but rather the HTML ID of the
  1823. * form, which is typically the same thing but with hyphens replacing the
  1824. * underscores.
  1825. * @param $extra_post
  1826. * (optional) A string of additional data to append to the POST submission.
  1827. * This can be used to add POST data for which there are no HTML fields, as
  1828. * is done by drupalPostAJAX(). This string is literally appended to the
  1829. * POST data, so it must already be urlencoded and contain a leading "&"
  1830. * (e.g., "&extra_var1=hello+world&extra_var2=you%26me").
  1831. */
  1832. protected function drupalPost($path, $edit, $submit, array $options = array(), array $headers = array(), $form_html_id = NULL, $extra_post = NULL) {
  1833. $submit_matches = FALSE;
  1834. $ajax = is_array($submit);
  1835. if (isset($path)) {
  1836. $this->drupalGet($path, $options);
  1837. }
  1838. if ($this->parse()) {
  1839. $edit_save = $edit;
  1840. // Let's iterate over all the forms.
  1841. $xpath = "//form";
  1842. if (!empty($form_html_id)) {
  1843. $xpath .= "[@id='" . $form_html_id . "']";
  1844. }
  1845. $forms = $this->xpath($xpath);
  1846. foreach ($forms as $form) {
  1847. // We try to set the fields of this form as specified in $edit.
  1848. $edit = $edit_save;
  1849. $post = array();
  1850. $upload = array();
  1851. $submit_matches = $this->handleForm($post, $edit, $upload, $ajax ? NULL : $submit, $form);
  1852. $action = isset($form['action']) ? $this->getAbsoluteUrl((string) $form['action']) : $this->getUrl();
  1853. if ($ajax) {
  1854. $action = $this->getAbsoluteUrl(!empty($submit['path']) ? $submit['path'] : 'system/ajax');
  1855. // Ajax callbacks verify the triggering element if necessary, so while
  1856. // we may eventually want extra code that verifies it in the
  1857. // handleForm() function, it's not currently a requirement.
  1858. $submit_matches = TRUE;
  1859. }
  1860. // We post only if we managed to handle every field in edit and the
  1861. // submit button matches.
  1862. if (!$edit && ($submit_matches || !isset($submit))) {
  1863. $post_array = $post;
  1864. if ($upload) {
  1865. // TODO: cURL handles file uploads for us, but the implementation
  1866. // is broken. This is a less than elegant workaround. Alternatives
  1867. // are being explored at #253506.
  1868. foreach ($upload as $key => $file) {
  1869. $file = drupal_realpath($file);
  1870. if ($file && is_file($file)) {
  1871. // Use the new CurlFile class for file uploads when using PHP
  1872. // 5.5 or higher.
  1873. if (class_exists('CurlFile')) {
  1874. $post[$key] = curl_file_create($file);
  1875. }
  1876. else {
  1877. $post[$key] = '@' . $file;
  1878. }
  1879. }
  1880. }
  1881. }
  1882. else {
  1883. foreach ($post as $key => $value) {
  1884. // Encode according to application/x-www-form-urlencoded
  1885. // Both names and values needs to be urlencoded, according to
  1886. // http://www.w3.org/TR/html4/interact/forms.html#h-17.13.4.1
  1887. $post[$key] = urlencode($key) . '=' . urlencode($value);
  1888. }
  1889. $post = implode('&', $post) . $extra_post;
  1890. }
  1891. $out = $this->curlExec(array(CURLOPT_URL => $action, CURLOPT_POST => TRUE, CURLOPT_POSTFIELDS => $post, CURLOPT_HTTPHEADER => $headers));
  1892. // Ensure that any changes to variables in the other thread are picked up.
  1893. $this->refreshVariables();
  1894. // Replace original page output with new output from redirected page(s).
  1895. if ($new = $this->checkForMetaRefresh()) {
  1896. $out = $new;
  1897. }
  1898. $this->verbose('POST request to: ' . $path .
  1899. '<hr />Ending URL: ' . $this->getUrl() .
  1900. '<hr />Fields: ' . highlight_string('<?php ' . var_export($post_array, TRUE), TRUE) .
  1901. '<hr />' . $out);
  1902. return $out;
  1903. }
  1904. }
  1905. // We have not found a form which contained all fields of $edit.
  1906. foreach ($edit as $name => $value) {
  1907. $this->fail(t('Failed to set field @name to @value', array('@name' => $name, '@value' => $value)));
  1908. }
  1909. if (!$ajax && isset($submit)) {
  1910. $this->assertTrue($submit_matches, t('Found the @submit button', array('@submit' => $submit)));
  1911. }
  1912. $this->fail(t('Found the requested form fields at @path', array('@path' => $path)));
  1913. }
  1914. }
  1915. /**
  1916. * Execute an Ajax submission.
  1917. *
  1918. * This executes a POST as ajax.js does. It uses the returned JSON data, an
  1919. * array of commands, to update $this->content using equivalent DOM
  1920. * manipulation as is used by ajax.js. It also returns the array of commands.
  1921. *
  1922. * @param $path
  1923. * Location of the form containing the Ajax enabled element to test. Can be
  1924. * either a Drupal path or an absolute path or NULL to use the current page.
  1925. * @param $edit
  1926. * Field data in an associative array. Changes the current input fields
  1927. * (where possible) to the values indicated.
  1928. * @param $triggering_element
  1929. * The name of the form element that is responsible for triggering the Ajax
  1930. * functionality to test. May be a string or, if the triggering element is
  1931. * a button, an associative array where the key is the name of the button
  1932. * and the value is the button label. i.e.) array('op' => t('Refresh')).
  1933. * @param $ajax_path
  1934. * (optional) Override the path set by the Ajax settings of the triggering
  1935. * element. In the absence of both the triggering element's Ajax path and
  1936. * $ajax_path 'system/ajax' will be used.
  1937. * @param $options
  1938. * (optional) Options to be forwarded to url().
  1939. * @param $headers
  1940. * (optional) An array containing additional HTTP request headers, each
  1941. * formatted as "name: value". Forwarded to drupalPost().
  1942. * @param $form_html_id
  1943. * (optional) HTML ID of the form to be submitted, use when there is more
  1944. * than one identical form on the same page and the value of the triggering
  1945. * element is not enough to identify the form. Note this is not the Drupal
  1946. * ID of the form but rather the HTML ID of the form.
  1947. * @param $ajax_settings
  1948. * (optional) An array of Ajax settings which if specified will be used in
  1949. * place of the Ajax settings of the triggering element.
  1950. *
  1951. * @return
  1952. * An array of Ajax commands.
  1953. *
  1954. * @see drupalPost()
  1955. * @see ajax.js
  1956. */
  1957. protected function drupalPostAJAX($path, $edit, $triggering_element, $ajax_path = NULL, array $options = array(), array $headers = array(), $form_html_id = NULL, $ajax_settings = NULL) {
  1958. // Get the content of the initial page prior to calling drupalPost(), since
  1959. // drupalPost() replaces $this->content.
  1960. if (isset($path)) {
  1961. $this->drupalGet($path, $options);
  1962. }
  1963. $content = $this->content;
  1964. $drupal_settings = $this->drupalSettings;
  1965. // Get the Ajax settings bound to the triggering element.
  1966. if (!isset($ajax_settings)) {
  1967. if (is_array($triggering_element)) {
  1968. $xpath = '//*[@name="' . key($triggering_element) . '" and @value="' . current($triggering_element) . '"]';
  1969. }
  1970. else {
  1971. $xpath = '//*[@name="' . $triggering_element . '"]';
  1972. }
  1973. if (isset($form_html_id)) {
  1974. $xpath = '//form[@id="' . $form_html_id . '"]' . $xpath;
  1975. }
  1976. $element = $this->xpath($xpath);
  1977. $element_id = (string) $element[0]['id'];
  1978. $ajax_settings = $drupal_settings['ajax'][$element_id];
  1979. }
  1980. // Add extra information to the POST data as ajax.js does.
  1981. $extra_post = '';
  1982. if (isset($ajax_settings['submit'])) {
  1983. foreach ($ajax_settings['submit'] as $key => $value) {
  1984. $extra_post .= '&' . urlencode($key) . '=' . urlencode($value);
  1985. }
  1986. }
  1987. foreach ($this->xpath('//*[@id]') as $element) {
  1988. $id = (string) $element['id'];
  1989. $extra_post .= '&' . urlencode('ajax_html_ids[]') . '=' . urlencode($id);
  1990. }
  1991. if (isset($drupal_settings['ajaxPageState'])) {
  1992. $extra_post .= '&' . urlencode('ajax_page_state[theme]') . '=' . urlencode($drupal_settings['ajaxPageState']['theme']);
  1993. $extra_post .= '&' . urlencode('ajax_page_state[theme_token]') . '=' . urlencode($drupal_settings['ajaxPageState']['theme_token']);
  1994. foreach ($drupal_settings['ajaxPageState']['css'] as $key => $value) {
  1995. $extra_post .= '&' . urlencode("ajax_page_state[css][$key]") . '=1';
  1996. }
  1997. foreach ($drupal_settings['ajaxPageState']['js'] as $key => $value) {
  1998. $extra_post .= '&' . urlencode("ajax_page_state[js][$key]") . '=1';
  1999. }
  2000. }
  2001. // Unless a particular path is specified, use the one specified by the
  2002. // Ajax settings, or else 'system/ajax'.
  2003. if (!isset($ajax_path)) {
  2004. $ajax_path = isset($ajax_settings['url']) ? $ajax_settings['url'] : 'system/ajax';
  2005. }
  2006. // Submit the POST request.
  2007. $return = drupal_json_decode($this->drupalPost(NULL, $edit, array('path' => $ajax_path, 'triggering_element' => $triggering_element), $options, $headers, $form_html_id, $extra_post));
  2008. // Change the page content by applying the returned commands.
  2009. if (!empty($ajax_settings) && !empty($return)) {
  2010. // ajax.js applies some defaults to the settings object, so do the same
  2011. // for what's used by this function.
  2012. $ajax_settings += array(
  2013. 'method' => 'replaceWith',
  2014. );
  2015. // DOM can load HTML soup. But, HTML soup can throw warnings, suppress
  2016. // them.
  2017. $dom = new DOMDocument();
  2018. @$dom->loadHTML($content);
  2019. // XPath allows for finding wrapper nodes better than DOM does.
  2020. $xpath = new DOMXPath($dom);
  2021. foreach ($return as $command) {
  2022. switch ($command['command']) {
  2023. case 'settings':
  2024. $drupal_settings = drupal_array_merge_deep($drupal_settings, $command['settings']);
  2025. break;
  2026. case 'insert':
  2027. $wrapperNode = NULL;
  2028. // When a command doesn't specify a selector, use the
  2029. // #ajax['wrapper'] which is always an HTML ID.
  2030. if (!isset($command['selector'])) {
  2031. $wrapperNode = $xpath->query('//*[@id="' . $ajax_settings['wrapper'] . '"]')->item(0);
  2032. }
  2033. // @todo Ajax commands can target any jQuery selector, but these are
  2034. // hard to fully emulate with XPath. For now, just handle 'head'
  2035. // and 'body', since these are used by ajax_render().
  2036. elseif (in_array($command['selector'], array('head', 'body'))) {
  2037. $wrapperNode = $xpath->query('//' . $command['selector'])->item(0);
  2038. }
  2039. if ($wrapperNode) {
  2040. // ajax.js adds an enclosing DIV to work around a Safari bug.
  2041. $newDom = new DOMDocument();
  2042. $newDom->loadHTML('<div>' . $command['data'] . '</div>');
  2043. $newNode = $dom->importNode($newDom->documentElement->firstChild->firstChild, TRUE);
  2044. $method = isset($command['method']) ? $command['method'] : $ajax_settings['method'];
  2045. // The "method" is a jQuery DOM manipulation function. Emulate
  2046. // each one using PHP's DOMNode API.
  2047. switch ($method) {
  2048. case 'replaceWith':
  2049. $wrapperNode->parentNode->replaceChild($newNode, $wrapperNode);
  2050. break;
  2051. case 'append':
  2052. $wrapperNode->appendChild($newNode);
  2053. break;
  2054. case 'prepend':
  2055. // If no firstChild, insertBefore() falls back to
  2056. // appendChild().
  2057. $wrapperNode->insertBefore($newNode, $wrapperNode->firstChild);
  2058. break;
  2059. case 'before':
  2060. $wrapperNode->parentNode->insertBefore($newNode, $wrapperNode);
  2061. break;
  2062. case 'after':
  2063. // If no nextSibling, insertBefore() falls back to
  2064. // appendChild().
  2065. $wrapperNode->parentNode->insertBefore($newNode, $wrapperNode->nextSibling);
  2066. break;
  2067. case 'html':
  2068. foreach ($wrapperNode->childNodes as $childNode) {
  2069. $wrapperNode->removeChild($childNode);
  2070. }
  2071. $wrapperNode->appendChild($newNode);
  2072. break;
  2073. }
  2074. }
  2075. break;
  2076. case 'updateBuildId':
  2077. $buildId = $xpath->query('//input[@name="form_build_id" and @value="' . $command['old'] . '"]')->item(0);
  2078. if ($buildId) {
  2079. $buildId->setAttribute('value', $command['new']);
  2080. }
  2081. break;
  2082. // @todo Add suitable implementations for these commands in order to
  2083. // have full test coverage of what ajax.js can do.
  2084. case 'remove':
  2085. break;
  2086. case 'changed':
  2087. break;
  2088. case 'css':
  2089. break;
  2090. case 'data':
  2091. break;
  2092. case 'restripe':
  2093. break;
  2094. case 'add_css':
  2095. break;
  2096. }
  2097. }
  2098. $content = $dom->saveHTML();
  2099. }
  2100. $this->drupalSetContent($content);
  2101. $this->drupalSetSettings($drupal_settings);
  2102. $verbose = 'AJAX POST request to: ' . $path;
  2103. $verbose .= '<br />AJAX callback path: ' . $ajax_path;
  2104. $verbose .= '<hr />Ending URL: ' . $this->getUrl();
  2105. $verbose .= '<hr />' . $this->content;
  2106. $this->verbose($verbose);
  2107. return $return;
  2108. }
  2109. /**
  2110. * Runs cron in the Drupal installed by Simpletest.
  2111. */
  2112. protected function cronRun() {
  2113. $this->drupalGet($GLOBALS['base_url'] . '/cron.php', array('external' => TRUE, 'query' => array('cron_key' => variable_get('cron_key', 'drupal'))));
  2114. }
  2115. /**
  2116. * Check for meta refresh tag and if found call drupalGet() recursively. This
  2117. * function looks for the http-equiv attribute to be set to "Refresh"
  2118. * and is case-sensitive.
  2119. *
  2120. * @return
  2121. * Either the new page content or FALSE.
  2122. */
  2123. protected function checkForMetaRefresh() {
  2124. if (strpos($this->drupalGetContent(), '<meta ') && $this->parse()) {
  2125. $refresh = $this->xpath('//meta[@http-equiv="Refresh"]');
  2126. if (!empty($refresh)) {
  2127. // Parse the content attribute of the meta tag for the format:
  2128. // "[delay]: URL=[page_to_redirect_to]".
  2129. if (preg_match('/\d+;\s*URL=(?P<url>.*)/i', $refresh[0]['content'], $match)) {
  2130. return $this->drupalGet($this->getAbsoluteUrl(decode_entities($match['url'])));
  2131. }
  2132. }
  2133. }
  2134. return FALSE;
  2135. }
  2136. /**
  2137. * Retrieves only the headers for a Drupal path or an absolute path.
  2138. *
  2139. * @param $path
  2140. * Drupal path or URL to load into internal browser
  2141. * @param $options
  2142. * Options to be forwarded to url().
  2143. * @param $headers
  2144. * An array containing additional HTTP request headers, each formatted as
  2145. * "name: value".
  2146. * @return
  2147. * The retrieved headers, also available as $this->drupalGetContent()
  2148. */
  2149. protected function drupalHead($path, array $options = array(), array $headers = array()) {
  2150. $options['absolute'] = TRUE;
  2151. $out = $this->curlExec(array(CURLOPT_NOBODY => TRUE, CURLOPT_URL => url($path, $options), CURLOPT_HTTPHEADER => $headers));
  2152. $this->refreshVariables(); // Ensure that any changes to variables in the other thread are picked up.
  2153. return $out;
  2154. }
  2155. /**
  2156. * Handle form input related to drupalPost(). Ensure that the specified fields
  2157. * exist and attempt to create POST data in the correct manner for the particular
  2158. * field type.
  2159. *
  2160. * @param $post
  2161. * Reference to array of post values.
  2162. * @param $edit
  2163. * Reference to array of edit values to be checked against the form.
  2164. * @param $submit
  2165. * Form submit button value.
  2166. * @param $form
  2167. * Array of form elements.
  2168. * @return
  2169. * Submit value matches a valid submit input in the form.
  2170. */
  2171. protected function handleForm(&$post, &$edit, &$upload, $submit, $form) {
  2172. // Retrieve the form elements.
  2173. $elements = $form->xpath('.//input[not(@disabled)]|.//textarea[not(@disabled)]|.//select[not(@disabled)]');
  2174. $submit_matches = FALSE;
  2175. foreach ($elements as $element) {
  2176. // SimpleXML objects need string casting all the time.
  2177. $name = (string) $element['name'];
  2178. // This can either be the type of <input> or the name of the tag itself
  2179. // for <select> or <textarea>.
  2180. $type = isset($element['type']) ? (string) $element['type'] : $element->getName();
  2181. $value = isset($element['value']) ? (string) $element['value'] : '';
  2182. $done = FALSE;
  2183. if (isset($edit[$name])) {
  2184. switch ($type) {
  2185. case 'text':
  2186. case 'tel':
  2187. case 'textarea':
  2188. case 'url':
  2189. case 'number':
  2190. case 'range':
  2191. case 'color':
  2192. case 'hidden':
  2193. case 'password':
  2194. case 'email':
  2195. case 'search':
  2196. $post[$name] = $edit[$name];
  2197. unset($edit[$name]);
  2198. break;
  2199. case 'radio':
  2200. if ($edit[$name] == $value) {
  2201. $post[$name] = $edit[$name];
  2202. unset($edit[$name]);
  2203. }
  2204. break;
  2205. case 'checkbox':
  2206. // To prevent checkbox from being checked.pass in a FALSE,
  2207. // otherwise the checkbox will be set to its value regardless
  2208. // of $edit.
  2209. if ($edit[$name] === FALSE) {
  2210. unset($edit[$name]);
  2211. continue 2;
  2212. }
  2213. else {
  2214. unset($edit[$name]);
  2215. $post[$name] = $value;
  2216. }
  2217. break;
  2218. case 'select':
  2219. $new_value = $edit[$name];
  2220. $options = $this->getAllOptions($element);
  2221. if (is_array($new_value)) {
  2222. // Multiple select box.
  2223. if (!empty($new_value)) {
  2224. $index = 0;
  2225. $key = preg_replace('/\[\]$/', '', $name);
  2226. foreach ($options as $option) {
  2227. $option_value = (string) $option['value'];
  2228. if (in_array($option_value, $new_value)) {
  2229. $post[$key . '[' . $index++ . ']'] = $option_value;
  2230. $done = TRUE;
  2231. unset($edit[$name]);
  2232. }
  2233. }
  2234. }
  2235. else {
  2236. // No options selected: do not include any POST data for the
  2237. // element.
  2238. $done = TRUE;
  2239. unset($edit[$name]);
  2240. }
  2241. }
  2242. else {
  2243. // Single select box.
  2244. foreach ($options as $option) {
  2245. if ($new_value == $option['value']) {
  2246. $post[$name] = $new_value;
  2247. unset($edit[$name]);
  2248. $done = TRUE;
  2249. break;
  2250. }
  2251. }
  2252. }
  2253. break;
  2254. case 'file':
  2255. $upload[$name] = $edit[$name];
  2256. unset($edit[$name]);
  2257. break;
  2258. }
  2259. }
  2260. if (!isset($post[$name]) && !$done) {
  2261. switch ($type) {
  2262. case 'textarea':
  2263. $post[$name] = (string) $element;
  2264. break;
  2265. case 'select':
  2266. $single = empty($element['multiple']);
  2267. $first = TRUE;
  2268. $index = 0;
  2269. $key = preg_replace('/\[\]$/', '', $name);
  2270. $options = $this->getAllOptions($element);
  2271. foreach ($options as $option) {
  2272. // For single select, we load the first option, if there is a
  2273. // selected option that will overwrite it later.
  2274. if ($option['selected'] || ($first && $single)) {
  2275. $first = FALSE;
  2276. if ($single) {
  2277. $post[$name] = (string) $option['value'];
  2278. }
  2279. else {
  2280. $post[$key . '[' . $index++ . ']'] = (string) $option['value'];
  2281. }
  2282. }
  2283. }
  2284. break;
  2285. case 'file':
  2286. break;
  2287. case 'submit':
  2288. case 'image':
  2289. if (isset($submit) && $submit == $value) {
  2290. $post[$name] = $value;
  2291. $submit_matches = TRUE;
  2292. }
  2293. break;
  2294. case 'radio':
  2295. case 'checkbox':
  2296. if (!isset($element['checked'])) {
  2297. break;
  2298. }
  2299. // Deliberate no break.
  2300. default:
  2301. $post[$name] = $value;
  2302. }
  2303. }
  2304. }
  2305. return $submit_matches;
  2306. }
  2307. /**
  2308. * Builds an XPath query.
  2309. *
  2310. * Builds an XPath query by replacing placeholders in the query by the value
  2311. * of the arguments.
  2312. *
  2313. * XPath 1.0 (the version supported by libxml2, the underlying XML library
  2314. * used by PHP) doesn't support any form of quotation. This function
  2315. * simplifies the building of XPath expression.
  2316. *
  2317. * @param $xpath
  2318. * An XPath query, possibly with placeholders in the form ':name'.
  2319. * @param $args
  2320. * An array of arguments with keys in the form ':name' matching the
  2321. * placeholders in the query. The values may be either strings or numeric
  2322. * values.
  2323. * @return
  2324. * An XPath query with arguments replaced.
  2325. */
  2326. protected function buildXPathQuery($xpath, array $args = array()) {
  2327. // Replace placeholders.
  2328. foreach ($args as $placeholder => $value) {
  2329. // XPath 1.0 doesn't support a way to escape single or double quotes in a
  2330. // string literal. We split double quotes out of the string, and encode
  2331. // them separately.
  2332. if (is_string($value)) {
  2333. // Explode the text at the quote characters.
  2334. $parts = explode('"', $value);
  2335. // Quote the parts.
  2336. foreach ($parts as &$part) {
  2337. $part = '"' . $part . '"';
  2338. }
  2339. // Return the string.
  2340. $value = count($parts) > 1 ? 'concat(' . implode(', \'"\', ', $parts) . ')' : $parts[0];
  2341. }
  2342. $xpath = preg_replace('/' . preg_quote($placeholder) . '\b/', $value, $xpath);
  2343. }
  2344. return $xpath;
  2345. }
  2346. /**
  2347. * Perform an xpath search on the contents of the internal browser. The search
  2348. * is relative to the root element (HTML tag normally) of the page.
  2349. *
  2350. * @param $xpath
  2351. * The xpath string to use in the search.
  2352. * @return
  2353. * The return value of the xpath search. For details on the xpath string
  2354. * format and return values see the SimpleXML documentation,
  2355. * http://us.php.net/manual/function.simplexml-element-xpath.php.
  2356. */
  2357. protected function xpath($xpath, array $arguments = array()) {
  2358. if ($this->parse()) {
  2359. $xpath = $this->buildXPathQuery($xpath, $arguments);
  2360. $result = $this->elements->xpath($xpath);
  2361. // Some combinations of PHP / libxml versions return an empty array
  2362. // instead of the documented FALSE. Forcefully convert any falsish values
  2363. // to an empty array to allow foreach(...) constructions.
  2364. return $result ? $result : array();
  2365. }
  2366. else {
  2367. return FALSE;
  2368. }
  2369. }
  2370. /**
  2371. * Get all option elements, including nested options, in a select.
  2372. *
  2373. * @param $element
  2374. * The element for which to get the options.
  2375. * @return
  2376. * Option elements in select.
  2377. */
  2378. protected function getAllOptions(SimpleXMLElement $element) {
  2379. $options = array();
  2380. // Add all options items.
  2381. foreach ($element->option as $option) {
  2382. $options[] = $option;
  2383. }
  2384. // Search option group children.
  2385. if (isset($element->optgroup)) {
  2386. foreach ($element->optgroup as $group) {
  2387. $options = array_merge($options, $this->getAllOptions($group));
  2388. }
  2389. }
  2390. return $options;
  2391. }
  2392. /**
  2393. * Pass if a link with the specified label is found, and optional with the
  2394. * specified index.
  2395. *
  2396. * @param $label
  2397. * Text between the anchor tags.
  2398. * @param $index
  2399. * Link position counting from zero.
  2400. * @param $message
  2401. * Message to display.
  2402. * @param $group
  2403. * The group this message belongs to, defaults to 'Other'.
  2404. * @return
  2405. * TRUE if the assertion succeeded, FALSE otherwise.
  2406. */
  2407. protected function assertLink($label, $index = 0, $message = '', $group = 'Other') {
  2408. $links = $this->xpath('//a[normalize-space(text())=:label]', array(':label' => $label));
  2409. $message = ($message ? $message : t('Link with label %label found.', array('%label' => $label)));
  2410. return $this->assert(isset($links[$index]), $message, $group);
  2411. }
  2412. /**
  2413. * Pass if a link with the specified label is not found.
  2414. *
  2415. * @param $label
  2416. * Text between the anchor tags.
  2417. * @param $message
  2418. * Message to display.
  2419. * @param $group
  2420. * The group this message belongs to, defaults to 'Other'.
  2421. * @return
  2422. * TRUE if the assertion succeeded, FALSE otherwise.
  2423. */
  2424. protected function assertNoLink($label, $message = '', $group = 'Other') {
  2425. $links = $this->xpath('//a[normalize-space(text())=:label]', array(':label' => $label));
  2426. $message = ($message ? $message : t('Link with label %label not found.', array('%label' => $label)));
  2427. return $this->assert(empty($links), $message, $group);
  2428. }
  2429. /**
  2430. * Pass if a link containing a given href (part) is found.
  2431. *
  2432. * @param $href
  2433. * The full or partial value of the 'href' attribute of the anchor tag.
  2434. * @param $index
  2435. * Link position counting from zero.
  2436. * @param $message
  2437. * Message to display.
  2438. * @param $group
  2439. * The group this message belongs to, defaults to 'Other'.
  2440. *
  2441. * @return
  2442. * TRUE if the assertion succeeded, FALSE otherwise.
  2443. */
  2444. protected function assertLinkByHref($href, $index = 0, $message = '', $group = 'Other') {
  2445. $links = $this->xpath('//a[contains(@href, :href)]', array(':href' => $href));
  2446. $message = ($message ? $message : t('Link containing href %href found.', array('%href' => $href)));
  2447. return $this->assert(isset($links[$index]), $message, $group);
  2448. }
  2449. /**
  2450. * Pass if a link containing a given href (part) is not found.
  2451. *
  2452. * @param $href
  2453. * The full or partial value of the 'href' attribute of the anchor tag.
  2454. * @param $message
  2455. * Message to display.
  2456. * @param $group
  2457. * The group this message belongs to, defaults to 'Other'.
  2458. *
  2459. * @return
  2460. * TRUE if the assertion succeeded, FALSE otherwise.
  2461. */
  2462. protected function assertNoLinkByHref($href, $message = '', $group = 'Other') {
  2463. $links = $this->xpath('//a[contains(@href, :href)]', array(':href' => $href));
  2464. $message = ($message ? $message : t('No link containing href %href found.', array('%href' => $href)));
  2465. return $this->assert(empty($links), $message, $group);
  2466. }
  2467. /**
  2468. * Follows a link by name.
  2469. *
  2470. * Will click the first link found with this link text by default, or a later
  2471. * one if an index is given. Match is case sensitive with normalized space.
  2472. * The label is translated label.
  2473. *
  2474. * If the link is discovered and clicked, the test passes. Fail otherwise.
  2475. *
  2476. * @param $label
  2477. * Text between the anchor tags.
  2478. * @param $index
  2479. * Link position counting from zero.
  2480. * @return
  2481. * Page contents on success, or FALSE on failure.
  2482. */
  2483. protected function clickLink($label, $index = 0) {
  2484. $url_before = $this->getUrl();
  2485. $urls = $this->xpath('//a[normalize-space(text())=:label]', array(':label' => $label));
  2486. if (isset($urls[$index])) {
  2487. $url_target = $this->getAbsoluteUrl($urls[$index]['href']);
  2488. $this->pass(t('Clicked link %label (@url_target) from @url_before', array('%label' => $label, '@url_target' => $url_target, '@url_before' => $url_before)), 'Browser');
  2489. return $this->drupalGet($url_target);
  2490. }
  2491. $this->fail(t('Link %label does not exist on @url_before', array('%label' => $label, '@url_before' => $url_before)), 'Browser');
  2492. return FALSE;
  2493. }
  2494. /**
  2495. * Takes a path and returns an absolute path.
  2496. *
  2497. * @param $path
  2498. * A path from the internal browser content.
  2499. * @return
  2500. * The $path with $base_url prepended, if necessary.
  2501. */
  2502. protected function getAbsoluteUrl($path) {
  2503. global $base_url, $base_path;
  2504. $parts = parse_url($path);
  2505. if (empty($parts['host'])) {
  2506. // Ensure that we have a string (and no xpath object).
  2507. $path = (string) $path;
  2508. // Strip $base_path, if existent.
  2509. $length = strlen($base_path);
  2510. if (substr($path, 0, $length) === $base_path) {
  2511. $path = substr($path, $length);
  2512. }
  2513. // Ensure that we have an absolute path.
  2514. if ($path[0] !== '/') {
  2515. $path = '/' . $path;
  2516. }
  2517. // Finally, prepend the $base_url.
  2518. $path = $base_url . $path;
  2519. }
  2520. return $path;
  2521. }
  2522. /**
  2523. * Get the current URL from the cURL handler.
  2524. *
  2525. * @return
  2526. * The current URL.
  2527. */
  2528. protected function getUrl() {
  2529. return $this->url;
  2530. }
  2531. /**
  2532. * Gets the HTTP response headers of the requested page. Normally we are only
  2533. * interested in the headers returned by the last request. However, if a page
  2534. * is redirected or HTTP authentication is in use, multiple requests will be
  2535. * required to retrieve the page. Headers from all requests may be requested
  2536. * by passing TRUE to this function.
  2537. *
  2538. * @param $all_requests
  2539. * Boolean value specifying whether to return headers from all requests
  2540. * instead of just the last request. Defaults to FALSE.
  2541. * @return
  2542. * A name/value array if headers from only the last request are requested.
  2543. * If headers from all requests are requested, an array of name/value
  2544. * arrays, one for each request.
  2545. *
  2546. * The pseudonym ":status" is used for the HTTP status line.
  2547. *
  2548. * Values for duplicate headers are stored as a single comma-separated list.
  2549. */
  2550. protected function drupalGetHeaders($all_requests = FALSE) {
  2551. $request = 0;
  2552. $headers = array($request => array());
  2553. foreach ($this->headers as $header) {
  2554. $header = trim($header);
  2555. if ($header === '') {
  2556. $request++;
  2557. }
  2558. else {
  2559. if (strpos($header, 'HTTP/') === 0) {
  2560. $name = ':status';
  2561. $value = $header;
  2562. }
  2563. else {
  2564. list($name, $value) = explode(':', $header, 2);
  2565. $name = strtolower($name);
  2566. }
  2567. if (isset($headers[$request][$name])) {
  2568. $headers[$request][$name] .= ',' . trim($value);
  2569. }
  2570. else {
  2571. $headers[$request][$name] = trim($value);
  2572. }
  2573. }
  2574. }
  2575. if (!$all_requests) {
  2576. $headers = array_pop($headers);
  2577. }
  2578. return $headers;
  2579. }
  2580. /**
  2581. * Gets the value of an HTTP response header. If multiple requests were
  2582. * required to retrieve the page, only the headers from the last request will
  2583. * be checked by default. However, if TRUE is passed as the second argument,
  2584. * all requests will be processed from last to first until the header is
  2585. * found.
  2586. *
  2587. * @param $name
  2588. * The name of the header to retrieve. Names are case-insensitive (see RFC
  2589. * 2616 section 4.2).
  2590. * @param $all_requests
  2591. * Boolean value specifying whether to check all requests if the header is
  2592. * not found in the last request. Defaults to FALSE.
  2593. * @return
  2594. * The HTTP header value or FALSE if not found.
  2595. */
  2596. protected function drupalGetHeader($name, $all_requests = FALSE) {
  2597. $name = strtolower($name);
  2598. $header = FALSE;
  2599. if ($all_requests) {
  2600. foreach (array_reverse($this->drupalGetHeaders(TRUE)) as $headers) {
  2601. if (isset($headers[$name])) {
  2602. $header = $headers[$name];
  2603. break;
  2604. }
  2605. }
  2606. }
  2607. else {
  2608. $headers = $this->drupalGetHeaders();
  2609. if (isset($headers[$name])) {
  2610. $header = $headers[$name];
  2611. }
  2612. }
  2613. return $header;
  2614. }
  2615. /**
  2616. * Gets the current raw HTML of requested page.
  2617. */
  2618. protected function drupalGetContent() {
  2619. return $this->content;
  2620. }
  2621. /**
  2622. * Gets the value of the Drupal.settings JavaScript variable for the currently loaded page.
  2623. */
  2624. protected function drupalGetSettings() {
  2625. return $this->drupalSettings;
  2626. }
  2627. /**
  2628. * Gets an array containing all e-mails sent during this test case.
  2629. *
  2630. * @param $filter
  2631. * An array containing key/value pairs used to filter the e-mails that are returned.
  2632. * @return
  2633. * An array containing e-mail messages captured during the current test.
  2634. */
  2635. protected function drupalGetMails($filter = array()) {
  2636. $captured_emails = variable_get('drupal_test_email_collector', array());
  2637. $filtered_emails = array();
  2638. foreach ($captured_emails as $message) {
  2639. foreach ($filter as $key => $value) {
  2640. if (!isset($message[$key]) || $message[$key] != $value) {
  2641. continue 2;
  2642. }
  2643. }
  2644. $filtered_emails[] = $message;
  2645. }
  2646. return $filtered_emails;
  2647. }
  2648. /**
  2649. * Sets the raw HTML content. This can be useful when a page has been fetched
  2650. * outside of the internal browser and assertions need to be made on the
  2651. * returned page.
  2652. *
  2653. * A good example would be when testing drupal_http_request(). After fetching
  2654. * the page the content can be set and page elements can be checked to ensure
  2655. * that the function worked properly.
  2656. */
  2657. protected function drupalSetContent($content, $url = 'internal:') {
  2658. $this->content = $content;
  2659. $this->url = $url;
  2660. $this->plainTextContent = FALSE;
  2661. $this->elements = FALSE;
  2662. $this->drupalSettings = array();
  2663. if (preg_match('/jQuery\.extend\(Drupal\.settings, (.*?)\);/', $content, $matches)) {
  2664. $this->drupalSettings = drupal_json_decode($matches[1]);
  2665. }
  2666. }
  2667. /**
  2668. * Sets the value of the Drupal.settings JavaScript variable for the currently loaded page.
  2669. */
  2670. protected function drupalSetSettings($settings) {
  2671. $this->drupalSettings = $settings;
  2672. }
  2673. /**
  2674. * Pass if the internal browser's URL matches the given path.
  2675. *
  2676. * @param $path
  2677. * The expected system path.
  2678. * @param $options
  2679. * (optional) Any additional options to pass for $path to url().
  2680. * @param $message
  2681. * Message to display.
  2682. * @param $group
  2683. * The group this message belongs to, defaults to 'Other'.
  2684. *
  2685. * @return
  2686. * TRUE on pass, FALSE on fail.
  2687. */
  2688. protected function assertUrl($path, array $options = array(), $message = '', $group = 'Other') {
  2689. if (!$message) {
  2690. $message = t('Current URL is @url.', array(
  2691. '@url' => var_export(url($path, $options), TRUE),
  2692. ));
  2693. }
  2694. $options['absolute'] = TRUE;
  2695. return $this->assertEqual($this->getUrl(), url($path, $options), $message, $group);
  2696. }
  2697. /**
  2698. * Pass if the raw text IS found on the loaded page, fail otherwise. Raw text
  2699. * refers to the raw HTML that the page generated.
  2700. *
  2701. * @param $raw
  2702. * Raw (HTML) string to look for.
  2703. * @param $message
  2704. * Message to display.
  2705. * @param $group
  2706. * The group this message belongs to, defaults to 'Other'.
  2707. * @return
  2708. * TRUE on pass, FALSE on fail.
  2709. */
  2710. protected function assertRaw($raw, $message = '', $group = 'Other') {
  2711. if (!$message) {
  2712. $message = t('Raw "@raw" found', array('@raw' => $raw));
  2713. }
  2714. return $this->assert(strpos($this->drupalGetContent(), $raw) !== FALSE, $message, $group);
  2715. }
  2716. /**
  2717. * Pass if the raw text is NOT found on the loaded page, fail otherwise. Raw text
  2718. * refers to the raw HTML that the page generated.
  2719. *
  2720. * @param $raw
  2721. * Raw (HTML) string to look for.
  2722. * @param $message
  2723. * Message to display.
  2724. * @param $group
  2725. * The group this message belongs to, defaults to 'Other'.
  2726. * @return
  2727. * TRUE on pass, FALSE on fail.
  2728. */
  2729. protected function assertNoRaw($raw, $message = '', $group = 'Other') {
  2730. if (!$message) {
  2731. $message = t('Raw "@raw" not found', array('@raw' => $raw));
  2732. }
  2733. return $this->assert(strpos($this->drupalGetContent(), $raw) === FALSE, $message, $group);
  2734. }
  2735. /**
  2736. * Pass if the text IS found on the text version of the page. The text version
  2737. * is the equivalent of what a user would see when viewing through a web browser.
  2738. * In other words the HTML has been filtered out of the contents.
  2739. *
  2740. * @param $text
  2741. * Plain text to look for.
  2742. * @param $message
  2743. * Message to display.
  2744. * @param $group
  2745. * The group this message belongs to, defaults to 'Other'.
  2746. * @return
  2747. * TRUE on pass, FALSE on fail.
  2748. */
  2749. protected function assertText($text, $message = '', $group = 'Other') {
  2750. return $this->assertTextHelper($text, $message, $group, FALSE);
  2751. }
  2752. /**
  2753. * Pass if the text is NOT found on the text version of the page. The text version
  2754. * is the equivalent of what a user would see when viewing through a web browser.
  2755. * In other words the HTML has been filtered out of the contents.
  2756. *
  2757. * @param $text
  2758. * Plain text to look for.
  2759. * @param $message
  2760. * Message to display.
  2761. * @param $group
  2762. * The group this message belongs to, defaults to 'Other'.
  2763. * @return
  2764. * TRUE on pass, FALSE on fail.
  2765. */
  2766. protected function assertNoText($text, $message = '', $group = 'Other') {
  2767. return $this->assertTextHelper($text, $message, $group, TRUE);
  2768. }
  2769. /**
  2770. * Helper for assertText and assertNoText.
  2771. *
  2772. * It is not recommended to call this function directly.
  2773. *
  2774. * @param $text
  2775. * Plain text to look for.
  2776. * @param $message
  2777. * Message to display.
  2778. * @param $group
  2779. * The group this message belongs to.
  2780. * @param $not_exists
  2781. * TRUE if this text should not exist, FALSE if it should.
  2782. * @return
  2783. * TRUE on pass, FALSE on fail.
  2784. */
  2785. protected function assertTextHelper($text, $message = '', $group, $not_exists) {
  2786. if ($this->plainTextContent === FALSE) {
  2787. $this->plainTextContent = filter_xss($this->drupalGetContent(), array());
  2788. }
  2789. if (!$message) {
  2790. $message = !$not_exists ? t('"@text" found', array('@text' => $text)) : t('"@text" not found', array('@text' => $text));
  2791. }
  2792. return $this->assert($not_exists == (strpos($this->plainTextContent, $text) === FALSE), $message, $group);
  2793. }
  2794. /**
  2795. * Pass if the text is found ONLY ONCE on the text version of the page.
  2796. *
  2797. * The text version is the equivalent of what a user would see when viewing
  2798. * through a web browser. In other words the HTML has been filtered out of
  2799. * the contents.
  2800. *
  2801. * @param $text
  2802. * Plain text to look for.
  2803. * @param $message
  2804. * Message to display.
  2805. * @param $group
  2806. * The group this message belongs to, defaults to 'Other'.
  2807. * @return
  2808. * TRUE on pass, FALSE on fail.
  2809. */
  2810. protected function assertUniqueText($text, $message = '', $group = 'Other') {
  2811. return $this->assertUniqueTextHelper($text, $message, $group, TRUE);
  2812. }
  2813. /**
  2814. * Pass if the text is found MORE THAN ONCE on the text version of the page.
  2815. *
  2816. * The text version is the equivalent of what a user would see when viewing
  2817. * through a web browser. In other words the HTML has been filtered out of
  2818. * the contents.
  2819. *
  2820. * @param $text
  2821. * Plain text to look for.
  2822. * @param $message
  2823. * Message to display.
  2824. * @param $group
  2825. * The group this message belongs to, defaults to 'Other'.
  2826. * @return
  2827. * TRUE on pass, FALSE on fail.
  2828. */
  2829. protected function assertNoUniqueText($text, $message = '', $group = 'Other') {
  2830. return $this->assertUniqueTextHelper($text, $message, $group, FALSE);
  2831. }
  2832. /**
  2833. * Helper for assertUniqueText and assertNoUniqueText.
  2834. *
  2835. * It is not recommended to call this function directly.
  2836. *
  2837. * @param $text
  2838. * Plain text to look for.
  2839. * @param $message
  2840. * Message to display.
  2841. * @param $group
  2842. * The group this message belongs to.
  2843. * @param $be_unique
  2844. * TRUE if this text should be found only once, FALSE if it should be found more than once.
  2845. * @return
  2846. * TRUE on pass, FALSE on fail.
  2847. */
  2848. protected function assertUniqueTextHelper($text, $message = '', $group, $be_unique) {
  2849. if ($this->plainTextContent === FALSE) {
  2850. $this->plainTextContent = filter_xss($this->drupalGetContent(), array());
  2851. }
  2852. if (!$message) {
  2853. $message = '"' . $text . '"' . ($be_unique ? ' found only once' : ' found more than once');
  2854. }
  2855. $first_occurance = strpos($this->plainTextContent, $text);
  2856. if ($first_occurance === FALSE) {
  2857. return $this->assert(FALSE, $message, $group);
  2858. }
  2859. $offset = $first_occurance + strlen($text);
  2860. $second_occurance = strpos($this->plainTextContent, $text, $offset);
  2861. return $this->assert($be_unique == ($second_occurance === FALSE), $message, $group);
  2862. }
  2863. /**
  2864. * Will trigger a pass if the Perl regex pattern is found in the raw content.
  2865. *
  2866. * @param $pattern
  2867. * Perl regex to look for including the regex delimiters.
  2868. * @param $message
  2869. * Message to display.
  2870. * @param $group
  2871. * The group this message belongs to.
  2872. * @return
  2873. * TRUE on pass, FALSE on fail.
  2874. */
  2875. protected function assertPattern($pattern, $message = '', $group = 'Other') {
  2876. if (!$message) {
  2877. $message = t('Pattern "@pattern" found', array('@pattern' => $pattern));
  2878. }
  2879. return $this->assert((bool) preg_match($pattern, $this->drupalGetContent()), $message, $group);
  2880. }
  2881. /**
  2882. * Will trigger a pass if the perl regex pattern is not present in raw content.
  2883. *
  2884. * @param $pattern
  2885. * Perl regex to look for including the regex delimiters.
  2886. * @param $message
  2887. * Message to display.
  2888. * @param $group
  2889. * The group this message belongs to.
  2890. * @return
  2891. * TRUE on pass, FALSE on fail.
  2892. */
  2893. protected function assertNoPattern($pattern, $message = '', $group = 'Other') {
  2894. if (!$message) {
  2895. $message = t('Pattern "@pattern" not found', array('@pattern' => $pattern));
  2896. }
  2897. return $this->assert(!preg_match($pattern, $this->drupalGetContent()), $message, $group);
  2898. }
  2899. /**
  2900. * Pass if the page title is the given string.
  2901. *
  2902. * @param $title
  2903. * The string the title should be.
  2904. * @param $message
  2905. * Message to display.
  2906. * @param $group
  2907. * The group this message belongs to.
  2908. * @return
  2909. * TRUE on pass, FALSE on fail.
  2910. */
  2911. protected function assertTitle($title, $message = '', $group = 'Other') {
  2912. $actual = (string) current($this->xpath('//title'));
  2913. if (!$message) {
  2914. $message = t('Page title @actual is equal to @expected.', array(
  2915. '@actual' => var_export($actual, TRUE),
  2916. '@expected' => var_export($title, TRUE),
  2917. ));
  2918. }
  2919. return $this->assertEqual($actual, $title, $message, $group);
  2920. }
  2921. /**
  2922. * Pass if the page title is not the given string.
  2923. *
  2924. * @param $title
  2925. * The string the title should not be.
  2926. * @param $message
  2927. * Message to display.
  2928. * @param $group
  2929. * The group this message belongs to.
  2930. * @return
  2931. * TRUE on pass, FALSE on fail.
  2932. */
  2933. protected function assertNoTitle($title, $message = '', $group = 'Other') {
  2934. $actual = (string) current($this->xpath('//title'));
  2935. if (!$message) {
  2936. $message = t('Page title @actual is not equal to @unexpected.', array(
  2937. '@actual' => var_export($actual, TRUE),
  2938. '@unexpected' => var_export($title, TRUE),
  2939. ));
  2940. }
  2941. return $this->assertNotEqual($actual, $title, $message, $group);
  2942. }
  2943. /**
  2944. * Asserts themed output.
  2945. *
  2946. * @param $callback
  2947. * The name of the theme function to invoke; e.g. 'links' for theme_links().
  2948. * @param $variables
  2949. * (optional) An array of variables to pass to the theme function.
  2950. * @param $expected
  2951. * The expected themed output string.
  2952. * @param $message
  2953. * (optional) A message to display with the assertion. Do not translate
  2954. * messages: use format_string() to embed variables in the message text, not
  2955. * t(). If left blank, a default message will be displayed.
  2956. * @param $group
  2957. * (optional) The group this message is in, which is displayed in a column
  2958. * in test output. Use 'Debug' to indicate this is debugging output. Do not
  2959. * translate this string. Defaults to 'Other'; most tests do not override
  2960. * this default.
  2961. *
  2962. * @return
  2963. * TRUE on pass, FALSE on fail.
  2964. */
  2965. protected function assertThemeOutput($callback, array $variables = array(), $expected, $message = '', $group = 'Other') {
  2966. $output = theme($callback, $variables);
  2967. $this->verbose('Variables:' . '<pre>' . check_plain(var_export($variables, TRUE)) . '</pre>'
  2968. . '<hr />' . 'Result:' . '<pre>' . check_plain(var_export($output, TRUE)) . '</pre>'
  2969. . '<hr />' . 'Expected:' . '<pre>' . check_plain(var_export($expected, TRUE)) . '</pre>'
  2970. . '<hr />' . $output
  2971. );
  2972. if (!$message) {
  2973. $message = '%callback rendered correctly.';
  2974. }
  2975. $message = format_string($message, array('%callback' => 'theme_' . $callback . '()'));
  2976. return $this->assertIdentical($output, $expected, $message, $group);
  2977. }
  2978. /**
  2979. * Asserts that a field exists in the current page by the given XPath.
  2980. *
  2981. * @param $xpath
  2982. * XPath used to find the field.
  2983. * @param $value
  2984. * (optional) Value of the field to assert. You may pass in NULL (default)
  2985. * to skip checking the actual value, while still checking that the field
  2986. * exists.
  2987. * @param $message
  2988. * (optional) Message to display.
  2989. * @param $group
  2990. * (optional) The group this message belongs to.
  2991. *
  2992. * @return
  2993. * TRUE on pass, FALSE on fail.
  2994. */
  2995. protected function assertFieldByXPath($xpath, $value = NULL, $message = '', $group = 'Other') {
  2996. $fields = $this->xpath($xpath);
  2997. // If value specified then check array for match.
  2998. $found = TRUE;
  2999. if (isset($value)) {
  3000. $found = FALSE;
  3001. if ($fields) {
  3002. foreach ($fields as $field) {
  3003. if (isset($field['value']) && $field['value'] == $value) {
  3004. // Input element with correct value.
  3005. $found = TRUE;
  3006. }
  3007. elseif (isset($field->option)) {
  3008. // Select element found.
  3009. if ($this->getSelectedItem($field) == $value) {
  3010. $found = TRUE;
  3011. }
  3012. else {
  3013. // No item selected so use first item.
  3014. $items = $this->getAllOptions($field);
  3015. if (!empty($items) && $items[0]['value'] == $value) {
  3016. $found = TRUE;
  3017. }
  3018. }
  3019. }
  3020. elseif ((string) $field == $value) {
  3021. // Text area with correct text.
  3022. $found = TRUE;
  3023. }
  3024. }
  3025. }
  3026. }
  3027. return $this->assertTrue($fields && $found, $message, $group);
  3028. }
  3029. /**
  3030. * Get the selected value from a select field.
  3031. *
  3032. * @param $element
  3033. * SimpleXMLElement select element.
  3034. * @return
  3035. * The selected value or FALSE.
  3036. */
  3037. protected function getSelectedItem(SimpleXMLElement $element) {
  3038. foreach ($element->children() as $item) {
  3039. if (isset($item['selected'])) {
  3040. return $item['value'];
  3041. }
  3042. elseif ($item->getName() == 'optgroup') {
  3043. if ($value = $this->getSelectedItem($item)) {
  3044. return $value;
  3045. }
  3046. }
  3047. }
  3048. return FALSE;
  3049. }
  3050. /**
  3051. * Asserts that a field doesn't exist or its value doesn't match, by XPath.
  3052. *
  3053. * @param $xpath
  3054. * XPath used to find the field.
  3055. * @param $value
  3056. * (optional) Value for the field, to assert that the field's value on the
  3057. * page doesn't match it. You may pass in NULL to skip checking the
  3058. * value, while still checking that the field doesn't exist.
  3059. * @param $message
  3060. * (optional) Message to display.
  3061. * @param $group
  3062. * (optional) The group this message belongs to.
  3063. *
  3064. * @return
  3065. * TRUE on pass, FALSE on fail.
  3066. */
  3067. protected function assertNoFieldByXPath($xpath, $value = NULL, $message = '', $group = 'Other') {
  3068. $fields = $this->xpath($xpath);
  3069. // If value specified then check array for match.
  3070. $found = TRUE;
  3071. if (isset($value)) {
  3072. $found = FALSE;
  3073. if ($fields) {
  3074. foreach ($fields as $field) {
  3075. if ($field['value'] == $value) {
  3076. $found = TRUE;
  3077. }
  3078. }
  3079. }
  3080. }
  3081. return $this->assertFalse($fields && $found, $message, $group);
  3082. }
  3083. /**
  3084. * Asserts that a field exists in the current page with the given name and value.
  3085. *
  3086. * @param $name
  3087. * Name of field to assert.
  3088. * @param $value
  3089. * (optional) Value of the field to assert. You may pass in NULL (default)
  3090. * to skip checking the actual value, while still checking that the field
  3091. * exists.
  3092. * @param $message
  3093. * Message to display.
  3094. * @param $group
  3095. * The group this message belongs to.
  3096. * @return
  3097. * TRUE on pass, FALSE on fail.
  3098. */
  3099. protected function assertFieldByName($name, $value = NULL, $message = NULL) {
  3100. if (!isset($message)) {
  3101. if (!isset($value)) {
  3102. $message = t('Found field with name @name', array(
  3103. '@name' => var_export($name, TRUE),
  3104. ));
  3105. }
  3106. else {
  3107. $message = t('Found field with name @name and value @value', array(
  3108. '@name' => var_export($name, TRUE),
  3109. '@value' => var_export($value, TRUE),
  3110. ));
  3111. }
  3112. }
  3113. return $this->assertFieldByXPath($this->constructFieldXpath('name', $name), $value, $message, t('Browser'));
  3114. }
  3115. /**
  3116. * Asserts that a field does not exist with the given name and value.
  3117. *
  3118. * @param $name
  3119. * Name of field to assert.
  3120. * @param $value
  3121. * (optional) Value for the field, to assert that the field's value on the
  3122. * page doesn't match it. You may pass in NULL to skip checking the
  3123. * value, while still checking that the field doesn't exist. However, the
  3124. * default value ('') asserts that the field value is not an empty string.
  3125. * @param $message
  3126. * (optional) Message to display.
  3127. * @param $group
  3128. * The group this message belongs to.
  3129. * @return
  3130. * TRUE on pass, FALSE on fail.
  3131. */
  3132. protected function assertNoFieldByName($name, $value = '', $message = '') {
  3133. return $this->assertNoFieldByXPath($this->constructFieldXpath('name', $name), $value, $message ? $message : t('Did not find field by name @name', array('@name' => $name)), t('Browser'));
  3134. }
  3135. /**
  3136. * Asserts that a field exists in the current page with the given ID and value.
  3137. *
  3138. * @param $id
  3139. * ID of field to assert.
  3140. * @param $value
  3141. * (optional) Value for the field to assert. You may pass in NULL to skip
  3142. * checking the value, while still checking that the field exists.
  3143. * However, the default value ('') asserts that the field value is an empty
  3144. * string.
  3145. * @param $message
  3146. * (optional) Message to display.
  3147. * @param $group
  3148. * The group this message belongs to.
  3149. * @return
  3150. * TRUE on pass, FALSE on fail.
  3151. */
  3152. protected function assertFieldById($id, $value = '', $message = '') {
  3153. return $this->assertFieldByXPath($this->constructFieldXpath('id', $id), $value, $message ? $message : t('Found field by id @id', array('@id' => $id)), t('Browser'));
  3154. }
  3155. /**
  3156. * Asserts that a field does not exist with the given ID and value.
  3157. *
  3158. * @param $id
  3159. * ID of field to assert.
  3160. * @param $value
  3161. * (optional) Value for the field, to assert that the field's value on the
  3162. * page doesn't match it. You may pass in NULL to skip checking the value,
  3163. * while still checking that the field doesn't exist. However, the default
  3164. * value ('') asserts that the field value is not an empty string.
  3165. * @param $message
  3166. * (optional) Message to display.
  3167. * @param $group
  3168. * The group this message belongs to.
  3169. * @return
  3170. * TRUE on pass, FALSE on fail.
  3171. */
  3172. protected function assertNoFieldById($id, $value = '', $message = '') {
  3173. return $this->assertNoFieldByXPath($this->constructFieldXpath('id', $id), $value, $message ? $message : t('Did not find field by id @id', array('@id' => $id)), t('Browser'));
  3174. }
  3175. /**
  3176. * Asserts that a checkbox field in the current page is checked.
  3177. *
  3178. * @param $id
  3179. * ID of field to assert.
  3180. * @param $message
  3181. * (optional) Message to display.
  3182. * @return
  3183. * TRUE on pass, FALSE on fail.
  3184. */
  3185. protected function assertFieldChecked($id, $message = '') {
  3186. $elements = $this->xpath('//input[@id=:id]', array(':id' => $id));
  3187. return $this->assertTrue(isset($elements[0]) && !empty($elements[0]['checked']), $message ? $message : t('Checkbox field @id is checked.', array('@id' => $id)), t('Browser'));
  3188. }
  3189. /**
  3190. * Asserts that a checkbox field in the current page is not checked.
  3191. *
  3192. * @param $id
  3193. * ID of field to assert.
  3194. * @param $message
  3195. * (optional) Message to display.
  3196. * @return
  3197. * TRUE on pass, FALSE on fail.
  3198. */
  3199. protected function assertNoFieldChecked($id, $message = '') {
  3200. $elements = $this->xpath('//input[@id=:id]', array(':id' => $id));
  3201. return $this->assertTrue(isset($elements[0]) && empty($elements[0]['checked']), $message ? $message : t('Checkbox field @id is not checked.', array('@id' => $id)), t('Browser'));
  3202. }
  3203. /**
  3204. * Asserts that a select option in the current page is checked.
  3205. *
  3206. * @param $id
  3207. * ID of select field to assert.
  3208. * @param $option
  3209. * Option to assert.
  3210. * @param $message
  3211. * (optional) Message to display.
  3212. * @return
  3213. * TRUE on pass, FALSE on fail.
  3214. *
  3215. * @todo $id is unusable. Replace with $name.
  3216. */
  3217. protected function assertOptionSelected($id, $option, $message = '') {
  3218. $elements = $this->xpath('//select[@id=:id]//option[@value=:option]', array(':id' => $id, ':option' => $option));
  3219. return $this->assertTrue(isset($elements[0]) && !empty($elements[0]['selected']), $message ? $message : t('Option @option for field @id is selected.', array('@option' => $option, '@id' => $id)), t('Browser'));
  3220. }
  3221. /**
  3222. * Asserts that a select option in the current page is not checked.
  3223. *
  3224. * @param $id
  3225. * ID of select field to assert.
  3226. * @param $option
  3227. * Option to assert.
  3228. * @param $message
  3229. * (optional) Message to display.
  3230. * @return
  3231. * TRUE on pass, FALSE on fail.
  3232. */
  3233. protected function assertNoOptionSelected($id, $option, $message = '') {
  3234. $elements = $this->xpath('//select[@id=:id]//option[@value=:option]', array(':id' => $id, ':option' => $option));
  3235. return $this->assertTrue(isset($elements[0]) && empty($elements[0]['selected']), $message ? $message : t('Option @option for field @id is not selected.', array('@option' => $option, '@id' => $id)), t('Browser'));
  3236. }
  3237. /**
  3238. * Asserts that a field exists with the given name or ID.
  3239. *
  3240. * @param $field
  3241. * Name or ID of field to assert.
  3242. * @param $message
  3243. * (optional) Message to display.
  3244. * @param $group
  3245. * The group this message belongs to.
  3246. * @return
  3247. * TRUE on pass, FALSE on fail.
  3248. */
  3249. protected function assertField($field, $message = '', $group = 'Other') {
  3250. return $this->assertFieldByXPath($this->constructFieldXpath('name', $field) . '|' . $this->constructFieldXpath('id', $field), NULL, $message, $group);
  3251. }
  3252. /**
  3253. * Asserts that a field does not exist with the given name or ID.
  3254. *
  3255. * @param $field
  3256. * Name or ID of field to assert.
  3257. * @param $message
  3258. * (optional) Message to display.
  3259. * @param $group
  3260. * The group this message belongs to.
  3261. * @return
  3262. * TRUE on pass, FALSE on fail.
  3263. */
  3264. protected function assertNoField($field, $message = '', $group = 'Other') {
  3265. return $this->assertNoFieldByXPath($this->constructFieldXpath('name', $field) . '|' . $this->constructFieldXpath('id', $field), NULL, $message, $group);
  3266. }
  3267. /**
  3268. * Asserts that each HTML ID is used for just a single element.
  3269. *
  3270. * @param $message
  3271. * Message to display.
  3272. * @param $group
  3273. * The group this message belongs to.
  3274. * @param $ids_to_skip
  3275. * An optional array of ids to skip when checking for duplicates. It is
  3276. * always a bug to have duplicate HTML IDs, so this parameter is to enable
  3277. * incremental fixing of core code. Whenever a test passes this parameter,
  3278. * it should add a "todo" comment above the call to this function explaining
  3279. * the legacy bug that the test wishes to ignore and including a link to an
  3280. * issue that is working to fix that legacy bug.
  3281. * @return
  3282. * TRUE on pass, FALSE on fail.
  3283. */
  3284. protected function assertNoDuplicateIds($message = '', $group = 'Other', $ids_to_skip = array()) {
  3285. $status = TRUE;
  3286. foreach ($this->xpath('//*[@id]') as $element) {
  3287. $id = (string) $element['id'];
  3288. if (isset($seen_ids[$id]) && !in_array($id, $ids_to_skip)) {
  3289. $this->fail(t('The HTML ID %id is unique.', array('%id' => $id)), $group);
  3290. $status = FALSE;
  3291. }
  3292. $seen_ids[$id] = TRUE;
  3293. }
  3294. return $this->assert($status, $message, $group);
  3295. }
  3296. /**
  3297. * Helper function: construct an XPath for the given set of attributes and value.
  3298. *
  3299. * @param $attribute
  3300. * Field attributes.
  3301. * @param $value
  3302. * Value of field.
  3303. * @return
  3304. * XPath for specified values.
  3305. */
  3306. protected function constructFieldXpath($attribute, $value) {
  3307. $xpath = '//textarea[@' . $attribute . '=:value]|//input[@' . $attribute . '=:value]|//select[@' . $attribute . '=:value]';
  3308. return $this->buildXPathQuery($xpath, array(':value' => $value));
  3309. }
  3310. /**
  3311. * Asserts the page responds with the specified response code.
  3312. *
  3313. * @param $code
  3314. * Response code. For example 200 is a successful page request. For a list
  3315. * of all codes see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html.
  3316. * @param $message
  3317. * Message to display.
  3318. * @return
  3319. * Assertion result.
  3320. */
  3321. protected function assertResponse($code, $message = '') {
  3322. $curl_code = curl_getinfo($this->curlHandle, CURLINFO_HTTP_CODE);
  3323. $match = is_array($code) ? in_array($curl_code, $code) : $curl_code == $code;
  3324. return $this->assertTrue($match, $message ? $message : t('HTTP response expected !code, actual !curl_code', array('!code' => $code, '!curl_code' => $curl_code)), t('Browser'));
  3325. }
  3326. /**
  3327. * Asserts the page did not return the specified response code.
  3328. *
  3329. * @param $code
  3330. * Response code. For example 200 is a successful page request. For a list
  3331. * of all codes see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html.
  3332. * @param $message
  3333. * Message to display.
  3334. *
  3335. * @return
  3336. * Assertion result.
  3337. */
  3338. protected function assertNoResponse($code, $message = '') {
  3339. $curl_code = curl_getinfo($this->curlHandle, CURLINFO_HTTP_CODE);
  3340. $match = is_array($code) ? in_array($curl_code, $code) : $curl_code == $code;
  3341. return $this->assertFalse($match, $message ? $message : t('HTTP response not expected !code, actual !curl_code', array('!code' => $code, '!curl_code' => $curl_code)), t('Browser'));
  3342. }
  3343. /**
  3344. * Asserts that the most recently sent e-mail message has the given value.
  3345. *
  3346. * The field in $name must have the content described in $value.
  3347. *
  3348. * @param $name
  3349. * Name of field or message property to assert. Examples: subject, body, id, ...
  3350. * @param $value
  3351. * Value of the field to assert.
  3352. * @param $message
  3353. * Message to display.
  3354. *
  3355. * @return
  3356. * TRUE on pass, FALSE on fail.
  3357. */
  3358. protected function assertMail($name, $value = '', $message = '') {
  3359. $captured_emails = variable_get('drupal_test_email_collector', array());
  3360. $email = end($captured_emails);
  3361. return $this->assertTrue($email && isset($email[$name]) && $email[$name] == $value, $message, t('E-mail'));
  3362. }
  3363. /**
  3364. * Asserts that the most recently sent e-mail message has the string in it.
  3365. *
  3366. * @param $field_name
  3367. * Name of field or message property to assert: subject, body, id, ...
  3368. * @param $string
  3369. * String to search for.
  3370. * @param $email_depth
  3371. * Number of emails to search for string, starting with most recent.
  3372. *
  3373. * @return
  3374. * TRUE on pass, FALSE on fail.
  3375. */
  3376. protected function assertMailString($field_name, $string, $email_depth) {
  3377. $mails = $this->drupalGetMails();
  3378. $string_found = FALSE;
  3379. for ($i = sizeof($mails) -1; $i >= sizeof($mails) - $email_depth && $i >= 0; $i--) {
  3380. $mail = $mails[$i];
  3381. // Normalize whitespace, as we don't know what the mail system might have
  3382. // done. Any run of whitespace becomes a single space.
  3383. $normalized_mail = preg_replace('/\s+/', ' ', $mail[$field_name]);
  3384. $normalized_string = preg_replace('/\s+/', ' ', $string);
  3385. $string_found = (FALSE !== strpos($normalized_mail, $normalized_string));
  3386. if ($string_found) {
  3387. break;
  3388. }
  3389. }
  3390. return $this->assertTrue($string_found, t('Expected text found in @field of email message: "@expected".', array('@field' => $field_name, '@expected' => $string)));
  3391. }
  3392. /**
  3393. * Asserts that the most recently sent e-mail message has the pattern in it.
  3394. *
  3395. * @param $field_name
  3396. * Name of field or message property to assert: subject, body, id, ...
  3397. * @param $regex
  3398. * Pattern to search for.
  3399. *
  3400. * @return
  3401. * TRUE on pass, FALSE on fail.
  3402. */
  3403. protected function assertMailPattern($field_name, $regex, $message) {
  3404. $mails = $this->drupalGetMails();
  3405. $mail = end($mails);
  3406. $regex_found = preg_match("/$regex/", $mail[$field_name]);
  3407. return $this->assertTrue($regex_found, t('Expected text found in @field of email message: "@expected".', array('@field' => $field_name, '@expected' => $regex)));
  3408. }
  3409. /**
  3410. * Outputs to verbose the most recent $count emails sent.
  3411. *
  3412. * @param $count
  3413. * Optional number of emails to output.
  3414. */
  3415. protected function verboseEmail($count = 1) {
  3416. $mails = $this->drupalGetMails();
  3417. for ($i = sizeof($mails) -1; $i >= sizeof($mails) - $count && $i >= 0; $i--) {
  3418. $mail = $mails[$i];
  3419. $this->verbose(t('Email:') . '<pre>' . print_r($mail, TRUE) . '</pre>');
  3420. }
  3421. }
  3422. }
  3423. /**
  3424. * Logs verbose message in a text file.
  3425. *
  3426. * If verbose mode is enabled then page requests will be dumped to a file and
  3427. * presented on the test result screen. The messages will be placed in a file
  3428. * located in the simpletest directory in the original file system.
  3429. *
  3430. * @param $message
  3431. * The verbose message to be stored.
  3432. * @param $original_file_directory
  3433. * The original file directory, before it was changed for testing purposes.
  3434. * @param $test_class
  3435. * The active test case class.
  3436. *
  3437. * @return
  3438. * The ID of the message to be placed in related assertion messages.
  3439. *
  3440. * @see DrupalTestCase->originalFileDirectory
  3441. * @see DrupalWebTestCase->verbose()
  3442. */
  3443. function simpletest_verbose($message, $original_file_directory = NULL, $test_class = NULL) {
  3444. static $file_directory = NULL, $class = NULL, $id = 1, $verbose = NULL;
  3445. // Will pass first time during setup phase, and when verbose is TRUE.
  3446. if (!isset($original_file_directory) && !$verbose) {
  3447. return FALSE;
  3448. }
  3449. if ($message && $file_directory) {
  3450. $message = '<hr />ID #' . $id . ' (<a href="' . $class . '-' . ($id - 1) . '.html">Previous</a> | <a href="' . $class . '-' . ($id + 1) . '.html">Next</a>)<hr />' . $message;
  3451. file_put_contents($file_directory . "/simpletest/verbose/$class-$id.html", $message, FILE_APPEND);
  3452. return $id++;
  3453. }
  3454. if ($original_file_directory) {
  3455. $file_directory = $original_file_directory;
  3456. $class = $test_class;
  3457. $verbose = variable_get('simpletest_verbose', TRUE);
  3458. $directory = $file_directory . '/simpletest/verbose';
  3459. $writable = file_prepare_directory($directory, FILE_CREATE_DIRECTORY);
  3460. if ($writable && !file_exists($directory . '/.htaccess')) {
  3461. file_put_contents($directory . '/.htaccess', "<IfModule mod_expires.c>\nExpiresActive Off\n</IfModule>\n");
  3462. }
  3463. return $writable;
  3464. }
  3465. return FALSE;
  3466. }