class StateItemTest in State Machine 8

@coversDefaultClass \Drupal\state_machine\Plugin\Field\FieldType\StateItem @group state_machine

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\field\Kernel\FieldKernelTestBase
  - class \Drupal\Tests\state_machine\Kernel\StateItemTest

Expanded class hierarchy of StateItemTest

File

tests/src/Kernel/StateItemTest.php, line 12

Namespace

Drupal\Tests\state_machine\Kernel

View source

class StateItemTest extends FieldKernelTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'entity_test',
    'field',
    'user',
    'state_machine',
    'state_machine_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('entity_test_with_bundle');
    $this
      ->installConfig([
      'state_machine_test',
    ]);
  }

  /**
   * @covers ::applyTransitionById
   * @expectedException \InvalidArgumentException
   */
  public function testInvalidTransitionApply() {
    $entity = EntityTestWithBundle::create([
      'type' => 'first',
    ]);

    /** @var \Drupal\state_machine\Plugin\Field\FieldType\StateItemInterface $state_item */
    $state_item = $entity
      ->get('field_state')
      ->first();
    $state_item
      ->applyTransitionById('INVALID');
  }

  /**
   * @dataProvider providerTestField
   */
  public function testField($initial_state, $allowed_transitions, $invalid_new_state, $valid_transition, $expected_new_state) {
    $entity = EntityTestWithBundle::create([
      'type' => 'second',
      'field_state' => $initial_state,
    ]);
    $this
      ->assertEquals($initial_state, $entity
      ->get('field_state')->value);

    /** @var \Drupal\state_machine\Plugin\Field\FieldType\StateItemInterface $state_item */
    $state_item = $entity
      ->get('field_state')
      ->first();

    // Confirm that the transitions are correct.
    $transitions = $state_item
      ->getTransitions();
    $this
      ->assertCount(count($allowed_transitions), $transitions);
    $this
      ->assertEquals($allowed_transitions, array_keys($transitions));
    if (count($allowed_transitions) > 0) {
      foreach ($allowed_transitions as $transition_id) {
        $this
          ->assertTrue($state_item
          ->isTransitionAllowed($transition_id));
      }
    }
    $this
      ->assertFalse($state_item
      ->isTransitionAllowed('foo'));

    // Confirm that invalid states are recognized.
    if ($invalid_new_state) {
      $state_item->value = $invalid_new_state;
      $this
        ->assertEquals($initial_state, $state_item
        ->getOriginalId());
      $this
        ->assertEquals($invalid_new_state, $state_item
        ->getId());
      $this
        ->assertFalse($state_item
        ->isValid());
    }

    // Revert to the initial state because the valid transaction could be
    // invalid from the invalid_new_state.
    $state_item->value = $initial_state;

    // Retrieve all workflow transitions.
    $workflow = $state_item
      ->getWorkflow();
    $all_transitions = $workflow
      ->getTransitions();

    // Pick a random invalid transition and assert it throws an Exception.
    $invalid_transitions = array_diff_key($all_transitions, $allowed_transitions);
    if ($invalid_transitions) {
      $random_key = array_rand($invalid_transitions);
      $this
        ->expectException(\InvalidArgumentException::class);
      $state_item
        ->applyTransition($invalid_transitions[$random_key]);

      // Also try applying by ID.
      $this
        ->expectException(\InvalidArgumentException::class);
      $state_item
        ->applyTransitionById($random_key);
    }
    $state_item
      ->applyTransitionById($valid_transition);
    $this
      ->assertEquals($initial_state, $state_item
      ->getOriginalId());
    $this
      ->assertEquals($expected_new_state, $state_item
      ->getId());
    $this
      ->assertTrue($state_item
      ->isValid());
  }

  /**
   * Data provider for ::testField.
   *
   * @return array
   *   A list of testField function arguments.
   */
  public function providerTestField() {
    $data = [];
    $data['new->validation'] = [
      'new',
      [
        'create',
        'cancel',
      ],
      'fulfillment',
      'create',
      'validation',
    ];
    $data['new->canceled'] = [
      'new',
      [
        'create',
        'cancel',
      ],
      'completed',
      'cancel',
      'canceled',
    ];

    // The workflow defines validation->fulfillment and validation->canceled
    // transitions, but the second one is forbidden by the GenericGuard.
    $data['validation->fulfillment'] = [
      'validation',
      [
        'validate',
      ],
      'completed',
      'validate',
      'fulfillment',
    ];

    // The workflow defines fulfillment->completed and fulfillment->canceled
    // transitions, but the second one is forbidden by the FulfillmentGuard.
    $data['fulfillment->completed'] = [
      'fulfillment',
      [
        'fulfill',
      ],
      'new',
      'fulfill',
      'completed',
    ];
    return $data;
  }

  /**
   * @dataProvider providerSettableOptions
   */
  public function testSettableOptions($initial_state, $available_options) {
    $entity = EntityTestWithBundle::create([
      'type' => 'second',
      'field_state' => $initial_state,
    ]);
    $this
      ->assertEquals($initial_state, $entity
      ->get('field_state')->value);

    // An invalid state should not have any settable options.
    $this
      ->assertEquals($available_options, $entity
      ->get('field_state')
      ->first()
      ->getSettableOptions());
  }

  /**
   * Data provider for ::providerSettableOptions.
   *
   * @return array
   *   A list of providerSettableOptions function arguments.
   */
  public function providerSettableOptions() {
    $data = [];
    $data['new'] = [
      'new',
      [
        'canceled' => 'Canceled',
        'validation' => 'Validation',
        'new' => 'New',
      ],
    ];
    $data['invalid'] = [
      'invalid',
      [],
    ];
    return $data;
  }

  /**
   * @covers ::generateSampleValue
   */
  public function testGenerateSampleValue() {
    $entity = EntityTestWithBundle::create([
      'type' => 'first',
    ]);
    $entity->field_state
      ->generateSampleItems();

    /** @var \Drupal\state_machine\Plugin\Field\FieldType\StateItemInterface $state_item */
    $state_item = $entity
      ->get('field_state')
      ->first();
    $this
      ->assertEquals('default', $state_item
      ->getWorkflow()
      ->getId());
    $this
      ->assertNotEmpty($state_item
      ->getId());
    $this
      ->assertTrue(in_array($state_item
      ->getId(), array_keys($state_item
      ->getWorkflow()
      ->getStates())));
    $this
      ->entityValidateAndSave($entity);
    $entity = EntityTestWithBundle::create([
      'type' => 'second',
    ]);
    $entity->field_state
      ->generateSampleItems();

    /** @var \Drupal\state_machine\Plugin\Field\FieldType\StateItemInterface $state_item */
    $state_item = $entity
      ->get('field_state')
      ->first();
    $this
      ->assertNotEmpty($state_item
      ->getId());
    $this
      ->assertTrue(in_array($state_item
      ->getId(), array_keys($state_item
      ->getWorkflow()
      ->getStates())));
    $this
      ->entityValidateAndSave($entity);
    $entity = EntityTestWithBundle::create([
      'type' => 'third',
    ]);
    $entity->field_state
      ->generateSampleItems();

    /** @var \Drupal\state_machine\Plugin\Field\FieldType\StateItemInterface $state_item */
    $state_item = $entity
      ->get('field_state')
      ->first();
    $this
      ->assertEquals('two_transitions', $state_item
      ->getWorkflow()
      ->getId());
    $this
      ->assertNotEmpty($state_item
      ->getId());
    $this
      ->assertTrue(in_array($state_item
      ->getId(), array_keys($state_item
      ->getWorkflow()
      ->getStates())));
    $this
      ->entityValidateAndSave($entity);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertContentTrait::$content	protected	property	The current raw content.
AssertContentTrait::$drupalSettings	protected	property	The drupalSettings value from the current raw $content.
AssertContentTrait::$elements	protected	property	The XML structure parsed from the current raw $content.	1
AssertContentTrait::$plainTextContent	protected	property	The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds	protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped	protected	function	Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion	protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption	protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected	protected	function	Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern	protected	function	Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw	protected	function	Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle	protected	function	Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText	protected	function	Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern	protected	function	Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput	protected	function	Asserts themed output.
AssertContentTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertContentTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper	protected	function	Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertContentTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings	protected	function	Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent	protected	function	Gets the current raw content.
AssertContentTrait::getSelectedItem	protected	function	Get the selected value from a select field.
AssertContentTrait::getTextContent	protected	function	Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl	protected	function	Get the current URL from the cURL handler.	1
AssertContentTrait::parse	protected	function	Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace	protected	function	Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings	protected	function	Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent	protected	function	Sets the raw content (e.g. HTML).
AssertContentTrait::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings	protected static	function	Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose	protected	function
ConfigTestTrait::configImporter	protected	function	Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig	protected	function	Copies configuration objects from source storage to target storage.
FieldKernelTestBase::$fieldTestData	protected	property	Bag of created field storages and fields.
FieldKernelTestBase::assertFieldValues	protected	function	Assert that a field has the expected values in an entity.
FieldKernelTestBase::createFieldWithStorage	protected	function	Create a field and an associated field storage.
FieldKernelTestBase::entitySaveReload	protected	function	Saves and reloads an entity.
FieldKernelTestBase::entityValidateAndSave	protected	function	Validate and save entity. Fail if violations are found.
FieldKernelTestBase::_generateTestFieldValues	protected	function	Generate random values for a field_test field.
KernelTestBase::$backupGlobals	protected	property	Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes	protected	property	Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist	protected	property	Contains a few static class properties for performance.
KernelTestBase::$classLoader	protected	property
KernelTestBase::$configImporter	protected	property	@todo Move into Config test base class.	7
KernelTestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container	protected	property
KernelTestBase::$databasePrefix	protected	property
KernelTestBase::$preserveGlobalState	protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root	protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess	protected	property	Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory	protected	property
KernelTestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	6
KernelTestBase::$vfsRoot	protected	property	The virtual filesystem root directory.
KernelTestBase::assertPostConditions	protected	function		1
KernelTestBase::bootEnvironment	protected	function	Bootstraps a basic test environment.
KernelTestBase::bootKernel	private	function	Bootstraps a kernel for a test.
KernelTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo	protected	function	Returns the Database connection info to be used for this test.	1
KernelTestBase::getDatabasePrefix	public	function
KernelTestBase::getExtensionsForModules	private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable	private static	function	Returns the modules to enable for this test.
KernelTestBase::initFileCache	protected	function	Initializes the FileCache component.
KernelTestBase::installConfig	protected	function	Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema	protected	function	Installs the storage schema for a specific entity type.
KernelTestBase::installSchema	protected	function	Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated	protected	function	Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	26
KernelTestBase::render	protected	function	Renders a render array.	1
KernelTestBase::setInstallProfile	protected	function	Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting	protected	function	Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass	public static	function		1
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	2
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		6
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated	public	function	BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
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.
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
RandomGeneratorTrait::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName	protected	function	Generates a unique random string containing letters and numbers.	1
RandomGeneratorTrait::randomObject	public	function	Generates a random PHP object.
RandomGeneratorTrait::randomString	public	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
StateItemTest::$modules	public static	property	Modules to enable. Overrides FieldKernelTestBase::$modules
StateItemTest::providerSettableOptions	public	function	Data provider for ::providerSettableOptions.
StateItemTest::providerTestField	public	function	Data provider for ::testField.
StateItemTest::setUp	protected	function	Set the default field storage backend for fields created during tests. Overrides FieldKernelTestBase::setUp
StateItemTest::testField	public	function	@dataProvider providerTestField
StateItemTest::testGenerateSampleValue	public	function	@covers ::generateSampleValue
StateItemTest::testInvalidTransitionApply	public	function	@covers ::applyTransitionById @expectedException \InvalidArgumentException
StateItemTest::testSettableOptions	public	function	@dataProvider providerSettableOptions
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.

You are here

class StateItemTest in State Machine 8

Hierarchy

File

Namespace

Members

API Navigation