128318177SAndreas Gohr<?php 228318177SAndreas Gohr 3ba766201SAndreas Gohrnamespace dokuwiki\plugin\struct\test; 428318177SAndreas Gohr 5*ea9843dcSAndreas Gohruse dokuwiki\plugin\struct\meta\AccessTable; 6ba766201SAndreas Gohruse dokuwiki\plugin\struct\meta\SchemaData; 7ba766201SAndreas Gohruse dokuwiki\plugin\struct\meta\SchemaImporter; 828318177SAndreas Gohr 928318177SAndreas Gohr/** 1028318177SAndreas Gohr * Base class for all struct tests 1128318177SAndreas Gohr * 1228318177SAndreas Gohr * It cleans up the database in teardown and provides some useful helper methods 1328318177SAndreas Gohr * 14ba766201SAndreas Gohr * @package dokuwiki\plugin\struct\test 1528318177SAndreas Gohr */ 1628318177SAndreas Gohrabstract class StructTest extends \DokuWikiTest { 1728318177SAndreas Gohr 1828318177SAndreas Gohr /** @var array alway enable the needed plugins */ 1928318177SAndreas Gohr protected $pluginsEnabled = array('struct', 'sqlite'); 2028318177SAndreas Gohr 2128318177SAndreas Gohr /** 2228318177SAndreas Gohr * Default teardown 2328318177SAndreas Gohr * 2428318177SAndreas Gohr * we always make sure the database is clear 2528318177SAndreas Gohr */ 2628318177SAndreas Gohr protected function tearDown() { 2728318177SAndreas Gohr parent::tearDown(); 289d580426SAndreas Gohr /** @var \helper_plugin_struct_db $db */ 299d580426SAndreas Gohr $db = plugin_load('helper', 'struct_db'); 309d580426SAndreas Gohr $db->resetDB(); 3128318177SAndreas Gohr } 3228318177SAndreas Gohr 3328318177SAndreas Gohr /** 3428318177SAndreas Gohr * Creates a schema from one of the available schema files 3528318177SAndreas Gohr * 3628318177SAndreas Gohr * @param string $schema 3728318177SAndreas Gohr * @param string $json base name of the JSON file optional, defaults to $schema 389d580426SAndreas Gohr * @param int $rev allows to create schemas back in time 3928318177SAndreas Gohr */ 409d580426SAndreas Gohr protected function loadSchemaJSON($schema, $json = '', $rev = 0) { 4128318177SAndreas Gohr if(!$json) $json = $schema; 4228318177SAndreas Gohr $file = __DIR__ . "/json/$json.struct.json"; 4328318177SAndreas Gohr if(!file_exists($file)) { 4428318177SAndreas Gohr throw new \RuntimeException("$file does not exist"); 4528318177SAndreas Gohr } 4628318177SAndreas Gohr 4728318177SAndreas Gohr $importer = new SchemaImporter($schema, file_get_contents($file)); 4828318177SAndreas Gohr 499d580426SAndreas Gohr if(!$importer->build($rev)) { 5028318177SAndreas Gohr throw new \RuntimeException("build of $schema from $file failed"); 5128318177SAndreas Gohr } 5228318177SAndreas Gohr } 5328318177SAndreas Gohr 5428318177SAndreas Gohr /** 5528318177SAndreas Gohr * This waits until a new second has passed 5628318177SAndreas Gohr * 5728318177SAndreas Gohr * The very first call will return immeadiately, proceeding calls will return 589d580426SAndreas Gohr * only after at least 1 second after the last call has passed. 5928318177SAndreas Gohr * 609d580426SAndreas Gohr * When passing $init=true it will not return immeadiately but use the current 619d580426SAndreas Gohr * second as initialization. It might still return faster than a second. 629d580426SAndreas Gohr * 639d580426SAndreas Gohr * @param bool $init wait from now on, not from last time 6428318177SAndreas Gohr * @return int new timestamp 6528318177SAndreas Gohr */ 669d580426SAndreas Gohr protected function waitForTick($init = false) { 6728318177SAndreas Gohr static $last = 0; 689d580426SAndreas Gohr if($init) $last = time(); 699d580426SAndreas Gohr 7028318177SAndreas Gohr while($last === $now = time()) { 7128318177SAndreas Gohr usleep(100000); //recheck in a 10th of a second 7228318177SAndreas Gohr } 7328318177SAndreas Gohr $last = $now; 7428318177SAndreas Gohr return $now; 7528318177SAndreas Gohr } 7628318177SAndreas Gohr 7728318177SAndreas Gohr /** 7828318177SAndreas Gohr * Saves struct data for given page and schema 7928318177SAndreas Gohr * 809d580426SAndreas Gohr * Please note that setting the $rev only influences the struct data timestamp, 819d580426SAndreas Gohr * not the page and changelog entries. 829d580426SAndreas Gohr * 8328318177SAndreas Gohr * @param string $page 8428318177SAndreas Gohr * @param string $schema 8528318177SAndreas Gohr * @param array $data 869d580426SAndreas Gohr * @param int $rev allows to override the revision timestamp 8728318177SAndreas Gohr */ 889d580426SAndreas Gohr protected function saveData($page, $schema, $data, $rev = 0) { 899d580426SAndreas Gohr if(!$rev) $rev = time(); 909d580426SAndreas Gohr 9128318177SAndreas Gohr saveWikiText($page, "test for $page", "saved for testing"); 92*ea9843dcSAndreas Gohr $schemaData = AccessTable::byTableName($schema, $page, $rev); 9328318177SAndreas Gohr $schemaData->saveData($data); 9428318177SAndreas Gohr } 959d580426SAndreas Gohr 969d580426SAndreas Gohr /** 979d580426SAndreas Gohr * Access the plugin's english language strings 989d580426SAndreas Gohr * 999d580426SAndreas Gohr * @param string $key 1009d580426SAndreas Gohr * @return string 1019d580426SAndreas Gohr */ 1029d580426SAndreas Gohr protected function getLang($key) { 1039d580426SAndreas Gohr static $lang = null; 1049d580426SAndreas Gohr if(is_null($lang)) { 1059d580426SAndreas Gohr $lang = array(); 1069d580426SAndreas Gohr include(DOKU_PLUGIN . 'struct/lang/en/lang.php'); 1079d580426SAndreas Gohr } 1089d580426SAndreas Gohr return $lang[$key]; 1099d580426SAndreas Gohr } 110df30dbf7SAndreas Gohr 111df30dbf7SAndreas Gohr /** 112df30dbf7SAndreas Gohr * Removes Whitespace 113df30dbf7SAndreas Gohr * 114df30dbf7SAndreas Gohr * Makes comparing sql statements a bit simpler as it ignores formatting 115df30dbf7SAndreas Gohr * 116df30dbf7SAndreas Gohr * @param $string 117df30dbf7SAndreas Gohr * @return string 118df30dbf7SAndreas Gohr */ 119df30dbf7SAndreas Gohr protected function cleanWS($string) { 120df30dbf7SAndreas Gohr return preg_replace('/\s+/s', '', $string); 121df30dbf7SAndreas Gohr } 12228318177SAndreas Gohr} 123