You are here

Home » API reference » Workbench Moderation to Content Moderation 8.2 » WorkflowCollectorTest.php

class WorkflowCollectorTest in Workbench Moderation to Content Moderation 8.2

@covers \Drupal\wbm2cm\WorkflowCollector @group wbm2cm

Hierarchy

Expanded class hierarchy of WorkflowCollectorTest

File

tests/src/Kernel/WorkflowCollectorTest.php, line 19

Namespace

Drupal\Tests\wbm2cm\Kernel
View source 
class WorkflowCollectorTest extends KernelTestBase {
  use ContentTypeCreationTrait {
    createContentType as drupalCreateContentType;
  }

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'field',
    'filter',
    'migrate',
    'node',
    'options',
    'system',
    'text',
    'user',
    'views',
    'wbm2cm',
    'workbench_moderation',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installConfig('node');
    $this
      ->createState('archived', FALSE, TRUE);
    $this
      ->createState('draft', FALSE, FALSE);
    $this
      ->createState('review', FALSE, FALSE);
    $this
      ->createState('legal_review', FALSE, FALSE);
    $this
      ->createState('postponed', FALSE, FALSE);
    $this
      ->createState('published', TRUE, TRUE);
    $states = [
      'archived',
      'draft',
      'review',
      'published',
    ];
    $this
      ->createContentType('page', $states);
    $this
      ->createContentType('article', $states);
    $states = [
      'archived',
      'draft',
      'review',
      'legal_review',
      'postponed',
      'published',
    ];
    $this
      ->createContentType('press_release', $states);
    $states = [
      'archived',
      'draft',
      'review',
      'legal_review',
      'published',
    ];
    $this
      ->createContentType('announcement', $states);
    $this
      ->createContentType('offering', $states);
    $this
      ->createTransition('archived', 'draft');
    $this
      ->createTransition('draft', 'draft');
    $this
      ->createTransition('draft', 'review');
    $this
      ->createTransition('review', 'draft');
    $this
      ->createTransition('review', 'legal_review');
    $this
      ->createTransition('legal_review', 'draft');
    $this
      ->createTransition('review', 'published');
    $this
      ->createTransition('legal_review', 'published');
    $this
      ->createTransition('published', 'archived');
    $this
      ->createTransition('published', 'draft');
    module_load_install('wbm2cm');
    wbm2cm_install();
  }
  public function testWorkflowCollection() {
    $modules = [
      'content_moderation',
      'workflows',
    ];
    $this
      ->enableModules($modules);
    wbm2cm_modules_installed($modules);
    $this
      ->assertSame(3, \Drupal::entityQuery('workflow')
      ->count()
      ->execute());
    return;
    $this
      ->assertWorkflow('article__page', [
      'page',
      'article',
    ], [
      'archived',
      'draft',
      'review',
      'published',
    ], [
      'legal_review',
      'postponed',
    ], [
      'archived_draft',
      'draft_draft',
      'draft_review',
      'review_draft',
      'review_published',
      'published_draft',
      'published_archived',
    ], [
      'review_legal_review',
      'legal_review_draft',
      'legal_review_published',
    ]);
    $this
      ->assertWorkflow('press_release', [
      'press_release',
    ], [
      'archived',
      'draft',
      'review',
      'legal_review',
      'postponed',
      'published',
    ], [], [
      'archived_draft',
      'draft_draft',
      'draft_review',
      'review_draft',
      'review_legal_review',
      'legal_review_draft',
      'review_published',
      'legal_review_published',
      'published_archived',
      'published_draft',
    ], []);
  }

  /**
   * Asserts various aspects of a workflow.
   *
   * @param string $id
   *   The workflow ID.
   * @param string[] $expected_node_types
   *   The content types that the workflow is expected to support.
   * @param string[] $expected_states
   *   The state IDs that the workflow is expected to have.
   * @param string[] $unexpected_states
   *   The state IDs that the workflow specifically should not have.
   * @param string[] $expected_transitions
   *   The transition IDs that the workflow is expected to have.
   * @param string[] $unexpected_transitions
   *   The transition IDs that the workflow specifically should not have.
   */
  protected function assertWorkflow($id, array $expected_node_types, array $expected_states, array $unexpected_states, array $expected_transitions, array $unexpected_transitions) {
    $workflow = Workflow::load($id);
    $this
      ->assertInstanceOf(Workflow::class, $workflow);

    /** @var ContentModeration $plugin */
    $plugin = $workflow
      ->getTypePlugin();
    $this
      ->assertInstanceOf(ContentModeration::class, $plugin);
    $actual_node_types = $plugin
      ->getBundlesForEntityType('node');
    foreach ($expected_node_types as $node_type) {
      $this
        ->assertContains($node_type, $actual_node_types);
    }
    foreach ($expected_states as $state_id) {
      $this
        ->assertState($plugin, $state_id);
    }
    foreach ($unexpected_states as $state_id) {
      $this
        ->assertNoState($plugin, $state_id);
    }
    foreach ($expected_transitions as $transition_id) {
      $this
        ->assertTransition($plugin, $transition_id);
    }
    foreach ($unexpected_transitions as $transition_id) {
      $this
        ->assertNoTransition($plugin, $transition_id);
    }
  }

  /**
   * Asserts that a workflow type plugin has a specific state.
   *
   * @param \Drupal\workflows\WorkflowTypeInterface $plugin
   *   The workflow type plugin.
   * @param string $state_id
   *   The state ID.
   */
  protected function assertState(WorkflowTypeInterface $plugin, $state_id) {
    $this
      ->assertInstanceOf(StateInterface::class, $plugin
      ->getState($state_id));
  }

  /**
   * Asserts that a workflow type plugin does not have a specific state.
   *
   * @param \Drupal\workflows\WorkflowTypeInterface $plugin
   *   The workflow type plugin.
   * @param string $state_id
   *   The state ID.
   */
  protected function assertNoState(WorkflowTypeInterface $plugin, $state_id) {
    try {
      $plugin
        ->getState($state_id);
      $this
        ->fail();
    } catch (\InvalidArgumentException $e) {
      $this
        ->assertTrue(TRUE);
    }
  }

  /**
   * Asserts that a workflow type plugin has a specific transition.
   *
   * @param \Drupal\workflows\WorkflowTypeInterface $plugin
   *   The workflow type plugin.
   * @param string $transition_id
   *   The transition ID.
   */
  protected function assertTransition(WorkflowTypeInterface $plugin, $transition_id) {
    $this
      ->assertInstanceOf(TransitionInterface::class, $plugin
      ->getTransition($transition_id));
  }

  /**
   * Asserts that a workflow type plugin does not have a specific transition.
   *
   * @param \Drupal\workflows\WorkflowTypeInterface $plugin
   *   The workflow type plugin.
   * @param string $transition_id
   *   The transition ID.
   */
  protected function assertNoTransition(WorkflowTypeInterface $plugin, $transition_id) {
    try {
      $plugin
        ->getTransition($transition_id);
      $this
        ->fail();
    } catch (\InvalidArgumentException $e) {
      $this
        ->assertTrue(TRUE);
    }
  }

  /**
   * Creates a moderated content type.
   *
   * @param string $id
   *   The content type ID.
   * @param string[] $moderation_states
   *   The moderation states that the content type should allow.
   */
  protected function createContentType($id, array $moderation_states) {
    $this
      ->drupalCreateContentType([
      'type' => $id,
    ])
      ->setThirdPartySetting('workbench_moderation', 'enabled', TRUE)
      ->setThirdPartySetting('workbench_moderation', 'allowed_moderation_states', $moderation_states)
      ->save();
  }

  /**
   * Creates a moderation state.
   *
   * @param string $id
   *   The state ID.
   * @param bool $published
   *   Whether content in this state is published.
   * @param bool $default_revision
   *   Whether content in this state is the default revision.
   */
  protected function createState($id, $published, $default_revision) {
    ModerationState::create([
      'id' => $id,
      'label' => $this
        ->randomMachineName(),
      'published' => $published,
      'default_revision' => $default_revision,
    ])
      ->save();
  }

  /**
   * Creates a moderation state transition.
   *
   * @param string $from_state
   *   The moderation state from which to transition.
   * @param string $to_state
   *   The moderation state to which to transition.
   */
  protected function createTransition($from_state, $to_state) {
    ModerationStateTransition::create([
      'id' => "{$from_state}_{$to_state}",
      'label' => $this
        ->randomMachineName(),
      'stateFrom' => $from_state,
      'stateTo' => $to_state,
    ])
      ->save();
  }

}

Members

Namesort descending 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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
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.
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.
WorkflowCollectorTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
WorkflowCollectorTest::assertNoState protected function Asserts that a workflow type plugin does not have a specific state.
WorkflowCollectorTest::assertNoTransition protected function Asserts that a workflow type plugin does not have a specific transition.
WorkflowCollectorTest::assertState protected function Asserts that a workflow type plugin has a specific state.
WorkflowCollectorTest::assertTransition protected function Asserts that a workflow type plugin has a specific transition.
WorkflowCollectorTest::assertWorkflow protected function Asserts various aspects of a workflow.
WorkflowCollectorTest::createContentType protected function Creates a moderated content type.
WorkflowCollectorTest::createState protected function Creates a moderation state.
WorkflowCollectorTest::createTransition protected function Creates a moderation state transition.
WorkflowCollectorTest::setUp protected function Overrides KernelTestBase::setUp
WorkflowCollectorTest::testWorkflowCollection public function