class MigrateExecutableMemoryExceededTest in Drupal 8

Tests the \Drupal\migrate\MigrateExecutable::memoryExceeded() method.

@group migrate

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\migrate\Unit\MigrateTestCase
    • class \Drupal\Tests\migrate\Unit\MigrateExecutableMemoryExceededTest

File

core/modules/migrate/tests/src/Unit/MigrateExecutableMemoryExceededTest.php, line 10

Namespace

Drupal\Tests\migrate\Unit

class MigrateExecutableMemoryExceededTest extends MigrateTestCase {

  /**
   * The mocked migration entity.
   *
   * @var \Drupal\migrate\Plugin\MigrationInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $migration;

  /**
   * The mocked migrate message.
   *
   * @var \Drupal\migrate\MigrateMessageInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $message;

  /**
   * The tested migrate executable.
   *
   * @var \Drupal\Tests\migrate\Unit\TestMigrateExecutable
   */
  protected $executable;

  /**
   * The migration configuration, initialized to set the ID to test.
   *
   * @var array
   */
  protected $migrationConfiguration = [
    'id' => 'test',
  ];

  /**
   * The php.ini memory_limit value.
   *
   * @var int
   */
  protected $memoryLimit = 10000000;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->migration = $this
      ->getMigration();
    $this->message = $this
      ->createMock('Drupal\\migrate\\MigrateMessageInterface');
    $this->executable = new TestMigrateExecutable($this->migration, $this->message);
    $this->executable
      ->setStringTranslation($this
      ->getStringTranslationStub());
  }

  /**
   * Runs the actual test.
   *
   * @param string $message
   *   The second message to assert.
   * @param bool $memory_exceeded
   *   Whether to test the memory exceeded case.
   * @param int|null $memory_usage_first
   *   (optional) The first memory usage value. Defaults to NULL.
   * @param int|null $memory_usage_second
   *   (optional) The fake amount of memory usage reported after memory reclaim.
   *   Defaults to NULL.
   * @param int|null $memory_limit
   *   (optional) The memory limit. Defaults to NULL.
   */
  protected function runMemoryExceededTest($message, $memory_exceeded, $memory_usage_first = NULL, $memory_usage_second = NULL, $memory_limit = NULL) {
    $this->executable
      ->setMemoryLimit($memory_limit ?: $this->memoryLimit);
    $this->executable
      ->setMemoryUsage($memory_usage_first ?: $this->memoryLimit, $memory_usage_second ?: $this->memoryLimit);
    $this->executable
      ->setMemoryThreshold(0.85);
    if ($message) {
      $this->executable->message
        ->expects($this
        ->at(0))
        ->method('display')
        ->with($this
        ->callback(function ($subject) {
        return mb_stripos((string) $subject, 'reclaiming memory') !== FALSE;
      }));
      $this->executable->message
        ->expects($this
        ->at(1))
        ->method('display')
        ->with($this
        ->callback(function ($subject) use ($message) {
        return mb_stripos((string) $subject, $message) !== FALSE;
      }));
    }
    else {
      $this->executable->message
        ->expects($this
        ->never())
        ->method($this
        ->anything());
    }
    $result = $this->executable
      ->memoryExceeded();
    $this
      ->assertEquals($memory_exceeded, $result);
  }

  /**
   * Tests memoryExceeded method when a new batch is needed.
   */
  public function testMemoryExceededNewBatch() {

    // First case try reset and then start new batch.
    $this
      ->runMemoryExceededTest('starting new batch', TRUE);
  }

  /**
   * Tests memoryExceeded method when enough is cleared.
   */
  public function testMemoryExceededClearedEnough() {
    $this
      ->runMemoryExceededTest('reclaimed enough', FALSE, $this->memoryLimit, $this->memoryLimit * 0.75);
  }

  /**
   * Tests memoryExceeded when memory usage is not exceeded.
   */
  public function testMemoryNotExceeded() {
    $this
      ->runMemoryExceededTest('', FALSE, floor($this->memoryLimit * 0.85) - 1);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MigrateExecutableMemoryExceededTest::$executable	protected	property	The tested migrate executable.
MigrateExecutableMemoryExceededTest::$memoryLimit	protected	property	The php.ini memory_limit value.
MigrateExecutableMemoryExceededTest::$message	protected	property	The mocked migrate message.
MigrateExecutableMemoryExceededTest::$migration	protected	property	The mocked migration entity.
MigrateExecutableMemoryExceededTest::$migrationConfiguration	protected	property	The migration configuration, initialized to set the ID to test. Overrides MigrateTestCase::$migrationConfiguration
MigrateExecutableMemoryExceededTest::runMemoryExceededTest	protected	function	Runs the actual test.
MigrateExecutableMemoryExceededTest::setUp	protected	function	Overrides UnitTestCase::setUp
MigrateExecutableMemoryExceededTest::testMemoryExceededClearedEnough	public	function	Tests memoryExceeded method when enough is cleared.
MigrateExecutableMemoryExceededTest::testMemoryExceededNewBatch	public	function	Tests memoryExceeded method when a new batch is needed.
MigrateExecutableMemoryExceededTest::testMemoryNotExceeded	public	function	Tests memoryExceeded when memory usage is not exceeded.
MigrateTestCase::$idMap	protected	property	The migration ID map.
MigrateTestCase::$migrationStatus	protected	property	Local store for mocking setStatus()/getStatus().
MigrateTestCase::createSchemaFromRow	protected	function	Generates a table schema from a row.
MigrateTestCase::getDatabase	protected	function	Gets an SQLite database connection object for use in tests.
MigrateTestCase::getMigration	protected	function	Retrieves a mocked migration.	1
MigrateTestCase::getValue	protected	function	Gets the value on a row for a given key.	1
MigrateTestCase::queryResultTest	public	function	Tests a query.
MigrateTestCase::retrievalAssertHelper	protected	function	Asserts tested values during test retrieval.
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated	protected	function	Mocks a block with a block plugin.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.