silverstripe-framework/tests/php/ORM/DatabaseTest.php

<?php

namespace SilverStripe\ORM\Tests;

use SilverStripe\ORM\DB;
use SilverStripe\ORM\Connect\MySQLDatabase;
use SilverStripe\MSSQL\MSSQLDatabase;
use SilverStripe\Dev\SapphireTest;
use Exception;
use SilverStripe\ORM\Tests\DatabaseTest\MyObject;

/** @skipUpgrade */
class DatabaseTest extends SapphireTest {

	protected $extraDataObjects = array(
		MyObject::class,
	);

	protected $usesDatabase = true;

	public function testDontRequireField() {
		$schema = DB::get_schema();
		$this->assertArrayHasKey(
			'MyField',
			$schema->fieldList('DatabaseTest_MyObject')
		);

		$schema->dontRequireField('DatabaseTest_MyObject', 'MyField');

		$this->assertArrayHasKey(
			'_obsolete_MyField',
			$schema->fieldList('DatabaseTest_MyObject'),
			'Field is renamed to _obsolete_<fieldname> through dontRequireField()'
		);

		$this->resetDBSchema(true);
	}

	public function testRenameField() {
		$schema = DB::get_schema();

		$schema->clearCachedFieldlist();

		$schema->renameField('DatabaseTest_MyObject', 'MyField', 'MyRenamedField');

		$this->assertArrayHasKey(
			'MyRenamedField',
			$schema->fieldList('DatabaseTest_MyObject'),
			'New fieldname is set through renameField()'
		);
		$this->assertArrayNotHasKey(
			'MyField',
			$schema->fieldList('DatabaseTest_MyObject'),
			'Old fieldname isnt preserved through renameField()'
		);

		$this->resetDBSchema(true);
	}

	public function testMySQLCreateTableOptions() {
		if(!(DB::get_conn() instanceof MySQLDatabase)) {
			$this->markTestSkipped('MySQL only');
		}


		$ret = DB::query(sprintf(
			'SHOW TABLE STATUS WHERE "Name" = \'%s\'',
			'DatabaseTest_MyObject'
		))->first();
		$this->assertEquals($ret['Engine'],'InnoDB',
			"MySQLDatabase tables can be changed to InnoDB through DataObject::\$create_table_options"
		);
	}

	function testIsSchemaUpdating() {
		$schema = DB::get_schema();

		$this->assertFalse($schema->isSchemaUpdating(), 'Before the transaction the flag is false.');

		// Test complete schema update
		$test = $this;
		$schema->schemaUpdate(function() use ($test, $schema) {
			$test->assertTrue($schema->isSchemaUpdating(), 'During the transaction the flag is true.');
		});
		$this->assertFalse($schema->isSchemaUpdating(), 'After the transaction the flag is false.');

		// Test cancelled schema update
		$schema->schemaUpdate(function() use ($test, $schema) {
			$schema->cancelSchemaUpdate();
			$test->assertFalse($schema->doesSchemaNeedUpdating(), 'After cancelling the transaction the flag is false');
		});
	}

	public function testSchemaUpdateChecking() {
		$schema = DB::get_schema();

		// Initially, no schema changes necessary
		$test = $this;
		$schema->schemaUpdate(function() use ($test, $schema) {
			$test->assertFalse($schema->doesSchemaNeedUpdating());

			// If we make a change, then the schema will need updating
			$schema->transCreateTable("TestTable");
			$test->assertTrue($schema->doesSchemaNeedUpdating());

			// If we make cancel the change, then schema updates are no longer necessary
			$schema->cancelSchemaUpdate();
			$test->assertFalse($schema->doesSchemaNeedUpdating());
		});
	}

	public function testHasTable() {
		$this->assertTrue(DB::get_schema()->hasTable('DatabaseTest_MyObject'));
		$this->assertFalse(DB::get_schema()->hasTable('asdfasdfasdf'));
	}

	public function testGetAndReleaseLock() {
		$db = DB::get_conn();

		if(!$db->supportsLocks()) {
			return $this->markTestSkipped('Tested database doesn\'t support application locks');
		}

		$this->assertTrue($db->getLock('DatabaseTest'),
			'Can aquire lock');
		// $this->assertFalse($db->getLock('DatabaseTest'), 'Can\'t repeatedly aquire the same lock');
		$this->assertTrue($db->getLock('DatabaseTest'),
			'The same lock can be aquired multiple times in the same connection');

		$this->assertTrue($db->getLock('DatabaseTestOtherLock'),
			'Can aquire different lock');
		$db->releaseLock('DatabaseTestOtherLock');

		// Release potentially stacked locks from previous getLock() invocations
		$db->releaseLock('DatabaseTest');
		$db->releaseLock('DatabaseTest');

		$this->assertTrue($db->getLock('DatabaseTest'),
			'Can aquire lock after releasing it');
		$db->releaseLock('DatabaseTest');
	}

	public function testCanLock() {
		$db = DB::get_conn();

		if(!$db->supportsLocks()) {
			return $this->markTestSkipped('Database doesn\'t support locks');
		}

		if($db instanceof MSSQLDatabase) {
			return $this->markTestSkipped('MSSQLDatabase doesn\'t support inspecting locks');
		}

		$this->assertTrue($db->canLock('DatabaseTest'), 'Can lock before first aquiring one');
		$db->getLock('DatabaseTest');
		$this->assertFalse($db->canLock('DatabaseTest'), 'Can\'t lock after aquiring one');
		$db->releaseLock('DatabaseTest');
		$this->assertTrue($db->canLock('DatabaseTest'), 'Can lock again after releasing it');
	}

	public function testTransactions() {
		$conn = DB::get_conn();
		if(!$conn->supportsTransactions()) {
			$this->markTestSkipped("DB Doesn't support transactions");
			return;
		}

		// Test that successful transactions are comitted
		$obj = new DatabaseTest\MyObject();
		$failed = false;
		$conn->withTransaction(function() use (&$obj) {
			$obj->MyField = 'Save 1';
			$obj->write();
		}, function() use (&$failed) {
			$failed = true;
		});
		$this->assertEquals('Save 1', DatabaseTest\MyObject::get()->first()->MyField);
		$this->assertFalse($failed);

		// Test failed transactions are rolled back
		$ex = null;
		$failed = false;
		try {
			$conn->withTransaction(function() use (&$obj) {
				$obj->MyField = 'Save 2';
				$obj->write();
				throw new Exception("error");
			}, function() use (&$failed) {
				$failed = true;
			});
		} catch ( Exception $ex) {}
		$this->assertTrue($failed);
		$this->assertEquals('Save 1', DatabaseTest\MyObject::get()->first()->MyField);
		$this->assertInstanceOf('Exception', $ex);
		$this->assertEquals('error', $ex->getMessage());
	}


}